| Australian Digital Health Agency Medicare Records FHIR Implementation Guide 2.2.0

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

### StructureDefinition: ADHA PBS Medication [Active]

The purpose of this profile is to define a representation of medicinal product information for a prescription item claimed in a claim against the Pharmaceutical Benefits Schedule (PBS) or Repatriation Pharmaceutical Benefits Scheme (RPBS) for the electronic exchange of health information between Medicare repositories and the My Health Record system infrastructure in Australia.

##### Usage scenarios

The following are the usage scenarios expected:

- An individual’s PBS claim item records are uploaded to the My Health Record system from a Medicare repository

##### Each Medication SHALL have

1. a code identifying the medication

##### Must Support

In the context of this profile Must Support SHALL be interpreted as follows.

- The system SHALL be able to store and retrieve the following elements:
  - code
- The system SHALL be able to take the following elements into account when performing processing:
  - manufacturer

##### Profile-specific implementation guidance

No specific guidance.

#### Formal Views of Profile Content

The official URL for this profile is:

    http://ns.electronichealth.net.au/ci/fhir/StructureDefinition/medication-pbs

The purpose of this profile is to define a representation of medicinal product information for a prescription item claimed in a claim against the Pharmaceutical Benefits Schedule (PBS) or Repatriation Pharmaceutical Benefits Scheme (RPBS) for the electronic exchange of health information between Medicare repositories and the My Health Record system infrastructure in Australia.

This profile builds on Medication.

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

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

- Differential Table
- Snapshot Table
- All

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Medication |  | 0..* | Medication | Definition of a Medication
code | S | 1..1 | CodeableConcept | Codes that identify this medication Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-dhs-modified-pbs-item-1 (required)
manufacturer | S | 0..1 | Reference(AU Base Organisation) | Manufacturer of the item
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Medication |  | 0..* | Medication | Definition of a Medication
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
Additional Bindings | Purpose
All Languages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
code | S Σ | 1..1 | CodeableConcept | Codes that identify this medication Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-dhs-modified-pbs-item-1 (required)
status | Σ | 0..1 | code | active | inactive | entered-in-error Binding: MedicationStatus (required): A coded concept defining if the medication is in active use
isBrand | Σ | 0..1 | boolean | True if a brand
isOverTheCounter | Σ | 0..1 | boolean | True if medication does not require a prescription
manufacturer | S Σ | 0..1 | Reference(AU Base Organisation) | Manufacturer of the item
form |  | 0..1 | CodeableConcept | powder | tablets | capsule + Binding: SNOMED CT Form Codes (example): A coded concept defining the form of a medication
ingredient |  | 0..* | BackboneElement | Active or inactive ingredient
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
item[x] |  | 1..1 |  | The product contained
itemCodeableConcept |  |  | CodeableConcept |
itemReference |  |  | Reference(Substance | Medication) |
isActive |  | 0..1 | boolean | Active ingredient indicator
amount |  | 0..1 | Ratio | Quantity of ingredient present
package |  | 0..1 | BackboneElement | Details about packaged medications
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
container |  | 0..1 | CodeableConcept | E.g. box, vial, blister-pack Binding: MedicationContainer (example): A coded concept defining the kind of container a medication package is packaged in
content |  | 0..* | BackboneElement | What is in the package
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
item[x] |  | 1..1 |  | The item in the package
itemCodeableConcept |  |  | CodeableConcept |
itemReference |  |  | Reference(Medication) |
amount |  | 0..1 | SimpleQuantity | Quantity present in the package
batch |  | 0..* | BackboneElement | Identifies a single production run
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
lotNumber |  | 0..1 | string | Identifier assigned to batch
expirationDate |  | 0..1 | dateTime | When batch will expire
image |  | 0..* | Attachment | Picture of the medication
Documentation for this format

Differential View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Medication |  | 0..* | Medication | Definition of a Medication
code | S | 1..1 | CodeableConcept | Codes that identify this medication Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-dhs-modified-pbs-item-1 (required)
manufacturer | S | 0..1 | Reference(AU Base Organisation) | Manufacturer of the item
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Medication |  | 0..* | Medication | Definition of a Medication
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
Additional Bindings | Purpose
All Languages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
code | S Σ | 1..1 | CodeableConcept | Codes that identify this medication Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-dhs-modified-pbs-item-1 (required)
status | Σ | 0..1 | code | active | inactive | entered-in-error Binding: MedicationStatus (required): A coded concept defining if the medication is in active use
isBrand | Σ | 0..1 | boolean | True if a brand
isOverTheCounter | Σ | 0..1 | boolean | True if medication does not require a prescription
manufacturer | S Σ | 0..1 | Reference(AU Base Organisation) | Manufacturer of the item
form |  | 0..1 | CodeableConcept | powder | tablets | capsule + Binding: SNOMED CT Form Codes (example): A coded concept defining the form of a medication
ingredient |  | 0..* | BackboneElement | Active or inactive ingredient
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
item[x] |  | 1..1 |  | The product contained
itemCodeableConcept |  |  | CodeableConcept |
itemReference |  |  | Reference(Substance | Medication) |
isActive |  | 0..1 | boolean | Active ingredient indicator
amount |  | 0..1 | Ratio | Quantity of ingredient present
package |  | 0..1 | BackboneElement | Details about packaged medications
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
container |  | 0..1 | CodeableConcept | E.g. box, vial, blister-pack Binding: MedicationContainer (example): A coded concept defining the kind of container a medication package is packaged in
content |  | 0..* | BackboneElement | What is in the package
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
item[x] |  | 1..1 |  | The item in the package
itemCodeableConcept |  |  | CodeableConcept |
itemReference |  |  | Reference(Medication) |
amount |  | 0..1 | SimpleQuantity | Quantity present in the package
batch |  | 0..* | BackboneElement | Identifies a single production run
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional Content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
lotNumber |  | 0..1 | string | Identifier assigned to batch
expirationDate |  | 0..1 | dateTime | When batch will expire
image |  | 0..* | Attachment | Picture of the medication
Documentation for this format

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

#### 1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-medication-pbs

none defined