Breast Screening NZ FHIR Implementation Guide
1.1.0 - Release
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
| Active as of 2025-11-14 |
@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
# - resource -------------------------------------------------------------------
<http://hl7.org/fhir/CodeSystem/pathway-substate> a fhir:CodeSystem ;
fhir:nodeRole fhir:treeRoot ;
fhir:Resource.id [ fhir:value "pathway-substate"] ;
fhir:DomainResource.text [
fhir:Narrative.status [ fhir:value "generated" ] ;
fhir:Narrative.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>"
] ;
fhir:CodeSystem.url [ fhir:value "http://hl7.org.nz/fhir/ig/bsa/CodeSystem/pathway-substate"] ;
fhir:CodeSystem.version [ fhir:value "1.1.0"] ;
fhir:CodeSystem.name [ fhir:value "PathwaySubstate"] ;
fhir:CodeSystem.title [ fhir:value "Pathway Substate Code System"] ;
fhir:CodeSystem.status [ fhir:value "active"] ;
fhir:CodeSystem.experimental [ fhir:value "false"^^xsd:boolean] ;
fhir:CodeSystem.date [ fhir:value "2025-11-14"^^xsd:date] ;
fhir:CodeSystem.publisher [ fhir:value "Te Whatu Ora"] ;
fhir:CodeSystem.contact [
fhir:index 0 ;
fhir:ContactDetail.name [ fhir:value "Te Whatu Ora" ] ;
fhir:ContactDetail.telecom [
fhir:index 0 ;
fhir:ContactPoint.system [ fhir:value "email" ] ;
fhir:ContactPoint.value [ fhir:value "mailto:integration@health.govt.nz" ]
]
] ;
fhir:CodeSystem.description [ fhir:value "Codes for detailed substates within the screening pathway, providing additional granularity to pathway states."] ;
fhir:CodeSystem.caseSensitive [ fhir:value "true"^^xsd:boolean] ;
fhir:CodeSystem.content [ fhir:value "complete"] ;
fhir:CodeSystem.count [ fhir:value "43"^^xsd:nonNegativeInteger] ;
fhir:CodeSystem.concept [
fhir:index 0 ;
fhir:CodeSystem.concept.code [ fhir:value "invitation-scheduled" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Invitation scheduled" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Invitation has been scheduled to be sent" ]
], [
fhir:index 1 ;
fhir:CodeSystem.concept.code [ fhir:value "invitation-sent" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Invitation sent" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Initial invitation has been sent to participant" ]
], [
fhir:index 2 ;
fhir:CodeSystem.concept.code [ fhir:value "invitation-re-sent" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Invitation re-sent" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Follow-up invitation has been re-sent to participant" ]
], [
fhir:index 3 ;
fhir:CodeSystem.concept.code [ fhir:value "booking-in-progress" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Booking in progress" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Appointment booking is currently in progress" ]
], [
fhir:index 4 ;
fhir:CodeSystem.concept.code [ fhir:value "confirmed" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Confirmed" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Appointment has been confirmed by participant" ]
], [
fhir:index 5 ;
fhir:CodeSystem.concept.code [ fhir:value "cancelled" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Cancelled" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Appointment has been cancelled" ]
], [
fhir:index 6 ;
fhir:CodeSystem.concept.code [ fhir:value "re-booking" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Re-booking" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Participant is re-booking an appointment" ]
], [
fhir:index 7 ;
fhir:CodeSystem.concept.code [ fhir:value "follow-up" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Follow up" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Follow-up action required" ]
], [
fhir:index 8 ;
fhir:CodeSystem.concept.code [ fhir:value "tentative" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Tentative" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Appointment is tentatively scheduled" ]
], [
fhir:index 9 ;
fhir:CodeSystem.concept.code [ fhir:value "ready-for-screening" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Ready for screening" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Participant is ready to undergo screening" ]
], [
fhir:index 10 ;
fhir:CodeSystem.concept.code [ fhir:value "in-screening" ] ;
fhir:CodeSystem.concept.display [ fhir:value "In screening" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Participant is in the screening workflow. Screening mammogram is currently being performed" ]
], [
fhir:index 11 ;
fhir:CodeSystem.concept.code [ fhir:value "in-review" ] ;
fhir:CodeSystem.concept.display [ fhir:value "In review" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Screening results are under review" ]
], [
fhir:index 12 ;
fhir:CodeSystem.concept.code [ fhir:value "ready-for-reading" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Ready for reading" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Images are ready for radiologist reading" ]
], [
fhir:index 13 ;
fhir:CodeSystem.concept.code [ fhir:value "read" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Read" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Images are being read by radiologist" ]
], [
fhir:index 14 ;
fhir:CodeSystem.concept.code [ fhir:value "booked" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Booked" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Assessment appointment has been booked" ]
], [
fhir:index 15 ;
fhir:CodeSystem.concept.code [ fhir:value "in-progress" ] ;
fhir:CodeSystem.concept.display [ fhir:value "In progress" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Appointment is currently in progress" ]
], [
fhir:index 16 ;
fhir:CodeSystem.concept.code [ fhir:value "assigned" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Assigned" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Case has been assigned for multi-disciplinary review" ]
], [
fhir:index 17 ;
fhir:CodeSystem.concept.code [ fhir:value "external" ] ;
fhir:CodeSystem.concept.display [ fhir:value "External" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "External multi-disciplinary review" ]
], [
fhir:index 18 ;
fhir:CodeSystem.concept.code [ fhir:value "bsa-contracted-provider" ] ;
fhir:CodeSystem.concept.display [ fhir:value "BSA contracted provider" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Further assessment with BSA contracted provider" ]
], [
fhir:index 19 ;
fhir:CodeSystem.concept.code [ fhir:value "diagnostic-provider" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Diagnostic provider" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Further assessment with diagnostic provider" ]
], [
fhir:index 20 ;
fhir:CodeSystem.concept.code [ fhir:value "pending" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Pending" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Extended assessment is pending" ]
], [
fhir:index 21 ;
fhir:CodeSystem.concept.code [ fhir:value "waiting-for-results" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Waiting for results" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Waiting for assessment or screening results" ]
], [
fhir:index 22 ;
fhir:CodeSystem.concept.code [ fhir:value "five-year-status" ] ;
fhir:CodeSystem.concept.display [ fhir:value "5-year status" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Five-year follow-up status" ]
], [
fhir:index 23 ;
fhir:CodeSystem.concept.code [ fhir:value "treatment-data-collection-pending" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Treatment data collection pending" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Treatment data collection is pending" ]
], [
fhir:index 24 ;
fhir:CodeSystem.concept.code [ fhir:value "treatment-data-collection-in-progress" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Treatment data collection in progress" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Treatment data collection is currently in progress" ]
], [
fhir:index 25 ;
fhir:CodeSystem.concept.code [ fhir:value "treatment-data-collection-complete" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Treatment data collection complete" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Treatment data collection has been completed" ]
], [
fhir:index 26 ;
fhir:CodeSystem.concept.code [ fhir:value "treatment-data-not-collected" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Treatment data not collected" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Treatment data was not collected" ]
], [
fhir:index 27 ;
fhir:CodeSystem.concept.code [ fhir:value "contacting" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Contacting" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Attempting to contact participant for unbooked assessments" ]
], [
fhir:index 28 ;
fhir:CodeSystem.concept.code [ fhir:value "ineligible" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Ineligible" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Participant is ineligible for the programme" ]
], [
fhir:index 29 ;
fhir:CodeSystem.concept.code [ fhir:value "dnr" ] ;
fhir:CodeSystem.concept.display [ fhir:value "DNR" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Do not recall - participant should not be contacted" ]
], [
fhir:index 30 ;
fhir:CodeSystem.concept.code [ fhir:value "declined" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Declined" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Participant has declined to participate" ]
], [
fhir:index 31 ;
fhir:CodeSystem.concept.code [ fhir:value "never-enrolled" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Never enrolled" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Participant was never enrolled in the programme" ]
], [
fhir:index 32 ;
fhir:CodeSystem.concept.code [ fhir:value "programme-exit" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Programme exit" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Participant has exited the programme" ]
], [
fhir:index 33 ;
fhir:CodeSystem.concept.code [ fhir:value "aged-out" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Aged out" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Participant has aged out of the programme" ]
], [
fhir:index 34 ;
fhir:CodeSystem.concept.code [ fhir:value "deceased" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Deceased" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Participant is deceased" ]
], [
fhir:index 35 ;
fhir:CodeSystem.concept.code [ fhir:value "clinical-exit" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Clinical exit" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Participant has exited for clinical reasons" ]
], [
fhir:index 36 ;
fhir:CodeSystem.concept.code [ fhir:value "diagnosis-age-out" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Diagnosis age out" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Participant aged out due to diagnosis" ]
], [
fhir:index 37 ;
fhir:CodeSystem.concept.code [ fhir:value "clinical-review" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Clinical review" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Case is under clinical review" ]
], [
fhir:index 38 ;
fhir:CodeSystem.concept.code [ fhir:value "screening-review" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Screening review" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Screening process is under review" ]
], [
fhir:index 39 ;
fhir:CodeSystem.concept.code [ fhir:value "post-diagnosis-review" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Post diagnosis review" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Post-diagnosis review is being conducted" ]
], [
fhir:index 40 ;
fhir:CodeSystem.concept.code [ fhir:value "participant-review" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Participant review" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Participant status is under review" ]
], [
fhir:index 41 ;
fhir:CodeSystem.concept.code [ fhir:value "none" ] ;
fhir:CodeSystem.concept.display [ fhir:value "None" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "No specific substate" ]
], [
fhir:index 42 ;
fhir:CodeSystem.concept.code [ fhir:value "ageing-out-soon" ] ;
fhir:CodeSystem.concept.display [ fhir:value "Ageing out soon" ] ;
fhir:CodeSystem.concept.definition [ fhir:value "Participant will age out within 30 days" ]
] .
# - ontology header ------------------------------------------------------------
<http://hl7.org/fhir/CodeSystem/pathway-substate.ttl> a owl:Ontology ;
owl:imports fhir:fhir.ttl ;
owl:versionIRI <http://build.fhir.org/CodeSystem/pathway-substate.ttl> .
IG © 2020+ Te Whatu Ora. Package nz.breastscreening.fhir.ig#1.1.0 based on FHIR 4.0.1. Generated 2026-07-09
Links: Table of Contents |
QA Report