AU Patient Summary Implementation Guide
0.1.0-preview - Preview Australia flag

This page is part of the AU Patient Summary (v0.1.0-preview: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. No current official version has been published yet. For a full list of available versions, see the Directory of published versions

Resource Profile: AU PS Medication

Official URL: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-medication Version: 0.1.0-preview
Standards status: Draft Maturity Level: 0 Computable Name: AUPSMedication

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 in the context of a patient summary in an Australian context. It is based on the AU Base Medication profile, and applies the constraints of AU Core Medication and Medication (IPS).

See Comparison with other national and international IGs for a comparison between AU Core profiles and profiles in other implementation guides.

Profile specific implementation guidance

  • See the Medicine Information page in AU Core for guidance on how medicinal product identification can be structured in FHIR conformant to AU Patient Summary.

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..* AUBaseMedication A medication in an Australian healthcare context
This profile also complies with the profiles Medication (IPS) and AU Core Medication
... code S 1..1 CodeableConceptIPS Coding for the medicine
.... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:pbs S 0..* Coding Code defined by a terminology system
Binding: PBS Item Codes (required)
..... coding:amt S 0..* Coding Code defined by a terminology system
Binding: Australian Medication . (required)
... form S 0..1 CodeableConceptIPS powder | tablets | capsule +
... ingredient S 0..* BackboneElement Active or inactive ingredient
.... item[x] S 1..1 The actual ingredient or content
..... itemCodeableConcept CodeableConcept(CodeableConceptIPS)
..... itemReference Reference(Substance | Medication)
.... strength S 0..1 Ratio Quantity/strength of ingredient present

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
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
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* AUBaseMedication A medication in an Australian healthcare context
This profile also complies with the profiles Medication (IPS) and AU Core Medication
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... code SΣ 1..1 CodeableConceptIPS Coding for the medicine
Binding: SNOMEDCTMedicationCodes (example)
Additional BindingsPurpose
Australian Medication . Preferred
PBS Item Codes Preferred
MIMS Preferred
GTIN Preferred

ele-1: All FHIR elements must have a @value or children
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
ele-1: All FHIR elements must have a @value or children
..... coding:All Slices Content/Rules for all slices
...... Slices for extension Content/Rules for all slices
....... extension:medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... coding:pbs SΣ 0..* Coding Code defined by a terminology system
Binding: PBS Item Codes (required)
ele-1: All FHIR elements must have a @value or children
...... Slices for extension Content/Rules for all slices
....... extension:medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... coding:amt SΣ 0..* Coding Code defined by a terminology system
Binding: Australian Medication . (required)
ele-1: All FHIR elements must have a @value or children
...... Slices for extension Content/Rules for all slices
....... extension:medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... form S 0..1 CodeableConceptIPS powder | tablets | capsule +
Binding: Medication Form . (preferred)
ele-1: All FHIR elements must have a @value or children
... ingredient S 0..* BackboneElement Active or inactive ingredient
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... item[x] S 1..1 The actual ingredient or content
Binding: AMT Medicinal Product and Substances (preferred)
ele-1: All FHIR elements must have a @value or children
..... itemCodeableConcept CodeableConcept(CodeableConceptIPS)
..... itemReference Reference(Substance | Medication)
.... strength S 0..1 Ratio Quantity/strength of ingredient present
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.codeexampleSNOMEDCTMedicationCodes
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
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMedicationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* AUBaseMedication A medication in an Australian healthcare context
This profile also complies with the profiles Medication (IPS) and AU Core Medication
... 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
... extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifier for this medication
... code SΣ 1..1 CodeableConceptIPS Coding for the medicine
Binding: SNOMEDCTMedicationCodes (example)
Additional BindingsPurpose
Australian Medication . Preferred
PBS Item Codes Preferred
MIMS Preferred
GTIN Preferred
.... 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
....... extension: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 SΣ 0..* Coding Code defined by a terminology system
Binding: PBS Item Codes (required)
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension: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 SΣ 0..* Coding Code defined by a terminology system
Binding: Australian Medication . (required)
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension: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 Σ 0..1 Reference(Organization) Physical product manufacturer organisation
... form S 0..1 CodeableConceptIPS powder | tablets | capsule +
Binding: Medication Form . (preferred)
... amount Σ 0..1 Ratio Amount of drug in package
... ingredient S 0..* BackboneElement Active or inactive ingredient
.... 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] S 1..1 The actual ingredient or content
Binding: AMT Medicinal Product and Substances (preferred)
..... itemCodeableConcept CodeableConcept(CodeableConceptIPS)
..... itemReference Reference(Substance | Medication)
.... isActive 0..1 boolean Active ingredient indicator
.... strength S 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
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Medication.codeexampleSNOMEDCTMedicationCodes
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
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMedicationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from AUBaseMedication

Summary

Mandatory: 1 element
Must-Support: 7 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

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

Maturity: 0

Differential View

This structure is derived from AUBaseMedication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* AUBaseMedication A medication in an Australian healthcare context
This profile also complies with the profiles Medication (IPS) and AU Core Medication
... code S 1..1 CodeableConceptIPS Coding for the medicine
.... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:pbs S 0..* Coding Code defined by a terminology system
Binding: PBS Item Codes (required)
..... coding:amt S 0..* Coding Code defined by a terminology system
Binding: Australian Medication . (required)
... form S 0..1 CodeableConceptIPS powder | tablets | capsule +
... ingredient S 0..* BackboneElement Active or inactive ingredient
.... item[x] S 1..1 The actual ingredient or content
..... itemCodeableConcept CodeableConcept(CodeableConceptIPS)
..... itemReference Reference(Substance | Medication)
.... strength S 0..1 Ratio Quantity/strength of ingredient present

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
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

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* AUBaseMedication A medication in an Australian healthcare context
This profile also complies with the profiles Medication (IPS) and AU Core Medication
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... code SΣ 1..1 CodeableConceptIPS Coding for the medicine
Binding: SNOMEDCTMedicationCodes (example)
Additional BindingsPurpose
Australian Medication . Preferred
PBS Item Codes Preferred
MIMS Preferred
GTIN Preferred

ele-1: All FHIR elements must have a @value or children
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
ele-1: All FHIR elements must have a @value or children
..... coding:All Slices Content/Rules for all slices
...... Slices for extension Content/Rules for all slices
....... extension:medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... coding:pbs SΣ 0..* Coding Code defined by a terminology system
Binding: PBS Item Codes (required)
ele-1: All FHIR elements must have a @value or children
...... Slices for extension Content/Rules for all slices
....... extension:medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... coding:amt SΣ 0..* Coding Code defined by a terminology system
Binding: Australian Medication . (required)
ele-1: All FHIR elements must have a @value or children
...... Slices for extension Content/Rules for all slices
....... extension:medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... form S 0..1 CodeableConceptIPS powder | tablets | capsule +
Binding: Medication Form . (preferred)
ele-1: All FHIR elements must have a @value or children
... ingredient S 0..* BackboneElement Active or inactive ingredient
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... item[x] S 1..1 The actual ingredient or content
Binding: AMT Medicinal Product and Substances (preferred)
ele-1: All FHIR elements must have a @value or children
..... itemCodeableConcept CodeableConcept(CodeableConceptIPS)
..... itemReference Reference(Substance | Medication)
.... strength S 0..1 Ratio Quantity/strength of ingredient present
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.codeexampleSNOMEDCTMedicationCodes
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
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMedicationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* AUBaseMedication A medication in an Australian healthcare context
This profile also complies with the profiles Medication (IPS) and AU Core Medication
... 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
... extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifier for this medication
... code SΣ 1..1 CodeableConceptIPS Coding for the medicine
Binding: SNOMEDCTMedicationCodes (example)
Additional BindingsPurpose
Australian Medication . Preferred
PBS Item Codes Preferred
MIMS Preferred
GTIN Preferred
.... 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
....... extension: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 SΣ 0..* Coding Code defined by a terminology system
Binding: PBS Item Codes (required)
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension: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 SΣ 0..* Coding Code defined by a terminology system
Binding: Australian Medication . (required)
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension: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 Σ 0..1 Reference(Organization) Physical product manufacturer organisation
... form S 0..1 CodeableConceptIPS powder | tablets | capsule +
Binding: Medication Form . (preferred)
... amount Σ 0..1 Ratio Amount of drug in package
... ingredient S 0..* BackboneElement Active or inactive ingredient
.... 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] S 1..1 The actual ingredient or content
Binding: AMT Medicinal Product and Substances (preferred)
..... itemCodeableConcept CodeableConcept(CodeableConceptIPS)
..... itemReference Reference(Substance | Medication)
.... isActive 0..1 boolean Active ingredient indicator
.... strength S 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
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Medication.codeexampleSNOMEDCTMedicationCodes
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
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMedicationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from AUBaseMedication

Summary

Mandatory: 1 element
Must-Support: 7 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

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

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron