Australian Digital Health Agency FHIR Implementation Guide
1.2.0-ci-build - draft Australia flag

Australian Digital Health Agency FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/ci-fhir-r4/ and changes regularly. See the Directory of published versions

Resource Profile: ADHA Core Medication

Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-medication-core-1 Version: 1.0.2
Active as of 2024-09-12 Computable Name: ADHAMedicationCore

Copyright/Legal: Copyright © 2022 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.

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.

This profile may be referred to by APIs, which will be listed here when available.

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

Usage:

Formal Views of Profile Content

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

This structure is derived from AUCoreMedication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication C 0..* AUCoreMedication A 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..* Extension Extension
Slice: Unordered, Open by value:url
.... brandName S 0..1 string Medication brand name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
.... genericName S 0..1 string Medication generic drug name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... manufacturer SC 0..1 Reference(ADHA Core Organization) Physical product manufacturer organisation
... ingredient SC 0..* BackboneElement Active or inactive ingredient
inv-dh-med-02: If present, an item reference shall at least have a reference or a display
.... item[x] SC 1..1 The actual ingredient or content
..... itemCodeableConcept CodeableConcept
..... itemReference Reference(ADHA Core Substance | ADHA Core Medication)

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-med-01errorMedicationIf present, a manufacturer shall at least have a reference, an identifier or a display
: manufacturer.exists() implies manufacturer.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
inv-dh-med-02errorMedication.ingredientIf present, an item reference shall at least have a reference or a display
: itemReference.exists() implies itemReference.all($this.reference.exists() or $this.display.exists())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication C 0..* AUCoreMedication A 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
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... brandName S 0..1 string Medication brand name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
.... genericName S 0..1 string Medication generic drug name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:All Slices Content/Rules for all slices
...... Slices for extension Content/Rules for all slices
....... medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
..... coding:pbs SOΣ 0..* Coding Code defined by a terminology system
Binding: PBS Item Codes (required)
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
...... Slices for extension Content/Rules for all slices
....... medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
..... coding:amt SOΣ 0..* Coding Code defined by a terminology system
Binding: Australian Medication . (required)
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
...... Slices for extension Content/Rules for all slices
....... medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... manufacturer SΣC 0..1 Reference(ADHA Core Organization) Physical product manufacturer organisation
... ingredient SC 0..* BackboneElement Active or inactive ingredient
inv-dh-med-02: If present, an item reference shall at least have a reference or a display
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... item[x] SC 1..1 The actual ingredient or content
Binding: AMT Medicinal Product and Substances (preferred)
..... itemCodeableConcept CodeableConcept
..... itemReference Reference(ADHA Core Substance | ADHA Core Medication)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.codeexampleSNOMEDCTMedicationCodes
Additional Bindings Purpose Documentation
Australian Medication . Preferred

This value set is for use when AMT (Australian Medicines Terminology) codes are preferred.
PBS Item Codes Preferred

This value set is for use when PBS (Pharmaceutical Benefits Scheme) item codes are preferred.
MIMS Preferred

This value set is for use when MIMS (Monthly Index of Medical Specialties) codes are preferred.
GTIN Preferred

This value set is for use when GTIN (Global Trade Item Number) codes are preferred.
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
Medication.code.coding:pbsrequiredPBSItemCodes
http://terminology.hl7.org.au/ValueSet/pbs-item
Medication.code.coding:amtrequiredAustralianMedication .
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
from the FHIR Standard
Medication.ingredient.item[x]preferredAMTMedicinalProductAndSubstances
http://terminology.hl7.org.au/ValueSet/amt-mp-codes

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-med-01errorMedicationIf present, a manufacturer shall at least have a reference, an identifier or a display
: manufacturer.exists() implies manufacturer.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
inv-dh-med-02errorMedication.ingredientIf present, an item reference shall at least have a reference or a display
: itemReference.exists() implies itemReference.all($this.reference.exists() or $this.display.exists())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication C 0..* AUCoreMedication A 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..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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... brandName S 0..1 string Medication brand name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
.... genericName S 0..1 string Medication generic drug name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifier for this medication
... code SOΣ 1..1 CodeableConcept Coding for the medicine
Binding: SNOMEDCTMedicationCodes (example)
Additional BindingsPurpose
Australian Medication . Preferred
PBS Item Codes Preferred
MIMS Preferred
GTIN Preferred
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:All Slices Content/Rules for all slices
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... system Σ 0..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:pbs SOΣ 0..* Coding Code defined by a terminology system
Binding: PBS Item Codes (required)
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... system Σ 0..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:amt SOΣ 0..* Coding Code defined by a terminology system
Binding: Australian Medication . (required)
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... system Σ 0..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Medication primary text
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... manufacturer SΣC 0..1 Reference(ADHA Core Organization) Physical product manufacturer organisation
... form 0..1 CodeableConcept powder | tablets | capsule +
Binding: Medication Form . (preferred)
... amount Σ 0..1 Ratio Amount of drug in package
... ingredient SC 0..* BackboneElement Active or inactive ingredient
inv-dh-med-02: If present, an item reference shall at least have a reference or a display
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... item[x] SC 1..1 The actual ingredient or content
Binding: AMT Medicinal Product and Substances (preferred)
..... itemCodeableConcept CodeableConcept
..... itemReference Reference(ADHA Core Substance | ADHA Core Medication)
.... isActive 0..1 boolean Active ingredient indicator
.... strength 0..1 Ratio Quantity/strength of ingredient present
... batch 0..1 BackboneElement Details about packaged medications
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... lotNumber 0..1 string Identifier assigned to batch
.... expirationDate 0..1 dateTime When batch will expire

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Medication.codeexampleSNOMEDCTMedicationCodes
Additional Bindings Purpose Documentation
Australian Medication . Preferred

This value set is for use when AMT (Australian Medicines Terminology) codes are preferred.
PBS Item Codes Preferred

This value set is for use when PBS (Pharmaceutical Benefits Scheme) item codes are preferred.
MIMS Preferred

This value set is for use when MIMS (Monthly Index of Medical Specialties) codes are preferred.
GTIN Preferred

This value set is for use when GTIN (Global Trade Item Number) codes are preferred.
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
Medication.code.coding:pbsrequiredPBSItemCodes
http://terminology.hl7.org.au/ValueSet/pbs-item
Medication.code.coding:amtrequiredAustralianMedication .
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
from the FHIR Standard
Medication.formpreferredMedicationForm .
https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1
Medication.ingredient.item[x]preferredAMTMedicinalProductAndSubstances
http://terminology.hl7.org.au/ValueSet/amt-mp-codes

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-med-01errorMedicationIf present, a manufacturer shall at least have a reference, an identifier or a display
: manufacturer.exists() implies manufacturer.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
inv-dh-med-02errorMedication.ingredientIf present, an item reference shall at least have a reference or a display
: itemReference.exists() implies itemReference.all($this.reference.exists() or $this.display.exists())

Differential View

This structure is derived from AUCoreMedication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication C 0..* AUCoreMedication A 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..* Extension Extension
Slice: Unordered, Open by value:url
.... brandName S 0..1 string Medication brand name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
.... genericName S 0..1 string Medication generic drug name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... manufacturer SC 0..1 Reference(ADHA Core Organization) Physical product manufacturer organisation
... ingredient SC 0..* BackboneElement Active or inactive ingredient
inv-dh-med-02: If present, an item reference shall at least have a reference or a display
.... item[x] SC 1..1 The actual ingredient or content
..... itemCodeableConcept CodeableConcept
..... itemReference Reference(ADHA Core Substance | ADHA Core Medication)

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-med-01errorMedicationIf present, a manufacturer shall at least have a reference, an identifier or a display
: manufacturer.exists() implies manufacturer.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
inv-dh-med-02errorMedication.ingredientIf present, an item reference shall at least have a reference or a display
: itemReference.exists() implies itemReference.all($this.reference.exists() or $this.display.exists())

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication C 0..* AUCoreMedication A 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
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... brandName S 0..1 string Medication brand name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
.... genericName S 0..1 string Medication generic drug name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:All Slices Content/Rules for all slices
...... Slices for extension Content/Rules for all slices
....... medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
..... coding:pbs SOΣ 0..* Coding Code defined by a terminology system
Binding: PBS Item Codes (required)
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
...... Slices for extension Content/Rules for all slices
....... medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
..... coding:amt SOΣ 0..* Coding Code defined by a terminology system
Binding: Australian Medication . (required)
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
...... Slices for extension Content/Rules for all slices
....... medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... manufacturer SΣC 0..1 Reference(ADHA Core Organization) Physical product manufacturer organisation
... ingredient SC 0..* BackboneElement Active or inactive ingredient
inv-dh-med-02: If present, an item reference shall at least have a reference or a display
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... item[x] SC 1..1 The actual ingredient or content
Binding: AMT Medicinal Product and Substances (preferred)
..... itemCodeableConcept CodeableConcept
..... itemReference Reference(ADHA Core Substance | ADHA Core Medication)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.codeexampleSNOMEDCTMedicationCodes
Additional Bindings Purpose Documentation
Australian Medication . Preferred

This value set is for use when AMT (Australian Medicines Terminology) codes are preferred.
PBS Item Codes Preferred

This value set is for use when PBS (Pharmaceutical Benefits Scheme) item codes are preferred.
MIMS Preferred

This value set is for use when MIMS (Monthly Index of Medical Specialties) codes are preferred.
GTIN Preferred

This value set is for use when GTIN (Global Trade Item Number) codes are preferred.
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
Medication.code.coding:pbsrequiredPBSItemCodes
http://terminology.hl7.org.au/ValueSet/pbs-item
Medication.code.coding:amtrequiredAustralianMedication .
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
from the FHIR Standard
Medication.ingredient.item[x]preferredAMTMedicinalProductAndSubstances
http://terminology.hl7.org.au/ValueSet/amt-mp-codes

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-med-01errorMedicationIf present, a manufacturer shall at least have a reference, an identifier or a display
: manufacturer.exists() implies manufacturer.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
inv-dh-med-02errorMedication.ingredientIf present, an item reference shall at least have a reference or a display
: itemReference.exists() implies itemReference.all($this.reference.exists() or $this.display.exists())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication C 0..* AUCoreMedication A 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..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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... brandName S 0..1 string Medication brand name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
.... genericName S 0..1 string Medication generic drug name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifier for this medication
... code SOΣ 1..1 CodeableConcept Coding for the medicine
Binding: SNOMEDCTMedicationCodes (example)
Additional BindingsPurpose
Australian Medication . Preferred
PBS Item Codes Preferred
MIMS Preferred
GTIN Preferred
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:All Slices Content/Rules for all slices
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... system Σ 0..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:pbs SOΣ 0..* Coding Code defined by a terminology system
Binding: PBS Item Codes (required)
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... system Σ 0..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:amt SOΣ 0..* Coding Code defined by a terminology system
Binding: Australian Medication . (required)
ObligationsActor
SHALL:populate-if-known http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
SHALL:no-error http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... system Σ 0..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Medication primary text
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... manufacturer SΣC 0..1 Reference(ADHA Core Organization) Physical product manufacturer organisation
... form 0..1 CodeableConcept powder | tablets | capsule +
Binding: Medication Form . (preferred)
... amount Σ 0..1 Ratio Amount of drug in package
... ingredient SC 0..* BackboneElement Active or inactive ingredient
inv-dh-med-02: If present, an item reference shall at least have a reference or a display
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... item[x] SC 1..1 The actual ingredient or content
Binding: AMT Medicinal Product and Substances (preferred)
..... itemCodeableConcept CodeableConcept
..... itemReference Reference(ADHA Core Substance | ADHA Core Medication)
.... isActive 0..1 boolean Active ingredient indicator
.... strength 0..1 Ratio Quantity/strength of ingredient present
... batch 0..1 BackboneElement Details about packaged medications
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... lotNumber 0..1 string Identifier assigned to batch
.... expirationDate 0..1 dateTime When batch will expire

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Medication.codeexampleSNOMEDCTMedicationCodes
Additional Bindings Purpose Documentation
Australian Medication . Preferred

This value set is for use when AMT (Australian Medicines Terminology) codes are preferred.
PBS Item Codes Preferred

This value set is for use when PBS (Pharmaceutical Benefits Scheme) item codes are preferred.
MIMS Preferred

This value set is for use when MIMS (Monthly Index of Medical Specialties) codes are preferred.
GTIN Preferred

This value set is for use when GTIN (Global Trade Item Number) codes are preferred.
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
Medication.code.coding:pbsrequiredPBSItemCodes
http://terminology.hl7.org.au/ValueSet/pbs-item
Medication.code.coding:amtrequiredAustralianMedication .
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
from the FHIR Standard
Medication.formpreferredMedicationForm .
https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1
Medication.ingredient.item[x]preferredAMTMedicinalProductAndSubstances
http://terminology.hl7.org.au/ValueSet/amt-mp-codes

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-med-01errorMedicationIf present, a manufacturer shall at least have a reference, an identifier or a display
: manufacturer.exists() implies manufacturer.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
inv-dh-med-02errorMedication.ingredientIf present, an item reference shall at least have a reference or a display
: itemReference.exists() implies itemReference.all($this.reference.exists() or $this.display.exists())

 

Other representations of profile: CSV, Excel, Schematron

Notes:

No mandatory or optional search parameters for ADHA Core Medication profile.