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

## ValueSet: Pathway Sub-State Value Set

Official URL: http://hl7.org.nz/fhir/ig/bsa/ValueSet/pathway-substate | Version: 1.1.0
Active as of 2025-11-14 | Computable Name: PathwaySubStateValueSet

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

References

- Pathway Substate Extension

### Logical Definition (CLD)

- Include all codes defined in `http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` version 📦1.1.0

### Expansion

Expansion performed internally based on codesystem Pathway Substate Code System v1.1.0 (CodeSystem)

This value set contains 43 concepts

System | Code | Display (en) | Definition | JSON | XML
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | invitation-scheduled | Invitation scheduled | Invitation has been scheduled to be sent |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | invitation-sent | Invitation sent | Initial invitation has been sent to participant |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | invitation-re-sent | Invitation re-sent | Follow-up invitation has been re-sent to participant |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | booking-in-progress | Booking in progress | Appointment booking is currently in progress |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | confirmed | Confirmed | Appointment has been confirmed by participant |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | cancelled | Cancelled | Appointment has been cancelled |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | re-booking | Re-booking | Participant is re-booking an appointment |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | follow-up | Follow up | Follow-up action required |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | tentative | Tentative | Appointment is tentatively scheduled |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | ready-for-screening | Ready for screening | Participant is ready to undergo screening |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | in-screening | In screening | Participant is in the screening workflow. Screening mammogram is currently being performed |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | in-review | In review | Screening results are under review |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | ready-for-reading | Ready for reading | Images are ready for radiologist reading |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | read | Read | Images are being read by radiologist |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | booked | Booked | Assessment appointment has been booked |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | in-progress | In progress | Appointment is currently in progress |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | assigned | Assigned | Case has been assigned for multi-disciplinary review |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | external | External | External multi-disciplinary review |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | bsa-contracted-provider | BSA contracted provider | Further assessment with BSA contracted provider |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | diagnostic-provider | Diagnostic provider | Further assessment with diagnostic provider |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | pending | Pending | Extended assessment is pending |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | waiting-for-results | Waiting for results | Waiting for assessment or screening results |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | five-year-status | 5-year status | Five-year follow-up status |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | treatment-data-collection-pending | Treatment data collection pending | Treatment data collection is pending |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | treatment-data-collection-in-progress | Treatment data collection in progress | Treatment data collection is currently in progress |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | treatment-data-collection-complete | Treatment data collection complete | Treatment data collection has been completed |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | treatment-data-not-collected | Treatment data not collected | Treatment data was not collected |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | contacting | Contacting | Attempting to contact participant for unbooked assessments |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | ineligible | Ineligible | Participant is ineligible for the programme |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | dnr | DNR | Do not recall - participant should not be contacted |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | declined | Declined | Participant has declined to participate |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | never-enrolled | Never enrolled | Participant was never enrolled in the programme |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | programme-exit | Programme exit | Participant has exited the programme |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | aged-out | Aged out | Participant has aged out of the programme |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | deceased | Deceased | Participant is deceased |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | clinical-exit | Clinical exit | Participant has exited for clinical reasons |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | diagnosis-age-out | Diagnosis age out | Participant aged out due to diagnosis |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | clinical-review | Clinical review | Case is under clinical review |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | screening-review | Screening review | Screening process is under review |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | post-diagnosis-review | Post diagnosis review | Post-diagnosis review is being conducted |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | participant-review | Participant review | Participant status is under review |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | none | None | No specific substate |  |
`http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate` | ageing-out-soon | Ageing out soon | Participant will age out within 30 days |  |

Explanation of the columns that may appear on this page:

Level | A few code lists that FHIR defines are hierarchical - each code is assigned a level. In this scheme, some codes are under other codes, and imply that the code they are under also applies
System | The source of the definition of the code (when the value set draws in codes defined elsewhere)
Code | The code (used as the code in the resource instance)
Display | The display (used in the display element of a Coding). If there is no display, implementers should not simply display the code, but map the concept into their application
Definition | An explanation of the meaning of the concept
Comments | Additional notes about how to use the code