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

HL7® FHIR® New Zealand Base Implementation Guide - Local Development build (v3.0.0). See the Directory of published versions

Extension: Dhb - Detailed Descriptions

Active as of 2020-07-31 Maturity Level: 3

Definitions for the dhb extension.

Guidance on how to interpret the contents of this table can be found here.

1. Extension
Definition

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

Optional Extension Element - found in all resources.

2. Extension.extension
Control0..0*
3. Extension.url
Fixed Valuehttp://hl7.org.nz/fhir/StructureDefinition/dhb
4. 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.

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

BindingThe codes SHALL be taken from District Health Board Identifer; other codes may be used where these codes are not suitableFor codes, see (unbound) NZ HPI-ORG Values for DHB
TypeChoice of: , date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[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 District Health Board"/>
  </coding>
</valueCodeableConcept>

Guidance on how to interpret the contents of this table can be found here.

1. Extension
Definition

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

Optional Extension Element - found in all resources.

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.extension
Definition

An Extension

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..0*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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
3. Extension.url
Definition

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

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
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
4. 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.

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
BindingThe codes SHALL be taken from District Health Board Identifer; other codes may be used where these codes are not suitableFor codes, see (unbound) NZ HPI-ORG Values for DHB
TypeChoice of: CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summaryfalse
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 District Health Board"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here.

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
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
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
3. Extension.extension
Definition

An Extension

Control0..0
TypeExtension
Summaryfalse
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
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
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 DHB
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summaryfalse
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 District Health Board"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))