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
<Bundle xmlns="http://hl7.org/fhir">
<id value="BundleVerificationSamplesPageOneResponseExample"/>
<type value="searchset"/>
<timestamp value="2026-07-03T10:00:00+12:00"/>
<total value="2"/>
<link>
<relation value="self"/>
<url
value="https://api.uat.sdhr.digital.health.nz/s2s/AuditEvent/$verification-samples?_count=1&_getpagesoffset=0"/>
</link>
<link>
<relation value="next"/>
<url
value="https://api.uat.sdhr.digital.health.nz/s2s/AuditEvent/$verification-samples?_count=1&_getpagesoffset=1"/>
</link>
<entry>
<fullUrl
value="https://api.uat.sdhr.digital.health.nz/s2s/AuditEvent/b3f9de58-2da4-427c-a39c-07147eac3615"/>
<resource>
<AuditEvent>
<id value="b3f9de58-2da4-427c-a39c-07147eac3615"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><a name="AuditEvent_b3f9de58-2da4-427c-a39c-07147eac3615"> </a><p class="res-header-id"><b>Generated Narrative: AuditEvent b3f9de58-2da4-427c-a39c-07147eac3615</b></p><a name="b3f9de58-2da4-427c-a39c-07147eac3615"> </a><a name="hcb3f9de58-2da4-427c-a39c-07147eac3615"> </a><p><b>type</b>: <a href="http://terminology.hl7.org/7.4.0/CodeSystem-audit-event-type.html#audit-event-type-rest">Audit Event ID: rest</a> (RESTful Operation)</p><p><b>recorded</b>: 2026-07-03 09:15:00+1200</p><blockquote><p><b>agent</b></p><p><b>role</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/extra-security-role-type dataprocessor}">Data Processor</span></p><p><b>who</b>: Identifier: <code>https://api.auth.digital.health.nz/realms/hnz-integration/clients</code>/2b628d46-bdad-4f91-a3b0-c26e058c7d24</p><p><b>requestor</b>: false</p></blockquote><blockquote><p><b>agent</b></p><p><b>role</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/v3-RoleClass PROV}">healthcare provider</span></p><p><b>who</b>: Identifier: HPIProvider/99ZZFX</p><p><b>requestor</b>: true</p></blockquote><blockquote><p><b>agent</b></p><p><b>role</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/v3-RoleClass PROV}">healthcare provider</span></p><p><b>who</b>: Identifier: HPIOrganization/GZZ999</p><p><b>requestor</b>: false</p></blockquote><h3>Sources</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Observer</b></td></tr><tr><td style="display: none">*</td><td>SDHR verification samples</td></tr></table><blockquote><p><b>entity</b></p><blockquote><p><b>detail</b></p><p><b>type</b>: nhi</p><p><b>value</b>: ZZZ0004</p></blockquote><blockquote><p><b>detail</b></p><p><b>type</b>: correlationId</p><p><b>value</b>: c500dae6-ac65-4e4f-a4c1-5aa222a6a807</p></blockquote></blockquote></div>
</text>
<type>
<system
value="http://terminology.hl7.org/CodeSystem/audit-event-type"/>
<code value="rest"/>
</type>
<recorded value="2026-07-03T09:15:00+12:00"/>
<agent>
<role>
<coding>
<system
value="http://terminology.hl7.org/CodeSystem/extra-security-role-type"/>
<code value="dataprocessor"/>
</coding>
</role>
<who>
<identifier>
<system
value="https://api.auth.digital.health.nz/realms/hnz-integration/clients"/>
<value value="2b628d46-bdad-4f91-a3b0-c26e058c7d24"/>
</identifier>
</who>
<requestor value="false"/>
</agent>
<agent>
<role>
<coding>
<system
value="http://terminology.hl7.org/CodeSystem/v3-RoleClass"/>
<code value="PROV"/>
</coding>
</role>
<who>
<identifier>
<system
value="https://standards.digital.health.nz/ns/hpi-person-id"/>
<value value="99ZZFX"/>
</identifier>
</who>
<requestor value="true"/>
</agent>
<agent>
<role>
<coding>
<system
value="http://terminology.hl7.org/CodeSystem/v3-RoleClass"/>
<code value="PROV"/>
</coding>
</role>
<who>
<identifier>
<system
value="https://standards.digital.health.nz/ns/hpi-organisation-id"/>
<value value="GZZ999"/>
</identifier>
</who>
<requestor value="false"/>
</agent>
<source>
<observer>
<display value="SDHR verification samples"/>
</observer>
</source>
<entity>
<detail>
<type value="nhi"/>
<valueString value="ZZZ0004"/>
</detail>
<detail>
<type value="correlationId"/>
<valueString value="c500dae6-ac65-4e4f-a4c1-5aa222a6a807"/>
</detail>
</entity>
</AuditEvent>
</resource>
</entry>
</Bundle>