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: NZ Domicile Code

Official URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code | Version: 0.1.0
Active as of 2020-07-20 | Computable Name: Domicile_code
Copyright/Legal: HL7 New Zealand© 2020+; Licensed Under Creative Commons No Rights Reserved.

NZ Domicile Code. Derived from a patient's primary physical, home address.

Context of Use

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

- Element ID: `Patient`
- Element ID: `Address`

Example of extension

      <extension url="http://hl7.org.nz/fhir/StructureDefinition/domicile-code">
        <valueCodeableConcept>
          <coding>
            <system value="https://standards.digital.health.nz/ns/domicile-code"/>
            <code value="0040"/>
            <display value="Waipu"/>
          </coding>
        </valueCodeableConcept>
      </extension>

Example instances

Patient with domicile code

Usage info

Usages:

- Use this Extension: Common NZ Address datatype and NZ Patient
- Examples for this Extension: Patient/patient-domicile-code

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 | NZ Domicile Code
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/domicile-code"
value[x] |  | 0..1 | CodeableConcept | Value of extension Binding: Domicile Code (preferred)
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | NZ Domicile Code
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/domicile-code"
value[x] |  | 0..1 | CodeableConcept | Value of extension Binding: Domicile Code (preferred)
Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type CodeableConcept: NZ Domicile Code. Derived from a patient's primary physical, home address.

Differential View

This structure is derived from Extension

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | NZ Domicile Code
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/domicile-code"
value[x] |  | 0..1 | CodeableConcept | Value of extension Binding: Domicile Code (preferred)
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | NZ Domicile Code
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/domicile-code"
value[x] |  | 0..1 | CodeableConcept | Value of extension Binding: Domicile Code (preferred)
Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type CodeableConcept: NZ Domicile Code. Derived from a patient's primary physical, home address.

Other representations of profile: CSV, Excel, Schematron

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Extension.value[x] | Base | preferred | Domicile Code | 📦3.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()`