HL7® FHIR® New Zealand Base Implementation Guide
1.0.0 - Release

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

Extension: Dhb - Detailed Descriptions

Definitions for the dhb extension.

1. Extension
Definition

District Health Board relating to a NZ Healthcare Service, Location (Facility) or Patient (primary, physical home address).

Control0..* This element is affected by the following invariants: ele-1
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
2. Extension.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
3. Extension.extension
Definition

An Extension

Control0..0
TypeExtension
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
4. Extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org.nz/fhir/StructureDefinition/dhb
5. Extension.value[x]
Definition

NZ District Health Boards as defined in the NZ Health Provider Index Listing published by the NZ Ministry of Health each month.

Control0..1
BindingThe codes SHALL be taken from District Health Board Identifer; other codes may be used where these codes are not suitable NZ HPI-ORG Values for DHBs

TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
Requirements

The NzDHB ValueSet should be used as this provides the correct NZ HPI-ORG ID for each of the 20 District Health Boards.The binding strength is extensible as this is the most suitable option for a Codeable Concept data type.

Example
Waikato DHB:<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="https://standards.digital.health.nz/ns/dhb-code"/>
    <version value="1.0"/>
    <code value="G00027-C"/>
    <display value="Waikato"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))