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

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

BSACapabilityStatement

BSA FHIR Capabilities

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

BSA Care Plan

Describes a participant's BSA screening enrolment and pathway status

BSA Diagnostic Report

Describes a participant's BSA screening outcomes and radiologist assessment reports

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

Pathway State Date Last Modified Extension

The date when the pathway state was last modified.

Pathway State Extension
Pathway Substate Extension

The current substate of the participant within the screening pathway.

Programme Status Extension

The enrollment status of a participant in the breast screening programme.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

Pathway State Value Set

Valid codes representing the current state of a participant within the screening pathway.

Pathway Sub-State Value Set

Valid codes representing the current sub-state of a participant within the screening pathway.

Programme Status Value Set

Valid codes representing the current programme status of a participant within the screening pathway.

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

Pathway State Code System

Codes representing states in the screening pathway workflow.

Pathway Substate Code System

Codes for detailed substates within the screening pathway, providing additional granularity to pathway states.

Programme Status Code System

Codes representing a participant's enrollment status in the breast screening programme.

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

CAREPLAN-1

Example BSA Care Plan resource

CAREPLAN-BUNDLE-11

Example BSA Care Plan search result

DIAGNOSTICREPORT-1

Example BSA Diagnostic Report resource

DIAGNOSTICREPORT-BUNDLE-1

Example BSA Diagnostic Report search result

bsa-error-response-1

Example of an error response message