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
| Official URL: https://fhir-ig.digital.health.nz/sdhr/OperationDefinition/SDHRVerificationSubmissionsOperation | Version: 1.1.6 | |||
| Draft as of 2026-10-20 | Computable Name: VerificationSubmissions | |||
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.
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.
URL: [base]/AuditEvent/$verification-submissions
Input parameters Profile:SDHRVerificationSubmissionParameters
Output parameters Profile:SDHRVerificationSubmissionResponseParameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | verification | 1..100 | ||||
| IN | verification.auditEvent | 1..1 | Reference | 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. | ||
| IN | verification.result | 1..1 | code | ValueSet for SDHR Verification Result (Required) | Verification result code for the sampled AuditEvent. | |
| OUT | return | 1..1 | Parameters | Parameters resource conforming to the SDHRVerificationSubmissionResponseParameters profile, summarising per-item processing results for the submitted verifications. |