HL7® FHIR® New Zealand Base Implementation Guide
3.1.0 - Draft
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
| Official URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency | Version: 1.0.0 | |||
| Active as of 2025-09-12 | Computable Name: NZResidency | |||
NZ Residency status
Context of Use
This extension may be used on the following element(s)
Patient
Usage info
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Extension |
0..* | Extension | Extension | |
  Slices for extension |
Content/Rules for all slices | |||
   extension:status |
0..1 | Extension | Extension | |
   extension |
0..0 | |||
| 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 | |||
| 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 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 | |||
| 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 | |||
| 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
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Extension | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:status |
0..1 | Extension | Extension | |
| extension |
0..0 | |||
| 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 | |||
| 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 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 | |||
| 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 | |||
| 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
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet | URI |
| Extension.extension:status.value[x] | preferred | NZResidency(a valid code from NZ Residency status)https://nzhts.digital.health.nz/fhir/ValueSet/nz-residency-codeFrom this IG | |
| Extension.extension:source.value[x] | preferred | InformationSource(a valid code from Information Source)https://nzhts.digital.health.nz/fhir/ValueSet/information-source-codeFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |