AU Core Implementation Guide
0.2.0-preview - QA Preview Australia flag

This page is part of the Australian Core IG (v0.2.0-preview: AU Core) based on FHIR R4. For a full list of available versions, see the Directory of published versions

Resource Profile: AU Core Medication

Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-medication Version: 0.2.0-preview
Standards status: Draft Maturity Level: 0 Computable Name: AUMedication

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved.

This profile sets minimum expectations for a Medication resource to record, search, and fetch medications associated with a patient. It is based on the AU Base Medication profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Medication when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

In AU Core a Medication resource is used within the context of a referencing resource: MedicationAdministration, MedicationDispense, MedicationRequest, or MedicationStatement resource.

Usage scenarios

The following are supported usage scenarios for this profile:

  • Query medications associated with a patient referenced by another resource
  • Record or update a medication associated with a patient referenced by another resource
  • Read medications associated with a patient referenced by another resource

Comparison with other national and international specifications

A resource conforming to this profile is conformant to:

Conformance in reverse is not guaranteed, i.e. a resource conforming to International Patient Access, International Patient Summary, or US Core MAY NOT conform to AU Core.

Profile specific implementation guidance

  • See the Medicine information section for guidance on constructing a resource and the use of medicines terminology
  • Manufacturer information will commonly be exchanged as a PBS code, this information can be represented as an external resource of by using Medication.manufacturer.identifier to carry the PBS code and Medication.manufacturer.display to carry the name of the manufacturer

Specific feedback is sought on supporting ingredient information in Medication. Identification of a specific ingredient can be support by use of Medication.itemCodeableConcept or Medication.itemReference which refers to an external Medication or Substance resource.

Usage:

Formal Views of Profile Content

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

This structure is derived from AUBaseMedication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*AUBaseMedicationA medication in an Australian healthcare context
... code S1..1CodeableConceptCoding for the medicine
.... Slices for coding 0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:pbs S0..*CodingPBS Item Code
..... coding:amt S0..*CodingAMT Medicines
... manufacturer SC0..1Reference(AU Core Organization)Physical product manufacturer organisation
... form S0..1CodeableConceptpowder | tablets | capsule +
... ingredient S0..*BackboneElementActive or inactive ingredient
.... item[x] S1..1The actual ingredient or content
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(AU Core Substance | AU Core Medication)
.... isActive S0..1booleanActive ingredient indicator
.... strength S0..1RatioQuantity/strength of ingredient present

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*AUBaseMedicationA medication in an Australian healthcare context
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... code SΣ1..1CodeableConceptCoding for the medicine
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.

.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:pbs SΣ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 SΣ0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
...... medicationClass 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
... manufacturer SΣC0..1Reference(AU Core Organization)Physical product manufacturer organisation
... form S0..1CodeableConceptpowder | tablets | capsule +
Binding: https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1 (preferred)
... amount SΣ0..1RatioAmount of drug in package
... ingredient S0..*BackboneElementActive or inactive ingredient
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... item[x] S1..1The actual ingredient or content
Binding: AMT Medicinal Product and Substances (preferred)
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(AU Core Substance | AU Core Medication)
.... isActive S0..1booleanActive ingredient indicator
.... strength S0..1RatioQuantity/strength of ingredient present

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Medication.codeexampleSNOMEDCTMedicationCodes
Medication.code.coding:pbspreferredPBSItemCodes
Medication.code.coding:gtinpreferredGTIN
Medication.code.coding:amtpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
Medication.code.coding:mimsPackagepreferredMIMS
Medication.statusrequiredMedication Status Codes
Medication.formpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/medication-form-1
Medication.ingredient.item[x]preferredAMTMedicinalProductAndSubstances
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*AUBaseMedicationA 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
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier for this medication
... code SΣ1..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
.... 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 SΣ0..*CodingPBS Item Code
Binding: PBS Item Codes (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... 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
...... 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 SΣ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
...... medicationClass 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
...... 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 SΣC0..1Reference(AU Core Organization)Physical product manufacturer organisation
... form S0..1CodeableConceptpowder | tablets | capsule +
Binding: https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1 (preferred)
... amount SΣ0..1RatioAmount of drug in package
... ingredient S0..*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] S1..1The actual ingredient or content
Binding: AMT Medicinal Product and Substances (preferred)
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(AU Core Substance | AU Core Medication)
.... isActive S0..1booleanActive ingredient indicator
.... strength S0..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

Terminology Bindings

PathConformanceValueSet
Medication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Medication.codeexampleSNOMEDCTMedicationCodes
Medication.code.coding:pbspreferredPBSItemCodes
Medication.code.coding:gtinpreferredGTIN
Medication.code.coding:amtpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
Medication.code.coding:mimsPackagepreferredMIMS
Medication.statusrequiredMedication Status Codes
Medication.formpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/medication-form-1
Medication.ingredient.item[x]preferredAMTMedicinalProductAndSubstances

This structure is derived from AUBaseMedication

Summary

Mandatory: 1 element
Must-Support: 10 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Medication.code.coding is sliced based on the value of value:system

Maturity: 0

Differential View

This structure is derived from AUBaseMedication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*AUBaseMedicationA medication in an Australian healthcare context
... code S1..1CodeableConceptCoding for the medicine
.... Slices for coding 0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:pbs S0..*CodingPBS Item Code
..... coding:amt S0..*CodingAMT Medicines
... manufacturer SC0..1Reference(AU Core Organization)Physical product manufacturer organisation
... form S0..1CodeableConceptpowder | tablets | capsule +
... ingredient S0..*BackboneElementActive or inactive ingredient
.... item[x] S1..1The actual ingredient or content
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(AU Core Substance | AU Core Medication)
.... isActive S0..1booleanActive ingredient indicator
.... strength S0..1RatioQuantity/strength of ingredient present

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*AUBaseMedicationA medication in an Australian healthcare context
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... code SΣ1..1CodeableConceptCoding for the medicine
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.

.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:pbs SΣ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 SΣ0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
...... medicationClass 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
... manufacturer SΣC0..1Reference(AU Core Organization)Physical product manufacturer organisation
... form S0..1CodeableConceptpowder | tablets | capsule +
Binding: https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1 (preferred)
... amount SΣ0..1RatioAmount of drug in package
... ingredient S0..*BackboneElementActive or inactive ingredient
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... item[x] S1..1The actual ingredient or content
Binding: AMT Medicinal Product and Substances (preferred)
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(AU Core Substance | AU Core Medication)
.... isActive S0..1booleanActive ingredient indicator
.... strength S0..1RatioQuantity/strength of ingredient present

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Medication.codeexampleSNOMEDCTMedicationCodes
Medication.code.coding:pbspreferredPBSItemCodes
Medication.code.coding:gtinpreferredGTIN
Medication.code.coding:amtpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
Medication.code.coding:mimsPackagepreferredMIMS
Medication.statusrequiredMedication Status Codes
Medication.formpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/medication-form-1
Medication.ingredient.item[x]preferredAMTMedicinalProductAndSubstances

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*AUBaseMedicationA 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
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier for this medication
... code SΣ1..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
.... 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 SΣ0..*CodingPBS Item Code
Binding: PBS Item Codes (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... 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
...... 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 SΣ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
...... medicationClass 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
...... 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 SΣC0..1Reference(AU Core Organization)Physical product manufacturer organisation
... form S0..1CodeableConceptpowder | tablets | capsule +
Binding: https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1 (preferred)
... amount SΣ0..1RatioAmount of drug in package
... ingredient S0..*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] S1..1The actual ingredient or content
Binding: AMT Medicinal Product and Substances (preferred)
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(AU Core Substance | AU Core Medication)
.... isActive S0..1booleanActive ingredient indicator
.... strength S0..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

Terminology Bindings

PathConformanceValueSet
Medication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Medication.codeexampleSNOMEDCTMedicationCodes
Medication.code.coding:pbspreferredPBSItemCodes
Medication.code.coding:gtinpreferredGTIN
Medication.code.coding:amtpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
Medication.code.coding:mimsPackagepreferredMIMS
Medication.statusrequiredMedication Status Codes
Medication.formpreferredhttps://healthterminologies.gov.au/fhir/ValueSet/medication-form-1
Medication.ingredient.item[x]preferredAMTMedicinalProductAndSubstances

This structure is derived from AUBaseMedication

Summary

Mandatory: 1 element
Must-Support: 10 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Medication.code.coding is sliced based on the value of value:system

Maturity: 0

 

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.

Mandatory Search Parameters

No mandatory search parameters for this profile.

Optional Search Parameters

No optional search parameters for this profile.