New Zealand NHI IG
0.2.0 - CI Build

New Zealand NHI IG, published by David Hay. This is not an authorized publication; it is the continuous build for version 0.2.0). This version is based on the current content of https://github.com/HL7NZ/nhi/ and changes regularly. See the Directory of published versions

Extensions


Extensions defined in this guide

Id Url Context of Use Description
birth-place http://hl7.org.nz/fhir/StructureDefinition/birth-place
Patient
The country where the person was born
building-name http://hl7.org.nz/fhir/StructureDefinition/building-name
Address
Used on an adddress datatype when a building name is needed
citizenship http://hl7.org.nz/fhir/StructureDefinition/citizenship
Patient
New Zealand citizenship
domicile-code http://hl7.org.nz/fhir/StructureDefinition/domicile-code
Address
The domicile code. Derived from the address
gp-practice-enrollment-date http://hl7.org.nz/fhir/StructureDefinition/gp-practice-enrollment-date
Patient
The date that the patient was enrolled with their GP Practicce
information-source http://hl7.org.nz/fhir/StructureDefinition/information-source
Element
The source of the information. Used paricularly in the NHI. Note this not the person but rather than it came from a passport for example
is-primary-address http://hl7.org.nz/fhir/StructureDefinition/is-primary-address
Element
Indicates this is the primary residential address - each patient must have one and only one
nhi-address-derived http://hl7.org.nz/fhir/StructureDefinition/nhi-address-derived
Address
Address elements that are directly derived from the actual address
not-validated-address-reason http://hl7.org.nz/fhir/StructureDefinition/not-validated-address-reason
Element
The reason why the address has not been validated
nz-ethnicity http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Element
The ethnicity of the patient. Uses level 4 codes (most detailed).
nz-geocode http://hl7.org.nz/fhir/StructureDefinition/nz-geocode
Address
The new zealand geocode. This uses a different datum from that defined in the spec for the geocode, so is an extension rather than using the element in the spec. see discussion at https://chat.fhir.org/#narrow/stream/179166-implementers/topic/geocode.20extension
nz-residency-status http://hl7.org.nz/fhir/StructureDefinition/nz-residency-status
Patient
NZ Residency status
patient-iwi http://hl7.org.nz/fhir/StructureDefinition/patient-iwi
Patient
Persons Iwi affiliation
sex-at-birth http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth
Patient
The persons sex when born. Is considered to be immutable
suburb http://hl7.org.nz/fhir/StructureDefinition/suburb
Address
The suburb of the address. This is not the same as 'district' or 'state.

Extensions used but defined elsewhere

Url Description IG
http://hl7.org/fhir/StructureDefinition/iso21090-preferred Defined outside of known IG's
http://hl7.org/fhir/StructureDefinition/originalText Defined outside of known IG's