AU Core Implementation Guide
0.2.2-preview - Preview
This page is part of the Australian Core IG (v0.2.2-preview: AU Core) based on FHIR R4. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-medicationstatement | Version: 0.2.2-preview | |||
Standards status: Draft | Maturity Level: 0 | Computable Name: AUCoreMedicationStatement | ||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved. |
This profile sets minimum expectations for a MedicationStatement resource to record, search, and fetch summary statements of medication use associated with a patient. It is based on the AU Base Medication Statement profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the MedicationStatement when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.
The following are supported usage scenarios for this profile:
A resource conforming to this profile is conformant to:
No equivalent US Core profile.
Conformance in reverse is not guaranteed, i.e. a resource conforming to International Patient Access or International Patient Summary MAY NOT conform to AU Core.
MedicationStatement.medicationCodeableConcept
, or reference a Medication resource with MedicationStatement.medicationReference
.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUBaseMedicationStatement
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationStatement | 0..* | AUBaseMedicationStatement | A record of medication being taken by a patient in an Australian healthcare context | |
basedOn | S | 0..* | Reference(AU Core MedicationRequest | AU Core CarePlan | AU Core ServiceRequest) | Fulfils plan, proposal or order |
status | S | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken |
statusReason | S | 0..* | CodeableConcept | Reason for current status |
category | S | 0..1 | CodeableConcept | Type of medication usage |
Slices for medication[x] | S | 1..1 | CodeableConcept, Reference(Medication) | Medication Detail Slice: Unordered, Closed by type:$this |
medication[x]:medicationCodeableConcept | 0..1 | CodeableConcept | Coded Medication | |
Slices for coding | 0..* | Coding | Medication Codes Slice: Unordered, Open by value:system | |
coding:pbs | S | 0..* | Coding | PBS Item Code |
coding:amt | S | 0..* | Coding | AMT Medicines |
medication[x]:medicationReference | 0..1 | Reference(AU Core Medication) | Medication Reference | |
subject | S | 1..1 | Reference(AU Core Patient) | Who is/was taking the medication |
context | S | 0..1 | Reference(AU Core Encounter) | Encounter / Episode associated with MedicationStatement |
effective[x] | S | 0..1 | dateTime, Period | The date/time or interval when the medication is/was/will be taken |
dateAsserted | S | 0..1 | dateTime | When the statement was asserted? |
informationSource | S | 0..1 | Reference(AU Core Patient | AU Core Practitioner | AU Core PractitionerRole | AU Core RelatedPerson) | Person or organization that provided the information about the taking of this medication |
reasonCode | S | 0..* | CodeableConcept | Reason for why the medication is being/was taken |
note | S | 0..* | Annotation | Further information about the statement |
dosage | SC | 0..* | AUBaseDosage | Dosage information in an Australian healthcare context au-core-mst-03: If present, the dosage shall at least have text or patient instructions |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
au-core-mst-03 | error | MedicationStatement.dosage | If present, the dosage shall at least have text or patient instructions : text.exists() or patientInstruction.exists() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationStatement | 0..* | AUBaseMedicationStatement | A record of medication being taken by a patient in an Australian healthcare context | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
longTerm | 0..1 | boolean | Medication Long Term Indicator URL: http://hl7.org.au/fhir/StructureDefinition/medication-long-term | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
basedOn | SΣ | 0..* | Reference(AU Core MedicationRequest | AU Core CarePlan | AU Core ServiceRequest) | Fulfils plan, proposal or order |
status | ?!SΣ | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement. |
statusReason | S | 0..* | CodeableConcept | Reason for current status Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement. |
category | SΣ | 0..1 | CodeableConcept | Type of medication usage Binding: Medication usage category codes (preferred): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered. |
Slices for medication[x] | SΣ | 1..1 | Medication Detail Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken. | |
medicationCodeableConcept | CodeableConcept | |||
medicationReference | Reference(Medication) | |||
medication[x]:medicationCodeableConcept | Σ | 0..1 | CodeableConcept | Coded Medication Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken. |
Slices for coding | Σ | 0..* | Coding | Medication Codes Slice: Unordered, Open by value:system |
coding:pbs | SΣ | 0..* | Coding | PBS Item Code Binding: PBS Item Codes (preferred) |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://pbs.gov.au/code/item |
coding:gtin | Σ | 0..* | Coding | Medication Package Global Trade Item Number (GTIN) Binding: GTIN (preferred) |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.gs1.org/gtin |
coding:amt | SΣ | 0..* | Coding | AMT Medicines Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred) |
medicationClass | 0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
coding:mimsPackage | Σ | 0..1 | Coding | MIMS Package Binding: MIMS (preferred) |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.mims.com.au/codes |
medication[x]:medicationReference | Σ | 0..1 | Reference(AU Core Medication) | Medication Reference |
subject | SΣ | 1..1 | Reference(AU Core Patient) | Who is/was taking the medication |
context | SΣ | 0..1 | Reference(AU Core Encounter) | Encounter / Episode associated with MedicationStatement |
effective[x] | SΣ | 0..1 | The date/time or interval when the medication is/was/will be taken | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
dateAsserted | SΣ | 0..1 | dateTime | When the statement was asserted? |
informationSource | S | 0..1 | Reference(AU Core Patient | AU Core Practitioner | AU Core PractitionerRole | AU Core RelatedPerson) | Person or organization that provided the information about the taking of this medication |
reasonCode | S | 0..* | CodeableConcept | Reason for why the medication is being/was taken Binding: https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1 (preferred) |
note | S | 0..* | Annotation | Further information about the statement |
dosage | SC | 0..* | AUBaseDosage | Dosage information in an Australian healthcare context au-core-mst-03: If present, the dosage shall at least have text or patient instructions |
Documentation for this format |
Path | Conformance | ValueSet |
MedicationStatement.status | required | Medication Status Codes |
MedicationStatement.statusReason | example | SNOMEDCTDrugTherapyStatusCodes |
MedicationStatement.category | preferred | Medication usage category codes |
MedicationStatement.medication[x] | example | SNOMEDCTMedicationCodes |
MedicationStatement.medication[x]:medicationCodeableConcept | example | SNOMEDCTMedicationCodes |
MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbs | preferred | PBSItemCodes |
MedicationStatement.medication[x]:medicationCodeableConcept.coding:gtin | preferred | GTIN |
MedicationStatement.medication[x]:medicationCodeableConcept.coding:amt | preferred | https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 |
MedicationStatement.medication[x]:medicationCodeableConcept.coding:mimsPackage | preferred | MIMS |
MedicationStatement.reasonCode | preferred | https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1 |
Id | Grade | Path(s) | Details | Requirements |
au-core-mst-03 | error | MedicationStatement.dosage | If present, the dosage shall at least have text or patient instructions : text.exists() or patientInstruction.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MedicationStatement | 0..* | AUBaseMedicationStatement | A record of medication being taken by a patient in an Australian healthcare context | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
longTerm | 0..1 | boolean | Medication Long Term Indicator URL: http://hl7.org.au/fhir/StructureDefinition/medication-long-term | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | External identifier | ||||
basedOn | SΣ | 0..* | Reference(AU Core MedicationRequest | AU Core CarePlan | AU Core ServiceRequest) | Fulfils plan, proposal or order | ||||
partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) | Part of referenced event | ||||
status | ?!SΣ | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement. | ||||
statusReason | S | 0..* | CodeableConcept | Reason for current status Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement. | ||||
category | SΣ | 0..1 | CodeableConcept | Type of medication usage Binding: Medication usage category codes (preferred): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered. | ||||
Slices for medication[x] | SΣ | 1..1 | Medication Detail Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken. | |||||
medicationCodeableConcept | CodeableConcept | |||||||
medicationReference | Reference(Medication) | |||||||
medication[x]:medicationCodeableConcept | Σ | 0..1 | CodeableConcept | Coded Medication Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 0..* | Coding | Medication Codes Slice: Unordered, Open by value:system | ||||
coding:pbs | SΣ | 0..* | Coding | PBS Item Code Binding: PBS Item Codes (preferred) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://pbs.gov.au/code/item | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
coding:gtin | Σ | 0..* | Coding | Medication Package Global Trade Item Number (GTIN) Binding: GTIN (preferred) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.gs1.org/gtin | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
coding:amt | SΣ | 0..* | Coding | AMT Medicines Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
medicationClass | 0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
coding:mimsPackage | Σ | 0..1 | Coding | MIMS Package Binding: MIMS (preferred) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.mims.com.au/codes | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Medication primary text | ||||
medication[x]:medicationReference | Σ | 0..1 | Reference(AU Core Medication) | Medication Reference | ||||
subject | SΣ | 1..1 | Reference(AU Core Patient) | Who is/was taking the medication | ||||
context | SΣ | 0..1 | Reference(AU Core Encounter) | Encounter / Episode associated with MedicationStatement | ||||
effective[x] | SΣ | 0..1 | The date/time or interval when the medication is/was/will be taken | |||||
effectiveDateTime | dateTime | |||||||
effectivePeriod | Period | |||||||
dateAsserted | SΣ | 0..1 | dateTime | When the statement was asserted? | ||||
informationSource | S | 0..1 | Reference(AU Core Patient | AU Core Practitioner | AU Core PractitionerRole | AU Core RelatedPerson) | Person or organization that provided the information about the taking of this medication | ||||
derivedFrom | 0..* | Reference(Resource) | Additional supporting information | |||||
reasonCode | S | 0..* | CodeableConcept | Reason for why the medication is being/was taken Binding: https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1 (preferred) | ||||
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport) | Condition or observation that supports why the medication is being/was taken | |||||
note | S | 0..* | Annotation | Further information about the statement | ||||
dosage | SC | 0..* | AUBaseDosage | Dosage information in an Australian healthcare context au-core-mst-03: If present, the dosage shall at least have text or patient instructions | ||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
MedicationStatement.language | preferred | CommonLanguages
| ||||
MedicationStatement.status | required | Medication Status Codes | ||||
MedicationStatement.statusReason | example | SNOMEDCTDrugTherapyStatusCodes | ||||
MedicationStatement.category | preferred | Medication usage category codes | ||||
MedicationStatement.medication[x] | example | SNOMEDCTMedicationCodes | ||||
MedicationStatement.medication[x]:medicationCodeableConcept | example | SNOMEDCTMedicationCodes | ||||
MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbs | preferred | PBSItemCodes | ||||
MedicationStatement.medication[x]:medicationCodeableConcept.coding:gtin | preferred | GTIN | ||||
MedicationStatement.medication[x]:medicationCodeableConcept.coding:amt | preferred | https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 | ||||
MedicationStatement.medication[x]:medicationCodeableConcept.coding:mimsPackage | preferred | MIMS | ||||
MedicationStatement.reasonCode | preferred | https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1 |
Id | Grade | Path(s) | Details | Requirements |
au-core-mst-03 | error | MedicationStatement.dosage | If present, the dosage shall at least have text or patient instructions : text.exists() or patientInstruction.exists() |
This structure is derived from AUBaseMedicationStatement
Summary
Must-Support: 15 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 |
---|---|---|---|---|
MedicationStatement | 0..* | AUBaseMedicationStatement | A record of medication being taken by a patient in an Australian healthcare context | |
basedOn | S | 0..* | Reference(AU Core MedicationRequest | AU Core CarePlan | AU Core ServiceRequest) | Fulfils plan, proposal or order |
status | S | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken |
statusReason | S | 0..* | CodeableConcept | Reason for current status |
category | S | 0..1 | CodeableConcept | Type of medication usage |
Slices for medication[x] | S | 1..1 | CodeableConcept, Reference(Medication) | Medication Detail Slice: Unordered, Closed by type:$this |
medication[x]:medicationCodeableConcept | 0..1 | CodeableConcept | Coded Medication | |
Slices for coding | 0..* | Coding | Medication Codes Slice: Unordered, Open by value:system | |
coding:pbs | S | 0..* | Coding | PBS Item Code |
coding:amt | S | 0..* | Coding | AMT Medicines |
medication[x]:medicationReference | 0..1 | Reference(AU Core Medication) | Medication Reference | |
subject | S | 1..1 | Reference(AU Core Patient) | Who is/was taking the medication |
context | S | 0..1 | Reference(AU Core Encounter) | Encounter / Episode associated with MedicationStatement |
effective[x] | S | 0..1 | dateTime, Period | The date/time or interval when the medication is/was/will be taken |
dateAsserted | S | 0..1 | dateTime | When the statement was asserted? |
informationSource | S | 0..1 | Reference(AU Core Patient | AU Core Practitioner | AU Core PractitionerRole | AU Core RelatedPerson) | Person or organization that provided the information about the taking of this medication |
reasonCode | S | 0..* | CodeableConcept | Reason for why the medication is being/was taken |
note | S | 0..* | Annotation | Further information about the statement |
dosage | SC | 0..* | AUBaseDosage | Dosage information in an Australian healthcare context au-core-mst-03: If present, the dosage shall at least have text or patient instructions |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
au-core-mst-03 | error | MedicationStatement.dosage | If present, the dosage shall at least have text or patient instructions : text.exists() or patientInstruction.exists() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationStatement | 0..* | AUBaseMedicationStatement | A record of medication being taken by a patient in an Australian healthcare context | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
longTerm | 0..1 | boolean | Medication Long Term Indicator URL: http://hl7.org.au/fhir/StructureDefinition/medication-long-term | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
basedOn | SΣ | 0..* | Reference(AU Core MedicationRequest | AU Core CarePlan | AU Core ServiceRequest) | Fulfils plan, proposal or order |
status | ?!SΣ | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement. |
statusReason | S | 0..* | CodeableConcept | Reason for current status Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement. |
category | SΣ | 0..1 | CodeableConcept | Type of medication usage Binding: Medication usage category codes (preferred): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered. |
Slices for medication[x] | SΣ | 1..1 | Medication Detail Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken. | |
medicationCodeableConcept | CodeableConcept | |||
medicationReference | Reference(Medication) | |||
medication[x]:medicationCodeableConcept | Σ | 0..1 | CodeableConcept | Coded Medication Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken. |
Slices for coding | Σ | 0..* | Coding | Medication Codes Slice: Unordered, Open by value:system |
coding:pbs | SΣ | 0..* | Coding | PBS Item Code Binding: PBS Item Codes (preferred) |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://pbs.gov.au/code/item |
coding:gtin | Σ | 0..* | Coding | Medication Package Global Trade Item Number (GTIN) Binding: GTIN (preferred) |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.gs1.org/gtin |
coding:amt | SΣ | 0..* | Coding | AMT Medicines Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred) |
medicationClass | 0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
coding:mimsPackage | Σ | 0..1 | Coding | MIMS Package Binding: MIMS (preferred) |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.mims.com.au/codes |
medication[x]:medicationReference | Σ | 0..1 | Reference(AU Core Medication) | Medication Reference |
subject | SΣ | 1..1 | Reference(AU Core Patient) | Who is/was taking the medication |
context | SΣ | 0..1 | Reference(AU Core Encounter) | Encounter / Episode associated with MedicationStatement |
effective[x] | SΣ | 0..1 | The date/time or interval when the medication is/was/will be taken | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
dateAsserted | SΣ | 0..1 | dateTime | When the statement was asserted? |
informationSource | S | 0..1 | Reference(AU Core Patient | AU Core Practitioner | AU Core PractitionerRole | AU Core RelatedPerson) | Person or organization that provided the information about the taking of this medication |
reasonCode | S | 0..* | CodeableConcept | Reason for why the medication is being/was taken Binding: https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1 (preferred) |
note | S | 0..* | Annotation | Further information about the statement |
dosage | SC | 0..* | AUBaseDosage | Dosage information in an Australian healthcare context au-core-mst-03: If present, the dosage shall at least have text or patient instructions |
Documentation for this format |
Path | Conformance | ValueSet |
MedicationStatement.status | required | Medication Status Codes |
MedicationStatement.statusReason | example | SNOMEDCTDrugTherapyStatusCodes |
MedicationStatement.category | preferred | Medication usage category codes |
MedicationStatement.medication[x] | example | SNOMEDCTMedicationCodes |
MedicationStatement.medication[x]:medicationCodeableConcept | example | SNOMEDCTMedicationCodes |
MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbs | preferred | PBSItemCodes |
MedicationStatement.medication[x]:medicationCodeableConcept.coding:gtin | preferred | GTIN |
MedicationStatement.medication[x]:medicationCodeableConcept.coding:amt | preferred | https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 |
MedicationStatement.medication[x]:medicationCodeableConcept.coding:mimsPackage | preferred | MIMS |
MedicationStatement.reasonCode | preferred | https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1 |
Id | Grade | Path(s) | Details | Requirements |
au-core-mst-03 | error | MedicationStatement.dosage | If present, the dosage shall at least have text or patient instructions : text.exists() or patientInstruction.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MedicationStatement | 0..* | AUBaseMedicationStatement | A record of medication being taken by a patient in an Australian healthcare context | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
longTerm | 0..1 | boolean | Medication Long Term Indicator URL: http://hl7.org.au/fhir/StructureDefinition/medication-long-term | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | External identifier | ||||
basedOn | SΣ | 0..* | Reference(AU Core MedicationRequest | AU Core CarePlan | AU Core ServiceRequest) | Fulfils plan, proposal or order | ||||
partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) | Part of referenced event | ||||
status | ?!SΣ | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement. | ||||
statusReason | S | 0..* | CodeableConcept | Reason for current status Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement. | ||||
category | SΣ | 0..1 | CodeableConcept | Type of medication usage Binding: Medication usage category codes (preferred): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered. | ||||
Slices for medication[x] | SΣ | 1..1 | Medication Detail Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken. | |||||
medicationCodeableConcept | CodeableConcept | |||||||
medicationReference | Reference(Medication) | |||||||
medication[x]:medicationCodeableConcept | Σ | 0..1 | CodeableConcept | Coded Medication Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 0..* | Coding | Medication Codes Slice: Unordered, Open by value:system | ||||
coding:pbs | SΣ | 0..* | Coding | PBS Item Code Binding: PBS Item Codes (preferred) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://pbs.gov.au/code/item | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
coding:gtin | Σ | 0..* | Coding | Medication Package Global Trade Item Number (GTIN) Binding: GTIN (preferred) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.gs1.org/gtin | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
coding:amt | SΣ | 0..* | Coding | AMT Medicines Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
medicationClass | 0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
coding:mimsPackage | Σ | 0..1 | Coding | MIMS Package Binding: MIMS (preferred) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.mims.com.au/codes | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Medication primary text | ||||
medication[x]:medicationReference | Σ | 0..1 | Reference(AU Core Medication) | Medication Reference | ||||
subject | SΣ | 1..1 | Reference(AU Core Patient) | Who is/was taking the medication | ||||
context | SΣ | 0..1 | Reference(AU Core Encounter) | Encounter / Episode associated with MedicationStatement | ||||
effective[x] | SΣ | 0..1 | The date/time or interval when the medication is/was/will be taken | |||||
effectiveDateTime | dateTime | |||||||
effectivePeriod | Period | |||||||
dateAsserted | SΣ | 0..1 | dateTime | When the statement was asserted? | ||||
informationSource | S | 0..1 | Reference(AU Core Patient | AU Core Practitioner | AU Core PractitionerRole | AU Core RelatedPerson) | Person or organization that provided the information about the taking of this medication | ||||
derivedFrom | 0..* | Reference(Resource) | Additional supporting information | |||||
reasonCode | S | 0..* | CodeableConcept | Reason for why the medication is being/was taken Binding: https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1 (preferred) | ||||
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport) | Condition or observation that supports why the medication is being/was taken | |||||
note | S | 0..* | Annotation | Further information about the statement | ||||
dosage | SC | 0..* | AUBaseDosage | Dosage information in an Australian healthcare context au-core-mst-03: If present, the dosage shall at least have text or patient instructions | ||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
MedicationStatement.language | preferred | CommonLanguages
| ||||
MedicationStatement.status | required | Medication Status Codes | ||||
MedicationStatement.statusReason | example | SNOMEDCTDrugTherapyStatusCodes | ||||
MedicationStatement.category | preferred | Medication usage category codes | ||||
MedicationStatement.medication[x] | example | SNOMEDCTMedicationCodes | ||||
MedicationStatement.medication[x]:medicationCodeableConcept | example | SNOMEDCTMedicationCodes | ||||
MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbs | preferred | PBSItemCodes | ||||
MedicationStatement.medication[x]:medicationCodeableConcept.coding:gtin | preferred | GTIN | ||||
MedicationStatement.medication[x]:medicationCodeableConcept.coding:amt | preferred | https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 | ||||
MedicationStatement.medication[x]:medicationCodeableConcept.coding:mimsPackage | preferred | MIMS | ||||
MedicationStatement.reasonCode | preferred | https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1 |
Id | Grade | Path(s) | Details | Requirements |
au-core-mst-03 | error | MedicationStatement.dosage | If present, the dosage shall at least have text or patient instructions : text.exists() or patientInstruction.exists() |
This structure is derived from AUBaseMedicationStatement
Summary
Must-Support: 15 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. FHIR search operations and the syntax used to describe the interactions is described here.
Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”. A few items are marked as MAY in this implementation guide to highlight their potential relevance.
Parameter(s) | Conformance | Type(s) | Requirements (when used alone or in combination) |
---|---|---|---|
patient | SHALL | reference |
The client SHALL provide at least an id value and MAY provide both the Type and id values. The server SHALL support both. |
patient+status | SHALL | reference +token |
|
patient+effective | SHOULD | reference +date |
|
patient.identifier | SHOULD | reference .token |
The client SHALL provide both the system and code values. The server SHALL support both. The client SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The server SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. |
effective | MAY | date |
A client SHALL provide a value precise to the second + time offset. A server SHALL support a value precise to the second + time offset. |
status | MAY | token |
The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. |
The following search parameters and search parameter combinations SHALL be supported:
patient
search parameter:
_include
parameters: MedicationStatement:medication
_revinclude
parameters: Provenance:target
patient.identifier
(e.g. patient.identifier=[system|][code]
)GET [base]/MedicationStatement?patient={Type/}[id]
or optionallyGET [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
_revinclude
parameters: Provenance:target
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:
patient
and effective
search parameters:
_include
parameters: MedicationStatement:medication
patient.identifier
(e.g. patient.identifier=[system|][code]
)_revinclude
parameters: Provenance:target
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)