Who can use this API
The HPI Organisation and HPI Facility data is available to any health providers or organisations that support health providers. Integrators are encouraged to use HPI Organisation and HPI Facility identifiers wherever possible in their applications.
Access to practitioner details that are already available on responsible authorities' public registers is available to all health providers.
Access to other practitioner details, like their place of work and contact details, is restricted to authorised organisations and users only.
API type
REST API
Technical
All API endpoints will adhere to Fast Healthcare Interoperable Resources (FHIR) interoperability standards. The New Zealand HPI Implementation Guide sets out all the artefacts that are necessary to understand and use the FHIR API.
New Zealand HPI Implementation Guide(external link)
Onboarding and implementation
To get started, complete the online onboarding request form. You will need to provide information about your organisation and the application you will integrate with.
Onboarding Request form(external link)
Once your onboarding request has been approved, you will be provided with the information to start integration. The onboarding team will be in touch if further information is required.
If you require help or have any questions regarding the onboarding process, please contact our team by completing a general enquiry form.
General enquiry form(external link)
Learn more
Health Provider Index overview — Ministry of Health(external link)
HPI information for health IT developers — Ministry of Health(external link)
HPI information for health providers — Ministry of Health(external link)