NZ Shared Digital Health Record API
1.1.6 - release
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
{
"resourceType" : "Bundle",
"id" : "BundleVerificationSamplesResponseExample",
"type" : "searchset",
"timestamp" : "2026-07-03T10:00:00+12:00",
"total" : 2,
"link" : [
{
"relation" : "self",
"url" : "https://api.uat.sdhr.digital.health.nz/s2s/AuditEvent/$verification-samples"
}
],
"entry" : [
{
"fullUrl" : "https://api.uat.sdhr.digital.health.nz/s2s/AuditEvent/b3f9de58-2da4-427c-a39c-07147eac3615",
"resource" : {
"resourceType" : "AuditEvent",
"id" : "b3f9de58-2da4-427c-a39c-07147eac3615",
"text" : {
"status" : "generated",
"div" : "<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>"
},
"type" : {
"system" : "http://terminology.hl7.org/CodeSystem/audit-event-type",
"code" : "rest"
},
"recorded" : "2026-07-03T09:15:00+12:00",
"agent" : [
{
"role" : [
{
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/extra-security-role-type",
"code" : "dataprocessor"
}
]
}
],
"who" : {
"identifier" : {
"system" : "https://api.auth.digital.health.nz/realms/hnz-integration/clients",
"value" : "2b628d46-bdad-4f91-a3b0-c26e058c7d24"
}
},
"requestor" : false
},
{
"role" : [
{
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/v3-RoleClass",
"code" : "PROV"
}
]
}
],
"who" : {
"identifier" : {
"system" : "https://standards.digital.health.nz/ns/hpi-person-id",
"value" : "99ZZFX"
}
},
"requestor" : true
},
{
"role" : [
{
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/v3-RoleClass",
"code" : "PROV"
}
]
}
],
"who" : {
"identifier" : {
"system" : "https://standards.digital.health.nz/ns/hpi-organisation-id",
"value" : "GZZ999"
}
},
"requestor" : false
}
],
"source" : {
"observer" : {
"display" : "SDHR verification samples"
}
},
"entity" : [
{
"detail" : [
{
"type" : "nhi",
"valueString" : "ZZZ0004"
},
{
"type" : "correlationId",
"valueString" : "c500dae6-ac65-4e4f-a4c1-5aa222a6a807"
}
]
}
]
}
},
{
"fullUrl" : "https://api.uat.sdhr.digital.health.nz/s2s/AuditEvent/6ebffb1a-61a1-4646-857e-51d4153b698d",
"resource" : {
"resourceType" : "AuditEvent",
"id" : "6ebffb1a-61a1-4646-857e-51d4153b698d",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><a name=\"AuditEvent_6ebffb1a-61a1-4646-857e-51d4153b698d\"> </a><p class=\"res-header-id\"><b>Generated Narrative: AuditEvent 6ebffb1a-61a1-4646-857e-51d4153b698d</b></p><a name=\"6ebffb1a-61a1-4646-857e-51d4153b698d\"> </a><a name=\"hc6ebffb1a-61a1-4646-857e-51d4153b698d\"> </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:20: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>"
},
"type" : {
"system" : "http://terminology.hl7.org/CodeSystem/audit-event-type",
"code" : "rest"
},
"recorded" : "2026-07-03T09:20:00+12:00",
"agent" : [
{
"role" : [
{
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/extra-security-role-type",
"code" : "dataprocessor"
}
]
}
],
"who" : {
"identifier" : {
"system" : "https://api.auth.digital.health.nz/realms/hnz-integration/clients",
"value" : "2b628d46-bdad-4f91-a3b0-c26e058c7d24"
}
},
"requestor" : false
},
{
"role" : [
{
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/v3-RoleClass",
"code" : "PROV"
}
]
}
],
"who" : {
"identifier" : {
"system" : "https://standards.digital.health.nz/ns/hpi-person-id",
"value" : "99ZZFX"
}
},
"requestor" : true
},
{
"role" : [
{
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/v3-RoleClass",
"code" : "PROV"
}
]
}
],
"who" : {
"identifier" : {
"system" : "https://standards.digital.health.nz/ns/hpi-organisation-id",
"value" : "GZZ999"
}
},
"requestor" : false
}
],
"source" : {
"observer" : {
"display" : "SDHR verification samples"
}
},
"entity" : [
{
"detail" : [
{
"type" : "nhi",
"valueString" : "ZZZ0004"
},
{
"type" : "correlationId",
"valueString" : "c500dae6-ac65-4e4f-a4c1-5aa222a6a807"
}
]
}
]
}
}
]
}