Australian Base Implementation Guide (AU Base 2)

AU Base Implementation Guide, published by HL7 Australia. This is not an authorized publication; it is the continuous build for version 2.2.0). This version is based on the current content of https://github.com/ci-collaborative/au-fhir-base-r4/ and changes regularly. See the Directory of published versions

1.0 StructureDefinition-au-medication

AU Base Medication [FMM 2]

This profile defines a medication structure that localises core concepts, including terminology, for use in an Australian context.

The purpose of this profile is to provide national level agreement on core localised concepts.

This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

Extensions

Extensions used in this profile:

Potentially useful extensions:

Usage Notes

A full medication definition as medicationReference or medicationCodeableConcept can be included to define the drug/medication concept. Medication definition includes coding as:

Examples

Fluconazole Dose Based Medication

Paracetamol Generic Pack

Nexium Hp7 Brand Pack

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 that localises core concepts, including terminology, for use in an Australian context.

This profile builds on Medication.

This profile was published on 2022-03-30 as a active by Health Level Seven Australia (Medications WG).

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationA medication in an Australian healthcare context
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... code 0..1CodeableConceptCoding for the medicine
.... Slices for coding 0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:pbs 0..*CodingPBS Item Code
Binding: PBS Item Codes (preferred)
...... system 1..1uriIdentity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
..... coding:gtin 0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
...... system 1..1uriIdentity of the terminology system
Fixed Value: http://www.gs1.org/gtin
..... coding:amt 0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
...... Slices for 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)
...... system 1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... coding:mimsPackage 0..1CodingMIMS Package
Binding: MIMS (preferred)
...... system 1..1uriIdentity of the terminology system
Fixed Value: http://www.mims.com.au/codes
.... text 0..1stringMedication primary text
... manufacturer 0..1Reference(Organization)Physical product manufacturer organisation
... form 0..1CodeableConceptpowder | tablets | capsule +
Binding: https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1 (preferred)
... ingredient 0..*BackboneElementActive or inactive ingredient
.... item[x] 1..1CodeableConcept, Reference(Substance | Medication)The actual ingredient or content
Binding: AMT Medicinal Product and Substances (preferred)
.... strength 0..1RatioQuantity/strength of ingredient present

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationA medication in an Australian healthcare context
... id Σ0..1stringLogical 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
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier for this medication
... code Σ0..1CodeableConceptCoding for the medicine
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.

.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:pbs Σ0..*CodingPBS Item Code
Binding: PBS Item Codes (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
...... 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:gtin Σ0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.gs1.org/gtin
...... 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:amt Σ0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... Slices for 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)
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... 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:mimsPackage Σ0..1CodingMIMS Package
Binding: MIMS (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.mims.com.au/codes
...... 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
.... text Σ0..1stringMedication primary text
... status ?!Σ0..1codeactive | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... manufacturer Σ0..1Reference(Organization)Physical product manufacturer organisation
... form 0..1CodeableConceptpowder | tablets | capsule +
Binding: https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1 (preferred)
... amount Σ0..1RatioAmount of drug in package
... ingredient 0..*BackboneElementActive or inactive ingredient
.... 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
.... item[x] 1..1The actual ingredient or content
Binding: AMT Medicinal Product and Substances (preferred)
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance | Medication)
.... isActive 0..1booleanActive ingredient indicator
.... strength 0..1RatioQuantity/strength of ingredient present
... batch 0..1BackboneElementDetails about packaged medications
.... 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
.... lotNumber 0..1stringIdentifier assigned to batch
.... expirationDate 0..1dateTimeWhen batch will expire

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationA medication in an Australian healthcare context
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... code 0..1CodeableConceptCoding for the medicine
.... Slices for coding 0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:pbs 0..*CodingPBS Item Code
Binding: PBS Item Codes (preferred)
...... system 1..1uriIdentity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
..... coding:gtin 0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
...... system 1..1uriIdentity of the terminology system
Fixed Value: http://www.gs1.org/gtin
..... coding:amt 0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
...... Slices for 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)
...... system 1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... coding:mimsPackage 0..1CodingMIMS Package
Binding: MIMS (preferred)
...... system 1..1uriIdentity of the terminology system
Fixed Value: http://www.mims.com.au/codes
.... text 0..1stringMedication primary text
... manufacturer 0..1Reference(Organization)Physical product manufacturer organisation
... form 0..1CodeableConceptpowder | tablets | capsule +
Binding: https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1 (preferred)
... ingredient 0..*BackboneElementActive or inactive ingredient
.... item[x] 1..1CodeableConcept, Reference(Substance | Medication)The actual ingredient or content
Binding: AMT Medicinal Product and Substances (preferred)
.... strength 0..1RatioQuantity/strength of ingredient present

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationA medication in an Australian healthcare context
... id Σ0..1stringLogical 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
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier for this medication
... code Σ0..1CodeableConceptCoding for the medicine
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.

.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:pbs Σ0..*CodingPBS Item Code
Binding: PBS Item Codes (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
...... 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:gtin Σ0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.gs1.org/gtin
...... 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:amt Σ0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... Slices for 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)
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... 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:mimsPackage Σ0..1CodingMIMS Package
Binding: MIMS (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.mims.com.au/codes
...... 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
.... text Σ0..1stringMedication primary text
... status ?!Σ0..1codeactive | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... manufacturer Σ0..1Reference(Organization)Physical product manufacturer organisation
... form 0..1CodeableConceptpowder | tablets | capsule +
Binding: https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1 (preferred)
... amount Σ0..1RatioAmount of drug in package
... ingredient 0..*BackboneElementActive or inactive ingredient
.... 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
.... item[x] 1..1The actual ingredient or content
Binding: AMT Medicinal Product and Substances (preferred)
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance | Medication)
.... isActive 0..1booleanActive ingredient indicator
.... strength 0..1RatioQuantity/strength of ingredient present
... batch 0..1BackboneElementDetails about packaged medications
.... 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
.... lotNumber 0..1stringIdentifier assigned to batch
.... expirationDate 0..1dateTimeWhen batch will expire

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

Issues & Feedback