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

Terminology

ValueSets

Valuesets are selectors of concepts (represented as codes) that are used to indicate preferred values for specific elements in a particular context. The codes are actually defined in a Code System. The profile is used to 'bind' the ValueSet to an element. A ValueSet can refer to concepts from multiple CodeSystems, and any concept can be references by many ValueSets. Ideally (and the case in this guide) the url of the valueSet will 'resolve' - entering it into a browser or REST client will return the ValueSet. A common pattern is to have a ValueSet that 'includes' all the codes from a code system.
ValueSetPurposeUrlCodeSystem Urls
Address Not Validated reasonThe reason why the address was not validatedhttps://standards.digital.health.nz/fhir/ValueSet/address-not-validated-reason-code
IwiNew Zealand iwi codeshttps://standards.digital.health.nz/fhir/ValueSet/iwi-code
Patient citizenship statusStatus of citizenship in NZ​https://standards.digital.health.nz/fhir/ValueSet/citizenship-status-code
domicileCodedomicileCodehttps://standards.digital.health.nz/fhir/ValueSet/domicile-code
Patient ethnicityLevel 4 ethnicity codeshttps://standards.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code
InformationSourceThe source from where the value of this item was sourcedhttps://standards.digital.health.nz/fhir/ValueSet/information-source-code
Gender codes including IndeterminateAdditional genders for Patient​https://standards.digital.health.nz/fhir/ValueSet/nz-additional-gender-code
NZ Residency statusIs the person a NZ residenthttps://standards.digital.health.nz/fhir/ValueSet/nz-residency-status-code



CodeSystems

These are codesystems that have been defined by this guide. They define specific concepts that are included in ValueSets. It is preferabe to use an international code systm such as SNOMED, ICD or LOINC - but this is not always possible.

Each CodeSystem has a globally unique url that is used to unambiguously identiy it. The url generally refers to a describtion of the codesystem, rather than to the FHIR CodeSystem resource.

The FHIR spec has much more detail on the use of Terminology in FHIR

CodeSystemPurposeCodeSystem Url
Address Not Validated reasonThe reason why the address was not validatedhttps://standards.digital.health.nz/ns/address-not-validated-reason-code
IwiNew Zealand iwi codeshttps://standards.digital.health.nz/ns/iwi-code
Patient citizenship statusStatus of citizenship in NZ​https://standards.digital.health.nz/ns/citizenship-status-code
domicileCodedomicileCodehttps://standards.digital.health.nz/ns/domicile-code
Level 4 ethnicity codesLevel 4 ethnicity codeshttps://standards.digital.health.nz/ns/ethnic-group-level-4-code
InformationSourceAll possible sources of informationhttps://standards.digital.health.nz/ns/information-source-code
Patient citizenship statusAdditional genders for Patient​https://standards.digital.health.nz/ns/nz-additional-gender-code
NZ Residency statusNZ Residency statushttps://standards.digital.health.nz/ns/nz-residency-status-code