HL7® FHIR® New Zealand Base Implementation Guide
2.1.1 - 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.1). 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: 2.1.1 | |||
Draft as of 2023-05-24 |
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![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Medication | Definition of a Medication | |
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | 0..* | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-atc Binding: https://nzhts.digital.health.nz/fhir/ValueSet/atc-code (required) | |
![]() ![]() ![]() | 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) | |
![]() ![]() ![]() | 0..1 | CodeableConcept | Codes that identify this medication Binding: http://nzmt.org.nz/vs (preferred) | |
![]() |
Path | Conformance | ValueSet |
Medication.code | preferred | http://nzmt.org.nz/vs |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Medication | Definition of a Medication | |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | 0..* | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-atc Binding: https://nzhts.digital.health.nz/fhir/ValueSet/atc-code (required) | |
![]() ![]() ![]() | 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) | |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Codes that identify this medication Binding: http://nzmt.org.nz/vs (preferred) |
![]() ![]() ![]() | ?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use. |
![]() |
Path | Conformance | ValueSet |
Medication.code | preferred | http://nzmt.org.nz/vs |
Medication.status | required | Medication Status Codes |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | 0..* | Medication | Definition of a Medication | |||||
![]() ![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() | 0..* | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-atc Binding: https://nzhts.digital.health.nz/fhir/ValueSet/atc-code (required) | |||||
![]() ![]() ![]() | 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) | |||||
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() | Σ | 0..* | Identifier | Business identifier for this medication | ||||
![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Codes that identify this medication Binding: http://nzmt.org.nz/vs (preferred) | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use. | ||||
![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Manufacturer of the item | ||||
![]() ![]() ![]() | 0..1 | CodeableConcept | powder | tablets | capsule + Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication. | |||||
![]() ![]() ![]() | Σ | 0..1 | Ratio | Amount of drug in package | ||||
![]() ![]() ![]() | 0..* | BackboneElement | Active or inactive ingredient | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | 1..1 | The actual ingredient or content | ||||||
![]() ![]() ![]() ![]() ![]() | CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() | Reference(Substance | Medication) | |||||||
![]() ![]() ![]() ![]() | 0..1 | boolean | Active ingredient indicator | |||||
![]() ![]() ![]() ![]() | 0..1 | Ratio | Quantity of ingredient present | |||||
![]() ![]() ![]() | 0..1 | BackboneElement | Details about packaged medications | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Identifier assigned to batch | |||||
![]() ![]() ![]() ![]() | 0..1 | dateTime | When batch will expire | |||||
![]() |
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![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Medication | Definition of a Medication | |
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | 0..* | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-atc Binding: https://nzhts.digital.health.nz/fhir/ValueSet/atc-code (required) | |
![]() ![]() ![]() | 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) | |
![]() ![]() ![]() | 0..1 | CodeableConcept | Codes that identify this medication Binding: http://nzmt.org.nz/vs (preferred) | |
![]() |
Path | Conformance | ValueSet |
Medication.code | preferred | http://nzmt.org.nz/vs |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Medication | Definition of a Medication | |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | 0..* | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-atc Binding: https://nzhts.digital.health.nz/fhir/ValueSet/atc-code (required) | |
![]() ![]() ![]() | 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) | |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Codes that identify this medication Binding: http://nzmt.org.nz/vs (preferred) |
![]() ![]() ![]() | ?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use. |
![]() |
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![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | 0..* | Medication | Definition of a Medication | |||||
![]() ![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() | 0..* | CodeableConcept | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-atc Binding: https://nzhts.digital.health.nz/fhir/ValueSet/atc-code (required) | |||||
![]() ![]() ![]() | 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) | |||||
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() | Σ | 0..* | Identifier | Business identifier for this medication | ||||
![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Codes that identify this medication Binding: http://nzmt.org.nz/vs (preferred) | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use. | ||||
![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Manufacturer of the item | ||||
![]() ![]() ![]() | 0..1 | CodeableConcept | powder | tablets | capsule + Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication. | |||||
![]() ![]() ![]() | Σ | 0..1 | Ratio | Amount of drug in package | ||||
![]() ![]() ![]() | 0..* | BackboneElement | Active or inactive ingredient | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | 1..1 | The actual ingredient or content | ||||||
![]() ![]() ![]() ![]() ![]() | CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() | Reference(Substance | Medication) | |||||||
![]() ![]() ![]() ![]() | 0..1 | boolean | Active ingredient indicator | |||||
![]() ![]() ![]() ![]() | 0..1 | Ratio | Quantity of ingredient present | |||||
![]() ![]() ![]() | 0..1 | BackboneElement | Details about packaged medications | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Identifier assigned to batch | |||||
![]() ![]() ![]() ![]() | 0..1 | dateTime | When batch will expire | |||||
![]() |
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