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

CapabilityStatement: BSACapabilityStatement

Official URL: http://hl7.org.nz/fhir/ig/bsa/CapabilityStatement/BSACapabilityStatement Version: 1.1.0
Draft as of 2023-05-24 Computable Name:

BSA FHIR Capabilities

Raw OpenAPI-Swagger Definition file | Download

  • Implementation Guide Version: 1.1.0
  • FHIR Version: 4.0.1
  • Supported Formats: json
  • Supported Patch Formats: json
  • Published on: 2023-05-24
  • Published by: Te Whatu Ora

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: server

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
DiagnosticReporthttp://hl7.org.nz/fhir/StructureDefinition/BsaDiagnosticReportyypatient, status, date, category
CarePlanhttp://hl7.org.nz/fhir/StructureDefinition/BsaCarePlanyypatient, _lastUpdated
Base System Profile
http://hl7.org.nz/fhir/StructureDefinition/BsaDiagnosticReport
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports
    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

Documentation

Describes a participant's BSA screening enrolment and pathway status

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

NHI id of patient who is the subject of the report

SHALLstatustoken

report status

SHALLdatetoken

The clinically relevant time of the report

SHALLcategorytoken

Which diagnostic discipline/department created the report

 
Base System Profile
http://hl7.org.nz/fhir/StructureDefinition/BsaCarePlan
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports
    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
ConformanceParameterTypeDocumentation
SHALLpatientreference

NHI id of patient who is the subject of the CarePlan

SHALL_lastUpdatedtoken

The date the care plan was last updated