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

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

The official URL for this extension is:

http://hl7.org.nz/fhir/StructureDefinition/nzf-supply-information

Status: draft
Extension maintained by: New Zealand Medicines Formulary LP

Context of Use

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

  • 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

Mandatory: 7 elements
Fixed Value: 8 elements
Prohibited: 8 elements

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionExtension
... extension 7..*ExtensionExtension
... extension:type 1..1ExtensionThe type of issue affecting the product.
.... extension 0..0
.... url 1..1uri"type"
.... value[x] 0..1CodeableConceptValue of extension
... extension:duration 1..1ExtensionIndication of whether the issue is temporary (such as an out of stock) or permanent (such as a discontinuation).
.... extension 0..0
.... url 1..1uri"duration"
.... value[x] 0..1CodeableConceptValue of extension
.... extension 0..0
.... url 1..1uri"solution"
.... value[x] 0..1stringValue of extension
... extension:action 1..1ExtensionDescription of the action prompted by the issue and solution.
.... extension 0..0
.... url 1..1uri"action"
.... value[x] 0..1stringValue of extension
... extension:date 1..1Extensionthe date the issue was entered
.... extension 0..0
.... url 1..1uri"date"
.... value[x] 0..1dateValue of extension
... extension:information 1..1ExtensionProduct description using NZULM format with short description of the issue and solution.
.... extension 0..0
.... url 1..1uri"information"
.... value[x] 0..1stringValue of extension
... extension:url 1..1ExtensionAddress of relevant notice on PHARMAC webpage.
.... extension 0..0
.... url 1..1uri"url"
.... value[x] 0..1urlValue of extension
... url 1..1uri"http://hl7.org.nz/fhir/StructureDefinition/nzf-supply-information"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionExtension
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 7..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:type 1..1ExtensionThe type of issue affecting the product.
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"type"
.... value[x] 0..1CodeableConceptValue of extension
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"duration"
.... value[x] 0..1CodeableConceptValue of extension
... extension:solution 1..1ExtensionDescription of the solution in place to address the issue.
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"solution"
.... value[x] 0..1stringValue of extension
... extension:action 1..1ExtensionDescription of the action prompted by the issue and solution.
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"action"
.... value[x] 0..1stringValue of extension
... extension:date 1..1Extensionthe date the issue was entered
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"date"
.... value[x] 0..1dateValue of extension
... extension:information 1..1ExtensionProduct description using NZULM format with short description of the issue and solution.
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"information"
.... value[x] 0..1stringValue of extension
... extension:url 1..1ExtensionAddress of relevant notice on PHARMAC webpage.
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"url"
.... value[x] 0..1urlValue of extension
... url 1..1uri"http://hl7.org.nz/fhir/StructureDefinition/nzf-supply-information"

doco Documentation for this format

This structure is derived from Extension

Summary

Mandatory: 7 elements
Fixed Value: 8 elements
Prohibited: 8 elements

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionExtension
... extension 7..*ExtensionExtension
... extension:type 1..1ExtensionThe type of issue affecting the product.
.... extension 0..0
.... url 1..1uri"type"
.... value[x] 0..1CodeableConceptValue of extension
... extension:duration 1..1ExtensionIndication of whether the issue is temporary (such as an out of stock) or permanent (such as a discontinuation).
.... extension 0..0
.... url 1..1uri"duration"
.... value[x] 0..1CodeableConceptValue of extension
.... extension 0..0
.... url 1..1uri"solution"
.... value[x] 0..1stringValue of extension
... extension:action 1..1ExtensionDescription of the action prompted by the issue and solution.
.... extension 0..0
.... url 1..1uri"action"
.... value[x] 0..1stringValue of extension
... extension:date 1..1Extensionthe date the issue was entered
.... extension 0..0
.... url 1..1uri"date"
.... value[x] 0..1dateValue of extension
... extension:information 1..1ExtensionProduct description using NZULM format with short description of the issue and solution.
.... extension 0..0
.... url 1..1uri"information"
.... value[x] 0..1stringValue of extension
... extension:url 1..1ExtensionAddress of relevant notice on PHARMAC webpage.
.... extension 0..0
.... url 1..1uri"url"
.... value[x] 0..1urlValue of extension
... url 1..1uri"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..*ExtensionExtension
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 7..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:type 1..1ExtensionThe type of issue affecting the product.
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"type"
.... value[x] 0..1CodeableConceptValue of extension
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"duration"
.... value[x] 0..1CodeableConceptValue of extension
... extension:solution 1..1ExtensionDescription of the solution in place to address the issue.
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"solution"
.... value[x] 0..1stringValue of extension
... extension:action 1..1ExtensionDescription of the action prompted by the issue and solution.
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"action"
.... value[x] 0..1stringValue of extension
... extension:date 1..1Extensionthe date the issue was entered
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"date"
.... value[x] 0..1dateValue of extension
... extension:information 1..1ExtensionProduct description using NZULM format with short description of the issue and solution.
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"information"
.... value[x] 0..1stringValue of extension
... extension:url 1..1ExtensionAddress of relevant notice on PHARMAC webpage.
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"url"
.... value[x] 0..1urlValue of extension
... url 1..1uri"http://hl7.org.nz/fhir/StructureDefinition/nzf-supply-information"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Constraints

IdPathDetailsRequirements
ele-1ExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Extension.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Extension.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Extension.extension:typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Extension.extension:typeMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Extension.extension:type.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Extension.extension:durationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Extension.extension:durationMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Extension.extension:duration.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Extension.extension:solutionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Extension.extension:solutionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Extension.extension:solution.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Extension.extension:actionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Extension.extension:actionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Extension.extension:action.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Extension.extension:dateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Extension.extension:dateMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Extension.extension:date.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Extension.extension:informationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Extension.extension:informationMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Extension.extension:information.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Extension.extension:urlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Extension.extension:urlMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Extension.extension:url.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())