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

## Terminology

### ValueSets

These are ValueSets that have been defined in this guide for coded elements.

Each ValueSet resource has a globally unique url (the Canonical url) that is used to unambiguously identify it. This url generally should resolve to the to the FHIR ValueSet resource, though the infrastructure to support this is not yet in place. There's a specific note in the spec on ValueSet identification.

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

ValueSet | Purpose | Canonical url
--- | --- | ---
ACC Patient Occupation | ValueSet of codes for classifying patient occupations, drawn from the ACC codeset | https://nzhts.digital.health.nz/fhir/ValueSet/acc-patient-occupation-code
Additional Practitioner authorisations | A coded type for additional authorisations | https://nzhts.digital.health.nz/fhir/ValueSet/practitioner-additional-authorisation-code
Alias types | The complete set of alias types that apply to Locations and Organizations | https://nzhts.digital.health.nz/fhir/ValueSet/alias-type-code
ContactPoint purpose | The purpose of a ContactPoint - what it is used for. | https://nzhts.digital.health.nz/fhir/ValueSet/contact-point-purpose-code
Coverage Category | New Zealand codes for Coverage category types | https://nzhts.digital.health.nz/fhir/ValueSet/coverage-category-code
Coverage Type | New Zealand codes for Coverage Types | https://nzhts.digital.health.nz/fhir/ValueSet/coverage-type-code
Datum code | Datum codes used | https://nzhts.digital.health.nz/fhir/ValueSet/nz-datum-code
Death date Information Source | The source from where the date of death was sourced | https://nzhts.digital.health.nz/fhir/ValueSet/dod-information-source-code
District Health Board Identifer | District Health Board Identifer. Assigned by the HPI. | https://nzhts.digital.health.nz/fhir/ValueSet/dhb-code
Domicile Code | Domicile Code | https://nzhts.digital.health.nz/fhir/ValueSet/domicile-code
Ethnicity of a person (L4) | Codes to record a person's ethnicity, drawn from Level 4 of the Ethnicity code system | https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code
Ethnicity of a person (full) | Ethnicity New Zealand Standard Classification 2005. Ethnicity is the ethnic group or groups that people identify with or feel they belong to. | https://nzhts.digital.health.nz/fhir/ValueSet/nz-ethnic-group-code
Funded Programme | Codes to describe NZ-specific types of funded programmes. | https://nzhts.digital.health.nz/fhir/ValueSet/funded-programme-code
Information Source | The source from where the value of this item was sourced | https://nzhts.digital.health.nz/fhir/ValueSet/information-source-code
Iwi | New Zealand iwi codes. The 2 digit codes are abstract codes and provided in the expansion for navigational purposes. A user should not select an abstract code directly as a proper value. | https://nzhts.digital.health.nz/fhir/ValueSet/iwi-code
Māori Descent | A code indicating whether a person is of Māori descent | https://nzhts.digital.health.nz/fhir/ValueSet/maori-descent
NZ Citizenship status | Citizenship status | https://nzhts.digital.health.nz/fhir/ValueSet/nz-citizenship-status-code
NZ Residency status | Is the person a NZ resident | https://nzhts.digital.health.nz/fhir/ValueSet/nz-residency-code
PHO | Primary Healthcare Organization | https://nzhts.digital.health.nz/fhir/ValueSet/pho-code
PractitionerRole status reason | The reason for the change in status of PractitionerRole | https://nzhts.digital.health.nz/fhir/ValueSet/hpi-practitioner-role-status-reason-code
Registration Status of Practitioners | The code list represents the current practicing status of the Provider Person as per their registration with an RA. | https://nzhts.digital.health.nz/fhir/ValueSet/practitioner-registration-status-code
Scope of practice | A coded type for professional scope of practice. | https://nzhts.digital.health.nz/fhir/ValueSet/practitioner-scope-of-practice-code
Valid use values for NHI | NHI Use codes | https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code

### CodeSystems

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

Each CodeSystem resource has a globally unique url (the canonical url) that is used to unambiguously identify it. The url generally refers to a description of the codesystem, rather than to the FHIR CodeSystem resource.

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

CodeSystem | Purpose | Canonical Url
--- | --- | ---
ACC Patient Occupation CodeSystem | Codes for classifying patient occupations, drawn from the ACC codeset | https://standards.digital.health.nz/ns/acc-patient-occupation-code
Additional Authorisation | Additional authorisations that a practitioner is authorised to practice or prescribe. | https://standards.digital.health.nz/ns/practitioner-additional-authorisation-code
ContactPoint purpose | The purpose of a ContactPoint - what it is used for. | https://standards.digital.health.nz/ns/contact-point-purpose-code
Coverage category | New Zealand codes for Coverage category types | https://standards.digital.health.nz/ns/coverage-category-code
Coverage type | New Zealand codes for Coverage Types | https://standards.digital.health.nz/ns/coverage-type-code
Datum codes | Possible datum codes | https://standards.digital.health.nz/ns/nz-datum-code
Domicile Code | Domicile Code | https://standards.digital.health.nz/ns/domicile-code
Funded Programme | Codes to describe NZ-specific types of funded programmes. | https://standards.digital.health.nz/ns/funded-programme-code
Information Source | All possible sources of information | https://standards.digital.health.nz/ns/information-source-code
Level 4 ethnicity codes | Codes to record a person’s ethnicity, drawn from Level 4 of the Ethnicity code system described here | https://standards.digital.health.nz/ns/ethnic-group-level-4-code
Māori Descent | Codes for classifying Māori descent. Defined by Stats NZ - Māori descent v1.0.0 | https://standards.digital.health.nz/ns/maori-descent-code
NZ Citizenship status | Is this person a NZ Citizen | https://standards.digital.health.nz/ns/nz-citizenship-status-code
NZ DHB | NZ District Health Board (HPI-ORG) Codes | https://standards.digital.health.nz/ns/dhb-code
NZ Iwi | NZ Iwi Statistical Standard | https://standards.digital.health.nz/ns/iwi-code
NZ Residency status | NZ Residency status | https://standards.digital.health.nz/ns/nz-residency-code
NZ ethnic group codes | Ethnicity New Zealand Standard Classification 2005. Ethnicity is the ethnic group or groups that people identify with or feel they belong to. | https://standards.digital.health.nz/ns/nz-ethnic-group-codes
PHO | Primary Healthcare Organization | https://standards.digital.health.nz/ns/pho-code
PractitionerRole status reason | The reason for the change in status of PractitionerRole | https://standards.digital.health.nz/ns/hpi-practitioner-role-status-reason-code
Registration Status of Practitioners | The code list represents the current practicing status of the Provider Person as per their registration with an RA. | https://standards.digital.health.nz/ns/practitioner-registration-status-code
Scope of practice | A classification of the type or range of health services that a practitioner is authorised to provide, as determined by the Responsible Authority or other statutory authority (e.g. PHARMAC), that is, what the practitioner can or cannot do. It includes Scope of Practice as defined by the Health Practitioners Competence Assurance Act 2003, any special authorisations granted, and any conditions or limitations imposed by the Responsible Authority. | https://standards.digital.health.nz/ns/practitioner-scope-of-practice-code
Type of Alias | Used in Organization and Location to indicate what is the type of Alias | https://standards.digital.health.nz/ns/alias-type-code