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

Defining URL:http://hl7.org.nz/fhir/StructureDefinition/nzf-medication
Version:0.1.0
Name:NzfMedication
Title:Medication resource for NZ Formulary
Status:Active as of 2021-09-07T23:01:56+00:00
Publisher:New Zealand Medicines Formulary LP
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org.nz/fhir/StructureDefinition/nzf-medication

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 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... nzf-nzmt-type 1..1CodeableConceptType of NZMT record (e.g. MP, MPUU)
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-nzmt-type
Binding: Nzmt type (required)
... nzf-atc 0..*(Complex)Anatomical Therapeutic Chemical (ATC) Classification
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-atc
... nzf-cal 0..*(Complex)Cautionary and Advisory Label
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-cal
... nzf-funding 0..*(Complex)Funding constraints and requirements
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-funding
... nzf-unapproved 0..1booleanWhether the medication can be used under section29
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-unapproved
... nzf-legalclass 0..1(Complex)Legal classification of the medication
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-legalclass
... nzf-medsafe 0..1(Complex)Medsafe details of the medication
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-medsafe
... nzf-prescribe-by-brand 0..1booleanTrue if can be prescribed by brand
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-prescribe-by-brand
... nzf-supply-information 0..*(Complex)Supply information
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-supply-information
... status 0..0
... manufacturer 0..0
... amount 0..0
... ingredient
.... strength 0..0
... batch 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationDefinition of a Medication
... id Σ0..1stringLogical 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 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... nzf-nzmt-type 1..1CodeableConceptType of NZMT record (e.g. MP, MPUU)
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-nzmt-type
Binding: Nzmt type (required)
... nzf-atc 0..*(Complex)Anatomical Therapeutic Chemical (ATC) Classification
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-atc
... nzf-link 0..*Reference(DocumentReference)Links to other information about this medication
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-link
... nzf-cal 0..*(Complex)Cautionary and Advisory Label
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-cal
... nzf-funding 0..*(Complex)Funding constraints and requirements
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-funding
... nzf-unapproved 0..1booleanWhether the medication can be used under section29
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-unapproved
... nzf-legalclass 0..1(Complex)Legal classification of the medication
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-legalclass
... nzf-medsafe 0..1(Complex)Medsafe details of the medication
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-medsafe
... nzf-prescribe-by-brand 0..1booleanTrue if can be prescribed by brand
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-prescribe-by-brand
... nzf-supply-information 0..*(Complex)Supply information
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-supply-information
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier for this medication
... code Σ0..1CodeableConceptCodes that identify this medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.

... 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

Differential View

This structure is derived from Medication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationDefinition of a Medication
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... nzf-nzmt-type 1..1CodeableConceptType of NZMT record (e.g. MP, MPUU)
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-nzmt-type
Binding: Nzmt type (required)
... nzf-atc 0..*(Complex)Anatomical Therapeutic Chemical (ATC) Classification
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-atc
... nzf-cal 0..*(Complex)Cautionary and Advisory Label
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-cal
... nzf-funding 0..*(Complex)Funding constraints and requirements
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-funding
... nzf-unapproved 0..1booleanWhether the medication can be used under section29
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-unapproved
... nzf-legalclass 0..1(Complex)Legal classification of the medication
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-legalclass
... nzf-medsafe 0..1(Complex)Medsafe details of the medication
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-medsafe
... nzf-prescribe-by-brand 0..1booleanTrue if can be prescribed by brand
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-prescribe-by-brand
... nzf-supply-information 0..*(Complex)Supply information
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-supply-information
... status 0..0
... manufacturer 0..0
... amount 0..0
... ingredient
.... strength 0..0
... batch 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*MedicationDefinition of a Medication
... id Σ0..1stringLogical 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 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... nzf-nzmt-type 1..1CodeableConceptType of NZMT record (e.g. MP, MPUU)
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-nzmt-type
Binding: Nzmt type (required)
... nzf-atc 0..*(Complex)Anatomical Therapeutic Chemical (ATC) Classification
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-atc
... nzf-link 0..*Reference(DocumentReference)Links to other information about this medication
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-link
... nzf-cal 0..*(Complex)Cautionary and Advisory Label
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-cal
... nzf-funding 0..*(Complex)Funding constraints and requirements
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-funding
... nzf-unapproved 0..1booleanWhether the medication can be used under section29
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-unapproved
... nzf-legalclass 0..1(Complex)Legal classification of the medication
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-legalclass
... nzf-medsafe 0..1(Complex)Medsafe details of the medication
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-medsafe
... nzf-prescribe-by-brand 0..1booleanTrue if can be prescribed by brand
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-prescribe-by-brand
... nzf-supply-information 0..*(Complex)Supply information
URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-supply-information
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier for this medication
... code Σ0..1CodeableConceptCodes that identify this medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.

... 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

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Medication.languagepreferredCommonLanguages
Max Binding: AllLanguages
Medication.codeexampleSNOMEDCTMedicationCodes
Medication.formexampleSNOMEDCTFormCodes

Constraints

IdPathDetailsRequirements
dom-2MedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3MedicationIf 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-4MedicationIf 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-5MedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6MedicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1Medication.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Medication.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Medication.extension:nzmtTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Medication.extension:nzmtTypeMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Medication.extension:atcAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Medication.extension:atcMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Medication.extension:linkAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Medication.extension:linkMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Medication.extension:calAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Medication.extension:calMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Medication.extension:fundingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Medication.extension:fundingMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Medication.extension:unapprovedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Medication.extension:unapprovedMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Medication.extension:legalclassAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Medication.extension:legalclassMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Medication.extension:medsafeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Medication.extension:medsafeMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Medication.extension:prescribebybrandAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Medication.extension:prescribebybrandMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Medication.extension:supplyinformationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Medication.extension:supplyinformationMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Medication.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Medication.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Medication.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.formAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.ingredientAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.ingredient.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Medication.ingredient.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Medication.ingredient.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Medication.ingredient.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Medication.ingredient.item[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.ingredient.isActiveAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.batch.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Medication.batch.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Medication.batch.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Medication.batch.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Medication.batch.lotNumberAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Medication.batch.expirationDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())