NZ Shared Digital Health Record API - Local Development build (v1.1.3) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

NZ Shared Digital Health Record API

Official URL: https://fhir-ig.digital.health.nz/sdhr/ImplementationGuide/tewhatuora.fhir.nz-shared-digital-health-record				Version: 1.1.3
Active as of 2026-08-12				Computable Name: nzshareddigitalhealthrecord

The Shared Digital Health Record (SDHR), provided by Health New Zealand | Te Whatu Ora (Health NZ), enables authorised clinical systems to securely access and share core patient health information across care settings. It brings together information from the SDHR Primary Care Collection and selected national sources through common standards, subject to participation, privacy, confidentiality, security, and access controls. Source systems remain responsible for maintaining the information they provide.

Patient information

Information is available from:

SDHR Primary Care Collection

Information contributed by participating primary care providers:

• Allergies and intolerances
• Health conditions
• Observations

Additional information sources (in development)

Information from from national health information sources:

• Medication requests
• Medication dispenses
• Immunisations

See Contribute information to SDHR, access information from SDHR, data overview, data models, and FHIR artifacts for information about supported interactions, data, profiles, and implementation requirements.

Integration patterns

Clinical systems integrate with SDHR in one or both of the following ways.

Access SDHR information

Shared electronic health record (SEHR) systems and other authorised clinical applications retrieve patient health information from SDHR and make it available to healthcare professionals involved in providing care.

SEHR systems use SDHR information (alongside other clinical information sources as required) to provide a consolidated view of a person's health information.

See the requirements for systems providing access to SDHR information.

Contribute SDHR information

Participating practice management systems (PMS) contribute patient health information to the SDHR Primary Care Collection on behalf of participating primary care providers.

The PMS remains the system of record for information contributed to the SDHR Primary Care Collection.

See the requirements for systems contributing data.

Getting started

To begin integrating with SDHR:

• Begin the onboarding process through the Digital Services Hub consumer onboarding process.
• Review the use cases for contributing information and accessing information, and the data overview.
• Review the API documentation.
• Explore the FHIR artifacts and data models.
• Review the requirements for systems accessing or contributing SDHR information.
• ​Download the UAT Postman collection and example environment.

Additional information

Additional information about SDHR, participation, privacy, and onboarding:

• For patients: SDHR privacy and information-sharing choices.
• For practices: About the Shared Digital Health Record.
• For participating providers: Onboarding to the Shared Digital Health Record.

FHIR version

​This is an R4 IG. None of the features it uses are changed in R4B, so it can be used as is with R4B systems. Packages for both R4 (tewhatuora.fhir.nz-shared-digital-health-record.r4) and R4B (tewhatuora.fhir.nz-shared-digital-health-record.r4b) are available.