Digital Health Identity

NOTE: A new platform called the Digital Services Hub will be coming in June with a broader range of services.

It will host APIs and services that have been onboarded by Health NZ, and include a developer portal with application programming interface (API) testing capabilities and identity and access protections.

Overview

The Digital Health Identity (DHI) service is an authentication and identity solution that enables health consumers and health professionals to confirm who they are digitally and engage in online healthcare services using their My Health Account or My Health Account Workforce.

Online health services may include lab results, vaccination records and other personal health information. An example of an online health service is My Health Record(external link).

Digital Health Identity service

The DHI service is a standards-based service that supports OpenID Connect. This adherence to standards means you can use your preferred OAuth library for integrating with the service.

The DHI platform provides a combination of standard and custom ‘claims’. The claims you can access will depend on how you agree to use them and what confidence level is granted during onboarding.

Who can use this digital service

Users of the DHI service could include, but are not limited to:

• primary health organisations (PHOs) with consumer portals
• private companies providing patient portals or other digital services to better the health outcomes of their customers
• health sector start-ups looking to leverage a large potential customer base
• other government agencies with an interest in the health outcomes of New Zealanders.

The DHI vision is to enable New Zealand health consumers to improve their health outcomes through access to digital health services.

If you think your service or application is suitable, get in touch.

Example use cases

The DHI Service could be used:

• to confirm users are who they say they are in a digital health environment  
• to allow users to manage health records through a self-service web portal or mobile application 
• by healthcare application providers wanting to enable access to their products and services for anyone who holds a My Health Account or My Health Account Workforce
• by application (app) developers who require high-levels of confidence in a health consumer’s identity before sharing sensitive health-related information. 

Digital service type

OpenID Connect (OIDC)

Onboarding and implementation

Before starting the onboarding process, review the DHI Onboarding Guide. This guide provides useful information about the DHI service and the steps required to onboard and integrate your application, including meeting the brand guidelines.

Digital Health Identity: Onboarding and Integration Guide (V6.2) [PDF, 1.7 MB]

My Health Account: Brand Guidelines (V3.0) [PDF, 3.4 MB]

My Health Account Workforce: Brand Guidelines (V3.0) [PDF, 3.3 MB]

Branding resources (V2.0) [ZIP, 62 KB]

Once you have read the guide, complete the online onboarding request form. You will need to provide information about your organisation and the applications you will integrate with the DHI service.

Digital Health Identity Service Onboarding Request Form(external link)

Once your onboarding request has been approved, you will be provided with the information to start integration. The DHI onboarding team will be in touch if further information is required.

Technical

A test environment is available for all development activities. You will be setup with access as part of the onboarding process.

If you require support for onboarding or integration, email DHI.Integration@health.govt.nz.

Learn more

My Health Account information — Health New Zealand(external link)

My Health Account(external link)

My Health Account Workforce information – (external link)Health New Zealand(external link)(external link)

My Health Account Workforce(external link)

OpenID Connect(external link)