Medtech ALEX® AU Implementation Guide
1.0.0 - Trial Use International flag

Medtech ALEX® AU Implementation Guide - Local Development build (v1.0.0) 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: 1.0.0
Active as of 2025-10-09 Computable Name: AlexMedicationStatementIps

The Medication Statement resource exposed by ALEX for IPS

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationStatement 0..* AUBaseMedicationStatement A record of medication being taken by a patient in an Australian healthcare context
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension: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
... 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.
..... 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)
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
...... coding:gtin Σ 0..* Coding Medication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://www.gs1.org/gtin
...... coding:amt Σ 0..* Coding AMT Medicines
Binding: Australian Medication (preferred)
....... 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)
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... coding:mimsPackage Σ 0..1 Coding MIMS Package
Binding: MIMS (preferred)
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://www.mims.com.au/codes
.... medication[x]:medicationReference Σ 0..1 Reference() Medication Reference
... subject SΣ 1..1 Reference(Patient | Group) Who is/was taking the medication
.... reference ΣC 0..1 string Reference to Patient resource
.... display Σ 0..1 string External Name of Patient
... 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
... note 0..* Annotation Further information about the statement
.... text SΣ 1..1 markdown The annotation - text content (as markdown)
... dosage S 0..* AUBaseDosage Dosage information in an Australian healthcare context
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code SΣC 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: Daily Frequency Value Set for Dosage (extensible)
Constraints: medstmt-daily-frequency-system
.... 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

Path Status Usage ValueSet Version Source
MedicationStatement.​status Base required Status for Medication Statement 📦1.0.0 This IG
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 preferred PBS Item Codes 📦4.1.0 AU Base Implementation Guide v4.1
MedicationStatement.​medication[x]:medicationCodeableConcept.​coding:gtin Base preferred GTIN 📦3.0.0 THO v5.5
MedicationStatement.​medication[x]:medicationCodeableConcept.​coding:amt Base preferred Australian Medication 📦1.0.0 This IG
MedicationStatement.​medication[x]:medicationCodeableConcept.​coding:mimsPackage Base preferred MIMS 📦4.1.0 AU Base Implementation Guide v4.1
MedicationStatement.​dosage.timing.code Base extensible Daily Frequency Value Set for Dosage 📦1.0.0 This IG
MedicationStatement.​dosage.route Base required Route of Administration 📦1.0.0 This IG

Constraints

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()
medstmt-daily-frequency-system error MedicationStatement.dosage.timing.code MedicationStatement dosage timing codes must use SNOMED CT or Medtech daily-frequency codes coding.all(system.empty() or system = 'http://snomed.info/sct' or system = 'https://alexapi.medtechglobal.com.au/fhir/CodeSystem/daily-frequency')

This structure is derived from AUBaseMedicationStatement

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
Binding: Status for Medication Statement (required)
.... 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 SC 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: Daily Frequency Value Set for Dosage (extensible)
Constraints: medstmt-daily-frequency-system
.... 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)

Path Status Usage ValueSet Version Source
MedicationStatement.​meta.security Base required Definition of Confidentiality Value Set 📦1.0.0 This IG
MedicationStatement.​status Base required Status for Medication Statement 📦1.0.0 This IG
MedicationStatement.​dosage.timing.code Base extensible Daily Frequency Value Set for Dosage 📦1.0.0 This IG
MedicationStatement.​dosage.route Base required Route of Administration 📦1.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
medstmt-daily-frequency-system error MedicationStatement.dosage.timing.code MedicationStatement dosage timing codes must use SNOMED CT or Medtech daily-frequency codes coding.all(system.empty() or system = 'http://snomed.info/sct' or system = 'https://alexapi.medtechglobal.com.au/fhir/CodeSystem/daily-frequency')
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
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 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: Status for Medication Statement (required)
... 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
........ extension: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
Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10
...... 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ΣC 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: Daily Frequency Value Set for Dosage (extensible)
Constraints: medstmt-daily-frequency-system
.... 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

Path Status Usage ValueSet Version Source
MedicationStatement.​meta.security Base required Definition of Confidentiality Value Set 📦1.0.0 This IG
MedicationStatement.​meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
MedicationStatement.​language Base preferred Common Languages 📦4.0.1 FHIR Std.
MedicationStatement.​status Base required Status for Medication Statement 📦1.0.0 This IG
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 preferred PBS Item Codes 📦4.1.0 AU Base Implementation Guide v4.1
MedicationStatement.​medication[x]:medicationCodeableConcept.​coding:gtin Base preferred GTIN 📦3.0.0 THO v5.5
MedicationStatement.​medication[x]:medicationCodeableConcept.​coding:amt Base preferred Australian Medication 📦1.0.0 This IG
MedicationStatement.​medication[x]:medicationCodeableConcept.​coding:mimsPackage Base preferred MIMS 📦4.1.0 AU Base Implementation Guide v4.1
MedicationStatement.​subject.type Base extensible ResourceType 📍4.0.1 FHIR Std.
MedicationStatement.​reasonCode Base preferred Medication Reason Taken 📦1.0.0 This IG
MedicationStatement.​dosage.additionalInstruction Base preferred SNOMED CT Additional Dosage Instructions 📦4.0.1 FHIR Std.
MedicationStatement.​dosage.timing.repeat.​durationUnit Base required UnitsOfTime 📍4.0.1 FHIR Std.
MedicationStatement.​dosage.timing.repeat.​periodUnit Base required UnitsOfTime 📍4.0.1 FHIR Std.
MedicationStatement.​dosage.timing.repeat.​dayOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.
MedicationStatement.​dosage.timing.repeat.​when Base required EventTiming 📍4.0.1 FHIR Std.
MedicationStatement.​dosage.timing.code Base extensible Daily Frequency Value Set for Dosage 📦1.0.0 This IG
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 required Route of Administration 📦1.0.0 This IG
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.

Constraints

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()
medstmt-daily-frequency-system error MedicationStatement.dosage.timing.code MedicationStatement dosage timing codes must use SNOMED CT or Medtech daily-frequency codes coding.all(system.empty() or system = 'http://snomed.info/sct' or system = 'https://alexapi.medtechglobal.com.au/fhir/CodeSystem/daily-frequency')
tim-1 error MedicationStatement.dosage.timing.repeat if there's a duration, there needs to be duration units duration.empty() or durationUnit.exists()
tim-2 error MedicationStatement.dosage.timing.repeat if there's a period, there needs to be period units period.empty() or periodUnit.exists()
tim-4 error MedicationStatement.dosage.timing.repeat duration SHALL be a non-negative value duration.exists() implies duration >= 0
tim-5 error MedicationStatement.dosage.timing.repeat period SHALL be a non-negative value period.exists() implies period >= 0
tim-6 error MedicationStatement.dosage.timing.repeat If there's a periodMax, there must be a period periodMax.empty() or period.exists()
tim-7 error MedicationStatement.dosage.timing.repeat If there's a durationMax, there must be a duration durationMax.empty() or duration.exists()
tim-8 error MedicationStatement.dosage.timing.repeat If there's a countMax, there must be a count countMax.empty() or count.exists()
tim-9 error MedicationStatement.dosage.timing.repeat If 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-10 error MedicationStatement.dosage.timing.repeat If 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 & Constraints    Filter: Filtersdoco
.. MedicationStatement 0..* AUBaseMedicationStatement A record of medication being taken by a patient in an Australian healthcare context
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension: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
... 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.
..... 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)
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
...... coding:gtin Σ 0..* Coding Medication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://www.gs1.org/gtin
...... coding:amt Σ 0..* Coding AMT Medicines
Binding: Australian Medication (preferred)
....... 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)
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... coding:mimsPackage Σ 0..1 Coding MIMS Package
Binding: MIMS (preferred)
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://www.mims.com.au/codes
.... medication[x]:medicationReference Σ 0..1 Reference() Medication Reference
... subject SΣ 1..1 Reference(Patient | Group) Who is/was taking the medication
.... reference ΣC 0..1 string Reference to Patient resource
.... display Σ 0..1 string External Name of Patient
... 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
... note 0..* Annotation Further information about the statement
.... text SΣ 1..1 markdown The annotation - text content (as markdown)
... dosage S 0..* AUBaseDosage Dosage information in an Australian healthcare context
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code SΣC 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: Daily Frequency Value Set for Dosage (extensible)
Constraints: medstmt-daily-frequency-system
.... 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

Path Status Usage ValueSet Version Source
MedicationStatement.​status Base required Status for Medication Statement 📦1.0.0 This IG
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 preferred PBS Item Codes 📦4.1.0 AU Base Implementation Guide v4.1
MedicationStatement.​medication[x]:medicationCodeableConcept.​coding:gtin Base preferred GTIN 📦3.0.0 THO v5.5
MedicationStatement.​medication[x]:medicationCodeableConcept.​coding:amt Base preferred Australian Medication 📦1.0.0 This IG
MedicationStatement.​medication[x]:medicationCodeableConcept.​coding:mimsPackage Base preferred MIMS 📦4.1.0 AU Base Implementation Guide v4.1
MedicationStatement.​dosage.timing.code Base extensible Daily Frequency Value Set for Dosage 📦1.0.0 This IG
MedicationStatement.​dosage.route Base required Route of Administration 📦1.0.0 This IG

Constraints

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()
medstmt-daily-frequency-system error MedicationStatement.dosage.timing.code MedicationStatement dosage timing codes must use SNOMED CT or Medtech daily-frequency codes coding.all(system.empty() or system = 'http://snomed.info/sct' or system = 'https://alexapi.medtechglobal.com.au/fhir/CodeSystem/daily-frequency')

Differential View

This structure is derived from AUBaseMedicationStatement

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
Binding: Status for Medication Statement (required)
.... 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 SC 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: Daily Frequency Value Set for Dosage (extensible)
Constraints: medstmt-daily-frequency-system
.... 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)

Path Status Usage ValueSet Version Source
MedicationStatement.​meta.security Base required Definition of Confidentiality Value Set 📦1.0.0 This IG
MedicationStatement.​status Base required Status for Medication Statement 📦1.0.0 This IG
MedicationStatement.​dosage.timing.code Base extensible Daily Frequency Value Set for Dosage 📦1.0.0 This IG
MedicationStatement.​dosage.route Base required Route of Administration 📦1.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
medstmt-daily-frequency-system error MedicationStatement.dosage.timing.code MedicationStatement dosage timing codes must use SNOMED CT or Medtech daily-frequency codes coding.all(system.empty() or system = 'http://snomed.info/sct' or system = 'https://alexapi.medtechglobal.com.au/fhir/CodeSystem/daily-frequency')

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
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 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: Status for Medication Statement (required)
... 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
........ extension: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
Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10
...... 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ΣC 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: Daily Frequency Value Set for Dosage (extensible)
Constraints: medstmt-daily-frequency-system
.... 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

Path Status Usage ValueSet Version Source
MedicationStatement.​meta.security Base required Definition of Confidentiality Value Set 📦1.0.0 This IG
MedicationStatement.​meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
MedicationStatement.​language Base preferred Common Languages 📦4.0.1 FHIR Std.
MedicationStatement.​status Base required Status for Medication Statement 📦1.0.0 This IG
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 preferred PBS Item Codes 📦4.1.0 AU Base Implementation Guide v4.1
MedicationStatement.​medication[x]:medicationCodeableConcept.​coding:gtin Base preferred GTIN 📦3.0.0 THO v5.5
MedicationStatement.​medication[x]:medicationCodeableConcept.​coding:amt Base preferred Australian Medication 📦1.0.0 This IG
MedicationStatement.​medication[x]:medicationCodeableConcept.​coding:mimsPackage Base preferred MIMS 📦4.1.0 AU Base Implementation Guide v4.1
MedicationStatement.​subject.type Base extensible ResourceType 📍4.0.1 FHIR Std.
MedicationStatement.​reasonCode Base preferred Medication Reason Taken 📦1.0.0 This IG
MedicationStatement.​dosage.additionalInstruction Base preferred SNOMED CT Additional Dosage Instructions 📦4.0.1 FHIR Std.
MedicationStatement.​dosage.timing.repeat.​durationUnit Base required UnitsOfTime 📍4.0.1 FHIR Std.
MedicationStatement.​dosage.timing.repeat.​periodUnit Base required UnitsOfTime 📍4.0.1 FHIR Std.
MedicationStatement.​dosage.timing.repeat.​dayOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.
MedicationStatement.​dosage.timing.repeat.​when Base required EventTiming 📍4.0.1 FHIR Std.
MedicationStatement.​dosage.timing.code Base extensible Daily Frequency Value Set for Dosage 📦1.0.0 This IG
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 required Route of Administration 📦1.0.0 This IG
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.

Constraints

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()
medstmt-daily-frequency-system error MedicationStatement.dosage.timing.code MedicationStatement dosage timing codes must use SNOMED CT or Medtech daily-frequency codes coding.all(system.empty() or system = 'http://snomed.info/sct' or system = 'https://alexapi.medtechglobal.com.au/fhir/CodeSystem/daily-frequency')
tim-1 error MedicationStatement.dosage.timing.repeat if there's a duration, there needs to be duration units duration.empty() or durationUnit.exists()
tim-2 error MedicationStatement.dosage.timing.repeat if there's a period, there needs to be period units period.empty() or periodUnit.exists()
tim-4 error MedicationStatement.dosage.timing.repeat duration SHALL be a non-negative value duration.exists() implies duration >= 0
tim-5 error MedicationStatement.dosage.timing.repeat period SHALL be a non-negative value period.exists() implies period >= 0
tim-6 error MedicationStatement.dosage.timing.repeat If there's a periodMax, there must be a period periodMax.empty() or period.exists()
tim-7 error MedicationStatement.dosage.timing.repeat If there's a durationMax, there must be a duration durationMax.empty() or duration.exists()
tim-8 error MedicationStatement.dosage.timing.repeat If there's a countMax, there must be a count countMax.empty() or count.exists()
tim-9 error MedicationStatement.dosage.timing.repeat If 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-10 error MedicationStatement.dosage.timing.repeat If 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