Breast Screening NZ FHIR Implementation Guide
1.1.0 - Release
Breast Screening NZ FHIR Implementation Guide
1.1.0 - Release
Breast Screening NZ FHIR Implementation Guide - Local Development build (v1.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Te Puna is the core technology platform that supports the delivery and operation of the BreastScreen Aotearoa (BSA) national breast screening programme. Its purpose is to provide a single, integrated source of information for managing participants, screening activities, clinical workflows, imaging, assessments, reporting, and programme administration.
Te Puna enables BreastScreen Aotearoa to:
Manage participant enrolment and eligibility.
Maintain participant demographic and screening history information.
Support the end-to-end screening pathway, from invitation through to screening, assessment, and outcome management.
Coordinate activities between screening providers, assessment services, radiology providers, and programme administrators.
Record and manage screening episodes and associated clinical information.
Store and provide access to screening results, reports, and related diagnostic information.
Support programme monitoring, reporting, quality assurance, and population health activities.
Enable information sharing with authorised internal and external systems
At a high level, Te Puna acts as the system of record for key BreastScreen Aotearoa information, supporting the participant journey:
Te Puna maintains information associated with each stage of this journey and makes relevant information available to authorised users and systems.
The Te Puna FHIR API exposes selected information held within Te Puna enabling authorised consumers to retrieve information such as:
Screening CarePlan
Diagnostic findings and reports (DiagnosticReport)
The participants NHI is usually used to get their Care Plan details, although there are options to include a status parameter to narrow down the results, e.g. draft, active, ended
There is an option to return all plans between a date range or by status. Where a status is used then multiple different status can be entered but must be comma separated. These types of calls will return a large result set.
Diagnostic reports are usually searched by the NHI. Only one NHI is allowed per search. Searches by NHI and Status and by Date Range are allowed.
Searching on just the Status is allowed, with options to search by Final, or Preliminary being supported. This is likely to return a large number of reports.
Screening Use Case Summary
Care Plan - the participants overall participation in the BreastScreen Aotearoa programme.
Dagnostic Report - a participants Radiologist report
A Care Plan represents a participant's enrolment and current status in the BreastScreen Aotearoa programme, including their pathway and lead provider information. It is the longitudinal record of programme participation, while Episodes of Care represent individual screening journeys.
The Care Plan remains active while the participant stays in the programme, whereas each Episode of Care starts and finishes for a particular screening event
The Care Plan resource:
Care Plan Status Mapping
| Te Puna Care Plan Status | FHIR Status | Description |
|---|---|---|
| PRE_ENROLLED | DRAFT | Participant has not yet fully enrolled in BSA. |
| ENROLLED | ACTIVE | Participant is actively enrolled in the programme. |
| NOT_ENROLLED | ENDED | Participant is no longer enrolled in BSA. |
Use Cases
Search screening Care Plans by NHI
Search screening Care Plans by NHI and Status
Search screening Care Plans by Date Range
Search screening Care Plans by Status
The Diagnostic Report resource provides the clinical findings and outcomes generated during the BreastScreen Aotearoa screening pathway. It represents radiologist reports and related diagnostic information produced from screening and assessment activities.
The report forms part of the participant's screening record and supports the communication of screening outcomes, clinical conclusions, and associated reporting information to internal and external clinical systems.
Diagnostic report attributes include:
Diagnostic Report Status Mapping
| Te Puna Status | FHIR Status | Description |
|---|---|---|
| DRAFT_NOT_STARTED | registered | Report created but not yet started |
| DRAFT_IN_PROGRESS | partial | Report is being drafted |
| DOUBLE_READ_IN_PROGRESS | preliminary | Under double-read review |
| PENDING_DOUBLE_READ | preliminary | Awaiting double-read |
| COMPLETED | final | Report finalised |
| COMPLETED_REPORT_SENT | final | Report finalised and sent |
| ADDENDUM_IN_PROGRESS | amended | Report is being amended after finalisation |
Use Cases
Search Radiologist report by NHI
Search Radiologist report by NHI and Date Range
Search Radiologist report by NHI and Status