FHIR New Zealand Patient Summary IG
0.3.0 - ci-build
FHIR New Zealand Patient Summary IG, published by Health NZ | Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/fhir-nzps/ and changes regularly. See the Directory of published versions
Official URL: https://standards.digital.health.nz/fhir/StructureDefinition/nzps-medicationstatement | Version: 0.3.0 | |||
Active as of 2024-11-22 | 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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MedicationStatementIPS
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationStatement | MedicationStatementIPS | This profile also imposes the profile MedicationStatement resource for use in NZ | ||
Slices for medication[x] | 1..1 | Reference(Medication (IPS)), CodeableConceptIPS | What medication was taken Slice: Unordered, Open by type:$this | |
medication[x]:medicationCodeableConcept | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text | |
Slices for coding | 0..* | CodingIPS | A reference to a 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 | |||
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/vs | |
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 | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
MedicationStatement.medication[x]:medicationCodeableConcept.coding:NZMT | preferred | http://nzmt.org.nz/vshttp://nzmt.org.nz/vs | |
MedicationStatement.medication[x]:medicationCodeableConcept.coding:GTIN | preferred | GTINhttp://terminology.hl7.org/ValueSet/v3-GTIN |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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. |
Slices for medication[x] | SΣ | 1..1 | What medication was taken Slice: Unordered, Open by type:$this Binding: Medications - SNOMED CT + Absent/Unknown (IPS) (preferred): SNOMED CT medications (Pharmaceutical / biologic product) or a code for absent/unknown medication | |
medicationReference | Reference(Medication (IPS)) | |||
medicationCodeableConcept | CodeableConcept(CodeableConceptIPS) | |||
medication[x]:medicationCodeableConcept | S | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Medications - SNOMED CT + Absent/Unknown (IPS) (preferred): SNOMED CT medications (Pharmaceutical / biologic product) or a code for absent/unknown medication |
Slices for coding | S | 0..* | CodingIPS | A reference to a code defined by a terminology system Slice: Unordered, Open by value:system |
coding:NZMT | S | 0..* | CodingIPS | New Zealand Medicines Terminology Binding: http://nzmt.org.nz/vs (preferred) |
Slices for extension | Content/Rules for all slices | |||
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 | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://nzmt.org.nz/vs |
code | SΣ | 0..1 | code | Symbol in syntax defined by the system |
display | SΣ | 0..1 | string | Representation defined by the system |
Slices for extension | Content/Rules for all slices | |||
translation | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation | |
coding:GTIN | S | 0..* | CodingIPS | Medication Package Global Trade Item Number (GTIN) Binding: GTIN (preferred) |
system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.gs1.org/gtin |
code | SΣ | 0..1 | code | Symbol in syntax defined by the system |
display | SΣ | 0..1 | string | Representation defined by the system |
Slices for extension | Content/Rules for all slices | |||
translation | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation | |
text | SΣ | 0..1 | string | Plain text representation of the concept |
subject | SΣ | 1..1 | Reference(Patient (IPS)) | Who is/was taking the medication |
reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
effective[x] | SΣ | 1..1 | The date/time or interval when the medication is/was/will be taken | |
effective[x]All Types | Content/Rules for all Types | |||
Slices for extension | Content/Rules for all slices | |||
data-absent-reason | S | 0..1 | code | effective[x] absence reason URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
dosage | S | 0..* | Dosage | Details of how medication is/was taken or should be taken |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
text | SΣ | 0..1 | string | Free text dosage instructions e.g. SIG |
timing | SΣ | 0..1 | Timing | When medication should be administered |
Documentation for this format |
Path | Conformance | ValueSet | URI |
MedicationStatement.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1 from the FHIR Standard | |
MedicationStatement.medication[x] | preferred | MedicationSnomedCodesAbsentUnknownhttp://hl7.org/fhir/uv/ips/ValueSet/medication-snomed-absent-unknown-uv-ips | |
MedicationStatement.medication[x]:medicationCodeableConcept | preferred | MedicationSnomedCodesAbsentUnknownhttp://hl7.org/fhir/uv/ips/ValueSet/medication-snomed-absent-unknown-uv-ips | |
MedicationStatement.medication[x]:medicationCodeableConcept.coding:NZMT | preferred | http://nzmt.org.nz/vshttp://nzmt.org.nz/vs | |
MedicationStatement.medication[x]:medicationCodeableConcept.coding:GTIN | preferred | GTINhttp://terminology.hl7.org/ValueSet/v3-GTIN |
Id | Grade | Path(s) | Details | Requirements |
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() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
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 | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
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] | SΣ | 1..1 | What medication was taken Slice: Unordered, Open by type:$this Binding: Medications - SNOMED CT + Absent/Unknown (IPS) (preferred): SNOMED CT medications (Pharmaceutical / biologic product) or a code for absent/unknown medication | |||||
medicationReference | Reference(Medication (IPS)) | |||||||
medicationCodeableConcept | CodeableConcept(CodeableConceptIPS) | |||||||
medication[x]:medicationCodeableConcept | S | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Medications - SNOMED CT + Absent/Unknown (IPS) (preferred): SNOMED CT medications (Pharmaceutical / biologic product) or a code for absent/unknown 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 | |||||
Slices for coding | S | 0..* | CodingIPS | A reference to a code defined by a terminology system Slice: Unordered, Open by value:system | ||||
coding:NZMT | S | 0..* | CodingIPS | New Zealand Medicines Terminology Binding: http://nzmt.org.nz/vs (preferred) | ||||
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 | |||||
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 | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://nzmt.org.nz/vs | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | SΣ | 0..1 | string | 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 | |||||
translation | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation | |||||
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 | S | 0..* | CodingIPS | 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 | SΣ | 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 | SΣ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | SΣ | 0..1 | string | 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 | |||||
translation | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation | |||||
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 | SΣ | 0..1 | string | Plain text representation of the concept | ||||
subject | SΣ | 1..1 | Reference(Patient (IPS)) | 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 | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
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 | ||||
effective[x] | SΣ | 1..1 | The date/time or interval when the medication is/was/will be taken | |||||
effective[x]All Types | Content/Rules for all Types | |||||||
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 | |||||
data-absent-reason | S | 0..1 | code | effective[x] absence reason URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) | ||||
effectiveDateTime | dateTime | |||||||
effectivePeriod | Period | |||||||
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 | S | 0..* | Dosage | Details of how medication is/was taken or should be taken | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
sequence | Σ | 0..1 | integer | The order of the dosage instructions | ||||
text | 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 (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 | SΣ | 0..1 | Timing | When medication should be administered | ||||
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 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Medicine Route of Administration - IPS (preferred): EDQM Standards Terms | |||||
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 | Upper limit on medication per administration | ||||
maxDosePerLifetime | Σ | 0..1 | SimpleQuantity | Upper limit on medication per lifetime of the patient | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
MedicationStatement.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
MedicationStatement.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1 from the FHIR Standard | ||||
MedicationStatement.statusReason | example | SNOMEDCTDrugTherapyStatusCodeshttp://hl7.org/fhir/ValueSet/reason-medication-status-codes from the FHIR Standard | ||||
MedicationStatement.category | preferred | Medication usage category codeshttp://hl7.org/fhir/ValueSet/medication-statement-category from the FHIR Standard | ||||
MedicationStatement.medication[x] | preferred | MedicationSnomedCodesAbsentUnknownhttp://hl7.org/fhir/uv/ips/ValueSet/medication-snomed-absent-unknown-uv-ips | ||||
MedicationStatement.medication[x]:medicationCodeableConcept | preferred | MedicationSnomedCodesAbsentUnknownhttp://hl7.org/fhir/uv/ips/ValueSet/medication-snomed-absent-unknown-uv-ips | ||||
MedicationStatement.medication[x]:medicationCodeableConcept.coding:NZMT | preferred | http://nzmt.org.nz/vshttp://nzmt.org.nz/vs | ||||
MedicationStatement.medication[x]:medicationCodeableConcept.coding:GTIN | preferred | GTINhttp://terminology.hl7.org/ValueSet/v3-GTIN | ||||
MedicationStatement.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
MedicationStatement.reasonCode | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard | ||||
MedicationStatement.dosage.additionalInstruction | example | SNOMEDCTAdditionalDosageInstructionshttp://hl7.org/fhir/ValueSet/additional-instruction-codes from the FHIR Standard | ||||
MedicationStatement.dosage.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | ||||
MedicationStatement.dosage.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodeshttp://hl7.org/fhir/ValueSet/approach-site-codes from the FHIR Standard | ||||
MedicationStatement.dosage.route | preferred | MedicineRouteOfAdministrationUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/medicine-route-of-administration | ||||
MedicationStatement.dosage.method | example | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codes from the FHIR Standard | ||||
MedicationStatement.dosage.doseAndRate.type | example | DoseAndRateTypehttp://hl7.org/fhir/ValueSet/dose-rate-type from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | MedicationStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MedicationStatement | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | MedicationStatement | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | MedicationStatement | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MedicationStatement | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from 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:
Differential View
This structure is derived from MedicationStatementIPS
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationStatement | MedicationStatementIPS | This profile also imposes the profile MedicationStatement resource for use in NZ | ||
Slices for medication[x] | 1..1 | Reference(Medication (IPS)), CodeableConceptIPS | What medication was taken Slice: Unordered, Open by type:$this | |
medication[x]:medicationCodeableConcept | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text | |
Slices for coding | 0..* | CodingIPS | A reference to a 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 | |||
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/vs | |
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 | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
MedicationStatement.medication[x]:medicationCodeableConcept.coding:NZMT | preferred | http://nzmt.org.nz/vshttp://nzmt.org.nz/vs | |
MedicationStatement.medication[x]:medicationCodeableConcept.coding:GTIN | preferred | GTINhttp://terminology.hl7.org/ValueSet/v3-GTIN |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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. |
Slices for medication[x] | SΣ | 1..1 | What medication was taken Slice: Unordered, Open by type:$this Binding: Medications - SNOMED CT + Absent/Unknown (IPS) (preferred): SNOMED CT medications (Pharmaceutical / biologic product) or a code for absent/unknown medication | |
medicationReference | Reference(Medication (IPS)) | |||
medicationCodeableConcept | CodeableConcept(CodeableConceptIPS) | |||
medication[x]:medicationCodeableConcept | S | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Medications - SNOMED CT + Absent/Unknown (IPS) (preferred): SNOMED CT medications (Pharmaceutical / biologic product) or a code for absent/unknown medication |
Slices for coding | S | 0..* | CodingIPS | A reference to a code defined by a terminology system Slice: Unordered, Open by value:system |
coding:NZMT | S | 0..* | CodingIPS | New Zealand Medicines Terminology Binding: http://nzmt.org.nz/vs (preferred) |
Slices for extension | Content/Rules for all slices | |||
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 | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://nzmt.org.nz/vs |
code | SΣ | 0..1 | code | Symbol in syntax defined by the system |
display | SΣ | 0..1 | string | Representation defined by the system |
Slices for extension | Content/Rules for all slices | |||
translation | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation | |
coding:GTIN | S | 0..* | CodingIPS | Medication Package Global Trade Item Number (GTIN) Binding: GTIN (preferred) |
system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.gs1.org/gtin |
code | SΣ | 0..1 | code | Symbol in syntax defined by the system |
display | SΣ | 0..1 | string | Representation defined by the system |
Slices for extension | Content/Rules for all slices | |||
translation | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation | |
text | SΣ | 0..1 | string | Plain text representation of the concept |
subject | SΣ | 1..1 | Reference(Patient (IPS)) | Who is/was taking the medication |
reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
effective[x] | SΣ | 1..1 | The date/time or interval when the medication is/was/will be taken | |
effective[x]All Types | Content/Rules for all Types | |||
Slices for extension | Content/Rules for all slices | |||
data-absent-reason | S | 0..1 | code | effective[x] absence reason URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
dosage | S | 0..* | Dosage | Details of how medication is/was taken or should be taken |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
text | SΣ | 0..1 | string | Free text dosage instructions e.g. SIG |
timing | SΣ | 0..1 | Timing | When medication should be administered |
Documentation for this format |
Path | Conformance | ValueSet | URI |
MedicationStatement.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1 from the FHIR Standard | |
MedicationStatement.medication[x] | preferred | MedicationSnomedCodesAbsentUnknownhttp://hl7.org/fhir/uv/ips/ValueSet/medication-snomed-absent-unknown-uv-ips | |
MedicationStatement.medication[x]:medicationCodeableConcept | preferred | MedicationSnomedCodesAbsentUnknownhttp://hl7.org/fhir/uv/ips/ValueSet/medication-snomed-absent-unknown-uv-ips | |
MedicationStatement.medication[x]:medicationCodeableConcept.coding:NZMT | preferred | http://nzmt.org.nz/vshttp://nzmt.org.nz/vs | |
MedicationStatement.medication[x]:medicationCodeableConcept.coding:GTIN | preferred | GTINhttp://terminology.hl7.org/ValueSet/v3-GTIN |
Id | Grade | Path(s) | Details | Requirements |
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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
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 | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
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] | SΣ | 1..1 | What medication was taken Slice: Unordered, Open by type:$this Binding: Medications - SNOMED CT + Absent/Unknown (IPS) (preferred): SNOMED CT medications (Pharmaceutical / biologic product) or a code for absent/unknown medication | |||||
medicationReference | Reference(Medication (IPS)) | |||||||
medicationCodeableConcept | CodeableConcept(CodeableConceptIPS) | |||||||
medication[x]:medicationCodeableConcept | S | 0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Medications - SNOMED CT + Absent/Unknown (IPS) (preferred): SNOMED CT medications (Pharmaceutical / biologic product) or a code for absent/unknown 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 | |||||
Slices for coding | S | 0..* | CodingIPS | A reference to a code defined by a terminology system Slice: Unordered, Open by value:system | ||||
coding:NZMT | S | 0..* | CodingIPS | New Zealand Medicines Terminology Binding: http://nzmt.org.nz/vs (preferred) | ||||
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 | |||||
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 | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://nzmt.org.nz/vs | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | SΣ | 0..1 | string | 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 | |||||
translation | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation | |||||
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 | S | 0..* | CodingIPS | 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 | SΣ | 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 | SΣ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | SΣ | 0..1 | string | 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 | |||||
translation | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation | |||||
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 | SΣ | 0..1 | string | Plain text representation of the concept | ||||
subject | SΣ | 1..1 | Reference(Patient (IPS)) | 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 | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
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 | ||||
effective[x] | SΣ | 1..1 | The date/time or interval when the medication is/was/will be taken | |||||
effective[x]All Types | Content/Rules for all Types | |||||||
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 | |||||
data-absent-reason | S | 0..1 | code | effective[x] absence reason URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) | ||||
effectiveDateTime | dateTime | |||||||
effectivePeriod | Period | |||||||
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 | S | 0..* | Dosage | Details of how medication is/was taken or should be taken | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
sequence | Σ | 0..1 | integer | The order of the dosage instructions | ||||
text | 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 (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 | SΣ | 0..1 | Timing | When medication should be administered | ||||
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 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Medicine Route of Administration - IPS (preferred): EDQM Standards Terms | |||||
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 | Upper limit on medication per administration | ||||
maxDosePerLifetime | Σ | 0..1 | SimpleQuantity | Upper limit on medication per lifetime of the patient | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
MedicationStatement.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
MedicationStatement.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1 from the FHIR Standard | ||||
MedicationStatement.statusReason | example | SNOMEDCTDrugTherapyStatusCodeshttp://hl7.org/fhir/ValueSet/reason-medication-status-codes from the FHIR Standard | ||||
MedicationStatement.category | preferred | Medication usage category codeshttp://hl7.org/fhir/ValueSet/medication-statement-category from the FHIR Standard | ||||
MedicationStatement.medication[x] | preferred | MedicationSnomedCodesAbsentUnknownhttp://hl7.org/fhir/uv/ips/ValueSet/medication-snomed-absent-unknown-uv-ips | ||||
MedicationStatement.medication[x]:medicationCodeableConcept | preferred | MedicationSnomedCodesAbsentUnknownhttp://hl7.org/fhir/uv/ips/ValueSet/medication-snomed-absent-unknown-uv-ips | ||||
MedicationStatement.medication[x]:medicationCodeableConcept.coding:NZMT | preferred | http://nzmt.org.nz/vshttp://nzmt.org.nz/vs | ||||
MedicationStatement.medication[x]:medicationCodeableConcept.coding:GTIN | preferred | GTINhttp://terminology.hl7.org/ValueSet/v3-GTIN | ||||
MedicationStatement.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
MedicationStatement.reasonCode | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard | ||||
MedicationStatement.dosage.additionalInstruction | example | SNOMEDCTAdditionalDosageInstructionshttp://hl7.org/fhir/ValueSet/additional-instruction-codes from the FHIR Standard | ||||
MedicationStatement.dosage.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | ||||
MedicationStatement.dosage.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodeshttp://hl7.org/fhir/ValueSet/approach-site-codes from the FHIR Standard | ||||
MedicationStatement.dosage.route | preferred | MedicineRouteOfAdministrationUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/medicine-route-of-administration | ||||
MedicationStatement.dosage.method | example | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codes from the FHIR Standard | ||||
MedicationStatement.dosage.doseAndRate.type | example | DoseAndRateTypehttp://hl7.org/fhir/ValueSet/dose-rate-type from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | MedicationStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MedicationStatement | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | MedicationStatement | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | MedicationStatement | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MedicationStatement | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from 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:
Other representations of profile: CSV, Excel, Schematron