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

: Approval valid on - JSON Representation

Draft as of 2026-10-15

Raw json | Download

{
  "resourceType" : "SearchParameter",
  "id" : "approval-valid-on",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: SearchParameter approval-valid-on</b></p><a name=\"approval-valid-on\"> </a><a name=\"hcapproval-valid-on\"> </a><h2>ApprovalValidOn</h2><p>Parameter <code>approval-valid-on</code>:<code>date</code></p><div><p>Matches Approvals whose preAuthPeriod contains the supplied date, i.e. preAuthPeriod.start &lt;= date &lt;= preAuthPeriod.end. This is containment of a single date, which differs from standard FHIR date search semantics on a Period, hence a custom parameter. Only the eq comparator is supported. Mutually exclusive with approval-expiring.</p>\n</div><table class=\"grid\"><tr><td>Resource</td><td><a href=\"http://hl7.org/fhir/R4/claimresponse.html\">ClaimResponse</a></td></tr><tr><td>Expression</td><td><code>ClaimResponse.preAuthPeriod</code></td></tr><tr><td>Processing Mode</td><td>Normal</td></tr><tr><td>Multiples</td><td><ul><li>multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true</li><li>multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true</li></ul></td></tr><tr><td>Comparators</td><td>Allowed: eq</td></tr></table></div>"
  },
  "url" : "https://fhir-ig.digital.health.nz/special-authority/SearchParameter/approval-valid-on",
  "version" : "0.1.1",
  "name" : "ApprovalValidOn",
  "status" : "draft",
  "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" : "Matches Approvals whose preAuthPeriod contains the supplied date, i.e. preAuthPeriod.start <= date <= preAuthPeriod.end. This is containment of a single date, which differs from standard FHIR date search semantics on a Period, hence a custom parameter. Only the eq comparator is supported. Mutually exclusive with approval-expiring.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "NZ",
          "display" : "New Zealand"
        }
      ]
    }
  ],
  "code" : "approval-valid-on",
  "base" : [
    "ClaimResponse"
  ],
  "type" : "date",
  "expression" : "ClaimResponse.preAuthPeriod",
  "xpathUsage" : "normal",
  "comparator" : [
    "eq"
  ]
}