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-approval-search-all-versions"/>
<type value="searchset"/>
<total value="2"/>
<link>
<relation value="self"/>
<url
value="https://api.example.health.nz/fhir/ClaimResponse?patient.identifier=https://standards.digital.health.nz/ns/nhi-id|ZZZ0016&approval-version-state=ALL"/>
</link>
<entry>
<fullUrl
value="https://api.example.health.nz/fhir/ClaimResponse/sa-example-approval-chem-v2"/>
<resource>
<ClaimResponse>
<id value="sa-example-approval-chem-v2"/>
<meta>
<lastUpdated value="2025-08-20T14:40:00+12:00"/>
<profile
value="https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/sa-approval-claimresponse"/>
</meta>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><a name="ClaimResponse_sa-example-approval-chem-v2"> </a><p class="res-header-id"><b>Generated Narrative: ClaimResponse sa-example-approval-chem-v2</b></p><a name="sa-example-approval-chem-v2"> </a><a name="hcsa-example-approval-chem-v2"> </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">Last updated: 2025-08-20 14:40:00+1200</p><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-sa-approval-claimresponse.html">SA Approval ClaimResponse</a></p></div><blockquote><p><b>Approval Detail</b></p><ul><li>approvalType: CHEM</li><li>status: REVOKED</li><li>formNumber: SA9999</li></ul></blockquote><p><b>identifier</b>: <a href="NamingSystem-sa-approval-number.html" title="Special Authority Approval Number. Carried on ClaimResponse.identifier and ClaimResponse.preAuthRef (D23).">SAApprovalNumber</a>/25SA0001234</p><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>: 2025-08-20 14:40:00+1200</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>outcome</b>: Processing Complete</p><p><b>preAuthRef</b>: 25SA0001234</p><p><b>preAuthPeriod</b>: 2025-02-01 --> 2026-02-01</p></div>
</text>
<extension
url="https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/approval-detail">
<extension url="approvalType">
<valueCode value="CHEM"/>
</extension>
<extension url="status">
<valueCode value="REVOKED"/>
</extension>
<extension url="formNumber">
<valueString value="SA9999"/>
</extension>
</extension>
<identifier>
<system
value="https://fhir-ig.digital.health.nz/special-authority/ns/approval-number"/>
<value value="25SA0001234"/>
</identifier>
<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="2025-08-20T14:40:00+12:00"/>
<insurer>
<display value="Health New Zealand | Te Whatu Ora"/>
</insurer>
<requestor>🔗
<reference value="Practitioner/sa-example-applicant"/>
</requestor>
<outcome value="complete"/>
<preAuthRef value="25SA0001234"/>
<preAuthPeriod>
<start value="2025-02-01"/>
<end value="2026-02-01"/>
</preAuthPeriod>
</ClaimResponse>
</resource>
<search>
<mode value="match"/>
</search>
</entry>
<entry>
<fullUrl
value="https://api.example.health.nz/fhir/ClaimResponse/sa-example-approval-chem-v1"/>
<resource>
<ClaimResponse>
<id value="sa-example-approval-chem-v1"/>
<meta>
<lastUpdated value="2025-02-01T08:15:00+13:00"/>
<profile
value="https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/sa-approval-claimresponse"/>
</meta>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><a name="ClaimResponse_sa-example-approval-chem-v1"> </a><p class="res-header-id"><b>Generated Narrative: ClaimResponse sa-example-approval-chem-v1</b></p><a name="sa-example-approval-chem-v1"> </a><a name="hcsa-example-approval-chem-v1"> </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">Last updated: 2025-02-01 08:15:00+1300</p><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-sa-approval-claimresponse.html">SA Approval ClaimResponse</a></p></div><blockquote><p><b>Approval Detail</b></p><ul><li>approvalType: CHEM</li><li>status: ACTIVE</li><li>formNumber: SA9999</li></ul></blockquote><p><b>identifier</b>: <a href="NamingSystem-sa-approval-number.html" title="Special Authority Approval Number. Carried on ClaimResponse.identifier and ClaimResponse.preAuthRef (D23).">SAApprovalNumber</a>/25SA0001234</p><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>: 2025-02-01 08:15:00+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>outcome</b>: Processing Complete</p><p><b>preAuthRef</b>: 25SA0001234</p><p><b>preAuthPeriod</b>: 2025-02-01 --> 2026-02-01</p></div>
</text>
<extension
url="https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/approval-detail">
<extension url="approvalType">
<valueCode value="CHEM"/>
</extension>
<extension url="status">
<valueCode value="ACTIVE"/>
</extension>
<extension url="formNumber">
<valueString value="SA9999"/>
</extension>
</extension>
<identifier>
<system
value="https://fhir-ig.digital.health.nz/special-authority/ns/approval-number"/>
<value value="25SA0001234"/>
</identifier>
<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="2025-02-01T08:15:00+13:00"/>
<insurer>
<display value="Health New Zealand | Te Whatu Ora"/>
</insurer>
<requestor>🔗
<reference value="Practitioner/sa-example-applicant"/>
</requestor>
<outcome value="complete"/>
<preAuthRef value="25SA0001234"/>
<preAuthPeriod>
<start value="2025-02-01"/>
<end value="2026-02-01"/>
</preAuthPeriod>
</ClaimResponse>
</resource>
<search>
<mode value="match"/>
</search>
</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>
<search>
<mode value="include"/>
</search>
</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>
<search>
<mode value="include"/>
</search>
</entry>
</Bundle>