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 |
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="SDHRVerificationSubmissionsOperation"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition SDHRVerificationSubmissionsOperation</b></p><a name="SDHRVerificationSubmissionsOperation"> </a><a name="hcSDHRVerificationSubmissionsOperation"> </a><p>URL: [base]/AuditEvent/$verification-submissions</p><p>Input parameters Profile:<a href="StructureDefinition-SDHRVerificationSubmissionParameters.html">SDHRVerificationSubmissionParameters</a></p><p>Output parameters Profile:<a href="StructureDefinition-SDHRVerificationSubmissionResponseParameters.html">SDHRVerificationSubmissionResponseParameters</a></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>verification</td><td/><td>1..100</td><td/><td/><td/></tr><tr><td>IN</td><td>verification.auditEvent</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/references.html#Reference">Reference</a></td><td/><td><div><p>Relative AuditEvent/{id} reference or absolute HTTP(S) URL ending in /AuditEvent/{id}. The ID identifies a local sample; versioned references, query strings and fragments are not supported.</p>
</div></td></tr><tr><td>IN</td><td>verification.result</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#code">code</a></td><td><a href="ValueSet-sdhr-verification-result-valueset.html">ValueSet for SDHR Verification Result</a> (Required)</td><td><div><p>Verification result code for the sampled AuditEvent.</p>
</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/parameters.html">Parameters</a></td><td/><td><div><p>Parameters resource conforming to the SDHRVerificationSubmissionResponseParameters profile, summarising per-item processing results for the submitted verifications.</p>
</div></td></tr></table></div>
</text>
<url
value="https://fhir-ig.digital.health.nz/sdhr/OperationDefinition/SDHRVerificationSubmissionsOperation"/>
<version value="1.1.6"/>
<name value="VerificationSubmissions"/>
<status value="draft"/>
<kind value="operation"/>
<date value="2026-10-20T03:14: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 allows the data viewer application to submit one or more verification decisions for previously issued `AuditEvent` samples.
The operation is invoked on the `AuditEvent` type using `POST /AuditEvent/$verification-submissions` with a `Parameters` resource in the request body.
Each repeating `verification` parameter identifies an `AuditEvent` sample and the verification result being submitted for that sample. A request may contain 1 to 100 `verification` parameters; requests above this limit are rejected before any decisions are processed.
The required operation scope is `https://fhir-ig.digital.health.nz/sdhr/OperationDefinition/SDHRVerificationSubmissionsOperation`. References may be relative (`AuditEvent/{id}`) or absolute HTTP(S) URLs ending in `/AuditEvent/{id}`; the logical ID identifies a local sample. Versioned references, query strings and fragments are not accepted.
Each item is processed independently, in request order. Accepted result codes are `validated` and `validation-failed`; both mark a pending sample as verified and remove it from subsequent sample responses. The response contains one `verificationSubmissionResult` per submitted verification, with the submitted reference and a status from the [SDHR Verification Submission Status CodeSystem](CodeSystem-sdhr-verification-submission-status.html).
A failure for one item does not stop the remaining items. An invalid Parameters envelope, no verification items, or more than 100 verification items causes a request-level error."/>
<affectsState value="true"/>
<code value="verification-submissions"/>
<resource value="AuditEvent"/>
<system value="false"/>
<type value="true"/>
<instance value="false"/>
<inputProfile
value="https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRVerificationSubmissionParameters"/>
<outputProfile
value="https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRVerificationSubmissionResponseParameters"/>
<parameter>
<name value="verification"/>
<use value="in"/>
<min value="1"/>
<max value="100"/>
<part>
<name value="auditEvent"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation
value="Relative AuditEvent/{id} reference or absolute HTTP(S) URL ending in /AuditEvent/{id}. The ID identifies a local sample; versioned references, query strings and fragments are not supported."/>
<type value="Reference"/>
</part>
<part>
<name value="result"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation
value="Verification result code for the sampled AuditEvent."/>
<type value="code"/>
<binding>
<strength value="required"/>
<valueSet
value="https://fhir-ig.digital.health.nz/sdhr/ValueSet/sdhr-verification-result-valueset"/>
</binding>
</part>
</parameter>
<parameter>
<name value="return"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation
value="Parameters resource conforming to the SDHRVerificationSubmissionResponseParameters profile, summarising per-item processing results for the submitted verifications."/>
<type value="Parameters"/>
</parameter>
</OperationDefinition>