NZ Shared Digital Health Record API
1.0.0 - 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.0.0 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: SearchWithRecordsWithheldExample

Last updated: 2025-04-29 23:35:29+0000

Bundle SearchWithRecordsWithheldExample of type searchset

Entry 1 - fullUrl = https://api.mock.sdhr.digital.health.nz/s2s/Condition/ConditionHypertensionExample

Search:Mode = match

Resource Condition:

> Last updated: 2024-01-26 10:03:26+1300;

> Information Source: https://api.hip.digital.health.nz/fhir/hpi/v1/Location/F38006-B

> Profile: SDHRCondition

> Long Term Condition Indicator: true

> Client Last Updated: 2023-11-26 10:02:45+1300

> HNZ SDHR Highlighted: true

> identifier: `https://fhir.examplepms.co.nz`/ec2d6cad-1e19-46ee-accf-dc460a680710 (use: secondary, )

> clinicalStatus: Active

> verificationStatus: Confirmed

> code: Hypertension

> subject: Sage Westbrook

> onset: 2011-02-05 00:00:00+1300

> recordedDate: 2023-11-26 10:02:45+1300

Entry 2

Search:Mode = outcome

Resource OperationOutcome:

> All OK

> Severity | Location | Code | Details | Diagnostics
> Information |  | Informational Note | Patient has withheld records at source. The operation was successful, but some records were not included in the response due to confidentiality settings. |