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: District Health Board linked to a NZ Healthcare Service, Location or Patient

Official URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Version: 1.0
Active as of 2020-07-31 Maturity Level: 3 Computable Name: Dhb

Copyright/Legal: HL7 New Zealand© 2020+; Licensed Under Creative Commons No Rights Reserved.

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

Administrative - to allow NZ HealthcareService, Location (Facility) or Patient Resources to include the related District Health Board.

Context of Use

Example of extension


  <extension url="http://hl7.org.nz/fhir/StructureDefinition/dhb">
    <valueCodeableConcept>
      <coding>
        <system value="https://standards.digital.health.nz/ns/dhb-code"/>
        <code value="G00026-A"/>
        <display value="Northland"/>
      </coding>
    </valueCodeableConcept>
  </extension>

Example instances

Patient with DHB

Usage info

Usages:

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.

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension District Health Board linked to a NZ Healthcare Service, Location or Patient
... extension 0..0
... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/dhb"
... value[x] 0..1 CodeableConcept NZ District Health Boards
Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
Example Waikato DHB: {"coding":[{"system":"https://standards.digital.health.nz/ns/dhb-code","version":"1.0","code":"G00027-C","display":"Waikato District Health Board"}]}

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension District Health Board linked to a NZ Healthcare Service, Location or Patient
... id 0..1 string Unique id for inter-element referencing
... extension 0..0
... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/dhb"

doco Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type CodeableConcept: District Health Board relating to a NZ Healthcare Service, Location (Facility) or Patient (primary, physical home address).

Maturity: 3

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension District Health Board linked to a NZ Healthcare Service, Location or Patient
... extension 0..0
... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/dhb"
... value[x] 0..1 CodeableConcept NZ District Health Boards
Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
Example Waikato DHB: {"coding":[{"system":"https://standards.digital.health.nz/ns/dhb-code","version":"1.0","code":"G00027-C","display":"Waikato District Health Board"}]}

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension District Health Board linked to a NZ Healthcare Service, Location or Patient
... id 0..1 string Unique id for inter-element referencing
... extension 0..0
... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/dhb"

doco Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type CodeableConcept: District Health Board relating to a NZ Healthcare Service, Location (Facility) or Patient (primary, physical home address).

Maturity: 3

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
Extension.value[x]extensibleDHB(a valid code from NZ DHB)
https://nzhts.digital.health.nz/fhir/ValueSet/dhb-code
From this IG

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()