Australian Base Implementation Guide (AU Base 1)

This page is part of the Australian Base IG (v1.0.2: AU Base 1 on STU3) based on FHIR R3. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

1.0 StructureDefinition-au-medication

AU Base Medication [FMM Level 2]

This profile defines a medication structure including core localisation concepts for use in an Australian context. Wherever possible, the structure for medication information profiled here, has been aligned to the proposed R4 Medication. In support of alignment it is expected that value of Medication.package.content.item is the same as Medication.code; and the following elements have been profiled to allow a maximum cardinality of 1:

  • Medication.package
  • Medication.package.content
  • Medication.package.batch

The following elements available in STU3 Medication have been removed from the standard structure of R4 Medication and replaced with standard extensions, for this reason the direct use of these elements is not encouraged:

  • Medication.isBrand
  • Medication.isOverCounter
  • Medication.package.container
  • Medication.image

Medication Coding

Medication codings are use be used to define relevant drug/medication concepts. This includes coding as:

  • PBS Item Code - Pharmaceutical Benefits Scheme coding, claiming context is not relevant as medicine coding.
  • GTIN - Global Trade Item Number, physical product reference.
  • AMT Code - Australian Medicines Terminology, national drug terminology.
  • MIMS Package - commonly used medicine coding.

Extensions

Extensions used in this profile:

  • Medication: PBS Sponsor [1]
  • Medication.code.coding: Medication Type [1] - used to distinguish a level classification when the same coding system is used.
  • MedicationDispense: Medication Brand Name [1] - this text only extension is supplied to support brand name content where no coding is available, use medicationReference or medicationCodeable concept if code is available.
  • MedicationDispense: Medication Generic Drug Name [1] - this text only extension is supplied to support generic name content where no coding is available, use medicationReference or medicationCodeable concept if code is available.

Examples

Fluconazole Dose Based Medication

Paracetamol Generic Pack

Nexium Hp7 Brand Pack

Nexium Hp7 Combination Package with Product Parts

Clarithromycin 500mg Tablet Unbranded Product

Esomeprazole 20mg Tablet Unbranded Product

Amoxicillin 500mg Capsule Unbranded Product

Norvasc 10 mg Tablet Brand Product with Batch Details

The following examples have been taken from the National guidelines for on-screen display of clinical medicines information – January 2016 published by the Australian Commission on Safety and Quality in Health Care. Care has been taken with the clinical content in the structured data, and construction of narrative to be consistent with the guidelines:

Single active ingredient product: pack-based

Two active ingredients product

Product with four or more active ingredients

1.0.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org.au/fhir/StructureDefinition/au-medication

This profile defines a medication structure including core localisation concepts for use in an Australian context.

This profile builds on Medication.

This profile was published on Thu May 11 10:06:07 AEST 2017 as a active by Health Level Seven Australia (Medications WG).

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

This profile contains the following variations from Medication:

  1. extension sliced
    • PBS Sponsor extension
    • Medication Brand Name extension
    • Medication Generic Drug Name extension
  2. code Coding for the medicine
    • coding PBS Item Code
    • coding Medication Package Global Trade Item Number (GTIN)
    • coding AMT Medicines
      • Type of Medication Coding extension
    • coding MIMS Package
  3. manufacturer Physical product manufacturer organisation
  4. form
    • coding Medication Form (SNOMED CT)
  5. ingredient
    • item[x] Coded Ingredient Product
    • coding AMT Medicinal Product Ingredient
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*A medication in an Australian healthcare context
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... pbs-sponsor 0..1Reference(http://hl7.org.au/fhir/StructureDefinition/au-pbs-sponsor)PBS Sponsor
URL: http://hl7.org.au/fhir/StructureDefinition/pbs-sponsor
... medication-brand-name 0..*stringMedication Brand Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
... medication-generic-name 0..*stringMedication Generic Drug Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... code I0..1CodeableConceptCoding for the medicine
inv-amt-tpuu: AMT TPUU valueset membership required
inv-amt-tpp: AMT TPU valueset membership required
inv-amt-tp: AMT TP valueset membership required
inv-amp-mpuu: AMT MPUU valueset membership required
inv-amt-mpp: AMT MPP valueset membership required
inv-amt-mp: AMT MP valueset membership required
inv-amt-ctpp: AMT CTPP valueset membership required
.... coding CodingSlice: Unordered, Open by value:system, value:code
.... coding 0..*CodingPBS Item Code
Binding: PBS Medicines Item Codes (required)
.... coding 0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN for Medicines (required)
.... coding 0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (required)
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... medication-type 0..1CodingMedication Type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
.... coding 0..1CodingMIMS Package
Binding: MIMS Terminology (required)
.... text 0..1stringMedication primary text
... manufacturer 0..1Reference(Organization)Physical product manufacturer organisation
... ingredient 0..*BackboneElement
.... item[x] CodeableConcept, Reference(Substance | Medication)Medication ingredient
Slice: Unordered, Open by type:$this
​.... item[x] 1..1CodeableConceptCoded Ingredient Product
​..... coding CodingSlice: Unordered, Open by value:system
​..... coding 0..1CodingAMT Medicinal Product Ingredient
Binding: AMT Medicinal Product (required)
.... amount 0..1RatioStrength of ingredient

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication I0..*A medication in an Australian healthcare context
... 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: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... pbs-sponsor I0..1Reference(http://hl7.org.au/fhir/StructureDefinition/au-pbs-sponsor)PBS Sponsor
URL: http://hl7.org.au/fhir/StructureDefinition/pbs-sponsor
... medication-brand-name I0..*stringMedication Brand Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
... medication-generic-name I0..*stringMedication Generic Drug Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... code ΣI0..1CodeableConceptCoding for the medicine
Binding: SNOMED CT Medication Codes (example)
inv-amt-tpuu: AMT TPUU valueset membership required
inv-amt-tpp: AMT TPU valueset membership required
inv-amt-tp: AMT TP valueset membership required
inv-amp-mpuu: AMT MPUU valueset membership required
inv-amt-mpp: AMT MPP valueset membership required
inv-amt-mp: AMT MP valueset membership required
inv-amt-ctpp: AMT CTPP valueset membership required
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system, value:code
.... coding Σ0..*CodingPBS Item Code
Binding: PBS Medicines Item Codes (required)
.... coding Σ0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN for Medicines (required)
.... coding Σ0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... medication-type 0..1CodingMedication Type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/medication-type"
...... valueCoding 1..1CodingValue of extension
Binding: Medication Type (required)
..... system Σ0..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... coding Σ0..1CodingMIMS Package
Binding: MIMS Terminology (required)
.... text Σ0..1stringMedication primary text
... status Σ0..1codeactive | inactive | entered-in-error
Binding: MedicationStatus (required)
... isBrand Σ0..1booleanTrue if a brand
... isOverTheCounter Σ0..1booleanTrue if medication does not require a prescription
... manufacturer Σ0..1Reference(Organization)Physical product manufacturer organisation
... form 0..1CodeableConceptpowder | tablets | capsule +
Binding: SNOMED CT Form Codes (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system
.... coding Σ0..1CodingMedication Form (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1 (required)
.... text Σ0..1stringPlain text representation of the concept
... ingredient I0..*BackboneElementActive or inactive ingredient
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... item[x] 1..1CodeableConcept, Reference(Substance | Medication)Medication ingredient
.... itemCodeableConcept 1..1CodeableConceptCoded Ingredient Product
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding Σ0..1CodingAMT Medicinal Product Ingredient
Binding: AMT Medicinal Product (required)
..... text Σ0..1stringPlain text representation of the concept
.... isActive 0..1booleanActive ingredient indicator
.... amount 0..1RatioStrength of ingredient
... package I0..1BackboneElementDetails about packaged medications
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... container 0..1CodeableConceptE.g. box, vial, blister-pack
Binding: MedicationContainer (example)
.... content I0..*BackboneElementWhat is in the package
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... item[x] 1..1CodeableConcept, Reference(Medication)The item in the package
..... amount 0..1SimpleQuantityQuantity present in the package
.... batch I0..*BackboneElementIdentifies a single production run
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... lotNumber 0..1stringIdentifier assigned to batch
..... expirationDate 0..1dateTimeWhen batch will expire
... image 0..*AttachmentPicture of the medication

doco Documentation for this format

This profile contains the following variations from Medication:

  1. extension sliced
    • PBS Sponsor extension
    • Medication Brand Name extension
    • Medication Generic Drug Name extension
  2. code Coding for the medicine
    • coding PBS Item Code
    • coding Medication Package Global Trade Item Number (GTIN)
    • coding AMT Medicines
      • Type of Medication Coding extension
    • coding MIMS Package
  3. manufacturer Physical product manufacturer organisation
  4. form
    • coding Medication Form (SNOMED CT)
  5. ingredient
    • item[x] Coded Ingredient Product
    • coding AMT Medicinal Product Ingredient

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*A medication in an Australian healthcare context
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... pbs-sponsor 0..1Reference(http://hl7.org.au/fhir/StructureDefinition/au-pbs-sponsor)PBS Sponsor
URL: http://hl7.org.au/fhir/StructureDefinition/pbs-sponsor
... medication-brand-name 0..*stringMedication Brand Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
... medication-generic-name 0..*stringMedication Generic Drug Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... code I0..1CodeableConceptCoding for the medicine
inv-amt-tpuu: AMT TPUU valueset membership required
inv-amt-tpp: AMT TPU valueset membership required
inv-amt-tp: AMT TP valueset membership required
inv-amp-mpuu: AMT MPUU valueset membership required
inv-amt-mpp: AMT MPP valueset membership required
inv-amt-mp: AMT MP valueset membership required
inv-amt-ctpp: AMT CTPP valueset membership required
.... coding CodingSlice: Unordered, Open by value:system, value:code
.... coding 0..*CodingPBS Item Code
Binding: PBS Medicines Item Codes (required)
.... coding 0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN for Medicines (required)
.... coding 0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (required)
..... extension 0..*ExtensionSlice: Unordered, Open by value:url
..... medication-type 0..1CodingMedication Type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
.... coding 0..1CodingMIMS Package
Binding: MIMS Terminology (required)
.... text 0..1stringMedication primary text
... manufacturer 0..1Reference(Organization)Physical product manufacturer organisation
... ingredient 0..*BackboneElement
.... item[x] CodeableConcept, Reference(Substance | Medication)Medication ingredient
Slice: Unordered, Open by type:$this
​.... item[x] 1..1CodeableConceptCoded Ingredient Product
​..... coding CodingSlice: Unordered, Open by value:system
​..... coding 0..1CodingAMT Medicinal Product Ingredient
Binding: AMT Medicinal Product (required)
.... amount 0..1RatioStrength of ingredient

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication I0..*A medication in an Australian healthcare context
... 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: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... pbs-sponsor I0..1Reference(http://hl7.org.au/fhir/StructureDefinition/au-pbs-sponsor)PBS Sponsor
URL: http://hl7.org.au/fhir/StructureDefinition/pbs-sponsor
... medication-brand-name I0..*stringMedication Brand Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
... medication-generic-name I0..*stringMedication Generic Drug Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... code ΣI0..1CodeableConceptCoding for the medicine
Binding: SNOMED CT Medication Codes (example)
inv-amt-tpuu: AMT TPUU valueset membership required
inv-amt-tpp: AMT TPU valueset membership required
inv-amt-tp: AMT TP valueset membership required
inv-amp-mpuu: AMT MPUU valueset membership required
inv-amt-mpp: AMT MPP valueset membership required
inv-amt-mp: AMT MP valueset membership required
inv-amt-ctpp: AMT CTPP valueset membership required
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system, value:code
.... coding Σ0..*CodingPBS Item Code
Binding: PBS Medicines Item Codes (required)
.... coding Σ0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN for Medicines (required)
.... coding Σ0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... medication-type 0..1CodingMedication Type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/medication-type"
...... valueCoding 1..1CodingValue of extension
Binding: Medication Type (required)
..... system Σ0..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... coding Σ0..1CodingMIMS Package
Binding: MIMS Terminology (required)
.... text Σ0..1stringMedication primary text
... status Σ0..1codeactive | inactive | entered-in-error
Binding: MedicationStatus (required)
... isBrand Σ0..1booleanTrue if a brand
... isOverTheCounter Σ0..1booleanTrue if medication does not require a prescription
... manufacturer Σ0..1Reference(Organization)Physical product manufacturer organisation
... form 0..1CodeableConceptpowder | tablets | capsule +
Binding: SNOMED CT Form Codes (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system
.... coding Σ0..1CodingMedication Form (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1 (required)
.... text Σ0..1stringPlain text representation of the concept
... ingredient I0..*BackboneElementActive or inactive ingredient
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... item[x] 1..1CodeableConcept, Reference(Substance | Medication)Medication ingredient
.... itemCodeableConcept 1..1CodeableConceptCoded Ingredient Product
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding Σ0..1CodingAMT Medicinal Product Ingredient
Binding: AMT Medicinal Product (required)
..... text Σ0..1stringPlain text representation of the concept
.... isActive 0..1booleanActive ingredient indicator
.... amount 0..1RatioStrength of ingredient
... package I0..1BackboneElementDetails about packaged medications
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... container 0..1CodeableConceptE.g. box, vial, blister-pack
Binding: MedicationContainer (example)
.... content I0..*BackboneElementWhat is in the package
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... item[x] 1..1CodeableConcept, Reference(Medication)The item in the package
..... amount 0..1SimpleQuantityQuantity present in the package
.... batch I0..*BackboneElementIdentifies a single production run
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... lotNumber 0..1stringIdentifier assigned to batch
..... expirationDate 0..1dateTimeWhen batch will expire
... image 0..*AttachmentPicture of the medication

doco 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-au-medication

none defined