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 API HNZ digital services hub health practitioner (screening) health practitioner (screening) practitioner's APP/PMS practitioner's APP/PMS API authn. server API authn. server API gateway API gateway screening summary FHIR API screening summary FHIR API NHI FHIR API NHI FHIR API initialisation OAUTH2.0 Client Credentials Flow (client credentials and requested scope) OAUTH token scopes: system/DocumentReference.rs?category=http://snomed.info/sct|1230046007 system/Patient.r aud: https://api.{env}.nss.digital.health.nz operations enter patient name, NHI NHI search present NHI matches request screening summaries for selected NHI and programme type GET / DocumentReference ?<params> search request query parameters: ? subject:identifier = <NHI> & category = <screening service type SNOMED> & contenttype = application/pdf & _include = DocumentReference:subject validate OAUTH token (issuer,token,scopes,sig) GET /DocumentReference?.. alt [normal report generation] get data from backend APIs generate screening summary content as HTML and PDF include participant data as Patient instance 200 OK , FHIR searchset Bundle In normal search response is a FHIR searchset Bundle. Each Bundle entry comprises a DocumentReference (mode:#match) containing the formatted screening summary, AND a Patient (mode:#include) instance for the patient demographic detail [No screening summary is available] 200 OK , Bundle of mode: #outcome When no screening history is available for the specified subject for some reason, the Bundle contains one or more OperationOutcome(s) ( mode: #outcome ) describing the reason(s). [technical error] HTTP 4xx|5xx error code In technical error scenarios, the response is just a FHIR OperationOutcome process results and determine what to display for user present screening summary / search result
