Smart Health Checks
0.3.0 - ci-build
Smart Health Checks
0.3.0 - ci-build
Smart Health Checks, published by AEHRC CSIRO. This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/aehrc/smart-forms-ig/ and changes regularly. See the Directory of published versions
| Official URL: https://smartforms.csiro.au/ig/StructureDefinition/SHCMedicationStatement | Version: 0.3.0 | |||
| Draft as of 2025-10-13 | Computable Name: SmartHealthChecksMedicationStatement | |||
Copyright/Legal: Copyright © 2022+ Australian Government Department of Health and Aged Care - All rights reserved. This content is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License. See https://creativecommons.org/licenses/by-sa/4.0/. |
||||
This profile sets the minimum expectations for a MedicationStatement resource to record, search and save medication information when used within Smart Health Checks.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationStatement.status | Base | required | Medication status codes | 📍4.0.1 | FHIR Std. |
| MedicationStatement.medication[x] | Base | example | SNOMED CT Medication Codes | 📦4.0.1 | FHIR Std. |
| MedicationStatement.medication[x]:medicationCodeableConcept | Base | example | SNOMED CT Medication Codes | 📦4.0.1 | FHIR Std. |
| MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbs | Base | required | PBS Item Codes | 📦6.0.0-ballot | AU Base Implementation Guide v6.0 |
| MedicationStatement.medication[x]:medicationCodeableConcept.coding:amt | Base | required |
Australian Medication
|
⏿1.0.2 | tx.ontoserver.csiro.au |
| MedicationStatement.reasonCode | Base | preferred | Medication Reason Taken | 📦1.1.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | MedicationStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | MedicationStatement | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | MedicationStatement | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | MedicationStatement | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | MedicationStatement | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from AUCoreMedicationStatement
| Name | Flags | Card. | Type | Description & Constraints Filter:   | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
  MedicationStatement |
AUCoreMedicationStatement | ||||||||||||||||||
  id |
SO | 0..1 | id | Logical id of this artifact
| |||||||||||||||
| status |
O | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken
| |||||||||||||||
  Slices for medication[x] |
Content/Rules for all slices | ||||||||||||||||||
   medication[x]:medicationCodeableConcept |
O | 0..1 | CodeableConcept | Coded Medication
| |||||||||||||||
  text |
SO | 0..1 | string | Medication primary text
| |||||||||||||||
 medication[x]:medicationReference |
O | 0..1 | Reference(Smart Health Checks Medication) | Medication Reference
| |||||||||||||||
| subject |
O | 1..1 | Reference(AU Core Patient) | Who is/was taking the medication
| |||||||||||||||
| dateAsserted |
O | 0..1 | dateTime | When the statement was asserted?
| |||||||||||||||
| reasonCode |
O | 0..* | CodeableConcept | Reason for why the medication is being/was taken
| |||||||||||||||
| note |
S | 0..1 | Annotation | Further information about the statement | |||||||||||||||
 text |
SO | 1..1 | markdown | The annotation - text content (as markdown)
| |||||||||||||||
 dosage |
0..1 | AUBaseDosage | Details of how medication is/was taken or should be taken | ||||||||||||||||
 text |
O | 0..1 | string | Free text dosage instructions e.g. SIG
| |||||||||||||||
| Documentation for this format | |||||||||||||||||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| MedicationStatement |
0..* | AUCoreMedicationStatement | A record of medication being taken by a patient in an Australian healthcare context | ||||||||||||||||||||||||||||||||
 id |
SOΣ | 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | ||||||||||||||||||||||||||||||||
| contained |
0..* | Resource | Contained, inline Resources | ||||||||||||||||||||||||||||||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||||||||||||||||||||||||||||||
| extension:longTerm |
0..1 | boolean | Medication Long Term Indicator URL: http://hl7.org.au/fhir/StructureDefinition/medication-long-term | ||||||||||||||||||||||||||||||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||||||||||||||||||||||||
| identifier |
Σ | 0..* | Identifier | External identifier | |||||||||||||||||||||||||||||||
 basedOn |
Σ | 0..* | Reference(MedicationRequest | CarePlan | ServiceRequest) | Fulfils plan, proposal or order | |||||||||||||||||||||||||||||||
| partOf |
Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) | Part of referenced event | |||||||||||||||||||||||||||||||
| status |
?!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.
| |||||||||||||||||||||||||||||||
| statusReason |
0..* | CodeableConcept | Reason for current status Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement. | ||||||||||||||||||||||||||||||||
| category |
Σ | 0..1 | CodeableConcept | Type of medication usage Binding: Medication usage category codes (preferred): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered. | |||||||||||||||||||||||||||||||
| Slices for medication[x] |
SOΣ | 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(Any) | ||||||||||||||||||||||||||||||||||
| medication[x]:medicationCodeableConcept |
SOΣ | 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 pattern:$this | |||||||||||||||||||||||||||||||
 coding:All Slices |
Content/Rules for all slices | ||||||||||||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||||||||||||||||||||||||||||||
| extension:medicationClass |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | ||||||||||||||||||||||||||||||||
| system |
Σ | 0..1 | uri | Identity of the terminology system | |||||||||||||||||||||||||||||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | |||||||||||||||||||||||||||||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system | |||||||||||||||||||||||||||||||
| display |
Σ | 0..1 | string | Representation defined by the system | |||||||||||||||||||||||||||||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||||||||||||||||||||
| coding:pbs |
SOΣ | 0..* | Coding | Code defined by a terminology system Binding: PBS Item Codes (required)
| |||||||||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||||||||||||||||||||||||||||||
| extension:medicationClass |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | ||||||||||||||||||||||||||||||||
| system |
Σ | 0..1 | uri | Identity of the terminology system | |||||||||||||||||||||||||||||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | |||||||||||||||||||||||||||||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system | |||||||||||||||||||||||||||||||
| display |
Σ | 0..1 | string | Representation defined by the system | |||||||||||||||||||||||||||||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||||||||||||||||||||
 coding:amt |
SOΣ | 0..* | Coding | Code defined by a terminology system Binding: Australian Medication (required)
| |||||||||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||||||||||||||||||||||||||||||
| extension:medicationClass |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | ||||||||||||||||||||||||||||||||
| system |
Σ | 0..1 | uri | Identity of the terminology system | |||||||||||||||||||||||||||||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | |||||||||||||||||||||||||||||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system | |||||||||||||||||||||||||||||||
| display |
Σ | 0..1 | string | Representation defined by the system | |||||||||||||||||||||||||||||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||||||||||||||||||||
| text |
SOΣ | 0..1 | string | Medication primary text
| |||||||||||||||||||||||||||||||
| medication[x]:medicationReference |
SOΣ | 0..1 | Reference(Smart Health Checks Medication) | Medication Reference
| |||||||||||||||||||||||||||||||
| subject |
SOΣ | 1..1 | Reference(AU Core Patient) | Who is/was taking the medication
| |||||||||||||||||||||||||||||||
| context |
Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with MedicationStatement | |||||||||||||||||||||||||||||||
 effective[x] |
SOΣ | 0..1 | The date/time or interval when the medication is/was/will be taken
| ||||||||||||||||||||||||||||||||
| effectiveDateTime |
dateTime | ||||||||||||||||||||||||||||||||||
| effectivePeriod |
Period | ||||||||||||||||||||||||||||||||||
| dateAsserted |
SOΣ | 0..1 | dateTime | When the statement was asserted?
| |||||||||||||||||||||||||||||||
| informationSource |
0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | Person or organization that provided the information about the taking of this medication | ||||||||||||||||||||||||||||||||
| derivedFrom |
0..* | Reference(Resource) | Additional supporting information | ||||||||||||||||||||||||||||||||
| reasonCode |
SO | 0..* | CodeableConcept | Reason for why the medication is being/was taken Binding: Medication Reason Taken (preferred)
| |||||||||||||||||||||||||||||||
| reasonReference |
SO | 0..* | Reference(AU Core Condition | Observation | AU Base DiagnosticReport) | Condition or observation that supports why the medication is being/was taken
| |||||||||||||||||||||||||||||||
| note |
S | 0..1 | Annotation | Further information about the statement | |||||||||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||||||||||||
| author[x] |
Σ | 0..1 | Individual responsible for the annotation | ||||||||||||||||||||||||||||||||
| authorReference |
Reference(Practitioner | Patient | RelatedPerson | Organization) | ||||||||||||||||||||||||||||||||||
| authorString |
string | ||||||||||||||||||||||||||||||||||
| time |
Σ | 0..1 | dateTime | When the annotation was made | |||||||||||||||||||||||||||||||
| text |
SOΣ | 1..1 | markdown | The annotation - text content (as markdown)
| |||||||||||||||||||||||||||||||
| dosage |
SO | 0..1 | AUBaseDosage | Details of how medication is/was taken or should be taken
| |||||||||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||||||||||||
| sequence |
Σ | 0..1 | integer | The order of the dosage instructions | |||||||||||||||||||||||||||||||
| text |
SOΣ | 0..1 | string | Free text dosage instructions e.g. SIG
| |||||||||||||||||||||||||||||||
| additionalInstruction |
Σ | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (preferred) | |||||||||||||||||||||||||||||||
| patientInstruction |
Σ | 0..1 | string | Patient or consumer oriented instructions | |||||||||||||||||||||||||||||||
| timing |
Σ | 0..1 | Timing | When medication should be administered | |||||||||||||||||||||||||||||||
| asNeeded[x] |
Σ | 0..1 | Take "as needed" (for x) Binding: Clinical Finding (preferred) | ||||||||||||||||||||||||||||||||
| asNeededBoolean |
boolean | ||||||||||||||||||||||||||||||||||
| asNeededCodeableConcept |
CodeableConcept | ||||||||||||||||||||||||||||||||||
| site |
Σ | 0..1 | CodeableConcept | Body site to administer to Binding: Body Site (preferred) | |||||||||||||||||||||||||||||||
| route |
Σ | 0..1 | CodeableConcept | How drug should enter body Binding: Route of Administration (preferred) | |||||||||||||||||||||||||||||||
| method |
Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (preferred) | |||||||||||||||||||||||||||||||
| doseAndRate |
Σ | 0..* | Element | Amount of medication administered | |||||||||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||||||||||||
| type |
Σ | 0..1 | CodeableConcept | The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified. | |||||||||||||||||||||||||||||||
| dose[x] |
Σ | 0..1 | Amount of medication per dose | ||||||||||||||||||||||||||||||||
| doseRange |
Range | ||||||||||||||||||||||||||||||||||
| doseQuantity |
Quantity(SimpleQuantity) | ||||||||||||||||||||||||||||||||||
| rate[x] |
Σ | 0..1 | Amount of medication per unit of time | ||||||||||||||||||||||||||||||||
| rateRatio |
Ratio | ||||||||||||||||||||||||||||||||||
| rateRange |
Range | ||||||||||||||||||||||||||||||||||
| rateQuantity |
Quantity(SimpleQuantity) | ||||||||||||||||||||||||||||||||||
| maxDosePerPeriod |
Σ | 0..1 | Ratio | Upper limit on medication per unit of time | |||||||||||||||||||||||||||||||
| maxDosePerAdministration |
Σ | 0..1 | SimpleQuantity | Upper limit on medication per administration | |||||||||||||||||||||||||||||||
| maxDosePerLifetime |
Σ | 0..1 | SimpleQuantity | Upper limit on medication per lifetime of the patient | |||||||||||||||||||||||||||||||
| Documentation for this format | |||||||||||||||||||||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationStatement.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| MedicationStatement.status | Base | required | Medication status codes | 📍4.0.1 | FHIR Std. |
| MedicationStatement.statusReason | Base | example | SNOMED CT Drug Therapy Status codes | 📦4.0.1 | FHIR Std. |
| MedicationStatement.category | Base | preferred | Medication usage category codes | 📦4.0.1 | FHIR Std. |
| MedicationStatement.medication[x] | Base | example | SNOMED CT Medication Codes | 📦4.0.1 | FHIR Std. |
| MedicationStatement.medication[x]:medicationCodeableConcept | Base | example | SNOMED CT Medication Codes | 📦4.0.1 | FHIR Std. |
| MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbs | Base | required | PBS Item Codes | 📦6.0.0-ballot | AU Base Implementation Guide v6.0 |
| MedicationStatement.medication[x]:medicationCodeableConcept.coding:amt | Base | required |
Australian Medication
|
⏿1.0.2 | tx.ontoserver.csiro.au |
| MedicationStatement.reasonCode | Base | preferred | Medication Reason Taken | 📦1.1.0 | This IG |
| MedicationStatement.dosage.additionalInstruction | Base | preferred | SNOMED CT Additional Dosage Instructions | 📦4.0.1 | FHIR Std. |
| MedicationStatement.dosage.asNeeded[x] | Base | preferred |
Clinical Finding
|
⏿1.0.2 | tx.ontoserver.csiro.au |
| MedicationStatement.dosage.site | Base | preferred |
Body Site
|
⏿1.0.2 | tx.ontoserver.csiro.au |
| MedicationStatement.dosage.route | Base | preferred |
Route of Administration
|
⏿1.0.2 | tx.ontoserver.csiro.au |
| MedicationStatement.dosage.method | Base | preferred | SNOMED CT Administration Method Codes | 📦4.0.1 | FHIR Std. |
| MedicationStatement.dosage.doseAndRate.type | Base | example | DoseAndRateType | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | MedicationStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | MedicationStatement | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | MedicationStatement | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | MedicationStatement | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | MedicationStatement | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from AUCoreMedicationStatement
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| MedicationStatement |
0..* | AUCoreMedicationStatement | A record of medication being taken by a patient in an Australian healthcare context | ||||||||||||||||||||||||||||||||
| id |
SOΣ | 0..1 | id | Logical id of this artifact
| |||||||||||||||||||||||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||||||||||||||||||||||||
| Slices for extension |
Content/Rules for all slices | ||||||||||||||||||||||||||||||||||
| extension:longTerm |
0..1 | boolean | Medication Long Term Indicator URL: http://hl7.org.au/fhir/StructureDefinition/medication-long-term | ||||||||||||||||||||||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||||||||||||||||||||||||
| status |
?!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.
| |||||||||||||||||||||||||||||||
| Slices for medication[x] |
SOΣ | 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(Any) | ||||||||||||||||||||||||||||||||||
| medication[x]:medicationCodeableConcept |
SOΣ | 0..1 | CodeableConcept | Coded Medication Binding: SNOMEDCTMedicationCodes (example)
| |||||||||||||||||||||||||||||||
| Slices for coding |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | |||||||||||||||||||||||||||||||
| coding:All Slices |
Content/Rules for all slices | ||||||||||||||||||||||||||||||||||
| Slices for extension |
Content/Rules for all slices | ||||||||||||||||||||||||||||||||||
| extension:medicationClass |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | ||||||||||||||||||||||||||||||||
| coding:pbs |
SOΣ | 0..* | Coding | Code defined by a terminology system Binding: PBS Item Codes (required)
| |||||||||||||||||||||||||||||||
 Slices for extension |
Content/Rules for all slices | ||||||||||||||||||||||||||||||||||
| extension:medicationClass |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | ||||||||||||||||||||||||||||||||
| coding:amt |
SOΣ | 0..* | Coding | Code defined by a terminology system Binding: Australian Medication (required)
| |||||||||||||||||||||||||||||||
| Slices for extension |
Content/Rules for all slices | ||||||||||||||||||||||||||||||||||
| extension:medicationClass |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | ||||||||||||||||||||||||||||||||
| text |
SOΣ | 0..1 | string | Medication primary text
| |||||||||||||||||||||||||||||||
| medication[x]:medicationReference |
SOΣ | 0..1 | Reference(Smart Health Checks Medication) | Medication Reference
| |||||||||||||||||||||||||||||||
| subject |
SOΣ | 1..1 | Reference(AU Core Patient) | Who is/was taking the medication
| |||||||||||||||||||||||||||||||
| effective[x] |
SOΣ | 0..1 | The date/time or interval when the medication is/was/will be taken
| ||||||||||||||||||||||||||||||||
| effectiveDateTime |
dateTime | ||||||||||||||||||||||||||||||||||
| effectivePeriod |
Period | ||||||||||||||||||||||||||||||||||
| dateAsserted |
SOΣ | 0..1 | dateTime | When the statement was asserted?
| |||||||||||||||||||||||||||||||
| reasonCode |
SO | 0..* | CodeableConcept | Reason for why the medication is being/was taken Binding: Medication Reason Taken (preferred)
| |||||||||||||||||||||||||||||||
| reasonReference |
SO | 0..* | Reference(AU Core Condition | Observation | AU Base DiagnosticReport) | Condition or observation that supports why the medication is being/was taken
| |||||||||||||||||||||||||||||||
| note |
S | 0..1 | Annotation | Further information about the statement | |||||||||||||||||||||||||||||||
| text |
SOΣ | 1..1 | markdown | The annotation - text content (as markdown)
| |||||||||||||||||||||||||||||||
| dosage |
SO | 0..1 | AUBaseDosage | Details of how medication is/was taken or should be taken
| |||||||||||||||||||||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||||||||||||
| text |
SOΣ | 0..1 | string | Free text dosage instructions e.g. SIG
| |||||||||||||||||||||||||||||||
| Documentation for this format | |||||||||||||||||||||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationStatement.status | Base | required | Medication status codes | 📍4.0.1 | FHIR Std. |
| MedicationStatement.medication[x] | Base | example | SNOMED CT Medication Codes | 📦4.0.1 | FHIR Std. |
| MedicationStatement.medication[x]:medicationCodeableConcept | Base | example | SNOMED CT Medication Codes | 📦4.0.1 | FHIR Std. |
| MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbs | Base | required | PBS Item Codes | 📦6.0.0-ballot | AU Base Implementation Guide v6.0 |
| MedicationStatement.medication[x]:medicationCodeableConcept.coding:amt | Base | required |
Australian Medication
|
⏿1.0.2 | tx.ontoserver.csiro.au |
| MedicationStatement.reasonCode | Base | preferred | Medication Reason Taken | 📦1.1.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | MedicationStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | MedicationStatement | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | MedicationStatement | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | MedicationStatement | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | MedicationStatement | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from AUCoreMedicationStatement
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| MedicationStatement |
AUCoreMedicationStatement | ||||||||||||||||||
| id |
SO | 0..1 | id | Logical id of this artifact
| |||||||||||||||
| status |
O | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken
| |||||||||||||||
| Slices for medication[x] |
Content/Rules for all slices | ||||||||||||||||||
| medication[x]:medicationCodeableConcept |
O | 0..1 | CodeableConcept | Coded Medication
| |||||||||||||||
| text |
SO | 0..1 | string | Medication primary text
| |||||||||||||||
| medication[x]:medicationReference |
O | 0..1 | Reference(Smart Health Checks Medication) | Medication Reference
| |||||||||||||||
| subject |
O | 1..1 | Reference(AU Core Patient) | Who is/was taking the medication
| |||||||||||||||
| dateAsserted |
O | 0..1 | dateTime | When the statement was asserted?
| |||||||||||||||
| reasonCode |
O | 0..* | CodeableConcept | Reason for why the medication is being/was taken
| |||||||||||||||
| note |
S | 0..1 | Annotation | Further information about the statement | |||||||||||||||
| text |
SO | 1..1 | markdown | The annotation - text content (as markdown)
| |||||||||||||||
| dosage |
0..1 | AUBaseDosage | Details of how medication is/was taken or should be taken | ||||||||||||||||
| text |
O | 0..1 | string | Free text dosage instructions e.g. SIG
| |||||||||||||||
| Documentation for this format | |||||||||||||||||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| MedicationStatement |
0..* | AUCoreMedicationStatement | A record of medication being taken by a patient in an Australian healthcare context | ||||||||||||||||||||||||||||||||
| id |
SOΣ | 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | ||||||||||||||||||||||||||||||||
| contained |
0..* | Resource | Contained, inline Resources | ||||||||||||||||||||||||||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||||||||||||||||||||||||||||||
| extension:longTerm |
0..1 | boolean | Medication Long Term Indicator URL: http://hl7.org.au/fhir/StructureDefinition/medication-long-term | ||||||||||||||||||||||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||||||||||||||||||||||||
| identifier |
Σ | 0..* | Identifier | External identifier | |||||||||||||||||||||||||||||||
| basedOn |
Σ | 0..* | Reference(MedicationRequest | CarePlan | ServiceRequest) | Fulfils plan, proposal or order | |||||||||||||||||||||||||||||||
| partOf |
Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) | Part of referenced event | |||||||||||||||||||||||||||||||
| status |
?!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.
| |||||||||||||||||||||||||||||||
| statusReason |
0..* | CodeableConcept | Reason for current status Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement. | ||||||||||||||||||||||||||||||||
| category |
Σ | 0..1 | CodeableConcept | Type of medication usage Binding: Medication usage category codes (preferred): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered. | |||||||||||||||||||||||||||||||
| Slices for medication[x] |
SOΣ | 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(Any) | ||||||||||||||||||||||||||||||||||
| medication[x]:medicationCodeableConcept |
SOΣ | 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 pattern:$this | |||||||||||||||||||||||||||||||
| coding:All Slices |
Content/Rules for all slices | ||||||||||||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||||||||||||||||||||||||||||||
| extension:medicationClass |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | ||||||||||||||||||||||||||||||||
| system |
Σ | 0..1 | uri | Identity of the terminology system | |||||||||||||||||||||||||||||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | |||||||||||||||||||||||||||||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system | |||||||||||||||||||||||||||||||
| display |
Σ | 0..1 | string | Representation defined by the system | |||||||||||||||||||||||||||||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||||||||||||||||||||
| coding:pbs |
SOΣ | 0..* | Coding | Code defined by a terminology system Binding: PBS Item Codes (required)
| |||||||||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||||||||||||||||||||||||||||||
| extension:medicationClass |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | ||||||||||||||||||||||||||||||||
| system |
Σ | 0..1 | uri | Identity of the terminology system | |||||||||||||||||||||||||||||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | |||||||||||||||||||||||||||||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system | |||||||||||||||||||||||||||||||
| display |
Σ | 0..1 | string | Representation defined by the system | |||||||||||||||||||||||||||||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||||||||||||||||||||
| coding:amt |
SOΣ | 0..* | Coding | Code defined by a terminology system Binding: Australian Medication (required)
| |||||||||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||||||||||||||||||||||||||||||
| extension:medicationClass |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | ||||||||||||||||||||||||||||||||
| system |
Σ | 0..1 | uri | Identity of the terminology system | |||||||||||||||||||||||||||||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | |||||||||||||||||||||||||||||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system | |||||||||||||||||||||||||||||||
| display |
Σ | 0..1 | string | Representation defined by the system | |||||||||||||||||||||||||||||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||||||||||||||||||||
| text |
SOΣ | 0..1 | string | Medication primary text
| |||||||||||||||||||||||||||||||
| medication[x]:medicationReference |
SOΣ | 0..1 | Reference(Smart Health Checks Medication) | Medication Reference
| |||||||||||||||||||||||||||||||
| subject |
SOΣ | 1..1 | Reference(AU Core Patient) | Who is/was taking the medication
| |||||||||||||||||||||||||||||||
| context |
Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with MedicationStatement | |||||||||||||||||||||||||||||||
| effective[x] |
SOΣ | 0..1 | The date/time or interval when the medication is/was/will be taken
| ||||||||||||||||||||||||||||||||
| effectiveDateTime |
dateTime | ||||||||||||||||||||||||||||||||||
| effectivePeriod |
Period | ||||||||||||||||||||||||||||||||||
| dateAsserted |
SOΣ | 0..1 | dateTime | When the statement was asserted?
| |||||||||||||||||||||||||||||||
| informationSource |
0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | Person or organization that provided the information about the taking of this medication | ||||||||||||||||||||||||||||||||
| derivedFrom |
0..* | Reference(Resource) | Additional supporting information | ||||||||||||||||||||||||||||||||
| reasonCode |
SO | 0..* | CodeableConcept | Reason for why the medication is being/was taken Binding: Medication Reason Taken (preferred)
| |||||||||||||||||||||||||||||||
| reasonReference |
SO | 0..* | Reference(AU Core Condition | Observation | AU Base DiagnosticReport) | Condition or observation that supports why the medication is being/was taken
| |||||||||||||||||||||||||||||||
| note |
S | 0..1 | Annotation | Further information about the statement | |||||||||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||||||||||||
| author[x] |
Σ | 0..1 | Individual responsible for the annotation | ||||||||||||||||||||||||||||||||
| authorReference |
Reference(Practitioner | Patient | RelatedPerson | Organization) | ||||||||||||||||||||||||||||||||||
| authorString |
string | ||||||||||||||||||||||||||||||||||
| time |
Σ | 0..1 | dateTime | When the annotation was made | |||||||||||||||||||||||||||||||
| text |
SOΣ | 1..1 | markdown | The annotation - text content (as markdown)
| |||||||||||||||||||||||||||||||
| dosage |
SO | 0..1 | AUBaseDosage | Details of how medication is/was taken or should be taken
| |||||||||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||||||||||||
| sequence |
Σ | 0..1 | integer | The order of the dosage instructions | |||||||||||||||||||||||||||||||
| text |
SOΣ | 0..1 | string | Free text dosage instructions e.g. SIG
| |||||||||||||||||||||||||||||||
| additionalInstruction |
Σ | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (preferred) | |||||||||||||||||||||||||||||||
| patientInstruction |
Σ | 0..1 | string | Patient or consumer oriented instructions | |||||||||||||||||||||||||||||||
| timing |
Σ | 0..1 | Timing | When medication should be administered | |||||||||||||||||||||||||||||||
| asNeeded[x] |
Σ | 0..1 | Take "as needed" (for x) Binding: Clinical Finding (preferred) | ||||||||||||||||||||||||||||||||
| asNeededBoolean |
boolean | ||||||||||||||||||||||||||||||||||
| asNeededCodeableConcept |
CodeableConcept | ||||||||||||||||||||||||||||||||||
| site |
Σ | 0..1 | CodeableConcept | Body site to administer to Binding: Body Site (preferred) | |||||||||||||||||||||||||||||||
| route |
Σ | 0..1 | CodeableConcept | How drug should enter body Binding: Route of Administration (preferred) | |||||||||||||||||||||||||||||||
| method |
Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (preferred) | |||||||||||||||||||||||||||||||
| doseAndRate |
Σ | 0..* | Element | Amount of medication administered | |||||||||||||||||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||||||||||||||||
| type |
Σ | 0..1 | CodeableConcept | The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified. | |||||||||||||||||||||||||||||||
| dose[x] |
Σ | 0..1 | Amount of medication per dose | ||||||||||||||||||||||||||||||||
| doseRange |
Range | ||||||||||||||||||||||||||||||||||
| doseQuantity |
Quantity(SimpleQuantity) | ||||||||||||||||||||||||||||||||||
| rate[x] |
Σ | 0..1 | Amount of medication per unit of time | ||||||||||||||||||||||||||||||||
| rateRatio |
Ratio | ||||||||||||||||||||||||||||||||||
| rateRange |
Range | ||||||||||||||||||||||||||||||||||
| rateQuantity |
Quantity(SimpleQuantity) | ||||||||||||||||||||||||||||||||||
| maxDosePerPeriod |
Σ | 0..1 | Ratio | Upper limit on medication per unit of time | |||||||||||||||||||||||||||||||
| maxDosePerAdministration |
Σ | 0..1 | SimpleQuantity | Upper limit on medication per administration | |||||||||||||||||||||||||||||||
| maxDosePerLifetime |
Σ | 0..1 | SimpleQuantity | Upper limit on medication per lifetime of the patient | |||||||||||||||||||||||||||||||
| Documentation for this format | |||||||||||||||||||||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationStatement.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| MedicationStatement.status | Base | required | Medication status codes | 📍4.0.1 | FHIR Std. |
| MedicationStatement.statusReason | Base | example | SNOMED CT Drug Therapy Status codes | 📦4.0.1 | FHIR Std. |
| MedicationStatement.category | Base | preferred | Medication usage category codes | 📦4.0.1 | FHIR Std. |
| MedicationStatement.medication[x] | Base | example | SNOMED CT Medication Codes | 📦4.0.1 | FHIR Std. |
| MedicationStatement.medication[x]:medicationCodeableConcept | Base | example | SNOMED CT Medication Codes | 📦4.0.1 | FHIR Std. |
| MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbs | Base | required | PBS Item Codes | 📦6.0.0-ballot | AU Base Implementation Guide v6.0 |
| MedicationStatement.medication[x]:medicationCodeableConcept.coding:amt | Base | required |
Australian Medication
|
⏿1.0.2 | tx.ontoserver.csiro.au |
| MedicationStatement.reasonCode | Base | preferred | Medication Reason Taken | 📦1.1.0 | This IG |
| MedicationStatement.dosage.additionalInstruction | Base | preferred | SNOMED CT Additional Dosage Instructions | 📦4.0.1 | FHIR Std. |
| MedicationStatement.dosage.asNeeded[x] | Base | preferred |
Clinical Finding
|
⏿1.0.2 | tx.ontoserver.csiro.au |
| MedicationStatement.dosage.site | Base | preferred |
Body Site
|
⏿1.0.2 | tx.ontoserver.csiro.au |
| MedicationStatement.dosage.route | Base | preferred |
Route of Administration
|
⏿1.0.2 | tx.ontoserver.csiro.au |
| MedicationStatement.dosage.method | Base | preferred | SNOMED CT Administration Method Codes | 📦4.0.1 | FHIR Std. |
| MedicationStatement.dosage.doseAndRate.type | Base | example | DoseAndRateType | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | MedicationStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | MedicationStatement | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | MedicationStatement | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | MedicationStatement | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | MedicationStatement | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from AUCoreMedicationStatement
Other representations of profile: CSV, Excel, Schematron