AU Patient Summary Implementation Guide
0.1.0-preview - Preview Australia flag

This page is part of the AU Patient Summary (v0.1.0-preview: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. No current official version has been published yet. For a full list of available versions, see the Directory of published versions

Resource Profile: AU PS MedicationStatement

Official URL: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-medicationstatement Version: 0.1.0-preview
Standards status: Draft Maturity Level: 0 Computable Name: AUPSMedicationStatement

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 in the context of a patient summary in an Australian context. It is based on the AU Base MedicationStatement profile, and applies the constraints of AU Core MedicationStatement and MedicationStatement (IPS).

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 in AU Core for guidance on how medicinal product identification can be structured in FHIR conformant to AU Patient Summary.
  • MedicationStatement resources can represent a medication using either a code with MedicationStatement.medicationCodeableConcept, or reference a Medication resource with MedicationStatement.medicationReference.
    • When referencing a Medication resource, it is preferred the resource is contained but it may be an external resource

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..* AUBaseMedicationStatement A record of medication being taken by a patient in an Australian healthcare context
This profile also complies with the profiles Medication Statement (IPS) and AU Core MedicationStatement
... status S 1..1 code active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken
... Slices for medication[x] S 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 Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
...... coding:pbs S 0..* Coding Code defined by a terminology system
Binding: PBS Item Codes (required)
...... coding:amt S 0..* Coding Code defined by a terminology system
Binding: Australian Medication . (required)
.... medication[x]:medicationReference 0..1 Reference(AU Core Medication) Medication Reference
... subject S 1..1 Reference(AU PS Patient) Who is/was taking the medication
.... reference S 1..1 string Literal reference, Relative, internal or absolute URL
... dateAsserted S 0..1 dateTime When the statement was asserted?
... reasonCode S 0..* CodeableConcept Reason for why the medication is being/was taken
... reasonReference S 0..* Reference(AU PS Condition | Observation | AU Base Diagnostic Report) Condition or observation that supports why the medication is being/was taken
... dosage S 0..* AUBaseDosage Details of how medication is/was taken or should be taken
.... text S 0..1 string Free text dosage instructions e.g. SIG
.... timing S 0..1 Timing When medication should be administered

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbsrequiredPBSItemCodes
http://terminology.hl7.org.au/ValueSet/pbs-item
MedicationStatement.medication[x]:medicationCodeableConcept.coding:amtrequiredAustralianMedication .
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement 0..* AUBaseMedicationStatement A record of medication being taken by a patient in an Australian healthcare context
This profile also complies with the profiles Medication Statement (IPS) and AU Core MedicationStatement
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension Content/Rules for all slices
.... extension:longTerm 0..1 boolean Medication Long Term Indicator
URL: http://hl7.org.au/fhir/StructureDefinition/medication-long-term
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... Slices for medication[x] SΣ 1..1 Medication Detail
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.


ele-1: All FHIR elements must have a @value or children
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
.... medication[x]:medicationCodeableConcept Σ 0..1 CodeableConcept Coded Medication
Binding: SNOMEDCTMedicationCodes (example)
Additional BindingsPurpose
Australian Medication . Preferred
PBS Item Codes Preferred
MIMS Preferred
GTIN Preferred

ele-1: All FHIR elements must have a @value or children
..... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
ele-1: All FHIR elements must have a @value or children
...... coding:All Slices Content/Rules for all slices
....... Slices for extension Content/Rules for all slices
........ extension:medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... coding:pbs SΣ 0..* Coding Code defined by a terminology system
Binding: PBS Item Codes (required)
ele-1: All FHIR elements must have a @value or children
....... Slices for extension Content/Rules for all slices
........ extension:medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... coding:amt SΣ 0..* Coding Code defined by a terminology system
Binding: Australian Medication . (required)
ele-1: All FHIR elements must have a @value or children
....... Slices for extension Content/Rules for all slices
........ extension:medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... medication[x]:medicationReference Σ 0..1 Reference(AU Core Medication) Medication Reference
ele-1: All FHIR elements must have a @value or children
... subject SΣ 1..1 Reference(AU PS Patient) Who is/was taking the medication
ele-1: All FHIR elements must have a @value or children
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
ele-1: All FHIR elements must have a @value or children
... effective[x] SΣ 1..1 The date/time or interval when the medication is/was/will be taken
ele-1: All FHIR elements must have a @value or children
.... effectiveDateTime dateTime
.... effectivePeriod Period
... dateAsserted SΣ 0..1 dateTime When the statement was asserted?
ele-1: All FHIR elements must have a @value or children
... reasonCode S 0..* CodeableConcept Reason for why the medication is being/was taken
Binding: Medication Reason Taken . (preferred)
ele-1: All FHIR elements must have a @value or children
... reasonReference S 0..* Reference(AU PS Condition | Observation | AU Base Diagnostic Report) Condition or observation that supports why the medication is being/was taken
ele-1: All FHIR elements must have a @value or children
... dosage S 0..* AUBaseDosage Details of how medication is/was taken or should be taken
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... text SΣ 0..1 string Free text dosage instructions e.g. SIG
ele-1: All FHIR elements must have a @value or children
.... timing SΣ 0..1 Timing When medication should be administered
ele-1: All FHIR elements must have a @value or children

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:pbsrequiredPBSItemCodes
http://terminology.hl7.org.au/ValueSet/pbs-item
MedicationStatement.medication[x]:medicationCodeableConcept.coding:amtrequiredAustralianMedication .
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
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..* AUBaseMedicationStatement A record of medication being taken by a patient in an Australian healthcare context
This profile also complies with the profiles Medication Statement (IPS) and AU Core MedicationStatement
... 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
.... extension: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 ?!SΣ 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] SΣ 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)
Additional BindingsPurpose
Australian Medication . Preferred
PBS Item Codes Preferred
MIMS Preferred
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
..... 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
....... id 0..1 string Unique id for inter-element referencing
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
....... system Σ 0..1 uri Identity of the terminology system
....... 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:pbs SΣ 0..* Coding Code defined by a terminology system
Binding: PBS Item Codes (required)
....... id 0..1 string Unique id for inter-element referencing
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
....... system Σ 0..1 uri Identity of the terminology system
....... 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 SΣ 0..* Coding Code defined by a terminology system
Binding: Australian Medication . (required)
....... id 0..1 string Unique id for inter-element referencing
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
....... system Σ 0..1 uri Identity of the terminology system
....... 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(AU Core Medication) Medication Reference
... subject SΣ 1..1 Reference(AU PS Patient) Who is/was taking the medication
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... context Σ 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with MedicationStatement
... effective[x] SΣ 1..1 The date/time or interval when the medication is/was/will be taken
.... effectiveDateTime dateTime
.... effectivePeriod Period
... dateAsserted SΣ 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 S 0..* CodeableConcept Reason for why the medication is being/was taken
Binding: Medication Reason Taken . (preferred)
... reasonReference S 0..* Reference(AU PS Condition | Observation | AU Base Diagnostic Report) Condition or observation that supports why the medication is being/was taken
... note 0..* Annotation Further information about the statement
... dosage S 0..* AUBaseDosage Details of how medication is/was taken or should be 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence Σ 0..1 integer The order of the dosage instructions
.... text SΣ 0..1 string Free text dosage instructions e.g. SIG
.... additionalInstruction Σ 0..* CodeableConcept Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMEDCTAdditionalDosageInstructions (preferred)
.... patientInstruction Σ 0..1 string Patient or consumer oriented instructions
.... timing SΣ 0..1 Timing When medication should be administered
.... asNeeded[x] Σ 0..1 Take "as needed" (for x)
Binding: Clinical Finding . (preferred)
..... asNeededBoolean boolean
..... asNeededCodeableConcept CodeableConcept
.... site Σ 0..1 CodeableConcept Body site to administer to
Binding: Body Site . (preferred)
.... route Σ 0..1 CodeableConcept How drug should enter body
Binding: Route of Administration . (preferred)
.... method Σ 0..1 CodeableConcept Technique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (preferred)
.... doseAndRate Σ 0..* Element Amount of medication administered
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ 0..1 CodeableConcept The kind of dose or rate specified
Binding: DoseAndRateType (example): The kind of dose or rate specified.

..... dose[x] Σ 0..1 Amount of medication per dose
...... doseRange Range
...... doseQuantity Quantity(SimpleQuantity)
..... rate[x] Σ 0..1 Amount of medication per unit of time
...... rateRatio Ratio
...... rateRange Range
...... rateQuantity Quantity(SimpleQuantity)
.... maxDosePerPeriod Σ 0..1 Ratio Upper limit on medication per unit of time
.... maxDosePerAdministration Σ 0..1 SimpleQuantity Upper limit on medication per administration
.... maxDosePerLifetime Σ 0..1 SimpleQuantity Upper limit on medication per lifetime of the patient

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationStatement.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
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:pbsrequiredPBSItemCodes
http://terminology.hl7.org.au/ValueSet/pbs-item
MedicationStatement.medication[x]:medicationCodeableConcept.coding:amtrequiredAustralianMedication .
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
MedicationStatement.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
MedicationStatement.reasonCodepreferredMedicationReasonTaken .
https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1
MedicationStatement.dosage.additionalInstructionpreferredSNOMEDCTAdditionalDosageInstructions
http://hl7.org/fhir/ValueSet/additional-instruction-codes
from the FHIR Standard
MedicationStatement.dosage.asNeeded[x]preferredClinicalFinding .
https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1
MedicationStatement.dosage.sitepreferredBodySite .
https://healthterminologies.gov.au/fhir/ValueSet/body-site-1
MedicationStatement.dosage.routepreferredRouteOfAdministration .
https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1
MedicationStatement.dosage.methodpreferredSNOMEDCTAdministrationMethodCodes
http://hl7.org/fhir/ValueSet/administration-method-codes
from the FHIR Standard
MedicationStatement.dosage.doseAndRate.typeexampleDoseAndRateType
http://hl7.org/fhir/ValueSet/dose-rate-type
from the FHIR Standard

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 AUBaseMedicationStatement

Summary

Mandatory: 2 elements
Must-Support: 13 elements

Structures

This structure refers to these other structures:

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

Differential View

This structure is derived from AUBaseMedicationStatement

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement 0..* AUBaseMedicationStatement A record of medication being taken by a patient in an Australian healthcare context
This profile also complies with the profiles Medication Statement (IPS) and AU Core MedicationStatement
... status S 1..1 code active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken
... Slices for medication[x] S 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 Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
...... coding:pbs S 0..* Coding Code defined by a terminology system
Binding: PBS Item Codes (required)
...... coding:amt S 0..* Coding Code defined by a terminology system
Binding: Australian Medication . (required)
.... medication[x]:medicationReference 0..1 Reference(AU Core Medication) Medication Reference
... subject S 1..1 Reference(AU PS Patient) Who is/was taking the medication
.... reference S 1..1 string Literal reference, Relative, internal or absolute URL
... dateAsserted S 0..1 dateTime When the statement was asserted?
... reasonCode S 0..* CodeableConcept Reason for why the medication is being/was taken
... reasonReference S 0..* Reference(AU PS Condition | Observation | AU Base Diagnostic Report) Condition or observation that supports why the medication is being/was taken
... dosage S 0..* AUBaseDosage Details of how medication is/was taken or should be taken
.... text S 0..1 string Free text dosage instructions e.g. SIG
.... timing S 0..1 Timing When medication should be administered

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbsrequiredPBSItemCodes
http://terminology.hl7.org.au/ValueSet/pbs-item
MedicationStatement.medication[x]:medicationCodeableConcept.coding:amtrequiredAustralianMedication .
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement 0..* AUBaseMedicationStatement A record of medication being taken by a patient in an Australian healthcare context
This profile also complies with the profiles Medication Statement (IPS) and AU Core MedicationStatement
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension Content/Rules for all slices
.... extension:longTerm 0..1 boolean Medication Long Term Indicator
URL: http://hl7.org.au/fhir/StructureDefinition/medication-long-term
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... Slices for medication[x] SΣ 1..1 Medication Detail
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.


ele-1: All FHIR elements must have a @value or children
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
.... medication[x]:medicationCodeableConcept Σ 0..1 CodeableConcept Coded Medication
Binding: SNOMEDCTMedicationCodes (example)
Additional BindingsPurpose
Australian Medication . Preferred
PBS Item Codes Preferred
MIMS Preferred
GTIN Preferred

ele-1: All FHIR elements must have a @value or children
..... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
ele-1: All FHIR elements must have a @value or children
...... coding:All Slices Content/Rules for all slices
....... Slices for extension Content/Rules for all slices
........ extension:medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... coding:pbs SΣ 0..* Coding Code defined by a terminology system
Binding: PBS Item Codes (required)
ele-1: All FHIR elements must have a @value or children
....... Slices for extension Content/Rules for all slices
........ extension:medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... coding:amt SΣ 0..* Coding Code defined by a terminology system
Binding: Australian Medication . (required)
ele-1: All FHIR elements must have a @value or children
....... Slices for extension Content/Rules for all slices
........ extension:medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... medication[x]:medicationReference Σ 0..1 Reference(AU Core Medication) Medication Reference
ele-1: All FHIR elements must have a @value or children
... subject SΣ 1..1 Reference(AU PS Patient) Who is/was taking the medication
ele-1: All FHIR elements must have a @value or children
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
ele-1: All FHIR elements must have a @value or children
... effective[x] SΣ 1..1 The date/time or interval when the medication is/was/will be taken
ele-1: All FHIR elements must have a @value or children
.... effectiveDateTime dateTime
.... effectivePeriod Period
... dateAsserted SΣ 0..1 dateTime When the statement was asserted?
ele-1: All FHIR elements must have a @value or children
... reasonCode S 0..* CodeableConcept Reason for why the medication is being/was taken
Binding: Medication Reason Taken . (preferred)
ele-1: All FHIR elements must have a @value or children
... reasonReference S 0..* Reference(AU PS Condition | Observation | AU Base Diagnostic Report) Condition or observation that supports why the medication is being/was taken
ele-1: All FHIR elements must have a @value or children
... dosage S 0..* AUBaseDosage Details of how medication is/was taken or should be taken
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... text SΣ 0..1 string Free text dosage instructions e.g. SIG
ele-1: All FHIR elements must have a @value or children
.... timing SΣ 0..1 Timing When medication should be administered
ele-1: All FHIR elements must have a @value or children

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:pbsrequiredPBSItemCodes
http://terminology.hl7.org.au/ValueSet/pbs-item
MedicationStatement.medication[x]:medicationCodeableConcept.coding:amtrequiredAustralianMedication .
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
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..* AUBaseMedicationStatement A record of medication being taken by a patient in an Australian healthcare context
This profile also complies with the profiles Medication Statement (IPS) and AU Core MedicationStatement
... 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
.... extension: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 ?!SΣ 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] SΣ 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)
Additional BindingsPurpose
Australian Medication . Preferred
PBS Item Codes Preferred
MIMS Preferred
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
..... 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
....... id 0..1 string Unique id for inter-element referencing
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
....... system Σ 0..1 uri Identity of the terminology system
....... 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:pbs SΣ 0..* Coding Code defined by a terminology system
Binding: PBS Item Codes (required)
....... id 0..1 string Unique id for inter-element referencing
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
....... system Σ 0..1 uri Identity of the terminology system
....... 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 SΣ 0..* Coding Code defined by a terminology system
Binding: Australian Medication . (required)
....... id 0..1 string Unique id for inter-element referencing
....... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
........ extension:medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
....... system Σ 0..1 uri Identity of the terminology system
....... 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(AU Core Medication) Medication Reference
... subject SΣ 1..1 Reference(AU PS Patient) Who is/was taking the medication
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... context Σ 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with MedicationStatement
... effective[x] SΣ 1..1 The date/time or interval when the medication is/was/will be taken
.... effectiveDateTime dateTime
.... effectivePeriod Period
... dateAsserted SΣ 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 S 0..* CodeableConcept Reason for why the medication is being/was taken
Binding: Medication Reason Taken . (preferred)
... reasonReference S 0..* Reference(AU PS Condition | Observation | AU Base Diagnostic Report) Condition or observation that supports why the medication is being/was taken
... note 0..* Annotation Further information about the statement
... dosage S 0..* AUBaseDosage Details of how medication is/was taken or should be 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence Σ 0..1 integer The order of the dosage instructions
.... text SΣ 0..1 string Free text dosage instructions e.g. SIG
.... additionalInstruction Σ 0..* CodeableConcept Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMEDCTAdditionalDosageInstructions (preferred)
.... patientInstruction Σ 0..1 string Patient or consumer oriented instructions
.... timing SΣ 0..1 Timing When medication should be administered
.... asNeeded[x] Σ 0..1 Take "as needed" (for x)
Binding: Clinical Finding . (preferred)
..... asNeededBoolean boolean
..... asNeededCodeableConcept CodeableConcept
.... site Σ 0..1 CodeableConcept Body site to administer to
Binding: Body Site . (preferred)
.... route Σ 0..1 CodeableConcept How drug should enter body
Binding: Route of Administration . (preferred)
.... method Σ 0..1 CodeableConcept Technique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (preferred)
.... doseAndRate Σ 0..* Element Amount of medication administered
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ 0..1 CodeableConcept The kind of dose or rate specified
Binding: DoseAndRateType (example): The kind of dose or rate specified.

..... dose[x] Σ 0..1 Amount of medication per dose
...... doseRange Range
...... doseQuantity Quantity(SimpleQuantity)
..... rate[x] Σ 0..1 Amount of medication per unit of time
...... rateRatio Ratio
...... rateRange Range
...... rateQuantity Quantity(SimpleQuantity)
.... maxDosePerPeriod Σ 0..1 Ratio Upper limit on medication per unit of time
.... maxDosePerAdministration Σ 0..1 SimpleQuantity Upper limit on medication per administration
.... maxDosePerLifetime Σ 0..1 SimpleQuantity Upper limit on medication per lifetime of the patient

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationStatement.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
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:pbsrequiredPBSItemCodes
http://terminology.hl7.org.au/ValueSet/pbs-item
MedicationStatement.medication[x]:medicationCodeableConcept.coding:amtrequiredAustralianMedication .
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
MedicationStatement.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
MedicationStatement.reasonCodepreferredMedicationReasonTaken .
https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1
MedicationStatement.dosage.additionalInstructionpreferredSNOMEDCTAdditionalDosageInstructions
http://hl7.org/fhir/ValueSet/additional-instruction-codes
from the FHIR Standard
MedicationStatement.dosage.asNeeded[x]preferredClinicalFinding .
https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1
MedicationStatement.dosage.sitepreferredBodySite .
https://healthterminologies.gov.au/fhir/ValueSet/body-site-1
MedicationStatement.dosage.routepreferredRouteOfAdministration .
https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1
MedicationStatement.dosage.methodpreferredSNOMEDCTAdministrationMethodCodes
http://hl7.org/fhir/ValueSet/administration-method-codes
from the FHIR Standard
MedicationStatement.dosage.doseAndRate.typeexampleDoseAndRateType
http://hl7.org/fhir/ValueSet/dose-rate-type
from the FHIR Standard

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 AUBaseMedicationStatement

Summary

Mandatory: 2 elements
Must-Support: 13 elements

Structures

This structure refers to these other structures:

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

 

Other representations of profile: CSV, Excel, Schematron