New Zealand HPI Implementation Guide
0.2.0 - CI Build

New Zealand HPI Implementation Guide, 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/hpi/ and changes regularly. See the Directory of published versions

Terminology

ValueSets

ValueSetPurposeUrlCodeSystem Urls
Additional Authorisation for functions that a Practitioner can performA coded type for additional authorisationshttps://standards.digital.health.nz/fhir/ValueSet/practitioner-additional-authorisation-code
Address Not Validated ReasonReason why an address is not validated.https://standards.digital.health.nz/fhir/ValueSet/address-not-validated-reason-code
Address Type for PatientPatient address typehttps://standards.digital.health.nz/vs/nhi-address-type
Address Use for LocationLocation address usehttps://standards.digital.health.nz/fhir/ValueSet/hpi-location-address-use-code
Address Use for OrganisationOrganisation address usehttps://standards.digital.health.nz/fhir/ValueSet/hpi-organisation-address-use-code
AddressTypeThe type of an address (physical / postal).http://hl7.org/fhir/ValueSet/address-type
AddressUseThe use of an address.http://hl7.org/fhir/ValueSet/address-use
AdministrativeGenderThe gender of a person used for administrative purposes.http://hl7.org/fhir/ValueSet/administrative-gender
Citizenship or Residency StatusA coded type for the status of citizenship/residency.https://standards.digital.health.nz/vs/nhi-citizenship-status
ContactPointSystemTelecommunications form for contact point.http://hl7.org/fhir/ValueSet/contact-point-system
ContactPointUseUse of contact point.http://hl7.org/fhir/ValueSet/contact-point-use
Country of Birth Information SourceA coded type for the source of information for a birth country.https://standards.digital.health.nz/vs/nhi-country-of-birth-source
Date of Birth Information SourceA coded type for the source of information for a birth date.https://standards.digital.health.nz/vs/nhi-date-of-birth-source
Date of Death Information SourceA coded type for the source of information for a death date.https://standards.digital.health.nz/vs/nhi-date-of-death-source
District Health Board CodeA coded type for a DHB.https://standards.digital.health.nz/fhir/ValueSet/dhb-code
District Health Board HPI Organisation IdentiferDistrict Health Board HPI Organisation Identiferhttps://standards.digital.health.nz/fhir/ValueSet/dhb-code
Domicile CodeA coded type for domicile.https://standards.digital.health.nz/fhir/ValueSet/domicile-code
Ethnicity New Zealand Standard Classification 2005 (level 4)Level 4 ethnicity codeshttps://standards.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code
HPI 3 digit ethnicity codesHPI 3 digit ethnicity codes as used in the provider person extracthttps://standards.digital.health.nz/fhir/ValueSet/ethnic-group-level-3-code
HPI Additional AuthorisationA coded type for additional authorisations.https://standards.digital.health.nz/fhir/ValueSet/practitioner-additional-authorisation-code
HPI Alias Type (Location)A coded type for an alias name for facilities.https://standards.digital.health.nz/fhir/ValueSet/location-alias-type-code
HPI Alias Type (Organization)A coded type for an alias name for organisation.https://standards.digital.health.nz/fhir/ValueSet/organization-alias-type-code
HPI Location TypeA coded type for types of facilities.https://standards.digital.health.nz/fhir/ValueSet/location-type-code
HPI Name PrefixA coded type for name prefixes.https://standards.digital.health.nz/fhir/ValueSet/name-prefix-code
HPI Registration StatusA coded type for professional registration status.https://standards.digital.health.nz/fhir/ValueSet/practitioner-registration-status-code
HPI Registration TypeA coded type for professional registrations.https://standards.digital.health.nz/fhir/ValueSet/practitioner-registration-authority-code
HPI Scope of PracticeA coded type for professional scope of practice.https://standards.digital.health.nz/fhir/ValueSet/practitioner-scope-of-practice-code
ISO 3166-1:2013 (2-alpha country code)2-alpha country codeshttps://standards.digital.health.nz/fhir/ValueSet/country-code
ISO 639-3:2007 (3-alpha language code)3-alpha language codeshttps://standards.digital.health.nz/fhir/ValueSet/language-code
IdentifierTypeA coded type for an identifier that can be used to determine which identifier to use for a specific purpose.http://hl7.org/fhir/ValueSet/identifier-type
IdentifierUseIdentifies the purpose for this identifier, if known .http://hl7.org/fhir/ValueSet/identifier-use
IdentifierUseUse values for an Identifierhttps://standards.digital.health.nz/fhir/ValueSet/hpi-identifier-use-code
Legal Entity TypeLegal entity typehttps://standards.digital.health.nz/fhir/ValueSet/hpi-legal-entity-type
Location alias typesThe set of alias types that apply to Locationshttps://standards.digital.health.nz/fhir/ValueSet/location-alias-type-code
NZ Citizenship Information SourceA coded type for the source of information for NZ citizenship.https://standards.digital.health.nz/vs/nhi-citizenship-source
NZ Residency Information SourceA coded type for the source of information for NZ residency.https://standards.digital.health.nz/vs/nhi-residency-source
Name Information SourceA coded type for the source of information for a name.https://standards.digital.health.nz/vs/nhi-name-source
NameUseThe use of a human name.http://hl7.org/fhir/ValueSet/name-use
Old HPI two alpha language codes2-alpha language codeshttps://standards.digital.health.nz/fhir/ValueSet/hpi-legacy-language-code
Organisation TypeOrganisation typehttps://standards.digital.health.nz/fhir/ValueSet/organisation-type-code
Organization alias typesThe set of alias types that apply to Organizationshttps://standards.digital.health.nz/fhir/ValueSet/organization-alias-type-code
PractitionerRoleCodesCoded roles that can be in a PractitionerRolehttps://standards.digital.health.nz/fhir/ValueSet/practitioner-role-code
PractitonerRole codeThe role a practitioner holds.https://standards.digital.health.nz/fhir/ValueSet/practitioner-role-code
PractitonerRole status reasonThe reason for the current status of PractitionerRole.https://standards.digital.health.nz/fhir/ValueSet/hpi-practitioner-role-status-reason-code
PractitonerRole status reasonThe reason for the current status of PractitionerRolehttps://standards.digital.health.nz/fhir/ValueSet/hpi-practitioner-role-status-reason-code
Professional registration the healthcare provider hasProfessional registration the healthcare provider hashttps://standards.digital.health.nz/fhir/ValueSet/practitioner-registration-authority-code
Registration Status of PractitionersThe code list represents the current practicing status of the Provider Person as per their registration with an RA.https://standards.digital.health.nz/fhir/ValueSet/practitioner-registration-status-code
Scope of practiceA coded type for professional scope of practice.https://standards.digital.health.nz/fhir/ValueSet/practitioner-scope-of-practice-code
Status of Location - is it still in useStatus of Location - is it still in usehttps://standards.digital.health.nz/fhir/ValueSet/hpi-location-status-code
Type of locationType of Locationhttps://standards.digital.health.nz/fhir/ValueSet/location-type-code
Use values for a ContactPointUse values for a ContactPointhttps://standards.digital.health.nz/fhir/ValueSet/hpi-contact-point-use-code
Use values for a HumanNameUse values for a HumanNamehttps://standards.digital.health.nz/fhir/ValueSet/hpi-human-name-use-code



Retired ValueSets

ValueSetPurposeUrlCodeSystem Urls
Address Purpose (Qualifier) for FacilityFacility address purposehttps://standards.digital.health.nz/fhir/ValueSet/hpi-facility-address-purpose
Address Purpose (Qualifier) for OrganisationOrganisation address purposehttps://standards.digital.health.nz/fhir/ValueSet/hpi-organisation-address-purpose
Address Type for FacilityFacility address typehttps://standards.digital.health.nz/fhir/ValueSet/hpi-facility-address-type
Address Type for OrganisationOrganisation address typehttps://standards.digital.health.nz/fhir/ValueSet/hpi-organisation-address-type
Contact TypeContact typehttps://standards.digital.health.nz/fhir/ValueSet/hpi-contact-type
Contact UsageContact usagehttps://standards.digital.health.nz/fhir/ValueSet/hpi-contact-usage
Facility TypeFacility typehttps://standards.digital.health.nz/fhir/ValueSet/hpi-facility-type
GenderA coded type for a person's gender.https://standards.digital.health.nz/fhir/ValueSet/gender-code
HPI Disestablishment ReasonDisestablishment Reason Code (Organisation and Facility)https://standards.digital.health.nz/fhir/ValueSet/hpi-disestablishment-reason
HPI Legacy Name TypeA coded type for name type based on NAMTYP 2.0https://standards.digital.health.nz/fhir/ValueSet/hpi-name-type
HPI Registration StatusA coded type for professional registration status.https://standards.digital.health.nz/fhir/ValueSet/hpi-registration-status
HPI Registration TypeA coded type for professional registrations.https://standards.digital.health.nz/fhir/ValueSet/hpi-registration-type
Legal Entity TypeLegal entity typehttps://standards.digital.health.nz/fhir/ValueSet/hpi-legal-entity-type
NZSCC4N99 four digit country code4-digit country codeshttps://standards.digital.health.nz/fhir/ValueSet/hpi-nzscc4n
Name qualifier for FacilityFacility name qualifierhttps://standards.digital.health.nz/fhir/ValueSet/hpi-facility-name-qualifier
Name qualifier for OrganisationOrganisation name qualifierhttps://standards.digital.health.nz/fhir/ValueSet/hpi-organisation-name-qualifier
Organisation TypeOrganisation typehttps://standards.digital.health.nz/fhir/ValueSet/organisation-type-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
AddressTypeThe type of an address (physical / postal).http://hl7.org/fhir/address-type
AddressUseThe use of an address.http://hl7.org/fhir/address-use
AdministrativeGenderThe gender of a person used for administrative purposes.http://hl7.org/fhir/administrative-gender
Type of AliasUsed in Organization and Location to indicate what is the type of Aliashttps://standards.digital.health.nz/ns/alias-type-code
ContactPointSystemTelecommunications form for contact point.http://hl7.org/fhir/contact-point-system
ContactPointUseUse of contact point.http://hl7.org/fhir/contact-point-use
District Health Board CodeDistrict Health Board Codehttps://standards.digital.health.nz/ns/dhb-code
PractitonerRole status reasonThe reason for the current status of PractitionerRolehttps://standards.digital.health.nz/ns/hpi-practitioner-role-status-reason-code
ANZSCO - Australian and New Zealand Standard Classification of Occupations, 2013Index 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
GenderA coded type for a person's gender.https://standards.digital.health.nz/ns/gender-code
GenderA coded type for a person's gender.https://standards.digital.health.nz/ns/gender-code
HPI Additional AuthorisationAdditional authorisations that a practitioner is authorised to practice or prescribe.https://standards.digital.health.nz/ns/practitioner-additional-authorisation-code
OrgFac Address PurposeA coded type for organisation/facility address purpose (qualifier).https://standards.digital.health.nz/ns/hpi-address-purpose
OrgFac Address TypeA coded type for organisation/facility address.https://standards.digital.health.nz/ns/hpi-address-type
OrgFac Address UseA coded type for organisation/facility address purpose (qualifier).https://standards.digital.health.nz/ns/hpi-address-use
HPI Alias TypeA coded type for an alias name.https://standards.digital.health.nz/ns/alias-type-code
OrgFac Contact TypeA coded type for organisation/facility contact.https://standards.digital.health.nz/ns/hpi-contact-type
OrgFac Contact UsageA coded type for organisation/facility contact usage.https://standards.digital.health.nz/ns/hpi-contact-usage
HPI Country CodeSupplementary country codes to extend ISO3166-1.https://standards.digital.health.nz/ns/country-code
SNOMED Health occupation subset (New Zealand Ministry of Health)Health occupation subset. Refset Id 451000210100. Module Id 21000210109.http://snomed.info/sct/223366009
HPI Disestablishment ReasonDisestablishment Reason Code (Organisation and Facility)https://standards.digital.health.nz/ns/hpi-disestablishment-reason
HPI Disestablishment ReasonDisestablishment Reason Code (Organisation and Facility)https://standards.digital.health.nz/ns/hpi-disestablishment-reason
Facility TypeA coded value for facility type.https://standards.digital.health.nz/ns/hpi-facility-type
Legacy HPI 2 alpha language codesLegacy HPI two alpha language codeshttps://standards.digital.health.nz/ns/hpi-legacy-language
Legal Entity TypeA coded value for organisation legal entity type.https://standards.digital.health.nz/ns/hpi-legal-entity-type
Location TypeA coded value for location type.https://standards.digital.health.nz/ns/location-type-code
OrgFac Name QualifierA code for organisation/facility name type/qualifier.https://standards.digital.health.nz/ns/hpi-name-qualifier
HPI Legacy Name TypeA code for practitioner name type.https://standards.digital.health.nz/ns/hpi-name-type
Organisation TypeA coded value for organisation type.https://standards.digital.health.nz/ns/organisation-type-code
HPI PractitionerRole status reasonThe reason for the current status of PractitionerRole.https://standards.digital.health.nz/ns/hpi-practitioner-role-status-reason-code
Address Not Validated ReasonReason why an address is not validated.https://standards.digital.health.nz/ns/address-not-validated-reason-code
HPI Registration StatusThe 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 StatusThe 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/practitioner-registration-status-code
HPI Registration TypeA code to identify the type of professional registration the healthcare provider person has been assigned.https://standards.digital.health.nz/ns/hpi-registration-type
HPI Registration TypeA 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
HPI Scope of PracticeA 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
ISO3166-1 two character country codeThe 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)ISO 639-3 is a set of codes that defines three-letter identifiers for all known human languages.urn:iso:std:iso:639:-3
HPI Name PrefixA coded type for name prefixes.https://standards.digital.health.nz/ns/name-prefix-code
Name PrefixA coded type for name prefixes.https://standards.digital.health.nz/ns/name-prefix-code
Patient Address TypeA coded type for patient address.https://standards.digital.health.nz/cs/nhi-address-type
District Health Board CodeDistrict Health Board code table.https://standards.digital.health.nz/ns/dhb-code
Citizenship or Residency StatusA coded type for the status of citizenship/residency.https://standards.digital.health.nz/cs/nhi-citizenship-status
Official Information SourceA coded type for the source of a piece of information in the NHI (e.g. name).https://standards.digital.health.nz/cs/nhi-information-source
NZSCC4N99 four digit country codeNZSCC4N99 four digit numeric country codes (Statistics New Zealand Country Code List - NZSC 1999).https://standards.digital.health.nz/ns/nzscc4n
Domicile CodeDomicile code table.https://standards.digital.health.nz/fhir/CodeSystem/domicile-code
Ethnicity New Zealand Standard Classification 2005 (level 4)Ethnicity is a key social factor used with other topics in describing the New Zealand population. Information collected on ethnicity is used to inform, plan, and evaluate services and policies by a wide range of organisations, local authorities and government agencies.https://standards.digital.health.nz/ns/ethnic-group-level-4-code
Ethnicity lvl 2Ethnic Group Codes at Level 2https://standards.digital.health.nz/ns/ethnic-group-level-2-code
Ethnicity lvl 3Ethnic Group Codes at Level 3https://standards.digital.health.nz/ns/ethnic-group-level-3-code
GenderA coded type for a person's gender.https://standards.digital.health.nz/ns/gender-code
IdentifierUseIdentifies the purpose for this identifier, if known .http://hl7.org/fhir/identifier-use
Type of LocationType of Locationhttps://standards.digital.health.nz/ns/location-type-code
NameUseThe use of a human name.http://hl7.org/fhir/name-use
Additional AuthorisationAdditional authorisations that a practitioner is authorised to practice or prescribe.https://standards.digital.health.nz/ns/practitioner-additional-authorization-code
Professional registration the healthcare provider hasProfessional registration the healthcare provider hashttps://standards.digital.health.nz/ns/practitioner-registration-authority-code
Registration Status of PractitionersThe 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
PractitionerRoleCodesCoded roles that can be in a PractitionerRolehttps://standards.digital.health.nz/ns/practitioner-role-code
Scope of practiceA 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
v2 Identifier TypeFHIR Value set/code system definition for HL7 v2 table 0203 ( Identifier Type)http://terminology.hl7.org/CodeSystem/v2-0203

Duplicated ValueSets

Url
https://standards.digital.health.nz/fhir/ValueSet/dhb-code
https://standards.digital.health.nz/fhir/ValueSet/hpi-practitioner-role-status-reason-code
https://standards.digital.health.nz/fhir/ValueSet/organization-alias-type-code
https://standards.digital.health.nz/fhir/ValueSet/practitioner-role-code
https://standards.digital.health.nz/fhir/ValueSet/practitioner-registration-status-code
https://standards.digital.health.nz/fhir/ValueSet/practitioner-registration-authority-code
https://standards.digital.health.nz/fhir/ValueSet/practitioner-scope-of-practice-code
https://standards.digital.health.nz/fhir/ValueSet/practitioner-additional-authorisation-code
https://standards.digital.health.nz/fhir/ValueSet/hpi-legal-entity-type
https://standards.digital.health.nz/fhir/ValueSet/location-alias-type-code
https://standards.digital.health.nz/fhir/ValueSet/location-type-code
https://standards.digital.health.nz/fhir/ValueSet/organisation-type-code

ValueSets defined but not used

Url
http://hl7.org/fhir/ValueSet/address-type
http://hl7.org/fhir/ValueSet/address-use
http://hl7.org/fhir/ValueSet/administrative-gender
http://hl7.org/fhir/ValueSet/contact-point-system
http://hl7.org/fhir/ValueSet/contact-point-use
https://standards.digital.health.nz/fhir/ValueSet/hpi-registration-status
https://standards.digital.health.nz/fhir/ValueSet/hpi-registration-type
https://standards.digital.health.nz/fhir/ValueSet/name-prefix-code
https://standards.digital.health.nz/vs/nhi-address-type
https://standards.digital.health.nz/vs/nhi-citizenship-source
https://standards.digital.health.nz/vs/nhi-citizenship-status
https://standards.digital.health.nz/vs/nhi-country-of-birth-source
https://standards.digital.health.nz/vs/nhi-date-of-birth-source
https://standards.digital.health.nz/vs/nhi-date-of-death-source
https://standards.digital.health.nz/vs/nhi-name-source
https://standards.digital.health.nz/vs/nhi-residency-source
https://standards.digital.health.nz/fhir/ValueSet/address-not-validated-reason-code
https://standards.digital.health.nz/fhir/ValueSet/country-code
https://standards.digital.health.nz/fhir/ValueSet/domicile-code
https://standards.digital.health.nz/fhir/ValueSet/gender-code
https://standards.digital.health.nz/fhir/ValueSet/hpi-contact-type
https://standards.digital.health.nz/fhir/ValueSet/hpi-contact-usage
https://standards.digital.health.nz/fhir/ValueSet/hpi-disestablishment-reason
https://standards.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code
https://standards.digital.health.nz/fhir/ValueSet/ethnic-group-level-3-code
https://standards.digital.health.nz/fhir/ValueSet/hpi-facility-address-purpose
https://standards.digital.health.nz/fhir/ValueSet/hpi-facility-address-type
https://standards.digital.health.nz/fhir/ValueSet/hpi-facility-name-qualifier
https://standards.digital.health.nz/fhir/ValueSet/hpi-facility-type
https://standards.digital.health.nz/fhir/ValueSet/language-code
https://standards.digital.health.nz/fhir/ValueSet/hpi-legacy-language-code
https://standards.digital.health.nz/fhir/ValueSet/hpi-legal-entity-type
https://standards.digital.health.nz/fhir/ValueSet/hpi-name-type
https://standards.digital.health.nz/fhir/ValueSet/hpi-nzscc4n
https://standards.digital.health.nz/fhir/ValueSet/hpi-organisation-address-purpose
https://standards.digital.health.nz/fhir/ValueSet/hpi-organisation-address-type
https://standards.digital.health.nz/fhir/ValueSet/hpi-organisation-address-use-code
https://standards.digital.health.nz/fhir/ValueSet/hpi-organisation-name-qualifier
https://standards.digital.health.nz/fhir/ValueSet/organisation-type-code
http://hl7.org/fhir/ValueSet/identifier-use
http://hl7.org/fhir/ValueSet/name-use
https://standards.digital.health.nz/fhir/ValueSet/organization-alias-type-code