AU Base Medication - AU Base Implementation Guide v4.1.2-preview

AU Base Implementation Guide
4.1.2-preview - Preview Australia flag

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

Resource Profile: AU Base Medication

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-medication		Version: 4.1.2-preview
Standards status: Trial-use	Maturity Level: 2	Computable Name: AUBaseMedication
Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

This profile defines a medication structure that localises core concepts, including terminology, for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

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.codemay 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

Usage:

Examples for this Resource Profile: Medication/BrandProductwithBatchDetails0, Medication/BrandedPack0, Medication/BrandedPack1, Medication/BrandedPackSingleActiveIngredient0... Show 8 more

Formal Views of Profile Content

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

This structure is derived from Medication

Name	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
Slices for coding	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system
coding:pbs	0..*	Coding	PBS Item Code Binding: PBS Item Codes (preferred)
system	1..1	uri	Identity of the terminology system Fixed Value: http://pbs.gov.au/code/item
coding:gtin	0..*	Coding	Medication Package Global Trade Item Number (GTIN) Binding: GTIN (preferred)
system	1..1	uri	Identity of the terminology system Fixed Value: http://www.gs1.org/gtin
coding:amt	0..*	Coding	AMT Medicines Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
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	1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
coding:mimsPackage	0..1	Coding	MIMS Package Binding: MIMS (preferred)
system	1..1	uri	Identity of the terminology system Fixed Value: http://www.mims.com.au/codes
text	0..1	string	Medication primary text
manufacturer	0..1	Reference(Organization)	Physical product manufacturer organisation
form	0..1	CodeableConcept	powder \| tablets \| capsule + Binding: https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1 (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
Medication.code.coding:pbs	preferred	PBSItemCodes (a valid code from PBS Item Codes)
Medication.code.coding:gtin	preferred	GTIN
Medication.code.coding:amt	preferred	https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
Medication.code.coding:mimsPackage	preferred	MIMS (a valid code from Monthly Index of Medical Specialties (MIMS))
Medication.form	preferred	https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1
Medication.ingredient.item[x]	preferred	AMTMedicinalProductAndSubstances

Name	Flags	Card.	Type	Description & Constraints
Medication		0..*	Medication	A medication in an Australian healthcare context
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
code	Σ	0..1	CodeableConcept	Coding for the medicine Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system
coding:pbs	Σ	0..*	Coding	PBS Item Code Binding: PBS Item Codes (preferred)
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://pbs.gov.au/code/item
coding:gtin	Σ	0..*	Coding	Medication Package Global Trade Item Number (GTIN) Binding: GTIN (preferred)
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://www.gs1.org/gtin
coding:amt	Σ	0..*	Coding	AMT Medicines Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
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	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
coding:mimsPackage	Σ	0..1	Coding	MIMS Package Binding: MIMS (preferred)
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://www.mims.com.au/codes
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: https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1 (preferred)
ingredient		0..*	BackboneElement	Active or inactive ingredient
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)
strength		0..1	Ratio	Quantity/strength of ingredient present
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Medication.code	example	SNOMEDCTMedicationCodes
Medication.code.coding:pbs	preferred	PBSItemCodes (a valid code from PBS Item Codes)
Medication.code.coding:gtin	preferred	GTIN
Medication.code.coding:amt	preferred	https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
Medication.code.coding:mimsPackage	preferred	MIMS (a valid code from Monthly Index of Medical Specialties (MIMS))
Medication.status	required	Medication Status Codes
Medication.form	preferred	https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1
Medication.ingredient.item[x]	preferred	AMTMedicinalProductAndSubstances

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()

Description & Constraints

Medication

0..*

Medication

A medication in an Australian healthcare context

id

Σ

0..1

id

Logical id of this artifact

Terminology Bindings

Path

Conformance

ValueSet

Medication.language

preferred

CommonLanguages

Additional Bindings

Purpose

AllLanguages

Max Binding

Medication.code

example

SNOMEDCTMedicationCodes

Medication.code.coding:pbs

preferred

PBSItemCodes (a valid code from PBS Item Codes)

Medication.code.coding:gtin

preferred

GTIN

Medication.code.coding:amt

preferred

https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1

Medication.code.coding:mimsPackage

preferred

MIMS (a valid code from Monthly Index of Medical Specialties (MIMS))

Medication.status

required

Medication Status Codes

Medication.form

preferred

https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1

Medication.ingredient.item[x]

preferred

AMTMedicinalProductAndSubstances

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

Mandatory: 0 element (4 nested mandatory elements)
Fixed Value: 4 elements

Extensions

This structure refers to these extensions:

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

Slices

This structure defines the following Slices:

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

Maturity: 2

Differential View

This structure is derived from Medication

Name	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
Slices for coding	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system
coding:pbs	0..*	Coding	PBS Item Code Binding: PBS Item Codes (preferred)
system	1..1	uri	Identity of the terminology system Fixed Value: http://pbs.gov.au/code/item
coding:gtin	0..*	Coding	Medication Package Global Trade Item Number (GTIN) Binding: GTIN (preferred)
system	1..1	uri	Identity of the terminology system Fixed Value: http://www.gs1.org/gtin
coding:amt	0..*	Coding	AMT Medicines Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
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	1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
coding:mimsPackage	0..1	Coding	MIMS Package Binding: MIMS (preferred)
system	1..1	uri	Identity of the terminology system Fixed Value: http://www.mims.com.au/codes
text	0..1	string	Medication primary text
manufacturer	0..1	Reference(Organization)	Physical product manufacturer organisation
form	0..1	CodeableConcept	powder \| tablets \| capsule + Binding: https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1 (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
Medication.code.coding:pbs	preferred	PBSItemCodes (a valid code from PBS Item Codes)
Medication.code.coding:gtin	preferred	GTIN
Medication.code.coding:amt	preferred	https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
Medication.code.coding:mimsPackage	preferred	MIMS (a valid code from Monthly Index of Medical Specialties (MIMS))
Medication.form	preferred	https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1
Medication.ingredient.item[x]	preferred	AMTMedicinalProductAndSubstances

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Medication		0..*	Medication	A medication in an Australian healthcare context
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
code	Σ	0..1	CodeableConcept	Coding for the medicine Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system
coding:pbs	Σ	0..*	Coding	PBS Item Code Binding: PBS Item Codes (preferred)
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://pbs.gov.au/code/item
coding:gtin	Σ	0..*	Coding	Medication Package Global Trade Item Number (GTIN) Binding: GTIN (preferred)
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://www.gs1.org/gtin
coding:amt	Σ	0..*	Coding	AMT Medicines Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
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	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
coding:mimsPackage	Σ	0..1	Coding	MIMS Package Binding: MIMS (preferred)
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://www.mims.com.au/codes
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: https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1 (preferred)
ingredient		0..*	BackboneElement	Active or inactive ingredient
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)
strength		0..1	Ratio	Quantity/strength of ingredient present
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Medication.code	example	SNOMEDCTMedicationCodes
Medication.code.coding:pbs	preferred	PBSItemCodes (a valid code from PBS Item Codes)
Medication.code.coding:gtin	preferred	GTIN
Medication.code.coding:amt	preferred	https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
Medication.code.coding:mimsPackage	preferred	MIMS (a valid code from Monthly Index of Medical Specialties (MIMS))
Medication.status	required	Medication Status Codes
Medication.form	preferred	https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1
Medication.ingredient.item[x]	preferred	AMTMedicinalProductAndSubstances

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

Description & Constraints

Medication

0..*

Medication

A medication in an Australian healthcare context

id

Σ

0..1

id

Logical id of this artifact

Terminology Bindings

Path

Conformance

ValueSet

Medication.language

preferred

CommonLanguages

Additional Bindings

Purpose

AllLanguages

Max Binding

Medication.code

example

SNOMEDCTMedicationCodes

Medication.code.coding:pbs

preferred

PBSItemCodes (a valid code from PBS Item Codes)

Medication.code.coding:gtin

preferred

GTIN

Medication.code.coding:amt

preferred

https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1

Medication.code.coding:mimsPackage

preferred

MIMS (a valid code from Monthly Index of Medical Specialties (MIMS))

Medication.status

required

Medication Status Codes

Medication.form

preferred

https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1

Medication.ingredient.item[x]

preferred

AMTMedicinalProductAndSubstances

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

Mandatory: 0 element (4 nested mandatory elements)
Fixed Value: 4 elements

Extensions

This structure refers to these extensions:

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

Slices

This structure defines the following Slices:

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

Maturity: 2

Other representations of profile: CSV, Excel, Schematron

IG © 2017+ HL7 Australia. Package hl7.fhir.au.base#4.1.2-preview based on FHIR 4.0.1. Generated 2023-11-15
Links: Table of Contents | QA Report | Version History | | Propose a change