Australian Digital Health Agency FHIR Implementation Guide 1.0.0

Australian Digital Health Agency FHIR Implementation Guide. This is the current published version. It is based on FHIR® version 4.0.1. See the Directory of published versions for a list of available versions.

StructureDefinition: ADHA Record of Claim against PBS or RPBS [Active]

The purpose of this profile is to define a representation of a record of a claim against the Pharmaceutical Benefits Scheme (PBS) or Repatriation Pharmaceutical Benefits Scheme (RPBS) for the electronic exchange of digital health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia.

This profile identifies the additional constraints, extensions, and value sets that build on and extend ExplanationOfBenefit that are supported.

This profile is designed to set an ExplanationOfBenefit standard for:

  • Query for a record of a PBS or RPBS item claim associated with a patient
  • Record or update a PBS or RPBS item claim associated with a patient

Profile specific guidance

  • In an exchange with the My Health Record system references to a MedicationRequest resource will be contained.

Boundaries and relationships

This profile is not referenced by another profile in this implementation guide.

Formal Views of Profile Content

The official URL for this profile is: 

http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-explanationofbenefit-medicare-pbs-1

The purpose of this profile is to define a representation of a record of a claim against the Pharmaceutical Benefits Scheme (PBS) or Repatriation Pharmaceutical Benefits Scheme (RPBS) for the electronic exchange of digital health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia.

This profile builds on ExplanationOfBenefit.

This profile was published on 2023-04-14 04:02:01+0000 as a active by Australian Digital Health Agency.

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. ExplanationOfBenefit 0..*ExplanationOfBenefitRecord of Claim against PBS or RPBS
... identifier S1..*IdentifierBusiness Identifier for the resource
... status S1..1codeactive | cancelled | draft | entered-in-error
Fixed Value: active
... type S1..1CodeableConceptCategory or discipline
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/claim-type
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: pharmacy
... subType S1..1CodeableConceptMore granular claim type
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medicare-benefit-claim-category-1 (required)
... use S1..1codeclaim | preauthorization | predetermination
Fixed Value: claim
... patient SC1..1Reference(ADHA Core Patient)The recipient of the products and services
inv-dh-eob-01: At least reference or a valid identifier shall be present
... created SC1..1dateTimeResponse creation date
inv-dh-eob-03: Date shall be at least to day
... insurer SC1..1Reference(ADHA Core Organization)Australian Government department that subsidises the benefits scheme
inv-dh-eob-02: At least reference or a valid identifier shall be present
... provider S1..1Reference(ADHA Core PractitionerRole)Party responsible for the claim
... priority 0..1CodeableConceptDesired processing urgency
Binding: ProcessPriorityCodes (example)
... prescription S1..1Reference(ADHA PBS Claim Item)Prescription authorizing services or products
.... reference 1..1stringLiteral reference, Relative, internal or absolute URL
... outcome S1..1codequeued | complete | error | partial
Fixed Value: complete
... insurance S1..1BackboneElementPatient insurance information
.... focal S1..1booleanCoverage to be used for adjudication
Fixed Value: true
.... coverage S1..1Reference(Coverage)Medicare or Veteran card information
... item S1..1BackboneElementProduct or service provided
.... sequence S1..1positiveIntItem instance identifier
Fixed Value: 1
.... category S1..1CodeableConceptBenefit classification
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medicare-benefit-claim-category-1 (extensible)
.... productOrService S1..1CodeableConceptPBS Billing code
Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
.... serviced[x] S1..1date, PeriodDate or dates of service or product delivery
.... quantity S0..1SimpleQuantityCount of products or services

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ExplanationOfBenefit 0..*ExplanationOfBenefitRecord of Claim against PBS or RPBS
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S1..*IdentifierBusiness Identifier for the resource
... status ?!SΣ1..1codeactive | cancelled | draft | entered-in-error
Binding: ExplanationOfBenefitStatus (required): A code specifying the state of the resource instance.


Fixed Value: active
... type SΣ1..1CodeableConceptCategory or discipline
Binding: ClaimTypeCodes (extensible): The type or discipline-style of the claim.


Required Pattern: At least the following
.... id0..1idUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1idUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/claim-type
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: pharmacy
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... subType S1..1CodeableConceptMore granular claim type
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medicare-benefit-claim-category-1 (required)
... use SΣ1..1codeclaim | preauthorization | predetermination
Binding: Use (required): Complete, proposed, exploratory, other.


Fixed Value: claim
... patient SΣC1..1Reference(ADHA Core Patient)The recipient of the products and services
inv-dh-eob-01: At least reference or a valid identifier shall be present
... billablePeriod Σ0..1PeriodRelevant time frame for the claim
... created SΣC1..1dateTimeResponse creation date
inv-dh-eob-03: Date shall be at least to day
... enterer 0..1Reference(Practitioner | PractitionerRole)Author of the claim
... insurer SΣC1..1Reference(ADHA Core Organization)Australian Government department that subsidises the benefits scheme
inv-dh-eob-02: At least reference or a valid identifier shall be present
... provider SΣ1..1Reference(ADHA Core PractitionerRole)Party responsible for the claim
... priority 0..1CodeableConceptDesired processing urgency
Binding: ProcessPriorityCodes (example)
... fundsReserveRequested 0..1CodeableConceptFor whom to reserve funds
Binding: Funds Reservation Codes (example): For whom funds are to be reserved: (Patient, Provider, None).

... fundsReserve 0..1CodeableConceptFunds reserved status
Binding: Funds Reservation Codes (example): For whom funds are to be reserved: (Patient, Provider, None).

... related 0..*BackboneElementPrior or corollary claims
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... claim 0..1Reference(Claim)Reference to the related claim
.... relationship 0..1CodeableConceptHow the reference claim is related
Binding: ExampleRelatedClaimRelationshipCodes (example): Relationship of this claim to a related Claim.

.... reference 0..1IdentifierFile or case reference
... prescription S1..1Reference(ADHA PBS Claim Item)Prescription authorizing services or products
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... originalPrescription 0..1Reference(MedicationRequest)Original prescription if superceded by fulfiller
... payee 0..1BackboneElementRecipient of benefits payable
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 0..1CodeableConceptCategory of recipient
Binding: Claim Payee Type Codes (example): A code for the party to be reimbursed.

.... party 0..1Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson)Recipient reference
... referral 0..1Reference(ServiceRequest)Treatment Referral
... facility 0..1Reference(Location)Servicing Facility
... claim 0..1Reference(Claim)Claim reference
... claimResponse 0..1Reference(ClaimResponse)Claim response reference
... outcome SΣ1..1codequeued | complete | error | partial
Binding: ClaimProcessingCodes (required): The result of the claim processing.


Fixed Value: complete
... disposition 0..1stringDisposition Message
... preAuthRef 0..*stringPreauthorization reference
... preAuthRefPeriod 0..*PeriodPreauthorization in-effect period
... careTeam 0..*BackboneElementCare Team members
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... sequence 1..1positiveIntOrder of care team
.... provider 1..1Reference(Practitioner | PractitionerRole | Organization)Practitioner or organization
.... responsible 0..1booleanIndicator of the lead practitioner
.... role 0..1CodeableConceptFunction within the team
Binding: ClaimCareTeamRoleCodes (example): The role codes for the care team members.

.... qualification 0..1CodeableConceptPractitioner credential or specialization
Binding: ExampleProviderQualificationCodes (example): Provider professional qualifications.

... supportingInfo 0..*BackboneElementSupporting information
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... sequence 1..1positiveIntInformation instance identifier
.... category 1..1CodeableConceptClassification of the supplied information
Binding: ClaimInformationCategoryCodes (example): The valuset used for additional information category codes.

.... code 0..1CodeableConceptType of information
Binding: ExceptionCodes (example): The valuset used for additional information codes.

.... timing[x] 0..1When it occurred
..... timingDatedate
..... timingPeriodPeriod
.... value[x] 0..1Data to be provided
..... valueBooleanboolean
..... valueStringstring
..... valueQuantityQuantity
..... valueAttachmentAttachment
..... valueReferenceReference(Resource)
.... reason 0..1CodingExplanation for the information
Binding: MissingToothReasonCodes (example): Reason codes for the missing teeth.

... diagnosis 0..*BackboneElementPertinent diagnosis information
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... sequence 1..1positiveIntDiagnosis instance identifier
.... diagnosis[x] 1..1Nature of illness or problem
Binding: ICD-10Codes (example): ICD10 Diagnostic codes.

..... diagnosisCodeableConceptCodeableConcept
..... diagnosisReferenceReference(Condition)
.... type 0..*CodeableConceptTiming or nature of the diagnosis
Binding: ExampleDiagnosisTypeCodes (example): The type of the diagnosis: admitting, principal, discharge.


.... onAdmission 0..1CodeableConceptPresent on admission
Binding: ExampleDiagnosisOnAdmissionCodes (example): Present on admission.

.... packageCode 0..1CodeableConceptPackage billing code
Binding: ExampleDiagnosisRelatedGroupCodes (example): The DRG codes associated with the diagnosis.

... procedure 0..*BackboneElementClinical procedures performed
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... sequence 1..1positiveIntProcedure instance identifier
.... type 0..*CodeableConceptCategory of Procedure
Binding: ExampleProcedureTypeCodes (example): Example procedure type codes.


.... date 0..1dateTimeWhen the procedure was performed
.... procedure[x] 1..1Specific clinical procedure
Binding: ICD-10ProcedureCodes (example): ICD10 Procedure codes.

..... procedureCodeableConceptCodeableConcept
..... procedureReferenceReference(Procedure)
.... udi 0..*Reference(Device)Unique device identifier
... precedence 0..1positiveIntPrecedence (primary, secondary, etc.)
... insurance SΣ1..1BackboneElementPatient insurance information
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... focal SΣ1..1booleanCoverage to be used for adjudication
Fixed Value: true
.... coverage SΣ1..1Reference(Coverage)Medicare or Veteran card information
.... preAuthRef 0..*stringPrior authorization reference number
... accident 0..1BackboneElementDetails of the event
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... date 0..1dateWhen the incident occurred
.... type 0..1CodeableConceptThe nature of the accident
Binding: ActIncidentCode (extensible): Type of accident: work place, auto, etc.

.... location[x] 0..1Where the event occurred
..... locationAddressAddress
..... locationReferenceReference(Location)
... item S1..1BackboneElementProduct or service provided
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... sequence S1..1positiveIntItem instance identifier
Fixed Value: 1
.... careTeamSequence 0..*positiveIntApplicable care team members
.... diagnosisSequence 0..*positiveIntApplicable diagnoses
.... procedureSequence 0..*positiveIntApplicable procedures
.... informationSequence 0..*positiveIntApplicable exception and supporting information
.... revenue 0..1CodeableConceptRevenue or cost center code
Binding: ExampleRevenueCenterCodes (example): Codes for the revenue or cost centers supplying the service and/or products.

.... category S1..1CodeableConceptBenefit classification
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medicare-benefit-claim-category-1 (extensible)
.... productOrService S1..1CodeableConceptPBS Billing code
Binding: USCLSCodes (example): Allowable service and product codes.


Required Pattern: At least the following
..... id0..1idUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1idUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
...... version0..1stringVersion of the system - if relevant
...... code0..1codeSymbol in syntax defined by the system
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
.... modifier 0..*CodeableConceptProduct or service billing modifiers
Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.


.... programCode 0..*CodeableConceptProgram the product or service is provided under
Binding: ExampleProgramReasonCodes (example): Program specific reason codes.


.... serviced[x] S1..1Date or dates of service or product delivery
..... servicedDatedate
..... servicedPeriodPeriod
.... location[x] 0..1Place of service or where product was supplied
Binding: ExampleServicePlaceCodes (example): Place where the service is rendered.

..... locationCodeableConceptCodeableConcept
..... locationAddressAddress
..... locationReferenceReference(Location)
.... quantity S0..1SimpleQuantityCount of products or services
.... unitPrice 0..1MoneyFee, charge or cost per item
.... factor 0..1decimalPrice scaling factor
.... net 0..1MoneyTotal item cost
.... udi 0..*Reference(Device)Unique device identifier
.... bodySite 0..1CodeableConceptAnatomical location
Binding: OralSiteCodes (example): The code for the teeth, quadrant, sextant and arch.

.... subSite 0..*CodeableConceptAnatomical sub-location
Binding: SurfaceCodes (example): The code for the tooth surface and surface combinations.


.... encounter 0..*Reference(Encounter)Encounters related to this billed item
.... noteNumber 0..*positiveIntApplicable note numbers
.... adjudication 0..*BackboneElementAdjudication details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... category 1..1CodeableConceptType of adjudication information
Binding: AdjudicationValueCodes (example): The adjudication codes.

..... reason 0..1CodeableConceptExplanation of adjudication outcome
Binding: AdjudicationReasonCodes (example): Adjudication reason codes.

..... amount 0..1MoneyMonetary amount
..... value 0..1decimalNon-monitary value
.... detail 0..*BackboneElementAdditional items
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... sequence 1..1positiveIntProduct or service provided
..... revenue 0..1CodeableConceptRevenue or cost center code
Binding: ExampleRevenueCenterCodes (example): Codes for the revenue or cost centers supplying the service and/or products.

..... category 0..1CodeableConceptBenefit classification
Binding: BenefitCategoryCodes (example): Benefit categories such as: oral, medical, vision, oral-basic etc.

..... productOrService 1..1CodeableConceptBilling, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.

..... modifier 0..*CodeableConceptService/Product billing modifiers
Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.


..... programCode 0..*CodeableConceptProgram the product or service is provided under
Binding: ExampleProgramReasonCodes (example): Program specific reason codes.


..... quantity 0..1SimpleQuantityCount of products or services
..... unitPrice 0..1MoneyFee, charge or cost per item
..... factor 0..1decimalPrice scaling factor
..... net 0..1MoneyTotal item cost
..... udi 0..*Reference(Device)Unique device identifier
..... noteNumber 0..*positiveIntApplicable note numbers
..... adjudication 0..*See adjudication (ExplanationOfBenefit)Detail level adjudication details
..... subDetail 0..*BackboneElementAdditional items
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... sequence 1..1positiveIntProduct or service provided
...... revenue 0..1CodeableConceptRevenue or cost center code
Binding: ExampleRevenueCenterCodes (example): Codes for the revenue or cost centers supplying the service and/or products.

...... category 0..1CodeableConceptBenefit classification
Binding: BenefitCategoryCodes (example): Benefit categories such as: oral, medical, vision, oral-basic etc.

...... productOrService 1..1CodeableConceptBilling, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.

...... modifier 0..*CodeableConceptService/Product billing modifiers
Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.


...... programCode 0..*CodeableConceptProgram the product or service is provided under
Binding: ExampleProgramReasonCodes (example): Program specific reason codes.


...... quantity 0..1SimpleQuantityCount of products or services
...... unitPrice 0..1MoneyFee, charge or cost per item
...... factor 0..1decimalPrice scaling factor
...... net 0..1MoneyTotal item cost
...... udi 0..*Reference(Device)Unique device identifier
...... noteNumber 0..*positiveIntApplicable note numbers
...... adjudication 0..*See adjudication (ExplanationOfBenefit)Subdetail level adjudication details
... addItem 0..*BackboneElementInsurer added line items
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... itemSequence 0..*positiveIntItem sequence number
.... detailSequence 0..*positiveIntDetail sequence number
.... subDetailSequence 0..*positiveIntSubdetail sequence number
.... provider 0..*Reference(Practitioner | PractitionerRole | Organization)Authorized providers
.... productOrService 1..1CodeableConceptBilling, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.

.... modifier 0..*CodeableConceptService/Product billing modifiers
Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.


.... programCode 0..*CodeableConceptProgram the product or service is provided under
Binding: ExampleProgramReasonCodes (example): Program specific reason codes.


.... serviced[x] 0..1Date or dates of service or product delivery
..... servicedDatedate
..... servicedPeriodPeriod
.... location[x] 0..1Place of service or where product was supplied
Binding: ExampleServicePlaceCodes (example): Place where the service is rendered.

..... locationCodeableConceptCodeableConcept
..... locationAddressAddress
..... locationReferenceReference(Location)
.... quantity 0..1SimpleQuantityCount of products or services
.... unitPrice 0..1MoneyFee, charge or cost per item
.... factor 0..1decimalPrice scaling factor
.... net 0..1MoneyTotal item cost
.... bodySite 0..1CodeableConceptAnatomical location
Binding: OralSiteCodes (example): The code for the teeth, quadrant, sextant and arch.

.... subSite 0..*CodeableConceptAnatomical sub-location
Binding: SurfaceCodes (example): The code for the tooth surface and surface combinations.


.... noteNumber 0..*positiveIntApplicable note numbers
.... adjudication 0..*See adjudication (ExplanationOfBenefit)Added items adjudication
.... detail 0..*BackboneElementInsurer added line items
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... productOrService 1..1CodeableConceptBilling, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.

..... modifier 0..*CodeableConceptService/Product billing modifiers
Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.


..... quantity 0..1SimpleQuantityCount of products or services
..... unitPrice 0..1MoneyFee, charge or cost per item
..... factor 0..1decimalPrice scaling factor
..... net 0..1MoneyTotal item cost
..... noteNumber 0..*positiveIntApplicable note numbers
..... adjudication 0..*See adjudication (ExplanationOfBenefit)Added items adjudication
..... subDetail 0..*BackboneElementInsurer added line items
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... productOrService 1..1CodeableConceptBilling, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.

...... modifier 0..*CodeableConceptService/Product billing modifiers
Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.


...... quantity 0..1SimpleQuantityCount of products or services
...... unitPrice 0..1MoneyFee, charge or cost per item
...... factor 0..1decimalPrice scaling factor
...... net 0..1MoneyTotal item cost
...... noteNumber 0..*positiveIntApplicable note numbers
...... adjudication 0..*See adjudication (ExplanationOfBenefit)Added items adjudication
... adjudication 0..*See adjudication (ExplanationOfBenefit)Header-level adjudication
... total Σ0..*BackboneElementAdjudication totals
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... category Σ1..1CodeableConceptType of adjudication information
Binding: AdjudicationValueCodes (example): The adjudication codes.

.... amount Σ1..1MoneyFinancial total for the category
... payment 0..1BackboneElementPayment Details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 0..1CodeableConceptPartial or complete payment
Binding: ExamplePaymentTypeCodes (example): The type (partial, complete) of the payment.

.... adjustment 0..1MoneyPayment adjustment for non-claim issues
.... adjustmentReason 0..1CodeableConceptExplanation for the variance
Binding: PaymentAdjustmentReasonCodes (example): Payment Adjustment reason codes.

.... date 0..1dateExpected date of payment
.... amount 0..1MoneyPayable amount after adjustment
.... identifier 0..1IdentifierBusiness identifier for the payment
... formCode 0..1CodeableConceptPrinted form identifier
Binding: Form Codes (example): The forms codes.

... form 0..1AttachmentPrinted reference or actual form
... processNote 0..*BackboneElementNote concerning adjudication
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... number 0..1positiveIntNote instance identifier
.... type 0..1codedisplay | print | printoper
Binding: NoteType (required): The presentation types of notes.

.... text 0..1stringNote explanatory text
.... language 0..1CodeableConceptLanguage of the text
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... benefitPeriod 0..1PeriodWhen the benefits are applicable
... benefitBalance 0..*BackboneElementBalance by Benefit Category
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... category 1..1CodeableConceptBenefit classification
Binding: BenefitCategoryCodes (example): Benefit categories such as: oral, medical, vision, oral-basic etc.

.... excluded 0..1booleanExcluded from the plan
.... name 0..1stringShort name for the benefit
.... description 0..1stringDescription of the benefit or services covered
.... network 0..1CodeableConceptIn or out of network
Binding: NetworkTypeCodes (example): Code to classify in or out of network services.

.... unit 0..1CodeableConceptIndividual or family
Binding: UnitTypeCodes (example): Unit covered/serviced - individual or family.

.... term 0..1CodeableConceptAnnual or lifetime
Binding: BenefitTermCodes (example): Coverage unit - annual, lifetime.

.... financial 0..*BackboneElementBenefit Summary
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1CodeableConceptBenefit classification
Binding: BenefitTypeCodes (example): Deductable, visits, co-pay, etc.

..... allowed[x] 0..1Benefits allowed
...... allowedUnsignedIntunsignedInt
...... allowedStringstring
...... allowedMoneyMoney
..... used[x] 0..1Benefits used
...... usedUnsignedIntunsignedInt
...... usedMoneyMoney

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ExplanationOfBenefit 0..*ExplanationOfBenefitRecord of Claim against PBS or RPBS
... identifier S1..*IdentifierBusiness Identifier for the resource
... status S1..1codeactive | cancelled | draft | entered-in-error
Fixed Value: active
... type S1..1CodeableConceptCategory or discipline
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/claim-type
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: pharmacy
... subType S1..1CodeableConceptMore granular claim type
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medicare-benefit-claim-category-1 (required)
... use S1..1codeclaim | preauthorization | predetermination
Fixed Value: claim
... patient SC1..1Reference(ADHA Core Patient)The recipient of the products and services
inv-dh-eob-01: At least reference or a valid identifier shall be present
... created SC1..1dateTimeResponse creation date
inv-dh-eob-03: Date shall be at least to day
... insurer SC1..1Reference(ADHA Core Organization)Australian Government department that subsidises the benefits scheme
inv-dh-eob-02: At least reference or a valid identifier shall be present
... provider S1..1Reference(ADHA Core PractitionerRole)Party responsible for the claim
... priority 0..1CodeableConceptDesired processing urgency
Binding: ProcessPriorityCodes (example)
... prescription S1..1Reference(ADHA PBS Claim Item)Prescription authorizing services or products
.... reference 1..1stringLiteral reference, Relative, internal or absolute URL
... outcome S1..1codequeued | complete | error | partial
Fixed Value: complete
... insurance S1..1BackboneElementPatient insurance information
.... focal S1..1booleanCoverage to be used for adjudication
Fixed Value: true
.... coverage S1..1Reference(Coverage)Medicare or Veteran card information
... item S1..1BackboneElementProduct or service provided
.... sequence S1..1positiveIntItem instance identifier
Fixed Value: 1
.... category S1..1CodeableConceptBenefit classification
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medicare-benefit-claim-category-1 (extensible)
.... productOrService S1..1CodeableConceptPBS Billing code
Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
.... serviced[x] S1..1date, PeriodDate or dates of service or product delivery
.... quantity S0..1SimpleQuantityCount of products or services

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ExplanationOfBenefit 0..*ExplanationOfBenefitRecord of Claim against PBS or RPBS
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S1..*IdentifierBusiness Identifier for the resource
... status ?!SΣ1..1codeactive | cancelled | draft | entered-in-error
Binding: ExplanationOfBenefitStatus (required): A code specifying the state of the resource instance.


Fixed Value: active
... type SΣ1..1CodeableConceptCategory or discipline
Binding: ClaimTypeCodes (extensible): The type or discipline-style of the claim.


Required Pattern: At least the following
.... id0..1idUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1idUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/claim-type
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: pharmacy
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... subType S1..1CodeableConceptMore granular claim type
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medicare-benefit-claim-category-1 (required)
... use SΣ1..1codeclaim | preauthorization | predetermination
Binding: Use (required): Complete, proposed, exploratory, other.


Fixed Value: claim
... patient SΣC1..1Reference(ADHA Core Patient)The recipient of the products and services
inv-dh-eob-01: At least reference or a valid identifier shall be present
... billablePeriod Σ0..1PeriodRelevant time frame for the claim
... created SΣC1..1dateTimeResponse creation date
inv-dh-eob-03: Date shall be at least to day
... enterer 0..1Reference(Practitioner | PractitionerRole)Author of the claim
... insurer SΣC1..1Reference(ADHA Core Organization)Australian Government department that subsidises the benefits scheme
inv-dh-eob-02: At least reference or a valid identifier shall be present
... provider SΣ1..1Reference(ADHA Core PractitionerRole)Party responsible for the claim
... priority 0..1CodeableConceptDesired processing urgency
Binding: ProcessPriorityCodes (example)
... fundsReserveRequested 0..1CodeableConceptFor whom to reserve funds
Binding: Funds Reservation Codes (example): For whom funds are to be reserved: (Patient, Provider, None).

... fundsReserve 0..1CodeableConceptFunds reserved status
Binding: Funds Reservation Codes (example): For whom funds are to be reserved: (Patient, Provider, None).

... related 0..*BackboneElementPrior or corollary claims
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... claim 0..1Reference(Claim)Reference to the related claim
.... relationship 0..1CodeableConceptHow the reference claim is related
Binding: ExampleRelatedClaimRelationshipCodes (example): Relationship of this claim to a related Claim.

.... reference 0..1IdentifierFile or case reference
... prescription S1..1Reference(ADHA PBS Claim Item)Prescription authorizing services or products
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... originalPrescription 0..1Reference(MedicationRequest)Original prescription if superceded by fulfiller
... payee 0..1BackboneElementRecipient of benefits payable
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 0..1CodeableConceptCategory of recipient
Binding: Claim Payee Type Codes (example): A code for the party to be reimbursed.

.... party 0..1Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson)Recipient reference
... referral 0..1Reference(ServiceRequest)Treatment Referral
... facility 0..1Reference(Location)Servicing Facility
... claim 0..1Reference(Claim)Claim reference
... claimResponse 0..1Reference(ClaimResponse)Claim response reference
... outcome SΣ1..1codequeued | complete | error | partial
Binding: ClaimProcessingCodes (required): The result of the claim processing.


Fixed Value: complete
... disposition 0..1stringDisposition Message
... preAuthRef 0..*stringPreauthorization reference
... preAuthRefPeriod 0..*PeriodPreauthorization in-effect period
... careTeam 0..*BackboneElementCare Team members
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... sequence 1..1positiveIntOrder of care team
.... provider 1..1Reference(Practitioner | PractitionerRole | Organization)Practitioner or organization
.... responsible 0..1booleanIndicator of the lead practitioner
.... role 0..1CodeableConceptFunction within the team
Binding: ClaimCareTeamRoleCodes (example): The role codes for the care team members.

.... qualification 0..1CodeableConceptPractitioner credential or specialization
Binding: ExampleProviderQualificationCodes (example): Provider professional qualifications.

... supportingInfo 0..*BackboneElementSupporting information
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... sequence 1..1positiveIntInformation instance identifier
.... category 1..1CodeableConceptClassification of the supplied information
Binding: ClaimInformationCategoryCodes (example): The valuset used for additional information category codes.

.... code 0..1CodeableConceptType of information
Binding: ExceptionCodes (example): The valuset used for additional information codes.

.... timing[x] 0..1When it occurred
..... timingDatedate
..... timingPeriodPeriod
.... value[x] 0..1Data to be provided
..... valueBooleanboolean
..... valueStringstring
..... valueQuantityQuantity
..... valueAttachmentAttachment
..... valueReferenceReference(Resource)
.... reason 0..1CodingExplanation for the information
Binding: MissingToothReasonCodes (example): Reason codes for the missing teeth.

... diagnosis 0..*BackboneElementPertinent diagnosis information
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... sequence 1..1positiveIntDiagnosis instance identifier
.... diagnosis[x] 1..1Nature of illness or problem
Binding: ICD-10Codes (example): ICD10 Diagnostic codes.

..... diagnosisCodeableConceptCodeableConcept
..... diagnosisReferenceReference(Condition)
.... type 0..*CodeableConceptTiming or nature of the diagnosis
Binding: ExampleDiagnosisTypeCodes (example): The type of the diagnosis: admitting, principal, discharge.


.... onAdmission 0..1CodeableConceptPresent on admission
Binding: ExampleDiagnosisOnAdmissionCodes (example): Present on admission.

.... packageCode 0..1CodeableConceptPackage billing code
Binding: ExampleDiagnosisRelatedGroupCodes (example): The DRG codes associated with the diagnosis.

... procedure 0..*BackboneElementClinical procedures performed
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... sequence 1..1positiveIntProcedure instance identifier
.... type 0..*CodeableConceptCategory of Procedure
Binding: ExampleProcedureTypeCodes (example): Example procedure type codes.


.... date 0..1dateTimeWhen the procedure was performed
.... procedure[x] 1..1Specific clinical procedure
Binding: ICD-10ProcedureCodes (example): ICD10 Procedure codes.

..... procedureCodeableConceptCodeableConcept
..... procedureReferenceReference(Procedure)
.... udi 0..*Reference(Device)Unique device identifier
... precedence 0..1positiveIntPrecedence (primary, secondary, etc.)
... insurance SΣ1..1BackboneElementPatient insurance information
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... focal SΣ1..1booleanCoverage to be used for adjudication
Fixed Value: true
.... coverage SΣ1..1Reference(Coverage)Medicare or Veteran card information
.... preAuthRef 0..*stringPrior authorization reference number
... accident 0..1BackboneElementDetails of the event
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... date 0..1dateWhen the incident occurred
.... type 0..1CodeableConceptThe nature of the accident
Binding: ActIncidentCode (extensible): Type of accident: work place, auto, etc.

.... location[x] 0..1Where the event occurred
..... locationAddressAddress
..... locationReferenceReference(Location)
... item S1..1BackboneElementProduct or service provided
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... sequence S1..1positiveIntItem instance identifier
Fixed Value: 1
.... careTeamSequence 0..*positiveIntApplicable care team members
.... diagnosisSequence 0..*positiveIntApplicable diagnoses
.... procedureSequence 0..*positiveIntApplicable procedures
.... informationSequence 0..*positiveIntApplicable exception and supporting information
.... revenue 0..1CodeableConceptRevenue or cost center code
Binding: ExampleRevenueCenterCodes (example): Codes for the revenue or cost centers supplying the service and/or products.

.... category S1..1CodeableConceptBenefit classification
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medicare-benefit-claim-category-1 (extensible)
.... productOrService S1..1CodeableConceptPBS Billing code
Binding: USCLSCodes (example): Allowable service and product codes.


Required Pattern: At least the following
..... id0..1idUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1idUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
...... version0..1stringVersion of the system - if relevant
...... code0..1codeSymbol in syntax defined by the system
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
.... modifier 0..*CodeableConceptProduct or service billing modifiers
Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.


.... programCode 0..*CodeableConceptProgram the product or service is provided under
Binding: ExampleProgramReasonCodes (example): Program specific reason codes.


.... serviced[x] S1..1Date or dates of service or product delivery
..... servicedDatedate
..... servicedPeriodPeriod
.... location[x] 0..1Place of service or where product was supplied
Binding: ExampleServicePlaceCodes (example): Place where the service is rendered.

..... locationCodeableConceptCodeableConcept
..... locationAddressAddress
..... locationReferenceReference(Location)
.... quantity S0..1SimpleQuantityCount of products or services
.... unitPrice 0..1MoneyFee, charge or cost per item
.... factor 0..1decimalPrice scaling factor
.... net 0..1MoneyTotal item cost
.... udi 0..*Reference(Device)Unique device identifier
.... bodySite 0..1CodeableConceptAnatomical location
Binding: OralSiteCodes (example): The code for the teeth, quadrant, sextant and arch.

.... subSite 0..*CodeableConceptAnatomical sub-location
Binding: SurfaceCodes (example): The code for the tooth surface and surface combinations.


.... encounter 0..*Reference(Encounter)Encounters related to this billed item
.... noteNumber 0..*positiveIntApplicable note numbers
.... adjudication 0..*BackboneElementAdjudication details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... category 1..1CodeableConceptType of adjudication information
Binding: AdjudicationValueCodes (example): The adjudication codes.

..... reason 0..1CodeableConceptExplanation of adjudication outcome
Binding: AdjudicationReasonCodes (example): Adjudication reason codes.

..... amount 0..1MoneyMonetary amount
..... value 0..1decimalNon-monitary value
.... detail 0..*BackboneElementAdditional items
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... sequence 1..1positiveIntProduct or service provided
..... revenue 0..1CodeableConceptRevenue or cost center code
Binding: ExampleRevenueCenterCodes (example): Codes for the revenue or cost centers supplying the service and/or products.

..... category 0..1CodeableConceptBenefit classification
Binding: BenefitCategoryCodes (example): Benefit categories such as: oral, medical, vision, oral-basic etc.

..... productOrService 1..1CodeableConceptBilling, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.

..... modifier 0..*CodeableConceptService/Product billing modifiers
Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.


..... programCode 0..*CodeableConceptProgram the product or service is provided under
Binding: ExampleProgramReasonCodes (example): Program specific reason codes.


..... quantity 0..1SimpleQuantityCount of products or services
..... unitPrice 0..1MoneyFee, charge or cost per item
..... factor 0..1decimalPrice scaling factor
..... net 0..1MoneyTotal item cost
..... udi 0..*Reference(Device)Unique device identifier
..... noteNumber 0..*positiveIntApplicable note numbers
..... adjudication 0..*See adjudication (ExplanationOfBenefit)Detail level adjudication details
..... subDetail 0..*BackboneElementAdditional items
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... sequence 1..1positiveIntProduct or service provided
...... revenue 0..1CodeableConceptRevenue or cost center code
Binding: ExampleRevenueCenterCodes (example): Codes for the revenue or cost centers supplying the service and/or products.

...... category 0..1CodeableConceptBenefit classification
Binding: BenefitCategoryCodes (example): Benefit categories such as: oral, medical, vision, oral-basic etc.

...... productOrService 1..1CodeableConceptBilling, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.

...... modifier 0..*CodeableConceptService/Product billing modifiers
Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.


...... programCode 0..*CodeableConceptProgram the product or service is provided under
Binding: ExampleProgramReasonCodes (example): Program specific reason codes.


...... quantity 0..1SimpleQuantityCount of products or services
...... unitPrice 0..1MoneyFee, charge or cost per item
...... factor 0..1decimalPrice scaling factor
...... net 0..1MoneyTotal item cost
...... udi 0..*Reference(Device)Unique device identifier
...... noteNumber 0..*positiveIntApplicable note numbers
...... adjudication 0..*See adjudication (ExplanationOfBenefit)Subdetail level adjudication details
... addItem 0..*BackboneElementInsurer added line items
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... itemSequence 0..*positiveIntItem sequence number
.... detailSequence 0..*positiveIntDetail sequence number
.... subDetailSequence 0..*positiveIntSubdetail sequence number
.... provider 0..*Reference(Practitioner | PractitionerRole | Organization)Authorized providers
.... productOrService 1..1CodeableConceptBilling, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.

.... modifier 0..*CodeableConceptService/Product billing modifiers
Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.


.... programCode 0..*CodeableConceptProgram the product or service is provided under
Binding: ExampleProgramReasonCodes (example): Program specific reason codes.


.... serviced[x] 0..1Date or dates of service or product delivery
..... servicedDatedate
..... servicedPeriodPeriod
.... location[x] 0..1Place of service or where product was supplied
Binding: ExampleServicePlaceCodes (example): Place where the service is rendered.

..... locationCodeableConceptCodeableConcept
..... locationAddressAddress
..... locationReferenceReference(Location)
.... quantity 0..1SimpleQuantityCount of products or services
.... unitPrice 0..1MoneyFee, charge or cost per item
.... factor 0..1decimalPrice scaling factor
.... net 0..1MoneyTotal item cost
.... bodySite 0..1CodeableConceptAnatomical location
Binding: OralSiteCodes (example): The code for the teeth, quadrant, sextant and arch.

.... subSite 0..*CodeableConceptAnatomical sub-location
Binding: SurfaceCodes (example): The code for the tooth surface and surface combinations.


.... noteNumber 0..*positiveIntApplicable note numbers
.... adjudication 0..*See adjudication (ExplanationOfBenefit)Added items adjudication
.... detail 0..*BackboneElementInsurer added line items
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... productOrService 1..1CodeableConceptBilling, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.

..... modifier 0..*CodeableConceptService/Product billing modifiers
Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.


..... quantity 0..1SimpleQuantityCount of products or services
..... unitPrice 0..1MoneyFee, charge or cost per item
..... factor 0..1decimalPrice scaling factor
..... net 0..1MoneyTotal item cost
..... noteNumber 0..*positiveIntApplicable note numbers
..... adjudication 0..*See adjudication (ExplanationOfBenefit)Added items adjudication
..... subDetail 0..*BackboneElementInsurer added line items
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... productOrService 1..1CodeableConceptBilling, service, product, or drug code
Binding: USCLSCodes (example): Allowable service and product codes.

...... modifier 0..*CodeableConceptService/Product billing modifiers
Binding: ModifierTypeCodes (example): Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.


...... quantity 0..1SimpleQuantityCount of products or services
...... unitPrice 0..1MoneyFee, charge or cost per item
...... factor 0..1decimalPrice scaling factor
...... net 0..1MoneyTotal item cost
...... noteNumber 0..*positiveIntApplicable note numbers
...... adjudication 0..*See adjudication (ExplanationOfBenefit)Added items adjudication
... adjudication 0..*See adjudication (ExplanationOfBenefit)Header-level adjudication
... total Σ0..*BackboneElementAdjudication totals
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... category Σ1..1CodeableConceptType of adjudication information
Binding: AdjudicationValueCodes (example): The adjudication codes.

.... amount Σ1..1MoneyFinancial total for the category
... payment 0..1BackboneElementPayment Details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 0..1CodeableConceptPartial or complete payment
Binding: ExamplePaymentTypeCodes (example): The type (partial, complete) of the payment.

.... adjustment 0..1MoneyPayment adjustment for non-claim issues
.... adjustmentReason 0..1CodeableConceptExplanation for the variance
Binding: PaymentAdjustmentReasonCodes (example): Payment Adjustment reason codes.

.... date 0..1dateExpected date of payment
.... amount 0..1MoneyPayable amount after adjustment
.... identifier 0..1IdentifierBusiness identifier for the payment
... formCode 0..1CodeableConceptPrinted form identifier
Binding: Form Codes (example): The forms codes.

... form 0..1AttachmentPrinted reference or actual form
... processNote 0..*BackboneElementNote concerning adjudication
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... number 0..1positiveIntNote instance identifier
.... type 0..1codedisplay | print | printoper
Binding: NoteType (required): The presentation types of notes.

.... text 0..1stringNote explanatory text
.... language 0..1CodeableConceptLanguage of the text
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... benefitPeriod 0..1PeriodWhen the benefits are applicable
... benefitBalance 0..*BackboneElementBalance by Benefit Category
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... category 1..1CodeableConceptBenefit classification
Binding: BenefitCategoryCodes (example): Benefit categories such as: oral, medical, vision, oral-basic etc.

.... excluded 0..1booleanExcluded from the plan
.... name 0..1stringShort name for the benefit
.... description 0..1stringDescription of the benefit or services covered
.... network 0..1CodeableConceptIn or out of network
Binding: NetworkTypeCodes (example): Code to classify in or out of network services.

.... unit 0..1CodeableConceptIndividual or family
Binding: UnitTypeCodes (example): Unit covered/serviced - individual or family.

.... term 0..1CodeableConceptAnnual or lifetime
Binding: BenefitTermCodes (example): Coverage unit - annual, lifetime.

.... financial 0..*BackboneElementBenefit Summary
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1CodeableConceptBenefit classification
Binding: BenefitTypeCodes (example): Deductable, visits, co-pay, etc.

..... allowed[x] 0..1Benefits allowed
...... allowedUnsignedIntunsignedInt
...... allowedStringstring
...... allowedMoneyMoney
..... used[x] 0..1Benefits used
...... usedUnsignedIntunsignedInt
...... usedMoneyMoney

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

Terminology Bindings

PathConformanceValueSet / Code
ExplanationOfBenefit.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
ExplanationOfBenefit.statusrequiredFixed Value: active
ExplanationOfBenefit.typeextensiblePattern: pharmacy
ExplanationOfBenefit.subTyperequiredhttps://healthterminologies.gov.au/fhir/ValueSet/australian-medicare-benefit-claim-category-1
ExplanationOfBenefit.userequiredFixed Value: claim
ExplanationOfBenefit.priorityexampleProcessPriorityCodes
ExplanationOfBenefit.fundsReserveRequestedexampleFunds Reservation Codes
ExplanationOfBenefit.fundsReserveexampleFunds Reservation Codes
ExplanationOfBenefit.related.relationshipexampleExampleRelatedClaimRelationshipCodes
ExplanationOfBenefit.prescription.typeextensibleResourceType
ExplanationOfBenefit.payee.typeexampleClaim Payee Type Codes
ExplanationOfBenefit.outcomerequiredFixed Value: complete
ExplanationOfBenefit.careTeam.roleexampleClaimCareTeamRoleCodes
ExplanationOfBenefit.careTeam.qualificationexampleExampleProviderQualificationCodes
ExplanationOfBenefit.supportingInfo.categoryexampleClaimInformationCategoryCodes
ExplanationOfBenefit.supportingInfo.codeexampleExceptionCodes
ExplanationOfBenefit.supportingInfo.reasonexampleMissingToothReasonCodes
ExplanationOfBenefit.diagnosis.diagnosis[x]exampleICD-10Codes
ExplanationOfBenefit.diagnosis.typeexampleExampleDiagnosisTypeCodes
ExplanationOfBenefit.diagnosis.onAdmissionexampleExampleDiagnosisOnAdmissionCodes
ExplanationOfBenefit.diagnosis.packageCodeexampleExampleDiagnosisRelatedGroupCodes
ExplanationOfBenefit.procedure.typeexampleExampleProcedureTypeCodes
ExplanationOfBenefit.procedure.procedure[x]exampleICD-10ProcedureCodes
ExplanationOfBenefit.accident.typeextensibleActIncidentCode
ExplanationOfBenefit.item.revenueexampleExampleRevenueCenterCodes
ExplanationOfBenefit.item.categoryextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/australian-medicare-benefit-claim-category-1
ExplanationOfBenefit.item.productOrServiceexamplePattern: null
ExplanationOfBenefit.item.modifierexampleModifierTypeCodes
ExplanationOfBenefit.item.programCodeexampleExampleProgramReasonCodes
ExplanationOfBenefit.item.location[x]exampleExampleServicePlaceCodes
ExplanationOfBenefit.item.bodySiteexampleOralSiteCodes
ExplanationOfBenefit.item.subSiteexampleSurfaceCodes
ExplanationOfBenefit.item.adjudication.categoryexampleAdjudicationValueCodes
ExplanationOfBenefit.item.adjudication.reasonexampleAdjudicationReasonCodes
ExplanationOfBenefit.item.detail.revenueexampleExampleRevenueCenterCodes
ExplanationOfBenefit.item.detail.categoryexampleBenefitCategoryCodes
ExplanationOfBenefit.item.detail.productOrServiceexampleUSCLSCodes
ExplanationOfBenefit.item.detail.modifierexampleModifierTypeCodes
ExplanationOfBenefit.item.detail.programCodeexampleExampleProgramReasonCodes
ExplanationOfBenefit.item.detail.subDetail.revenueexampleExampleRevenueCenterCodes
ExplanationOfBenefit.item.detail.subDetail.categoryexampleBenefitCategoryCodes
ExplanationOfBenefit.item.detail.subDetail.productOrServiceexampleUSCLSCodes
ExplanationOfBenefit.item.detail.subDetail.modifierexampleModifierTypeCodes
ExplanationOfBenefit.item.detail.subDetail.programCodeexampleExampleProgramReasonCodes
ExplanationOfBenefit.addItem.productOrServiceexampleUSCLSCodes
ExplanationOfBenefit.addItem.modifierexampleModifierTypeCodes
ExplanationOfBenefit.addItem.programCodeexampleExampleProgramReasonCodes
ExplanationOfBenefit.addItem.location[x]exampleExampleServicePlaceCodes
ExplanationOfBenefit.addItem.bodySiteexampleOralSiteCodes
ExplanationOfBenefit.addItem.subSiteexampleSurfaceCodes
ExplanationOfBenefit.addItem.detail.productOrServiceexampleUSCLSCodes
ExplanationOfBenefit.addItem.detail.modifierexampleModifierTypeCodes
ExplanationOfBenefit.addItem.detail.subDetail.productOrServiceexampleUSCLSCodes
ExplanationOfBenefit.addItem.detail.subDetail.modifierexampleModifierTypeCodes
ExplanationOfBenefit.total.categoryexampleAdjudicationValueCodes
ExplanationOfBenefit.payment.typeexampleExamplePaymentTypeCodes
ExplanationOfBenefit.payment.adjustmentReasonexamplePaymentAdjustmentReasonCodes
ExplanationOfBenefit.formCodeexampleForm Codes
ExplanationOfBenefit.processNote.typerequiredNoteType
ExplanationOfBenefit.processNote.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
ExplanationOfBenefit.benefitBalance.categoryexampleBenefitCategoryCodes
ExplanationOfBenefit.benefitBalance.networkexampleNetworkTypeCodes
ExplanationOfBenefit.benefitBalance.unitexampleUnitTypeCodes
ExplanationOfBenefit.benefitBalance.termexampleBenefitTermCodes
ExplanationOfBenefit.benefitBalance.financial.typeexampleBenefitTypeCodes

Search Parameters

None defined.