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

## Get Care Plan

### Get BSA CarePlan for Patient

This is typically used to get BSA screening enrolment and pathway status for a participant.

#### Get BSA CarePlan for Patient processing steps:

1. A FHIR Client sends a GET request to the BSA CarePlan endpoint with the 'patient' query parameter specifying the patient's NHI number
2. The request is validated - ALT: Validation failure. Operation Outcome resource returned
3. CarePlans for this NHI are retrieved from BSA
4. A bundle of CarePlan resources is returned to the client

#### Get BSA CarePlans Response Example

get-careplan-response-message-1

#### Get BSA CarePlans Error Example

get-careplan-error-message-1

### Search BSA CarePlan

This is used to find all CarePlans filtered by status, category, date or a combination.

#### Get BSA CarePlan for Patient processing steps:

1. A FHIR Client sends a GET request to the BSA CarePlan endpoint with some combination of the 'status' 'category' and 'date' parameters
2. The request is validated - ALT: Validation failure. Operation Outcome resource returned
3. CarePlans for this NHI are retrieved from BSA
4. A bundle of CarePlan resources is returned to the client

### Get and Search CarePlan for Patient - Business Rules and Errors

Business Rule | HTTP error | Error code | diagnostic
--- | --- | --- | ---
Must be a valid search parameter | 400 Bad request | processing | HAPI-0524: Unknown search parameter <x> for resource type \"DiagnosticReport\". Valid search parameters for this search are: ....
Must be a valid search parameter value | 400 Bad request | not-supported | Invalid request: The FHIR endpoint on this server does not know how to handle GET operation[DiagnosticReport/DiagnosticReport] with parameters <x>