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

: SDHRVerificationSamplesOperation - XML Representation

Draft as of 2026-07-22

Raw xml | Download


<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="SDHRVerificationSamplesOperation"/>
  <text>
    <status value="generated"/>
    <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>
</div></td></tr><tr><td>IN</td><td>_offset</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>
</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>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 <code>self</code> and <code>next</code>.</p>
</div></td></tr></table></div>
  </text>
  <url
       value="https://fhir-ig.digital.health.nz/sdhr/OperationDefinition/SDHRVerificationSamplesOperation"/>
  <version value="1.1.0"/>
  <name value="VerificationSamples"/>
  <status value="draft"/>
  <kind value="operation"/>
  <date value="2026-07-22T06:20:47+00:00"/>
  <publisher value="Health New Zealand"/>
  <contact>
    <name value="Health New Zealand"/>
    <telecom>
      <system value="url"/>
      <value value="https://github.com/tewhatuora"/>
    </telecom>
  </contact>
  <contact>
    <name value="HNZ Integration Team"/>
    <telecom>
      <system value="email"/>
      <value value="integration@tewhatuora.govt.nz"/>
      <use value="work"/>
    </telecom>
  </contact>
  <description
               value="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"/>
  <code value="verification-samples"/>
  <resource value="AuditEvent"/>
  <system value="false"/>
  <type value="true"/>
  <instance value="false"/>
  <parameter>
    <name value="_count"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="Optional page size. Limits the maximum number of sampled AuditEvent resources returned in the Bundle."/>
    <type value="integer"/>
  </parameter>
  <parameter>
    <name value="_offset"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="Optional zero-based starting offset. Skips the specified number of matching sampled AuditEvent resources before returning results."/>
    <type value="integer"/>
  </parameter>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="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`."/>
    <type value="Bundle"/>
  </parameter>
</OperationDefinition>