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

Official URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-funding Version: 0.1.0
Draft as of 2022-05-18 Realm: New Zealand flag Computable Name: Funding

Core funding information specific to NZ. The extension can be added multiple times to a product for each pharmac schedule. These can be differentiated via the scheduleDate field.

Context of Use

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

  • Medication

Funding information is added to Container Trade Product Packs where applicable. The funding information is derived from both the Pharmac schedule.

There are two extensions added that store this information. The first is nzf-funding. This stores the general information around funding for a specific product such as price and subsidy. This also includes a 'type' field which indicates whether it applies to community, hml or both. To cater for the existence of multiple schedules this extension can be added to a product multiple times, once per schedule. This allows vendors to see both the current schedule information as well as an upcoming schedule. To determine which set of information to use the 'scheduleDate' field can be used.

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 0..1Extensionstatus of community funding - no subsidy, partial subsidy, full subsidy
.... extension 0..0
.... url 1..1uri"status"
.... value[x] 0..1CodeableConceptValue of extension
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/nzf-funding-code (required)
.... extension 0..0
.... url 1..1uri"subsidy"
.... value[x] 0..1MoneyValue of extension
... extension:price 0..1ExtensionThe manufacturer price.
.... extension 0..0
.... url 1..1uri"price"
.... value[x] 0..1MoneyValue of extension
... extension:type 1..*ExtensionA list of funding types, currently either community or hml
.... extension 0..0
.... url 1..1uri"type"
.... value[x] 0..1CodeableConceptValue of extension
Binding: Pharmac funding type (required)
... 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
.... extension 0..0
.... url 1..1uri"scheduleDate"
.... value[x] 0..1dateValue of extension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"status"
.... value[x] 0..1CodeableConceptValue of extension
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/nzf-funding-code (required)
... extension:subsidy 0..1ExtensionThe subsided price
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"subsidy"
.... value[x] 0..1MoneyValue of extension
... extension:price 0..1ExtensionThe manufacturer price.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"price"
.... value[x] 0..1MoneyValue of extension
... extension:type 1..*ExtensionA list of funding types, currently either community or hml
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"type"
.... value[x] 0..1CodeableConceptValue of extension
Binding: Pharmac funding type (required)
... 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 0..1Extensionstatus of community funding - no subsidy, partial subsidy, full subsidy
.... extension 0..0
.... url 1..1uri"status"
.... value[x] 0..1CodeableConceptValue of extension
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/nzf-funding-code (required)
.... extension 0..0
.... url 1..1uri"subsidy"
.... value[x] 0..1MoneyValue of extension
... extension:price 0..1ExtensionThe manufacturer price.
.... extension 0..0
.... url 1..1uri"price"
.... value[x] 0..1MoneyValue of extension
... extension:type 1..*ExtensionA list of funding types, currently either community or hml
.... extension 0..0
.... url 1..1uri"type"
.... value[x] 0..1CodeableConceptValue of extension
Binding: Pharmac funding type (required)
... 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
.... extension 0..0
.... url 1..1uri"scheduleDate"
.... value[x] 0..1dateValue of extension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"status"
.... value[x] 0..1CodeableConceptValue of extension
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/nzf-funding-code (required)
... extension:subsidy 0..1ExtensionThe subsided price
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"subsidy"
.... value[x] 0..1MoneyValue of extension
... extension:price 0..1ExtensionThe manufacturer price.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"price"
.... value[x] 0..1MoneyValue of extension
... extension:type 1..*ExtensionA list of funding types, currently either community or hml
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"type"
.... value[x] 0..1CodeableConceptValue of extension
Binding: Pharmac funding type (required)
... 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]requiredhttps://nzhts.digital.health.nz/fhir/ValueSet/nzf-funding-code
Extension.extension:type.value[x]requiredPharmacFundingTypeHB

Constraints

IdGradePathDetailsRequirements
ele-1errorExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extension:scheduleDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extension:scheduleDateMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extension:scheduleDate.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorExtension.extension:statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extension:statusMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extension:status.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorExtension.extension:subsidyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extension:subsidyMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extension:subsidy.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorExtension.extension:priceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extension:priceMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extension:price.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorExtension.extension:typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorExtension.extension:typeMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorExtension.extension:type.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())