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

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

Extension: SupplyInformation

Official URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-supply-information Version: 1.0.0
Draft as of 2024-05-06 Realm: New Zealand flag Computable Name: SupplyInformation

Information around the supply and availability of medications applied at each NZMT level. For example, when paracetamol tablets are in short supply an alert may be attached to the MP level medication along with the relevant details.

Context of Use

This extension may be used on the following element(s):

  • Element ID Medication

Usage info

Usage:

Formal Views of Extension Content

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

This structure is derived from Extension

Summary

Complex Extension: Information around the supply and availability of medications applied at each NZMT level. For example, when paracetamol tablets are in short supply an alert may be attached to the MP level medication along with the relevant details.

  • type: CodeableConcept: The type of issue affecting the product. Possible values: Supply, Information, Brand Change.
  • duration: CodeableConcept: Indication of whether the issue is temporary (such as an out of stock) or permanent (such as a discontinuation). Possible values: Temporary, Permanent.
  • solution: string: Description of the solution in place to address the issue. Possible values: No replacement, Alternate brand, Alternate formulation, Alternate active ingredients(s), Equivalent product s29, Alternate brand s29, Alternate active ingredient s29, Product recall, Alternate product, No change, Alternate strength, New product.
  • action: string: Description of the action prompted by the issue and solution. Possible values: Prescribing action, Depensing action, Clinical caution, Recall action, Information.
  • date: date: The date the issue was entered.
  • information: string: Product description using NZULM format with short description of the issue and solution.
  • url: url: Address of relevant notice on PHARMAC webpage.

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension Extension
... extension 7..* Extension Extension
... extension:type 1..1 Extension The type of issue affecting the product.
.... extension 0..0
.... url 1..1 uri "type"
.... value[x] 0..1 CodeableConcept Value of extension
... extension:duration 1..1 Extension Indication of whether the issue is temporary (such as an out of stock) or permanent (such as a discontinuation).
.... extension 0..0
.... url 1..1 uri "duration"
.... value[x] 0..1 CodeableConcept Value of extension
.... extension 0..0
.... url 1..1 uri "solution"
.... value[x] 0..1 string Value of extension
... extension:action 1..1 Extension Description of the action prompted by the issue and solution.
.... extension 0..0
.... url 1..1 uri "action"
.... value[x] 0..1 string Value of extension
... extension:date 1..1 Extension The date the issue was entered.
.... extension 0..0
.... url 1..1 uri "date"
.... value[x] 0..1 date Value of extension
... extension:information 1..1 Extension Product description using NZULM format with short description of the issue and solution.
.... extension 0..0
.... url 1..1 uri "information"
.... value[x] 0..1 string Value of extension
... extension:url 1..1 Extension Address of relevant notice on PHARMAC webpage.
.... extension 0..0
.... url 1..1 uri "url"
.... value[x] 0..1 url Value of extension
... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/nzf-supply-information"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension Extension
... id 0..1 id Unique id for inter-element referencing
... Slices for extension 7..* Extension Extension
Slice: Unordered, Open by value:url
... extension:type 1..1 Extension The type of issue affecting the product.
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..0
.... url 1..1 uri "type"
.... value[x] 0..1 CodeableConcept Value of extension
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..0
.... url 1..1 uri "duration"
.... value[x] 0..1 CodeableConcept Value of extension
... extension:solution 1..1 Extension Description of the solution in place to address the issue.
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..0
.... url 1..1 uri "solution"
.... value[x] 0..1 string Value of extension
... extension:action 1..1 Extension Description of the action prompted by the issue and solution.
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..0
.... url 1..1 uri "action"
.... value[x] 0..1 string Value of extension
... extension:date 1..1 Extension The date the issue was entered.
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..0
.... url 1..1 uri "date"
.... value[x] 0..1 date Value of extension
... extension:information 1..1 Extension Product description using NZULM format with short description of the issue and solution.
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..0
.... url 1..1 uri "information"
.... value[x] 0..1 string Value of extension
... extension:url 1..1 Extension Address of relevant notice on PHARMAC webpage.
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..0
.... url 1..1 uri "url"
.... value[x] 0..1 url Value of extension
... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/nzf-supply-information"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Information around the supply and availability of medications applied at each NZMT level. For example, when paracetamol tablets are in short supply an alert may be attached to the MP level medication along with the relevant details.

  • type: CodeableConcept: The type of issue affecting the product. Possible values: Supply, Information, Brand Change.
  • duration: CodeableConcept: Indication of whether the issue is temporary (such as an out of stock) or permanent (such as a discontinuation). Possible values: Temporary, Permanent.
  • solution: string: Description of the solution in place to address the issue. Possible values: No replacement, Alternate brand, Alternate formulation, Alternate active ingredients(s), Equivalent product s29, Alternate brand s29, Alternate active ingredient s29, Product recall, Alternate product, No change, Alternate strength, New product.
  • action: string: Description of the action prompted by the issue and solution. Possible values: Prescribing action, Depensing action, Clinical caution, Recall action, Information.
  • date: date: The date the issue was entered.
  • information: string: Product description using NZULM format with short description of the issue and solution.
  • url: url: Address of relevant notice on PHARMAC webpage.

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension Extension
... extension 7..* Extension Extension
... extension:type 1..1 Extension The type of issue affecting the product.
.... extension 0..0
.... url 1..1 uri "type"
.... value[x] 0..1 CodeableConcept Value of extension
... extension:duration 1..1 Extension Indication of whether the issue is temporary (such as an out of stock) or permanent (such as a discontinuation).
.... extension 0..0
.... url 1..1 uri "duration"
.... value[x] 0..1 CodeableConcept Value of extension
.... extension 0..0
.... url 1..1 uri "solution"
.... value[x] 0..1 string Value of extension
... extension:action 1..1 Extension Description of the action prompted by the issue and solution.
.... extension 0..0
.... url 1..1 uri "action"
.... value[x] 0..1 string Value of extension
... extension:date 1..1 Extension The date the issue was entered.
.... extension 0..0
.... url 1..1 uri "date"
.... value[x] 0..1 date Value of extension
... extension:information 1..1 Extension Product description using NZULM format with short description of the issue and solution.
.... extension 0..0
.... url 1..1 uri "information"
.... value[x] 0..1 string Value of extension
... extension:url 1..1 Extension Address of relevant notice on PHARMAC webpage.
.... extension 0..0
.... url 1..1 uri "url"
.... value[x] 0..1 url Value of extension
... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/nzf-supply-information"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension Extension
... id 0..1 id Unique id for inter-element referencing
... Slices for extension 7..* Extension Extension
Slice: Unordered, Open by value:url
... extension:type 1..1 Extension The type of issue affecting the product.
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..0
.... url 1..1 uri "type"
.... value[x] 0..1 CodeableConcept Value of extension
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..0
.... url 1..1 uri "duration"
.... value[x] 0..1 CodeableConcept Value of extension
... extension:solution 1..1 Extension Description of the solution in place to address the issue.
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..0
.... url 1..1 uri "solution"
.... value[x] 0..1 string Value of extension
... extension:action 1..1 Extension Description of the action prompted by the issue and solution.
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..0
.... url 1..1 uri "action"
.... value[x] 0..1 string Value of extension
... extension:date 1..1 Extension The date the issue was entered.
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..0
.... url 1..1 uri "date"
.... value[x] 0..1 date Value of extension
... extension:information 1..1 Extension Product description using NZULM format with short description of the issue and solution.
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..0
.... url 1..1 uri "information"
.... value[x] 0..1 string Value of extension
... extension:url 1..1 Extension Address of relevant notice on PHARMAC webpage.
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..0
.... url 1..1 uri "url"
.... value[x] 0..1 url Value of extension
... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/nzf-supply-information"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Constraints

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