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

Artifacts Summary

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

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

CapabilityStatement

Represents API exposed by HPI

Behavior: Search Parameters

These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.

Search on birthdate

Search the Practitioner by birthdate

Search on Registration Authority identifier

Search the Registration Authority identifier

Structures: Logical Models

These define data models that represent the domain covered by this implementation guide in more business-friendly terms than the underlying FHIR resources.

HpiEndpointLM

The enpoint resource used by the HPI

HpiLocationLM

The Location resource used by the HPI service

HpiOrganizationLM

The Organization resource used by the HPI application.

HpiPractitionerLM

The Practitioner exposed by the HPI

Use cases:

  • What is a person’s CPN when I know the persons registration number i.e. Get using registration number
  • What is a person’s CPN when the person doesn’t have a registration i.e. search by name, gender
  • What is a person’s CPN when I don’t know the person’s registration number or CPN i.e. search by name, gender scope of practice
  • What are a practitioner’s details (eg practicing certificate dates) when I have a CPN. ie. Get using CPN
HpiPractitionerRoleLM

HpiPractitionerRole

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide

HPI Location

A physical location from which health goods and/or services are provided. They are also referred to as an HPI Facility.

HPI Organization

An entity that provides services of interest to, or is involved in, the business of health care service provision.

HPI Practitioner

The practitioner exposed by the HPI. This is the person who delivers care - regardless of qualification.

HPI Practitioner role

The practitioner role exposed by the HPI. Used to connect Practitioners with Organizations and Locations, indicating the role they have. A single Practitioner can have roles with multple organizations.

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide

AdditionalAuthorization

Additional authorizations that a practitioner is authorized to perform

AliasType

Indicates the type of alias name. VS Binding is done by the profile.

ConditionOnPractice

A full description of the conditions the health practitioner is subject to in relation to their scope of practice.

DeathDate

The date the person died.

Dhb

The District Health Board the Location is in. It is derived from the eSAM details of the location’s address that has use=work.

EducationalQualification

Educational qualifications.

LocationEstablished

The period over which the location is open

OrganizationEstablished

The period over which the Organization is active

PractitionerRoleCreator

The organisation and person that created this role

PractitionerRoleStatus

The status of the role - active,ended

RegistrationInitialDate

The date the practitioner first became registered with the Responsible Authority or professional body

RegistrationStatusCode

An indicator of the practicing status of the practitioner as supplied by their Responsible Authority or professional body.

ScopeOfPractice

The type or range of health services a practitioner is authorized to perform, as determined by the Responsible Authority or professional body.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide

AddressType

The type of an address (physical / postal).

AddressUse

The use of an address.

AdministrativeGender

The gender of a person used for administrative purposes.

ContactPointSystem

Telecommunications form for contact point.

ContactPointUse

Use of contact point.

District Health Board HPI Organisation Identifer

District Health Board HPI Organisation Identifer

District Health Board Code

A coded type for a DHB.

Domicile Code

A coded type for domicile.

Gender

A coded type for a person’s gender.

Use values for a ContactPoint

Use values for a ContactPoint

HPI Additional Authorisation

A coded type for additional authorisations.

Contact Type

Contact type

Contact Usage

Contact usage

ISO 3166-1:2013 (2-alpha country code)

2-alpha country codes

HPI Disestablishment Reason

Disestablishment Reason Code (Organisation and Facility)

Ethnicity New Zealand Standard Classification 2005 (level 4)

Level 4 ethnicity codes

HPI 3 digit ethnicity codes

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

Address Purpose (Qualifier) for Facility

Facility address purpose

Address Type for Facility

Facility address type

Name qualifier for Facility

Facility name qualifier

Facility Type

Facility type

ISO 639-3:2007 (3-alpha language code)

3-alpha language codes

Old HPI two alpha language codes

2-alpha language codes

HPI Legacy Name Type

A coded type for name type based on NAMTYP 2.0

Legal Entity Type

Legal entity type

Legal Entity Type

Legal entity type

Address Use for Location

Location address use

HPI Alias Type (Location)

A coded type for an alias name for facilities.

HPI Location Type

A coded type for types of facilities.

HPI Name Prefix

A coded type for name prefixes.

NZSCC4N99 four digit country code

4-digit country codes

Address Purpose (Qualifier) for Organisation

Organisation address purpose

Address Type for Organisation

Organisation address type

Address Use for Organisation

Organisation address use

Name qualifier for Organisation

Organisation name qualifier

Organisation Type

Organisation type

Organisation Type

Organisation type

HPI Alias Type (Organization)

A coded type for an alias name for organisation.

PractitonerRole code

The role a practitioner holds.

PractitonerRole status reason

The reason for the current status of PractitionerRole.

HPI Registration Status

A coded type for professional registration status.

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.

HPI Scope of Practice

A coded type for professional scope of practice.

Use values for a HumanName

Use values for a HumanName

IdentifierUse

Use values for an Identifier

IdentifierUse

Identifies the purpose for this identifier, if known .

IdentifierType

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Location alias types

The set of alias types that apply to Locations

Status of Location - is it still in use

Status of Location - is it still in use

Type of location

Type of Location

NameUse

The use of a human name.

Address Not Validated Reason

Reason why an address is not validated.

Address Type for Patient

Patient address type

NZ Citizenship Information Source

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

Citizenship or Residency Status

A coded type for the status of citizenship/residency.

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.

Name Information Source

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

NZ Residency Information Source

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

Organization alias types

The set of alias types that apply to Organizations

Additional Authorisation for functions that a Practitioner can perform

A coded type for additional authorisations

Registration Status of Practitioners

The code list represents the current practicing status of the Provider Person as per their registration with an RA.

PractitionerRoleCodes

Coded roles that can be in a PractitionerRole

PractitonerRole status reason

The reason for the current status of PractitionerRole

Scope of practice

A coded type for professional scope of practice.

Professional registration the healthcare provider has

Professional registration the healthcare provider has

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide

Additional Authorisation

Additional authorisations that a practitioner is authorised to practice or prescribe.

AddressType

The type of an address (physical / postal).

AddressUse

The use of an address.

Type of Alias

Used in Organization and Location to indicate what is the type of Alias

ContactPointSystem

Telecommunications form for contact point.

ContactPointUse

Use of contact point.

District Health Board Code

District Health Board Code

Domicile Code

Domicile code table.

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.

Ethnicity lvl 2

Ethnic Group Codes at Level 2

Ethnicity lvl 3

Ethnic Group Codes at Level 3

Gender

A coded type for a person’s gender.

Gender

A coded type for a person’s gender.

HPI Additional Authorisation

Additional authorisations that a practitioner is authorised to practice or prescribe.

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).

HPI Alias Type

A coded type for an alias name.

OrgFac Contact Type

A coded type for organisation/facility contact.

OrgFac Contact Usage

A coded type for organisation/facility contact usage.

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)

Facility Type

A coded value for facility type.

Legacy HPI 2 alpha language codes

Legacy HPI two alpha language codes

HPI Name Prefix

A coded type for name prefixes.

HPI Legacy Name Type

A code for practitioner name type.

Legal Entity Type

A coded value for organisation legal entity type.

Location Type

A coded value for location type.

OrgFac Name Qualifier

A code for organisation/facility name type/qualifier.

Organisation Type

A coded value for organisation type.

HPI PractitionerRole status reason

The reason for the current status of PractitionerRole.

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 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.

IdentifierUse

Identifies the purpose for this identifier, if known .

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).

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.

Type of Location

Type of Location

Name Prefix

A coded type for name prefixes.

Address Not Validated Reason

Reason why an address is not validated.

Patient Address Type

A coded type for patient address.

Citizenship or Residency Status

A coded type for the status of citizenship/residency.

Official Information Source

A coded type for the source of a piece of information in the NHI (e.g. name).

NZSCC4N99 four digit country code

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

Professional registration the healthcare provider has

Professional registration the healthcare provider has

Registration Status of Practitioners

The code list represents the current practicing status of the Provider Person as per their registration with an RA.

PractitionerRoleCodes

Coded roles that can be in a PractitionerRole

PractitonerRole status reason

The reason for the current status of PractitionerRole

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.

SNOMED Health occupation subset (New Zealand Ministry of Health)

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

administrative-gender

The gender of a person used for administrative purposes.

id-1

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

id-33

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

id-34

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.

id-4

District Health Board code table.

id-9

A coded type for a person’s gender.

name-use

The use of a human name.

v2-0203

FHIR Value set/code system definition for HL7 v2 table 0203 ( Identifier Type)

Terminology: Naming Systems

These define identifier and/or code system identities used by systems conforming to this implementation guide

hpiFacility

HPI facilities

hpiOrganization

HPI organizations

hpiProvider

HPI providers

hpipractitionerrole

HPI PractitionerRole id

nzFacilitylegacy

Legacy number for Facility (Location) National Collections

nzOrganizationlegacy

Legacy number for Organization National Collections

nzbn

New Zealand Business Number

nzchrir

Chiropractic Board Register number

nzdental

Dental Council Register Number

nzdiet

Dietitians Board Register Number

nzmc

Medical Council of New Zealand Register Number

nzmwife

Midwifery Council Register Number

nznc

Nursing Council of New Zealand Register Number

nzocc

Occupational Therapy Board Register Number

nzopt

Optometrists & Dispensing Opticians Board Register Number

nzost

Osteopathic Council Register Number

nzparamed

Paramedic Council Register Number

nzpharm

Pharmacy Council of New Zealand Register Number

nzphysio

Physiotherapy Board Register Number

nzpod

Podiatrists Board Register Number

nzpsycho

Psychotherapists Board register Number

nzpsyhc

Psychologists Board Register Number

nzrad

Medical Radiation Technologists Board Register Number

nzscience

Medical Sciences Council Register Number

Terminology: Concept Maps

These define transformations to convert between codes by systems conforming with this implementation guide

id-43

Convert country-codes down from new fhir to old

id-44

ConceptMap imported from NZSCC4N99_to_ISO3166-1.csv

id-45

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

id-46

Translation from FHIR Administrative Gender to HPI/NHI Gender Code

id-47

Translation from HPI/NHI Gender Code to FHIR Administrative Gender

id-48

Translation from HPI Contact Type to FHIR Contact Point System

id-49

Translation from HPI Contact Usage to FHIR Contact Point Use

id-50

Translation from HPI Address Purpose to FHIR Address Use

id-51

Translation from HPI Address Type to FHIR Address Type

id-52

Translation from HPI Name Qualifier to FHIR Location Alias Type

id-53

Translation from FHIR Location Type to legacy HPI Facility Type

id-54

Translation from HPI Facility Type to FHIR Location Type

id-55

Translation from legacy HPI aa language codes to iso639 aaa codes

id-56

Translation from HPI Name Type to FHIR Name Use

id-57

Translation from FHIR Name use to HPI Name Type

id-58

Translation from HPI Address Purpose to FHIR Address Use

id-59

Translation from HPI Address Type to FHIR Address Type

id-60

Translation from HPI Name Qualifier to FHIR Organization Alias Type

id-61

Translation from HPI Organisation Type to FHIR Organisation Type

id-62

Translation from FHIR to Legacy HPI values

id-63

Translation from legacy HPI to FHIR

id-64

Translation between HPI Registration Type versions

id-65

Translated FHIR name prefix to legacy name prefix

id-66

Translation from NHI Address Type to FHIR Address Type

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like

hltest

Patient1