AU Core Implementation Guide
0.3.0-ballot - R1 Australia flag

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

Resource Profile: AU Core MedicationStatement

Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-medicationstatement Version: 0.3.0-ballot
Standards status: Draft Maturity Level: 0 Computable Name: AUCoreMedicationStatement

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 MedicationStatement resource to record, search, and fetch summary statements of medication use associated with a patient. It is based on the AU Base Medication Statement profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the MedicationStatement when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

Usage scenarios

The following are supported usage scenarios for this profile:

  • Query for a patient’s medication usage (current and historical)
  • Record or update a record of a medication the patient may be taking the medication now or has taken the medication in the past or will be taking the medication in the future

Comparison with other national and international specifications

A resource conforming to this profile is conformant to:

No equivalent US Core profile.

Conformance in reverse is not guaranteed, i.e. a resource conforming to International Patient Access or International Patient Summary MAY NOT conform to AU Core.

Profile specific implementation guidance

  • See the Medicine information section for guidance
  • MedicationStatement resources can represent a medication using either a code with MedicationStatement.medicationCodeableConcept, or reference a Medication resource with MedicationStatement.medicationReference.
    • Although both are marked as must support, servers are not required to support both a code and a reference, but they SHALL support at least one of these elements
    • A client application SHALL support both elements
    • When referencing a Medication resource, it is preferred the resource is contained but it may be an external resource
  • MedicationStatement resources may record medication use that is derived from other records such as a MedicationRequest or MedicationDispense. In this case source system identifiers SHOULD be included as AU Local Prescription Identifier, AU ETP Prescription Identifier, or AU Local Dispense Identifier to support deduplication across medication resources.
    • See guidance on the construction of an identifier on the relevant Identifier profile page and the section on Business Identifiers in AU Base.

Usage:

Formal Views of Profile Content

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

This structure is derived from AUBaseMedicationStatement

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement 0..*AUBaseMedicationStatementA record of medication being taken by a patient in an Australian healthcare context
... basedOn S0..*Reference(AU Core MedicationRequest | CarePlan | ServiceRequest)Fulfils plan, proposal or order
... status S1..1codeactive | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken
... statusReason S0..*CodeableConceptReason for current status
... Slices for medication[x] S1..1CodeableConcept, Reference(Medication)Medication Detail
Slice: Unordered, Closed by type:$this
.... medication[x]:medicationCodeableConcept 0..1CodeableConceptCoded Medication
..... Slices for coding 0..*CodingMedication Codes
Slice: Unordered, Open by value:system
...... coding:pbs S0..*CodingPBS Item Code
...... coding:amt S0..*CodingAMT Medicines
.... medication[x]:medicationReference 0..1Reference(AU Core Medication)Medication Reference
... subject S1..1Reference(AU Core Patient)Who is/was taking the medication
... context S0..1Reference(AU Core Encounter)Encounter / Episode associated with MedicationStatement
... effective[x] S0..1dateTime, PeriodThe date/time or interval when the medication is/was/will be taken
... dateAsserted S0..1dateTimeWhen the statement was asserted?
... informationSource S0..1Reference(AU Core Patient | AU Core Practitioner | AU Core PractitionerRole | RelatedPerson)Person or organization that provided the information about the taking of this medication
... reasonCode S0..*CodeableConceptReason for why the medication is being/was taken
... note S0..*AnnotationFurther information about the statement
... dosage SC0..*AUBaseDosageDosage information in an Australian healthcare context
au-core-mst-03: If present, the dosage shall at least have text or patient instructions

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
au-core-mst-03errorMedicationStatement.dosageIf present, the dosage shall at least have text or patient instructions
: text.exists() or patientInstruction.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement 0..*AUBaseMedicationStatementA record of medication being taken by a patient in an Australian healthcare context
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... longTerm 0..1booleanMedication Long Term Indicator
URL: http://hl7.org.au/fhir/StructureDefinition/medication-long-term
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ1..1codeactive | 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 S0..*CodeableConceptReason for current status
Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement.


... category SΣ0..1CodeableConceptType 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] SΣ1..1Medication Detail
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.

.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
.... medication[x]:medicationCodeableConcept Σ0..1CodeableConceptCoded Medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.

..... Slices for coding Σ0..*CodingMedication Codes
Slice: Unordered, Open by value:system
...... coding:pbs SΣ0..*CodingPBS Item Code
Binding: PBS Item Codes (preferred)
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
...... coding:gtin Σ0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.gs1.org/gtin
...... coding:amt SΣ0..*CodingAMT Medicines
Binding: Australian Medication . (preferred)
....... medicationClass 0..1CodingMedication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... coding:mimsPackage Σ0..1CodingMIMS Package
Binding: MIMS (preferred)
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.mims.com.au/codes
.... medication[x]:medicationReference Σ0..1Reference(AU Core Medication)Medication Reference
... subject SΣ1..1Reference(AU Core Patient)Who is/was taking the medication
... context SΣ0..1Reference(AU Core Encounter)Encounter / Episode associated with MedicationStatement
... effective[x] SΣ0..1The date/time or interval when the medication is/was/will be taken
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... dateAsserted SΣ0..1dateTimeWhen the statement was asserted?
... informationSource S0..1Reference(AU Core Patient | AU Core Practitioner | AU Core PractitionerRole | RelatedPerson)Person or organization that provided the information about the taking of this medication
... reasonCode S0..*CodeableConceptReason for why the medication is being/was taken
Binding: Medication Reason Taken . (preferred)
... note S0..*AnnotationFurther information about the statement
... dosage SC0..*AUBaseDosageDosage information in an Australian healthcare context
au-core-mst-03: If present, the dosage shall at least have text or patient instructions

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.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
http://terminology.hl7.org.au/ValueSet/pbs-item
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
http://terminology.hl7.org.au/ValueSet/mims
MedicationStatement.reasonCodepreferredMedicationReasonTaken .
https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1

Constraints

IdGradePath(s)DetailsRequirements
au-core-mst-03errorMedicationStatement.dosageIf present, the dosage shall at least have text or patient instructions
: text.exists() or patientInstruction.exists()
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..*AUBaseMedicationStatementA record of medication being taken by a patient in an Australian healthcare context
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... longTerm 0..1booleanMedication Long Term Indicator
URL: http://hl7.org.au/fhir/StructureDefinition/medication-long-term
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal identifier
... basedOn SΣ0..*Reference(AU Core MedicationRequest | CarePlan | ServiceRequest)Fulfils plan, proposal or order
... partOf Σ0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation)Part of referenced event
... status ?!SΣ1..1codeactive | 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 S0..*CodeableConceptReason for current status
Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement.


... category SΣ0..1CodeableConceptType 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] SΣ1..1Medication Detail
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.

.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
.... medication[x]:medicationCodeableConcept Σ0..1CodeableConceptCoded Medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.

..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ0..*CodingMedication Codes
Slice: Unordered, Open by value:system
...... coding:pbs SΣ0..*CodingPBS Item Code
Binding: PBS Item Codes (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... coding:gtin Σ0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.gs1.org/gtin
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... coding:amt SΣ0..*CodingAMT Medicines
Binding: Australian Medication . (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... medicationClass 0..1CodingMedication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... coding:mimsPackage Σ0..1CodingMIMS Package
Binding: MIMS (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.mims.com.au/codes
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringMedication primary text
.... medication[x]:medicationReference Σ0..1Reference(AU Core Medication)Medication Reference
... subject SΣ1..1Reference(AU Core Patient)Who is/was taking the medication
... context SΣ0..1Reference(AU Core Encounter)Encounter / Episode associated with MedicationStatement
... effective[x] SΣ0..1The date/time or interval when the medication is/was/will be taken
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... dateAsserted SΣ0..1dateTimeWhen the statement was asserted?
... informationSource S0..1Reference(AU Core Patient | AU Core Practitioner | AU Core PractitionerRole | RelatedPerson)Person or organization that provided the information about the taking of this medication
... derivedFrom 0..*Reference(Resource)Additional supporting information
... reasonCode S0..*CodeableConceptReason 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 S0..*AnnotationFurther information about the statement
... dosage SC0..*AUBaseDosageDosage information in an Australian healthcare context
au-core-mst-03: If present, the dosage shall at least have text or patient instructions

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
http://terminology.hl7.org.au/ValueSet/pbs-item
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
http://terminology.hl7.org.au/ValueSet/mims
MedicationStatement.reasonCodepreferredMedicationReasonTaken .
https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1

Constraints

IdGradePath(s)DetailsRequirements
au-core-mst-03errorMedicationStatement.dosageIf present, the dosage shall at least have text or patient instructions
: text.exists() or patientInstruction.exists()
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()

Differential View

This structure is derived from AUBaseMedicationStatement

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement 0..*AUBaseMedicationStatementA record of medication being taken by a patient in an Australian healthcare context
... basedOn S0..*Reference(AU Core MedicationRequest | CarePlan | ServiceRequest)Fulfils plan, proposal or order
... status S1..1codeactive | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken
... statusReason S0..*CodeableConceptReason for current status
... Slices for medication[x] S1..1CodeableConcept, Reference(Medication)Medication Detail
Slice: Unordered, Closed by type:$this
.... medication[x]:medicationCodeableConcept 0..1CodeableConceptCoded Medication
..... Slices for coding 0..*CodingMedication Codes
Slice: Unordered, Open by value:system
...... coding:pbs S0..*CodingPBS Item Code
...... coding:amt S0..*CodingAMT Medicines
.... medication[x]:medicationReference 0..1Reference(AU Core Medication)Medication Reference
... subject S1..1Reference(AU Core Patient)Who is/was taking the medication
... context S0..1Reference(AU Core Encounter)Encounter / Episode associated with MedicationStatement
... effective[x] S0..1dateTime, PeriodThe date/time or interval when the medication is/was/will be taken
... dateAsserted S0..1dateTimeWhen the statement was asserted?
... informationSource S0..1Reference(AU Core Patient | AU Core Practitioner | AU Core PractitionerRole | RelatedPerson)Person or organization that provided the information about the taking of this medication
... reasonCode S0..*CodeableConceptReason for why the medication is being/was taken
... note S0..*AnnotationFurther information about the statement
... dosage SC0..*AUBaseDosageDosage information in an Australian healthcare context
au-core-mst-03: If present, the dosage shall at least have text or patient instructions

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
au-core-mst-03errorMedicationStatement.dosageIf present, the dosage shall at least have text or patient instructions
: text.exists() or patientInstruction.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement 0..*AUBaseMedicationStatementA record of medication being taken by a patient in an Australian healthcare context
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... longTerm 0..1booleanMedication Long Term Indicator
URL: http://hl7.org.au/fhir/StructureDefinition/medication-long-term
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ1..1codeactive | 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 S0..*CodeableConceptReason for current status
Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement.


... category SΣ0..1CodeableConceptType 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] SΣ1..1Medication Detail
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.

.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
.... medication[x]:medicationCodeableConcept Σ0..1CodeableConceptCoded Medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.

..... Slices for coding Σ0..*CodingMedication Codes
Slice: Unordered, Open by value:system
...... coding:pbs SΣ0..*CodingPBS Item Code
Binding: PBS Item Codes (preferred)
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
...... coding:gtin Σ0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.gs1.org/gtin
...... coding:amt SΣ0..*CodingAMT Medicines
Binding: Australian Medication . (preferred)
....... medicationClass 0..1CodingMedication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... coding:mimsPackage Σ0..1CodingMIMS Package
Binding: MIMS (preferred)
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.mims.com.au/codes
.... medication[x]:medicationReference Σ0..1Reference(AU Core Medication)Medication Reference
... subject SΣ1..1Reference(AU Core Patient)Who is/was taking the medication
... context SΣ0..1Reference(AU Core Encounter)Encounter / Episode associated with MedicationStatement
... effective[x] SΣ0..1The date/time or interval when the medication is/was/will be taken
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... dateAsserted SΣ0..1dateTimeWhen the statement was asserted?
... informationSource S0..1Reference(AU Core Patient | AU Core Practitioner | AU Core PractitionerRole | RelatedPerson)Person or organization that provided the information about the taking of this medication
... reasonCode S0..*CodeableConceptReason for why the medication is being/was taken
Binding: Medication Reason Taken . (preferred)
... note S0..*AnnotationFurther information about the statement
... dosage SC0..*AUBaseDosageDosage information in an Australian healthcare context
au-core-mst-03: If present, the dosage shall at least have text or patient instructions

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.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
http://terminology.hl7.org.au/ValueSet/pbs-item
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
http://terminology.hl7.org.au/ValueSet/mims
MedicationStatement.reasonCodepreferredMedicationReasonTaken .
https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1

Constraints

IdGradePath(s)DetailsRequirements
au-core-mst-03errorMedicationStatement.dosageIf present, the dosage shall at least have text or patient instructions
: text.exists() or patientInstruction.exists()
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..*AUBaseMedicationStatementA record of medication being taken by a patient in an Australian healthcare context
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... longTerm 0..1booleanMedication Long Term Indicator
URL: http://hl7.org.au/fhir/StructureDefinition/medication-long-term
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal identifier
... basedOn SΣ0..*Reference(AU Core MedicationRequest | CarePlan | ServiceRequest)Fulfils plan, proposal or order
... partOf Σ0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation)Part of referenced event
... status ?!SΣ1..1codeactive | 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 S0..*CodeableConceptReason for current status
Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement.


... category SΣ0..1CodeableConceptType 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] SΣ1..1Medication Detail
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.

.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
.... medication[x]:medicationCodeableConcept Σ0..1CodeableConceptCoded Medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.

..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ0..*CodingMedication Codes
Slice: Unordered, Open by value:system
...... coding:pbs SΣ0..*CodingPBS Item Code
Binding: PBS Item Codes (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... coding:gtin Σ0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.gs1.org/gtin
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... coding:amt SΣ0..*CodingAMT Medicines
Binding: Australian Medication . (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... medicationClass 0..1CodingMedication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... coding:mimsPackage Σ0..1CodingMIMS Package
Binding: MIMS (preferred)
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.mims.com.au/codes
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringMedication primary text
.... medication[x]:medicationReference Σ0..1Reference(AU Core Medication)Medication Reference
... subject SΣ1..1Reference(AU Core Patient)Who is/was taking the medication
... context SΣ0..1Reference(AU Core Encounter)Encounter / Episode associated with MedicationStatement
... effective[x] SΣ0..1The date/time or interval when the medication is/was/will be taken
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... dateAsserted SΣ0..1dateTimeWhen the statement was asserted?
... informationSource S0..1Reference(AU Core Patient | AU Core Practitioner | AU Core PractitionerRole | RelatedPerson)Person or organization that provided the information about the taking of this medication
... derivedFrom 0..*Reference(Resource)Additional supporting information
... reasonCode S0..*CodeableConceptReason 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 S0..*AnnotationFurther information about the statement
... dosage SC0..*AUBaseDosageDosage information in an Australian healthcare context
au-core-mst-03: If present, the dosage shall at least have text or patient instructions

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
http://terminology.hl7.org.au/ValueSet/pbs-item
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
http://terminology.hl7.org.au/ValueSet/mims
MedicationStatement.reasonCodepreferredMedicationReasonTaken .
https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1

Constraints

IdGradePath(s)DetailsRequirements
au-core-mst-03errorMedicationStatement.dosageIf present, the dosage shall at least have text or patient instructions
: text.exists() or patientInstruction.exists()
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()

 

Other representations of profile: CSV, Excel, Schematron

Notes:

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

Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”. A few items are marked as MAY in this implementation guide to highlight their potential relevance.

Parameter(s) Conformance Type(s) Requirements (when used alone or in combination)
patient SHALL reference The client SHALL provide at least an id value and MAY provide both the Type and id values. The server SHALL support both.
patient+status SHALL reference+token
patient+effective SHOULD reference+date
patient.identifier SHOULD reference.token The client SHALL provide both the system and code values. The server SHALL support both.

The client SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The server SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile.
effective MAY date A client SHALL provide a value precise to the second + time offset. A server SHALL support a value precise to the second + time offset.
status MAY token The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both.

Mandatory Search Parameters

The following search parameters and search parameter combinations SHALL be supported:

  1. SHALL support searching using the patient search parameter:
    • SHOULD support these _include parameters: MedicationStatement:medication
    • SHALL support these _revinclude parameters: Provenance:target
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])

    GET [base]/MedicationStatement?patient={Type/}[id] or optionallyGET [base]/MedicationStatement?patient.identifier=[system|][code]

    Example:

    1. GET [base]/MedicationStatement?patient=5678
    2. GET [base]/MedicationStatement?patient=5678&_include=MedicationStatement:medication
    3. GET [base]/MedicationStatement?patient.identifier=http://ns.electronichealth.net.au/id/medicare-number|32788511952
    4. GET [base]/MedicationStatement?patient.identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608833357361

    Implementation Notes: Fetches a bundle of all MedicationStatement resources for the specified patient (how to search by reference and how to search by token)

  2. SHALL support searching using the combination of the patient and status search parameters:
    • SHOULD support these _include parameters: MedicationStatement:medication
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])
    • SHALL support multipleOr search on status (e.g.status={system|}[code],{system|}[code],...)

    GET [base]/MedicationStatement?patient={Type/}[id]&status={system|}[code]{,{system|}[code],...}

    Example:

    1. GET [base]/MedicationStatement?patient=5678&status=active
    2. GET [base]/MedicationStatement?patient=5678&status=active&_include=MedicationStatement:medication

    Implementation Notes: Fetches a bundle of all MedicationStatement resources for the specified patient and status (how to search by reference and how to search by token)

Optional Search Parameters

The following search parameters and search parameter combinations SHOULD be supported:

  1. SHOULD support searching using the combination of the patient and effective search parameters:
    • SHOULD support these _include parameters: MedicationStatement:medication
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])
    • SHALL support these effective comparators: gt,lt,ge,le
    • SHOULD support multipleAnd search on effective (e.g.effective=[date]&effective=[date]]&...)

    GET [base]/MedicationStatement?patient={Type/}[id]&effective={gt|lt|ge|le}[date]{&effective={gt|lt|ge|le}[date]&...}

    Example:

    1. GET [base]/MedicationStatement?patient=5678&effective=ge2020-01-01T00:00:00Z
    2. GET [base]/MedicationStatement?patient.identifier=http://example.org/fhir/mrn|12345&effective=ge2020-01-01T00:00:00Z
    3. GET [base]/MedicationStatement?patient.identifier=http://example.org/fhir/mrn|12345&effective=ge2020-01-01T00:00:00Z&_include=MedicationStatement:medication

    Implementation Notes: Fetches a bundle of all MedicationStatement resources for the specified patient and date (how to search by reference and how to search by date)