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/NzMedication | Version: 1.0.0 | |||
| Draft as of 2025-06-10 | Computable Name: NzMedication | |||
Medication resource for use in NZ
Usages:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Path | Conformance | ValueSet | URI |
| Medication.code | preferred | http://nzmt.org.nz/vshttp://nzmt.org.nz/vs | |
| Medication.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-status|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Medication | 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 | Medication | 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 | Medication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Medication | 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 Medication
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Medication |
0..* | Medication | Definition of a Medication | |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:nzf-atc |
0..* | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-atc Binding: https://nzhts.digital.health.nz/fhir/ValueSet/atc-code (required) | |
 extension:nzf-nzmt-type |
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) | |
  code |
0..1 | CodeableConcept | Codes that identify this medication Binding: http://nzmt.org.nz/vs (preferred) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Medication.code | preferred | http://nzmt.org.nz/vshttp://nzmt.org.nz/vs |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Medication |
0..* | Medication | Definition of a Medication | |||||
  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:nzf-atc |
0..* | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-atc Binding: https://nzhts.digital.health.nz/fhir/ValueSet/atc-code (required) | |||||
| extension:nzf-nzmt-type |
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) | |||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Business identifier for this medication | ||||
| code |
Σ | 0..1 | CodeableConcept | Codes that identify this medication Binding: http://nzmt.org.nz/vs (preferred) | ||||
| status |
?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use. | ||||
 manufacturer |
Σ | 0..1 | Reference(Organization) | Manufacturer of the item | ||||
| form |
0..1 | CodeableConcept | powder | tablets | capsule + Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication. | |||||
| amount |
Σ | 0..1 | Ratio | Amount of drug in package | ||||
| ingredient |
0..* | BackboneElement | Active or inactive ingredient | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
 item[x] |
1..1 | The actual ingredient or content | ||||||
| itemCodeableConcept |
CodeableConcept | |||||||
| itemReference |
Reference(Substance | Medication) | |||||||
| isActive |
0..1 | boolean | Active ingredient indicator | |||||
| strength |
0..1 | Ratio | Quantity of ingredient present | |||||
 batch |
0..1 | BackboneElement | Details about packaged medications | |||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| lotNumber |
0..1 | string | Identifier assigned to batch | |||||
| expirationDate |
0..1 | dateTime | When batch will expire | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Medication.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Medication.code | preferred | http://nzmt.org.nz/vshttp://nzmt.org.nz/vs | ||||
| Medication.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-status|4.0.1From the FHIR Standard | ||||
| Medication.form | example | SNOMEDCTFormCodeshttp://hl7.org/fhir/ValueSet/medication-form-codesFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Medication | 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 | Medication | 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 | Medication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Medication | 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 Medication
Key Elements View
| Path | Conformance | ValueSet | URI |
| Medication.code | preferred | http://nzmt.org.nz/vshttp://nzmt.org.nz/vs | |
| Medication.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-status|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Medication | 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 | Medication | 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 | Medication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Medication | 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() |
Differential View
This structure is derived from Medication
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Medication |
0..* | Medication | Definition of a Medication | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:nzf-atc |
0..* | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-atc Binding: https://nzhts.digital.health.nz/fhir/ValueSet/atc-code (required) | |
| extension:nzf-nzmt-type |
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) | |
| code |
0..1 | CodeableConcept | Codes that identify this medication Binding: http://nzmt.org.nz/vs (preferred) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Medication.code | preferred | http://nzmt.org.nz/vshttp://nzmt.org.nz/vs |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Medication |
0..* | Medication | Definition of a Medication | |||||
| 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:nzf-atc |
0..* | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-atc Binding: https://nzhts.digital.health.nz/fhir/ValueSet/atc-code (required) | |||||
| extension:nzf-nzmt-type |
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) | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Business identifier for this medication | ||||
| code |
Σ | 0..1 | CodeableConcept | Codes that identify this medication Binding: http://nzmt.org.nz/vs (preferred) | ||||
| status |
?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use. | ||||
| manufacturer |
Σ | 0..1 | Reference(Organization) | Manufacturer of the item | ||||
| form |
0..1 | CodeableConcept | powder | tablets | capsule + Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication. | |||||
| amount |
Σ | 0..1 | Ratio | Amount of drug in package | ||||
| ingredient |
0..* | BackboneElement | Active or inactive ingredient | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| item[x] |
1..1 | The actual ingredient or content | ||||||
| itemCodeableConcept |
CodeableConcept | |||||||
| itemReference |
Reference(Substance | Medication) | |||||||
| isActive |
0..1 | boolean | Active ingredient indicator | |||||
| strength |
0..1 | Ratio | Quantity of ingredient present | |||||
| batch |
0..1 | BackboneElement | Details about packaged medications | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| lotNumber |
0..1 | string | Identifier assigned to batch | |||||
| expirationDate |
0..1 | dateTime | When batch will expire | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Medication.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Medication.code | preferred | http://nzmt.org.nz/vshttp://nzmt.org.nz/vs | ||||
| Medication.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-status|4.0.1From the FHIR Standard | ||||
| Medication.form | example | SNOMEDCTFormCodeshttp://hl7.org/fhir/ValueSet/medication-form-codesFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Medication | 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 | Medication | 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 | Medication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Medication | 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 Medication
Other representations of profile: CSV, Excel, Schematron