NZ Shared Digital Health Record API
1.1.6 - release

NZ Shared Digital Health Record API, published by Health New Zealand. This guide is not an authorized publication; it is the continuous build for version 1.1.6 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/fhir-sdhr/ and changes regularly. See the Directory of published versions

Example Bundle: BundleVerificationSamplesResponseExample

Bundle BundleVerificationSamplesResponseExample of type searchset


Entry 1 - fullUrl = https://api.uat.sdhr.digital.health.nz/s2s/AuditEvent/b3f9de58-2da4-427c-a39c-07147eac3615

Resource AuditEvent:

type: RESTful Operation

recorded: 2026-07-03 09:15:00+1200

agent

role: Data Processor

who: Identifier: https://api.auth.digital.health.nz/realms/hnz-integration/clients/2b628d46-bdad-4f91-a3b0-c26e058c7d24

requestor: false

agent

role: healthcare provider

who: Identifier: HPIProvider/99ZZFX

requestor: true

agent

role: healthcare provider

who: Identifier: HPIOrganization/GZZ999

requestor: false

Sources

-Observer
*SDHR verification samples

entity

detail

type: nhi

value: ZZZ0004

detail

type: correlationId

value: c500dae6-ac65-4e4f-a4c1-5aa222a6a807


Entry 2 - fullUrl = https://api.uat.sdhr.digital.health.nz/s2s/AuditEvent/6ebffb1a-61a1-4646-857e-51d4153b698d

Resource AuditEvent:

type: RESTful Operation

recorded: 2026-07-03 09:20:00+1200

agent

role: Data Processor

who: Identifier: https://api.auth.digital.health.nz/realms/hnz-integration/clients/2b628d46-bdad-4f91-a3b0-c26e058c7d24

requestor: false

agent

role: healthcare provider

who: Identifier: HPIProvider/99ZZFX

requestor: true

agent

role: healthcare provider

who: Identifier: HPIOrganization/GZZ999

requestor: false

Sources

-Observer
*SDHR verification samples

entity

detail

type: nhi

value: ZZZ0004

detail

type: correlationId

value: c500dae6-ac65-4e4f-a4c1-5aa222a6a807