HL7 FHIR Implementation Guide - New Zealand Formulary/NZULM IG
0.1.0 - ci-build

HL7 FHIR Implementation Guide - New Zealand Formulary/NZULM IG, published by New Zealand Medicines Formulary LP. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/HL7NZ/nzf/ and changes regularly. See the Directory of published versions

Resource Profile: Medication resource for NZ Formulary

Official URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-medication Version: 0.1.0
Active as of 2022-12-02 Realm: New Zealand flag Computable Name: NzfMedication

Medication resource for NZ Formulary

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..*MedicationDefinition of a Medication
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... nzmtType 0..1CodeableConceptType of NZMT record (e.g. MP, MPUU)
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-nzmt-type
Binding: Nzmt type (required)
... atc 0..*CodeableConceptAnatomical Therapeutic Chemical (ATC) Classification
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-atc
Binding: ATC codes (required)
... cal 0..*(Complex)Cautionary and Advisory Label
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-cal
... funding 0..*(Complex)General Funding details
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-funding
... fundingRule 0..*(Complex)Funding constraints and requirements
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-funding-rule
... description 0..*(Complex)NZMT descriptions for the medicine
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-description
... unapproved 0..1booleanWhether the medication can be used under section29
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-unapproved
... legalclass 0..1(Complex)Legal classification of the medication
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-legalclass
... medsafe 0..1(Complex)Medsafe details of the medication
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-medsafe
... prescribebybrand 0..1booleanTrue if can be prescribed by brand
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-prescribe-by-brand
... supplyinformation 0..*(Complex)Supply information
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-supply-information
... relatedmedication 0..*(Complex)Related medication
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-related-medication
... code 0..1CodeableConceptCodes that identify this medication
Binding: http://nzmt.org.nz/vs (preferred)
... manufacturer 0..0
... amount 0..0
... ingredient
.... strength 0..0
... batch 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Medication.codepreferredhttp://nzmt.org.nz/vs
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationDefinition of a Medication
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... nzmtType 0..1CodeableConceptType of NZMT record (e.g. MP, MPUU)
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-nzmt-type
Binding: Nzmt type (required)
... link 0..*Reference(DocumentReference)Links to other information about this medication
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-link
... cal 0..*(Complex)Cautionary and Advisory Label
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-cal
... funding 0..*(Complex)General Funding details
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-funding
... fundingRule 0..*(Complex)Funding constraints and requirements
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-funding-rule
... description 0..*(Complex)NZMT descriptions for the medicine
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-description
... unapproved 0..1booleanWhether the medication can be used under section29
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-unapproved
... legalclass 0..1(Complex)Legal classification of the medication
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-legalclass
... medsafe 0..1(Complex)Medsafe details of the medication
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-medsafe
... prescribebybrand 0..1booleanTrue if can be prescribed by brand
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-prescribe-by-brand
... supplyinformation 0..*(Complex)Supply information
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-supply-information
... relatedmedication 0..*(Complex)Related medication
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-related-medication
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... code Σ0..1CodeableConceptCodes that identify this medication
Binding: http://nzmt.org.nz/vs (preferred)
... status ?!Σ0..1codeactive | 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

PathConformanceValueSet
Medication.codepreferredhttp://nzmt.org.nz/vs
Medication.statusrequiredMedication Status Codes

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf 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-4errorMedicationIf 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-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationDefinition of a Medication
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... nzmtType 0..1CodeableConceptType of NZMT record (e.g. MP, MPUU)
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-nzmt-type
Binding: Nzmt type (required)
... atc 0..*CodeableConceptAnatomical Therapeutic Chemical (ATC) Classification
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-atc
Binding: ATC codes (required)
... link 0..*Reference(DocumentReference)Links to other information about this medication
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-link
... cal 0..*(Complex)Cautionary and Advisory Label
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-cal
... funding 0..*(Complex)General Funding details
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-funding
... fundingRule 0..*(Complex)Funding constraints and requirements
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-funding-rule
... description 0..*(Complex)NZMT descriptions for the medicine
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-description
... unapproved 0..1booleanWhether the medication can be used under section29
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-unapproved
... legalclass 0..1(Complex)Legal classification of the medication
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-legalclass
... medsafe 0..1(Complex)Medsafe details of the medication
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-medsafe
... prescribebybrand 0..1booleanTrue if can be prescribed by brand
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-prescribe-by-brand
... supplyinformation 0..*(Complex)Supply information
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-supply-information
... relatedmedication 0..*(Complex)Related medication
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-related-medication
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier for this medication
... code Σ0..1CodeableConceptCodes that identify this medication
Binding: http://nzmt.org.nz/vs (preferred)
... status ?!Σ0..1codeactive | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... form 0..1CodeableConceptpowder | tablets | capsule +
Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.

... ingredient 0..*BackboneElementActive or inactive ingredient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... item[x] 1..1The actual ingredient or content
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance | Medication)
.... isActive 0..1booleanActive ingredient indicator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Medication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Medication.codepreferredhttp://nzmt.org.nz/vs
Medication.statusrequiredMedication Status Codes
Medication.formexampleSNOMEDCTFormCodes

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from Medication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationDefinition of a Medication
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... nzmtType 0..1CodeableConceptType of NZMT record (e.g. MP, MPUU)
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-nzmt-type
Binding: Nzmt type (required)
... atc 0..*CodeableConceptAnatomical Therapeutic Chemical (ATC) Classification
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-atc
Binding: ATC codes (required)
... cal 0..*(Complex)Cautionary and Advisory Label
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-cal
... funding 0..*(Complex)General Funding details
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-funding
... fundingRule 0..*(Complex)Funding constraints and requirements
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-funding-rule
... description 0..*(Complex)NZMT descriptions for the medicine
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-description
... unapproved 0..1booleanWhether the medication can be used under section29
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-unapproved
... legalclass 0..1(Complex)Legal classification of the medication
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-legalclass
... medsafe 0..1(Complex)Medsafe details of the medication
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-medsafe
... prescribebybrand 0..1booleanTrue if can be prescribed by brand
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-prescribe-by-brand
... supplyinformation 0..*(Complex)Supply information
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-supply-information
... relatedmedication 0..*(Complex)Related medication
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-related-medication
... code 0..1CodeableConceptCodes that identify this medication
Binding: http://nzmt.org.nz/vs (preferred)
... manufacturer 0..0
... amount 0..0
... ingredient
.... strength 0..0
... batch 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Medication.codepreferredhttp://nzmt.org.nz/vs

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationDefinition of a Medication
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... nzmtType 0..1CodeableConceptType of NZMT record (e.g. MP, MPUU)
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-nzmt-type
Binding: Nzmt type (required)
... link 0..*Reference(DocumentReference)Links to other information about this medication
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-link
... cal 0..*(Complex)Cautionary and Advisory Label
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-cal
... funding 0..*(Complex)General Funding details
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-funding
... fundingRule 0..*(Complex)Funding constraints and requirements
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-funding-rule
... description 0..*(Complex)NZMT descriptions for the medicine
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-description
... unapproved 0..1booleanWhether the medication can be used under section29
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-unapproved
... legalclass 0..1(Complex)Legal classification of the medication
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-legalclass
... medsafe 0..1(Complex)Medsafe details of the medication
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-medsafe
... prescribebybrand 0..1booleanTrue if can be prescribed by brand
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-prescribe-by-brand
... supplyinformation 0..*(Complex)Supply information
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-supply-information
... relatedmedication 0..*(Complex)Related medication
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-related-medication
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... code Σ0..1CodeableConceptCodes that identify this medication
Binding: http://nzmt.org.nz/vs (preferred)
... status ?!Σ0..1codeactive | 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

PathConformanceValueSet
Medication.codepreferredhttp://nzmt.org.nz/vs
Medication.statusrequiredMedication Status Codes

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf 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-4errorMedicationIf 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-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationDefinition of a Medication
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... nzmtType 0..1CodeableConceptType of NZMT record (e.g. MP, MPUU)
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-nzmt-type
Binding: Nzmt type (required)
... atc 0..*CodeableConceptAnatomical Therapeutic Chemical (ATC) Classification
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-atc
Binding: ATC codes (required)
... link 0..*Reference(DocumentReference)Links to other information about this medication
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-link
... cal 0..*(Complex)Cautionary and Advisory Label
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-cal
... funding 0..*(Complex)General Funding details
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-funding
... fundingRule 0..*(Complex)Funding constraints and requirements
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-funding-rule
... description 0..*(Complex)NZMT descriptions for the medicine
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-description
... unapproved 0..1booleanWhether the medication can be used under section29
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-unapproved
... legalclass 0..1(Complex)Legal classification of the medication
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-legalclass
... medsafe 0..1(Complex)Medsafe details of the medication
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-medsafe
... prescribebybrand 0..1booleanTrue if can be prescribed by brand
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-prescribe-by-brand
... supplyinformation 0..*(Complex)Supply information
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-supply-information
... relatedmedication 0..*(Complex)Related medication
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-related-medication
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier for this medication
... code Σ0..1CodeableConceptCodes that identify this medication
Binding: http://nzmt.org.nz/vs (preferred)
... status ?!Σ0..1codeactive | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... form 0..1CodeableConceptpowder | tablets | capsule +
Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.

... ingredient 0..*BackboneElementActive or inactive ingredient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... item[x] 1..1The actual ingredient or content
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance | Medication)
.... isActive 0..1booleanActive ingredient indicator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Medication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Medication.codepreferredhttp://nzmt.org.nz/vs
Medication.statusrequiredMedication Status Codes
Medication.formexampleSNOMEDCTFormCodes

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron