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: Funding

General funding information specific to NZ. This details whether the product is either community funded or is on the HML. The extension can be added multiple times to a product for each pharmac schedule. These can be differentiated via the scheduleDate field.

The official URL for this extension is:

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

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: 2 elements
Fixed Value: 6 elements
Prohibited: 6 elements

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionExtension
... extension 2..*ExtensionExtension
... extension:scheduleDate 1..1ExtensionThe date this item was placed on the schedule
.... extension 0..0
.... url 1..1uri"scheduleDate"
.... value[x] 0..1dateValue of extension
... extension:status 1..1Extensionstatus of community funding - no subsidy, partial subsidy, full subsidy
.... extension 0..0
.... url 1..1uri"status"
.... value[x] 0..1CodeableConceptValue of extension
Binding: Derived pharmac funding code (required)
.... extension 0..0
.... url 1..1uri"subsidy"
.... value[x] 0..1MoneyValue of extension
... extension:manPrice 0..1ExtensionCommunity - The manufacturer price.
.... extension 0..0
.... url 1..1uri"manPrice"
.... value[x] 0..1MoneyValue of extension
... extension:isHml 0..1ExtensionIs HML.
.... extension 0..0
.... url 1..1uri"isHml"
.... value[x] 0..1booleanValue of extension
... url 1..1uri"http://hl7.org.nz/fhir/StructureDefinition/nzf-funding"
... 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 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:scheduleDate 1..1ExtensionThe date this item was placed on the schedule
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"scheduleDate"
.... value[x] 0..1dateValue of extension
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"status"
.... value[x] 0..1CodeableConceptValue of extension
Binding: Derived pharmac funding code (required)
... extension:subsidy 0..1ExtensionCommunity - The subsided price
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"subsidy"
.... value[x] 0..1MoneyValue of extension
... extension:manPrice 0..1ExtensionCommunity - The manufacturer price.
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"manPrice"
.... value[x] 0..1MoneyValue of extension
... extension:isHml 0..1ExtensionIs HML.
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"isHml"
.... value[x] 0..1booleanValue of extension
... url 1..1uri"http://hl7.org.nz/fhir/StructureDefinition/nzf-funding"

doco Documentation for this format

This structure is derived from Extension

Summary

Mandatory: 2 elements
Fixed Value: 6 elements
Prohibited: 6 elements

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionExtension
... extension 2..*ExtensionExtension
... extension:scheduleDate 1..1ExtensionThe date this item was placed on the schedule
.... extension 0..0
.... url 1..1uri"scheduleDate"
.... value[x] 0..1dateValue of extension
... extension:status 1..1Extensionstatus of community funding - no subsidy, partial subsidy, full subsidy
.... extension 0..0
.... url 1..1uri"status"
.... value[x] 0..1CodeableConceptValue of extension
Binding: Derived pharmac funding code (required)
.... extension 0..0
.... url 1..1uri"subsidy"
.... value[x] 0..1MoneyValue of extension
... extension:manPrice 0..1ExtensionCommunity - The manufacturer price.
.... extension 0..0
.... url 1..1uri"manPrice"
.... value[x] 0..1MoneyValue of extension
... extension:isHml 0..1ExtensionIs HML.
.... extension 0..0
.... url 1..1uri"isHml"
.... value[x] 0..1booleanValue of extension
... url 1..1uri"http://hl7.org.nz/fhir/StructureDefinition/nzf-funding"
... 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 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:scheduleDate 1..1ExtensionThe date this item was placed on the schedule
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"scheduleDate"
.... value[x] 0..1dateValue of extension
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"status"
.... value[x] 0..1CodeableConceptValue of extension
Binding: Derived pharmac funding code (required)
... extension:subsidy 0..1ExtensionCommunity - The subsided price
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"subsidy"
.... value[x] 0..1MoneyValue of extension
... extension:manPrice 0..1ExtensionCommunity - The manufacturer price.
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"manPrice"
.... value[x] 0..1MoneyValue of extension
... extension:isHml 0..1ExtensionIs HML.
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"isHml"
.... value[x] 0..1booleanValue of extension
... url 1..1uri"http://hl7.org.nz/fhir/StructureDefinition/nzf-funding"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Extension.extension:status.value[x]requiredPharmacFundingCodeHB

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:scheduleDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Extension.extension:scheduleDateMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Extension.extension:scheduleDate.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Extension.extension:statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Extension.extension:statusMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Extension.extension:status.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Extension.extension:subsidyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Extension.extension:subsidyMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Extension.extension:subsidy.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Extension.extension:manPriceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Extension.extension:manPriceMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Extension.extension:manPrice.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Extension.extension:isHmlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Extension.extension:isHmlMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Extension.extension:isHml.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())