HIP FHIR Common Terminology Guide
1.3.1 - Release

HIP FHIR Common Terminology Guide - Local Development build (v1.3.1). See the Directory of published versions

Terminology

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

Code Systems

TitleDescriptionCanonical url
SNOMED Health occupation subset (New Zealand Ministry of Health)-20190131

Health occupation subset. Refset Id 451000210100. Module Id 21000210109.

http://snomed.info/sct/223366009
ANZSCO - Australian and New Zealand Standard Classification of Occupations, 2013-1.2

Index of Principal Titles, Alternative Titles, Specialisations and Occupations in Not Elsewhere Classified (nec) Categories.

http://www.abs.gov.au/ausstats/abs@.nsf/mf/1220.0
NES Enrolment Termination Reason Code-1.0

A code to describe the reason the enrolment has ended

https://standards.digital.health.nz/nes-enrolment-termination-reason
NES Enrolment Type-1.0

Describes the type of health service which the enrolment is for

https://standards.digital.health.nz/nes-enrolment-type
Address Not Validated Reason-1.1

Reason why an address is not validated.

https://standards.digital.health.nz/ns/address-not-validated-reason-code
HPI Country Code-1.0

Supplementary country codes to extend ISO3166-1.

https://standards.digital.health.nz/ns/country-code
Ethnicity lvl 2-1.0

Ethnic Group Codes at Level 2

https://standards.digital.health.nz/ns/ethnic-group-level-2-code
Ethnicity lvl 3-1.0

Ethnic Group Codes at Level 3

https://standards.digital.health.nz/ns/ethnic-group-level-3-code
Ethnicity lvl 4. v2005 2.0-2.0

Ethnic Group Codes at Level 4.

https://standards.digital.health.nz/ns/ethnic-group-level-4-code
Gender v1.0-1.0

A coded type for a person's gender (M|F|I|U). Deprecated. Used in NHI HL7v2 legacy messaging

https://standards.digital.health.nz/ns/gender-code
Gender v1.1-1.1

A coded type for a person's gender(M|F|U). Used in HPI and NHI HL7v2 legacy messaging & SOAP v3 webservice.

https://standards.digital.health.nz/ns/gender-code
Gender v1.2-1.2

A coded type for a person's gender (M|F|O|U). Used in HPI and NHI HL7v2 legacy messaging & SOAP v3 webservice

https://standards.digital.health.nz/ns/gender-code
HIP Error Code-1.0

HIP Error Codes

https://standards.digital.health.nz/ns/hip-error-code
OrgFac Address Purpose-1.0

A coded type for organisation/facility address purpose (qualifier).

https://standards.digital.health.nz/ns/hpi-address-purpose
OrgFac Address Type-2.0

A coded type for organisation/facility address.

https://standards.digital.health.nz/ns/hpi-address-type
OrgFac Address Use-2.0

A coded type for organisation/facility address purpose (qualifier).

https://standards.digital.health.nz/ns/hpi-address-use
OrgFac Contact Type-2.0

A coded type for organisation/facility contact.

https://standards.digital.health.nz/ns/hpi-contact-type
OrgFac Contact Usage-2.0

A coded type for organisation/facility contact usage.

https://standards.digital.health.nz/ns/hpi-contact-usage
HPI Disestablishment Reason-1.0

Disestablishment Reason Code (Organisation and Facility)

https://standards.digital.health.nz/ns/hpi-disestablishment-reason
HPI Disestablishment Reason-2.0

Disestablishment Reason Code (Organisation and Facility)

https://standards.digital.health.nz/ns/hpi-disestablishment-reason
Facility Type-2.0

A coded value for facility type.

https://standards.digital.health.nz/ns/hpi-facility-type
Legacy HPI 2 alpha language codes-1.0

Legacy HPI two alpha language codes

https://standards.digital.health.nz/ns/hpi-legacy-language
Legal Entity Type-1.0

A coded value for organisation legal entity type.

https://standards.digital.health.nz/ns/hpi-legal-entity-type
Legal Entity Type-2.0

A coded value for organisation legal entity type.

https://standards.digital.health.nz/ns/hpi-legal-entity-type
OrgFac Name Qualifier-2.0

A code for organisation/facility name type/qualifier.

https://standards.digital.health.nz/ns/hpi-name-qualifier
HPI Legacy Name Type-2.0

A code for practitioner name type.

https://standards.digital.health.nz/ns/hpi-name-type
HPI Registration Authority Identifiers-1.0

A list of the registration authority identifiers.

https://standards.digital.health.nz/ns/hpi-ra-identifier-code
HPI Registration Status-1.0

The code list represents the current practicing status of the Provider Person as per their registration with an RA or a health worker source.

https://standards.digital.health.nz/ns/hpi-registration-status
HPI Registration Type-1.0

A code to identify the type of professional registration the healthcare provider person has been assigned.

https://standards.digital.health.nz/ns/hpi-registration-type
Location Type-1.0

A coded value for location type.

https://standards.digital.health.nz/ns/location-type-code
Name Prefix-1.0

A coded type for name prefixes.

https://standards.digital.health.nz/ns/name-prefix-code
Name Prefix-2.0

A coded type for name prefixes.

https://standards.digital.health.nz/ns/name-prefix-code
Name Suffix-1.0

Types of name suffixes used by HIP

https://standards.digital.health.nz/ns/name-suffix-code
NES Event Type-1.0

Identifies NES events.

https://standards.digital.health.nz/ns/nes-event-type
Patient Address Type-1.0

A coded type for patient address.

https://standards.digital.health.nz/ns/nhi-address-type
NHI Name Use Extra-1.0

Additional name use codes for NHI names

https://standards.digital.health.nz/ns/nhi-name-use-extra-code
NZSCC4N99 four digit country code-1999

NZSCC4N99 four digit numeric country codes (Statistics New Zealand Country Code List - NZSC 1999).

https://standards.digital.health.nz/ns/nzscc4n
Organisation Type-1.0

A coded value for organisation type.

https://standards.digital.health.nz/ns/organisation-type-code
Organisation Type-1.1

A coded value for organisation type.

https://standards.digital.health.nz/ns/organisation-type-code
HPI Registration Type-2.0

A code to identify the type of professional registration the healthcare provider person has been assigned.

https://standards.digital.health.nz/ns/practitioner-registration-authority-code
ISO3166-1 two character country code-2013

The purpose of ISO 3166 is to define internationally recognized codes of letters and/or numbers that we can use when we refer to countries and their subdivisions. However, it does not define the names of countries – this information comes from United Nations sources (Terminology Bulletin Country Names and the Country and Region Codes for Statistical Use maintained by the United Nations Statistics Divisions).

urn:iso:std:iso:3166
ISO 639-3:2007 (3-alpha language code)-2007

ISO 639-3 is a set of codes that defines three-letter identifiers for all known human languages.

urn:iso:std:iso:639:-3

ValueSets

NHI Address Type Codes-1.0

Types of address supported by the NHI

https://nzhts.digital.health.nz/fhir/ValueSet/addressType
ISO 3166-1:2013 (2-alpha country code)-2013

2-alpha country codes

https://nzhts.digital.health.nz/fhir/ValueSet/country-code
Country of Birth Information Source-1.2

A coded type for the source of information for a birth country.

https://nzhts.digital.health.nz/fhir/ValueSet/country-of-birth-source-code
Date of Birth Information Source-1.2

A coded type for the source of information for a birth date.

https://nzhts.digital.health.nz/fhir/ValueSet/date-of-birth-source-code
Date of Death Information Source-1.2

A coded type for the source of information for a death date.

https://nzhts.digital.health.nz/fhir/ValueSet/dod-information-source-code
HPI 2 digit ethnicity codes-1.0

HPI 2 digit ethnicity codes as used in the provider person extract

https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-2-code
HPI 3 digit ethnicity codes-1.0

HPI 3 digit ethnicity codes as used in the provider person extract

https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-3-code
Gender-1.0

A coded type for a person's gender.

https://nzhts.digital.health.nz/fhir/ValueSet/gender-code
Use values for a ContactSystem-1.0

System values for a ContactPoint

https://nzhts.digital.health.nz/fhir/ValueSet/hpi-contact-point-system-code
Use values for a ContactPoint-1.0

Use values for a ContactPoint

https://nzhts.digital.health.nz/fhir/ValueSet/hpi-contact-point-use-code
Contact Type-1.0

Contact type

https://nzhts.digital.health.nz/fhir/ValueSet/hpi-contact-type
Contact Usage-1.0

Contact usage

https://nzhts.digital.health.nz/fhir/ValueSet/hpi-contact-usage
HPI Disestablishment Reason-1.0

Disestablishment Reason Code (Organisation and Facility)

https://nzhts.digital.health.nz/fhir/ValueSet/hpi-disestablishment-reason
HPI Disestablishment Reason-2.0

Disestablishment Reason Code (Organisation and Facility)

https://nzhts.digital.health.nz/fhir/ValueSet/hpi-disestablishment-reason
Address Purpose (Qualifier) for Facility-1.0

Facility address purpose

https://nzhts.digital.health.nz/fhir/ValueSet/hpi-facility-address-purpose
Address Type for Facility-1.0

Facility address type

https://nzhts.digital.health.nz/fhir/ValueSet/hpi-facility-address-type
Name qualifier for Facility-1.0

Facility name qualifier

https://nzhts.digital.health.nz/fhir/ValueSet/hpi-facility-name-qualifier
Facility Type-1.0

Facility type

https://nzhts.digital.health.nz/fhir/ValueSet/hpi-facility-type
Use values for a HumanName-1.0

Use values for a HumanName

https://nzhts.digital.health.nz/fhir/ValueSet/hpi-human-name-use-code
IdentifierUse-1.0

Use values for an Identifier

https://nzhts.digital.health.nz/fhir/ValueSet/hpi-identifier-use-code
Old HPI two alpha language codes-1.0

2-alpha language codes

https://nzhts.digital.health.nz/fhir/ValueSet/hpi-legacy-language-code
Legal Entity Type-1.0

Legal entity type

https://nzhts.digital.health.nz/fhir/ValueSet/hpi-legal-entity-type
Legal Entity Type-2.0

Legal entity type

https://nzhts.digital.health.nz/fhir/ValueSet/hpi-legal-entity-type
Address Use for Location-2.0

Location address use

https://nzhts.digital.health.nz/fhir/ValueSet/hpi-location-address-use-code
HPI Location Status-1.0

A coded type for status of facilities.

https://nzhts.digital.health.nz/fhir/ValueSet/hpi-location-status-code
HPI Legacy Name Type-2.0

A coded type for name type based on NAMTYP 2.0

https://nzhts.digital.health.nz/fhir/ValueSet/hpi-name-type
NZSCC4N99 four digit country code-1999

4-digit country codes

https://nzhts.digital.health.nz/fhir/ValueSet/hpi-nzscc4n
Address Purpose (Qualifier) for Organisation-1.0

Organisation address purpose

https://nzhts.digital.health.nz/fhir/ValueSet/hpi-organisation-address-purpose
Address Type for Organisation-1.0

Organisation address type

https://nzhts.digital.health.nz/fhir/ValueSet/hpi-organisation-address-type
Address Use for Organisation-2.0

Organisation address use

https://nzhts.digital.health.nz/fhir/ValueSet/hpi-organisation-address-use-code
Name qualifier for Organisation-1.0

Organisation name qualifier

https://nzhts.digital.health.nz/fhir/ValueSet/hpi-organisation-name-qualifier
RaIdentifier-1.0

RA Identifier

https://nzhts.digital.health.nz/fhir/ValueSet/hpi-ra-identifier-code
HPI Registration Status-1.0

A coded type for professional registration status.

https://nzhts.digital.health.nz/fhir/ValueSet/hpi-registration-status
HPI Registration Type-1.0

A coded type for professional registrations.

https://nzhts.digital.health.nz/fhir/ValueSet/hpi-registration-type
ISO 639-3:2007 (3-alpha language code)-1.0

3-alpha language codes

https://nzhts.digital.health.nz/fhir/ValueSet/language-code
HPI Alias Type (Location)-1.0

A coded type for an alias name for facilities.

https://nzhts.digital.health.nz/fhir/ValueSet/location-alias-type-code
HPI Location Type-1.0

A coded type for types of facilities.

https://nzhts.digital.health.nz/fhir/ValueSet/location-type-code
Name Prefix Codes-1.0

A coded type for a name prefix or title eg Mr, Mrs, Dr.

https://nzhts.digital.health.nz/fhir/ValueSet/name-prefix-code
Name Prefix Codes-2.0

A coded type for name prefixes.

https://nzhts.digital.health.nz/fhir/ValueSet/name-prefix-code
Name Information Source-1.3

A coded type for the source of information for a name.

https://nzhts.digital.health.nz/fhir/ValueSet/name-source-code
Name Suffix Codes-1.0

Types of name suffixes used by NHI

https://nzhts.digital.health.nz/fhir/ValueSet/name-suffix-code
NES Enrolment Termination Reason -1.0

A code to describe the reason the enrolment has ended

https://nzhts.digital.health.nz/fhir/ValueSet/nes-enrolment-termination-reason
NES Enrolment Type-1.0

Describes the type of health service which the enrolment is for

https://nzhts.digital.health.nz/fhir/ValueSet/nes-enrolment-type
Address Not Validated Reason-1.1

Reason why an address is not validated.

https://nzhts.digital.health.nz/fhir/ValueSet/nhi-address-not-validated-reason-code
Address Type for Patient-1.2

Patient address type

https://nzhts.digital.health.nz/fhir/ValueSet/nhi-address-type
NHI Identifier-1.0.0

NHI Identifier

https://nzhts.digital.health.nz/fhir/ValueSet/nhi-identifier-use-code
NHI Name Use Extra-1.0

Additional name use codes for NHI names

https://nzhts.digital.health.nz/fhir/ValueSet/nhi-name-use-extra-code
NHI Address Use Codes-1.0.0

Uses of the address supported by the NHI

https://nzhts.digital.health.nz/fhir/ValueSet/nhiaddressUse
NZ Citizenship Information Source-1.1

A coded type for the source of information for NZ citizenship.

https://nzhts.digital.health.nz/fhir/ValueSet/nz-citizenship-source-code
NZ Residency Information Source-1.2

A coded type for the source of information for NZ residency.

https://nzhts.digital.health.nz/fhir/ValueSet/nz-residency-source-code
Organisation Type-1.0

Organisation type

https://nzhts.digital.health.nz/fhir/ValueSet/organisation-type-code
Organisation Type-1.1

Organisation type

https://nzhts.digital.health.nz/fhir/ValueSet/organisation-type-code
HPI Alias Type (Organization)-1.0

A coded type for an alias name for organisation.

https://nzhts.digital.health.nz/fhir/ValueSet/organization-alias-type-code
HPI Registration Type-2.0

A coded type for professional registrations.

https://nzhts.digital.health.nz/fhir/ValueSet/practitioner-registration-authority-code
PractitonerRole code-1.0

The role a practitioner holds.

https://nzhts.digital.health.nz/fhir/ValueSet/practitioner-role-code

Concept Maps

Disestablishment reason legacy translation-1.0

Translated disestablishment reason to legacy disestablishment reason

https://nzhts.digital.health.nz/cm/disestablishment-reason-down
Disestablishment reason mapping-1.0

Translated legacy disestablishment reason to disestablishment reason

https://nzhts.digital.health.nz/cm/disestablishment-reason
HPI Name type to Name Use Mapping-1.0

Translation from HPI Name Type to FHIR Name Use

https://nzhts.digital.health.nz/cm/hpi-name-type-to-name-use
HPI Name Use to Name Type Mapping-1.0

Translation from FHIR Name use to HPI Name Type

https://nzhts.digital.health.nz/cm/hpi-name-use-to-name-type
Name Prefix legacy translation-1.0

Translated FHIR name prefix to legacy name prefix

https://nzhts.digital.health.nz/cm/name-prefix-down
NHI Patient Address Type Mapping-1.0

Translation from NHI Address Type to FHIR Address Type

https://nzhts.digital.health.nz/cm/nhi-address-type
country-code-down-1.0

Convert country-codes down from new fhir to old

https://nzhts.digital.health.nz/fhir/ConceptMap/country-code-down
HPI provider person extract ethnicity cm-1.0

Translate from lvl 4 ethnicity codes down to level 3 ethnicity codes

https://nzhts.digital.health.nz/fhir/ConceptMap/ethnic-group-level4-to-level3
Gender Mapping (from R4)-1.0

Translation from FHIR Administrative Gender to HPI/NHI Gender Code

https://nzhts.digital.health.nz/fhir/ConceptMap/gender-from-r4
Gender Mapping (to R4)-1.0

Translation from HPI/NHI Gender Code to FHIR Administrative Gender

https://nzhts.digital.health.nz/fhir/ConceptMap/gender-to-r4
HPI Contact Type Mapping-1.0

Translation from FHIR Contact Point System to HPI Contact Type

https://nzhts.digital.health.nz/fhir/ConceptMap/hpi-contact-type-down
HPI Contact Type Mapping-1.0

Translation from HPI Contact Type to FHIR Contact Point System

https://nzhts.digital.health.nz/fhir/ConceptMap/hpi-contact-type
HPI Contact Usage Mapping-1.0

Translation from FHIR Contact Point Use to HPI Contact Usage

https://nzhts.digital.health.nz/fhir/ConceptMap/hpi-contact-usage-down
HPI Contact Usage Mapping-1.0

Translation from HPI Contact Usage to FHIR Contact Point Use

https://nzhts.digital.health.nz/fhir/ConceptMap/hpi-contact-usage
HPI Facility Address Purpose Mapping-1.0

Translation from FHIR Address Use to HPI Address Purpose

https://nzhts.digital.health.nz/fhir/ConceptMap/hpi-facility-address-purpose-down
HPI Facility Address Purpose Mapping-1.0

Translation from HPI Address Purpose to FHIR Address Use

https://nzhts.digital.health.nz/fhir/ConceptMap/hpi-facility-address-purpose
HPI Facility Address Type Mapping-1.0

Translation from FHIR Address Type to HPI Address Type

https://nzhts.digital.health.nz/fhir/ConceptMap/hpi-facility-address-type-down
HPI Facility Address Type Mapping-1.0

Translation from HPI Address Type to FHIR Address Type

https://nzhts.digital.health.nz/fhir/ConceptMap/hpi-facility-address-type
HPI Facility Name Qualifier Mapping Down-1.0

Translation from FHIR Location Alias Type to HPI Name Qualifier

https://nzhts.digital.health.nz/fhir/ConceptMap/hpi-facility-name-qualifier-down
HPI Facility Name Qualifier Mapping-1.0

Translation from HPI Name Qualifier to FHIR Location Alias Type

https://nzhts.digital.health.nz/fhir/ConceptMap/hpi-facility-name-qualifier
HPI Facility Type Mapping-1.0

Translation from FHIR Location Type to legacy HPI Facility Type

https://nzhts.digital.health.nz/fhir/ConceptMap/hpi-facility-type-down
HPI Facility Type Mapping-1.0

Translation from HPI Facility Type to FHIR Location Type

https://nzhts.digital.health.nz/fhir/ConceptMap/hpi-facility-type
HPI Organisation Address Purpose Mapping-1.0

Translation from FHIR Address Use to HPI Address Purpose

https://nzhts.digital.health.nz/fhir/ConceptMap/hpi-organisation-address-purpose-down
HPI Organisation Address Purpose Mapping-1.0

Translation from HPI Address Purpose to FHIR Address Use

https://nzhts.digital.health.nz/fhir/ConceptMap/hpi-organisation-address-purpose
HPI Organisation Address Type Mapping-1.0

Translation from FHIR Address Type to HPI Address Type

https://nzhts.digital.health.nz/fhir/ConceptMap/hpi-organisation-address-type-down
HPI Organisation Address Type Mapping-1.0

Translation from HPI Address Type to FHIR Address Type

https://nzhts.digital.health.nz/fhir/ConceptMap/hpi-organisation-address-type
HPI Organisation Name Qualifier Mapping Down-1.0

Translation from FHIR Organization Alias Type to HPI Name Qualifier

https://nzhts.digital.health.nz/fhir/ConceptMap/hpi-organisation-name-qualifier-down
HPI Organisation Name Qualifier Mapping-1.0

Translation from HPI Name Qualifier to FHIR Organization Alias Type

https://nzhts.digital.health.nz/fhir/ConceptMap/hpi-organisation-name-qualifier
HPI Organisation Type Mapping-1.0

Translation from HPI Organisation Type to FHIR Organisation Type

https://nzhts.digital.health.nz/fhir/ConceptMap/hpi-organisation-type
HPI Registration Type Mapping Down Conversion-1.0

Translation from FHIR to Legacy HPI values

https://nzhts.digital.health.nz/fhir/ConceptMap/hpi-registration-status-down
HPI Registration Type Mapping-1.0

Translation from legacy HPI to FHIR

https://nzhts.digital.health.nz/fhir/ConceptMap/hpi-registration-status
HPI Registration Type Mapping-1.0

Translation between HPI Registration Type versions

https://nzhts.digital.health.nz/fhir/ConceptMap/hpi-registration-type
Language mapping from legacy to iso639-3-2007-1.0

Translation from legacy HPI aa language codes to iso639 aaa codes

https://nzhts.digital.health.nz/fhir/ConceptMap/legacy1.0-to-iso639-3-2007
NZSCC4N99_to_ISO3166-1.csv-1.0

ConceptMap imported from NZSCC4N99toISO3166-1.csv

urn:moh:nzscc99