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: NZResidency

Official URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency | Version: 1.0.0
Active as of 2025-12-18 | Computable Name: NZResidency

NZ Residency status

Context of Use

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

- Element ID: `Patient`

Usage info

Usages:

- Use this Extension: NZ Patient
- Examples for this Extension: Patient/patient-nz-residency

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 | Extension
Slices for extension |  |  |  | Content/Rules for all slices
extension:status |  | 0..1 | Extension | Extension
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "status"
value[x] |  | 0..1 | CodeableConcept | Value of extension Binding: NZ Residency status (preferred)
extension:source |  | 0..1 | Extension | Extension
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "source"
value[x] |  | 0..1 | CodeableConcept | Value of extension Binding: Information Source (preferred)
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nz-residency"
value[x] |  | 0..0 |  | Value of extension
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | Extension
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:status |  | 0..1 | Extension | Extension
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "status"
value[x] |  | 0..1 | CodeableConcept | Value of extension Binding: NZ Residency status (preferred)
extension:source |  | 0..1 | Extension | Extension
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "source"
value[x] |  | 0..1 | CodeableConcept | Value of extension Binding: Information Source (preferred)
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nz-residency"
Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: NZ Residency status

- status: CodeableConcept: Residency Status
- source: CodeableConcept: The source of information concerning the residency

Differential View

This structure is derived from Extension

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | Extension
Slices for extension |  |  |  | Content/Rules for all slices
extension:status |  | 0..1 | Extension | Extension
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "status"
value[x] |  | 0..1 | CodeableConcept | Value of extension Binding: NZ Residency status (preferred)
extension:source |  | 0..1 | Extension | Extension
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "source"
value[x] |  | 0..1 | CodeableConcept | Value of extension Binding: Information Source (preferred)
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nz-residency"
value[x] |  | 0..0 |  | Value of extension
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | Extension
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:status |  | 0..1 | Extension | Extension
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "status"
value[x] |  | 0..1 | CodeableConcept | Value of extension Binding: NZ Residency status (preferred)
extension:source |  | 0..1 | Extension | Extension
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "source"
value[x] |  | 0..1 | CodeableConcept | Value of extension Binding: Information Source (preferred)
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nz-residency"
Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: NZ Residency status

- status: CodeableConcept: Residency Status
- source: CodeableConcept: The source of information concerning the residency

Other representations of profile: CSV, Excel, Schematron

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Extension.extension:status.​value[x] | Base | preferred | NZ Residency status | 📦1.1.0 | This IG
Extension.extension:source.​value[x] | Base | preferred | Information Source | 📦1.0.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()`