# Pathway Substate Code System - Breast Screening NZ FHIR Implementation Guide v1.1.0

* [**Table of Contents**](toc.md)
* [**Artifacts Summary**](artifacts.md)
* **Pathway Substate Code System**

## CodeSystem: Pathway Substate Code System 

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

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

 This Code system is referenced in the content logical definition of the following value sets: 

* [PathwaySubStateValueSet](ValueSet-pathway-substate.md)



## Resource Content

```json
{
  "resourceType" : "CodeSystem",
  "id" : "pathway-substate",
  "url" : "http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate",
  "version" : "1.1.0",
  "name" : "PathwaySubstate",
  "title" : "Pathway Substate Code System",
  "status" : "active",
  "experimental" : false,
  "date" : "2025-11-14",
  "publisher" : "Te Whatu Ora",
  "contact" : [{
    "name" : "Te Whatu Ora",
    "telecom" : [{
      "system" : "email",
      "value" : "mailto:integration@health.govt.nz"
    }]
  }],
  "description" : "Codes for detailed substates within the screening pathway, providing additional granularity to pathway states.",
  "caseSensitive" : true,
  "content" : "complete",
  "count" : 43,
  "concept" : [{
    "code" : "invitation-scheduled",
    "display" : "Invitation scheduled",
    "definition" : "Invitation has been scheduled to be sent"
  },
  {
    "code" : "invitation-sent",
    "display" : "Invitation sent",
    "definition" : "Initial invitation has been sent to participant"
  },
  {
    "code" : "invitation-re-sent",
    "display" : "Invitation re-sent",
    "definition" : "Follow-up invitation has been re-sent to participant"
  },
  {
    "code" : "booking-in-progress",
    "display" : "Booking in progress",
    "definition" : "Appointment booking is currently in progress"
  },
  {
    "code" : "confirmed",
    "display" : "Confirmed",
    "definition" : "Appointment has been confirmed by participant"
  },
  {
    "code" : "cancelled",
    "display" : "Cancelled",
    "definition" : "Appointment has been cancelled"
  },
  {
    "code" : "re-booking",
    "display" : "Re-booking",
    "definition" : "Participant is re-booking an appointment"
  },
  {
    "code" : "follow-up",
    "display" : "Follow up",
    "definition" : "Follow-up action required"
  },
  {
    "code" : "tentative",
    "display" : "Tentative",
    "definition" : "Appointment is tentatively scheduled"
  },
  {
    "code" : "ready-for-screening",
    "display" : "Ready for screening",
    "definition" : "Participant is ready to undergo screening"
  },
  {
    "code" : "in-screening",
    "display" : "In screening",
    "definition" : "Participant is in the screening workflow. Screening mammogram is currently being performed"
  },
  {
    "code" : "in-review",
    "display" : "In review",
    "definition" : "Screening results are under review"
  },
  {
    "code" : "ready-for-reading",
    "display" : "Ready for reading",
    "definition" : "Images are ready for radiologist reading"
  },
  {
    "code" : "read",
    "display" : "Read",
    "definition" : "Images are being read by radiologist"
  },
  {
    "code" : "booked",
    "display" : "Booked",
    "definition" : "Assessment appointment has been booked"
  },
  {
    "code" : "in-progress",
    "display" : "In progress",
    "definition" : "Appointment is currently in progress"
  },
  {
    "code" : "assigned",
    "display" : "Assigned",
    "definition" : "Case has been assigned for multi-disciplinary review"
  },
  {
    "code" : "external",
    "display" : "External",
    "definition" : "External multi-disciplinary review"
  },
  {
    "code" : "bsa-contracted-provider",
    "display" : "BSA contracted provider",
    "definition" : "Further assessment with BSA contracted provider"
  },
  {
    "code" : "diagnostic-provider",
    "display" : "Diagnostic provider",
    "definition" : "Further assessment with diagnostic provider"
  },
  {
    "code" : "pending",
    "display" : "Pending",
    "definition" : "Extended assessment is pending"
  },
  {
    "code" : "waiting-for-results",
    "display" : "Waiting for results",
    "definition" : "Waiting for assessment or screening results"
  },
  {
    "code" : "five-year-status",
    "display" : "5-year status",
    "definition" : "Five-year follow-up status"
  },
  {
    "code" : "treatment-data-collection-pending",
    "display" : "Treatment data collection pending",
    "definition" : "Treatment data collection is pending"
  },
  {
    "code" : "treatment-data-collection-in-progress",
    "display" : "Treatment data collection in progress",
    "definition" : "Treatment data collection is currently in progress"
  },
  {
    "code" : "treatment-data-collection-complete",
    "display" : "Treatment data collection complete",
    "definition" : "Treatment data collection has been completed"
  },
  {
    "code" : "treatment-data-not-collected",
    "display" : "Treatment data not collected",
    "definition" : "Treatment data was not collected"
  },
  {
    "code" : "contacting",
    "display" : "Contacting",
    "definition" : "Attempting to contact participant for unbooked assessments"
  },
  {
    "code" : "ineligible",
    "display" : "Ineligible",
    "definition" : "Participant is ineligible for the programme"
  },
  {
    "code" : "dnr",
    "display" : "DNR",
    "definition" : "Do not recall - participant should not be contacted"
  },
  {
    "code" : "declined",
    "display" : "Declined",
    "definition" : "Participant has declined to participate"
  },
  {
    "code" : "never-enrolled",
    "display" : "Never enrolled",
    "definition" : "Participant was never enrolled in the programme"
  },
  {
    "code" : "programme-exit",
    "display" : "Programme exit",
    "definition" : "Participant has exited the programme"
  },
  {
    "code" : "aged-out",
    "display" : "Aged out",
    "definition" : "Participant has aged out of the programme"
  },
  {
    "code" : "deceased",
    "display" : "Deceased",
    "definition" : "Participant is deceased"
  },
  {
    "code" : "clinical-exit",
    "display" : "Clinical exit",
    "definition" : "Participant has exited for clinical reasons"
  },
  {
    "code" : "diagnosis-age-out",
    "display" : "Diagnosis age out",
    "definition" : "Participant aged out due to diagnosis"
  },
  {
    "code" : "clinical-review",
    "display" : "Clinical review",
    "definition" : "Case is under clinical review"
  },
  {
    "code" : "screening-review",
    "display" : "Screening review",
    "definition" : "Screening process is under review"
  },
  {
    "code" : "post-diagnosis-review",
    "display" : "Post diagnosis review",
    "definition" : "Post-diagnosis review is being conducted"
  },
  {
    "code" : "participant-review",
    "display" : "Participant review",
    "definition" : "Participant status is under review"
  },
  {
    "code" : "none",
    "display" : "None",
    "definition" : "No specific substate"
  },
  {
    "code" : "ageing-out-soon",
    "display" : "Ageing out soon",
    "definition" : "Participant will age out within 30 days"
  }]
}

```
