AU Base Medication - AU Base Implementation Guide v5.0.0

AU Base Implementation Guide
5.0.0 - Working Standard Australia flag

This page is part of the Australian Base IG (v5.0.0: R4) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. 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: 5.0.0
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.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

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

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

coding

0..*

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)

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

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

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

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

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

coding

0..*

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)

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

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

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

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

Other representations of profile: CSV, Excel, Schematron

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