AU Base Implementation Guide
4.2.1-preview - Preview Australia flag

This page is part of the Australian Base IG (v4.2.1-preview: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 4.1.0. 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: 4.2.1-preview
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:
  • 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:

Usage:

Formal Views of Profile Content

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

This structure is derived from MedicationStatement

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
..... Slices for coding 0..* Coding Medication Codes
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: Australian Medication . (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
.... medication[x]:medicationReference 0..1 Reference() Medication Reference
... reasonCode 0..* CodeableConcept Reason for why the medication is being/was taken
Binding: Medication Reason Taken . (preferred)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbspreferredPBSItemCodes (a valid code from PBS Item Codes)
http://terminology.hl7.org.au/ValueSet/pbs-item
from this IG
MedicationStatement.medication[x]:medicationCodeableConcept.coding:gtinpreferredGTIN
http://terminology.hl7.org/ValueSet/v3-GTIN
MedicationStatement.medication[x]:medicationCodeableConcept.coding:amtpreferredAustralianMedication .
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
MedicationStatement.medication[x]:medicationCodeableConcept.coding:mimsPackagepreferredMIMS (a valid code from Monthly Index of Medical Specialties (MIMS))
http://terminology.hl7.org.au/ValueSet/mims
from this IG
MedicationStatement.reasonCodepreferredMedicationReasonTaken .
https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement 0..* MedicationStatement A record of medication being taken by a patient in an Australian healthcare context
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... 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.

.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
.... medication[x]:medicationCodeableConcept Σ 0..1 CodeableConcept Coded Medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.

..... Slices for coding Σ 0..* Coding Medication Codes
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: Australian Medication . (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
.... medication[x]:medicationReference Σ 0..1 Reference() Medication Reference
... subject Σ 1..1 Reference(Patient | Group) Who is/was taking the medication
... reasonCode 0..* CodeableConcept Reason for why the medication is being/was taken
Binding: Medication Reason Taken . (preferred)
... dosage 0..* AUBaseDosage Dosage information in an Australian healthcare context

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationStatement.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1
from the FHIR Standard
MedicationStatement.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationStatement.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbspreferredPBSItemCodes (a valid code from PBS Item Codes)
http://terminology.hl7.org.au/ValueSet/pbs-item
from this IG
MedicationStatement.medication[x]:medicationCodeableConcept.coding:gtinpreferredGTIN
http://terminology.hl7.org/ValueSet/v3-GTIN
MedicationStatement.medication[x]:medicationCodeableConcept.coding:amtpreferredAustralianMedication .
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
MedicationStatement.medication[x]:medicationCodeableConcept.coding:mimsPackagepreferredMIMS (a valid code from Monthly Index of Medical Specialties (MIMS))
http://terminology.hl7.org.au/ValueSet/mims
from this IG
MedicationStatement.reasonCodepreferredMedicationReasonTaken .
https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationStatementIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationStatementIf 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-4errorMedicationStatementIf 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-5errorMedicationStatementIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationStatementA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External identifier
... basedOn Σ 0..* Reference(MedicationRequest | CarePlan | ServiceRequest) Fulfils plan, proposal or order
... partOf Σ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) Part of referenced event
... status ?!Σ 1..1 code active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken
Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement.

... statusReason 0..* CodeableConcept Reason for current status
Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement.


... category Σ 0..1 CodeableConcept Type of medication usage
Binding: Medication usage category codes (preferred): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered.

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

.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
.... medication[x]:medicationCodeableConcept Σ 0..1 CodeableConcept Coded Medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.

..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ 0..* Coding Medication Codes
Slice: Unordered, Open by value:system
...... coding:pbs Σ 0..* Coding PBS Item Code
Binding: PBS Item Codes (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
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
....... 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
...... coding:gtin Σ 0..* Coding Medication Package Global Trade Item Number (GTIN)
Binding: 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
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://www.gs1.org/gtin
....... 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
...... coding:amt Σ 0..* Coding AMT Medicines
Binding: Australian Medication . (preferred)
....... id 0..1 string Unique id for inter-element referencing
....... 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
....... 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
...... coding:mimsPackage Σ 0..1 Coding MIMS Package
Binding: MIMS (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
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://www.mims.com.au/codes
....... 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
.... medication[x]:medicationReference Σ 0..1 Reference() Medication Reference
... subject Σ 1..1 Reference(Patient | Group) Who is/was taking the medication
... context Σ 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with MedicationStatement
... effective[x] Σ 0..1 The date/time or interval when the medication is/was/will be taken
.... effectiveDateTime dateTime
.... effectivePeriod Period
... dateAsserted Σ 0..1 dateTime When the statement was asserted?
... informationSource 0..1 Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) Person or organization that provided the information about the taking of this medication
... derivedFrom 0..* Reference(Resource) Additional supporting information
... reasonCode 0..* CodeableConcept Reason for why the medication is being/was taken
Binding: Medication Reason Taken . (preferred)
... reasonReference 0..* Reference(Condition | Observation | DiagnosticReport) Condition or observation that supports why the medication is being/was taken
... note 0..* Annotation Further information about the statement
... dosage 0..* AUBaseDosage Dosage information in an Australian healthcare context

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationStatement.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MedicationStatement.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1
from the FHIR Standard
MedicationStatement.statusReasonexampleSNOMEDCTDrugTherapyStatusCodes
http://hl7.org/fhir/ValueSet/reason-medication-status-codes
from the FHIR Standard
MedicationStatement.categorypreferredMedication usage category codes
http://hl7.org/fhir/ValueSet/medication-statement-category
from the FHIR Standard
MedicationStatement.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationStatement.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbspreferredPBSItemCodes (a valid code from PBS Item Codes)
http://terminology.hl7.org.au/ValueSet/pbs-item
from this IG
MedicationStatement.medication[x]:medicationCodeableConcept.coding:gtinpreferredGTIN
http://terminology.hl7.org/ValueSet/v3-GTIN
MedicationStatement.medication[x]:medicationCodeableConcept.coding:amtpreferredAustralianMedication .
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
MedicationStatement.medication[x]:medicationCodeableConcept.coding:mimsPackagepreferredMIMS (a valid code from Monthly Index of Medical Specialties (MIMS))
http://terminology.hl7.org.au/ValueSet/mims
from this IG
MedicationStatement.reasonCodepreferredMedicationReasonTaken .
https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1

Constraints

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

This structure is derived from MedicationStatement

Summary

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

Structures

This structure refers to these other structures:

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)
  • The element 1 is sliced based on the value of MedicationStatement.medication[x].coding

Maturity: 2

Differential View

This structure is derived from MedicationStatement

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
..... Slices for coding 0..* Coding Medication Codes
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: Australian Medication . (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
.... medication[x]:medicationReference 0..1 Reference() Medication Reference
... reasonCode 0..* CodeableConcept Reason for why the medication is being/was taken
Binding: Medication Reason Taken . (preferred)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbspreferredPBSItemCodes (a valid code from PBS Item Codes)
http://terminology.hl7.org.au/ValueSet/pbs-item
from this IG
MedicationStatement.medication[x]:medicationCodeableConcept.coding:gtinpreferredGTIN
http://terminology.hl7.org/ValueSet/v3-GTIN
MedicationStatement.medication[x]:medicationCodeableConcept.coding:amtpreferredAustralianMedication .
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
MedicationStatement.medication[x]:medicationCodeableConcept.coding:mimsPackagepreferredMIMS (a valid code from Monthly Index of Medical Specialties (MIMS))
http://terminology.hl7.org.au/ValueSet/mims
from this IG
MedicationStatement.reasonCodepreferredMedicationReasonTaken .
https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement 0..* MedicationStatement A record of medication being taken by a patient in an Australian healthcare context
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... 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.

.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
.... medication[x]:medicationCodeableConcept Σ 0..1 CodeableConcept Coded Medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.

..... Slices for coding Σ 0..* Coding Medication Codes
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: Australian Medication . (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
.... medication[x]:medicationReference Σ 0..1 Reference() Medication Reference
... subject Σ 1..1 Reference(Patient | Group) Who is/was taking the medication
... reasonCode 0..* CodeableConcept Reason for why the medication is being/was taken
Binding: Medication Reason Taken . (preferred)
... dosage 0..* AUBaseDosage Dosage information in an Australian healthcare context

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationStatement.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1
from the FHIR Standard
MedicationStatement.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationStatement.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbspreferredPBSItemCodes (a valid code from PBS Item Codes)
http://terminology.hl7.org.au/ValueSet/pbs-item
from this IG
MedicationStatement.medication[x]:medicationCodeableConcept.coding:gtinpreferredGTIN
http://terminology.hl7.org/ValueSet/v3-GTIN
MedicationStatement.medication[x]:medicationCodeableConcept.coding:amtpreferredAustralianMedication .
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
MedicationStatement.medication[x]:medicationCodeableConcept.coding:mimsPackagepreferredMIMS (a valid code from Monthly Index of Medical Specialties (MIMS))
http://terminology.hl7.org.au/ValueSet/mims
from this IG
MedicationStatement.reasonCodepreferredMedicationReasonTaken .
https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1

Constraints

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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External identifier
... basedOn Σ 0..* Reference(MedicationRequest | CarePlan | ServiceRequest) Fulfils plan, proposal or order
... partOf Σ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) Part of referenced event
... status ?!Σ 1..1 code active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken
Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement.

... statusReason 0..* CodeableConcept Reason for current status
Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement.


... category Σ 0..1 CodeableConcept Type of medication usage
Binding: Medication usage category codes (preferred): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered.

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

.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
.... medication[x]:medicationCodeableConcept Σ 0..1 CodeableConcept Coded Medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.

..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ 0..* Coding Medication Codes
Slice: Unordered, Open by value:system
...... coding:pbs Σ 0..* Coding PBS Item Code
Binding: PBS Item Codes (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
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
....... 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
...... coding:gtin Σ 0..* Coding Medication Package Global Trade Item Number (GTIN)
Binding: 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
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://www.gs1.org/gtin
....... 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
...... coding:amt Σ 0..* Coding AMT Medicines
Binding: Australian Medication . (preferred)
....... id 0..1 string Unique id for inter-element referencing
....... 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
....... 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
...... coding:mimsPackage Σ 0..1 Coding MIMS Package
Binding: MIMS (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
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://www.mims.com.au/codes
....... 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
.... medication[x]:medicationReference Σ 0..1 Reference() Medication Reference
... subject Σ 1..1 Reference(Patient | Group) Who is/was taking the medication
... context Σ 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with MedicationStatement
... effective[x] Σ 0..1 The date/time or interval when the medication is/was/will be taken
.... effectiveDateTime dateTime
.... effectivePeriod Period
... dateAsserted Σ 0..1 dateTime When the statement was asserted?
... informationSource 0..1 Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) Person or organization that provided the information about the taking of this medication
... derivedFrom 0..* Reference(Resource) Additional supporting information
... reasonCode 0..* CodeableConcept Reason for why the medication is being/was taken
Binding: Medication Reason Taken . (preferred)
... reasonReference 0..* Reference(Condition | Observation | DiagnosticReport) Condition or observation that supports why the medication is being/was taken
... note 0..* Annotation Further information about the statement
... dosage 0..* AUBaseDosage Dosage information in an Australian healthcare context

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationStatement.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MedicationStatement.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1
from the FHIR Standard
MedicationStatement.statusReasonexampleSNOMEDCTDrugTherapyStatusCodes
http://hl7.org/fhir/ValueSet/reason-medication-status-codes
from the FHIR Standard
MedicationStatement.categorypreferredMedication usage category codes
http://hl7.org/fhir/ValueSet/medication-statement-category
from the FHIR Standard
MedicationStatement.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationStatement.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbspreferredPBSItemCodes (a valid code from PBS Item Codes)
http://terminology.hl7.org.au/ValueSet/pbs-item
from this IG
MedicationStatement.medication[x]:medicationCodeableConcept.coding:gtinpreferredGTIN
http://terminology.hl7.org/ValueSet/v3-GTIN
MedicationStatement.medication[x]:medicationCodeableConcept.coding:amtpreferredAustralianMedication .
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
MedicationStatement.medication[x]:medicationCodeableConcept.coding:mimsPackagepreferredMIMS (a valid code from Monthly Index of Medical Specialties (MIMS))
http://terminology.hl7.org.au/ValueSet/mims
from this IG
MedicationStatement.reasonCodepreferredMedicationReasonTaken .
https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1

Constraints

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

This structure is derived from MedicationStatement

Summary

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

Structures

This structure refers to these other structures:

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)
  • The element 1 is sliced based on the value of MedicationStatement.medication[x].coding

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron