HL7® FHIR® New Zealand Base Implementation Guide
3.1.0 - Draft
HL7® FHIR® New Zealand Base Implementation Guide
3.1.0 - Draft
HL7® FHIR® New Zealand Base Implementation Guide, published by HL7 New Zealand. This guide is not an authorized publication; it is the continuous build for version 3.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7NZ/nzbase/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org.nz/fhir/StructureDefinition/NzMedicationStatement | Version: 1.0.0 | |||
| Draft as of 2025-02-28 | Computable Name: NzMedicationStatement | |||
MedicationStatement resource for use in NZ
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  MedicationStatement |
0..* | MedicationStatement | Record of medication being taken by a patient dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
   extension:nzeps-long-term-medication |
0..1 | boolean | NZePS Long Term Medication Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-long-term-medication ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| 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. ele-1: All FHIR elements must have a @value or children |
 Slices for medication[x] |
Σ | 1..1 | What medication was taken Slice: Unordered, Open by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken. ele-1: All FHIR elements must have a @value or children | |
  medicationCodeableConcept |
CodeableConcept | |||
 medicationReference |
Reference(Medication) | |||
| medication[x]:medicationCodeableConcept |
Σ | 0..1 | CodeableConcept | What medication was taken Binding: http://nzmt.org.nz/vs (preferred) ele-1: All FHIR elements must have a @value or children |
 subject |
Σ | 1..1 | Reference(Patient | Group) | Who is/was taking the medication ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| MedicationStatement.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1from the FHIR Standard | |
| MedicationStatement.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | |
| MedicationStatement.medication[x]:medicationCodeableConcept | preferred | http://nzmt.org.nz/vshttp://nzmt.org.nz/vs |
This structure is derived from MedicationStatement
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationStatement |
0..* | MedicationStatement | Record of medication being taken by a patient | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:nzeps-long-term-medication |
0..1 | boolean | NZePS Long Term Medication Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-long-term-medication | |
 Slices for medication[x] |
1..1 | CodeableConcept, Reference(Medication) | What medication was taken Slice: Unordered, Open by type:$this | |
 medication[x]:medicationCodeableConcept |
0..1 | CodeableConcept | What medication was taken Binding: http://nzmt.org.nz/vs (preferred) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| MedicationStatement.medication[x]:medicationCodeableConcept | preferred | http://nzmt.org.nz/vshttp://nzmt.org.nz/vs |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationStatement |
0..* | MedicationStatement | Record of medication being taken by a patient | |||||
| 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 | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:nzeps-long-term-medication |
0..1 | boolean | NZePS Long Term Medication Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-long-term-medication | |||||
| 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] |
Σ | 1..1 | What medication was taken Slice: Unordered, Open by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken. | |||||
| medicationCodeableConcept |
CodeableConcept | |||||||
| medicationReference |
Reference(Medication) | |||||||
| medication[x]:medicationCodeableConcept |
Σ | 0..1 | CodeableConcept | What medication was taken Binding: http://nzmt.org.nz/vs (preferred) | ||||
| subject |
Σ | 1..1 | Reference(Patient | Group) | Who is/was taking the medication | ||||
| context |
Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with MedicationStatement | ||||
 effective[x] |
Σ | 0..1 | The date/time or interval when the medication is/was/will be taken | |||||
| 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 |
0..* | Dosage | Details of how medication is/was taken or should be taken | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| MedicationStatement.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| MedicationStatement.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1from the FHIR Standard | ||||
| MedicationStatement.statusReason | example | SNOMEDCTDrugTherapyStatusCodeshttp://hl7.org/fhir/ValueSet/reason-medication-status-codesfrom the FHIR Standard | ||||
| MedicationStatement.category | preferred | Medication usage category codeshttp://hl7.org/fhir/ValueSet/medication-statement-categoryfrom the FHIR Standard | ||||
| MedicationStatement.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | ||||
| MedicationStatement.medication[x]:medicationCodeableConcept | preferred | http://nzmt.org.nz/vshttp://nzmt.org.nz/vs | ||||
| MedicationStatement.reasonCode | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-codefrom the FHIR Standard |
This structure is derived from MedicationStatement
Summary
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationStatement |
0..* | MedicationStatement | Record of medication being taken by a patient dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| extension:nzeps-long-term-medication |
0..1 | boolean | NZePS Long Term Medication Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-long-term-medication ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| 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. ele-1: All FHIR elements must have a @value or children |
| Slices for medication[x] |
Σ | 1..1 | What medication was taken Slice: Unordered, Open by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken. ele-1: All FHIR elements must have a @value or children | |
| medicationCodeableConcept |
CodeableConcept | |||
| medicationReference |
Reference(Medication) | |||
| medication[x]:medicationCodeableConcept |
Σ | 0..1 | CodeableConcept | What medication was taken Binding: http://nzmt.org.nz/vs (preferred) ele-1: All FHIR elements must have a @value or children |
| subject |
Σ | 1..1 | Reference(Patient | Group) | Who is/was taking the medication ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| MedicationStatement.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1from the FHIR Standard | |
| MedicationStatement.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | |
| MedicationStatement.medication[x]:medicationCodeableConcept | preferred | http://nzmt.org.nz/vshttp://nzmt.org.nz/vs |
Differential View
This structure is derived from MedicationStatement
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationStatement |
0..* | MedicationStatement | Record of medication being taken by a patient | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:nzeps-long-term-medication |
0..1 | boolean | NZePS Long Term Medication Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-long-term-medication | |
| Slices for medication[x] |
1..1 | CodeableConcept, Reference(Medication) | What medication was taken Slice: Unordered, Open by type:$this | |
| medication[x]:medicationCodeableConcept |
0..1 | CodeableConcept | What medication was taken Binding: http://nzmt.org.nz/vs (preferred) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| MedicationStatement.medication[x]:medicationCodeableConcept | preferred | http://nzmt.org.nz/vshttp://nzmt.org.nz/vs |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationStatement |
0..* | MedicationStatement | Record of medication being taken by a patient | |||||
| 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 | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:nzeps-long-term-medication |
0..1 | boolean | NZePS Long Term Medication Indicator URL: http://hl7.org.nz/fhir/StructureDefinition/nzeps-long-term-medication | |||||
| 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] |
Σ | 1..1 | What medication was taken Slice: Unordered, Open by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken. | |||||
| medicationCodeableConcept |
CodeableConcept | |||||||
| medicationReference |
Reference(Medication) | |||||||
| medication[x]:medicationCodeableConcept |
Σ | 0..1 | CodeableConcept | What medication was taken Binding: http://nzmt.org.nz/vs (preferred) | ||||
| subject |
Σ | 1..1 | Reference(Patient | Group) | Who is/was taking the medication | ||||
| context |
Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with MedicationStatement | ||||
| effective[x] |
Σ | 0..1 | The date/time or interval when the medication is/was/will be taken | |||||
| 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 |
0..* | Dosage | Details of how medication is/was taken or should be taken | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| MedicationStatement.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| MedicationStatement.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1from the FHIR Standard | ||||
| MedicationStatement.statusReason | example | SNOMEDCTDrugTherapyStatusCodeshttp://hl7.org/fhir/ValueSet/reason-medication-status-codesfrom the FHIR Standard | ||||
| MedicationStatement.category | preferred | Medication usage category codeshttp://hl7.org/fhir/ValueSet/medication-statement-categoryfrom the FHIR Standard | ||||
| MedicationStatement.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | ||||
| MedicationStatement.medication[x]:medicationCodeableConcept | preferred | http://nzmt.org.nz/vshttp://nzmt.org.nz/vs | ||||
| MedicationStatement.reasonCode | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-codefrom the FHIR Standard |
This structure is derived from MedicationStatement
Summary
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron