HL7® FHIR® New Zealand Base Implementation Guide
3.1.0 - Draft

HL7® FHIR® New Zealand Base Implementation Guide, published by HL7 New Zealand. This guide is not an authorized publication; it is the continuous build for version 3.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7nz/nzbase/ and changes regularly. See the Directory of published versions

## Extension: Funded Healthcare Programme

Official URL: http://hl7.org.nz/fhir/StructureDefinition/funded-programme | Version: 1.0
Active as of 2021-02-08 | Maturity Level: 1 | Computable Name: Funded_programme
Copyright/Legal: HL7 New Zealand© 2021+; Licensed Under Creative Commons No Rights Reserved.

Funded NZ Healthcare Programmes

Details of a NZ Healthcare Funded Programme relevant to its implementation status at an individual organisation, facility or service.

Context of Use

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

- Element ID: `Location`
- Element ID: `Organization`
- Element ID: `HealthcareService`

Example of extension

      <extension url="http://hl7.org.nz/fhir/StructureDefinition/funded-programme">
        <extension url="fundedProgramme">
          <valueCodeableConcept>
            <coding>
              <system
                      value="https://standards.digital.health.nz/ns/funded-programme-code"/>
              <code value="DENTAL_CHILD"/>
              <display value="Dental Care - Children up to age 13"/>
            </coding>
          </valueCodeableConcept>
        </extension>
        <extension url="currentAvailability">
          <valueBoolean value="true"/>
        </extension>
        <extension url="notes">
          <valueString
                       value="Dental care is only free on referral. Your child’s care will normally be managed by the Auckland Regional Dental Services (ARDs)."/>
        </extension>
      </extension>

Example instances

Organization with funded programme

Usage info

Usages:

- Use this Extension: HealthcareService resource for use in NZ, Location resource for use in NZ and Organization resource for use in NZ
- Examples for this Extension: Dianes Dental care

You can also check for usages in the FHIR IG Statistics

### Formal Views of Extension Content

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

- Differential Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from Extension

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | Funded Healthcare Programme
Slices for extension |  |  |  | Content/Rules for all slices
extension:fundedProgramme |  | 0..1 | Extension | Extension
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "fundedProgramme"
value[x] |  | 0..1 | CodeableConcept | Value of extension Binding: Funded Programme (required)
extension:currentAvailability |  | 0..1 | Extension | Extension
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "currentAvailability"
value[x] |  | 0..1 | boolean | Value of extension
extension:notes |  | 0..1 | Extension | Extension
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "notes"
value[x] |  | 0..1 | string | Value of extension
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/funded-programme"
value[x] |  | 0..0 |  | Value of extension
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | Funded Healthcare Programme
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:fundedProgramme |  | 0..1 | Extension | Extension
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "fundedProgramme"
value[x] |  | 0..1 | CodeableConcept | Value of extension Binding: Funded Programme (required)
extension:currentAvailability |  | 0..1 | Extension | Extension
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "currentAvailability"
value[x] |  | 0..1 | boolean | Value of extension
extension:notes |  | 0..1 | Extension | Extension
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "notes"
value[x] |  | 0..1 | string | Value of extension
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/funded-programme"
Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Funded NZ Healthcare Programmes

- fundedProgramme: CodeableConcept: The type of healthcare programme
- currentAvailability: boolean: The current status
- notes: string: Further details about the programme and status.

Maturity: 1

Differential View

This structure is derived from Extension

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | Funded Healthcare Programme
Slices for extension |  |  |  | Content/Rules for all slices
extension:fundedProgramme |  | 0..1 | Extension | Extension
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "fundedProgramme"
value[x] |  | 0..1 | CodeableConcept | Value of extension Binding: Funded Programme (required)
extension:currentAvailability |  | 0..1 | Extension | Extension
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "currentAvailability"
value[x] |  | 0..1 | boolean | Value of extension
extension:notes |  | 0..1 | Extension | Extension
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "notes"
value[x] |  | 0..1 | string | Value of extension
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/funded-programme"
value[x] |  | 0..0 |  | Value of extension
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | Funded Healthcare Programme
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:fundedProgramme |  | 0..1 | Extension | Extension
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "fundedProgramme"
value[x] |  | 0..1 | CodeableConcept | Value of extension Binding: Funded Programme (required)
extension:currentAvailability |  | 0..1 | Extension | Extension
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "currentAvailability"
value[x] |  | 0..1 | boolean | Value of extension
extension:notes |  | 0..1 | Extension | Extension
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "notes"
value[x] |  | 0..1 | string | Value of extension
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/funded-programme"
Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Funded NZ Healthcare Programmes

- fundedProgramme: CodeableConcept: The type of healthcare programme
- currentAvailability: boolean: The current status
- notes: string: Further details about the programme and status.

Maturity: 1

Other representations of profile: CSV, Excel, Schematron

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Extension.extension:fundedProgramme.​value[x] | Base | required | Funded Programme | 📦1.0.0 | This IG

#### Constraints

Id | Grade | Path(s) | Description | Expression
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`