AU Core Implementation Guide
1.1.0-ci-build - CI Build
AU Core Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 1.1.0-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-core/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-medicationstatement | Version: 1.1.0-ci-build | |||
Standards status: Trial-use | Maturity Level: 0 | Computable Name: AUCoreMedicationStatement | ||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved. |
This profile sets minimum expectations for a MedicationStatement resource to record, search, and fetch summary statements of medication use associated with a patient. It is based on the AU Base Medication Statement profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the MedicationStatement when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.
See Comparison with other national and international IGs for a comparison between AU Core profiles and profiles in other implementation guides.
The following are supported usage scenarios for this profile:
MedicationStatement.medicationCodeableConcept
, or reference a Medication resource with MedicationStatement.medicationReference
.
_include
parameter for searching this elementMedicationStatement.reasonCode
, or a reference with MedicationStatement.reasonReference
to a Condition or other resource.
Usage:
Changes since version 1.0.0:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUBaseMedicationStatement
Name | Flags | Card. | Type | Description & Constraints![]() | ||||||
---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | AUBaseMedicationStatement | A record of medication being taken by a patient in an Australian healthcare context | |||||||
![]() ![]() ![]() |
SO | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken
| ||||||
![]() ![]() ![]() |
SO | 1..1 | CodeableConcept, Reference(Medication) | Medication Detail Slice: Unordered, Closed by type:$this
| ||||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Coded Medication | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
SO | 0..* | Coding | Code defined by a terminology system Binding: PBS Item Codes (required)
| ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
SO | 0..* | Coding | Code defined by a terminology system Binding: Australian Medication ![]()
| ||||||
![]() ![]() ![]() ![]() |
O | 0..1 | Reference(AU Core Medication) | Medication Reference
| ||||||
![]() ![]() ![]() |
SO | 1..1 | Reference(AU Core Patient) | Who is/was taking the medication
| ||||||
![]() ![]() ![]() |
SO | 0..1 | dateTime, Period | The date/time or interval when the medication is/was/will be taken
| ||||||
![]() ![]() ![]() |
SO | 0..1 | dateTime | When the statement was asserted?
| ||||||
![]() ![]() ![]() |
SO | 0..* | CodeableConcept | Reason for why the medication is being/was taken
| ||||||
![]() ![]() ![]() |
SO | 0..* | Reference(AU Core Condition | Observation | AU Base Diagnostic Report) | Condition or observation that supports why the medication is being/was taken
| ||||||
![]() ![]() ![]() |
SO | 0..* | AUBaseDosage | Details of how medication is/was taken or should be taken
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | string | Free text dosage instructions e.g. SIG
| ||||||
![]() |
Path | Conformance | ValueSet | URI |
MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbs | required | PBSItemCodeshttp://terminology.hl7.org.au/ValueSet/pbs-item | |
MedicationStatement.medication[x]:medicationCodeableConcept.coding:amt | required | AustralianMedication ![]() https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | AUBaseMedicationStatement | A record of medication being taken by a patient in an Australian healthcare context 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 | |||||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||
![]() ![]() ![]() ![]() |
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 | |||||||||||
![]() ![]() ![]() |
?! | 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 | ||||||||||
![]() ![]() ![]() |
?!SOΣ | 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. ele-1: All FHIR elements must have a @value or children
| ||||||||||
![]() ![]() ![]() |
SOΣ | 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
| |||||||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||||||||
![]() ![]() ![]() ![]() |
Reference(Medication) | |||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Coded Medication Binding: SNOMEDCTMedicationCodes (example)
ele-1: All FHIR elements must have a @value or children | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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 | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
SOΣ | 0..* | Coding | Code defined by a terminology system Binding: PBS Item Codes (required) ele-1: All FHIR elements must have a @value or children
| ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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 | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
SOΣ | 0..* | Coding | Code defined by a terminology system Binding: Australian Medication ![]() ele-1: All FHIR elements must have a @value or children
| ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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 | |||||||||||
![]() ![]() ![]() ![]() |
OΣ | 0..1 | Reference(AU Core Medication) | Medication Reference ele-1: All FHIR elements must have a @value or children
| ||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | Reference(AU Core Patient) | Who is/was taking the medication ele-1: All FHIR elements must have a @value or children
| ||||||||||
![]() ![]() ![]() |
SOΣ | 0..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
| |||||||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||||||||
![]() ![]() ![]() ![]() |
Period | |||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | dateTime | When the statement was asserted? ele-1: All FHIR elements must have a @value or children
| ||||||||||
![]() ![]() ![]() |
SO | 0..* | CodeableConcept | Reason for why the medication is being/was taken Binding: Medication Reason Taken ![]() ele-1: All FHIR elements must have a @value or children
| ||||||||||
![]() ![]() ![]() |
SO | 0..* | Reference(AU Core 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
| ||||||||||
![]() ![]() ![]() |
SO | 0..* | AUBaseDosage | Details of how medication is/was taken or should be taken ele-1: All FHIR elements must have a @value or children
| ||||||||||
![]() ![]() ![]() ![]() |
?!Σ | 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 | ||||||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | Free text dosage instructions e.g. SIG ele-1: All FHIR elements must have a @value or children
| ||||||||||
![]() |
Path | Conformance | ValueSet | URI |
MedicationStatement.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1 from the FHIR Standard | |
MedicationStatement.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | |
MedicationStatement.medication[x]:medicationCodeableConcept | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | |
MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbs | required | PBSItemCodeshttp://terminology.hl7.org.au/ValueSet/pbs-item | |
MedicationStatement.medication[x]:medicationCodeableConcept.coding:amt | required | AustralianMedication ![]() https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 | |
MedicationStatement.reasonCode | preferred | MedicationReasonTaken ![]() https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1 |
Id | Grade | Path(s) | Details | Requirements |
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() |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | AUBaseMedicationStatement | A record of medication being taken by a patient in an Australian healthcare context | |||||||||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||||||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||||||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Medication Long Term Indicator URL: http://hl7.org.au/fhir/StructureDefinition/medication-long-term | |||||||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | External identifier | ||||||||||
![]() ![]() ![]() |
Σ | 0..* | Reference(MedicationRequest | CarePlan | ServiceRequest) | Fulfils plan, proposal or order | ||||||||||
![]() ![]() ![]() |
Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) | Part of referenced event | ||||||||||
![]() ![]() ![]() |
?!SOΣ | 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.
| ||||||||||
![]() ![]() ![]() |
0..* | CodeableConcept | Reason for current status Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement. | |||||||||||
![]() ![]() ![]() |
Σ | 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. | ||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | Medication Detail Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.
| |||||||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||||||||
![]() ![]() ![]() ![]() |
Reference(Medication) | |||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Coded Medication Binding: SNOMEDCTMedicationCodes (example)
| ||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
SOΣ | 0..* | Coding | Code defined by a terminology system Binding: PBS Item Codes (required)
| ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
SOΣ | 0..* | Coding | Code defined by a terminology system Binding: Australian Medication ![]()
| ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Medication primary text | ||||||||||
![]() ![]() ![]() ![]() |
OΣ | 0..1 | Reference(AU Core Medication) | Medication Reference
| ||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | Reference(AU Core Patient) | Who is/was taking the medication
| ||||||||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with MedicationStatement | ||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | The date/time or interval when the medication is/was/will be taken
| |||||||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||||||||
![]() ![]() ![]() ![]() |
Period | |||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | dateTime | When the statement was asserted?
| ||||||||||
![]() ![]() ![]() |
0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | Person or organization that provided the information about the taking of this medication | |||||||||||
![]() ![]() ![]() |
0..* | Reference(Resource) | Additional supporting information | |||||||||||
![]() ![]() ![]() |
SO | 0..* | CodeableConcept | Reason for why the medication is being/was taken Binding: Medication Reason Taken ![]()
| ||||||||||
![]() ![]() ![]() |
SO | 0..* | Reference(AU Core Condition | Observation | AU Base Diagnostic Report) | Condition or observation that supports why the medication is being/was taken
| ||||||||||
![]() ![]() ![]() |
0..* | Annotation | Further information about the statement | |||||||||||
![]() ![]() ![]() |
SO | 0..* | AUBaseDosage | Details of how medication is/was taken or should be taken
| ||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | integer | The order of the dosage instructions | ||||||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | Free text dosage instructions e.g. SIG
| ||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (preferred) | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Patient or consumer oriented instructions | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Timing | When medication should be administered | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Take "as needed" (for x) Binding: Clinical Finding ![]() | |||||||||||
![]() ![]() ![]() ![]() ![]() |
boolean | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Body site to administer to Binding: Body Site ![]() | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | How drug should enter body Binding: Route of Administration ![]() | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (preferred) | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Element | Amount of medication administered | ||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified. | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Amount of medication per dose | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Range | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Quantity(SimpleQuantity) | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Amount of medication per unit of time | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Ratio | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Range | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Quantity(SimpleQuantity) | |||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Ratio | Upper limit on medication per unit of time | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | SimpleQuantity | Upper limit on medication per administration | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | SimpleQuantity | Upper limit on medication per lifetime of the patient | ||||||||||
![]() |
Path | Conformance | ValueSet | URI | |||
MedicationStatement.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
MedicationStatement.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1 from the FHIR Standard | ||||
MedicationStatement.statusReason | example | SNOMEDCTDrugTherapyStatusCodeshttp://hl7.org/fhir/ValueSet/reason-medication-status-codes from the FHIR Standard | ||||
MedicationStatement.category | preferred | Medication usage category codeshttp://hl7.org/fhir/ValueSet/medication-statement-category from the FHIR Standard | ||||
MedicationStatement.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | ||||
MedicationStatement.medication[x]:medicationCodeableConcept | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | ||||
MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbs | required | PBSItemCodeshttp://terminology.hl7.org.au/ValueSet/pbs-item | ||||
MedicationStatement.medication[x]:medicationCodeableConcept.coding:amt | required | AustralianMedication ![]() https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 | ||||
MedicationStatement.reasonCode | preferred | MedicationReasonTaken ![]() https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1 | ||||
MedicationStatement.dosage.additionalInstruction | preferred | SNOMEDCTAdditionalDosageInstructionshttp://hl7.org/fhir/ValueSet/additional-instruction-codes from the FHIR Standard | ||||
MedicationStatement.dosage.asNeeded[x] | preferred | ClinicalFinding ![]() https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 | ||||
MedicationStatement.dosage.site | preferred | BodySite ![]() https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 | ||||
MedicationStatement.dosage.route | preferred | RouteOfAdministration ![]() https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 | ||||
MedicationStatement.dosage.method | preferred | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codes from the FHIR Standard | ||||
MedicationStatement.dosage.doseAndRate.type | example | DoseAndRateTypehttp://hl7.org/fhir/ValueSet/dose-rate-type from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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 AUBaseMedicationStatement
Summary
Mandatory: 1 element
Must-Support: 11 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 0
Differential View
This structure is derived from AUBaseMedicationStatement
Name | Flags | Card. | Type | Description & Constraints![]() | ||||||
---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | AUBaseMedicationStatement | A record of medication being taken by a patient in an Australian healthcare context | |||||||
![]() ![]() ![]() |
SO | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken
| ||||||
![]() ![]() ![]() |
SO | 1..1 | CodeableConcept, Reference(Medication) | Medication Detail Slice: Unordered, Closed by type:$this
| ||||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Coded Medication | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
SO | 0..* | Coding | Code defined by a terminology system Binding: PBS Item Codes (required)
| ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
SO | 0..* | Coding | Code defined by a terminology system Binding: Australian Medication ![]()
| ||||||
![]() ![]() ![]() ![]() |
O | 0..1 | Reference(AU Core Medication) | Medication Reference
| ||||||
![]() ![]() ![]() |
SO | 1..1 | Reference(AU Core Patient) | Who is/was taking the medication
| ||||||
![]() ![]() ![]() |
SO | 0..1 | dateTime, Period | The date/time or interval when the medication is/was/will be taken
| ||||||
![]() ![]() ![]() |
SO | 0..1 | dateTime | When the statement was asserted?
| ||||||
![]() ![]() ![]() |
SO | 0..* | CodeableConcept | Reason for why the medication is being/was taken
| ||||||
![]() ![]() ![]() |
SO | 0..* | Reference(AU Core Condition | Observation | AU Base Diagnostic Report) | Condition or observation that supports why the medication is being/was taken
| ||||||
![]() ![]() ![]() |
SO | 0..* | AUBaseDosage | Details of how medication is/was taken or should be taken
| ||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | string | Free text dosage instructions e.g. SIG
| ||||||
![]() |
Path | Conformance | ValueSet | URI |
MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbs | required | PBSItemCodeshttp://terminology.hl7.org.au/ValueSet/pbs-item | |
MedicationStatement.medication[x]:medicationCodeableConcept.coding:amt | required | AustralianMedication ![]() https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | AUBaseMedicationStatement | A record of medication being taken by a patient in an Australian healthcare context 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 | |||||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||
![]() ![]() ![]() ![]() |
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 | |||||||||||
![]() ![]() ![]() |
?! | 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 | ||||||||||
![]() ![]() ![]() |
?!SOΣ | 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. ele-1: All FHIR elements must have a @value or children
| ||||||||||
![]() ![]() ![]() |
SOΣ | 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
| |||||||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||||||||
![]() ![]() ![]() ![]() |
Reference(Medication) | |||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Coded Medication Binding: SNOMEDCTMedicationCodes (example)
ele-1: All FHIR elements must have a @value or children | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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 | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
SOΣ | 0..* | Coding | Code defined by a terminology system Binding: PBS Item Codes (required) ele-1: All FHIR elements must have a @value or children
| ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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 | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
SOΣ | 0..* | Coding | Code defined by a terminology system Binding: Australian Medication ![]() ele-1: All FHIR elements must have a @value or children
| ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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 | |||||||||||
![]() ![]() ![]() ![]() |
OΣ | 0..1 | Reference(AU Core Medication) | Medication Reference ele-1: All FHIR elements must have a @value or children
| ||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | Reference(AU Core Patient) | Who is/was taking the medication ele-1: All FHIR elements must have a @value or children
| ||||||||||
![]() ![]() ![]() |
SOΣ | 0..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
| |||||||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||||||||
![]() ![]() ![]() ![]() |
Period | |||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | dateTime | When the statement was asserted? ele-1: All FHIR elements must have a @value or children
| ||||||||||
![]() ![]() ![]() |
SO | 0..* | CodeableConcept | Reason for why the medication is being/was taken Binding: Medication Reason Taken ![]() ele-1: All FHIR elements must have a @value or children
| ||||||||||
![]() ![]() ![]() |
SO | 0..* | Reference(AU Core 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
| ||||||||||
![]() ![]() ![]() |
SO | 0..* | AUBaseDosage | Details of how medication is/was taken or should be taken ele-1: All FHIR elements must have a @value or children
| ||||||||||
![]() ![]() ![]() ![]() |
?!Σ | 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 | ||||||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | Free text dosage instructions e.g. SIG ele-1: All FHIR elements must have a @value or children
| ||||||||||
![]() |
Path | Conformance | ValueSet | URI |
MedicationStatement.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1 from the FHIR Standard | |
MedicationStatement.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | |
MedicationStatement.medication[x]:medicationCodeableConcept | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | |
MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbs | required | PBSItemCodeshttp://terminology.hl7.org.au/ValueSet/pbs-item | |
MedicationStatement.medication[x]:medicationCodeableConcept.coding:amt | required | AustralianMedication ![]() https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 | |
MedicationStatement.reasonCode | preferred | MedicationReasonTaken ![]() https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1 |
Id | Grade | Path(s) | Details | Requirements |
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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | AUBaseMedicationStatement | A record of medication being taken by a patient in an Australian healthcare context | |||||||||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||||||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||||||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Medication Long Term Indicator URL: http://hl7.org.au/fhir/StructureDefinition/medication-long-term | |||||||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | External identifier | ||||||||||
![]() ![]() ![]() |
Σ | 0..* | Reference(MedicationRequest | CarePlan | ServiceRequest) | Fulfils plan, proposal or order | ||||||||||
![]() ![]() ![]() |
Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) | Part of referenced event | ||||||||||
![]() ![]() ![]() |
?!SOΣ | 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.
| ||||||||||
![]() ![]() ![]() |
0..* | CodeableConcept | Reason for current status Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement. | |||||||||||
![]() ![]() ![]() |
Σ | 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. | ||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | Medication Detail Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.
| |||||||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||||||||
![]() ![]() ![]() ![]() |
Reference(Medication) | |||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Coded Medication Binding: SNOMEDCTMedicationCodes (example)
| ||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
SOΣ | 0..* | Coding | Code defined by a terminology system Binding: PBS Item Codes (required)
| ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
SOΣ | 0..* | Coding | Code defined by a terminology system Binding: Australian Medication ![]()
| ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Medication primary text | ||||||||||
![]() ![]() ![]() ![]() |
OΣ | 0..1 | Reference(AU Core Medication) | Medication Reference
| ||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | Reference(AU Core Patient) | Who is/was taking the medication
| ||||||||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with MedicationStatement | ||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | The date/time or interval when the medication is/was/will be taken
| |||||||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||||||||
![]() ![]() ![]() ![]() |
Period | |||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | dateTime | When the statement was asserted?
| ||||||||||
![]() ![]() ![]() |
0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | Person or organization that provided the information about the taking of this medication | |||||||||||
![]() ![]() ![]() |
0..* | Reference(Resource) | Additional supporting information | |||||||||||
![]() ![]() ![]() |
SO | 0..* | CodeableConcept | Reason for why the medication is being/was taken Binding: Medication Reason Taken ![]()
| ||||||||||
![]() ![]() ![]() |
SO | 0..* | Reference(AU Core Condition | Observation | AU Base Diagnostic Report) | Condition or observation that supports why the medication is being/was taken
| ||||||||||
![]() ![]() ![]() |
0..* | Annotation | Further information about the statement | |||||||||||
![]() ![]() ![]() |
SO | 0..* | AUBaseDosage | Details of how medication is/was taken or should be taken
| ||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | integer | The order of the dosage instructions | ||||||||||
![]() ![]() ![]() ![]() |
SOΣ | 0..1 | string | Free text dosage instructions e.g. SIG
| ||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (preferred) | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Patient or consumer oriented instructions | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Timing | When medication should be administered | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Take "as needed" (for x) Binding: Clinical Finding ![]() | |||||||||||
![]() ![]() ![]() ![]() ![]() |
boolean | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Body site to administer to Binding: Body Site ![]() | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | How drug should enter body Binding: Route of Administration ![]() | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (preferred) | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Element | Amount of medication administered | ||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified. | ||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Amount of medication per dose | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Range | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Quantity(SimpleQuantity) | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Amount of medication per unit of time | |||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Ratio | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Range | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Quantity(SimpleQuantity) | |||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Ratio | Upper limit on medication per unit of time | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | SimpleQuantity | Upper limit on medication per administration | ||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | SimpleQuantity | Upper limit on medication per lifetime of the patient | ||||||||||
![]() |
Path | Conformance | ValueSet | URI | |||
MedicationStatement.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
MedicationStatement.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1 from the FHIR Standard | ||||
MedicationStatement.statusReason | example | SNOMEDCTDrugTherapyStatusCodeshttp://hl7.org/fhir/ValueSet/reason-medication-status-codes from the FHIR Standard | ||||
MedicationStatement.category | preferred | Medication usage category codeshttp://hl7.org/fhir/ValueSet/medication-statement-category from the FHIR Standard | ||||
MedicationStatement.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | ||||
MedicationStatement.medication[x]:medicationCodeableConcept | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | ||||
MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbs | required | PBSItemCodeshttp://terminology.hl7.org.au/ValueSet/pbs-item | ||||
MedicationStatement.medication[x]:medicationCodeableConcept.coding:amt | required | AustralianMedication ![]() https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 | ||||
MedicationStatement.reasonCode | preferred | MedicationReasonTaken ![]() https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1 | ||||
MedicationStatement.dosage.additionalInstruction | preferred | SNOMEDCTAdditionalDosageInstructionshttp://hl7.org/fhir/ValueSet/additional-instruction-codes from the FHIR Standard | ||||
MedicationStatement.dosage.asNeeded[x] | preferred | ClinicalFinding ![]() https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 | ||||
MedicationStatement.dosage.site | preferred | BodySite ![]() https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 | ||||
MedicationStatement.dosage.route | preferred | RouteOfAdministration ![]() https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 | ||||
MedicationStatement.dosage.method | preferred | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codes from the FHIR Standard | ||||
MedicationStatement.dosage.doseAndRate.type | example | DoseAndRateTypehttp://hl7.org/fhir/ValueSet/dose-rate-type from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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 AUBaseMedicationStatement
Summary
Mandatory: 1 element
Must-Support: 11 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the mandatory and optional search parameters and combined search parameters. See the AU Core CapabilityStatements for a complete list of supported RESTful interactions for this IG.
FHIR search operations are described here and the syntax used to describe AU Core interactions is defined here.
Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”. A few items are marked as MAY in this implementation guide to highlight their potential relevance.
Parameter(s) | Conformance | Type(s) | Requirements (when used alone or in combination) |
---|---|---|---|
patient | SHALL | reference |
The requester SHALL provide at least an id value and MAY provide both the Type and id values. The responder SHALL support both. The requester SHOULD support chained search patient.identifier using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The responder SHOULD support chained search patient.identifier using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. |
patient+status | SHALL | reference +token |
|
patient+effective | SHOULD | reference +date |
|
_id | SHOULD | token |
|
effective | MAY | date |
A requester SHALL provide a value precise to the second + time offset. A responder SHALL support a value precise to the second + time offset. The requester SHALL support these search comparators gt , lt , ge , le . The responder SHALL support these search comparators gt , lt , ge , le .The requester SHOULD support multipleAnd , and if multipleAnd is supported, SHALL support the search comparators gt , lt , ge , le . The responder SHOULD support multipleAnd , and if multipleAnd is supported, SHALL support the search comparators gt , lt , ge , le . |
status | MAY | token |
The requester SHALL provide at least a code value and MAY provide both the system and code values. The responder SHALL support both. The requester SHALL support multipleOr . The responder SHALL support multipleOr . |
The following search parameters and search parameter combinations SHALL be supported:
patient
search parameter:
_include
parameters: MedicationStatement:medication
patient.identifier
(e.g. patient.identifier=[system|][code]
)GET [base]/MedicationStatement?patient={Type/}[id]
or optionally GET [base]/MedicationStatement?patient.identifier=[system|][code]
Example:
Implementation Notes: Fetches a bundle of all MedicationStatement resources for the specified patient (how to search by reference and how to search by token)
patient
and status
search parameters:
_include
parameters: MedicationStatement:medication
patient.identifier
(e.g. patient.identifier=[system|][code]
)status
(e.g.status={system|}[code],{system|}[code],...
)GET [base]/MedicationStatement?patient={Type/}[id]&status={system|}[code]{,{system|}[code],...}
Example:
Implementation Notes: Fetches a bundle of all MedicationStatement resources for the specified patient and status (how to search by reference and how to search by token)
The following search parameters and search parameter combinations SHOULD be supported:
_id
search parameter:
_include
parameters: MedicationStatement:medication
GET [base]/MedicationStatement?_id=[id]
Example:
Implementation Notes: Fetches a bundle with the requested MedicationStatement, instead of just the resource itself, and allows for the inclusion of additional search parameters such as _include, _revinclude, or _lastUpdated (how to search by id of the resource)
patient
and effective
search parameters:
_include
parameters: MedicationStatement:medication
patient.identifier
(e.g. patient.identifier=[system|][code]
)effective
comparators: gt,lt,ge,le
effective
(e.g.effective=[date]&effective=[date]&...
)GET [base]/MedicationStatement?patient={Type/}[id]&effective={gt|lt|ge|le}[date]{&effective={gt|lt|ge|le}[date]&...}
Example:
Implementation Notes: Fetches a bundle of all MedicationStatement resources for the specified patient and date (how to search by reference and how to search by date)