HSAAP Special Authority FHIR Implementation Guide
0.1.1 - draft New Zealand flag

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

: Example Approval - NPPA with explicit coverage and provider - TTL Representation

Raw ttl | Download


@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

# - resource -------------------------------------------------------------------

<http://hl7.org/fhir/ClaimResponse/sa-example-approval-nppa> a fhir:ClaimResponse ;
  fhir:nodeRole fhir:treeRoot ;
  fhir:Resource.id [ fhir:value "sa-example-approval-nppa"] ;
  fhir:Resource.meta [
     fhir:Meta.lastUpdated [ fhir:value "2026-09-01T09:00:00+12:00"^^xsd:dateTime ] ;
     fhir:Meta.profile [
       fhir:value "https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/sa-approval-claimresponse" ;
       fhir:index 0 ;
       fhir:link <https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/sa-approval-claimresponse>
     ]
  ] ;
  fhir:DomainResource.text [
     fhir:Narrative.status [ fhir:value "extensions" ] ;
     fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: ClaimResponse sa-example-approval-nppa</b></p><a name=\"sa-example-approval-nppa\"> </a><a name=\"hcsa-example-approval-nppa\"> </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: 2026-09-01 09:00: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: EXCP</li><li>status: ACTIVE</li><li>providerIdType: CLAIMANT_NUMBER</li><li>providerId: <a href=\"NamingSystem-sa-pharmacy-claimant-number.html\" title=\"Pharmacy claimant number. Identifies the provider (pharmacy) on an Approval and is the system used by the approval-provider-id search parameter.\">SAPharmacyClaimantNumber</a>/1234</li></ul></blockquote><blockquote><p><b>Approval Coverage</b></p><blockquote><p><b>url</b></p>type</blockquote><p><b>value</b>: EXPLICIT_PHARMACEUTICALS</p><p><b>ctppId</b>: 10000000000000</p><p><b>pharmacode</b>: 2000001</p><p><b>description</b>: Example medicine 10 mg tablet, 30</p><blockquote><p><b>url</b></p>pharmaceutical</blockquote></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>/26NP0000088</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>: 2026-09-01 09:00: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>: 26NP0000088</p><p><b>preAuthPeriod</b>: 2026-09-01 --&gt; 2027-03-01</p></div>"
  ] ;
  fhir:DomainResource.extension [
     fhir:index 0 ;
     fhir:Element.extension [
       fhir:index 0 ;
       fhir:Extension.url [ fhir:value "approvalType" ] ;
       fhir:Extension.valueCode [ fhir:value "EXCP" ]
     ], [
       fhir:index 1 ;
       fhir:Extension.url [ fhir:value "status" ] ;
       fhir:Extension.valueCode [ fhir:value "ACTIVE" ]
     ], [
       fhir:index 2 ;
       fhir:Extension.url [ fhir:value "providerIdType" ] ;
       fhir:Extension.valueCode [ fhir:value "CLAIMANT_NUMBER" ]
     ], [
       fhir:index 3 ;
       fhir:Extension.url [ fhir:value "providerId" ] ;
       fhir:Extension.valueIdentifier [
         fhir:Identifier.system [ fhir:value "https://fhir-ig.digital.health.nz/special-authority/ns/pharmacy-claimant-number" ] ;
         fhir:Identifier.value [ fhir:value "1234" ]
       ]
     ] ;
     fhir:Extension.url [ fhir:value "https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/approval-detail" ]
  ], [
     fhir:index 1 ;
     fhir:Element.extension [
       fhir:index 0 ;
       fhir:Extension.url [ fhir:value "type" ] ;
       fhir:Extension.valueCode [ fhir:value "EXPLICIT_PHARMACEUTICALS" ]
     ], [
       fhir:index 1 ;
       fhir:Element.extension [
         fhir:index 0 ;
         fhir:Extension.url [ fhir:value "ctppId" ] ;
         fhir:Extension.valueString [ fhir:value "10000000000000" ]
       ], [
         fhir:index 1 ;
         fhir:Extension.url [ fhir:value "pharmacode" ] ;
         fhir:Extension.valueString [ fhir:value "2000001" ]
       ], [
         fhir:index 2 ;
         fhir:Extension.url [ fhir:value "description" ] ;
         fhir:Extension.valueString [ fhir:value "Example medicine 10 mg tablet, 30" ]
       ] ;
       fhir:Extension.url [ fhir:value "pharmaceutical" ]
     ] ;
     fhir:Extension.url [ fhir:value "https://fhir-ig.digital.health.nz/special-authority/StructureDefinition/approval-coverage" ]
  ] ;
  fhir:ClaimResponse.identifier [
     fhir:index 0 ;
     fhir:Identifier.system [ fhir:value "https://fhir-ig.digital.health.nz/special-authority/ns/approval-number" ] ;
     fhir:Identifier.value [ fhir:value "26NP0000088" ]
  ] ;
  fhir:ClaimResponse.status [ fhir:value "active"] ;
  fhir:ClaimResponse.type [
     fhir:CodeableConcept.coding [
       fhir:index 0 ;
       fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/claim-type" ] ;
       fhir:Coding.code [ fhir:value "pharmacy" ]
     ]
  ] ;
  fhir:ClaimResponse.use [ fhir:value "preauthorization"] ;
  fhir:ClaimResponse.patient [
     fhir:link <http://hl7.org/fhir/Patient/sa-example-patient> ;
     fhir:Reference.reference [ fhir:value "Patient/sa-example-patient" ]
  ] ;
  fhir:ClaimResponse.created [ fhir:value "2026-09-01T09:00:00+12:00"^^xsd:dateTime] ;
  fhir:ClaimResponse.insurer [
     fhir:Reference.display [ fhir:value "Health New Zealand | Te Whatu Ora" ]
  ] ;
  fhir:ClaimResponse.requestor [
     fhir:link <http://hl7.org/fhir/Practitioner/sa-example-applicant> ;
     fhir:Reference.reference [ fhir:value "Practitioner/sa-example-applicant" ]
  ] ;
  fhir:ClaimResponse.outcome [ fhir:value "complete"] ;
  fhir:ClaimResponse.preAuthRef [ fhir:value "26NP0000088"] ;
  fhir:ClaimResponse.preAuthPeriod [
     fhir:Period.start [ fhir:value "2026-09-01"^^xsd:date ] ;
     fhir:Period.end [ fhir:value "2027-03-01"^^xsd:date ]
  ] .

<http://hl7.org/fhir/Patient/sa-example-patient> a fhir:Patient .

<http://hl7.org/fhir/Practitioner/sa-example-applicant> a fhir:Practitioner .

# - ontology header ------------------------------------------------------------

<http://hl7.org/fhir/ClaimResponse/sa-example-approval-nppa.ttl> a owl:Ontology ;
  owl:imports fhir:fhir.ttl ;
  owl:versionIRI <http://build.fhir.org/ClaimResponse/sa-example-approval-nppa.ttl> .