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 - JSON Representation

Draft as of 2026-07-22

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "SDHRVerificationSubmissionsOperation",
  "text" : {
    "status" : "generated",
    "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..*</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>\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>"
  },
  "url" : "https://fhir-ig.digital.health.nz/sdhr/OperationDefinition/SDHRVerificationSubmissionsOperation",
  "version" : "1.1.0",
  "name" : "VerificationSubmissions",
  "status" : "draft",
  "kind" : "operation",
  "date" : "2026-07-22T06:20:47+00:00",
  "publisher" : "Health New Zealand",
  "contact" : [
    {
      "name" : "Health New Zealand",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://github.com/tewhatuora"
        }
      ]
    },
    {
      "name" : "HNZ Integration Team",
      "telecom" : [
        {
          "system" : "email",
          "value" : "integration@tewhatuora.govt.nz",
          "use" : "work"
        }
      ]
    }
  ],
  "description" : "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.",
  "code" : "verification-submissions",
  "resource" : [
    "AuditEvent"
  ],
  "system" : false,
  "type" : true,
  "instance" : false,
  "inputProfile" : "https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRVerificationSubmissionParameters",
  "outputProfile" : "https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRVerificationSubmissionResponseParameters",
  "parameter" : [
    {
      "name" : "verification",
      "use" : "in",
      "min" : 1,
      "max" : "*",
      "part" : [
        {
          "name" : "auditEvent",
          "use" : "in",
          "min" : 1,
          "max" : "1",
          "documentation" : "Reference to the sampled AuditEvent being verified.",
          "type" : "Reference"
        },
        {
          "name" : "result",
          "use" : "in",
          "min" : 1,
          "max" : "1",
          "documentation" : "Verification result code for the sampled AuditEvent.",
          "type" : "code",
          "binding" : {
            "strength" : "required",
            "valueSet" : "https://fhir-ig.digital.health.nz/sdhr/ValueSet/sdhr-verification-result-valueset"
          }
        }
      ]
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "Parameters resource conforming to the SDHRVerificationSubmissionResponseParameters profile, summarising per-item processing results for the submitted verifications.",
      "type" : "Parameters"
    }
  ]
}