FHIR New Zealand Patient Summary IG
0.7.0 - ci-build NZ

FHIR New Zealand Patient Summary IG - Local Development build (v0.7.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: NZPS-MedicationStatement

Official URL: https://fhir-ig.digital.health.nz/nzps/StructureDefinition/nzps-medicationstatement Version: 0.7.0
Active as of 2026-04-10 Realm: New Zealand flag Computable Name: NZPSMedicationStatement

A record of medication being taken is represented in the patient summary as an instance of an MedicationStatement resource constrained by this profile. Based on the IPS profile.

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..* MedicationStatementIPS Record of medication being taken by a patient
This profile also imposes the profile MedicationStatement resource for use in NZ
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 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.
.... medicationCodeableConcept CodeableConcept(CodeableConceptIPS)
.... medicationReference Reference(Medication (IPS))
.... medication[x]:medicationCodeableConcept SOΣ 0..1 CodeableConceptIPS What medication was taken
Binding: Medications - IPS (preferred): SNOMED CT medications (Medicinal product) or a code for absent/unknown medication
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationStatement (IPS)
SHALL:handle Consumer (IPS) from MedicationStatement (IPS)
SHOULD:display Consumer (IPS) from MedicationStatement (IPS)
..... Slices for coding SOΣ 0..* CodingIPS Code defined by a terminology system
Slice: Unordered, Open by value:system
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Codeable Concept (IPS)
SHALL:handle Consumer (IPS) from Codeable Concept (IPS)
...... coding:NZMT SOΣ 0..* CodingIPS New Zealand Medicines Terminology
Binding: http://nzmt.org.nz/vs (preferred)
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Codeable Concept (IPS)
SHALL:handle Consumer (IPS) from Codeable Concept (IPS)
....... Slices for extension Content/Rules for all slices
........ extension:nzf-nzmt-tpe 0..1 CodeableConcept Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-nzmt-type
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/nzmt-type (required)
....... system SOΣ 1..1 uri Identity of the terminology system
Fixed Value: http://nzmt.org.nz
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Coding with translations
SHALL:handle Consumer (IPS) from Coding with translations
....... code SOΣ 0..1 code Symbol in syntax defined by the system
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Coding with translations
SHALL:handle Consumer (IPS) from Coding with translations
...... coding:GTIN SOΣ 0..* CodingIPS Medication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Codeable Concept (IPS)
SHALL:handle Consumer (IPS) from Codeable Concept (IPS)
....... system SOΣ 1..1 uri Identity of the terminology system
Fixed Value: http://www.gs1.org/gtin
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Coding with translations
SHALL:handle Consumer (IPS) from Coding with translations
....... code SOΣ 0..1 code Symbol in syntax defined by the system
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Coding with translations
SHALL:handle Consumer (IPS) from Coding with translations
..... text SOΣ 0..1 string Plain text representation of the concept
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Codeable Concept (IPS)
SHALL:handle Consumer (IPS) from Codeable Concept (IPS)
SHOULD:display Consumer (IPS) from Codeable Concept (IPS)
...... Slices for extension Content/Rules for all slices
....... extension:translation 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1]] Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1
... subject SOΣ 1..1 Reference(Patient (IPS)) Who is/was taking the medication
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationStatement (IPS)
SHALL:handle Consumer (IPS) from MedicationStatement (IPS)
SHOULD:display Consumer (IPS) from MedicationStatement (IPS)
.... reference SOΣC 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationStatement (IPS)
SHALL:handle Consumer (IPS) from MedicationStatement (IPS)
... Slices for effective[x] SOΣ 1..1 The date/time or interval when the medication is/was/will be taken
Slice: Unordered, Open by type:$this
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationStatement (IPS)
SHALL:handle Consumer (IPS) from MedicationStatement (IPS)
SHOULD:display Consumer (IPS) from MedicationStatement (IPS)
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effective[x]:effectiveDateTime SOΣ 0..1 dateTime The date/time or interval when the medication is/was/will be taken
ObligationsActorSource
SHOULD:able-to-populate Creator (IPS) from MedicationStatement (IPS)
SHALL:handle Consumer (IPS) from MedicationStatement (IPS)
SHOULD:display Consumer (IPS) from MedicationStatement (IPS)
... dosage SO 0..* Dosage Details of how medication is/was taken or should be taken
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationStatement (IPS)
SHALL:handle Consumer (IPS) from MedicationStatement (IPS)
SHOULD:display Consumer (IPS) from MedicationStatement (IPS)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... text SOΣ 0..1 string Free text dosage instructions e.g. SIG
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationStatement (IPS)
SHALL:handle Consumer (IPS) from MedicationStatement (IPS)
SHOULD:display Consumer (IPS) from MedicationStatement (IPS)
.... timing SOΣ 0..1 Timing When medication should be administered
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationStatement (IPS)
SHALL:handle Consumer (IPS) from MedicationStatement (IPS)
SHOULD:display Consumer (IPS) from MedicationStatement (IPS)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationStatement.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1
From the FHIR Standard
MedicationStatement.medication[x]preferredMedicationsUvIps
http://hl7.org/fhir/uv/ips/ValueSet/medication-uv-ips
MedicationStatement.medication[x]:medicationCodeableConceptpreferredMedicationsUvIps
http://hl7.org/fhir/uv/ips/ValueSet/medication-uv-ips
MedicationStatement.medication[x]:medicationCodeableConcept.coding:NZMTpreferredhttp://nzmt.org.nz/vs
http://nzmt.org.nz/vs
MedicationStatement.medication[x]:medicationCodeableConcept.coding:GTINpreferredGTIN
http://terminology.hl7.org/ValueSet/v3-GTIN

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 MedicationStatementIPS

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationStatement MedicationStatementIPS This profile also imposes the profile MedicationStatement resource for use in NZ
... Slices for medication[x] 1..1 CodeableConceptIPS, Reference(Medication (IPS)) What medication was taken
Slice: Unordered, Open by type:$this
.... medication[x]:medicationCodeableConcept 0..1 CodeableConceptIPS What medication was taken
..... Slices for coding 0..* CodingIPS Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:NZMT 0..* CodingIPS New Zealand Medicines Terminology
Binding: http://nzmt.org.nz/vs (preferred)
....... Slices for extension Content/Rules for all slices
........ extension:nzf-nzmt-tpe 0..1 CodeableConcept Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-nzmt-type
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/nzmt-type (required)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://nzmt.org.nz
...... coding:GTIN 0..* CodingIPS 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

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MedicationStatement.medication[x]:medicationCodeableConcept.coding:NZMTpreferredhttp://nzmt.org.nz/vs
http://nzmt.org.nz/vs
MedicationStatement.medication[x]:medicationCodeableConcept.coding:GTINpreferredGTIN
http://terminology.hl7.org/ValueSet/v3-GTIN
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationStatement 0..* MedicationStatementIPS Record of medication being taken by a patient
This profile also imposes the profile MedicationStatement resource for use in NZ
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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
... extension 0..* Extension Additional content defined by implementations
... 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 ?!Σ 1..1 code active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken
Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement.
... statusReason 0..* CodeableConcept Reason for current status
Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement.
... category Σ 0..1 CodeableConcept Type of medication usage
Binding: Medication usage category codes (preferred): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered.
... Slices for medication[x] SOΣ 1..1 What medication was taken
Slice: Unordered, Open by type:$this
Binding: Medications - IPS (preferred): SNOMED CT medications (Medicinal product) or a code for absent/unknown medication
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationStatement (IPS)
SHALL:handle Consumer (IPS) from MedicationStatement (IPS)
SHOULD:display Consumer (IPS) from MedicationStatement (IPS)
.... medicationCodeableConcept CodeableConcept(CodeableConceptIPS)
.... medicationReference Reference(Medication (IPS))
.... medication[x]:medicationCodeableConcept SOΣ 0..1 CodeableConceptIPS What medication was taken
Binding: Medications - IPS (preferred): SNOMED CT medications (Medicinal product) or a code for absent/unknown medication
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationStatement (IPS)
SHALL:handle Consumer (IPS) from MedicationStatement (IPS)
SHOULD:display Consumer (IPS) from MedicationStatement (IPS)
..... 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 SOΣ 0..* CodingIPS Code defined by a terminology system
Slice: Unordered, Open by value:system
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Codeable Concept (IPS)
SHALL:handle Consumer (IPS) from Codeable Concept (IPS)
...... coding:NZMT SOΣ 0..* CodingIPS New Zealand Medicines Terminology
Binding: http://nzmt.org.nz/vs (preferred)
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Codeable Concept (IPS)
SHALL:handle Consumer (IPS) from Codeable Concept (IPS)
....... id 0..1 string Unique id for inter-element referencing
....... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ extension:nzf-nzmt-tpe 0..1 CodeableConcept Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-nzmt-type
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/nzmt-type (required)
....... system SOΣ 1..1 uri Identity of the terminology system
Fixed Value: http://nzmt.org.nz
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Coding with translations
SHALL:handle Consumer (IPS) from Coding with translations
....... version Σ 0..1 string Version of the system - if relevant
....... code SOΣ 0..1 code Symbol in syntax defined by the system
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Coding with translations
SHALL:handle Consumer (IPS) from Coding with translations
....... display Σ 0..1 string Text representation defined by the system
........ id 0..1 string xml:id (or equivalent in JSON)
........ Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
......... extension:translation 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1]] Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1
........ value 0..1 string Primitive value for string
Max Length:1048576
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... coding:GTIN SOΣ 0..* CodingIPS Medication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Codeable Concept (IPS)
SHALL:handle Consumer (IPS) from Codeable Concept (IPS)
....... 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 SOΣ 1..1 uri Identity of the terminology system
Fixed Value: http://www.gs1.org/gtin
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Coding with translations
SHALL:handle Consumer (IPS) from Coding with translations
....... version Σ 0..1 string Version of the system - if relevant
....... code SOΣ 0..1 code Symbol in syntax defined by the system
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Coding with translations
SHALL:handle Consumer (IPS) from Coding with translations
....... display Σ 0..1 string Text representation defined by the system
........ id 0..1 string xml:id (or equivalent in JSON)
........ Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
......... extension:translation 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1]] Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1
........ value 0..1 string Primitive value for string
Max Length:1048576
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text SOΣ 0..1 string Plain text representation of the concept
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Codeable Concept (IPS)
SHALL:handle Consumer (IPS) from Codeable Concept (IPS)
SHOULD:display Consumer (IPS) from Codeable Concept (IPS)
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:translation 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1]] Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1
...... value 0..1 string Primitive value for string
Max Length:1048576
... subject SOΣ 1..1 Reference(Patient (IPS)) Who is/was taking the medication
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationStatement (IPS)
SHALL:handle Consumer (IPS) from MedicationStatement (IPS)
SHOULD:display Consumer (IPS) from MedicationStatement (IPS)
.... 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 SOΣC 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationStatement (IPS)
SHALL:handle Consumer (IPS) from MedicationStatement (IPS)
.... 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 Text alternative for the resource
... context Σ 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with MedicationStatement
... Slices for effective[x] SOΣ 1..1 The date/time or interval when the medication is/was/will be taken
Slice: Unordered, Open by type:$this
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationStatement (IPS)
SHALL:handle Consumer (IPS) from MedicationStatement (IPS)
SHOULD:display Consumer (IPS) from MedicationStatement (IPS)
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effective[x]:effectiveDateTime SOΣ 0..1 dateTime The date/time or interval when the medication is/was/will be taken
ObligationsActorSource
SHOULD:able-to-populate Creator (IPS) from MedicationStatement (IPS)
SHALL:handle Consumer (IPS) from MedicationStatement (IPS)
SHOULD:display Consumer (IPS) from MedicationStatement (IPS)
... 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: Condition/Problem/DiagnosisCodes (example): A coded concept identifying why the medication is being taken.
... 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
... dosage SO 0..* Dosage Details of how medication is/was taken or should be taken
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationStatement (IPS)
SHALL:handle Consumer (IPS) from MedicationStatement (IPS)
SHOULD:display Consumer (IPS) from MedicationStatement (IPS)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence Σ 0..1 integer The order of the dosage instructions
.... text SOΣ 0..1 string Free text dosage instructions e.g. SIG
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationStatement (IPS)
SHALL:handle Consumer (IPS) from MedicationStatement (IPS)
SHOULD:display Consumer (IPS) from MedicationStatement (IPS)
.... additionalInstruction Σ 0..* CodeableConcept Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery".
.... patientInstruction Σ 0..1 string Patient or consumer oriented instructions
.... timing SOΣ 0..1 Timing When medication should be administered
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationStatement (IPS)
SHALL:handle Consumer (IPS) from MedicationStatement (IPS)
SHOULD:display Consumer (IPS) from MedicationStatement (IPS)
.... asNeeded[x] Σ 0..1 Take "as needed" (for x)
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc.
..... asNeededBoolean boolean
..... asNeededCodeableConcept CodeableConcept
.... site Σ 0..1 CodeableConcept Body site to administer to
Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body.
.... route Σ 0..1 CodeableConcept How drug should enter body
Binding: SNOMEDCTRouteCodes (preferred): SNOMED Route Terms
Additional BindingsPurpose
Medicine EDQM Route of Administration - IPS candidate
.... method Σ 0..1 CodeableConcept Technique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.
.... doseAndRate Σ 0..* Element Amount of medication administered
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ 0..1 CodeableConcept The kind of dose or rate specified
Binding: DoseAndRateType (example): The kind of dose or rate specified.
..... dose[x] Σ 0..1 Amount of medication per dose
...... doseRange Range
...... doseQuantity Quantity(SimpleQuantity)
..... rate[x] Σ 0..1 Amount of medication per unit of time
...... rateRatio Ratio
...... rateRange Range
...... rateQuantity Quantity(SimpleQuantity)
.... maxDosePerPeriod Σ 0..1 Ratio Upper limit on medication per unit of time
.... maxDosePerAdministration Σ 0..1 SimpleQuantity(4.0.1) Upper limit on medication per administration
.... maxDosePerLifetime Σ 0..1 SimpleQuantity(4.0.1) Upper limit on medication per lifetime of the patient

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationStatement.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages|4.0.1
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
MedicationStatement.statusrequiredMedication Status Codes
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|4.0.1
From the FHIR Standard
MedicationStatement.categorypreferredMedication usage category codes
http://hl7.org/fhir/ValueSet/medication-statement-category|4.0.1
From the FHIR Standard
MedicationStatement.medication[x]preferredMedicationsUvIps
http://hl7.org/fhir/uv/ips/ValueSet/medication-uv-ips
MedicationStatement.medication[x]:medicationCodeableConceptpreferredMedicationsUvIps
http://hl7.org/fhir/uv/ips/ValueSet/medication-uv-ips
MedicationStatement.medication[x]:medicationCodeableConcept.coding:NZMTpreferredhttp://nzmt.org.nz/vs
http://nzmt.org.nz/vs
MedicationStatement.medication[x]:medicationCodeableConcept.coding:GTINpreferredGTIN
http://terminology.hl7.org/ValueSet/v3-GTIN
MedicationStatement.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types|4.0.1
From the FHIR Standard
MedicationStatement.reasonCodeexampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code|4.0.1
From the FHIR Standard
MedicationStatement.dosage.additionalInstructionexampleSNOMEDCTAdditionalDosageInstructions
http://hl7.org/fhir/ValueSet/additional-instruction-codes|4.0.1
From the FHIR Standard
MedicationStatement.dosage.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
http://hl7.org/fhir/ValueSet/medication-as-needed-reason|4.0.1
From the FHIR Standard
MedicationStatement.dosage.siteexampleSNOMEDCTAnatomicalStructureForAdministrationSiteCodes
http://hl7.org/fhir/ValueSet/approach-site-codes|4.0.1
From the FHIR Standard
MedicationStatement.dosage.routepreferredSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
From the FHIR Standard
MedicationStatement.dosage.methodexampleSNOMEDCTAdministrationMethodCodes
http://hl7.org/fhir/ValueSet/administration-method-codes|4.0.1
From the FHIR Standard
MedicationStatement.dosage.doseAndRate.typeexampleDoseAndRateType
http://hl7.org/fhir/ValueSet/dose-rate-type|4.0.1
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()

This structure is derived from MedicationStatementIPS

Summary

Mandatory: 0 element(2 nested mandatory elements)
Fixed: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationStatement 0..* MedicationStatementIPS Record of medication being taken by a patient
This profile also imposes the profile MedicationStatement resource for use in NZ
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 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.
.... medicationCodeableConcept CodeableConcept(CodeableConceptIPS)
.... medicationReference Reference(Medication (IPS))
.... medication[x]:medicationCodeableConcept SOΣ 0..1 CodeableConceptIPS What medication was taken
Binding: Medications - IPS (preferred): SNOMED CT medications (Medicinal product) or a code for absent/unknown medication
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationStatement (IPS)
SHALL:handle Consumer (IPS) from MedicationStatement (IPS)
SHOULD:display Consumer (IPS) from MedicationStatement (IPS)
..... Slices for coding SOΣ 0..* CodingIPS Code defined by a terminology system
Slice: Unordered, Open by value:system
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Codeable Concept (IPS)
SHALL:handle Consumer (IPS) from Codeable Concept (IPS)
...... coding:NZMT SOΣ 0..* CodingIPS New Zealand Medicines Terminology
Binding: http://nzmt.org.nz/vs (preferred)
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Codeable Concept (IPS)
SHALL:handle Consumer (IPS) from Codeable Concept (IPS)
....... Slices for extension Content/Rules for all slices
........ extension:nzf-nzmt-tpe 0..1 CodeableConcept Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-nzmt-type
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/nzmt-type (required)
....... system SOΣ 1..1 uri Identity of the terminology system
Fixed Value: http://nzmt.org.nz
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Coding with translations
SHALL:handle Consumer (IPS) from Coding with translations
....... code SOΣ 0..1 code Symbol in syntax defined by the system
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Coding with translations
SHALL:handle Consumer (IPS) from Coding with translations
...... coding:GTIN SOΣ 0..* CodingIPS Medication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Codeable Concept (IPS)
SHALL:handle Consumer (IPS) from Codeable Concept (IPS)
....... system SOΣ 1..1 uri Identity of the terminology system
Fixed Value: http://www.gs1.org/gtin
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Coding with translations
SHALL:handle Consumer (IPS) from Coding with translations
....... code SOΣ 0..1 code Symbol in syntax defined by the system
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Coding with translations
SHALL:handle Consumer (IPS) from Coding with translations
..... text SOΣ 0..1 string Plain text representation of the concept
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Codeable Concept (IPS)
SHALL:handle Consumer (IPS) from Codeable Concept (IPS)
SHOULD:display Consumer (IPS) from Codeable Concept (IPS)
...... Slices for extension Content/Rules for all slices
....... extension:translation 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1]] Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1
... subject SOΣ 1..1 Reference(Patient (IPS)) Who is/was taking the medication
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationStatement (IPS)
SHALL:handle Consumer (IPS) from MedicationStatement (IPS)
SHOULD:display Consumer (IPS) from MedicationStatement (IPS)
.... reference SOΣC 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationStatement (IPS)
SHALL:handle Consumer (IPS) from MedicationStatement (IPS)
... Slices for effective[x] SOΣ 1..1 The date/time or interval when the medication is/was/will be taken
Slice: Unordered, Open by type:$this
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationStatement (IPS)
SHALL:handle Consumer (IPS) from MedicationStatement (IPS)
SHOULD:display Consumer (IPS) from MedicationStatement (IPS)
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effective[x]:effectiveDateTime SOΣ 0..1 dateTime The date/time or interval when the medication is/was/will be taken
ObligationsActorSource
SHOULD:able-to-populate Creator (IPS) from MedicationStatement (IPS)
SHALL:handle Consumer (IPS) from MedicationStatement (IPS)
SHOULD:display Consumer (IPS) from MedicationStatement (IPS)
... dosage SO 0..* Dosage Details of how medication is/was taken or should be taken
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationStatement (IPS)
SHALL:handle Consumer (IPS) from MedicationStatement (IPS)
SHOULD:display Consumer (IPS) from MedicationStatement (IPS)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... text SOΣ 0..1 string Free text dosage instructions e.g. SIG
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationStatement (IPS)
SHALL:handle Consumer (IPS) from MedicationStatement (IPS)
SHOULD:display Consumer (IPS) from MedicationStatement (IPS)
.... timing SOΣ 0..1 Timing When medication should be administered
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationStatement (IPS)
SHALL:handle Consumer (IPS) from MedicationStatement (IPS)
SHOULD:display Consumer (IPS) from MedicationStatement (IPS)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationStatement.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1
From the FHIR Standard
MedicationStatement.medication[x]preferredMedicationsUvIps
http://hl7.org/fhir/uv/ips/ValueSet/medication-uv-ips
MedicationStatement.medication[x]:medicationCodeableConceptpreferredMedicationsUvIps
http://hl7.org/fhir/uv/ips/ValueSet/medication-uv-ips
MedicationStatement.medication[x]:medicationCodeableConcept.coding:NZMTpreferredhttp://nzmt.org.nz/vs
http://nzmt.org.nz/vs
MedicationStatement.medication[x]:medicationCodeableConcept.coding:GTINpreferredGTIN
http://terminology.hl7.org/ValueSet/v3-GTIN

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 MedicationStatementIPS

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationStatement MedicationStatementIPS This profile also imposes the profile MedicationStatement resource for use in NZ
... Slices for medication[x] 1..1 CodeableConceptIPS, Reference(Medication (IPS)) What medication was taken
Slice: Unordered, Open by type:$this
.... medication[x]:medicationCodeableConcept 0..1 CodeableConceptIPS What medication was taken
..... Slices for coding 0..* CodingIPS Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:NZMT 0..* CodingIPS New Zealand Medicines Terminology
Binding: http://nzmt.org.nz/vs (preferred)
....... Slices for extension Content/Rules for all slices
........ extension:nzf-nzmt-tpe 0..1 CodeableConcept Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-nzmt-type
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/nzmt-type (required)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://nzmt.org.nz
...... coding:GTIN 0..* CodingIPS 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

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MedicationStatement.medication[x]:medicationCodeableConcept.coding:NZMTpreferredhttp://nzmt.org.nz/vs
http://nzmt.org.nz/vs
MedicationStatement.medication[x]:medicationCodeableConcept.coding:GTINpreferredGTIN
http://terminology.hl7.org/ValueSet/v3-GTIN

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationStatement 0..* MedicationStatementIPS Record of medication being taken by a patient
This profile also imposes the profile MedicationStatement resource for use in NZ
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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
... extension 0..* Extension Additional content defined by implementations
... 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 ?!Σ 1..1 code active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken
Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement.
... statusReason 0..* CodeableConcept Reason for current status
Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement.
... category Σ 0..1 CodeableConcept Type of medication usage
Binding: Medication usage category codes (preferred): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered.
... Slices for medication[x] SOΣ 1..1 What medication was taken
Slice: Unordered, Open by type:$this
Binding: Medications - IPS (preferred): SNOMED CT medications (Medicinal product) or a code for absent/unknown medication
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationStatement (IPS)
SHALL:handle Consumer (IPS) from MedicationStatement (IPS)
SHOULD:display Consumer (IPS) from MedicationStatement (IPS)
.... medicationCodeableConcept CodeableConcept(CodeableConceptIPS)
.... medicationReference Reference(Medication (IPS))
.... medication[x]:medicationCodeableConcept SOΣ 0..1 CodeableConceptIPS What medication was taken
Binding: Medications - IPS (preferred): SNOMED CT medications (Medicinal product) or a code for absent/unknown medication
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationStatement (IPS)
SHALL:handle Consumer (IPS) from MedicationStatement (IPS)
SHOULD:display Consumer (IPS) from MedicationStatement (IPS)
..... 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 SOΣ 0..* CodingIPS Code defined by a terminology system
Slice: Unordered, Open by value:system
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Codeable Concept (IPS)
SHALL:handle Consumer (IPS) from Codeable Concept (IPS)
...... coding:NZMT SOΣ 0..* CodingIPS New Zealand Medicines Terminology
Binding: http://nzmt.org.nz/vs (preferred)
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Codeable Concept (IPS)
SHALL:handle Consumer (IPS) from Codeable Concept (IPS)
....... id 0..1 string Unique id for inter-element referencing
....... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ extension:nzf-nzmt-tpe 0..1 CodeableConcept Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-nzmt-type
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/nzmt-type (required)
....... system SOΣ 1..1 uri Identity of the terminology system
Fixed Value: http://nzmt.org.nz
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Coding with translations
SHALL:handle Consumer (IPS) from Coding with translations
....... version Σ 0..1 string Version of the system - if relevant
....... code SOΣ 0..1 code Symbol in syntax defined by the system
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Coding with translations
SHALL:handle Consumer (IPS) from Coding with translations
....... display Σ 0..1 string Text representation defined by the system
........ id 0..1 string xml:id (or equivalent in JSON)
........ Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
......... extension:translation 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1]] Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1
........ value 0..1 string Primitive value for string
Max Length:1048576
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... coding:GTIN SOΣ 0..* CodingIPS Medication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Codeable Concept (IPS)
SHALL:handle Consumer (IPS) from Codeable Concept (IPS)
....... 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 SOΣ 1..1 uri Identity of the terminology system
Fixed Value: http://www.gs1.org/gtin
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Coding with translations
SHALL:handle Consumer (IPS) from Coding with translations
....... version Σ 0..1 string Version of the system - if relevant
....... code SOΣ 0..1 code Symbol in syntax defined by the system
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Coding with translations
SHALL:handle Consumer (IPS) from Coding with translations
....... display Σ 0..1 string Text representation defined by the system
........ id 0..1 string xml:id (or equivalent in JSON)
........ Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
......... extension:translation 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1]] Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1
........ value 0..1 string Primitive value for string
Max Length:1048576
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text SOΣ 0..1 string Plain text representation of the concept
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from Codeable Concept (IPS)
SHALL:handle Consumer (IPS) from Codeable Concept (IPS)
SHOULD:display Consumer (IPS) from Codeable Concept (IPS)
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:translation 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1]] Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation|5.3.0-ballot-tc1
...... value 0..1 string Primitive value for string
Max Length:1048576
... subject SOΣ 1..1 Reference(Patient (IPS)) Who is/was taking the medication
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationStatement (IPS)
SHALL:handle Consumer (IPS) from MedicationStatement (IPS)
SHOULD:display Consumer (IPS) from MedicationStatement (IPS)
.... 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 SOΣC 1..1 string Literal reference, Relative, internal or absolute URL
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationStatement (IPS)
SHALL:handle Consumer (IPS) from MedicationStatement (IPS)
.... 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 Text alternative for the resource
... context Σ 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with MedicationStatement
... Slices for effective[x] SOΣ 1..1 The date/time or interval when the medication is/was/will be taken
Slice: Unordered, Open by type:$this
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationStatement (IPS)
SHALL:handle Consumer (IPS) from MedicationStatement (IPS)
SHOULD:display Consumer (IPS) from MedicationStatement (IPS)
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effective[x]:effectiveDateTime SOΣ 0..1 dateTime The date/time or interval when the medication is/was/will be taken
ObligationsActorSource
SHOULD:able-to-populate Creator (IPS) from MedicationStatement (IPS)
SHALL:handle Consumer (IPS) from MedicationStatement (IPS)
SHOULD:display Consumer (IPS) from MedicationStatement (IPS)
... 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: Condition/Problem/DiagnosisCodes (example): A coded concept identifying why the medication is being taken.
... 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
... dosage SO 0..* Dosage Details of how medication is/was taken or should be taken
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationStatement (IPS)
SHALL:handle Consumer (IPS) from MedicationStatement (IPS)
SHOULD:display Consumer (IPS) from MedicationStatement (IPS)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence Σ 0..1 integer The order of the dosage instructions
.... text SOΣ 0..1 string Free text dosage instructions e.g. SIG
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationStatement (IPS)
SHALL:handle Consumer (IPS) from MedicationStatement (IPS)
SHOULD:display Consumer (IPS) from MedicationStatement (IPS)
.... additionalInstruction Σ 0..* CodeableConcept Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery".
.... patientInstruction Σ 0..1 string Patient or consumer oriented instructions
.... timing SOΣ 0..1 Timing When medication should be administered
ObligationsActorSource
SHALL:populate-if-known Creator (IPS) from MedicationStatement (IPS)
SHALL:handle Consumer (IPS) from MedicationStatement (IPS)
SHOULD:display Consumer (IPS) from MedicationStatement (IPS)
.... asNeeded[x] Σ 0..1 Take "as needed" (for x)
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc.
..... asNeededBoolean boolean
..... asNeededCodeableConcept CodeableConcept
.... site Σ 0..1 CodeableConcept Body site to administer to
Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body.
.... route Σ 0..1 CodeableConcept How drug should enter body
Binding: SNOMEDCTRouteCodes (preferred): SNOMED Route Terms
Additional BindingsPurpose
Medicine EDQM Route of Administration - IPS candidate
.... method Σ 0..1 CodeableConcept Technique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.
.... doseAndRate Σ 0..* Element Amount of medication administered
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ 0..1 CodeableConcept The kind of dose or rate specified
Binding: DoseAndRateType (example): The kind of dose or rate specified.
..... dose[x] Σ 0..1 Amount of medication per dose
...... doseRange Range
...... doseQuantity Quantity(SimpleQuantity)
..... rate[x] Σ 0..1 Amount of medication per unit of time
...... rateRatio Ratio
...... rateRange Range
...... rateQuantity Quantity(SimpleQuantity)
.... maxDosePerPeriod Σ 0..1 Ratio Upper limit on medication per unit of time
.... maxDosePerAdministration Σ 0..1 SimpleQuantity(4.0.1) Upper limit on medication per administration
.... maxDosePerLifetime Σ 0..1 SimpleQuantity(4.0.1) Upper limit on medication per lifetime of the patient

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationStatement.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages|4.0.1
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
MedicationStatement.statusrequiredMedication Status Codes
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|4.0.1
From the FHIR Standard
MedicationStatement.categorypreferredMedication usage category codes
http://hl7.org/fhir/ValueSet/medication-statement-category|4.0.1
From the FHIR Standard
MedicationStatement.medication[x]preferredMedicationsUvIps
http://hl7.org/fhir/uv/ips/ValueSet/medication-uv-ips
MedicationStatement.medication[x]:medicationCodeableConceptpreferredMedicationsUvIps
http://hl7.org/fhir/uv/ips/ValueSet/medication-uv-ips
MedicationStatement.medication[x]:medicationCodeableConcept.coding:NZMTpreferredhttp://nzmt.org.nz/vs
http://nzmt.org.nz/vs
MedicationStatement.medication[x]:medicationCodeableConcept.coding:GTINpreferredGTIN
http://terminology.hl7.org/ValueSet/v3-GTIN
MedicationStatement.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types|4.0.1
From the FHIR Standard
MedicationStatement.reasonCodeexampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code|4.0.1
From the FHIR Standard
MedicationStatement.dosage.additionalInstructionexampleSNOMEDCTAdditionalDosageInstructions
http://hl7.org/fhir/ValueSet/additional-instruction-codes|4.0.1
From the FHIR Standard
MedicationStatement.dosage.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
http://hl7.org/fhir/ValueSet/medication-as-needed-reason|4.0.1
From the FHIR Standard
MedicationStatement.dosage.siteexampleSNOMEDCTAnatomicalStructureForAdministrationSiteCodes
http://hl7.org/fhir/ValueSet/approach-site-codes|4.0.1
From the FHIR Standard
MedicationStatement.dosage.routepreferredSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
From the FHIR Standard
MedicationStatement.dosage.methodexampleSNOMEDCTAdministrationMethodCodes
http://hl7.org/fhir/ValueSet/administration-method-codes|4.0.1
From the FHIR Standard
MedicationStatement.dosage.doseAndRate.typeexampleDoseAndRateType
http://hl7.org/fhir/ValueSet/dose-rate-type|4.0.1
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()

This structure is derived from MedicationStatementIPS

Summary

Mandatory: 0 element(2 nested mandatory elements)
Fixed: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel, Schematron