AU Base Medication Statement - 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 Statement

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

This profile defines a medication statement 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:

When identifying a medication, this resource can use either a code or refer to a Medication resource.
If making use of MedicationStatement.code, this profile 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
If a medication is compounded and is a list of ingredients, MedicationStatement.code is still present and may contain only the list of ingredients as text in MedicationStatement.code.text.
Where additional medicinal product information is needed, MedicationStatement.medicationReference is preferred to MedicationStatement.code and use of extensions, see guidance on AU Base Medication.

Potentially useful extensions:

MedicationStatement: Medication Brand Name
MedicationStatement: Medication Generic Name

Usage:

Examples for this Resource Profile: MedicationStatement/example0, MedicationStatement/example1 and MedicationStatement/example2

Formal Views of Profile Content

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

This structure is derived from MedicationStatement

Description & Constraints

MedicationStatement

0..*

MedicationStatement

A record of medication being taken by a patient in an Australian healthcare context

Slices for extension

0..*

Extension

Extension
Slice: Unordered, Open by value:url

longTerm

0..1

boolean

Medication Long Term Indicator
URL: http://hl7.org.au/fhir/StructureDefinition/medication-long-term

Slices for medication[x]

1..1

CodeableConcept, Reference(Medication)

Medication Detail
Slice: Unordered, Closed by type:$this

medication[x]:medicationCodeableConcept

0..1

CodeableConcept

Coded Medication
Binding: SNOMEDCTMedicationCodes (example)

Additional Bindings

Purpose

Australian Medication

coding

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)

text

0..1

string

Medication primary text

medication[x]:medicationReference

0..1

Reference(Medication)

Medication Reference

reasonCode

0..*

CodeableConcept

Reason for why the medication is being/was taken
Binding: Medication Reason Taken

(preferred)

dosage

0..*

AUBaseDosage

Details of how medication is/was taken or should be taken

Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
MedicationStatement.medication[x]:medicationCodeableConcept	example	SNOMEDCTMedicationCodes
MedicationStatement.reasonCode	preferred	MedicationReasonTaken `https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1` from https://tx.ontoserver.csiro.au/fhir

Description & Constraints

MedicationStatement

0..*

MedicationStatement

A record of medication being taken by a patient 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

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

longTerm

0..1

boolean

Medication Long Term Indicator
URL: http://hl7.org.au/fhir/StructureDefinition/medication-long-term
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

status

?!Σ

1..1

code

Slices for medication[x]

Σ

1..1

Medication Detail
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.

ele-1: All FHIR elements must have a @value or children

medicationCodeableConcept

CodeableConcept

medicationReference

Reference(Medication)

medication[x]:medicationCodeableConcept

Σ

0..1

CodeableConcept

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

medication[x]:medicationReference

Σ

0..1

Reference(Medication)

Medication Reference
ele-1: All FHIR elements must have a @value or children

subject

Σ

1..1

Reference(Patient | Group)

Who is/was taking the medication
ele-1: All FHIR elements must have a @value or children

reasonCode

0..*

CodeableConcept

Reason for why the medication is being/was taken
Binding: Medication Reason Taken

(preferred)
ele-1: All FHIR elements must have a @value or children

dosage

0..*

AUBaseDosage

Details of how medication is/was taken or should be taken
ele-1: All FHIR elements must have a @value or children

Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
MedicationStatement.status	required	Medication Status Codes `http://hl7.org/fhir/ValueSet/medication-statement-status\|4.0.1` from the FHIR Standard
MedicationStatement.medication[x]	example	SNOMEDCTMedicationCodes `http://hl7.org/fhir/ValueSet/medication-codes` from the FHIR Standard
MedicationStatement.medication[x]:medicationCodeableConcept	example	SNOMEDCTMedicationCodes `http://hl7.org/fhir/ValueSet/medication-codes` from the FHIR Standard
MedicationStatement.reasonCode	preferred	MedicationReasonTaken `https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1` from https://tx.ontoserver.csiro.au/fhir

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	MedicationStatement	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	MedicationStatement	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	MedicationStatement	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	MedicationStatement	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	MedicationStatement	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

MedicationStatement

0..*

MedicationStatement

A record of medication being taken by a patient in an Australian healthcare context

id

Σ

0..1

id

Logical id of this artifact

Terminology Bindings

Path Conformance ValueSet URI

MedicationStatement.language

preferred

CommonLanguages

http://hl7.org/fhir/ValueSet/languages

from the FHIR Standard

Additional Bindings

Purpose

AllLanguages

Max Binding

MedicationStatement.status

required

Medication Status Codes

http://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1

from the FHIR Standard

MedicationStatement.statusReason

example

SNOMEDCTDrugTherapyStatusCodes

http://hl7.org/fhir/ValueSet/reason-medication-status-codes

from the FHIR Standard

MedicationStatement.category

preferred

Medication usage category codes

http://hl7.org/fhir/ValueSet/medication-statement-category

from the FHIR Standard

MedicationStatement.medication[x]

example

SNOMEDCTMedicationCodes

http://hl7.org/fhir/ValueSet/medication-codes

from the FHIR Standard

MedicationStatement.medication[x]:medicationCodeableConcept

example

SNOMEDCTMedicationCodes

http://hl7.org/fhir/ValueSet/medication-codes

from the FHIR Standard

MedicationStatement.reasonCode

preferred

MedicationReasonTaken

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

from https://tx.ontoserver.csiro.au/fhir

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	MedicationStatement	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	MedicationStatement	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	MedicationStatement	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	MedicationStatement	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	MedicationStatement	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 MedicationStatement

Summary

Structures

This structure refers to these other structures:

AU Base Dosage (http://hl7.org.au/fhir/StructureDefinition/au-dosage)

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

The element 1 is sliced based on the value of MedicationStatement.medication[x] (Closed)

Maturity: 2

Differential View

This structure is derived from MedicationStatement

Description & Constraints

MedicationStatement

0..*

MedicationStatement

A record of medication being taken by a patient in an Australian healthcare context

Slices for extension

0..*

Extension

Extension
Slice: Unordered, Open by value:url

longTerm

0..1

boolean

Medication Long Term Indicator
URL: http://hl7.org.au/fhir/StructureDefinition/medication-long-term

Slices for medication[x]

1..1

CodeableConcept, Reference(Medication)

Medication Detail
Slice: Unordered, Closed by type:$this

medication[x]:medicationCodeableConcept

0..1

CodeableConcept

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

medication[x]:medicationReference

0..1

Reference(Medication)

Medication Reference

reasonCode

0..*

CodeableConcept

Reason for why the medication is being/was taken
Binding: Medication Reason Taken

(preferred)

dosage

0..*

AUBaseDosage

Details of how medication is/was taken or should be taken

Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
MedicationStatement.medication[x]:medicationCodeableConcept	example	SNOMEDCTMedicationCodes
MedicationStatement.reasonCode	preferred	MedicationReasonTaken `https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1` from https://tx.ontoserver.csiro.au/fhir

Key Elements View

Description & Constraints

MedicationStatement

0..*

MedicationStatement

A record of medication being taken by a patient 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

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

longTerm

0..1

boolean

Medication Long Term Indicator
URL: http://hl7.org.au/fhir/StructureDefinition/medication-long-term
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

status

?!Σ

1..1

code

Slices for medication[x]

Σ

1..1

Medication Detail
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.

ele-1: All FHIR elements must have a @value or children

medicationCodeableConcept

CodeableConcept

medicationReference

Reference(Medication)

medication[x]:medicationCodeableConcept

Σ

0..1

CodeableConcept

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

medication[x]:medicationReference

Σ

0..1

Reference(Medication)

Medication Reference
ele-1: All FHIR elements must have a @value or children

subject

Σ

1..1

Reference(Patient | Group)

Who is/was taking the medication
ele-1: All FHIR elements must have a @value or children

reasonCode

0..*

CodeableConcept

Reason for why the medication is being/was taken
Binding: Medication Reason Taken

(preferred)
ele-1: All FHIR elements must have a @value or children

dosage

0..*

AUBaseDosage

Details of how medication is/was taken or should be taken
ele-1: All FHIR elements must have a @value or children

Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
MedicationStatement.status	required	Medication Status Codes `http://hl7.org/fhir/ValueSet/medication-statement-status\|4.0.1` from the FHIR Standard
MedicationStatement.medication[x]	example	SNOMEDCTMedicationCodes `http://hl7.org/fhir/ValueSet/medication-codes` from the FHIR Standard
MedicationStatement.medication[x]:medicationCodeableConcept	example	SNOMEDCTMedicationCodes `http://hl7.org/fhir/ValueSet/medication-codes` from the FHIR Standard
MedicationStatement.reasonCode	preferred	MedicationReasonTaken `https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1` from https://tx.ontoserver.csiro.au/fhir

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	MedicationStatement	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	MedicationStatement	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	MedicationStatement	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	MedicationStatement	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	MedicationStatement	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

MedicationStatement

0..*

MedicationStatement

A record of medication being taken by a patient in an Australian healthcare context

id

Σ

0..1

id

Logical id of this artifact

Terminology Bindings

Path Conformance ValueSet URI

MedicationStatement.language

preferred

CommonLanguages

http://hl7.org/fhir/ValueSet/languages

from the FHIR Standard

Additional Bindings

Purpose

AllLanguages

Max Binding

MedicationStatement.status

required

Medication Status Codes

http://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1

from the FHIR Standard

MedicationStatement.statusReason

example

SNOMEDCTDrugTherapyStatusCodes

http://hl7.org/fhir/ValueSet/reason-medication-status-codes

from the FHIR Standard

MedicationStatement.category

preferred

Medication usage category codes

http://hl7.org/fhir/ValueSet/medication-statement-category

from the FHIR Standard

MedicationStatement.medication[x]

example

SNOMEDCTMedicationCodes

http://hl7.org/fhir/ValueSet/medication-codes

from the FHIR Standard

MedicationStatement.medication[x]:medicationCodeableConcept

example

SNOMEDCTMedicationCodes

http://hl7.org/fhir/ValueSet/medication-codes

from the FHIR Standard

MedicationStatement.reasonCode

preferred

MedicationReasonTaken

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

from https://tx.ontoserver.csiro.au/fhir

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	MedicationStatement	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	MedicationStatement	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	MedicationStatement	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	MedicationStatement	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	MedicationStatement	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()