NZ Shared Digital Health Record API
1.1.0 - release
NZ Shared Digital Health Record API
1.1.0 - release
NZ Shared Digital Health Record API - Local Development build (v1.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
{
"resourceType" : "Bundle",
"id" : "BundleVerificationSamplesResponseExample",
"type" : "collection",
"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",
"meta" : {
"profile" : [
🔗 "https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRAuditEvent"
]
},
"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><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\"/><p style=\"margin-bottom: 0px\">Profile: <a href=\"StructureDefinition-SDHRAuditEvent.html\">SDHRAuditEvent</a></p></div><p><b>type</b>: <a href=\"http://terminology.hl7.org/7.2.0/CodeSystem-audit-event-type.html#audit-event-type-rest\">Audit Event ID: rest</a> (Restful Operation)</p><p><b>subtype</b>: <a href=\"http://hl7.org/fhir/R4/codesystem-restful-interaction.html#restful-interaction-read\">FHIR Restful Interactions: read</a> (read)</p><p><b>action</b>: Read/View/Print</p><p><b>recorded</b>: 2026-07-03 09:15:00+1200</p><p><b>outcome</b>: Success</p><p><b>outcomeDesc</b>: Successful access sample returned for verification workflow.</p><h3>Agents</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Who</b></td><td><b>Requestor</b></td></tr><tr><td style=\"display: none\">*</td><td>Identifier: HPIProvider/1234</td><td>true</td></tr></table><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>HNZ API Gateway</td></tr></table><blockquote><p><b>entity</b></p><p><b>what</b>: Identifier: <code>https://standards.digital.health.nz/ns/nhi</code>/ZKC7284</p></blockquote><blockquote><p><b>entity</b></p><p><b>what</b>: <a href=\"https://simplifier.net/resolve?scope=fhir.org.nz.ig.base@3.0.0&canonical=http://fhir.org.nz/ig/base/Condition/ConditionRespiratoryExample\">Condition/ConditionRespiratoryExample</a></p><h3>Details</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Type</b></td><td><b>Value[x]</b></td></tr><tr><td style=\"display: none\">*</td><td>correlationId</td><td>c500dae6-ac65-4e4f-a4c1-5aa222a6a807</td></tr></table></blockquote></div>"
},
"type" : {
"system" : "http://terminology.hl7.org/CodeSystem/audit-event-type",
"code" : "rest",
"display" : "Restful Operation"
},
"subtype" : [
{
"system" : "http://hl7.org/fhir/restful-interaction",
"code" : "read",
"display" : "read"
}
],
"action" : "R",
"recorded" : "2026-07-03T09:15:00+12:00",
"outcome" : "0",
"outcomeDesc" : "Successful access sample returned for verification workflow.",
"agent" : [
{
"who" : {
"identifier" : {
"system" : "https://standards.digital.health.nz/ns/hpi-person-id",
"value" : "1234"
}
},
"requestor" : true
}
],
"source" : {
"observer" : {
"display" : "HNZ API Gateway"
}
},
"entity" : [
{
"what" : {
"identifier" : {
"system" : "https://standards.digital.health.nz/ns/nhi",
"value" : "ZKC7284"
}
}
},
{
"what" : {
"reference" : "Condition/ConditionRespiratoryExample"
},
"detail" : [
{
"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",
"meta" : {
"profile" : [
🔗 "https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRAuditEvent"
]
},
"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><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\"/><p style=\"margin-bottom: 0px\">Profile: <a href=\"StructureDefinition-SDHRAuditEvent.html\">SDHRAuditEvent</a></p></div><p><b>type</b>: <a href=\"http://terminology.hl7.org/7.2.0/CodeSystem-audit-event-type.html#audit-event-type-rest\">Audit Event ID: rest</a> (Restful Operation)</p><p><b>subtype</b>: <a href=\"http://hl7.org/fhir/R4/codesystem-restful-interaction.html#restful-interaction-search-type\">FHIR Restful Interactions: search-type</a> (search-type)</p><p><b>action</b>: Execute</p><p><b>recorded</b>: 2026-07-03 09:20:00+1200</p><p><b>outcome</b>: Success</p><p><b>outcomeDesc</b>: Successful search access sample returned for verification workflow.</p><h3>Agents</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Who</b></td><td><b>Requestor</b></td></tr><tr><td style=\"display: none\">*</td><td>Identifier: HPIProvider/1234</td><td>true</td></tr></table><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>HNZ API Gateway</td></tr></table><blockquote><p><b>entity</b></p><p><b>what</b>: Identifier: <code>https://standards.digital.health.nz/ns/nhi</code>/ZKC7284</p></blockquote><blockquote><p><b>entity</b></p><p><b>what</b>: <a href=\"AllergyIntolerance-AllergyIntoleranceExample.html\">AllergyIntolerance Allergy to penicillin (finding)</a></p><h3>Details</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Type</b></td><td><b>Value[x]</b></td></tr><tr><td style=\"display: none\">*</td><td>correlationId</td><td>c500dae6-ac65-4e4f-a4c1-5aa222a6a807</td></tr></table></blockquote></div>"
},
"type" : {
"system" : "http://terminology.hl7.org/CodeSystem/audit-event-type",
"code" : "rest",
"display" : "Restful Operation"
},
"subtype" : [
{
"system" : "http://hl7.org/fhir/restful-interaction",
"code" : "search-type",
"display" : "search-type"
}
],
"action" : "E",
"recorded" : "2026-07-03T09:20:00+12:00",
"outcome" : "0",
"outcomeDesc" : "Successful search access sample returned for verification workflow.",
"agent" : [
{
"who" : {
"identifier" : {
"system" : "https://standards.digital.health.nz/ns/hpi-person-id",
"value" : "1234"
}
},
"requestor" : true
}
],
"source" : {
"observer" : {
"display" : "HNZ API Gateway"
}
},
"entity" : [
{
"what" : {
"identifier" : {
"system" : "https://standards.digital.health.nz/ns/nhi",
"value" : "ZKC7284"
}
}
},
{
"what" : {
🔗 "reference" : "AllergyIntolerance/AllergyIntoleranceExample"
},
"detail" : [
{
"type" : "correlationId",
"valueString" : "c500dae6-ac65-4e4f-a4c1-5aa222a6a807"
}
]
}
]
}
}
]
}