HSAAP Special Authority FHIR Implementation Guide
0.1.1 - draft
HSAAP Special Authority FHIR Implementation Guide
0.1.1 - draft
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
<Bundle xmlns="http://hl7.org/fhir">
<id value="sa-example-response-bundle-declined"/>
<meta>
<profile
value="https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/sa-response-bundle"/>
</meta>
<type value="collection"/>
<timestamp value="2026-10-14T10:35:07+13:00"/>
<entry>
<fullUrl
value="https://api.example.health.nz/fhir/ClaimResponse/sa-example-cr-declined"/>
<resource>
<ClaimResponse>
<id value="sa-example-cr-declined"/>
<meta>
<profile
value="https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/sa-application-claimresponse"/>
</meta>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><a name="ClaimResponse_sa-example-cr-declined"> </a><p class="res-header-id"><b>Generated Narrative: ClaimResponse sa-example-cr-declined</b></p><a name="sa-example-cr-declined"> </a><a name="hcsa-example-cr-declined"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-sa-application-claimresponse.html">SA Application ClaimResponse</a></p></div><blockquote><p><b>Application Status</b></p><ul><li>status: DONE</li><li>outcome: DECLINED</li><li>outcomeCode: <a href="CodeSystem-sa-outcome-code.html#sa-outcome-code-URNSA011">SA Outcome Code: URNSA011</a> (URNSA011)</li><li>outcomeReason: An approval already exists for this patient and form.</li></ul></blockquote><blockquote><p><b>Existing Approval</b></p><ul><li>approvalType: CHEM</li><li>approvalNumber: <a href="NamingSystem-sa-approval-number.html" title="Special Authority Approval Number. Carried on ClaimResponse.identifier and ClaimResponse.preAuthRef (D23).">SAApprovalNumber</a>/25SA0001234</li><li>effectiveDate: 2026-02-01</li><li>expiryDate: 2027-02-01</li></ul></blockquote><p><b>status</b>: Active</p><p><b>type</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/claim-type pharmacy}">Pharmacy</span></p><p><b>use</b>: Preauthorization</p><p><b>patient</b>: <a href="Patient-sa-example-patient.html">Aroha Parata (official) (no stated gender), DoB: 1968-03-14 ( https://standards.digital.health.nz/ns/nhi-id#NHI#ZZZ0016 (use: official))</a></p><p><b>created</b>: 2026-10-14 10:35:07+1300</p><p><b>insurer</b>: Health New Zealand | Te Whatu Ora</p><p><b>requestor</b>: <a href="Practitioner-sa-example-applicant.html">Jane Smith (official) (https://standards.digital.health.nz/ns/hpi-person-id#HPIProvider#99ZZZZ (use: official))</a></p><p><b>request</b>: Identifier: <a href="NamingSystem-sa-application-number.html" title="Special Authority Application Number allocated by the special-authority-application-service. The only identifier carried on Claim.identifier (D23).">SAApplicationNumber</a>/000123457</p><p><b>outcome</b>: Processing Complete</p><p><b>disposition</b>: An approval already exists for this patient and form.</p><h3>Errors</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Code</b></td></tr><tr><td style="display: none">*</td><td><span title="Codes:{https://fhir-ig.digital.health.nz/special-authority/CodeSystem/sa-outcome-code URNSA011}">URNSA011</span></td></tr></table></div>
</text>
<extension
url="https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/application-status">
<extension url="status">
<valueCode value="DONE"/>
</extension>
<extension url="outcome">
<valueCode value="DECLINED"/>
</extension>
<extension url="outcomeCode">
<valueCoding>
<system
value="https://fhir-ig.digital.health.nz/special-authority/CodeSystem/sa-outcome-code"/>
<code value="URNSA011"/>
</valueCoding>
</extension>
<extension url="outcomeReason">
<valueString
value="An approval already exists for this patient and form."/>
</extension>
</extension>
<extension
url="https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/existing-approval">
<extension url="approvalType">
<valueCode value="CHEM"/>
</extension>
<extension url="approvalNumber">
<valueIdentifier>
<system
value="https://fhir-ig.digital.health.nz/special-authority/ns/approval-number"/>
<value value="25SA0001234"/>
</valueIdentifier>
</extension>
<extension url="effectiveDate">
<valueDate value="2026-02-01"/>
</extension>
<extension url="expiryDate">
<valueDate value="2027-02-01"/>
</extension>
</extension>
<status value="active"/>
<type>
<coding>
<system value="http://terminology.hl7.org/CodeSystem/claim-type"/>
<code value="pharmacy"/>
</coding>
</type>
<use value="preauthorization"/>
<patient>🔗
<reference value="Patient/sa-example-patient"/>
</patient>
<created value="2026-10-14T10:35:07+13:00"/>
<insurer>
<display value="Health New Zealand | Te Whatu Ora"/>
</insurer>
<requestor>🔗
<reference value="Practitioner/sa-example-applicant"/>
</requestor>
<request>
<identifier>
<system
value="https://fhir-ig.digital.health.nz/special-authority/ns/application-number"/>
<value value="000123457"/>
</identifier>
</request>
<outcome value="complete"/>
<disposition
value="An approval already exists for this patient and form."/>
<error>
<code>
<coding>
<system
value="https://fhir-ig.digital.health.nz/special-authority/CodeSystem/sa-outcome-code"/>
<code value="URNSA011"/>
</coding>
</code>
</error>
</ClaimResponse>
</resource>
</entry>
<entry>
<fullUrl value="urn:uuid:7d9c6b1e-3c55-4a7a-9f4e-2b8d3a1c9e01"/>
<resource>
<OperationOutcome>
<id value="sa-example-outcome-declined"/>
<meta>
<profile
value="https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/sa-outcome-operationoutcome"/>
</meta>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><a name="OperationOutcome_sa-example-outcome-declined"> </a><p class="res-header-id"><b>Generated Narrative: OperationOutcome sa-example-outcome-declined</b></p><a name="sa-example-outcome-declined"> </a><a name="hcsa-example-outcome-declined"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-sa-outcome-operationoutcome.html">SA Outcome OperationOutcome</a></p></div><h3>Issues</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Severity</b></td><td><b>Code</b></td><td><b>Details</b></td><td><b>Diagnostics</b></td></tr><tr><td style="display: none">*</td><td>Error</td><td>Business Rule Violation</td><td><span title="Codes:{https://fhir-ig.digital.health.nz/special-authority/CodeSystem/sa-outcome-code URNSA011}">URNSA011</span></td><td>An approval already exists for this patient and form.</td></tr></table></div>
</text>
<issue>
<severity value="error"/>
<code value="business-rule"/>
<details>
<coding>
<system
value="https://fhir-ig.digital.health.nz/special-authority/CodeSystem/sa-outcome-code"/>
<code value="URNSA011"/>
</coding>
</details>
<diagnostics
value="An approval already exists for this patient and form."/>
</issue>
</OperationOutcome>
</resource>
</entry>
<entry>
<fullUrl
value="https://api.example.health.nz/fhir/Patient/sa-example-patient"/>
<resource>
<Patient>
<id value="sa-example-patient"/>
<meta>
<profile
value="https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/sa-patient"/>
</meta>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><a name="Patient_sa-example-patient"> </a><p class="res-header-id"><b>Generated Narrative: Patient sa-example-patient</b></p><a name="sa-example-patient"> </a><a name="hcsa-example-patient"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-sa-patient.html">SA Patient</a></p></div><p style="border: 1px #661aff solid; background-color: #e6e6ff; padding: 10px;">Aroha Parata (official) (no stated gender), DoB: 1968-03-14 ( https://standards.digital.health.nz/ns/nhi-id#NHI#ZZZ0016 (use: official))</p><hr/><table class="grid"><tr><td style="background-color: #f3f5da" title="Ways to contact the Patient">Contact Detail</td><td colspan="3">12 Kowhai Street Waikanae 5036 NZ (home) (NZ Suburb: Waikanae Beach)</td></tr></table></div>
</text>
<identifier>
<use value="official"/>
<system value="https://standards.digital.health.nz/ns/nhi-id"/>
<value value="ZZZ0016"/>
</identifier>
<name>
<use value="official"/>
<family value="Parata"/>
<given value="Aroha"/>
<prefix value="Ms"/>
</name>
<birthDate value="1968-03-14"/>
<address>
<extension url="http://hl7.org.nz/fhir/StructureDefinition/suburb">
<valueString value="Waikanae Beach"/>
</extension>
<use value="home"/>
<line value="12 Kowhai Street"/>
<city value="Waikanae"/>
<postalCode value="5036"/>
<country value="NZ"/>
</address>
</Patient>
</resource>
</entry>
<entry>
<fullUrl
value="https://api.example.health.nz/fhir/Practitioner/sa-example-applicant"/>
<resource>
<Practitioner>
<id value="sa-example-applicant"/>
<meta>
<profile
value="https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/sa-practitioner"/>
</meta>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><a name="Practitioner_sa-example-applicant"> </a><p class="res-header-id"><b>Generated Narrative: Practitioner sa-example-applicant</b></p><a name="sa-example-applicant"> </a><a name="hcsa-example-applicant"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-sa-practitioner.html">SA Practitioner</a></p></div><p style="border: 1px #661aff solid; background-color: #e6e6ff; padding: 10px;">Jane Smith (official) (https://standards.digital.health.nz/ns/hpi-person-id#HPIProvider#99ZZZZ (use: official))</p><hr/><table class="grid"><tr><td style="background-color: #f3f5da" title="Other Id (see the one above)">Other Id:</td><td colspan="3"><a href="http://fhir.org.nz/ig/base/3.1.0/NamingSystem-medical-council-id.html" title="Medical Council of New Zealand Register Number">NZMC</a>/12345 (use: secondary)</td></tr><tr><td style="background-color: #f3f5da" title="Ways to contact the Practitioner">Contact Detail</td><td colspan="3">1 Main Highway Otaki 5512 NZ (work)</td></tr></table></div>
</text>
<identifier>
<use value="official"/>
<system
value="https://standards.digital.health.nz/ns/hpi-person-id"/>
<value value="99ZZZZ"/>
</identifier>
<identifier>
<use value="secondary"/>
<system
value="https://standards.digital.health.nz/ns/medical-council-id"/>
<value value="12345"/>
</identifier>
<name>
<use value="official"/>
<family value="Smith"/>
<given value="Jane"/>
<prefix value="Dr"/>
</name>
<address>
<use value="work"/>
<line value="1 Main Highway"/>
<city value="Otaki"/>
<postalCode value="5512"/>
<country value="NZ"/>
</address>
</Practitioner>
</resource>
</entry>
</Bundle>