AU Core Medication - AU Core Implementation Guide v1.0.0-ballot

AU Core Implementation Guide
1.0.0-ballot - Ballot Australia flag

This page is part of the AU Core (v1.0.0-ballot: AU Core R1 Ballot 7) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: AU Core Medication

Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-medication		Version: 1.0.0-ballot
Standards status: Draft	Maturity Level: 1	Computable Name: AUCoreMedication
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 to record, search, and fetch medications associated with a patient. It is based on the AU Base Medication profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Medication when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

In AU Core a Medication resource is used within the context of a referencing resource: MedicationAdministration, MedicationDispense, MedicationRequest, or MedicationStatement resource.

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

Usage scenarios

The following are supported usage scenarios for this profile:

Query medications associated with a patient referenced by another resource
Record or update a medication associated with a patient referenced by another resource
Read medications associated with a patient referenced by another resource

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 for guidance.

Usage:

Refer to this Resource Profile: AU Core MedicationRequest
Examples for this Resource Profile: Medication/1active-ingredient, Medication/2active-ingredients and Medication/simvastatin

Formal Views of Profile Content

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

This structure is derived from AUBaseMedication

Description & Constraints

Medication

0..*

AUBaseMedication

A medication in an Australian healthcare context

code

SO

1..1

CodeableConcept

Coding for the medicine

Obligations

Actor

SHALL:populate-if-known

SHALL:no-error

0..*

Code defined by a terminology system
Slice: Unordered, Open by pattern:$this

coding:pbs

SO

0..*

Coding

Code defined by a terminology system
Binding: PBS Item Codes (required)

Obligations

Actor

SHALL:populate-if-known

AU Core Responder

SHALL:no-error

AU Core Requester

coding:amt

SO

0..*

Coding

Code defined by a terminology system
Binding: Australian Medication

(required)

Obligations

Actor

SHALL:populate-if-known

AU Core Responder

SHALL:no-error

AU Core Requester

Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Medication.code.coding:pbs	required	PBSItemCodes `http://terminology.hl7.org.au/ValueSet/pbs-item`
Medication.code.coding:amt	required	AustralianMedication `https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1` from https://tx.ontoserver.csiro.au/fhir

Description & Constraints

Medication

0..*

AUBaseMedication

A medication in an Australian healthcare context

implicitRules

?!Σ

0..1

uri

A set of rules under which this content was created

modifierExtension

?!

0..*

Extension

Extensions that cannot be ignored

code

SOΣ

1..1

CodeableConcept

Coding for the medicine
Binding: SNOMEDCTMedicationCodes (example)

Additional Bindings

Purpose

Australian Medication

Obligations

Actor

SHALL:populate-if-known

AU Core Responder

SHALL:no-error

AU Core Requester

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

Slices for extension

Content/Rules for all slices

medicationClass

0..1

Coding

Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)

coding:pbs

SOΣ

0..*

Coding

Code defined by a terminology system
Binding: PBS Item Codes (required)

Obligations

Actor

SHALL:populate-if-known

AU Core Responder

SHALL:no-error

AU Core Requester

Slices for extension

Content/Rules for all slices

medicationClass

0..1

Coding

Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)

coding:amt

SOΣ

0..*

Coding

Code defined by a terminology system
Binding: Australian Medication

(required)

Obligations

Actor

SHALL:populate-if-known

AU Core Responder

SHALL:no-error

AU Core Requester

Slices for extension

Content/Rules for all slices

medicationClass

0..1

Coding

Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)

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.

Documentation for this format

Terminology Bindings

Path Conformance ValueSet URI

Medication.code

example

SNOMEDCTMedicationCodes

Additional Bindings

Purpose

Documentation

Australian Medication

Preferred

This value set is for use when AMT (Australian Medicines Terminology) codes are preferred.

PBS Item Codes

Preferred

This value set is for use when PBS (Pharmaceutical Benefits Scheme) item codes are preferred.

MIMS

Preferred

This value set is for use when MIMS (Monthly Index of Medical Specialties) codes are preferred.

GTIN

Preferred

This value set is for use when GTIN (Global Trade Item Number) codes are preferred.

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

from the FHIR Standard

Medication.code.coding:pbs

required

PBSItemCodes

http://terminology.hl7.org.au/ValueSet/pbs-item

Medication.code.coding:amt

required

AustralianMedication

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

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

Medication.status

required

Medication Status Codes

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

from the FHIR Standard

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

AUBaseMedication

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

Additional Bindings

Purpose

AllLanguages

Max Binding

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

from the FHIR Standard

Medication.code

example

SNOMEDCTMedicationCodes

Additional Bindings

Purpose

Documentation

Australian Medication

Preferred

This value set is for use when AMT (Australian Medicines Terminology) codes are preferred.

PBS Item Codes

Preferred

This value set is for use when PBS (Pharmaceutical Benefits Scheme) item codes are preferred.

MIMS

Preferred

This value set is for use when MIMS (Monthly Index of Medical Specialties) codes are preferred.

GTIN

Preferred

This value set is for use when GTIN (Global Trade Item Number) codes are preferred.

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

from the FHIR Standard

Medication.code.coding:pbs

required

PBSItemCodes

http://terminology.hl7.org.au/ValueSet/pbs-item

Medication.code.coding:amt

required

AustralianMedication

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

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

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

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 AUBaseMedication

Description & Constraints

Medication

0..*

AUBaseMedication

A medication in an Australian healthcare context

code

SO

1..1

CodeableConcept

Coding for the medicine

Obligations

Actor

SHALL:populate-if-known

SHALL:no-error

0..*

Code defined by a terminology system
Slice: Unordered, Open by pattern:$this

coding:pbs

SO

0..*

Coding

Code defined by a terminology system
Binding: PBS Item Codes (required)

Obligations

Actor

SHALL:populate-if-known

AU Core Responder

SHALL:no-error

AU Core Requester

coding:amt

SO

0..*

Coding

Code defined by a terminology system
Binding: Australian Medication

(required)

Obligations

Actor

SHALL:populate-if-known

AU Core Responder

SHALL:no-error

AU Core Requester

Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Medication.code.coding:pbs	required	PBSItemCodes `http://terminology.hl7.org.au/ValueSet/pbs-item`
Medication.code.coding:amt	required	AustralianMedication `https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1` from https://tx.ontoserver.csiro.au/fhir

Key Elements View

Description & Constraints

Medication

0..*

AUBaseMedication

A medication in an Australian healthcare context

implicitRules

?!Σ

0..1

uri

A set of rules under which this content was created

modifierExtension

?!

0..*

Extension

Extensions that cannot be ignored

code

SOΣ

1..1

CodeableConcept

Coding for the medicine
Binding: SNOMEDCTMedicationCodes (example)

Additional Bindings

Purpose

Australian Medication

Obligations

Actor

SHALL:populate-if-known

AU Core Responder

SHALL:no-error

AU Core Requester

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

Slices for extension

Content/Rules for all slices

medicationClass

0..1

Coding

Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)

coding:pbs

SOΣ

0..*

Coding

Code defined by a terminology system
Binding: PBS Item Codes (required)

Obligations

Actor

SHALL:populate-if-known

AU Core Responder

SHALL:no-error

AU Core Requester

Slices for extension

Content/Rules for all slices

medicationClass

0..1

Coding

Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)

coding:amt

SOΣ

0..*

Coding

Code defined by a terminology system
Binding: Australian Medication

(required)

Obligations

Actor

SHALL:populate-if-known

AU Core Responder

SHALL:no-error

AU Core Requester

Slices for extension

Content/Rules for all slices

medicationClass

0..1

Coding

Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)

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.

Documentation for this format

Terminology Bindings

Path Conformance ValueSet URI

Medication.code

example

SNOMEDCTMedicationCodes

Additional Bindings

Purpose

Documentation

Australian Medication

Preferred

This value set is for use when AMT (Australian Medicines Terminology) codes are preferred.

PBS Item Codes

Preferred

This value set is for use when PBS (Pharmaceutical Benefits Scheme) item codes are preferred.

MIMS

Preferred

This value set is for use when MIMS (Monthly Index of Medical Specialties) codes are preferred.

GTIN

Preferred

This value set is for use when GTIN (Global Trade Item Number) codes are preferred.

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

from the FHIR Standard

Medication.code.coding:pbs

required

PBSItemCodes

http://terminology.hl7.org.au/ValueSet/pbs-item

Medication.code.coding:amt

required

AustralianMedication

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

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

Medication.status

required

Medication Status Codes

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

from the FHIR Standard

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

AUBaseMedication

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

Additional Bindings

Purpose

AllLanguages

Max Binding

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

from the FHIR Standard

Medication.code

example

SNOMEDCTMedicationCodes

Additional Bindings

Purpose

Documentation

Australian Medication

Preferred

This value set is for use when AMT (Australian Medicines Terminology) codes are preferred.

PBS Item Codes

Preferred

This value set is for use when PBS (Pharmaceutical Benefits Scheme) item codes are preferred.

MIMS

Preferred

This value set is for use when MIMS (Monthly Index of Medical Specialties) codes are preferred.

GTIN

Preferred

This value set is for use when GTIN (Global Trade Item Number) codes are preferred.

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

from the FHIR Standard

Medication.code.coding:pbs

required

PBSItemCodes

http://terminology.hl7.org.au/ValueSet/pbs-item

Medication.code.coding:amt

required

AustralianMedication

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

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

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

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 AUBaseMedication

Summary

Mandatory: 1 element
Must-Support: 3 elements

Slices

This structure defines the following Slices:

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

Maturity: 1

Other representations of profile: CSV, Excel, Schematron

Notes:

Below is an overview of the mandatory and optional search parameters. FHIR search operations and the syntax used to describe the interactions is described here.

Mandatory Search Parameters

No mandatory search parameters for this profile.

Optional Search Parameters

No optional search parameters for this profile.

IG © 2022+ HL7 Australia. Package hl7.fhir.au.core#1.0.0-ballot based on FHIR 4.0.1. Generated 2024-08-05
Links: Table of Contents | QA Report | Version History | | Propose a change