HL7® FHIR® New Zealand Base Implementation Guide
2.1.2 - Draft
HL7® FHIR® New Zealand Base Implementation Guide
2.1.2 - Draft
HL7® FHIR® New Zealand Base Implementation Guide, published by HL7 New Zealand. This is not an authorized publication; it is the continuous build for version 2.1.2). 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: | |||
| Draft as of 2023-09-22 |
Realm: 
|
Computable Name: NzMedication | ||
Medication resource for use in NZ
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Medication
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Medication | 0..* | Medication | Definition of a Medication | |
  Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 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) | |
| 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 |
| Medication.code | preferred | http://nzmt.org.nz/vs |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Medication | 0..* | Medication | Definition of a Medication | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| 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) | |
| 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 |
 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. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Medication.code | preferred | http://nzmt.org.nz/vs |
| Medication.status | required | Medication Status Codes |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | |||||
| 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) | |||||
| 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 | ||||
| Medication.language | preferred | CommonLanguages
| ||||
| Medication.code | preferred | http://nzmt.org.nz/vs | ||||
| Medication.status | required | Medication Status Codes | ||||
| Medication.form | example | SNOMEDCTFormCodes |
This structure is derived from Medication
Differential View
This structure is derived from Medication
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Medication | 0..* | Medication | Definition of a Medication | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| 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) | |
| 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 |
| Medication.code | preferred | http://nzmt.org.nz/vs |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Medication | 0..* | Medication | Definition of a Medication | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| 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) | |
| 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 |
| 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. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Medication.code | preferred | http://nzmt.org.nz/vs |
| Medication.status | required | Medication Status Codes |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | |||||
| 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) | |||||
| 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 | ||||
| Medication.language | preferred | CommonLanguages
| ||||
| Medication.code | preferred | http://nzmt.org.nz/vs | ||||
| Medication.status | required | Medication Status Codes | ||||
| Medication.form | example | SNOMEDCTFormCodes |
This structure is derived from Medication
Other representations of profile: CSV, Excel, Schematron