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

OperationDefinition: SDHRVerificationSamplesOperation

Official URL: https://fhir-ig.digital.health.nz/sdhr/OperationDefinition/SDHRVerificationSamplesOperation Version: 1.1.0
Draft as of 2026-07-22 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.

The response is a Bundle containing sampled AuditEvent resources that:

  • are pending verification
  • are eligible for the authenticated caller
  • 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
  • _offset to skip a number of matching samples before returning results

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_offset0..1integer

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

OUTreturn1..1Bundle

Bundle of sampled AuditEvent resources requiring verification by the authenticated data viewer application. When paging is used, the Bundle may include paging links such as self and next.