Breast Screening NZ FHIR Implementation Guide
1.1.5 - Release

Breast Screening NZ FHIR Implementation Guide - Local Development build (v1.1.5) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: BSA Care Plan

Official URL: https://fhir-ig.digital.health.nz/bsa/StructureDefinition/BsaCarePlan Version: 1.1.5
Active as of 2026-10-07 Computable Name: BSACarePlan

Describes a participant's BSA screening enrolment and pathway status

CarePlan Profile

CarePlan - Breast Screening

This profile defines constraints on the CarePlan resource for representing a participant's enrollment and progression through the breast screening programme. It tracks the participant's pathway state, programme status, and key dates throughout their screening journey.

Key Features:

  • Required subject (Patient reference)
  • Fixed intent of "plan"
  • Enrollment period tracking
  • Managing organization reference
  • Support for programme and pathway tracking extensions

Must Support Elements:

  • status - Current status of the care plan
  • intent - Always set to "plan"
  • subject - The patient enrolled in screening
  • period - Enrollment and exit dates
  • author - Managing organization

Care Plan Status Mapping

Te Puna Care Plan Status FHIR Status Description
PRE_ENROLLED draft Participant has not yet fully enrolled in BSA.
ENROLLED active Participant is actively enrolled in the programme.
NOT_ENROLLED completed Participant is no longer enrolled in BSA.

Use Cases

  • Search screening Care Plans by NHI

  • Search screening Care Plans by NHI and Status

  • Search screening Care Plans by Date Range

  • Search screening Care Plans by Status

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
CarePlan 0..* CarePlan Healthcare plan for patient or group
CarePlan.Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
CarePlan.Slices for extension.extension:programmeStatus This element must be supported. 1..1 CodeableConcept Programme enrollment status
URL: https://fhir-ig.digital.health.nz/bsa/StructureDefinition/programme-status
Binding: Programme Status Value Set (required)
CarePlan.Slices for extension.extension:pathwayState This element must be supported. 1..1 CodeableConcept Current pathway state
URL: https://fhir-ig.digital.health.nz/bsa/StructureDefinition/pathway-state
Binding: Pathway State Value Set (required)
CarePlan.Slices for extension.extension:pathwaySubstate This element must be supported. 0..1 CodeableConcept Current pathway substate
URL: https://fhir-ig.digital.health.nz/bsa/StructureDefinition/pathway-substate
Binding: Pathway Sub-State Value Set (required)
CarePlan.Slices for extension.extension:pathwayStateLastModified This element must be supported. 1..1 dateTime Date pathway state last modified
URL: https://fhir-ig.digital.health.nz/bsa/StructureDefinition/pathway-state-date-last-modified
CarePlan.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
CarePlan.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
CarePlan.intent This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.
Fixed Value: plan
CarePlan.subject This element must be supported. This element is included in summaries. 1..1 Reference(Patient) NHI Id of Patient enrolled in breast screening
CarePlan.period This element must be supported. This element is included in summaries. 0..1 Period Enrollment period
CarePlan.author This element must be supported. This element is included in summaries. 0..1 Reference(Organization) Lead Provider HPI Org ID

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CarePlan.status Base required RequestStatus 📍4.0.1 FHIR Std.
CarePlan.intent Base required Care Plan Intent 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from CarePlan

NameFlagsCard.TypeDescription & Constraints    Filter: doco
CarePlan 0..* CarePlan Healthcare plan for patient or group
CarePlan.implicitRules 0..0 A set of rules under which this content was created
CarePlan.Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
CarePlan.Slices for extension.extension:programmeStatus This element must be supported. 1..1 CodeableConcept Programme enrollment status
URL: https://fhir-ig.digital.health.nz/bsa/StructureDefinition/programme-status
Binding: Programme Status Value Set (required)
CarePlan.Slices for extension.extension:pathwayState This element must be supported. 1..1 CodeableConcept Current pathway state
URL: https://fhir-ig.digital.health.nz/bsa/StructureDefinition/pathway-state
Binding: Pathway State Value Set (required)
CarePlan.Slices for extension.extension:pathwaySubstate This element must be supported. 0..1 CodeableConcept Current pathway substate
URL: https://fhir-ig.digital.health.nz/bsa/StructureDefinition/pathway-substate
Binding: Pathway Sub-State Value Set (required)
CarePlan.Slices for extension.extension:pathwayStateLastModified This element must be supported. 1..1 dateTime Date pathway state last modified
URL: https://fhir-ig.digital.health.nz/bsa/StructureDefinition/pathway-state-date-last-modified
CarePlan.instantiatesCanonical 0..0 Instantiates FHIR protocol or definition
CarePlan.basedOn 0..0 Fulfills CarePlan
CarePlan.replaces 0..0 CarePlan replaced by this CarePlan
CarePlan.partOf 0..0 Part of referenced CarePlan
CarePlan.status This element must be supported. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
CarePlan.intent This element must be supported. 1..1 code proposal | plan | order | option
Fixed Value: plan
CarePlan.subject This element must be supported. 1..1 Reference(Patient) NHI Id of Patient enrolled in breast screening
CarePlan.period This element must be supported. 0..1 Period Enrollment period
CarePlan.author This element must be supported. 0..1 Reference(Organization) Lead Provider HPI Org ID
CarePlan.contributor 0..0 Who provided the content of the care plan
CarePlan.careTeam 0..0 Who's involved in plan?
CarePlan.addresses 0..0 Health issues this plan addresses
CarePlan.supportingInfo 0..0 Information considered as part of plan
CarePlan.goal 0..0 Desired outcome of plan
CarePlan.activity 0..0 Action to occur as part of plan

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
CarePlan 0..* CarePlan Healthcare plan for patient or group
CarePlan.id This element is included in summaries. 0..1 id Logical id of this artifact
CarePlan.meta This element is included in summaries. 0..1 Meta Metadata about the resource
CarePlan.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
CarePlan.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
CarePlan.contained 0..* Resource Contained, inline Resources
CarePlan.Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
CarePlan.Slices for extension.extension:programmeStatus This element must be supported. 1..1 CodeableConcept Programme enrollment status
URL: https://fhir-ig.digital.health.nz/bsa/StructureDefinition/programme-status
Binding: Programme Status Value Set (required)
CarePlan.Slices for extension.extension:pathwayState This element must be supported. 1..1 CodeableConcept Current pathway state
URL: https://fhir-ig.digital.health.nz/bsa/StructureDefinition/pathway-state
Binding: Pathway State Value Set (required)
CarePlan.Slices for extension.extension:pathwaySubstate This element must be supported. 0..1 CodeableConcept Current pathway substate
URL: https://fhir-ig.digital.health.nz/bsa/StructureDefinition/pathway-substate
Binding: Pathway Sub-State Value Set (required)
CarePlan.Slices for extension.extension:pathwayStateLastModified This element must be supported. 1..1 dateTime Date pathway state last modified
URL: https://fhir-ig.digital.health.nz/bsa/StructureDefinition/pathway-state-date-last-modified
CarePlan.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
CarePlan.identifier This element is included in summaries. 0..* Identifier External Ids for this plan
CarePlan.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
CarePlan.intent This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.
Fixed Value: plan
CarePlan.category This element is included in summaries. 0..* CodeableConcept Type of plan
Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc.
CarePlan.title This element is included in summaries. 0..1 string Human-friendly name for the care plan
CarePlan.description This element is included in summaries. 0..1 string Summary of nature of plan
CarePlan.subject This element must be supported. This element is included in summaries. 1..1 Reference(Patient) NHI Id of Patient enrolled in breast screening
CarePlan.encounter This element is included in summaries. 0..1 Reference(Encounter) Encounter created as part of
CarePlan.period This element must be supported. This element is included in summaries. 0..1 Period Enrollment period
CarePlan.created This element is included in summaries. 0..1 dateTime Date record was first recorded
CarePlan.author This element must be supported. This element is included in summaries. 0..1 Reference(Organization) Lead Provider HPI Org ID
CarePlan.note 0..* Annotation Comments about the plan

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CarePlan.language Base preferred Common Languages 📍4.0.1 FHIR Std.
CarePlan.status Base required RequestStatus 📍4.0.1 FHIR Std.
CarePlan.intent Base required Care Plan Intent 📍4.0.1 FHIR Std.
CarePlan.category Base example Care Plan Category 📍4.0.1 FHIR Std.
CarePlan.activity.outcomeCodeableConcept Base example Care Plan Activity Outcome 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​kind Base required Care Plan Activity Kind 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​reasonCode Base example SNOMED CT Clinical Findings 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​status Base required CarePlanActivityStatus 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​product[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
CarePlan 0..* CarePlan Healthcare plan for patient or group
CarePlan.Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
CarePlan.Slices for extension.extension:programmeStatus This element must be supported. 1..1 CodeableConcept Programme enrollment status
URL: https://fhir-ig.digital.health.nz/bsa/StructureDefinition/programme-status
Binding: Programme Status Value Set (required)
CarePlan.Slices for extension.extension:pathwayState This element must be supported. 1..1 CodeableConcept Current pathway state
URL: https://fhir-ig.digital.health.nz/bsa/StructureDefinition/pathway-state
Binding: Pathway State Value Set (required)
CarePlan.Slices for extension.extension:pathwaySubstate This element must be supported. 0..1 CodeableConcept Current pathway substate
URL: https://fhir-ig.digital.health.nz/bsa/StructureDefinition/pathway-substate
Binding: Pathway Sub-State Value Set (required)
CarePlan.Slices for extension.extension:pathwayStateLastModified This element must be supported. 1..1 dateTime Date pathway state last modified
URL: https://fhir-ig.digital.health.nz/bsa/StructureDefinition/pathway-state-date-last-modified
CarePlan.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
CarePlan.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
CarePlan.intent This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.
Fixed Value: plan
CarePlan.subject This element must be supported. This element is included in summaries. 1..1 Reference(Patient) NHI Id of Patient enrolled in breast screening
CarePlan.period This element must be supported. This element is included in summaries. 0..1 Period Enrollment period
CarePlan.author This element must be supported. This element is included in summaries. 0..1 Reference(Organization) Lead Provider HPI Org ID

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CarePlan.status Base required RequestStatus 📍4.0.1 FHIR Std.
CarePlan.intent Base required Care Plan Intent 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

Differential View

This structure is derived from CarePlan

NameFlagsCard.TypeDescription & Constraints    Filter: doco
CarePlan 0..* CarePlan Healthcare plan for patient or group
CarePlan.implicitRules 0..0 A set of rules under which this content was created
CarePlan.Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
CarePlan.Slices for extension.extension:programmeStatus This element must be supported. 1..1 CodeableConcept Programme enrollment status
URL: https://fhir-ig.digital.health.nz/bsa/StructureDefinition/programme-status
Binding: Programme Status Value Set (required)
CarePlan.Slices for extension.extension:pathwayState This element must be supported. 1..1 CodeableConcept Current pathway state
URL: https://fhir-ig.digital.health.nz/bsa/StructureDefinition/pathway-state
Binding: Pathway State Value Set (required)
CarePlan.Slices for extension.extension:pathwaySubstate This element must be supported. 0..1 CodeableConcept Current pathway substate
URL: https://fhir-ig.digital.health.nz/bsa/StructureDefinition/pathway-substate
Binding: Pathway Sub-State Value Set (required)
CarePlan.Slices for extension.extension:pathwayStateLastModified This element must be supported. 1..1 dateTime Date pathway state last modified
URL: https://fhir-ig.digital.health.nz/bsa/StructureDefinition/pathway-state-date-last-modified
CarePlan.instantiatesCanonical 0..0 Instantiates FHIR protocol or definition
CarePlan.instantiatesUri 0..0 Instantiates external protocol or definition
CarePlan.basedOn 0..0 Fulfills CarePlan
CarePlan.replaces 0..0 CarePlan replaced by this CarePlan
CarePlan.partOf 0..0 Part of referenced CarePlan
CarePlan.status This element must be supported. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
CarePlan.intent This element must be supported. 1..1 code proposal | plan | order | option
Fixed Value: plan
CarePlan.subject This element must be supported. 1..1 Reference(Patient) NHI Id of Patient enrolled in breast screening
CarePlan.period This element must be supported. 0..1 Period Enrollment period
CarePlan.author This element must be supported. 0..1 Reference(Organization) Lead Provider HPI Org ID
CarePlan.contributor 0..0 Who provided the content of the care plan
CarePlan.careTeam 0..0 Who's involved in plan?
CarePlan.addresses 0..0 Health issues this plan addresses
CarePlan.supportingInfo 0..0 Information considered as part of plan
CarePlan.goal 0..0 Desired outcome of plan
CarePlan.activity 0..0 Action to occur as part of plan

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
CarePlan 0..* CarePlan Healthcare plan for patient or group
CarePlan.id This element is included in summaries. 0..1 id Logical id of this artifact
CarePlan.meta This element is included in summaries. 0..1 Meta Metadata about the resource
CarePlan.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
CarePlan.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
CarePlan.contained 0..* Resource Contained, inline Resources
CarePlan.Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
CarePlan.Slices for extension.extension:programmeStatus This element must be supported. 1..1 CodeableConcept Programme enrollment status
URL: https://fhir-ig.digital.health.nz/bsa/StructureDefinition/programme-status
Binding: Programme Status Value Set (required)
CarePlan.Slices for extension.extension:pathwayState This element must be supported. 1..1 CodeableConcept Current pathway state
URL: https://fhir-ig.digital.health.nz/bsa/StructureDefinition/pathway-state
Binding: Pathway State Value Set (required)
CarePlan.Slices for extension.extension:pathwaySubstate This element must be supported. 0..1 CodeableConcept Current pathway substate
URL: https://fhir-ig.digital.health.nz/bsa/StructureDefinition/pathway-substate
Binding: Pathway Sub-State Value Set (required)
CarePlan.Slices for extension.extension:pathwayStateLastModified This element must be supported. 1..1 dateTime Date pathway state last modified
URL: https://fhir-ig.digital.health.nz/bsa/StructureDefinition/pathway-state-date-last-modified
CarePlan.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
CarePlan.identifier This element is included in summaries. 0..* Identifier External Ids for this plan
CarePlan.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
CarePlan.intent This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.
Fixed Value: plan
CarePlan.category This element is included in summaries. 0..* CodeableConcept Type of plan
Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc.
CarePlan.title This element is included in summaries. 0..1 string Human-friendly name for the care plan
CarePlan.description This element is included in summaries. 0..1 string Summary of nature of plan
CarePlan.subject This element must be supported. This element is included in summaries. 1..1 Reference(Patient) NHI Id of Patient enrolled in breast screening
CarePlan.encounter This element is included in summaries. 0..1 Reference(Encounter) Encounter created as part of
CarePlan.period This element must be supported. This element is included in summaries. 0..1 Period Enrollment period
CarePlan.created This element is included in summaries. 0..1 dateTime Date record was first recorded
CarePlan.author This element must be supported. This element is included in summaries. 0..1 Reference(Organization) Lead Provider HPI Org ID
CarePlan.note 0..* Annotation Comments about the plan

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CarePlan.language Base preferred Common Languages 📍4.0.1 FHIR Std.
CarePlan.status Base required RequestStatus 📍4.0.1 FHIR Std.
CarePlan.intent Base required Care Plan Intent 📍4.0.1 FHIR Std.
CarePlan.category Base example Care Plan Category 📍4.0.1 FHIR Std.
CarePlan.activity.outcomeCodeableConcept Base example Care Plan Activity Outcome 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​kind Base required Care Plan Activity Kind 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​reasonCode Base example SNOMED CT Clinical Findings 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​status Base required CarePlanActivityStatus 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​product[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

 

Other representations of profile: CSV, Excel, Schematron