Australian Digital Health Agency FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/ci-fhir-r4/ and changes regularly. See the Directory of published versions

Resource Profile: ADHA Record of Claim against MBS or DVA

Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-explanationofbenefit-medicare-mbs-1 Version: 1.0.0
Active as of 2025-03-21 Computable Name: ADHAExplanationofBenefitMBS

Copyright/Legal: Copyright © 2023 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.

The purpose of this profile is to define a representation of a record of a claim against the Medicare Benefits Schedule (MBS) or Department of Veterans' Affairs (DVA) 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 an MBS or DVA item claim associated with a patient
  • Record or update an MBS or DVA item claim associated with a patient

This profile may be referred to by APIs, which will be listed here when available.

Profile specific guidance

None.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. ExplanationOfBenefit 0..* ExplanationOfBenefit Record of Claim against MBS or DVA
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier S 1..* Identifier Business Identifier for the resource
ele-1: All FHIR elements must have a @value or children
... type SΣ 1..1 CodeableConcept Category or discipline
Binding: ClaimTypeCodes (required)
ele-1: All FHIR elements must have a @value or children
... subType S 1..1 CodeableConcept More granular claim type
Binding: Australian Medicare Benefit and Claim Category . (required)
ele-1: All FHIR elements must have a @value or children
... use SΣ 1..1 code claim | preauthorization | predetermination
Binding: Use (required): Complete, proposed, exploratory, other.


ele-1: All FHIR elements must have a @value or children
Fixed Value: claim
... patient SΣC 1..1 Reference(ADHA Core Patient) The recipient of the products and services
ele-1: All FHIR elements must have a @value or children
inv-dh-eob-01: At least reference or a valid identifier shall be present
... created SΣC 1..1 dateTime Response creation date
ele-1: All FHIR elements must have a @value or children
inv-dh-eob-03: Date shall be at least to day
... insurer SΣC 1..1 Reference(ADHA Core Organization) Australian Government department that subsidises the benefits scheme
ele-1: All FHIR elements must have a @value or children
inv-dh-eob-02: At least reference or a valid identifier shall be present
... provider SΣ 1..1 Reference(ADHA Core PractitionerRole) Party responsible for the claim
ele-1: All FHIR elements must have a @value or children
... priority 0..1 CodeableConcept Desired processing urgency
Binding: ProcessPriorityCodes (example)
ele-1: All FHIR elements must have a @value or children
... outcome SΣ 1..1 code queued | complete | error | partial
Binding: ClaimProcessingCodes (required): The result of the claim processing.


ele-1: All FHIR elements must have a @value or children
Fixed Value: complete
... insurance SΣ 1..1 BackboneElement Patient insurance information
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... focal SΣ 1..1 boolean Coverage to be used for adjudication
ele-1: All FHIR elements must have a @value or children
Fixed Value: true
.... coverage SΣ 1..1 Reference(Coverage) Medicare or Veteran card information
ele-1: All FHIR elements must have a @value or children
... item S 1..1 BackboneElement Product or service provided
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... sequence S 1..1 positiveInt Item instance identifier
ele-1: All FHIR elements must have a @value or children
Fixed Value: 1
.... category S 1..1 CodeableConcept Benefit classification
Binding: Australian Medicare Benefit and Claim Category . (extensible)
ele-1: All FHIR elements must have a @value or children
.... productOrService S 1..1 CodeableConcept MBS Billing code
Binding: USCLSCodes (example): Allowable service and product codes.


ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: urn:oid:1.2.36.1.2001.1005.21
.... serviced[x] S 1..1 Date or dates of service or product delivery
ele-1: All FHIR elements must have a @value or children
..... servicedDate date
..... servicedPeriod Period
.... location[x] S 0..1 CodeableConcept Service in-hospital indicator
Binding: ExampleServicePlaceCodes (example): Place where the service is rendered.


ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: HOSP
.... quantity S 0..1 SimpleQuantity Count of products or services
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ExplanationOfBenefit.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/explanationofbenefit-status|4.0.1
from the FHIR Standard
ExplanationOfBenefit.typerequiredClaimTypeCodes
http://hl7.org/fhir/ValueSet/claim-type
from the FHIR Standard
ExplanationOfBenefit.subTyperequiredAustralianMedicareBenefitAndClaimCategory .
https://healthterminologies.gov.au/fhir/ValueSet/australian-medicare-benefit-claim-category-1
ExplanationOfBenefit.userequiredFixed Value: claim
http://hl7.org/fhir/ValueSet/claim-use|4.0.1
from the FHIR Standard
ExplanationOfBenefit.priorityexampleProcessPriorityCodes
http://hl7.org/fhir/ValueSet/process-priority
from the FHIR Standard
ExplanationOfBenefit.outcomerequiredFixed Value: complete
http://hl7.org/fhir/ValueSet/remittance-outcome|4.0.1
from the FHIR Standard
ExplanationOfBenefit.item.categoryextensibleAustralianMedicareBenefitAndClaimCategory .
https://healthterminologies.gov.au/fhir/ValueSet/australian-medicare-benefit-claim-category-1
ExplanationOfBenefit.item.productOrServiceexamplePattern: null
http://hl7.org/fhir/ValueSet/service-uscls
from the FHIR Standard
ExplanationOfBenefit.item.location[x]examplePattern: HOSP
http://hl7.org/fhir/ValueSet/service-place
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-eob-01errorExplanationOfBenefit.patientAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-eob-02errorExplanationOfBenefit.insurerAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-eob-03errorExplanationOfBenefit.createdDate shall be at least to day
: toString().length() >= 10

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Below is an overview of the mandatory and optional search parameters. FHIR search operations and the syntax used to describe the interactions is described here.

Name Type Conformance Description Path
identifier token SHALL The business identifier of the Explanation of Benefit ExplanationOfBenefit.identifier
patient:identifier token SHALL The reference to the patient ExplanationOfBenefit.patient.identifier
type token SHALL Classification of the record - for indexing/retrieval ExplanationOfBenefit.type
subType token SHALL Classification of the record using funding scheme - for indexing/retrieval ExplanationOfBenefit.subType
created date SHALL The creation date for the EOB ExplanationOfBenefit.created
status token SHALL Status of the instance ExplanationOfBenefit.status

Mandatory Search Parameters

The following search parameters and search parameter combinations SHALL be supported:

  1. SHALL support searching for all claims for a patient using the patient:identifier search parameter:

    GET [base]/ExplanationOfBenefit?patient:identifier={system|}[code]

    Example:

     GET [base]/ExplanationOfBenefit?patient:identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608000228437
    

    Implementation Notes: Fetches a bundle of all ExplanationOfBenefit resources for the specified patient (how to search by :identifier)

  2. SHALL support searching using the identifier search parameter:

    GET [base]/ExplanationOfBenefit?identifier={system|}[code]

    Example:

     GET [base]/ExplanationOfBenefit?identifier=urn:ietf:rfc:3986|urn:uuid:44a8f148-f5f7-447c-9e68-a9f06635ab6c
    

    Implementation Notes: Fetches a bundle containing any ExplanationOfBenefit resources matching the identifier (how to search by token)

  3. SHALL support searching using the combination patient:identifier and type and status search parameter:
    • including support for OR search on status (e.g.status={system|}[code],{system|}[code],...)

    GET [base]/ExplanationOfBenefit?patient:identifier={system|}[code]&type={system|}[code]&status={system|}[code]

    Example:

     GET [base]/ExplanationOfBenefit?patient:identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608000228437&type=http://terminology.hl7.org/CodeSystem/claim-type|institutional&status=active
    

    Implementation Notes: Fetches a bundle of all active ExplanationOfBenefit resources with the type of "Institutional" for the specified patient (how to search by :identifier and how to search by token)

  4. SHALL support searching using the combination patient:identifier and subType and status search parameter:
    • including support for OR search on status (e.g.status={system|}[code],{system|}[code],...)

    GET [base]/ExplanationOfBenefit?patient:identifier={system|}[code]&subType={system|}[code]&status={system|}[code]

    Example:

     GET [base]/ExplanationOfBenefit?patient:identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608000228437&subType=https://healthterminologies.gov.au/fhir/CodeSystem/australian-benefit-payment-category-1|mbs&status=active
    

    Implementation Notes: Fetches a bundle of all active ExplanationOfBenefit resources with the subType of mbs (MBS) for the specified patient (how to search by :identifier and how to search by token)

  5. SHALL support searching using the combination of the patient:identifier and created and status search parameters:
    • including support for OR search on status (e.g.status={system|}[code],{system|}[code],...)

    GET [base]/ExplanationOfBenefit?patient:identifier={system|}[code]&created=[date]&status={system|}[code]

    Example:

     GET [base]/ExplanationOfBenefit?patient:identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608000228437&created=ge2013-03-14&status=active
    

    Implementation Notes: Fetches a bundle of all active ExplanationOfBenefit resources for the specified patient that have a created date greater than or equal to 21st Jan 2013. (how to search by :identifier and how to search by date)