Australian Digital Health Agency FHIR Implementation Guide 1.0.0

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

StructureDefinition: ADHA Core Medication [Active]

The purpose of this profile is to provide a core representation of a medication for the electronic exchange of 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 Medication that are supported.

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

This profile is designed to set a core Medication standard in the context of:

  • Querying medications referenced by another resource
  • Recording or updating a medication referenced by another resource
  • Reading medications referenced by another resource

Operations on Medication resources are expected to be within the context of an ExplanationOfBenefit, Flag, MedicationAdministration, MedicationDipsense, MedicationRequest or MedicationStatement resource query.

Profile specific 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 by using Medication.manufacturer.identifier to carry the PBS code and Medication.manufacturer.display to carry the name of the manufacturer.

Boundaries and relationships

This profile is referenced by ADHA Core Flag, ADHA Core MedicationRequest, and ADHA PBS Claim Item.

Formal Views of Profile Content

The official URL for this profile is: 

http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-medication-core-1

The purpose of this profile is to provide a core representation of a medication for the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia.

This profile builds on AUBaseMedication.

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

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication C0..*AUBaseMedicationA medication in an Australian healthcare context
inv-dh-med-01: If present, a manufacturer shall at least have a reference, an identifier or a display
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... brandName S0..1stringMedication brand name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
... genericName S0..1stringMedication generic drug name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... 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(ADHA Core Organization)Physical product manufacturer organisation
... form S0..1CodeableConceptpowder | tablets | capsule +
... amount S0..1RatioAmount of drug in package
... ingredient SC0..*BackboneElementActive or inactive ingredient
inv-dh-med-02: If present, an item reference shall at least have a reference or a display
.... item[x] SC1..1The actual ingredient or content
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(ADHA Core Substance | ADHA Core Medication)
.... isActive S0..1booleanActive ingredient indicator
.... strength S0..1RatioQuantity/strength of ingredient present

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication C0..*AUBaseMedicationA medication in an Australian healthcare context
inv-dh-med-01: If present, a manufacturer shall at least have a reference, an identifier or a display
... 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: 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
... brandName S0..1stringMedication brand name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
... genericName S0..1stringMedication generic drug name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... 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(ADHA 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 SC0..*BackboneElementActive or inactive ingredient
inv-dh-med-02: If present, an item reference shall at least have a reference or a display
.... 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] SC1..1The actual ingredient or content
Binding: AMT Medicinal Product and Substances (preferred)
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(ADHA Core Substance | ADHA 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

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication C0..*AUBaseMedicationA medication in an Australian healthcare context
inv-dh-med-01: If present, a manufacturer shall at least have a reference, an identifier or a display
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... brandName S0..1stringMedication brand name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
... genericName S0..1stringMedication generic drug name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... 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(ADHA Core Organization)Physical product manufacturer organisation
... form S0..1CodeableConceptpowder | tablets | capsule +
... amount S0..1RatioAmount of drug in package
... ingredient SC0..*BackboneElementActive or inactive ingredient
inv-dh-med-02: If present, an item reference shall at least have a reference or a display
.... item[x] SC1..1The actual ingredient or content
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(ADHA Core Substance | ADHA Core Medication)
.... isActive S0..1booleanActive ingredient indicator
.... strength S0..1RatioQuantity/strength of ingredient present

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication C0..*AUBaseMedicationA medication in an Australian healthcare context
inv-dh-med-01: If present, a manufacturer shall at least have a reference, an identifier or a display
... 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: 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
... brandName S0..1stringMedication brand name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
... genericName S0..1stringMedication generic drug name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... 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(ADHA 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 SC0..*BackboneElementActive or inactive ingredient
inv-dh-med-02: If present, an item reference shall at least have a reference or a display
.... 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] SC1..1The actual ingredient or content
Binding: AMT Medicinal Product and Substances (preferred)
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(ADHA Core Substance | ADHA 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

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

 

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

Search Parameters

None defined.