New Zealand NHI IG
1.6.5 - Release

New Zealand NHI IG - Local Development build (v1.6.5) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Data Type Profile: NHI Address

Official URL: http://hl7.org.nz/fhir/StructureDefinition/NhiAddress | Version: 1.6.5
Active as of 2026-02-09 | Computable Name: NhiAddress

Adds additional, NHI specific extensions

Usages:

- Use this DataType Profile: NHI Patient

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

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

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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Address |  | 0..* | NzAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Slices for extension |  |  |  | Content/Rules for all slices
extension:nz-geocode |  | 0..1 | (Complex) | A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
extension:suburb |  | 0..1 | string | The suburb part of the address URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
extension:building-name |  | 0..1 | string | The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
extension:domicile-code |  | 0..1 | CodeableConcept | The domicile code associated with this address URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
extension:notValidatedAddressReason |  | 0..1 | CodeableConcept | The reason an address was not validated URL: http://hl7.org.nz/fhir/StructureDefinition/not-validated-address-reason Binding: Address Not Validated Reason (preferred)
extension:nz-address-id |  | 0..1 | string | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-address-id
extension:nz-address-derived |  | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nhi-address-derived
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: NHI Address Use Codes (required) Example General: home
type | Σ | 1..1 | code | postal | physical Binding: NHI Address Type Codes (required) Example General: both
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: ISO 3166-1:2013 (2-alpha country code) (required)
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Address.use | Base | required | NHI Address Use Codes | 📦1.0.0 | HIP FHIR Common Terminology Guide v1.9
Address.type | Base | required | NHI Address Type Codes | 📦1.0 | HIP FHIR Common Terminology Guide v1.9
Address.country | Base | required | ISO 3166-1:2013 (2-alpha country code) | 📦2013 | HIP FHIR Common Terminology Guide v1.9

#### 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()`

This structure is derived from NzAddress

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Address |  |  | NzAddress |
Slices for extension |  |  |  | Content/Rules for all slices
extension:notValidatedAddressReason |  | 0..1 | CodeableConcept | The reason an address was not validated URL: http://hl7.org.nz/fhir/StructureDefinition/not-validated-address-reason Binding: Address Not Validated Reason (preferred)
extension:nz-address-id |  | 0..1 | string | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-address-id
extension:nz-address-derived |  | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nhi-address-derived
use |  | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: NHI Address Use Codes (required)
type |  | 1..1 | code | postal | physical Binding: NHI Address Type Codes (required)
district |  | 0..0 |  | District name (aka county)
state |  | 0..0 |  | Sub-unit of country (abbreviations ok)
country |  | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: ISO 3166-1:2013 (2-alpha country code) (required)
period |  | 0..0 |  | Time period when address was/is in use
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Address.use | Base | required | NHI Address Use Codes | 📦1.0.0 | HIP FHIR Common Terminology Guide v1.9
Address.type | Base | required | NHI Address Type Codes | 📦1.0 | HIP FHIR Common Terminology Guide v1.9
Address.country | Base | required | ISO 3166-1:2013 (2-alpha country code) | 📦2013 | HIP FHIR Common Terminology Guide v1.9

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Address |  | 0..* | NzAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats)
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:nz-geocode |  | 0..1 | (Complex) | A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
extension:suburb |  | 0..1 | string | The suburb part of the address URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
extension:building-name |  | 0..1 | string | The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
extension:domicile-code |  | 0..1 | CodeableConcept | The domicile code associated with this address URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
extension:notValidatedAddressReason |  | 0..1 | CodeableConcept | The reason an address was not validated URL: http://hl7.org.nz/fhir/StructureDefinition/not-validated-address-reason Binding: Address Not Validated Reason (preferred)
extension:nz-address-id |  | 0..1 | string | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-address-id
extension:nz-address-derived |  | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nhi-address-derived
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: NHI Address Use Codes (required) Example General: home
type | Σ | 1..1 | code | postal | physical Binding: NHI Address Type Codes (required) Example General: both
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: ISO 3166-1:2013 (2-alpha country code) (required)
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Address.use | Base | required | NHI Address Use Codes | 📦1.0.0 | HIP FHIR Common Terminology Guide v1.9
Address.type | Base | required | NHI Address Type Codes | 📦1.0 | HIP FHIR Common Terminology Guide v1.9
Address.country | Base | required | ISO 3166-1:2013 (2-alpha country code) | 📦2013 | HIP FHIR Common Terminology Guide v1.9

#### 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()`

This structure is derived from NzAddress

Summary

Mandatory: 1 element
Prohibited: 3 elements

Extensions

This structure refers to these extensions:

- http://hl7.org.nz/fhir/StructureDefinition/not-validated-address-reason
- http://hl7.org.nz/fhir/StructureDefinition/nz-address-id
- http://hl7.org.nz/fhir/StructureDefinition/nhi-address-derived

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Address |  | 0..* | NzAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Slices for extension |  |  |  | Content/Rules for all slices
extension:nz-geocode |  | 0..1 | (Complex) | A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
extension:suburb |  | 0..1 | string | The suburb part of the address URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
extension:building-name |  | 0..1 | string | The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
extension:domicile-code |  | 0..1 | CodeableConcept | The domicile code associated with this address URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
extension:notValidatedAddressReason |  | 0..1 | CodeableConcept | The reason an address was not validated URL: http://hl7.org.nz/fhir/StructureDefinition/not-validated-address-reason Binding: Address Not Validated Reason (preferred)
extension:nz-address-id |  | 0..1 | string | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-address-id
extension:nz-address-derived |  | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nhi-address-derived
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: NHI Address Use Codes (required) Example General: home
type | Σ | 1..1 | code | postal | physical Binding: NHI Address Type Codes (required) Example General: both
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: ISO 3166-1:2013 (2-alpha country code) (required)
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Address.use | Base | required | NHI Address Use Codes | 📦1.0.0 | HIP FHIR Common Terminology Guide v1.9
Address.type | Base | required | NHI Address Type Codes | 📦1.0 | HIP FHIR Common Terminology Guide v1.9
Address.country | Base | required | ISO 3166-1:2013 (2-alpha country code) | 📦2013 | HIP FHIR Common Terminology Guide v1.9

#### 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()`

Differential View

This structure is derived from NzAddress

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Address |  |  | NzAddress |
Slices for extension |  |  |  | Content/Rules for all slices
extension:notValidatedAddressReason |  | 0..1 | CodeableConcept | The reason an address was not validated URL: http://hl7.org.nz/fhir/StructureDefinition/not-validated-address-reason Binding: Address Not Validated Reason (preferred)
extension:nz-address-id |  | 0..1 | string | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-address-id
extension:nz-address-derived |  | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nhi-address-derived
use |  | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: NHI Address Use Codes (required)
type |  | 1..1 | code | postal | physical Binding: NHI Address Type Codes (required)
district |  | 0..0 |  | District name (aka county)
state |  | 0..0 |  | Sub-unit of country (abbreviations ok)
country |  | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: ISO 3166-1:2013 (2-alpha country code) (required)
period |  | 0..0 |  | Time period when address was/is in use
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Address.use | Base | required | NHI Address Use Codes | 📦1.0.0 | HIP FHIR Common Terminology Guide v1.9
Address.type | Base | required | NHI Address Type Codes | 📦1.0 | HIP FHIR Common Terminology Guide v1.9
Address.country | Base | required | ISO 3166-1:2013 (2-alpha country code) | 📦2013 | HIP FHIR Common Terminology Guide v1.9

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Address |  | 0..* | NzAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats)
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:nz-geocode |  | 0..1 | (Complex) | A geocode using the NZ specific datum (reference point) URL: http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
extension:suburb |  | 0..1 | string | The suburb part of the address URL: http://hl7.org.nz/fhir/StructureDefinition/suburb
extension:building-name |  | 0..1 | string | The name of the building URL: http://hl7.org.nz/fhir/StructureDefinition/building-name
extension:domicile-code |  | 0..1 | CodeableConcept | The domicile code associated with this address URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
extension:notValidatedAddressReason |  | 0..1 | CodeableConcept | The reason an address was not validated URL: http://hl7.org.nz/fhir/StructureDefinition/not-validated-address-reason Binding: Address Not Validated Reason (preferred)
extension:nz-address-id |  | 0..1 | string | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-address-id
extension:nz-address-derived |  | 0..1 | (Complex) | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nhi-address-derived
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: NHI Address Use Codes (required) Example General: home
type | Σ | 1..1 | code | postal | physical Binding: NHI Address Type Codes (required) Example General: both
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: ISO 3166-1:2013 (2-alpha country code) (required)
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Address.use | Base | required | NHI Address Use Codes | 📦1.0.0 | HIP FHIR Common Terminology Guide v1.9
Address.type | Base | required | NHI Address Type Codes | 📦1.0 | HIP FHIR Common Terminology Guide v1.9
Address.country | Base | required | ISO 3166-1:2013 (2-alpha country code) | 📦2013 | HIP FHIR Common Terminology Guide v1.9

#### 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()`

This structure is derived from NzAddress

Summary

Mandatory: 1 element
Prohibited: 3 elements

Extensions

This structure refers to these extensions:

- http://hl7.org.nz/fhir/StructureDefinition/not-validated-address-reason
- http://hl7.org.nz/fhir/StructureDefinition/nz-address-id
- http://hl7.org.nz/fhir/StructureDefinition/nhi-address-derived

Other representations of profile: CSV, Excel, Schematron