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
Contents:
This page provides a list of the FHIR artifacts defined as part of this implementation guide.
These define constraints on FHIR resources for systems conforming to this implementation guide.
| HIP OperationOutcome |
Adds additional, HIP specific extensions |
These define sets of codes used by systems conforming to this implementation guide.
| Address Not Validated Reason |
Reason why an address is not validated. |
| Address Purpose (Qualifier) for Facility |
Facility address purpose |
| Address Purpose (Qualifier) for Organisation |
Organisation address purpose |
| Address Type for Facility |
Facility address type |
| Address Type for Organisation |
Organisation address type |
| Address Type for Patient |
Patient address type |
| Address Use for Location |
Location address use |
| Address Use for Organisation |
Organisation address use |
| Contact Type |
Contact type |
| Contact Usage |
Contact usage |
| Country of Birth Information Source |
A coded type for the source of information for a birth country. |
| Date of Birth Information Source |
A coded type for the source of information for a birth date. |
| Date of Death Information Source |
A coded type for the source of information for a death date. |
| Facility Type |
Facility type |
| Gender |
A coded type for a person’s gender. |
| HPI 2 digit ethnicity codes |
HPI 2 digit ethnicity codes as used in the provider person extract |
| HPI 3 digit ethnicity codes |
HPI 3 digit ethnicity codes as used in the provider person extract |
| HPI Alias Type (Location) |
A coded type for an alias name for facilities. |
| HPI Alias Type (Organization) |
A coded type for an alias name for organisation. |
| HPI Disestablishment Reason |
Disestablishment Reason Code (Organisation and Facility) |
| HPI Disestablishment Reason |
Disestablishment Reason Code (Organisation and Facility) |
| HPI Legacy Name Type |
A coded type for name type based on NAMTYP 2.0 |
| HPI Location Status |
A coded type for status of facilities. |
| HPI Location Type |
A coded type for types of facilities. |
| HPI Registration Status |
A coded type for professional registration status. |
| HPI Registration Type |
A coded type for professional registrations. |
| HPI Registration Type |
A coded type for professional registrations. |
| ISO 3166-1:2013 (2-alpha country code) |
2-alpha country codes |
| ISO 639-3:2007 (3-alpha language code) |
3-alpha language codes |
| IdentifierUse |
Use values for an Identifier |
| Legal Entity Type |
Legal entity type |
| Legal Entity Type |
Legal entity type |
| NES Enrolment Termination Reason |
A code to describe the reason the enrolment has ended |
| NES Enrolment Type |
Describes the type of health service which the enrolment is for |
| NHI Address Type Codes |
Types of address supported by the NHI |
| NHI Address Use Codes |
Uses of the address supported by the NHI |
| NHI Identifier |
NHI Identifier |
| NHI Name Use Extra |
Additional name use codes for NHI names |
| NZ Citizenship Information Source |
A coded type for the source of information for NZ citizenship. |
| NZ Residency Information Source |
A coded type for the source of information for NZ residency. |
| NZSCC4N99 four digit country code |
4-digit country codes |
| Name Information Source |
A coded type for the source of information for a name. |
| Name Prefix Codes |
A coded type for a name prefix or title eg Mr, Mrs, Dr. |
| Name Prefix Codes |
A coded type for name prefixes. |
| Name Suffix Codes |
Types of name suffixes used by NHI |
| Name qualifier for Facility |
Facility name qualifier |
| Name qualifier for Organisation |
Organisation name qualifier |
| Old HPI two alpha language codes |
2-alpha language codes |
| Organisation Type |
Organisation type |
| Organisation Type |
Organisation type |
| PractitonerRole code |
The role a practitioner holds. |
| RaIdentifier |
RA Identifier |
| Use values for a ContactPoint |
Use values for a ContactPoint |
| Use values for a ContactSystem |
System values for a ContactPoint |
| Use values for a HumanName |
Use values for a HumanName |
These define new code systems used by systems conforming to this implementation guide.
| ANZSCO - Australian and New Zealand Standard Classification of Occupations, 2013 |
Index of Principal Titles, Alternative Titles, Specialisations and Occupations in Not Elsewhere Classified (nec) Categories. |
||||
| Address Not Validated Reason |
Reason why an address is not validated. |
||||
| Ethnicity lvl 2 |
Ethnic Group Codes at Level 2 |
||||
| Ethnicity lvl 3 |
Ethnic Group Codes at Level 3 |
||||
| Ethnicity lvl 4. v2005 2.0 |
Ethnic Group Codes at Level 4. |
||||
| Facility Type |
A coded value for facility type. |
||||
| Gender v1.0 |
|
||||
| Gender v1.1 |
|
||||
| Gender v1.2 |
|
||||
| HIP Error Code |
HIP Error Codes |
||||
| HPI Country Code |
Supplementary country codes to extend ISO3166-1. |
||||
| HPI Disestablishment Reason |
Disestablishment Reason Code (Organisation and Facility) |
||||
| HPI Disestablishment Reason |
Disestablishment Reason Code (Organisation and Facility) |
||||
| HPI Legacy Name Type |
A code for practitioner name type. |
||||
| HPI Registration Authority Identifiers |
A list of the registration authority identifiers. |
||||
| HPI Registration Status |
The code list represents the current practicing status of the Provider Person as per their registration with an RA or a health worker source. |
||||
| HPI Registration Type |
A code to identify the type of professional registration the healthcare provider person has been assigned. |
||||
| HPI Registration Type |
A code to identify the type of professional registration the healthcare provider person has been assigned. |
||||
| ISO 639-3:2007 (3-alpha language code) |
ISO 639-3 is a set of codes that defines three-letter identifiers for all known human languages. |
||||
| ISO3166-1 two character country code |
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). |
||||
| Legacy HPI 2 alpha language codes |
Legacy HPI two alpha language codes |
||||
| Legal Entity Type |
A coded value for organisation legal entity type. |
||||
| Legal Entity Type |
A coded value for organisation legal entity type. |
||||
| Location Type |
A coded value for location type. |
||||
| NES Enrolment Termination Reason Code |
A code to describe the reason the enrolment has ended |
||||
| NES Enrolment Type |
Describes the type of health service which the enrolment is for |
||||
| NES Event Type |
Identifies NES events. |
||||
| NHI Name Use Extra |
Additional name use codes for NHI names |
||||
| NZSCC4N99 four digit country code |
NZSCC4N99 four digit numeric country codes (Statistics New Zealand Country Code List - NZSC 1999). |
||||
| Name Prefix |
A coded type for name prefixes. |
||||
| Name Prefix |
A coded type for name prefixes. |
||||
| Name Suffix |
Types of name suffixes used by HIP |
||||
| OrgFac Address Purpose |
A coded type for organisation/facility address purpose (qualifier). |
||||
| OrgFac Address Type |
A coded type for organisation/facility address. |
||||
| OrgFac Address Use |
A coded type for organisation/facility address purpose (qualifier). |
||||
| OrgFac Contact Type |
A coded type for organisation/facility contact. |
||||
| OrgFac Contact Usage |
A coded type for organisation/facility contact usage. |
||||
| OrgFac Name Qualifier |
A code for organisation/facility name type/qualifier. |
||||
| Organisation Type |
A coded value for organisation type. |
||||
| Organisation Type |
A coded value for organisation type. |
||||
| Patient Address Type |
A coded type for patient address. |
||||
| SNOMED Health occupation subset (New Zealand Ministry of Health) |
Health occupation subset. Refset Id 451000210100. Module Id 21000210109. |
These define transformations to convert between codes by systems conforming with this implementation guide.
| country-code |
ConceptMap imported from NZSCC4N99_to_ISO3166-1.csv |
| country-code-down |
Convert country-codes down from new fhir to old |
| ethnic-group-level4-to-level3 |
Translate from lvl 4 ethnicity codes down to level 3 ethnicity codes |
| gender-from-r4 |
Translation from FHIR Administrative Gender to HPI/NHI Gender Code |
| gender-to-r4 |
Translation from HPI/NHI Gender Code to FHIR Administrative Gender |
| hpi-contact-type |
Translation from HPI Contact Type to FHIR Contact Point System |
| hpi-contact-type-down |
Translation from FHIR Contact Point System to HPI Contact Type |
| hpi-contact-usage |
Translation from HPI Contact Usage to FHIR Contact Point Use |
| hpi-contact-usage-down |
Translation from FHIR Contact Point Use to HPI Contact Usage |
| hpi-disestablishment-reason |
Translated legacy disestablishment reason to disestablishment reason |
| hpi-disestablishment-reason-down |
Translated disestablishment reason to legacy disestablishment reason |
| hpi-facility-address-purpose |
Translation from HPI Address Purpose to FHIR Address Use |
| hpi-facility-address-purpose-down |
Translation from FHIR Address Use to HPI Address Purpose |
| hpi-facility-address-type |
Translation from HPI Address Type to FHIR Address Type |
| hpi-facility-address-type-down |
Translation from FHIR Address Type to HPI Address Type |
| hpi-facility-name-qualifier |
Translation from HPI Name Qualifier to FHIR Location Alias Type |
| hpi-facility-name-qualifier-down |
Translation from FHIR Location Alias Type to HPI Name Qualifier |
| hpi-facility-type |
Translation from HPI Facility Type to FHIR Location Type |
| hpi-facility-type-down |
Translation from FHIR Location Type to legacy HPI Facility Type |
| hpi-language-legacy1.0-to-iso639-3-2007 |
Translation from legacy HPI aa language codes to iso639 aaa codes |
| hpi-name-type-to-name-use |
Translation from HPI Name Type to FHIR Name Use |
| hpi-name-use-to-name-type |
Translation from FHIR Name use to HPI Name Type |
| hpi-organisation-address-purpose |
Translation from HPI Address Purpose to FHIR Address Use |
| hpi-organisation-address-purpose-down |
Translation from FHIR Address Use to HPI Address Purpose |
| hpi-organisation-address-type |
Translation from HPI Address Type to FHIR Address Type |
| hpi-organisation-address-type-down |
Translation from FHIR Address Type to HPI Address Type |
| hpi-organisation-name-qualifier |
Translation from HPI Name Qualifier to FHIR Organization Alias Type |
| hpi-organisation-name-qualifier-down |
Translation from FHIR Organization Alias Type to HPI Name Qualifier |
| hpi-organisation-type |
Translation from HPI Organisation Type to FHIR Organisation Type |
| hpi-registration-status |
Translation from legacy HPI to FHIR |
| hpi-registration-status-down |
Translation from FHIR to Legacy HPI values |
| hpi-registration-type |
Translation between HPI Registration Type versions |
| name-prefix-down |
Translated FHIR name prefix to legacy name prefix |
| nhi-address-type |
Translation from NHI Address Type to FHIR Address Type |