AU Patient Summary Implementation Guide
1.0.1-ci-build - CI Build Australia flag

AU Patient Summary Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 1.0.1-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-ps/ and changes regularly. See the Directory of published versions

Resource Profile: AU PS MedicationStatement

Official URL: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-medicationstatement Version: 1.0.1-ci-build
Standards status: Trial-use Maturity Level: 2 Computable Name: AUPSMedicationStatement

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2024+; 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 Core MedicationStatement profile, and applies the additional requirements from MedicationStatement (IPS).

See Comparison With Other National and International IGs for a comparison between AU Patient Summary (AU PS) profiles and profiles in other implementation guides.

Profile Specific Implementation Guidance

  • See the guidance on implementing the MedicationStatement resource in AU Core.
  • Implementers populating MedicationStatement.reasonReference with DiagnosticReport (IPS) are recommended to consider the corresponding AU Base DiagnosticReport profile as guidance for that resource type in an Australian healthcare context.
  • When populating MedicationStatement.medicationCodeableConcept producers SHALL correctly populate MedicationStatement.medicationCodeableConcept.coding with either a code from Australian Medication or PBS Item Codes, or both, if a coded value is known and MAY populate with a code from another code system.
    • Producers MAY populate with only text if no coded value is known.
  • The MedicationStatement resource can represent the clinical indication as a code with MedicationStatement.reasonCode, or a reference with MedicationStatement.reasonReference to a Condition or other resource.
    • Although both are marked as Must Support, producers are not required to support both a code and a reference, but they SHALL support at least one of these elements
    • A consumer SHALL support both elements
  • To represent that a patient is not currently taking any medications, the code SNOMED CT 787481004 |No known medications| is used in MedicationStatement.medicationCodeableConcept:
    • MedicationStatement.status is set to "active"
    • MedicationStatement.effectiveDateTime is the period the statement was true or date/time the statement was current
    • A Medication resource referenced in MedicationStatement.medicationReference SHALL NOT be used
    • Implementers need to be aware than an IPS document conforming to 1.0.0 or 1.1.0 may provide instead the IPS preferred concept "no-known-medications". The IPS concept "no-known-medications" has been removed from later versions of IPS and replaced with SNOMED CT 787481004 |No known medications|. The concept "no-known-medications" SHOULD NOT be used when producing AU PS compliant data, but receiving systems may still encounter it in IPS documents.

The additional obligation on MedicationStatement.effectiveDateTime for AU PS Producer is SHOULD:able-to-populate. This obligation is in addition to the obligation of SHALL:populate-if-known. There is no additional obligation for AU PS Consumer, the obligations of SHALL:handle and SHOULD:display apply.

This additional obligation is present in the underlying structure but due to a tooling limitation is not currently rendered in the Formal Views of Profile Content. See Zulip discussion for more information.

Examples for this Profile: Bundle/aups-basicsummary, Bundle/aups-noknownx, Bundle/aups-referral-endoconsult-autogen and Bundle/aups-referral-endoconsult-curated

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
MedicationStatement 0..* AUCoreMedicationStatement A record of medication being taken by a patient in an Australian healthcare context
This profile also complies with the profile MedicationStatement (IPS)
MedicationStatement.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
MedicationStatement.Slices for extension Content/Rules for all slices
MedicationStatement.Slices for extension.extension:longTerm 0..1 boolean Medication Long Term Indicator
URL: http://hl7.org.au/fhir/StructureDefinition/medication-long-term
MedicationStatement.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
MedicationStatement.status This element is a modifier element. This element has obligations and must be supported. This element is included in summaries. 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.
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.Slices for medication[x] This element has obligations and must be supported. This element is included in summaries. 1..1 Medication Detail
Slice: Unordered, Closed by type:$this
Binding: Australian Medication Use (preferred)
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
MedicationStatement.Slices for medication[x].medicationCodeableConcept CodeableConcept
MedicationStatement.Slices for medication[x].medicationReference Reference(Medication)
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept This element has obligations and must be supported. This element is included in summaries. 0..1 CodeableConceptIPS Coded Medication
Binding: Australian Medication Use (preferred)
Additional BindingsPurpose
Australian Medication Preferred
PBS Item Codes Preferred
MIMS Preferred
GTIN Preferred
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding Content/Rules for all slices
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:pbs This element has obligations and must be supported. This element is included in summaries. 0..* Coding Code defined by a terminology system
Binding: PBS Item Codes (required)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:pbs.Slices for extension Content/Rules for all slices
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:pbs.Slices for extension.extension:medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:amt This element has obligations and must be supported. This element is included in summaries. 0..* Coding Code defined by a terminology system
Binding: Australian Medication (required)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:amt.Slices for extension Content/Rules for all slices
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:amt.Slices for extension.extension:medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
MedicationStatement.Slices for medication[x].medication[x]:medicationReference This element has obligations and must be supported. This element is included in summaries. 0..1 Reference(AU PS Medication) Medication Reference
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.subject This element has obligations and must be supported. This element is included in summaries. 1..1 Reference(AU PS Patient) Who is/was taking the medication
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.subject.reference This element has obligations and must be supported. This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
MedicationStatement.effective[x] This element has obligations and must be supported. This element is included in summaries. 1..1 The date/time or interval when the medication is/was/will be taken
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.effective[x].effectiveDateTime dateTime This target must be supported.
MedicationStatement.effective[x].effectivePeriod Period
MedicationStatement.dateAsserted This element has obligations and must be supported. This element is included in summaries. 0..1 dateTime When the statement was asserted?
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.reasonCode This element has obligations and must be supported. 0..* CodeableConceptIPS Reason for why the medication is being/was taken
Binding: Medication Reason Taken (preferred)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.reasonReference This element has obligations and must be supported. 0..* Reference(AU PS Condition | Observation | DiagnosticReport (IPS)) Condition or observation that supports why the medication is being/was taken
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.dosage This element has obligations and must be supported. 0..* AUBaseDosage The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Details of how medication is/was taken or should be taken
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.dosage.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
MedicationStatement.dosage.text This element has obligations and must be supported. This element is included in summaries. 0..1 string Free text dosage instructions e.g. SIG
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.dosage.timing This element has obligations and must be supported. This element is included in summaries. 0..1 Timing When medication should be administered
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationStatement.​status Base required Medication status codes 📍4.0.1 FHIR Std.
MedicationStatement.​medication[x] Base preferred Australian Medication Use ⏿1.0.0 tx.hl7.org.au
MedicationStatement.​medication[x]:medicationCodeableConcept Base preferred Australian Medication Use ⏿1.0.0 tx.hl7.org.au
MedicationStatement.​medication[x]:medicationCodeableConcept.​coding:pbs Base required PBS Item Codes 📦7.0.0-ci-build AU Base Implementation Guide vnull
MedicationStatement.​medication[x]:medicationCodeableConcept.​coding:amt Base required Australian Medication ⏿1.0.2 tx.hl7.org.au
MedicationStatement.​reasonCode Base preferred Medication Reason Taken ⏿1.1.0 tx.hl7.org.au

Constraints

Id Grade Path(s) Description Expression
dom-2 error MedicationStatement If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationStatement If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MedicationStatement If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MedicationStatement If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationStatement A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from AUCoreMedicationStatement

NameFlagsCard.TypeDescription & Constraints    Filter: doco
MedicationStatement 0..* AUCoreMedicationStatement A record of medication being taken by a patient in an Australian healthcare context
This profile also complies with the profile MedicationStatement (IPS)
MedicationStatement.status This element has obligations. 1..1 code active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.medication[x] This element has obligations. 1..1 CodeableConcept, Reference(Medication) Medication Detail
Binding: Australian Medication Use (preferred)
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.Slices for medication[x] Content/Rules for all slices
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept This element has obligations. 0..1 CodeableConceptIPS Coded Medication
Binding: Australian Medication Use (preferred)
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding Content/Rules for all slices
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:pbs This element has obligations. 0..* Coding Code defined by a terminology system
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:amt This element has obligations. 0..* Coding Code defined by a terminology system
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
MedicationStatement.Slices for medication[x].medication[x]:medicationReference This element has obligations. 0..1 Reference(AU PS Medication) Medication Reference
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.subject.reference This element has obligations and must be supported. 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
MedicationStatement.effective[x] This element has obligations. 1..1 The date/time or interval when the medication is/was/will be taken
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.effective[x].effectiveDateTime dateTime
MedicationStatement.effective[x].effectivePeriod Period
MedicationStatement.dateAsserted This element has obligations. 0..1 dateTime When the statement was asserted?
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.reasonCode This element has obligations. 0..* CodeableConceptIPS Reason for why the medication is being/was taken
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.reasonReference This element has obligations. 0..* Reference(AU PS Condition | Observation | DiagnosticReport (IPS)) Condition or observation that supports why the medication is being/was taken
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.dosage This element has obligations. 0..* AUBaseDosage Details of how medication is/was taken or should be taken
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.dosage.text This element has obligations. 0..1 string Free text dosage instructions e.g. SIG
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.dosage.timing This element has obligations and must be supported. 0..1 Timing When medication should be administered
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
MedicationStatement.​medication[x] Base preferred Australian Medication Use ⏿1.0.0 tx.hl7.org.au
MedicationStatement.​medication[x]:medicationCodeableConcept Base preferred Australian Medication Use ⏿1.0.0 tx.hl7.org.au
NameFlagsCard.TypeDescription & Constraints    Filter: doco
MedicationStatement 0..* AUCoreMedicationStatement A record of medication being taken by a patient in an Australian healthcare context
This profile also complies with the profile MedicationStatement (IPS)
MedicationStatement.id This element is included in summaries. 0..1 id Logical id of this artifact
MedicationStatement.meta This element is included in summaries. 0..1 Meta Metadata about the resource
MedicationStatement.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
MedicationStatement.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
MedicationStatement.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
MedicationStatement.contained 0..* Resource Contained, inline Resources
MedicationStatement.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
MedicationStatement.Slices for extension.extension:longTerm 0..1 boolean Medication Long Term Indicator
URL: http://hl7.org.au/fhir/StructureDefinition/medication-long-term
MedicationStatement.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
MedicationStatement.identifier This element is included in summaries. 0..* Identifier External identifier
MedicationStatement.basedOn This element is included in summaries. 0..* Reference(MedicationRequest | CarePlan | ServiceRequest) Fulfils plan, proposal or order
MedicationStatement.partOf This element is included in summaries. 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) Part of referenced event
MedicationStatement.status This element is a modifier element. This element has obligations and must be supported. This element is included in summaries. 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.
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.statusReason 0..* CodeableConcept Reason for current status
Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement.
MedicationStatement.category This element is included in summaries. 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.
MedicationStatement.Slices for medication[x] This element has obligations and must be supported. This element is included in summaries. 1..1 Medication Detail
Slice: Unordered, Closed by type:$this
Binding: Australian Medication Use (preferred)
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
MedicationStatement.Slices for medication[x].medicationCodeableConcept CodeableConcept
MedicationStatement.Slices for medication[x].medicationReference Reference(Medication)
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept This element has obligations and must be supported. This element is included in summaries. 0..1 CodeableConceptIPS Coded Medication
Binding: Australian Medication Use (preferred)
Additional BindingsPurpose
Australian Medication Preferred
PBS Item Codes Preferred
MIMS Preferred
GTIN Preferred
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.id 0..1 string Unique id for inter-element referencing
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding Content/Rules for all slices
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:pbs This element has obligations and must be supported. This element is included in summaries. 0..* Coding Code defined by a terminology system
Binding: PBS Item Codes (required)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:pbs.id 0..1 string Unique id for inter-element referencing
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:pbs.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:pbs.Slices for extension Content/Rules for all slices
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:pbs.Slices for extension.extension:medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:pbs.system This element is included in summaries. 0..1 uri Identity of the terminology system
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:pbs.version This element is included in summaries. 0..1 string Version of the system - if relevant
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:pbs.code This element is included in summaries. 0..1 code Symbol in syntax defined by the system
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:pbs.display This element is included in summaries. 0..1 string Representation defined by the system
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:pbs.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:amt This element has obligations and must be supported. This element is included in summaries. 0..* Coding Code defined by a terminology system
Binding: Australian Medication (required)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:amt.id 0..1 string Unique id for inter-element referencing
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:amt.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:amt.Slices for extension Content/Rules for all slices
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:amt.Slices for extension.extension:medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:amt.system This element is included in summaries. 0..1 uri Identity of the terminology system
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:amt.version This element is included in summaries. 0..1 string Version of the system - if relevant
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:amt.code This element is included in summaries. 0..1 code Symbol in syntax defined by the system
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:amt.display This element is included in summaries. 0..1 string Representation defined by the system
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:amt.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.text This element is included in summaries. 0..1 string Medication primary text
MedicationStatement.Slices for medication[x].medication[x]:medicationReference This element has obligations and must be supported. This element is included in summaries. 0..1 Reference(AU PS Medication) Medication Reference
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.subject This element has obligations and must be supported. This element is included in summaries. 1..1 Reference(AU PS Patient) Who is/was taking the medication
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.subject.id 0..1 string Unique id for inter-element referencing
MedicationStatement.subject.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
MedicationStatement.subject.reference This element has obligations and must be supported. This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
MedicationStatement.subject.type This element is included in summaries. 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).
MedicationStatement.subject.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
MedicationStatement.subject.display This element is included in summaries. 0..1 string Text alternative for the resource
MedicationStatement.context This element is included in summaries. 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with MedicationStatement
MedicationStatement.effective[x] This element has obligations and must be supported. This element is included in summaries. 1..1 The date/time or interval when the medication is/was/will be taken
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.effective[x].effectiveDateTime dateTime This target must be supported.
MedicationStatement.effective[x].effectivePeriod Period
MedicationStatement.dateAsserted This element has obligations and must be supported. This element is included in summaries. 0..1 dateTime When the statement was asserted?
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.informationSource 0..1 Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) Person or organization that provided the information about the taking of this medication
MedicationStatement.derivedFrom 0..* Reference(Resource) Additional supporting information
MedicationStatement.reasonCode This element has obligations and must be supported. 0..* CodeableConceptIPS Reason for why the medication is being/was taken
Binding: Medication Reason Taken (preferred)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.reasonReference This element has obligations and must be supported. 0..* Reference(AU PS Condition | Observation | DiagnosticReport (IPS)) Condition or observation that supports why the medication is being/was taken
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.note 0..* Annotation Further information about the statement
MedicationStatement.dosage This element has obligations and must be supported. 0..* AUBaseDosage The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Details of how medication is/was taken or should be taken
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.dosage.id 0..1 string Unique id for inter-element referencing
MedicationStatement.dosage.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
MedicationStatement.dosage.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
MedicationStatement.dosage.sequence This element is included in summaries. 0..1 integer The order of the dosage instructions
MedicationStatement.dosage.text This element has obligations and must be supported. This element is included in summaries. 0..1 string Free text dosage instructions e.g. SIG
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.dosage.additionalInstruction This element is included in summaries. 0..* CodeableConcept Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMEDCTAdditionalDosageInstructions (preferred)
MedicationStatement.dosage.patientInstruction This element is included in summaries. 0..1 string Patient or consumer oriented instructions
MedicationStatement.dosage.timing This element has obligations and must be supported. This element is included in summaries. 0..1 Timing When medication should be administered
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.dosage.asNeeded[x] This element is included in summaries. 0..1 Take "as needed" (for x)
Binding: Clinical Finding (preferred)
MedicationStatement.dosage.asNeeded[x].asNeededBoolean boolean
MedicationStatement.dosage.asNeeded[x].asNeededCodeableConcept CodeableConcept
MedicationStatement.dosage.site This element is included in summaries. 0..1 CodeableConcept Body site to administer to
Binding: Body Site (preferred)
MedicationStatement.dosage.route This element is included in summaries. 0..1 CodeableConcept How drug should enter body
Binding: Route of Administration (preferred)
MedicationStatement.dosage.method This element is included in summaries. 0..1 CodeableConcept Technique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (preferred)
MedicationStatement.dosage.doseAndRate This element is included in summaries. 0..* Element Amount of medication administered
MedicationStatement.dosage.doseAndRate.id 0..1 string Unique id for inter-element referencing
MedicationStatement.dosage.doseAndRate.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
MedicationStatement.dosage.doseAndRate.type This element is included in summaries. 0..1 CodeableConcept The kind of dose or rate specified
Binding: DoseAndRateType (example): The kind of dose or rate specified.
MedicationStatement.dosage.doseAndRate.dose[x] This element is included in summaries. 0..1 Amount of medication per dose
MedicationStatement.dosage.doseAndRate.dose[x].doseRange Range
MedicationStatement.dosage.doseAndRate.dose[x].doseQuantity Quantity(SimpleQuantity)
MedicationStatement.dosage.doseAndRate.rate[x] This element is included in summaries. 0..1 Amount of medication per unit of time
MedicationStatement.dosage.doseAndRate.rate[x].rateRatio Ratio
MedicationStatement.dosage.doseAndRate.rate[x].rateRange Range
MedicationStatement.dosage.doseAndRate.rate[x].rateQuantity Quantity(SimpleQuantity)
MedicationStatement.dosage.maxDosePerPeriod This element is included in summaries. 0..1 Ratio Upper limit on medication per unit of time
MedicationStatement.dosage.maxDosePerAdministration This element is included in summaries. C 0..1 SimpleQuantity(4.0.1) Upper limit on medication per administration
Constraints: sqty-1
MedicationStatement.dosage.maxDosePerLifetime This element is included in summaries. C 0..1 SimpleQuantity(4.0.1) Upper limit on medication per lifetime of the patient
Constraints: sqty-1

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationStatement.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
MedicationStatement.​status Base required Medication status codes 📍4.0.1 FHIR Std.
MedicationStatement.​statusReason Base example SNOMED CT Drug Therapy Status codes 📍4.0.1 FHIR Std.
MedicationStatement.​category Base preferred Medication usage category codes 📍4.0.1 FHIR Std.
MedicationStatement.​medication[x] Base preferred Australian Medication Use ⏿1.0.0 tx.hl7.org.au
MedicationStatement.​medication[x]:medicationCodeableConcept Base preferred Australian Medication Use ⏿1.0.0 tx.hl7.org.au
MedicationStatement.​medication[x]:medicationCodeableConcept.​coding:pbs Base required PBS Item Codes 📦7.0.0-ci-build AU Base Implementation Guide vnull
MedicationStatement.​medication[x]:medicationCodeableConcept.​coding:amt Base required Australian Medication ⏿1.0.2 tx.hl7.org.au
MedicationStatement.​subject.type Base extensible ResourceType 📍4.0.1 FHIR Std.
MedicationStatement.​reasonCode Base preferred Medication Reason Taken ⏿1.1.0 tx.hl7.org.au
MedicationStatement.​dosage.additionalInstruction Base preferred SNOMED CT Additional Dosage Instructions 📦4.0.1 FHIR Std.
MedicationStatement.​dosage.asNeeded[x] Base preferred Clinical Finding ⏿1.0.2 tx.hl7.org.au
MedicationStatement.​dosage.site Base preferred Body Site ⏿1.0.2 tx.hl7.org.au
MedicationStatement.​dosage.route Base preferred Route of Administration ⏿1.0.2 tx.hl7.org.au
MedicationStatement.​dosage.method Base preferred SNOMED CT Administration Method Codes 📦4.0.1 FHIR Std.
MedicationStatement.​dosage.doseAndRate.type Base example DoseAndRateType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error MedicationStatement If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationStatement If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MedicationStatement If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MedicationStatement If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationStatement A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
sqty-1 error MedicationStatement.dosage.maxDosePerAdministration, MedicationStatement.dosage.maxDosePerLifetime The comparator is not used on a SimpleQuantity comparator.empty()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
MedicationStatement 0..* AUCoreMedicationStatement A record of medication being taken by a patient in an Australian healthcare context
This profile also complies with the profile MedicationStatement (IPS)
MedicationStatement.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
MedicationStatement.Slices for extension Content/Rules for all slices
MedicationStatement.Slices for extension.extension:longTerm 0..1 boolean Medication Long Term Indicator
URL: http://hl7.org.au/fhir/StructureDefinition/medication-long-term
MedicationStatement.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
MedicationStatement.status This element is a modifier element. This element has obligations and must be supported. This element is included in summaries. 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.
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.Slices for medication[x] This element has obligations and must be supported. This element is included in summaries. 1..1 Medication Detail
Slice: Unordered, Closed by type:$this
Binding: Australian Medication Use (preferred)
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
MedicationStatement.Slices for medication[x].medicationCodeableConcept CodeableConcept
MedicationStatement.Slices for medication[x].medicationReference Reference(Medication)
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept This element has obligations and must be supported. This element is included in summaries. 0..1 CodeableConceptIPS Coded Medication
Binding: Australian Medication Use (preferred)
Additional BindingsPurpose
Australian Medication Preferred
PBS Item Codes Preferred
MIMS Preferred
GTIN Preferred
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding Content/Rules for all slices
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:pbs This element has obligations and must be supported. This element is included in summaries. 0..* Coding Code defined by a terminology system
Binding: PBS Item Codes (required)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:pbs.Slices for extension Content/Rules for all slices
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:pbs.Slices for extension.extension:medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:amt This element has obligations and must be supported. This element is included in summaries. 0..* Coding Code defined by a terminology system
Binding: Australian Medication (required)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:amt.Slices for extension Content/Rules for all slices
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:amt.Slices for extension.extension:medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
MedicationStatement.Slices for medication[x].medication[x]:medicationReference This element has obligations and must be supported. This element is included in summaries. 0..1 Reference(AU PS Medication) Medication Reference
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.subject This element has obligations and must be supported. This element is included in summaries. 1..1 Reference(AU PS Patient) Who is/was taking the medication
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.subject.reference This element has obligations and must be supported. This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
MedicationStatement.effective[x] This element has obligations and must be supported. This element is included in summaries. 1..1 The date/time or interval when the medication is/was/will be taken
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.effective[x].effectiveDateTime dateTime This target must be supported.
MedicationStatement.effective[x].effectivePeriod Period
MedicationStatement.dateAsserted This element has obligations and must be supported. This element is included in summaries. 0..1 dateTime When the statement was asserted?
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.reasonCode This element has obligations and must be supported. 0..* CodeableConceptIPS Reason for why the medication is being/was taken
Binding: Medication Reason Taken (preferred)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.reasonReference This element has obligations and must be supported. 0..* Reference(AU PS Condition | Observation | DiagnosticReport (IPS)) Condition or observation that supports why the medication is being/was taken
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.dosage This element has obligations and must be supported. 0..* AUBaseDosage The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Details of how medication is/was taken or should be taken
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.dosage.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
MedicationStatement.dosage.text This element has obligations and must be supported. This element is included in summaries. 0..1 string Free text dosage instructions e.g. SIG
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.dosage.timing This element has obligations and must be supported. This element is included in summaries. 0..1 Timing When medication should be administered
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationStatement.​status Base required Medication status codes 📍4.0.1 FHIR Std.
MedicationStatement.​medication[x] Base preferred Australian Medication Use ⏿1.0.0 tx.hl7.org.au
MedicationStatement.​medication[x]:medicationCodeableConcept Base preferred Australian Medication Use ⏿1.0.0 tx.hl7.org.au
MedicationStatement.​medication[x]:medicationCodeableConcept.​coding:pbs Base required PBS Item Codes 📦7.0.0-ci-build AU Base Implementation Guide vnull
MedicationStatement.​medication[x]:medicationCodeableConcept.​coding:amt Base required Australian Medication ⏿1.0.2 tx.hl7.org.au
MedicationStatement.​reasonCode Base preferred Medication Reason Taken ⏿1.1.0 tx.hl7.org.au

Constraints

Id Grade Path(s) Description Expression
dom-2 error MedicationStatement If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationStatement If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MedicationStatement If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MedicationStatement If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationStatement A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from AUCoreMedicationStatement

NameFlagsCard.TypeDescription & Constraints    Filter: doco
MedicationStatement 0..* AUCoreMedicationStatement A record of medication being taken by a patient in an Australian healthcare context
This profile also complies with the profile MedicationStatement (IPS)
MedicationStatement.status This element has obligations. 1..1 code active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.medication[x] This element has obligations. 1..1 CodeableConcept, Reference(Medication) Medication Detail
Binding: Australian Medication Use (preferred)
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.Slices for medication[x] Content/Rules for all slices
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept This element has obligations. 0..1 CodeableConceptIPS Coded Medication
Binding: Australian Medication Use (preferred)
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding Content/Rules for all slices
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:pbs This element has obligations. 0..* Coding Code defined by a terminology system
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:amt This element has obligations. 0..* Coding Code defined by a terminology system
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
MedicationStatement.Slices for medication[x].medication[x]:medicationReference This element has obligations. 0..1 Reference(AU PS Medication) Medication Reference
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.subject This element has obligations. 1..1 Reference(AU PS Patient) Who is/was taking the medication
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.subject.reference This element has obligations and must be supported. 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
MedicationStatement.effective[x] This element has obligations. 1..1 The date/time or interval when the medication is/was/will be taken
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.effective[x].effectiveDateTime dateTime
MedicationStatement.effective[x].effectivePeriod Period
MedicationStatement.dateAsserted This element has obligations. 0..1 dateTime When the statement was asserted?
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.reasonCode This element has obligations. 0..* CodeableConceptIPS Reason for why the medication is being/was taken
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.reasonReference This element has obligations. 0..* Reference(AU PS Condition | Observation | DiagnosticReport (IPS)) Condition or observation that supports why the medication is being/was taken
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.dosage This element has obligations. 0..* AUBaseDosage Details of how medication is/was taken or should be taken
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.dosage.text This element has obligations. 0..1 string Free text dosage instructions e.g. SIG
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.dosage.timing This element has obligations and must be supported. 0..1 Timing When medication should be administered
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
MedicationStatement.​medication[x] Base preferred Australian Medication Use ⏿1.0.0 tx.hl7.org.au
MedicationStatement.​medication[x]:medicationCodeableConcept Base preferred Australian Medication Use ⏿1.0.0 tx.hl7.org.au

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
MedicationStatement 0..* AUCoreMedicationStatement A record of medication being taken by a patient in an Australian healthcare context
This profile also complies with the profile MedicationStatement (IPS)
MedicationStatement.id This element is included in summaries. 0..1 id Logical id of this artifact
MedicationStatement.meta This element is included in summaries. 0..1 Meta Metadata about the resource
MedicationStatement.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
MedicationStatement.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
MedicationStatement.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
MedicationStatement.contained 0..* Resource Contained, inline Resources
MedicationStatement.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
MedicationStatement.Slices for extension.extension:longTerm 0..1 boolean Medication Long Term Indicator
URL: http://hl7.org.au/fhir/StructureDefinition/medication-long-term
MedicationStatement.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
MedicationStatement.identifier This element is included in summaries. 0..* Identifier External identifier
MedicationStatement.basedOn This element is included in summaries. 0..* Reference(MedicationRequest | CarePlan | ServiceRequest) Fulfils plan, proposal or order
MedicationStatement.partOf This element is included in summaries. 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) Part of referenced event
MedicationStatement.status This element is a modifier element. This element has obligations and must be supported. This element is included in summaries. 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.
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.statusReason 0..* CodeableConcept Reason for current status
Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement.
MedicationStatement.category This element is included in summaries. 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.
MedicationStatement.Slices for medication[x] This element has obligations and must be supported. This element is included in summaries. 1..1 Medication Detail
Slice: Unordered, Closed by type:$this
Binding: Australian Medication Use (preferred)
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
MedicationStatement.Slices for medication[x].medicationCodeableConcept CodeableConcept
MedicationStatement.Slices for medication[x].medicationReference Reference(Medication)
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept This element has obligations and must be supported. This element is included in summaries. 0..1 CodeableConceptIPS Coded Medication
Binding: Australian Medication Use (preferred)
Additional BindingsPurpose
Australian Medication Preferred
PBS Item Codes Preferred
MIMS Preferred
GTIN Preferred
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.id 0..1 string Unique id for inter-element referencing
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding Content/Rules for all slices
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:pbs This element has obligations and must be supported. This element is included in summaries. 0..* Coding Code defined by a terminology system
Binding: PBS Item Codes (required)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:pbs.id 0..1 string Unique id for inter-element referencing
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:pbs.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:pbs.Slices for extension Content/Rules for all slices
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:pbs.Slices for extension.extension:medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:pbs.system This element is included in summaries. 0..1 uri Identity of the terminology system
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:pbs.version This element is included in summaries. 0..1 string Version of the system - if relevant
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:pbs.code This element is included in summaries. 0..1 code Symbol in syntax defined by the system
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:pbs.display This element is included in summaries. 0..1 string Representation defined by the system
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:pbs.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:amt This element has obligations and must be supported. This element is included in summaries. 0..* Coding Code defined by a terminology system
Binding: Australian Medication (required)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:amt.id 0..1 string Unique id for inter-element referencing
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:amt.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:amt.Slices for extension Content/Rules for all slices
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:amt.Slices for extension.extension:medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:amt.system This element is included in summaries. 0..1 uri Identity of the terminology system
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:amt.version This element is included in summaries. 0..1 string Version of the system - if relevant
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:amt.code This element is included in summaries. 0..1 code Symbol in syntax defined by the system
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:amt.display This element is included in summaries. 0..1 string Representation defined by the system
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.Slices for coding.coding:amt.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
MedicationStatement.Slices for medication[x].medication[x]:medicationCodeableConcept.text This element is included in summaries. 0..1 string Medication primary text
MedicationStatement.Slices for medication[x].medication[x]:medicationReference This element has obligations and must be supported. This element is included in summaries. 0..1 Reference(AU PS Medication) Medication Reference
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.subject This element has obligations and must be supported. This element is included in summaries. 1..1 Reference(AU PS Patient) Who is/was taking the medication
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.subject.id 0..1 string Unique id for inter-element referencing
MedicationStatement.subject.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
MedicationStatement.subject.reference This element has obligations and must be supported. This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActor
SHALL:populate AU PS Producer
SHALL:handle AU PS Consumer
MedicationStatement.subject.type This element is included in summaries. 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).
MedicationStatement.subject.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
MedicationStatement.subject.display This element is included in summaries. 0..1 string Text alternative for the resource
MedicationStatement.context This element is included in summaries. 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with MedicationStatement
MedicationStatement.effective[x] This element has obligations and must be supported. This element is included in summaries. 1..1 The date/time or interval when the medication is/was/will be taken
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.effective[x].effectiveDateTime dateTime This target must be supported.
MedicationStatement.effective[x].effectivePeriod Period
MedicationStatement.dateAsserted This element has obligations and must be supported. This element is included in summaries. 0..1 dateTime When the statement was asserted?
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.informationSource 0..1 Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) Person or organization that provided the information about the taking of this medication
MedicationStatement.derivedFrom 0..* Reference(Resource) Additional supporting information
MedicationStatement.reasonCode This element has obligations and must be supported. 0..* CodeableConceptIPS Reason for why the medication is being/was taken
Binding: Medication Reason Taken (preferred)
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.reasonReference This element has obligations and must be supported. 0..* Reference(AU PS Condition | Observation | DiagnosticReport (IPS)) Condition or observation that supports why the medication is being/was taken
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.note 0..* Annotation Further information about the statement
MedicationStatement.dosage This element has obligations and must be supported. 0..* AUBaseDosage The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Details of how medication is/was taken or should be taken
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.dosage.id 0..1 string Unique id for inter-element referencing
MedicationStatement.dosage.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
MedicationStatement.dosage.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
MedicationStatement.dosage.sequence This element is included in summaries. 0..1 integer The order of the dosage instructions
MedicationStatement.dosage.text This element has obligations and must be supported. This element is included in summaries. 0..1 string Free text dosage instructions e.g. SIG
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.dosage.additionalInstruction This element is included in summaries. 0..* CodeableConcept Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMEDCTAdditionalDosageInstructions (preferred)
MedicationStatement.dosage.patientInstruction This element is included in summaries. 0..1 string Patient or consumer oriented instructions
MedicationStatement.dosage.timing This element has obligations and must be supported. This element is included in summaries. 0..1 Timing When medication should be administered
ObligationsActor
SHALL:populate-if-known AU PS Producer
SHALL:handle AU PS Consumer
SHOULD:display AU PS Consumer
MedicationStatement.dosage.asNeeded[x] This element is included in summaries. 0..1 Take "as needed" (for x)
Binding: Clinical Finding (preferred)
MedicationStatement.dosage.asNeeded[x].asNeededBoolean boolean
MedicationStatement.dosage.asNeeded[x].asNeededCodeableConcept CodeableConcept
MedicationStatement.dosage.site This element is included in summaries. 0..1 CodeableConcept Body site to administer to
Binding: Body Site (preferred)
MedicationStatement.dosage.route This element is included in summaries. 0..1 CodeableConcept How drug should enter body
Binding: Route of Administration (preferred)
MedicationStatement.dosage.method This element is included in summaries. 0..1 CodeableConcept Technique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (preferred)
MedicationStatement.dosage.doseAndRate This element is included in summaries. 0..* Element Amount of medication administered
MedicationStatement.dosage.doseAndRate.id 0..1 string Unique id for inter-element referencing
MedicationStatement.dosage.doseAndRate.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
MedicationStatement.dosage.doseAndRate.type This element is included in summaries. 0..1 CodeableConcept The kind of dose or rate specified
Binding: DoseAndRateType (example): The kind of dose or rate specified.
MedicationStatement.dosage.doseAndRate.dose[x] This element is included in summaries. 0..1 Amount of medication per dose
MedicationStatement.dosage.doseAndRate.dose[x].doseRange Range
MedicationStatement.dosage.doseAndRate.dose[x].doseQuantity Quantity(SimpleQuantity)
MedicationStatement.dosage.doseAndRate.rate[x] This element is included in summaries. 0..1 Amount of medication per unit of time
MedicationStatement.dosage.doseAndRate.rate[x].rateRatio Ratio
MedicationStatement.dosage.doseAndRate.rate[x].rateRange Range
MedicationStatement.dosage.doseAndRate.rate[x].rateQuantity Quantity(SimpleQuantity)
MedicationStatement.dosage.maxDosePerPeriod This element is included in summaries. 0..1 Ratio Upper limit on medication per unit of time
MedicationStatement.dosage.maxDosePerAdministration This element is included in summaries. C 0..1 SimpleQuantity(4.0.1) Upper limit on medication per administration
Constraints: sqty-1
MedicationStatement.dosage.maxDosePerLifetime This element is included in summaries. C 0..1 SimpleQuantity(4.0.1) Upper limit on medication per lifetime of the patient
Constraints: sqty-1

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationStatement.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
MedicationStatement.​status Base required Medication status codes 📍4.0.1 FHIR Std.
MedicationStatement.​statusReason Base example SNOMED CT Drug Therapy Status codes 📍4.0.1 FHIR Std.
MedicationStatement.​category Base preferred Medication usage category codes 📍4.0.1 FHIR Std.
MedicationStatement.​medication[x] Base preferred Australian Medication Use ⏿1.0.0 tx.hl7.org.au
MedicationStatement.​medication[x]:medicationCodeableConcept Base preferred Australian Medication Use ⏿1.0.0 tx.hl7.org.au
MedicationStatement.​medication[x]:medicationCodeableConcept.​coding:pbs Base required PBS Item Codes 📦7.0.0-ci-build AU Base Implementation Guide vnull
MedicationStatement.​medication[x]:medicationCodeableConcept.​coding:amt Base required Australian Medication ⏿1.0.2 tx.hl7.org.au
MedicationStatement.​subject.type Base extensible ResourceType 📍4.0.1 FHIR Std.
MedicationStatement.​reasonCode Base preferred Medication Reason Taken ⏿1.1.0 tx.hl7.org.au
MedicationStatement.​dosage.additionalInstruction Base preferred SNOMED CT Additional Dosage Instructions 📦4.0.1 FHIR Std.
MedicationStatement.​dosage.asNeeded[x] Base preferred Clinical Finding ⏿1.0.2 tx.hl7.org.au
MedicationStatement.​dosage.site Base preferred Body Site ⏿1.0.2 tx.hl7.org.au
MedicationStatement.​dosage.route Base preferred Route of Administration ⏿1.0.2 tx.hl7.org.au
MedicationStatement.​dosage.method Base preferred SNOMED CT Administration Method Codes 📦4.0.1 FHIR Std.
MedicationStatement.​dosage.doseAndRate.type Base example DoseAndRateType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error MedicationStatement If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MedicationStatement If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MedicationStatement If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MedicationStatement If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MedicationStatement A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
sqty-1 error MedicationStatement.dosage.maxDosePerAdministration, MedicationStatement.dosage.maxDosePerLifetime The comparator is not used on a SimpleQuantity comparator.empty()

 

Other representations of profile: CSV, Excel, Schematron