Medtech ALEX® Implementation Guide
0.0.1 - draft International flag

Medtech ALEX® Implementation Guide - Local Development build (v0.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Medication Statement IPS Profile

Official URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-medicationstatement-ips Version: 0.0.1
Active as of 2025-01-20 Computable Name: AlexMedicationStatementIps

The Medication Statement resource exposed by ALEX for IPS

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement 0..* AUBaseMedicationStatement A record of medication being taken by a patient in an Australian healthcare context
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension Content/Rules for all slices
.... longTerm S 0..1 boolean Medication long term use indicator
URL: http://hl7.org.au/fhir/StructureDefinition/medication-long-term
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... Slices for medication[x] Σ 1..1 CodeableConcept Medication Detail
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.


ele-1: All FHIR elements must have a @value or children
.... medication[x]:medicationCodeableConcept SΣ 0..1 CodeableConcept Coded Medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.


ele-1: All FHIR elements must have a @value or children
..... Slices for coding Σ 0..* Coding Medication Codes
Slice: Unordered, Open by value:system
ele-1: All FHIR elements must have a @value or children
...... coding:pbs Σ 0..* Coding PBS Item Code
Binding: PBS Item Codes (preferred)
ele-1: All FHIR elements must have a @value or children
....... system Σ 1..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
Fixed Value: http://pbs.gov.au/code/item
...... coding:gtin Σ 0..* Coding Medication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
ele-1: All FHIR elements must have a @value or children
....... system Σ 1..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
Fixed Value: http://www.gs1.org/gtin
...... coding:amt Σ 0..* Coding AMT Medicines
Binding: Australian Medication (preferred)
ele-1: All FHIR elements must have a @value or children
....... 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)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... system Σ 1..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
Fixed Value: http://snomed.info/sct
...... coding:mimsPackage Σ 0..1 Coding MIMS Package
Binding: MIMS (preferred)
ele-1: All FHIR elements must have a @value or children
....... system Σ 1..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
Fixed Value: http://www.mims.com.au/codes
.... medication[x]:medicationReference Σ 0..1 Reference() Medication Reference
ele-1: All FHIR elements must have a @value or children
... subject SΣ 1..1 Reference(Patient | Group) Who is/was taking the medication
ele-1: All FHIR elements must have a @value or children
.... reference ΣC 0..1 string Reference to Patient resource
ele-1: All FHIR elements must have a @value or children
.... display Σ 0..1 string External Name of Patient
ele-1: All FHIR elements must have a @value or children
... Slices for effective[x] Σ 0..1 The date/time or interval when the medication is/was/will be taken
Slice: Unordered, Open by type:$this
ele-1: All FHIR elements must have a @value or children
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effective[x]:effectiveDateTime SΣ 0..1 dateTime The date/time or interval when the medication is/was/will be taken
ele-1: All FHIR elements must have a @value or children
... note 0..* Annotation Further information about the statement
ele-1: All FHIR elements must have a @value or children
.... text SΣ 1..1 markdown The annotation - text content (as markdown)
ele-1: All FHIR elements must have a @value or children
... dosage S 0..* AUBaseDosage Dosage information in an Australian healthcare context
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... text SΣ 0..1 string Free text dosage instructions e.g. SIG
ele-1: All FHIR elements must have a @value or children
.... patientInstruction SΣ 0..1 string Patient or consumer oriented instructions
ele-1: All FHIR elements must have a @value or children
.... timing SΣ 0..1 Timing When medication should be administered
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... code SΣ 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: Daily Frequency Value Set for Dosage (extensible)
ele-1: All FHIR elements must have a @value or children
.... route Σ 0..1 CodeableConcept How drug should enter body
Binding: Route of Administration (required)
ele-1: All FHIR elements must have a @value or children
.... doseAndRate SΣ 0..* Element Amount of medication administered
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MedicationStatement.statusrequiredPattern: active
http://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1
from the FHIR Standard
MedicationStatement.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationStatement.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbspreferredPBSItemCodes
http://terminology.hl7.org.au/ValueSet/pbs-item
MedicationStatement.medication[x]:medicationCodeableConcept.coding:gtinpreferredGTIN
http://terminology.hl7.org/ValueSet/v3-GTIN
MedicationStatement.medication[x]:medicationCodeableConcept.coding:amtpreferredAustralianMedication
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
from this IG
MedicationStatement.medication[x]:medicationCodeableConcept.coding:mimsPackagepreferredMIMS
http://terminology.hl7.org.au/ValueSet/mims
MedicationStatement.dosage.timing.codeextensibleDailyFrequency
https://alexapi.medtechglobal.com.au/fhir/ValueSet/daily-frequency
from this IG
MedicationStatement.dosage.routerequiredRouteOfAdministration
https://alexapi.medtechglobal.com.au/fhir/ValueSet/route-of-administration
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationStatementIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationStatementIf 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-4errorMedicationStatementIf 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-5errorMedicationStatementIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationStatementA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from AUBaseMedicationStatement

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement AUBaseMedicationStatement
... meta
.... security 0..* Coding Security Labels applied to this resource
Binding: Definition of Confidentiality Value Set (required)
... Slices for extension Content/Rules for all slices
.... extension:longTerm S 0..1 MedicationLongTerm Medication long term use indicator
... status S 1..1 code active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken
Required Pattern: active
.... medication[x]:medicationCodeableConcept S 0..1 CodeableConcept Coded Medication
... subject S 1..1 Reference(Patient | Group) Who is/was taking the medication
.... reference 0..1 string Reference to Patient resource
.... display 0..1 string External Name of Patient
... Slices for effective[x] 0..1 dateTime, Period The date/time or interval when the medication is/was/will be taken
Slice: Unordered, Open by type:$this
.... effective[x]:effectiveDateTime S 0..1 dateTime The date/time or interval when the medication is/was/will be taken
... note
.... text S 1..1 markdown The annotation - text content (as markdown)
... dosage S 0..* AUBaseDosage Dosage information in an Australian healthcare context
.... text S 0..1 string Free text dosage instructions e.g. SIG
.... patientInstruction S 0..1 string Patient or consumer oriented instructions
.... timing S 0..1 Timing When medication should be administered
..... code S 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: Daily Frequency Value Set for Dosage (extensible)
.... route 0..1 CodeableConcept How drug should enter body
Binding: Route of Administration (required)
.... doseAndRate S 0..* Element Amount of medication administered

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MedicationStatement.meta.securityrequiredConfidentialityVS
https://alexapi.medtechglobal.com.au/fhir/ValueSet/confidentiality
from this IG
MedicationStatement.dosage.timing.codeextensibleDailyFrequency
https://alexapi.medtechglobal.com.au/fhir/ValueSet/daily-frequency
from this IG
MedicationStatement.dosage.routerequiredRouteOfAdministration
https://alexapi.medtechglobal.com.au/fhir/ValueSet/route-of-administration
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: Definition of Confidentiality Value Set (required)
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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 S 0..1 boolean Medication long term use 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 ?!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.


Required Pattern: active
... 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] Σ 1..1 CodeableConcept Medication Detail
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.

.... medication[x]:medicationCodeableConcept SΣ 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 Σ 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 Σ 0..* Coding AMT Medicines
Binding: Australian Medication (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() Medication Reference
... subject SΣ 1..1 Reference(Patient | Group) Who is/was taking the medication
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Reference to Patient resource
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string External Name of Patient
... context Σ 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with MedicationStatement
... Slices for effective[x] Σ 0..1 The date/time or interval when the medication is/was/will be taken
Slice: Unordered, Open by type:$this
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effective[x]:effectiveDateTime SΣ 0..1 dateTime The date/time or interval when the medication is/was/will be taken
... dateAsserted Σ 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 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 0..* 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 SΣ 1..1 markdown The annotation - text content (as markdown)
... dosage S 0..* AUBaseDosage Dosage information in an Australian healthcare context
.... 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 SΣ 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 SΣ 0..1 string Patient or consumer oriented instructions
.... timing SΣ 0..1 Timing When medication should be 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... event Σ 0..* dateTime When the event occurs
..... repeat ΣC 0..1 Element When the event is to occur
tim-1: if there's a duration, there needs to be duration units
tim-2: if there's a period, there needs to be period units
tim-4: duration SHALL be a non-negative value
tim-5: period SHALL be a non-negative value
tim-6: If there's a periodMax, there must be a period
tim-7: If there's a durationMax, there must be a duration
tim-8: If there's a countMax, there must be a count
tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV)
tim-10: If there's a timeOfDay, there cannot be a when, or vice versa
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... bounds[x] Σ 0..1 Length/Range of lengths, or (Start and/or end) limits
....... boundsDuration Duration
....... boundsRange Range
....... boundsPeriod Period
...... count Σ 0..1 positiveInt Number of times to repeat
...... countMax Σ 0..1 positiveInt Maximum number of times to repeat
...... duration Σ 0..1 decimal How long when it happens
...... durationMax Σ 0..1 decimal How long when it happens (Max)
...... durationUnit Σ 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).

...... frequency Σ 0..1 positiveInt Event occurs frequency times per period
...... frequencyMax Σ 0..1 positiveInt Event occurs up to frequencyMax times per period
...... period Σ 0..1 decimal Event occurs frequency times per period
...... periodMax Σ 0..1 decimal Upper limit of period (3-4 hours)
...... periodUnit Σ 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).

...... dayOfWeek Σ 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
...... timeOfDay Σ 0..* time Time of day for action
...... when Σ 0..* code Code for time period of occurrence
Binding: EventTiming (required): Real world event relating to the schedule.


...... offset Σ 0..1 unsignedInt Minutes from event (before or after)
..... code SΣ 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: Daily Frequency Value Set for Dosage (extensible)
.... 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 (required)
.... method Σ 0..1 CodeableConcept Technique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (preferred)
.... doseAndRate SΣ 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MedicationStatement.meta.securityrequiredConfidentialityVS
https://alexapi.medtechglobal.com.au/fhir/ValueSet/confidentiality
from this IG
MedicationStatement.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
MedicationStatement.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
MedicationStatement.statusrequiredPattern: active
http://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1
from the FHIR Standard
MedicationStatement.statusReasonexampleSNOMEDCTDrugTherapyStatusCodes
http://hl7.org/fhir/ValueSet/reason-medication-status-codes
from the FHIR Standard
MedicationStatement.categorypreferredMedication usage category codes
http://hl7.org/fhir/ValueSet/medication-statement-category
from the FHIR Standard
MedicationStatement.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationStatement.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbspreferredPBSItemCodes
http://terminology.hl7.org.au/ValueSet/pbs-item
MedicationStatement.medication[x]:medicationCodeableConcept.coding:gtinpreferredGTIN
http://terminology.hl7.org/ValueSet/v3-GTIN
MedicationStatement.medication[x]:medicationCodeableConcept.coding:amtpreferredAustralianMedication
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
from this IG
MedicationStatement.medication[x]:medicationCodeableConcept.coding:mimsPackagepreferredMIMS
http://terminology.hl7.org.au/ValueSet/mims
MedicationStatement.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
MedicationStatement.reasonCodepreferredMedicationReasonTaken
https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1
from this IG
MedicationStatement.dosage.additionalInstructionpreferredSNOMEDCTAdditionalDosageInstructions
http://hl7.org/fhir/ValueSet/additional-instruction-codes
from the FHIR Standard
MedicationStatement.dosage.timing.repeat.durationUnitrequiredUnitsOfTime
http://hl7.org/fhir/ValueSet/units-of-time|4.0.1
from the FHIR Standard
MedicationStatement.dosage.timing.repeat.periodUnitrequiredUnitsOfTime
http://hl7.org/fhir/ValueSet/units-of-time|4.0.1
from the FHIR Standard
MedicationStatement.dosage.timing.repeat.dayOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard
MedicationStatement.dosage.timing.repeat.whenrequiredEventTiming
http://hl7.org/fhir/ValueSet/event-timing|4.0.1
from the FHIR Standard
MedicationStatement.dosage.timing.codeextensibleDailyFrequency
https://alexapi.medtechglobal.com.au/fhir/ValueSet/daily-frequency
from this IG
MedicationStatement.dosage.asNeeded[x]preferredClinicalFinding .
https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1
MedicationStatement.dosage.sitepreferredBodySite .
https://healthterminologies.gov.au/fhir/ValueSet/body-site-1
MedicationStatement.dosage.routerequiredRouteOfAdministration
https://alexapi.medtechglobal.com.au/fhir/ValueSet/route-of-administration
from this IG
MedicationStatement.dosage.methodpreferredSNOMEDCTAdministrationMethodCodes
http://hl7.org/fhir/ValueSet/administration-method-codes
from the FHIR Standard
MedicationStatement.dosage.doseAndRate.typeexampleDoseAndRateType
http://hl7.org/fhir/ValueSet/dose-rate-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationStatementIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationStatementIf 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-4errorMedicationStatementIf 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-5errorMedicationStatementIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationStatementA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
tim-1errorMedicationStatement.dosage.timing.repeatif there's a duration, there needs to be duration units
: duration.empty() or durationUnit.exists()
tim-2errorMedicationStatement.dosage.timing.repeatif there's a period, there needs to be period units
: period.empty() or periodUnit.exists()
tim-4errorMedicationStatement.dosage.timing.repeatduration SHALL be a non-negative value
: duration.exists() implies duration >= 0
tim-5errorMedicationStatement.dosage.timing.repeatperiod SHALL be a non-negative value
: period.exists() implies period >= 0
tim-6errorMedicationStatement.dosage.timing.repeatIf there's a periodMax, there must be a period
: periodMax.empty() or period.exists()
tim-7errorMedicationStatement.dosage.timing.repeatIf there's a durationMax, there must be a duration
: durationMax.empty() or duration.exists()
tim-8errorMedicationStatement.dosage.timing.repeatIf there's a countMax, there must be a count
: countMax.empty() or count.exists()
tim-9errorMedicationStatement.dosage.timing.repeatIf there's an offset, there must be a when (and not C, CM, CD, CV)
: offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))
tim-10errorMedicationStatement.dosage.timing.repeatIf there's a timeOfDay, there cannot be a when, or vice versa
: timeOfDay.empty() or when.empty()

This structure is derived from AUBaseMedicationStatement

Summary

Must-Support: 12 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of MedicationStatement.effective[x]

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement 0..* AUBaseMedicationStatement A record of medication being taken by a patient in an Australian healthcare context
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension Content/Rules for all slices
.... longTerm S 0..1 boolean Medication long term use indicator
URL: http://hl7.org.au/fhir/StructureDefinition/medication-long-term
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... Slices for medication[x] Σ 1..1 CodeableConcept Medication Detail
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.


ele-1: All FHIR elements must have a @value or children
.... medication[x]:medicationCodeableConcept SΣ 0..1 CodeableConcept Coded Medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.


ele-1: All FHIR elements must have a @value or children
..... Slices for coding Σ 0..* Coding Medication Codes
Slice: Unordered, Open by value:system
ele-1: All FHIR elements must have a @value or children
...... coding:pbs Σ 0..* Coding PBS Item Code
Binding: PBS Item Codes (preferred)
ele-1: All FHIR elements must have a @value or children
....... system Σ 1..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
Fixed Value: http://pbs.gov.au/code/item
...... coding:gtin Σ 0..* Coding Medication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
ele-1: All FHIR elements must have a @value or children
....... system Σ 1..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
Fixed Value: http://www.gs1.org/gtin
...... coding:amt Σ 0..* Coding AMT Medicines
Binding: Australian Medication (preferred)
ele-1: All FHIR elements must have a @value or children
....... 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)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... system Σ 1..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
Fixed Value: http://snomed.info/sct
...... coding:mimsPackage Σ 0..1 Coding MIMS Package
Binding: MIMS (preferred)
ele-1: All FHIR elements must have a @value or children
....... system Σ 1..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
Fixed Value: http://www.mims.com.au/codes
.... medication[x]:medicationReference Σ 0..1 Reference() Medication Reference
ele-1: All FHIR elements must have a @value or children
... subject SΣ 1..1 Reference(Patient | Group) Who is/was taking the medication
ele-1: All FHIR elements must have a @value or children
.... reference ΣC 0..1 string Reference to Patient resource
ele-1: All FHIR elements must have a @value or children
.... display Σ 0..1 string External Name of Patient
ele-1: All FHIR elements must have a @value or children
... Slices for effective[x] Σ 0..1 The date/time or interval when the medication is/was/will be taken
Slice: Unordered, Open by type:$this
ele-1: All FHIR elements must have a @value or children
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effective[x]:effectiveDateTime SΣ 0..1 dateTime The date/time or interval when the medication is/was/will be taken
ele-1: All FHIR elements must have a @value or children
... note 0..* Annotation Further information about the statement
ele-1: All FHIR elements must have a @value or children
.... text SΣ 1..1 markdown The annotation - text content (as markdown)
ele-1: All FHIR elements must have a @value or children
... dosage S 0..* AUBaseDosage Dosage information in an Australian healthcare context
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... text SΣ 0..1 string Free text dosage instructions e.g. SIG
ele-1: All FHIR elements must have a @value or children
.... patientInstruction SΣ 0..1 string Patient or consumer oriented instructions
ele-1: All FHIR elements must have a @value or children
.... timing SΣ 0..1 Timing When medication should be administered
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... code SΣ 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: Daily Frequency Value Set for Dosage (extensible)
ele-1: All FHIR elements must have a @value or children
.... route Σ 0..1 CodeableConcept How drug should enter body
Binding: Route of Administration (required)
ele-1: All FHIR elements must have a @value or children
.... doseAndRate SΣ 0..* Element Amount of medication administered
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MedicationStatement.statusrequiredPattern: active
http://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1
from the FHIR Standard
MedicationStatement.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationStatement.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbspreferredPBSItemCodes
http://terminology.hl7.org.au/ValueSet/pbs-item
MedicationStatement.medication[x]:medicationCodeableConcept.coding:gtinpreferredGTIN
http://terminology.hl7.org/ValueSet/v3-GTIN
MedicationStatement.medication[x]:medicationCodeableConcept.coding:amtpreferredAustralianMedication
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
from this IG
MedicationStatement.medication[x]:medicationCodeableConcept.coding:mimsPackagepreferredMIMS
http://terminology.hl7.org.au/ValueSet/mims
MedicationStatement.dosage.timing.codeextensibleDailyFrequency
https://alexapi.medtechglobal.com.au/fhir/ValueSet/daily-frequency
from this IG
MedicationStatement.dosage.routerequiredRouteOfAdministration
https://alexapi.medtechglobal.com.au/fhir/ValueSet/route-of-administration
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationStatementIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationStatementIf 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-4errorMedicationStatementIf 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-5errorMedicationStatementIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationStatementA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from AUBaseMedicationStatement

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement AUBaseMedicationStatement
... meta
.... security 0..* Coding Security Labels applied to this resource
Binding: Definition of Confidentiality Value Set (required)
... Slices for extension Content/Rules for all slices
.... extension:longTerm S 0..1 MedicationLongTerm Medication long term use indicator
... status S 1..1 code active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken
Required Pattern: active
.... medication[x]:medicationCodeableConcept S 0..1 CodeableConcept Coded Medication
... subject S 1..1 Reference(Patient | Group) Who is/was taking the medication
.... reference 0..1 string Reference to Patient resource
.... display 0..1 string External Name of Patient
... Slices for effective[x] 0..1 dateTime, Period The date/time or interval when the medication is/was/will be taken
Slice: Unordered, Open by type:$this
.... effective[x]:effectiveDateTime S 0..1 dateTime The date/time or interval when the medication is/was/will be taken
... note
.... text S 1..1 markdown The annotation - text content (as markdown)
... dosage S 0..* AUBaseDosage Dosage information in an Australian healthcare context
.... text S 0..1 string Free text dosage instructions e.g. SIG
.... patientInstruction S 0..1 string Patient or consumer oriented instructions
.... timing S 0..1 Timing When medication should be administered
..... code S 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: Daily Frequency Value Set for Dosage (extensible)
.... route 0..1 CodeableConcept How drug should enter body
Binding: Route of Administration (required)
.... doseAndRate S 0..* Element Amount of medication administered

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MedicationStatement.meta.securityrequiredConfidentialityVS
https://alexapi.medtechglobal.com.au/fhir/ValueSet/confidentiality
from this IG
MedicationStatement.dosage.timing.codeextensibleDailyFrequency
https://alexapi.medtechglobal.com.au/fhir/ValueSet/daily-frequency
from this IG
MedicationStatement.dosage.routerequiredRouteOfAdministration
https://alexapi.medtechglobal.com.au/fhir/ValueSet/route-of-administration
from this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: Definition of Confidentiality Value Set (required)
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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 S 0..1 boolean Medication long term use 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 ?!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.


Required Pattern: active
... 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] Σ 1..1 CodeableConcept Medication Detail
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.

.... medication[x]:medicationCodeableConcept SΣ 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 Σ 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 Σ 0..* Coding AMT Medicines
Binding: Australian Medication (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() Medication Reference
... subject SΣ 1..1 Reference(Patient | Group) Who is/was taking the medication
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Reference to Patient resource
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string External Name of Patient
... context Σ 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with MedicationStatement
... Slices for effective[x] Σ 0..1 The date/time or interval when the medication is/was/will be taken
Slice: Unordered, Open by type:$this
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effective[x]:effectiveDateTime SΣ 0..1 dateTime The date/time or interval when the medication is/was/will be taken
... dateAsserted Σ 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 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 0..* 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 SΣ 1..1 markdown The annotation - text content (as markdown)
... dosage S 0..* AUBaseDosage Dosage information in an Australian healthcare context
.... 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 SΣ 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 SΣ 0..1 string Patient or consumer oriented instructions
.... timing SΣ 0..1 Timing When medication should be 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... event Σ 0..* dateTime When the event occurs
..... repeat ΣC 0..1 Element When the event is to occur
tim-1: if there's a duration, there needs to be duration units
tim-2: if there's a period, there needs to be period units
tim-4: duration SHALL be a non-negative value
tim-5: period SHALL be a non-negative value
tim-6: If there's a periodMax, there must be a period
tim-7: If there's a durationMax, there must be a duration
tim-8: If there's a countMax, there must be a count
tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV)
tim-10: If there's a timeOfDay, there cannot be a when, or vice versa
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... bounds[x] Σ 0..1 Length/Range of lengths, or (Start and/or end) limits
....... boundsDuration Duration
....... boundsRange Range
....... boundsPeriod Period
...... count Σ 0..1 positiveInt Number of times to repeat
...... countMax Σ 0..1 positiveInt Maximum number of times to repeat
...... duration Σ 0..1 decimal How long when it happens
...... durationMax Σ 0..1 decimal How long when it happens (Max)
...... durationUnit Σ 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).

...... frequency Σ 0..1 positiveInt Event occurs frequency times per period
...... frequencyMax Σ 0..1 positiveInt Event occurs up to frequencyMax times per period
...... period Σ 0..1 decimal Event occurs frequency times per period
...... periodMax Σ 0..1 decimal Upper limit of period (3-4 hours)
...... periodUnit Σ 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).

...... dayOfWeek Σ 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
...... timeOfDay Σ 0..* time Time of day for action
...... when Σ 0..* code Code for time period of occurrence
Binding: EventTiming (required): Real world event relating to the schedule.


...... offset Σ 0..1 unsignedInt Minutes from event (before or after)
..... code SΣ 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: Daily Frequency Value Set for Dosage (extensible)
.... 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 (required)
.... method Σ 0..1 CodeableConcept Technique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (preferred)
.... doseAndRate SΣ 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MedicationStatement.meta.securityrequiredConfidentialityVS
https://alexapi.medtechglobal.com.au/fhir/ValueSet/confidentiality
from this IG
MedicationStatement.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
MedicationStatement.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
MedicationStatement.statusrequiredPattern: active
http://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1
from the FHIR Standard
MedicationStatement.statusReasonexampleSNOMEDCTDrugTherapyStatusCodes
http://hl7.org/fhir/ValueSet/reason-medication-status-codes
from the FHIR Standard
MedicationStatement.categorypreferredMedication usage category codes
http://hl7.org/fhir/ValueSet/medication-statement-category
from the FHIR Standard
MedicationStatement.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationStatement.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationStatement.medication[x]:medicationCodeableConcept.coding:pbspreferredPBSItemCodes
http://terminology.hl7.org.au/ValueSet/pbs-item
MedicationStatement.medication[x]:medicationCodeableConcept.coding:gtinpreferredGTIN
http://terminology.hl7.org/ValueSet/v3-GTIN
MedicationStatement.medication[x]:medicationCodeableConcept.coding:amtpreferredAustralianMedication
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
from this IG
MedicationStatement.medication[x]:medicationCodeableConcept.coding:mimsPackagepreferredMIMS
http://terminology.hl7.org.au/ValueSet/mims
MedicationStatement.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
MedicationStatement.reasonCodepreferredMedicationReasonTaken
https://healthterminologies.gov.au/fhir/ValueSet/medication-reason-taken-1
from this IG
MedicationStatement.dosage.additionalInstructionpreferredSNOMEDCTAdditionalDosageInstructions
http://hl7.org/fhir/ValueSet/additional-instruction-codes
from the FHIR Standard
MedicationStatement.dosage.timing.repeat.durationUnitrequiredUnitsOfTime
http://hl7.org/fhir/ValueSet/units-of-time|4.0.1
from the FHIR Standard
MedicationStatement.dosage.timing.repeat.periodUnitrequiredUnitsOfTime
http://hl7.org/fhir/ValueSet/units-of-time|4.0.1
from the FHIR Standard
MedicationStatement.dosage.timing.repeat.dayOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard
MedicationStatement.dosage.timing.repeat.whenrequiredEventTiming
http://hl7.org/fhir/ValueSet/event-timing|4.0.1
from the FHIR Standard
MedicationStatement.dosage.timing.codeextensibleDailyFrequency
https://alexapi.medtechglobal.com.au/fhir/ValueSet/daily-frequency
from this IG
MedicationStatement.dosage.asNeeded[x]preferredClinicalFinding .
https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1
MedicationStatement.dosage.sitepreferredBodySite .
https://healthterminologies.gov.au/fhir/ValueSet/body-site-1
MedicationStatement.dosage.routerequiredRouteOfAdministration
https://alexapi.medtechglobal.com.au/fhir/ValueSet/route-of-administration
from this IG
MedicationStatement.dosage.methodpreferredSNOMEDCTAdministrationMethodCodes
http://hl7.org/fhir/ValueSet/administration-method-codes
from the FHIR Standard
MedicationStatement.dosage.doseAndRate.typeexampleDoseAndRateType
http://hl7.org/fhir/ValueSet/dose-rate-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationStatementIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationStatementIf 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-4errorMedicationStatementIf 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-5errorMedicationStatementIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationStatementA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
tim-1errorMedicationStatement.dosage.timing.repeatif there's a duration, there needs to be duration units
: duration.empty() or durationUnit.exists()
tim-2errorMedicationStatement.dosage.timing.repeatif there's a period, there needs to be period units
: period.empty() or periodUnit.exists()
tim-4errorMedicationStatement.dosage.timing.repeatduration SHALL be a non-negative value
: duration.exists() implies duration >= 0
tim-5errorMedicationStatement.dosage.timing.repeatperiod SHALL be a non-negative value
: period.exists() implies period >= 0
tim-6errorMedicationStatement.dosage.timing.repeatIf there's a periodMax, there must be a period
: periodMax.empty() or period.exists()
tim-7errorMedicationStatement.dosage.timing.repeatIf there's a durationMax, there must be a duration
: durationMax.empty() or duration.exists()
tim-8errorMedicationStatement.dosage.timing.repeatIf there's a countMax, there must be a count
: countMax.empty() or count.exists()
tim-9errorMedicationStatement.dosage.timing.repeatIf there's an offset, there must be a when (and not C, CM, CD, CV)
: offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))
tim-10errorMedicationStatement.dosage.timing.repeatIf there's a timeOfDay, there cannot be a when, or vice versa
: timeOfDay.empty() or when.empty()

This structure is derived from AUBaseMedicationStatement

Summary

Must-Support: 12 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of MedicationStatement.effective[x]

 

Other representations of profile: CSV, Excel, Schematron