New Zealand NHI IG
1.6.1 - Release

New Zealand NHI IG - Local Development build (v1.6.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Onboarding

Who can apply for access?

To the test environment:

All health providers listed in Schedule 2 of the Health Information Privacy Code and software vendors will be given access to all the NHI 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 NHI operations is available to all health providers listed in Schedule 2 of the Health Information Privacy Code

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.
  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 patient interactions See the use case guidance page
By using Te Whatu Ora APIs you are accessing personally identifiable information from the NHI 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 prior to access to production.
Business Functions Description Comments
Get Patient Get Patient using an NHI number Returns a patient resource See Get Patient use case
Get Patient - Enrolled GP Get Patient using an NHI number and include the patients enrolled GP in the response ​The patient’s enrolled GP information is returned in the patient resource
The source for this is the National Enrolment Service (NES)
NES Business owner approval required
See Get Patient use case
See information on Patient’s Enrolled GP
Get Patient - Contact details Get Patient using an NHI number and include the patient’s contact details in the response The patient’s contact details are returned in the patient resource.
The source for this is the National Enrolment Service Patient Preferences.
Access to a patient’s contact details in Production will only be granted to Te Whatu Ora business teams that have completed a Privacy Impact Assessment which has been assessed and approved by the Te Whatu Ora privacy team. Business Owners should progress this in parallel with any application development. Production access to contact details will not be granted unless this step has been completed.
See Get Patient use case
See information on Patient’s Contact details
Search Patient Search Patient using name, birthdate and other demographics Returns only the core NHI fields (No enrolled GP or contact details even if the user has the correct permissions.
Returns a patient resource See Match Patient use case
Maintain Patient Update Patient records Provided on a limited basis to primary and secondary healthcare providers, and health system data quality teams.
Allows access to the following operations: Compliance will be issued by operation.
For those without access this may be achieved by phoning the Te Whatu Ora contact centre (0800 855 066).
Create Patient Create Patient records Provided on a limited basis to primary and secondary healthcare providers.
For those without access this may be achieved by phoning the Te Whatu Ora contact centre (0800 855 066).
See Create Patient use case
Validate Patient Validate Patient using an NHI number and patient demographics See Validate Patient use case