New Zealand HPI Implementation Guide, published by Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 1.5.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7NZ/hpi/ and changes regularly. See the Directory of published versions

Onboarding

Who can apply for access?

To the test environment:

All organisations and software vendors will be given access to all the HPI api operations in the HIP Compliance environment for testing and training after completing the on-boarding process described below.

To the production environment:

Access to HPI Organisation and HPI Facility Get and Search operations is available to all health providers, responsible authorities and organisations who provide supporting services to health providers and responsible authorities.

(Definitions: A health provider means a person or an organisation that provides, or arranges the provision of, personal health services or public health services-reference section 2, Health Act 1956. A responsible authority is an organisation responsible for the registration of practitioners-reference section 5, Health Practitioners Competence Assurance Act 2003).

Health providers and responsible authorities with existing HPI Data Access and Provision Agreements will be given access to Get and Search Practitioner under those agreements. This includes District Health Boards, ACC and health agencies employing practitioners to deliver health services e.g. Laboratories.

Health providers without an agreement wanting access to Get, Search, Update and Create Practitioner and any organisations wanting access to PractitionerRole Get, Search, Update and Create operations will need to apply to Te Whatu Ora / Health New Zealand (HNZ). The application will be assessed by HNZ sector digital channels. If granted, an access agreement may be required prior to credentials being issued to production.

On-boarding and Implementation

1. To get started, head to 'Consumer onboarding', over at the digital services hub. You will need to provide information about your organisation, the product you are developing and the API's you want to integrate with.
   • For more information have a look at the other resources on the Digital Service Hub.
2. Once your onboarding request has been approved, you will be provided with the information to start integration. The integration team will be in touch if further information is required.
   • You will receive your credentials, access token url, provided scopes, and the compliance environment endpoint.
3. Complete your development and testing.
4. Submit the results of the compliance tests by email to the integration team.
5. The integration team will issue a compliance test report. Your application will receive certification to be used in production or additional requirements will need to be met.
   • This can be an iterative process, so please get in touch as needed to discuss the compliance testing process.
6. Each organisation using your application with NHI integrated services must apply individually for access to the production environment (and recieve their own set of credentials) by completing the production form, please email NHI Access.

• Please allow at least 5 working days for compliance environment applications to be processed.

• Please allow at least 2 weeks for compliance testing to be signed off and returned.

• If Production credentials are required by a large number of organisations accessing your product, please get in touch to discuss options around bulk credential requests and how we can streamline this process.

Assistance

Please fill in the Digital Services Hub Support and Feedback form.

Business Functions

See below for available business functions. For more information on how these could be used in healthcare interactions See the use case guidance page
By using Te Whatu Ora APIs you are accessing personally identifiable information from the HPI which is not directly from the individual concerned. You need to consider your obligations under HIPC principle 2, and we may request to see your privacy impact assessment prir to access to production.

Business Functions	Description	Comments
Get Facility	Get Facility using hpi-facility-id	​Returns a location resource See who can access the production environment See Get Facility use case
Search Facility	Search Facilities by name, address, type and other parameters	​Returns a bundle containing location resources See who can access the production environment See Search Facility use case
Get Organisation	Get Organisation using hpi-organisation-id	​Returns an Organization resource See who can access the production environment See Get Organisation use case
Search Organisation	Search Organisation by name, type and other parameters	​Returns a bundle containing Organisation resources See who can access the production environment See Search Organisation use case
Get Practitioner	Get Practitioner using CPN or RA-id	Returns a Practitioner resource See who can access the production environment See Get Practitioner use case
Search Practitioner	Search Practitioner by name, date of birth and other demographics	Returns a bundle containing Practitioner resources See who can access the production environment See Search Practitioner use case
Maintain Practitioner	Update Practitioner records	See who can access the production environment See Update Practitioner use case
Create Practitioner	Create Practitioner records	See who can access the production environment See Create Practitioner use case
Get PractitionerRole	Get PractitionerRole using hpi-practitionerrole-id	See who can access the production environment See Get PractitionerRole use case
Search PractitionerRole	Search PractitionerRole using Practitioner and other parameters	See who can access the production environment See Search PractitionerRole use case
Maintain PractitionerRole	Update PractitionerRole records	See who can access the production environment See Update PractitionerRole use case
Create PractitionerRole	Create PractitionerRole records	See who can access the production environment See Create PractitionerRole use case