# API - Breast Screening NZ FHIR Implementation Guide v1.1.0

* [**Table of Contents**](toc.md)
* **API**

## API

### BSA FHIR Capabilities 

### REST APIs

#### Resource Level Interactions

##### DiagnosticReport

Describes a participant's BSA screening enrolment and pathway status

**Interactions**

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

**Search Parameters**

* Name: patient
  * Type: [reference](http://hl7.org/fhir/search.html#reference)
  * Documentation: NHI id of patient who is the subject of the report
* Name: status
  * Type: [token](http://hl7.org/fhir/search.html#token)
  * Documentation: report status
* Name: date
  * Type: [token](http://hl7.org/fhir/search.html#token)
  * Documentation: The clinically relevant time of the report
* Name: category
  * Type: [token](http://hl7.org/fhir/search.html#token)
  * Documentation: Which diagnostic discipline/department created the report

##### CarePlan

**Interactions**

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

**Search Parameters**

* Name: patient
  * Type: [reference](http://hl7.org/fhir/search.html#reference)
  * Documentation: NHI id of patient who is the subject of the CarePlan
* Name: _lastUpdated
  * Type: [token](http://hl7.org/fhir/search.html#token)
  * Documentation: The date the care plan was last updated

