New Zealand NES IG
1.4.7-snapshot - Release

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

Onboarding

Enrolment and Entitlement Onboarding

Who can apply for access?

To the test environment:

Health professionals, agencies governed by the Health Information Privacy Code (HIPC) and their software vendors will be given access to the National Enrolment Service (NES) in the Health Identity Platform (HIP) Compliance environment for testing and training after completing the on-boarding process described below.

To the production environment:

Access to the NES is available to Health professionals and agencies governed by the Health Information Privacy Code (HIPC).

Each organisation and user that has access to the NES accepts their obligations under the Privacy Act 1993 and the Health Information Privacy Code 1994 to only access information about patients they are treating and are authorised to do so. NES information may also be accessed when assessing a patient’s eligibility for specific programmes, such as bowel and breast screening.

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. When you are ready for compliance testing, email the integration team to get a compliance testing template.
  5. Submit the results of the compliance tests using this form [HIP Compliance Submission] (https://mohapis.atlassian.net/servicedesk/customer/portal/3/group/11/create/129).
  6. 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.
  7. 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.

By using Te Whatu Ora APIs you are accessing personally identifiable information from the NES 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
Business Functions Description Comments
FLS Read To allow access to get an FLS or FLS-NF enrolment by enrolment-id, or to get persons FLS or FLS-NF enrolment using NHI and other search parameters See Get Enrolment use case
See Search Enrolment use case
FLS Maintain Create and Update for FLS and FLS-NF enrolments See create Enrolment use case
See update Enrolment use case
LMC Read To allow access to get an LMC enrolment by enrolment-id, or to get persons LMC enrolment using NHI and other search parameters See Get Enrolment use case
See Search Enrolment use case
LMC Maintain Create and Update for LMC enrolments See create Enrolment use case
See update Enrolment use case
WCTO Read To allow access to get a WCTO enrolment by enrolment-id, or to get persons WCTO enrolments using NHI and other search parameters See Get Enrolment use case
See Search Enrolment use case
WCTO Maintain Create and Update for WCTO enrolments See create Enrolment use case
See update Enrolment use case
Health Entitlements Read Get a Patients Entitlement using identifier, or
Get a Patient's Entitlement using NHI, with optional search parameters status and type		 See get Entitlement use case
See search Entitlement use case
Health Entitlements Maintain Create and Update Patient Health Entitlements See create Entitlement use case

New Born Enrolment Service

Who can apply for access?

To the test environment:

Maternity and related service providers and their software vendors will be given access to the Newborn Enrolment Service (NBES) in the Health Identity Platform (HIP) Compliance environment for testing and training after completing the on-boarding process described below.

To the production environment:

Access to the NBES is available to Maternity and related service providers who require the ability to send newborn enrolment nominations.

On-boarding and Implementation

  1. To get started, complete the online onboarding request form. You will need to provide information about your organisation and the API you want to integrate with.
  2. Once your onboarding request has been approved, you will be provided with the information to start your integration. The integration team will be in touch if further information is required.
    • You will receive your credentials in an email and a sms message to the details provided in the onboarding form.
    • You will also receive the access token url, provided scopes, and the UAT 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.
  6. Access will only be given to the Te Whatu Ora Whaihua platform users, the Te Whatu Ora Enrolment nomination subscriber and HealthLink in the initial implementation (Q4, 2023). If you are interested in this business function please contact integration@health.govt.nz.

Please allow at least 5 working days for these applications to be processed and production credentials issued. If your product is to be used by many different organisations please get in touch to discuss your rollout plans and how we might assist.

If you require help or have any questions regarding the onboarding process, please contact our team by completing a General enquiry form.

Business Functions

See below for available business functions.
By using Te Whatu Ora APIs you are accessing personally identifiable information from the NES 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
Business Functions Description Comments
Enrolment Nomination
  • The ability to send a newborn enrolment nomination message (Te Whatu Ora Whaihua platform users and Te Whatu Ora Enrolment nomination subscriber only).
  • The ability to respond to an enrolment nomination message (HealthLink only).
 See Enrolment Nomination use case