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

## Extension: Pathway Substate Extension

Official URL: https://breastscreening.health.nz/ig/StructureDefinition/pathway-substate | Version: 1.1.0
Draft as of 2026-07-09 | Computable Name: PathwaySubstateExtension

The current substate of the participant within the screening pathway.

Context of Use

This extension may be used on the following element(s)

- Element ID: `CarePlan`

Usage info

Usages:

- Use this Extension: BSA Care Plan
- Examples for this Extension: Bundle/CPB1 and CarePlan/CP1

You can also check for usages in the FHIR IG Statistics

### Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

- Differential Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from Extension

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..1 | Extension | Pathway substate
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "https://breastscreening.health.nz/ig/StructureDefinition/pathway-substate"
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: Pathway Sub-State Value Set (required)
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..1 | Extension | Pathway substate
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "https://breastscreening.health.nz/ig/StructureDefinition/pathway-substate"
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: Pathway Sub-State Value Set (required)
Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type CodeableConcept: The current substate of the participant within the screening pathway.

Differential View

This structure is derived from Extension

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..1 | Extension | Pathway substate
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "https://breastscreening.health.nz/ig/StructureDefinition/pathway-substate"
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: Pathway Sub-State Value Set (required)
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..1 | Extension | Pathway substate
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "https://breastscreening.health.nz/ig/StructureDefinition/pathway-substate"
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: Pathway Sub-State Value Set (required)
Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type CodeableConcept: The current substate of the participant within the screening pathway.

Other representations of profile: CSV, Excel, Schematron

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Extension.value[x] | Base | required | Pathway Sub-State Value Set | 📦1.1.0 | This IG

#### Constraints

Id | Grade | Path(s) | Description | Expression
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`