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 - XML Representation

Active as of 2025-11-14

Raw xml | Download

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