Screening Summary History API

This service allows Registered Health Care Professionals access to National Cervical Screening Summaries within their clinical systems e.g. Practice Management Systems, EMRs or Clinical Portals.

A Screening Summary combines participation data from the national register (screening programme enrolment status and next action, etc.) and screening history such as cytology test results and other relevant lab test records.

As a FHIR API, screening summaries are returned as PDF/HTML documents attached to FHIR R4B DocumentReference resource instances.

Consumers of this API can search for screening summary by doing a FHIR search operation on the FHIR DocumentReference resource, which the API responds with a searchset Bundle. API consumers must parse the searchset Bundle for any special outcome messages about potential matches, in addition to the DocumentReference and included Patient instances for the matching screening summary.

Refer to the FHIR implementation guide (external link) for full details of the service.

The cervical screening history document (PDF/HTML) provides the following information:

Participant Details:

• Full Name
• Date of Birth
• Gender
• Sex assigned at Birth
• Ethnicity
• NHI Number
• Address

Participant Summary (clinical summary for cervical screening):

• Pathway status
• Next Expected Event
• Next Event due Date
• Unenrolled Reason
• Send Programme Correspondence
• Immune Deficient
• Total Hysterectomy
• Cervical / Vaginal Cancer

Screening History:

Individual medical history of all recorded diagnostic results and events related to cervical screening for the participant in reverse chronological order.

The individual medical history may contain any of the following:

• Test results - Cytology, Histology, HPV
• Events - Referral, Colposcopy Visit, Did Not Attend Visit
• Medical Condition, Medical Procedure
• Synopsis Test Result - Cytology, Histology, HPV

An explanatory reason if no screening history exists.

Registered Health Care Providers (with an HPI CPN) for the purpose of cervical screening, screening follow up, cervical cancer treatment and outreach services.

Access to the information is governed by the Health Information Privacy Code (HIPC) and Health (National Cervical Screening Programme) Amendment Act 2021 (Section 112J of Health Act 1956) for Cervical Screening information.

Each organisation and end user that has access to this API will need to accept Terms of Use agreements that outline their obligations under the Health Act 1956 (including specific restrictions of section 112J for cervical screening register access), the Privacy Act 1993 and the Health Information Privacy Code 1994 to only access information about patients they are treating and are authorised to do so.

The Screening History will surface a participant's cervical screening history to Primary and Community screen-takers, colposcopy practitioners, health professionals involved with Cervical Cancer treatment and participants (health consumers).

We can enable Cervical Screen takers and other clinical staff to accurately assess the participant's cervical screening needs by providing appropriate, relevant and timely access to participant’s cervical screening history from their clinical application of choice.  

To begin the onboarding process for this API, please visit the Consumer onboarding page.

For more information on integrating, please review the FHIR implementation guide (external link).

FHIR API

All FHIR API endpoints adhere to Fast Healthcare Interoperable Resources (FHIR) interoperability standards and follow REST protocols.

• Target 98% service availability 24 hours a day, seven days a week.
• Support available during New Zealand Business Hours only  

GEO Restriction

GEO Restriction rules prevent access from clients with IPs located in countries other than those listed below:

• New Zealand
• Australia