Australian Digital Health Agency FHIR Implementation Guide
1.2.0-ci-build - draft
Australian Digital Health Agency FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/ci-fhir-r4/ and changes regularly. See the Directory of published versions
Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-medicationstatement-core-1 | Version: 0.0.5 | |||
Draft as of 2024-09-12 | Computable Name: ADHAMedicationStatementCore | |||
Copyright/Legal: Copyright © 2022 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/. |
The purpose of this profile is to provide a core representation of a medication statement for the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia. This profile supports a statement of medication usage for a known medicine including asserting negation for a specific medicine.
This profile identifies the additional constraints, extensions, and value sets that build on and extend MedicationStatement that are supported.
This profile is designed to set a core MedicationStatement standard in the context of:
This profile may be referred to by APIs, which will be listed here when available.
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 | C | 0..* | AUBaseMedicationStatement | A record of medication being taken by a patient in an Australian healthcare context inv-dh-mst-01: If present, an information source shall at least have a reference, an identifier or a display |
basedOn | S | 0..* | Reference(ADHA Core MedicationRequest | CarePlan | ADHA 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 | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:pbs | S | 0..* | Coding | Code defined by a terminology system |
coding:amt | S | 0..* | Coding | Code defined by a terminology system |
medication[x]:medicationReference | 0..1 | Reference(ADHA Core Medication) | Medication Reference | |
subject | SC | 1..1 | Reference(ADHA Core Patient) | Who is/was taking the medication inv-dh-mst-02: At least reference or a valid identifier shall be present |
context | S | 0..1 | Reference(ADHA 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 | SC | 0..1 | Reference(ADHA Core Patient | ADHA Core PractitionerRole | ADHA 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 inv-dh-mst-03: If present, the dosage shall at least have text or patient instructions |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-mst-01 | error | MedicationStatement | If present, an information source shall at least have a reference, an identifier or a display : informationSource.exists() implies informationSource.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
inv-dh-mst-02 | error | MedicationStatement.subject | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-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 | C | 0..* | AUBaseMedicationStatement | A record of medication being taken by a patient in an Australian healthcare context inv-dh-mst-01: If present, an information source shall at least have a reference, an identifier or a display | ||||||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||
Slices for extension | Content/Rules for all slices | |||||||||||||
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(ADHA Core MedicationRequest | CarePlan | ADHA 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)
| ||||||||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||||||||
coding:All Slices | Content/Rules for all slices | |||||||||||||
Slices for extension | Content/Rules for all slices | |||||||||||||
medicationClass | 0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||
coding:pbs | SΣ | 0..* | Coding | Code defined by a terminology system | ||||||||||
Slices for extension | Content/Rules for all slices | |||||||||||||
medicationClass | 0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||
coding:amt | SΣ | 0..* | Coding | Code defined by a terminology system | ||||||||||
Slices for extension | Content/Rules for all slices | |||||||||||||
medicationClass | 0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||
medication[x]:medicationReference | Σ | 0..1 | Reference(ADHA Core Medication) | Medication Reference | ||||||||||
subject | SΣC | 1..1 | Reference(ADHA Core Patient) | Who is/was taking the medication inv-dh-mst-02: At least reference or a valid identifier shall be present | ||||||||||
context | SΣ | 0..1 | Reference(ADHA 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 | SC | 0..1 | Reference(ADHA Core Patient | ADHA Core PractitionerRole | ADHA 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: Medication Reason Taken (preferred) | ||||||||||
note | S | 0..* | Annotation | Further information about the statement | ||||||||||
dosage | SC | 0..* | AUBaseDosage | Dosage information in an Australian healthcare context inv-dh-mst-03: If present, the dosage shall at least have text or patient instructions | ||||||||||
Documentation for this format |
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.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 | SNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | |||||||||||||||
MedicationStatement.reasonCode | preferred | MedicationReasonTaken https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1 |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-mst-01 | error | MedicationStatement | If present, an information source shall at least have a reference, an identifier or a display : informationSource.exists() implies informationSource.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
inv-dh-mst-02 | error | MedicationStatement.subject | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-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 | C | 0..* | AUBaseMedicationStatement | A record of medication being taken by a patient in an Australian healthcare context inv-dh-mst-01: If present, an information source shall at least have a reference, an identifier or a display | ||||||||||
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(ADHA Core MedicationRequest | CarePlan | ADHA 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)
| ||||||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||||||||
coding:All Slices | Content/Rules for all slices | |||||||||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
medicationClass | 0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||||||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||||||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||||||||
display | Σ | 0..1 | string | Representation defined by the system | ||||||||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||||||
coding:pbs | SΣ | 0..* | Coding | Code defined by a terminology system | ||||||||||
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 | Σ | 0..1 | uri | Identity of the terminology system | ||||||||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||||||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||||||||
display | Σ | 0..1 | string | Representation defined by the system | ||||||||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||||||
coding:amt | SΣ | 0..* | Coding | Code defined by a terminology system | ||||||||||
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 | Σ | 0..1 | uri | Identity of the terminology system | ||||||||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||||||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||||||||
display | Σ | 0..1 | string | Representation defined by the system | ||||||||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||||||
text | Σ | 0..1 | string | Medication primary text | ||||||||||
medication[x]:medicationReference | Σ | 0..1 | Reference(ADHA Core Medication) | Medication Reference | ||||||||||
subject | SΣC | 1..1 | Reference(ADHA Core Patient) | Who is/was taking the medication inv-dh-mst-02: At least reference or a valid identifier shall be present | ||||||||||
context | SΣ | 0..1 | Reference(ADHA 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 | SC | 0..1 | Reference(ADHA Core Patient | ADHA Core PractitionerRole | ADHA 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: Medication Reason Taken (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 inv-dh-mst-03: If present, the dosage shall at least have text or patient instructions | ||||||||||
Documentation for this format |
Path | Conformance | ValueSet | URI | ||||||||||||||
MedicationStatement.language | preferred | CommonLanguages
http://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 | SNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | |||||||||||||||
MedicationStatement.reasonCode | preferred | MedicationReasonTaken https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1 |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-mst-01 | error | MedicationStatement | If present, an information source shall at least have a reference, an identifier or a display : informationSource.exists() implies informationSource.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
inv-dh-mst-02 | error | MedicationStatement.subject | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-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:
Differential View
This structure is derived from AUBaseMedicationStatement
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationStatement | C | 0..* | AUBaseMedicationStatement | A record of medication being taken by a patient in an Australian healthcare context inv-dh-mst-01: If present, an information source shall at least have a reference, an identifier or a display |
basedOn | S | 0..* | Reference(ADHA Core MedicationRequest | CarePlan | ADHA 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 | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:pbs | S | 0..* | Coding | Code defined by a terminology system |
coding:amt | S | 0..* | Coding | Code defined by a terminology system |
medication[x]:medicationReference | 0..1 | Reference(ADHA Core Medication) | Medication Reference | |
subject | SC | 1..1 | Reference(ADHA Core Patient) | Who is/was taking the medication inv-dh-mst-02: At least reference or a valid identifier shall be present |
context | S | 0..1 | Reference(ADHA 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 | SC | 0..1 | Reference(ADHA Core Patient | ADHA Core PractitionerRole | ADHA 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 inv-dh-mst-03: If present, the dosage shall at least have text or patient instructions |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-mst-01 | error | MedicationStatement | If present, an information source shall at least have a reference, an identifier or a display : informationSource.exists() implies informationSource.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
inv-dh-mst-02 | error | MedicationStatement.subject | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-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 | C | 0..* | AUBaseMedicationStatement | A record of medication being taken by a patient in an Australian healthcare context inv-dh-mst-01: If present, an information source shall at least have a reference, an identifier or a display | ||||||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||
Slices for extension | Content/Rules for all slices | |||||||||||||
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(ADHA Core MedicationRequest | CarePlan | ADHA 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)
| ||||||||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||||||||
coding:All Slices | Content/Rules for all slices | |||||||||||||
Slices for extension | Content/Rules for all slices | |||||||||||||
medicationClass | 0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||
coding:pbs | SΣ | 0..* | Coding | Code defined by a terminology system | ||||||||||
Slices for extension | Content/Rules for all slices | |||||||||||||
medicationClass | 0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||
coding:amt | SΣ | 0..* | Coding | Code defined by a terminology system | ||||||||||
Slices for extension | Content/Rules for all slices | |||||||||||||
medicationClass | 0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||
medication[x]:medicationReference | Σ | 0..1 | Reference(ADHA Core Medication) | Medication Reference | ||||||||||
subject | SΣC | 1..1 | Reference(ADHA Core Patient) | Who is/was taking the medication inv-dh-mst-02: At least reference or a valid identifier shall be present | ||||||||||
context | SΣ | 0..1 | Reference(ADHA 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 | SC | 0..1 | Reference(ADHA Core Patient | ADHA Core PractitionerRole | ADHA 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: Medication Reason Taken (preferred) | ||||||||||
note | S | 0..* | Annotation | Further information about the statement | ||||||||||
dosage | SC | 0..* | AUBaseDosage | Dosage information in an Australian healthcare context inv-dh-mst-03: If present, the dosage shall at least have text or patient instructions | ||||||||||
Documentation for this format |
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.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 | SNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | |||||||||||||||
MedicationStatement.reasonCode | preferred | MedicationReasonTaken https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1 |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-mst-01 | error | MedicationStatement | If present, an information source shall at least have a reference, an identifier or a display : informationSource.exists() implies informationSource.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
inv-dh-mst-02 | error | MedicationStatement.subject | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-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 | C | 0..* | AUBaseMedicationStatement | A record of medication being taken by a patient in an Australian healthcare context inv-dh-mst-01: If present, an information source shall at least have a reference, an identifier or a display | ||||||||||
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(ADHA Core MedicationRequest | CarePlan | ADHA 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)
| ||||||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||||||||
coding:All Slices | Content/Rules for all slices | |||||||||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
medicationClass | 0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||||||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||||||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||||||||
display | Σ | 0..1 | string | Representation defined by the system | ||||||||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||||||
coding:pbs | SΣ | 0..* | Coding | Code defined by a terminology system | ||||||||||
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 | Σ | 0..1 | uri | Identity of the terminology system | ||||||||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||||||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||||||||
display | Σ | 0..1 | string | Representation defined by the system | ||||||||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||||||
coding:amt | SΣ | 0..* | Coding | Code defined by a terminology system | ||||||||||
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 | Σ | 0..1 | uri | Identity of the terminology system | ||||||||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||||||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||||||||
display | Σ | 0..1 | string | Representation defined by the system | ||||||||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||||||
text | Σ | 0..1 | string | Medication primary text | ||||||||||
medication[x]:medicationReference | Σ | 0..1 | Reference(ADHA Core Medication) | Medication Reference | ||||||||||
subject | SΣC | 1..1 | Reference(ADHA Core Patient) | Who is/was taking the medication inv-dh-mst-02: At least reference or a valid identifier shall be present | ||||||||||
context | SΣ | 0..1 | Reference(ADHA 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 | SC | 0..1 | Reference(ADHA Core Patient | ADHA Core PractitionerRole | ADHA 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: Medication Reason Taken (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 inv-dh-mst-03: If present, the dosage shall at least have text or patient instructions | ||||||||||
Documentation for this format |
Path | Conformance | ValueSet | URI | ||||||||||||||
MedicationStatement.language | preferred | CommonLanguages
http://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 | SNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | |||||||||||||||
MedicationStatement.reasonCode | preferred | MedicationReasonTaken https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1 |
Id | Grade | Path(s) | Details | Requirements |
inv-dh-mst-01 | error | MedicationStatement | If present, an information source shall at least have a reference, an identifier or a display : informationSource.exists() implies informationSource.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()) | |
inv-dh-mst-02 | error | MedicationStatement.subject | At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists() | |
inv-dh-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:
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the mandatory and optional search parameters. FHIR search operations and the syntax used to describe the interactions is described here.
Name | Type | Conformance | Description | Path |
---|---|---|---|---|
subject:identifier | token | SHALL | The identity of a patient, animal or group to list statements for | MedicationStatement.subject.identifier |
effective | date | SHALL | Date when patient was taking (or not taking) the medication | MedicationStatement.effective |
status | token | SHALL | Return statements that match the given status | MedicationStatement.status |
code | token | SHOULD | Return statements of this medication code | MedicationStatement.medicationCodeableConcept |
medication | token | SHOULD | Return statements of this medication reference | MedicationStatement.medicationReference |
The following search parameters and search parameter combinations SHALL be supported:
subject:identifier
:
intent
(e.g.intent={system|}[code],{system|}[code],...
)GET [base]/MedicationStatement?subject:identifier={system|}[code]&intent=order,plan
Example:
GET [base]/MedicationStatement?subject:identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608000228437
Implementation Notes: Fetches a bundle of all MedicationStatement resources for the specified patient (how to search by :identifier and how to search by token)
subject:identifier
and status
search parameters:
status
(e.g.status={system|}[code],{system|}[code],...
)GET [base]/MedicationStatement?subject:identifier={system|}[code]&intent=order,plan&status={system|}[code]{,{system|}[code],...}
Example:
GET [base]/MedicationStatement?subject:identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608000228437&status=active
Implementation Notes: Fetches a bundle of all MedicationStatement resources for the specified patient and and status (how to search by :identifier and how to search by token)
subject:identifier
and effective
search parameters:
intent
(e.g.intent={system|}[code],{system|}[code],...
)GET [base]/MedicationStatement?subject:identifier={system|}[code]&effective=[date]
Example:
GET [base]/MedicationStatement?subject:identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608000228437&effective=ge2013-03-14
Implementation Notes: Fetches a bundle of all MedicationStatement resources for the specified patient that have a date greater than or equal to 21st Jan 2013. (how to search by :identifier and how to search by date)