Usage Notes

Profile specific implementation guidance:

• Medication definition includes coding as:
  • PBS Item Code - Pharmaceutical Benefits Scheme coding, claiming context is not relevant as medicine coding
  • Medication Package Global Trade Item Number - Global Trade Item Number (GTIN) physical product reference
  • AMT Medicines - Australian Medicines Terminology, national drug terminology
  • MIMS Package - commonly used medicine coding
• When a code for medication definition is unavailable, just text is allowed in Medication.code.text.
• When a medication is compounded and is a list of ingredients, Medication.code may contain only the list of ingredients as text in Medication.code.text.
• Non-coded support for other medicinal product information can be supported as follows:
  • ​brand name in Medication Brand Name extension
  • ​generic name in Medication Generic Name extension
  • item form and strength as part of medication definition in Medication.code.text
  • manufacturer in Medication.manufacturer.display

Potentially useful extensions:

• Medication: Medication Brand Name
• Medication: Medication Generic Name

Changes since version 5.0.0:

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Medication

Name	Flags	Card.	Type	Description & Constraints
Medication		0..*	Medication	A medication in an Australian healthcare context
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
code		0..1	CodeableConcept	Coding for the medicine Binding: SNOMEDCTMedicationCodes (example) Additional Bindings Purpose Australian Medication Preferred PBS Item Codes Preferred MIMS Preferred GTIN Preferred
coding
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)
text		0..1	string	Medication primary text
manufacturer		0..1	Reference(Organization)	Physical product manufacturer organisation
form		0..1	CodeableConcept	powder | tablets | capsule + Binding: Medication Form (preferred)
ingredient		0..*	BackboneElement	Active or inactive ingredient
item[x]		1..1	CodeableConcept, Reference(Substance | Medication)	The actual ingredient or content Binding: AMT Medicinal Product and Substances (preferred)
strength		0..1	Ratio	Quantity/strength of ingredient present
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Medication.code	example	SNOMEDCTMedicationCodes
Medication.form	preferred	MedicationForm https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1 from https://tx.ontoserver.csiro.au/fhir
Medication.ingredient.item[x]	preferred	AMTMedicinalProductAndSubstances http://terminology.hl7.org.au/ValueSet/amt-mp-codes from this IG

Name	Flags	Card.	Type	Description & Constraints
Medication		0..*	Medication	A medication in an Australian healthcare context 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
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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	Σ	0..1	CodeableConcept	Coding for the medicine Binding: SNOMEDCTMedicationCodes (example) Additional Bindings Purpose Australian Medication Preferred PBS Item Codes Preferred MIMS Preferred GTIN Preferred ele-1: All FHIR elements must have a @value or children
text	Σ	0..1	string	Medication primary text ele-1: All FHIR elements must have a @value or children
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. ele-1: All FHIR elements must have a @value or children
manufacturer	Σ	0..1	Reference(Organization)	Physical product manufacturer organisation ele-1: All FHIR elements must have a @value or children
form		0..1	CodeableConcept	powder | tablets | capsule + Binding: Medication Form (preferred) ele-1: All FHIR elements must have a @value or children
ingredient		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]		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
itemReference			Reference(Substance | Medication)
strength		0..1	Ratio	Quantity/strength of ingredient present ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Medication.code	example	SNOMEDCTMedicationCodes http://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard
Medication.status	required	Medication Status Codes http://hl7.org/fhir/ValueSet/medication-status|4.0.1 from the FHIR Standard
Medication.form	preferred	MedicationForm https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1 from https://tx.ontoserver.csiro.au/fhir
Medication.ingredient.item[x]	preferred	AMTMedicinalProductAndSubstances http://terminology.hl7.org.au/ValueSet/amt-mp-codes from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Medication	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Medication	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 : 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-4	error	Medication	If 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-5	error	Medication	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Medication	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Name	Flags	Card.	Type	Description & Constraints
Medication		0..*	Medication	A medication in an Australian healthcare context
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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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	Σ	0..1	CodeableConcept	Coding for the medicine Binding: SNOMEDCTMedicationCodes (example) Additional Bindings Purpose 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
coding	Σ	0..*	Coding	Code defined by a terminology system
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		0..1	CodeableConcept	powder | tablets | capsule + Binding: Medication Form (preferred)
amount	Σ	0..1	Ratio	Amount of drug in package
ingredient		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]		1..1		The actual ingredient or content Binding: AMT Medicinal Product and Substances (preferred)
itemCodeableConcept			CodeableConcept
itemReference			Reference(Substance | 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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Medication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Medication.code	example	SNOMEDCTMedicationCodes http://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard
Medication.status	required	Medication Status Codes http://hl7.org/fhir/ValueSet/medication-status|4.0.1 from the FHIR Standard
Medication.form	preferred	MedicationForm https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1 from https://tx.ontoserver.csiro.au/fhir
Medication.ingredient.item[x]	preferred	AMTMedicinalProductAndSubstances http://terminology.hl7.org.au/ValueSet/amt-mp-codes from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Medication	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Medication	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 : 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-4	error	Medication	If 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-5	error	Medication	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Medication	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Differential View

This structure is derived from Medication

Name	Flags	Card.	Type	Description & Constraints
Medication		0..*	Medication	A medication in an Australian healthcare context
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
code		0..1	CodeableConcept	Coding for the medicine Binding: SNOMEDCTMedicationCodes (example) Additional Bindings Purpose Australian Medication Preferred PBS Item Codes Preferred MIMS Preferred GTIN Preferred
coding
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)
text		0..1	string	Medication primary text
manufacturer		0..1	Reference(Organization)	Physical product manufacturer organisation
form		0..1	CodeableConcept	powder | tablets | capsule + Binding: Medication Form (preferred)
ingredient		0..*	BackboneElement	Active or inactive ingredient
item[x]		1..1	CodeableConcept, Reference(Substance | Medication)	The actual ingredient or content Binding: AMT Medicinal Product and Substances (preferred)
strength		0..1	Ratio	Quantity/strength of ingredient present
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Medication.code	example	SNOMEDCTMedicationCodes
Medication.form	preferred	MedicationForm https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1 from https://tx.ontoserver.csiro.au/fhir
Medication.ingredient.item[x]	preferred	AMTMedicinalProductAndSubstances http://terminology.hl7.org.au/ValueSet/amt-mp-codes from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Medication		0..*	Medication	A medication in an Australian healthcare context 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
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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	Σ	0..1	CodeableConcept	Coding for the medicine Binding: SNOMEDCTMedicationCodes (example) Additional Bindings Purpose Australian Medication Preferred PBS Item Codes Preferred MIMS Preferred GTIN Preferred ele-1: All FHIR elements must have a @value or children
text	Σ	0..1	string	Medication primary text ele-1: All FHIR elements must have a @value or children
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. ele-1: All FHIR elements must have a @value or children
manufacturer	Σ	0..1	Reference(Organization)	Physical product manufacturer organisation ele-1: All FHIR elements must have a @value or children
form		0..1	CodeableConcept	powder | tablets | capsule + Binding: Medication Form (preferred) ele-1: All FHIR elements must have a @value or children
ingredient		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]		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
itemReference			Reference(Substance | Medication)
strength		0..1	Ratio	Quantity/strength of ingredient present ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Medication.code	example	SNOMEDCTMedicationCodes http://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard
Medication.status	required	Medication Status Codes http://hl7.org/fhir/ValueSet/medication-status|4.0.1 from the FHIR Standard
Medication.form	preferred	MedicationForm https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1 from https://tx.ontoserver.csiro.au/fhir
Medication.ingredient.item[x]	preferred	AMTMedicinalProductAndSubstances http://terminology.hl7.org.au/ValueSet/amt-mp-codes from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Medication	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Medication	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 : 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-4	error	Medication	If 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-5	error	Medication	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Medication	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Medication		0..*	Medication	A medication in an Australian healthcare context
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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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	Σ	0..1	CodeableConcept	Coding for the medicine Binding: SNOMEDCTMedicationCodes (example) Additional Bindings Purpose 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
coding	Σ	0..*	Coding	Code defined by a terminology system
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		0..1	CodeableConcept	powder | tablets | capsule + Binding: Medication Form (preferred)
amount	Σ	0..1	Ratio	Amount of drug in package
ingredient		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]		1..1		The actual ingredient or content Binding: AMT Medicinal Product and Substances (preferred)
itemCodeableConcept			CodeableConcept
itemReference			Reference(Substance | 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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Medication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Medication.code	example	SNOMEDCTMedicationCodes http://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard
Medication.status	required	Medication Status Codes http://hl7.org/fhir/ValueSet/medication-status|4.0.1 from the FHIR Standard
Medication.form	preferred	MedicationForm https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1 from https://tx.ontoserver.csiro.au/fhir
Medication.ingredient.item[x]	preferred	AMTMedicinalProductAndSubstances http://terminology.hl7.org.au/ValueSet/amt-mp-codes from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Medication	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Medication	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 : 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-4	error	Medication	If 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-5	error	Medication	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Medication	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Medication

Summary

Extensions

This structure refers to these extensions:

• http://hl7.org.au/fhir/StructureDefinition/medication-type

Maturity: 2