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
| Draft as of 2026-10-20 |
{
"resourceType" : "OperationDefinition",
"id" : "SDHRVerificationSamplesOperation",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition SDHRVerificationSamplesOperation</b></p><a name=\"SDHRVerificationSamplesOperation\"> </a><a name=\"hcSDHRVerificationSamplesOperation\"> </a><p>URL: [base]/AuditEvent/$verification-samples</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>_count</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#integer\">integer</a></td><td/><td><div><p>Optional page size. Limits the maximum number of sampled AuditEvent resources returned in the Bundle.</p>\n</div></td></tr><tr><td>IN</td><td>_getpagesoffset</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#integer\">integer</a></td><td/><td><div><p>Optional zero-based starting offset. Skips the specified number of matching sampled AuditEvent resources before returning results.</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></td><td/><td><div><p>A searchset Bundle of slim AuditEvent resources conforming to SDHRAuditEvent for the authenticated client, including an empty Bundle when no samples are pending. Bundle paging links return to this operation.</p>\n</div></td></tr></table></div>"
},
"url" : "https://fhir-ig.digital.health.nz/sdhr/OperationDefinition/SDHRVerificationSamplesOperation",
"version" : "1.1.6",
"name" : "VerificationSamples",
"status" : "draft",
"kind" : "operation",
"date" : "2026-10-20T03:14:47+00:00",
"publisher" : "Health New Zealand",
"contact" : [
{
"name" : "Health New Zealand",
"telecom" : [
{
"system" : "url",
"value" : "https://github.com/tewhatuora"
}
]
},
{
"name" : "HNZ Integration Team",
"telecom" : [
{
"system" : "email",
"value" : "integration@tewhatuora.govt.nz",
"use" : "work"
}
]
}
],
"description" : "DRAFT OPERATION: This operation returns `AuditEvent` resources that have been sampled for verification and are still outstanding for the data viewer application.\n\nThe operation is invoked on the `AuditEvent` type using `GET /AuditEvent/$verification-samples`.\n\nSampling runs independently of this retrieval operation.\n\nA successful response is always a searchset `Bundle` containing slim `SDHRAuditEvent` samples. In each sample, the application agent has the `dataprocessor` role and identifies the Keycloak client UUID in `who.identifier`. The separate healthworker agent carries the clinician’s HPI person identifier; an organisation agent may also be present. Use the clinician identity, patient NHI and recorded time to assess whether the clinician had a valid reason to access that patient. NHI and correlation ID are returned as string-valued `entity.detail` entries with types `nhi` and `correlationId`.\n\nSamples:\n- are pending verification\n- belong to the authenticated `client_id`\n- have not already been marked as verified by the data viewer application\n\nThe operation supports optional paging parameters:\n- `_count` to limit the maximum number of samples returned in a single response\n- `_getpagesoffset` to skip a number of matching samples before returning results\n\nOnly these paging parameters are forwarded to the sample search. The server fixes the client and pending-verification filters. Follow the returned paging links, which point back to this operation; links may be relative in the development environment. An empty searchset Bundle means no pending samples are currently available.\n\nThe required operation scope is `https://fhir-ig.digital.health.nz/sdhr/OperationDefinition/SDHRVerificationSamplesOperation`. Generic AuditEvent read, search and write routes are unavailable.",
"affectsState" : false,
"code" : "verification-samples",
"resource" : [
"AuditEvent"
],
"system" : false,
"type" : true,
"instance" : false,
"parameter" : [
{
"name" : "_count",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Optional page size. Limits the maximum number of sampled AuditEvent resources returned in the Bundle.",
"type" : "integer"
},
{
"name" : "_getpagesoffset",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Optional zero-based starting offset. Skips the specified number of matching sampled AuditEvent resources before returning results.",
"type" : "integer"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "A searchset Bundle of slim AuditEvent resources conforming to SDHRAuditEvent for the authenticated client, including an empty Bundle when no samples are pending. Bundle paging links return to this operation.",
"type" : "Bundle"
}
]
}