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

## API

###

BSA FHIR Capabilities

### REST APIs

#### Resource Level Interactions

##### DiagnosticReport

Describes a participant's BSA screening enrolment and pathway status

Interactions

Name | Verb | URL | Documentation | Scope
--- | --- | --- | --- | ---
read | GET | [base]/DiagnosticReport/[id] | Used to retrieve a participant's BSA screening outcomes and radiologist assessment reports | system/DiagnosticReport.r
search-type | GET | [base]/Coverage | Search for a patient's participant's BSA screening outcomes and radiologist assessment reports | system/DiagnosticReport.s

Search Parameters

Name | Type | Documentation
--- | --- | ---
patient | reference | NHI id of patient who is the subject of the report
status | token | report status
date | token | The clinically relevant time of the report
category | token | Which diagnostic discipline/department created the report

##### CarePlan

Interactions

Name | Verb | URL | Documentation | Scope
--- | --- | --- | --- | ---
read | GET | [base]/DiagnosticReport/[id] | Used to retrieve a participant's BSA screening enrolment and pathway status | system/CarePlan.r
search-type | GET | [base]/Coverage | Search for a participant's BSA screening enrolment and pathway status | system/CarePlan.s

Search Parameters

Name | Type | Documentation
--- | --- | ---
patient | reference | NHI id of patient who is the subject of the CarePlan
_lastUpdated | token | The date the care plan was last updated