HSAAP Special Authority FHIR Implementation Guide - Local Development build (v0.1.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Narrative Content
• JSON

: Submit Special Authority Application - JSON Representation

Draft as of 2026-10-15

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "sa-claim-submit",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition sa-claim-submit</b></p><a name=\"sa-claim-submit\"> </a><a name=\"hcsa-claim-submit\"> </a><p>URL: [base]/Claim/$submit</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>resource</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></td><td/><td><div><p>An SA Submission Bundle (https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/sa-submission-bundle).</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/bundle.html\">Bundle</a></td><td/><td><div><p>An SA Response Bundle (https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/sa-response-bundle).</p>\n</div></td></tr></table></div>"
  },
  "url" : "https://fhir-ig.digital.health.nz/special-authority/OperationDefinition/sa-claim-submit",
  "version" : "0.1.1",
  "name" : "SASubmitApplication",
  "title" : "Submit Special Authority Application",
  "status" : "draft",
  "kind" : "operation",
  "experimental" : false,
  "date" : "2026-10-15",
  "publisher" : "Health New Zealand | Te Whatu Ora",
  "contact" : [
    {
      "name" : "Health New Zealand | Te Whatu Ora",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://www.tewhatuora.govt.nz/"
        },
        {
          "system" : "email",
          "value" : "integration@tewhatuora.govt.nz"
        }
      ]
    },
    {
      "name" : "HNZ Integration Team",
      "telecom" : [
        {
          "system" : "email",
          "value" : "integration@tewhatuora.govt.nz",
          "use" : "work"
        }
      ]
    }
  ],
  "description" : "Submits a Special Authority Application as a single, atomically accepted or rejected SA Submission Bundle. The Bundle is POSTed directly as the request body (Content-Type application/fhir+json). The response is an SA Response Bundle containing an SA Application ClaimResponse.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "NZ",
          "display" : "New Zealand"
        }
      ]
    }
  ],
  "affectsState" : true,
  "code" : "submit",
  "base" : "http://hl7.org/fhir/OperationDefinition/Claim-submit",
  "resource" : [
    "Claim"
  ],
  "system" : false,
  "type" : true,
  "instance" : false,
  "parameter" : [
    {
      "name" : "resource",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "An SA Submission Bundle (https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/sa-submission-bundle).",
      "type" : "Bundle"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "An SA Response Bundle (https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/sa-response-bundle).",
      "type" : "Bundle"
    }
  ]
}