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: HIP external reference targets (technical stubs)

Bundle HIPReferenceTargets of type collection


Entry 1 - fullUrl = https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZKC7284

Resource Patient:

Anonymous Patient (no stated gender), DoB Unknown



Entry 2 - fullUrl = https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZKC9999

Resource Patient:

Anonymous Patient (no stated gender), DoB Unknown



Entry 3 - fullUrl = https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZMW6002

Resource Patient:

Anonymous Patient (no stated gender), DoB Unknown



Entry 4 - fullUrl = https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZMW6003

Resource Patient:

Anonymous Patient (no stated gender), DoB Unknown



Entry 5 - fullUrl = https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZQW5496

Resource Patient:

Anonymous Patient (no stated gender), DoB Unknown



Entry 6 - fullUrl = https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZXK9000

Resource Patient:

Anonymous Patient (no stated gender), DoB Unknown



Entry 7 - fullUrl = https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/91ZZXN

Resource Practitioner:

Anonymous Practitioner



Entry 8 - fullUrl = https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/99ZZZZ

Resource Practitioner:

Anonymous Practitioner



Entry 9 - fullUrl = https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/91ZZXZ

Resource Practitioner:

Anonymous Practitioner



Entry 10 - fullUrl = https://api.hip.digital.health.nz/fhir/hpi/v1/Location/FXX222-B

Resource Location:

Unnamed Location



Entry 11 - fullUrl = https://api.hip.digital.health.nz/fhir/hpi/v1/Location/FZZ111-A

Resource Location:

Unnamed Location



Entry 12 - fullUrl = https://api.hip.digital.health.nz/fhir/hpi/v1/Location/FZZ998-C

Resource Location:

Unnamed Location



Entry 13 - fullUrl = https://api.hip.digital.health.nz/fhir/hpi/v1/Location/FZZ999-B

Resource Location:

Unnamed Location