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

## : Pathway Substate Code System - JSON Representation

Active as of 2025-11-14

Raw json | Download

    {
      "resourceType" : "CodeSystem",
      "id" : "pathway-substate",
      "text" : {
        "status" : "generated",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CodeSystem pathway-substate</b></p><a name=\"pathway-substate\"> </a><a name=\"hcpathway-substate\"> </a><p>This case-sensitive code system <code>http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate</code> defines the following codes:</p><table class=\"codes\"><tr><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td></tr><tr><td style=\"white-space:nowrap\">invitation-scheduled<a name=\"pathway-substate-invitation-scheduled\"> </a></td><td>Invitation scheduled</td><td>Invitation has been scheduled to be sent</td></tr><tr><td style=\"white-space:nowrap\">invitation-sent<a name=\"pathway-substate-invitation-sent\"> </a></td><td>Invitation sent</td><td>Initial invitation has been sent to participant</td></tr><tr><td style=\"white-space:nowrap\">invitation-re-sent<a name=\"pathway-substate-invitation-re-sent\"> </a></td><td>Invitation re-sent</td><td>Follow-up invitation has been re-sent to participant</td></tr><tr><td style=\"white-space:nowrap\">booking-in-progress<a name=\"pathway-substate-booking-in-progress\"> </a></td><td>Booking in progress</td><td>Appointment booking is currently in progress</td></tr><tr><td style=\"white-space:nowrap\">confirmed<a name=\"pathway-substate-confirmed\"> </a></td><td>Confirmed</td><td>Appointment has been confirmed by participant</td></tr><tr><td style=\"white-space:nowrap\">cancelled<a name=\"pathway-substate-cancelled\"> </a></td><td>Cancelled</td><td>Appointment has been cancelled</td></tr><tr><td style=\"white-space:nowrap\">re-booking<a name=\"pathway-substate-re-booking\"> </a></td><td>Re-booking</td><td>Participant is re-booking an appointment</td></tr><tr><td style=\"white-space:nowrap\">follow-up<a name=\"pathway-substate-follow-up\"> </a></td><td>Follow up</td><td>Follow-up action required</td></tr><tr><td style=\"white-space:nowrap\">tentative<a name=\"pathway-substate-tentative\"> </a></td><td>Tentative</td><td>Appointment is tentatively scheduled</td></tr><tr><td style=\"white-space:nowrap\">ready-for-screening<a name=\"pathway-substate-ready-for-screening\"> </a></td><td>Ready for screening</td><td>Participant is ready to undergo screening</td></tr><tr><td style=\"white-space:nowrap\">in-screening<a name=\"pathway-substate-in-screening\"> </a></td><td>In screening</td><td>Participant is in the screening workflow. Screening mammogram is currently being performed</td></tr><tr><td style=\"white-space:nowrap\">in-review<a name=\"pathway-substate-in-review\"> </a></td><td>In review</td><td>Screening results are under review</td></tr><tr><td style=\"white-space:nowrap\">ready-for-reading<a name=\"pathway-substate-ready-for-reading\"> </a></td><td>Ready for reading</td><td>Images are ready for radiologist reading</td></tr><tr><td style=\"white-space:nowrap\">read<a name=\"pathway-substate-read\"> </a></td><td>Read</td><td>Images are being read by radiologist</td></tr><tr><td style=\"white-space:nowrap\">booked<a name=\"pathway-substate-booked\"> </a></td><td>Booked</td><td>Assessment appointment has been booked</td></tr><tr><td style=\"white-space:nowrap\">in-progress<a name=\"pathway-substate-in-progress\"> </a></td><td>In progress</td><td>Appointment is currently in progress</td></tr><tr><td style=\"white-space:nowrap\">assigned<a name=\"pathway-substate-assigned\"> </a></td><td>Assigned</td><td>Case has been assigned for multi-disciplinary review</td></tr><tr><td style=\"white-space:nowrap\">external<a name=\"pathway-substate-external\"> </a></td><td>External</td><td>External multi-disciplinary review</td></tr><tr><td style=\"white-space:nowrap\">bsa-contracted-provider<a name=\"pathway-substate-bsa-contracted-provider\"> </a></td><td>BSA contracted provider</td><td>Further assessment with BSA contracted provider</td></tr><tr><td style=\"white-space:nowrap\">diagnostic-provider<a name=\"pathway-substate-diagnostic-provider\"> </a></td><td>Diagnostic provider</td><td>Further assessment with diagnostic provider</td></tr><tr><td style=\"white-space:nowrap\">pending<a name=\"pathway-substate-pending\"> </a></td><td>Pending</td><td>Extended assessment is pending</td></tr><tr><td style=\"white-space:nowrap\">waiting-for-results<a name=\"pathway-substate-waiting-for-results\"> </a></td><td>Waiting for results</td><td>Waiting for assessment or screening results</td></tr><tr><td style=\"white-space:nowrap\">five-year-status<a name=\"pathway-substate-five-year-status\"> </a></td><td>5-year status</td><td>Five-year follow-up status</td></tr><tr><td style=\"white-space:nowrap\">treatment-data-collection-pending<a name=\"pathway-substate-treatment-data-collection-pending\"> </a></td><td>Treatment data collection pending</td><td>Treatment data collection is pending</td></tr><tr><td style=\"white-space:nowrap\">treatment-data-collection-in-progress<a name=\"pathway-substate-treatment-data-collection-in-progress\"> </a></td><td>Treatment data collection in progress</td><td>Treatment data collection is currently in progress</td></tr><tr><td style=\"white-space:nowrap\">treatment-data-collection-complete<a name=\"pathway-substate-treatment-data-collection-complete\"> </a></td><td>Treatment data collection complete</td><td>Treatment data collection has been completed</td></tr><tr><td style=\"white-space:nowrap\">treatment-data-not-collected<a name=\"pathway-substate-treatment-data-not-collected\"> </a></td><td>Treatment data not collected</td><td>Treatment data was not collected</td></tr><tr><td style=\"white-space:nowrap\">contacting<a name=\"pathway-substate-contacting\"> </a></td><td>Contacting</td><td>Attempting to contact participant for unbooked assessments</td></tr><tr><td style=\"white-space:nowrap\">ineligible<a name=\"pathway-substate-ineligible\"> </a></td><td>Ineligible</td><td>Participant is ineligible for the programme</td></tr><tr><td style=\"white-space:nowrap\">dnr<a name=\"pathway-substate-dnr\"> </a></td><td>DNR</td><td>Do not recall - participant should not be contacted</td></tr><tr><td style=\"white-space:nowrap\">declined<a name=\"pathway-substate-declined\"> </a></td><td>Declined</td><td>Participant has declined to participate</td></tr><tr><td style=\"white-space:nowrap\">never-enrolled<a name=\"pathway-substate-never-enrolled\"> </a></td><td>Never enrolled</td><td>Participant was never enrolled in the programme</td></tr><tr><td style=\"white-space:nowrap\">programme-exit<a name=\"pathway-substate-programme-exit\"> </a></td><td>Programme exit</td><td>Participant has exited the programme</td></tr><tr><td style=\"white-space:nowrap\">aged-out<a name=\"pathway-substate-aged-out\"> </a></td><td>Aged out</td><td>Participant has aged out of the programme</td></tr><tr><td style=\"white-space:nowrap\">deceased<a name=\"pathway-substate-deceased\"> </a></td><td>Deceased</td><td>Participant is deceased</td></tr><tr><td style=\"white-space:nowrap\">clinical-exit<a name=\"pathway-substate-clinical-exit\"> </a></td><td>Clinical exit</td><td>Participant has exited for clinical reasons</td></tr><tr><td style=\"white-space:nowrap\">diagnosis-age-out<a name=\"pathway-substate-diagnosis-age-out\"> </a></td><td>Diagnosis age out</td><td>Participant aged out due to diagnosis</td></tr><tr><td style=\"white-space:nowrap\">clinical-review<a name=\"pathway-substate-clinical-review\"> </a></td><td>Clinical review</td><td>Case is under clinical review</td></tr><tr><td style=\"white-space:nowrap\">screening-review<a name=\"pathway-substate-screening-review\"> </a></td><td>Screening review</td><td>Screening process is under review</td></tr><tr><td style=\"white-space:nowrap\">post-diagnosis-review<a name=\"pathway-substate-post-diagnosis-review\"> </a></td><td>Post diagnosis review</td><td>Post-diagnosis review is being conducted</td></tr><tr><td style=\"white-space:nowrap\">participant-review<a name=\"pathway-substate-participant-review\"> </a></td><td>Participant review</td><td>Participant status is under review</td></tr><tr><td style=\"white-space:nowrap\">none<a name=\"pathway-substate-none\"> </a></td><td>None</td><td>No specific substate</td></tr><tr><td style=\"white-space:nowrap\">ageing-out-soon<a name=\"pathway-substate-ageing-out-soon\"> </a></td><td>Ageing out soon</td><td>Participant will age out within 30 days</td></tr></table></div>"
      },
      "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"
        }
      ]
    }