Information for health IT vendors and developers
This section contains information for developers about integration of NHI interfaces and NHI number validation routines
Pātiki and Waharua Kōpito patterns
On this page
NHI Interfaces
Technology interfaces are available for vendors to integrate into their applications, enabling health providers to access the NHI directly and in real time.
July 2020
The NHI Patient Web Services July 2020 Release is now available. This release includes the addition of a new Gender Diverse code, implementation of Ethnicity 2005 V2.0.0 code set and the new NHI format. The details of the release are provided below:
October 2016
We are pleased to release the set of v3 specifications and documents to support integration of the Patient (NHI) Web Services (SEARCH and GET) by health application vendors.
The set of supporting documentation and artefacts can be downloaded from this page:
- Patient Identity Web Services Getting Started v1.3 (ZIP, 259 KB)
- Patient Identity Web services Guidance for Integrators (ZIP, 2.4 MB)
- Patient Identity Web Services Technical Documentation for Developers (ZIP, 3.8 MB)
- Patient Identity Web Services Requirements and Compliance Testing (ZIP, 2.1 MB)
- NHI Validation Routine (Word, 60 KB)
If you find any suggestions for improvements, errors or omissions we welcome your feedback to integration@health.govt.nz
The zipped file 'Getting Started' outlines the process for vendors wishing to integrate the web services. Initially, there will be some assessment and prioritisation of requests received in order to provide sufficient support to vendors within limited Ministry resource capacity.
The process for integration to the Ministry's web services is centred around requests from Health Providers. Vendors who wish to integrate their own applications should apply in conjunction with a Health Provider who wishes to use their application or services.
The legacy HL7 NHI Interface Specification 1997 has been archived, but may be accessed if required by emailing HI_Administration@health.govt.nz
NHI Test Data
The download file of test NHI records can be found in the Ministry of Health NHI -Compliance environment (pre-production environment). The associated attributes like names and addresses may change over time as sector testers make updates in the test environment.
The Ministry application called HealthUI will be made available to all testers to create their own test and training data in the Ministry Compliance environment. This will be available towards the end of 2021. In the interim, email WS_integration@health.govt.nz to request additional test data.
If you also need test HPI provider person, organisation and facility data, view HPI information for health IT developers.