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

: SDHRVerificationSubmissionsOperation - TTL Representation

Draft as of 2026-10-20

Raw ttl | Download


@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

# - resource -------------------------------------------------------------------

<http://hl7.org/fhir/OperationDefinition/SDHRVerificationSubmissionsOperation> a fhir:OperationDefinition ;
  fhir:nodeRole fhir:treeRoot ;
  fhir:Resource.id [ fhir:value "SDHRVerificationSubmissionsOperation"] ;
  fhir:DomainResource.text [
     fhir:Narrative.status [ fhir:value "generated" ] ;
     fhir:Narrative.div "<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>\n</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>\n</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>\n</div></td></tr></table></div>"
  ] ;
  fhir:OperationDefinition.url [ fhir:value "https://fhir-ig.digital.health.nz/sdhr/OperationDefinition/SDHRVerificationSubmissionsOperation"] ;
  fhir:OperationDefinition.version [ fhir:value "1.1.6"] ;
  fhir:OperationDefinition.name [ fhir:value "VerificationSubmissions"] ;
  fhir:OperationDefinition.status [ fhir:value "draft"] ;
  fhir:OperationDefinition.kind [ fhir:value "operation"] ;
  fhir:OperationDefinition.date [ fhir:value "2026-10-20T03:14:47+00:00"^^xsd:dateTime] ;
  fhir:OperationDefinition.publisher [ fhir:value "Health New Zealand"] ;
  fhir:OperationDefinition.contact [
     fhir:index 0 ;
     fhir:ContactDetail.name [ fhir:value "Health New Zealand" ] ;
     fhir:ContactDetail.telecom [
       fhir:index 0 ;
       fhir:ContactPoint.system [ fhir:value "url" ] ;
       fhir:ContactPoint.value [ fhir:value "https://github.com/tewhatuora" ]
     ]
  ], [
     fhir:index 1 ;
     fhir:ContactDetail.name [ fhir:value "HNZ Integration Team" ] ;
     fhir:ContactDetail.telecom [
       fhir:index 0 ;
       fhir:ContactPoint.system [ fhir:value "email" ] ;
       fhir:ContactPoint.value [ fhir:value "integration@tewhatuora.govt.nz" ] ;
       fhir:ContactPoint.use [ fhir:value "work" ]
     ]
  ] ;
  fhir:OperationDefinition.description [ fhir:value "DRAFT OPERATION: This operation allows the data viewer application to submit one or more verification decisions for previously issued `AuditEvent` samples.\n\nThe operation is invoked on the `AuditEvent` type using `POST /AuditEvent/$verification-submissions` with a `Parameters` resource in the request body.\n\nEach 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.\n\nThe 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.\n\nEach 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).\n\nA 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."] ;
  fhir:OperationDefinition.affectsState [ fhir:value "true"^^xsd:boolean] ;
  fhir:OperationDefinition.code [ fhir:value "verification-submissions"] ;
  fhir:OperationDefinition.resource [
     fhir:value "AuditEvent" ;
     fhir:index 0
  ] ;
  fhir:OperationDefinition.system [ fhir:value "false"^^xsd:boolean] ;
  fhir:OperationDefinition.type [ fhir:value "true"^^xsd:boolean] ;
  fhir:OperationDefinition.instance [ fhir:value "false"^^xsd:boolean] ;
  fhir:OperationDefinition.inputProfile [
     fhir:value "https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRVerificationSubmissionParameters" ;
     fhir:link <https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRVerificationSubmissionParameters>
  ] ;
  fhir:OperationDefinition.outputProfile [
     fhir:value "https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRVerificationSubmissionResponseParameters" ;
     fhir:link <https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRVerificationSubmissionResponseParameters>
  ] ;
  fhir:OperationDefinition.parameter [
     fhir:index 0 ;
     fhir:OperationDefinition.parameter.name [ fhir:value "verification" ] ;
     fhir:OperationDefinition.parameter.use [ fhir:value "in" ] ;
     fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ] ;
     fhir:OperationDefinition.parameter.max [ fhir:value "100" ] ;
     fhir:OperationDefinition.parameter.part [
       fhir:index 0 ;
       fhir:OperationDefinition.parameter.name [ fhir:value "auditEvent" ] ;
       fhir:OperationDefinition.parameter.use [ fhir:value "in" ] ;
       fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ] ;
       fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
       fhir:OperationDefinition.parameter.documentation [ fhir: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." ] ;
       fhir:OperationDefinition.parameter.type [ fhir:value "Reference" ]
     ], [
       fhir:index 1 ;
       fhir:OperationDefinition.parameter.name [ fhir:value "result" ] ;
       fhir:OperationDefinition.parameter.use [ fhir:value "in" ] ;
       fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ] ;
       fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
       fhir:OperationDefinition.parameter.documentation [ fhir:value "Verification result code for the sampled AuditEvent." ] ;
       fhir:OperationDefinition.parameter.type [ fhir:value "code" ] ;
       fhir:OperationDefinition.parameter.binding [
         fhir:OperationDefinition.parameter.binding.strength [ fhir:value "required" ] ;
         fhir:OperationDefinition.parameter.binding.valueSet [
           fhir:value "https://fhir-ig.digital.health.nz/sdhr/ValueSet/sdhr-verification-result-valueset" ;
           fhir:link <https://fhir-ig.digital.health.nz/sdhr/ValueSet/sdhr-verification-result-valueset>
         ]
       ]
     ]
  ], [
     fhir:index 1 ;
     fhir:OperationDefinition.parameter.name [ fhir:value "return" ] ;
     fhir:OperationDefinition.parameter.use [ fhir:value "out" ] ;
     fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:integer ] ;
     fhir:OperationDefinition.parameter.max [ fhir:value "1" ] ;
     fhir:OperationDefinition.parameter.documentation [ fhir:value "Parameters resource conforming to the SDHRVerificationSubmissionResponseParameters profile, summarising per-item processing results for the submitted verifications." ] ;
     fhir:OperationDefinition.parameter.type [ fhir:value "Parameters" ]
  ] .

# - ontology header ------------------------------------------------------------

<http://hl7.org/fhir/OperationDefinition/SDHRVerificationSubmissionsOperation.ttl> a owl:Ontology ;
  owl:imports fhir:fhir.ttl ;
  owl:versionIRI <http://build.fhir.org/OperationDefinition/SDHRVerificationSubmissionsOperation.ttl> .