Health NZ | Te Whatu Ora FHIR Screening Implementation Guide
1.0.1 - normative+trial-use
Health NZ | Te Whatu Ora FHIR Screening Implementation Guide
1.0.1 - normative+trial-use
Health NZ | Te Whatu Ora FHIR Screening Implementation Guide - Local Development build (v1.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
This page documents the various screening summary request scenarios and the expected FHIR API response for each scenario.
| Id | Scenario | Participant Information returned in screening summary? | Screening History returned in screening summary? | Additional search outcome message(s) returned by DocumentReference.Search |
|---|---|---|---|---|
| H1 | A participant is Sex Assigned at Birth female on the programme with Screening History. | Yes | Yes | - |
| H2 | Deceased participant with screening history | Yes | Yes | - |
| H3 | A participant is Sex Assigned at Birth Female below Eligibility age with screening history | Yes | Yes | - |
| H4 | A participant is Sex Assigned at Birth Female above Eligibility age with screening history | Yes | Yes | - |
| H5 | A Participant has cervical cancer and doesn't require ongoing screening. | Yes | Yes | - |
| H6 | A participant with cancer has specifically been identified as requiring future screening | Yes | Yes | - |
| H7 | A participant has had Total hysterectomy | Yes | Yes | - |
| H8 | A participant has had sub-total hysterectomy | Yes | Yes | - |
| H9 | A participant is male/non-binary on the programme, and has Screening History. | Yes | Yes | - |
| Id | Scenario | Participant Information returned in screening summary? | Screening History returned in screening summary? | Additional search outcome message(s) returned by DocumentReference.Search |
|---|---|---|---|---|
| N1 | A person is sex-assigned-at-birth female, participating in the programme but with no Screening History. | Yes | No | This NHI has no screening history to display. |
| N2 | Deceased person with No screening history | Yes | No | This NHI has no screening history to display. They are deceased. |
| N3 | Sex-assigned-at-birth female below eligibility age without screening history | Yes | No | This NHI has no screening history to display. They are below the cervical screening eligibility age. |
| N4 | Sex-assigned-at-birth female aged 70-74 without screening history | Yes | No | This NHI has no screening history to display. They are unscreened. |
| N5 | Sex-assigned-at-birth female above eligibility age without screening history | Yes | No | This NHI has no screening history to display. They are above the cervical screening eligibility age. |
| N6 | Person is cis gendered male | Yes | No | This NHI has no screening history to display. This NHI is identified as MALE in the Cervical Screening Register. |
| Id | Scenario | Participant Information returned in screening summary? | Screening History returned in screening summary? | Additional search outcome message(s) returned by DocumentReference.Search |
|---|---|---|---|---|
| X1 | Participant has multiple NHI and a dormant NHI is searched for. | Yes | Yes (if available) | The requested NHI is dormant and linked to a live identifier, so the live NHI has been returned. |
| X2 | Participant has multiple NHIs and NHI searched for is dormant. | Yes | No | 1. The requested NHI is dormant and linked to a live identifier, so the live NHI has been returned. 2. This NHI has no screening history to display. |
| X3 | No screening information available for the specified NHI | No | No | This NHI has no screening information to display. |
| X4 | Person has withdrawn from screening programme | No | No | This NHI has no screening information to display. The participant has withdrawn from the National Cervical Screening Programme. |