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

Resource Profile: Medication resource for use in NZ

Official URL: http://hl7.org.nz/fhir/StructureDefinition/NzMedication Version: 1.0.0
Draft as of 2024-04-19 Realm: New Zealand flag Computable Name: NzMedication

Medication resource for use in NZ

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Medication

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Medication.codepreferredhttp://nzmt.org.nz/vs
http://nzmt.org.nz/vs
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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)
... 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.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.codepreferredhttp://nzmt.org.nz/vs
http://nzmt.org.nz/vs
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Medication.codepreferredhttp://nzmt.org.nz/vs
http://nzmt.org.nz/vs
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
from the FHIR Standard
Medication.formexampleSNOMEDCTFormCodes
http://hl7.org/fhir/ValueSet/medication-form-codes
from the FHIR Standard

This structure is derived from Medication

Differential View

This structure is derived from Medication

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Medication.codepreferredhttp://nzmt.org.nz/vs
http://nzmt.org.nz/vs

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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)
... 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.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.codepreferredhttp://nzmt.org.nz/vs
http://nzmt.org.nz/vs
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Medication.codepreferredhttp://nzmt.org.nz/vs
http://nzmt.org.nz/vs
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
from the FHIR Standard
Medication.formexampleSNOMEDCTFormCodes
http://hl7.org/fhir/ValueSet/medication-form-codes
from the FHIR Standard

This structure is derived from Medication

 

Other representations of profile: CSV, Excel, Schematron