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

OperationDefinition: SDHRVerificationSamplesOperation

Official URL: https://fhir-ig.digital.health.nz/sdhr/OperationDefinition/SDHRVerificationSamplesOperation Version: 1.1.6
Draft as of 2026-10-20 Computable Name: VerificationSamples

DRAFT OPERATION: This operation returns AuditEvent resources that have been sampled for verification and are still outstanding for the data viewer application.

The operation is invoked on the AuditEvent type using GET /AuditEvent/$verification-samples.

Sampling runs independently of this retrieval operation.

A 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.

Samples:

  • are pending verification
  • belong to the authenticated client_id
  • have not already been marked as verified by the data viewer application

The operation supports optional paging parameters:

  • _count to limit the maximum number of samples returned in a single response
  • _getpagesoffset to skip a number of matching samples before returning results

Only 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.

The required operation scope is https://fhir-ig.digital.health.nz/sdhr/OperationDefinition/SDHRVerificationSamplesOperation. Generic AuditEvent read, search and write routes are unavailable.

URL: [base]/AuditEvent/$verification-samples

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
IN_count0..1integer

Optional page size. Limits the maximum number of sampled AuditEvent resources returned in the Bundle.

IN_getpagesoffset0..1integer

Optional zero-based starting offset. Skips the specified number of matching sampled AuditEvent resources before returning results.

OUTreturn1..1Bundle

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.