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

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems complying with the implementation guide are expected to declare conformance to one or more of the following capability statements.

NhiCapabilityStatement A FHIR API in front of the New Zealand NHI

Structures: Resource Profiles

These define constraints on FHIR resources that need to be complied with by conformant implementations

Common Patient profiling The base Patient resource in NZ. Slices on identifer for NHI numbers (current & old), uses nzAddress and adds sme commonly used extensions
NHI Patient The Patient resource exposed by the NHI.

Structures: Data Type Profiles

These define constraints on FHIR data types that need to be complied with by conformant implementations

Common NZ Address datatype Adds building name, suburb, domicile code and geocode to the Address datatype
NHI Address Adds additional, NHI specific extensions

Structures: Extension Definitions

These define constraints on FHIR data types that need to be complied with by conformant implementations

BirthPlace The country where the person was born
BuildingName Used on an adddress datatype when a building name is needed
DomicileCode The domicile code. Derived from the address
GPPracticeEnrollmentDate The date that the patient was enrolled with their GP Practicce
Informationsource 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
IsPrimaryAddress Indicates this is the primary residential address - each patient must have one and only one
NZResidencyStatus NZ Residency status
NhiAddressDerived Address elements that are directly derived from the actual address
NotValidatedAddressReason The reason why the address has not been validated
NzCitizenship New Zealand citizenship
NzEthnicity The ethnicity of the individual. Uses level 4 codes (most detailed).
NzGeocode 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
Patient_iwi Persons Iwi affiliation
SexAtBirth The persons sex when born. Is considered to be immutable
Suburb The suburb of the address. This is not the same as 'district' or 'state.

Terminology: Value Sets

These define sets of codes used by systems conforming with this implementation guide

Gender codes including Indeterminate Additional sex values for Patient
Address Not Validated reason The reason why the address was not validated
domicileCode domicileCode
Ethnicity of a perrson Level 4 ethnicity codes
InformationSource The source from where the value of this item was sourced
Iwi New Zealand iwi codes
NZ Residency status Is the person a NZ resident
New Zealand citizenship status Status of citizenship in NZ

Terminology: Code Systems

These define new code systems used by systems conforming with this implementation guide

Patient citizenship status Additional sex values for Patient
Address Not Validated reason The reason why the address was not validated
domicileCode domicileCode
Level 4 ethnicity codes Level 4 ethnicity codes
InformationSource All possible sources of information
Iwi New Zealand iwi codes
NZ Residency status NZ Residency status
New Zealand citizenship status Status of citizenship in NZ

Terminology: Naming Systems

These define identifier and/or code system identities used by systems conforming with this implementation guide

nhi NHI number