Health NZ | Te Whatu Ora FHIR Screening Implementation Guide
0.9.3 - draft New Zealand flag

Health NZ | Te Whatu Ora FHIR Screening Implementation Guide - Local Development build (v0.9.3) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

API consumption sequence diagrams

PMS search for screening summary(s) using FHIR screening APIHNZ digital services hubhealth practitioner (screening)health practitioner (screening)practitioner's APP/PMSpractitioner's APP/PMSAPI authn. serverAPI authn. serverAPI gatewayAPI gatewayscreening summary FHIR APIscreening summary FHIR APINHI FHIR APINHI FHIR APIinitialisationOAUTH2.0 Client Credentials Flow(client credentials and requested scope)OAUTH tokenscopes:   system/DocumentReference.rs?category=http://snomed.info/sct|1230046007  system/Patient.raud: https://api.{env}.nss.digital.health.nzoperationsenter patient name, NHINHI searchpresent NHI matchesrequest screening summaries for selected NHI and programme typeGET /DocumentReference?<params>search request query parameters:? subject:identifier= <NHI>& category= <screening service type SNOMED>& contenttype=application/pdf& _include=DocumentReference:subjectvalidate OAUTH token(issuer,token,scopes,sig)GET /DocumentReference?..alt[normal report generation]get data from backend APIsgenerate screening summary content as HTML and PDFinclude participant data as Patient instance200 OK, FHIR searchset BundleIn normal search response is a FHIR searchset Bundle. EachBundle entry comprises aDocumentReference (mode:#match)containingthe formatted screening summary, AND aPatient (mode:#include) instance for the patient demographic detail[No screening summary is available]200 OK, Bundle of mode: #outcomeWhen no screening history is available for the specifiedsubject for some reason, the Bundle contains one or moreOperationOutcome(s) (mode: #outcome) describing the reason(s).[technical error]HTTP 4xx|5xx error codeIn technical error scenarios, the responseis just a FHIROperationOutcomeprocess results and determine what to display for userpresent screening summary / search result