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

• Narrative Content
• XML
• JSON
• TTL

: SDHRVerificationSubmissionsOperation - XML Representation

Draft as of 2026-07-22

Raw xml | Download

<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..*</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>Reference to the sampled AuditEvent being verified.</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.0"/>
  <name value="VerificationSubmissions"/>
  <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 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."/>
  <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="*"/>
    <part>
      <name value="auditEvent"/>
      <use value="in"/>
      <min value="1"/>
      <max value="1"/>
      <documentation
                     value="Reference to the sampled AuditEvent being verified."/>
      <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>