Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.5 - release

Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.5) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## : Status Reason for ServiceRequest - TTL Representation

Active as of 2026-03-03

Raw ttl | Download

    @prefix fhir: <http://hl7.org/fhir/> .
    @prefix owl: <http://www.w3.org/2002/07/owl#> .
    @prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
    @prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
    @prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

    # - resource -------------------------------------------------------------------

     a fhir:CodeSystem ;
      fhir:nodeRole fhir:treeRoot ;
      fhir:id [ fhir:v "hnz-service-request-status-reason-codes"] ; #
      fhir:text [
    fhir:status [ fhir:v "generated" ] ;
    fhir:div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CodeSystem hnz-service-request-status-reason-codes</b></p><a name=\"hnz-service-request-status-reason-codes\"> </a><a name=\"hchnz-service-request-status-reason-codes\"> </a><p>This case-sensitive code system <code>https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-service-request-status-reason-codes</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\">ReferredToOutreach<a name=\"hnz-service-request-status-reason-codes-ReferredToOutreach\"> </a></td><td>Referred to Outreach</td><td>The participant has been referred to outreach services.</td></tr><tr><td style=\"white-space:nowrap\">ServiceGiven<a name=\"hnz-service-request-status-reason-codes-ServiceGiven\"> </a></td><td>Service Given</td><td>All required services have been completed for the participant, and the process is now awaiting clinical results (e.g. all required vaccinations have been administered, but waiting for the clinical record to be received)</td></tr><tr><td style=\"white-space:nowrap\">ServiceDeclined<a name=\"hnz-service-request-status-reason-codes-ServiceDeclined\"> </a></td><td>Service Declined</td><td>All required services have been declined by the participant. (e.g. all required vaccinations have been declined)</td></tr><tr><td style=\"white-space:nowrap\">ServiceGivenDeclined<a name=\"hnz-service-request-status-reason-codes-ServiceGivenDeclined\"> </a></td><td>Service Given/Declined</td><td>All required services have either been completed or declined by the participant (e.g. all required vaccinations have been given or declined)</td></tr><tr><td style=\"white-space:nowrap\">ClinicalRecordReceived<a name=\"hnz-service-request-status-reason-codes-ClinicalRecordReceived\"> </a></td><td>Clinical record received</td><td>The relevant clinical record has been received, and outreach is no longer required.</td></tr><tr><td style=\"white-space:nowrap\">ClinicalRecordCollected<a name=\"hnz-service-request-status-reason-codes-ClinicalRecordCollected\"> </a></td><td>Clinical record collected</td><td>Documentation confirms the participant has previously received the required services.</td></tr><tr><td style=\"white-space:nowrap\">ReturningToProvider<a name=\"hnz-service-request-status-reason-codes-ReturningToProvider\"> </a></td><td>Returning to provider</td><td>The participant has indicated a preference to receive services from an existing provider (e.g. GP, Iwi, or Hauora).</td></tr><tr><td style=\"white-space:nowrap\">ProgrammeToBeCompleted<a name=\"hnz-service-request-status-reason-codes-ProgrammeToBeCompleted\"> </a></td><td>Programme to be completed</td><td>The participant will continue with outreach services until programme completion.</td></tr><tr><td style=\"white-space:nowrap\">ProgrammeStatusChanged<a name=\"hnz-service-request-status-reason-codes-ProgrammeStatusChanged\"> </a></td><td>Programme status changed</td><td>The participant's programme status has changed to 'Unenrolled' or 'Withdrawn'.</td></tr><tr><td style=\"white-space:nowrap\">CorrespondenceStatusChanged<a name=\"hnz-service-request-status-reason-codes-CorrespondenceStatusChanged\"> </a></td><td>Correspondence status changed</td><td>The participant has opted out of programme correspondence for reasons that preclude outreach engagement (e.g. illness, terminal diagnosis).</td></tr><tr><td style=\"white-space:nowrap\">DeclinedOutreachServices<a name=\"hnz-service-request-status-reason-codes-DeclinedOutreachServices\"> </a></td><td>Declined outreach services</td><td>The participant has declined engagement with outreach services.</td></tr><tr><td style=\"white-space:nowrap\">UnableToContact<a name=\"hnz-service-request-status-reason-codes-UnableToContact\"> </a></td><td>Unable to contact</td><td>Outreach has been unable to contact the participant despite multiple attempts.</td></tr><tr><td style=\"white-space:nowrap\">MovedOutOfArea<a name=\"hnz-service-request-status-reason-codes-MovedOutOfArea\"> </a></td><td>Moved out of area</td><td>The participant no longer resides within the region supported by the outreach provider.</td></tr><tr><td style=\"white-space:nowrap\">GoneOverseas<a name=\"hnz-service-request-status-reason-codes-GoneOverseas\"> </a></td><td>Gone Overseas</td><td>It has been confirmed that the participant is no longer residing in New Zealand.</td></tr><tr><td style=\"white-space:nowrap\">UnconfirmedOverseas<a name=\"hnz-service-request-status-reason-codes-UnconfirmedOverseas\"> </a></td><td>Unconfirmed Overseas</td><td>Investigations suggest that the participant is no longer residing in New Zealand.</td></tr><tr><td style=\"white-space:nowrap\">Deceased<a name=\"hnz-service-request-status-reason-codes-Deceased\"> </a></td><td>Deceased</td><td>It has been confirmed that the participant is deceased, any open outreach service requests to be revoked with a status reason of 'Deceased'.</td></tr><tr><td style=\"white-space:nowrap\">UnconfirmedDeceased<a name=\"hnz-service-request-status-reason-codes-UnconfirmedDeceased\"> </a></td><td>Unconfirmed deceased</td><td>Investigations suggest that the participant may be deceased.</td></tr><tr><td style=\"white-space:nowrap\">NoLongerOverdue<a name=\"hnz-service-request-status-reason-codes-NoLongerOverdue\"> </a></td><td>No longer overdue</td><td>The participant is no longer considered overdue for the condition that initiated the outreach request.</td></tr><tr><td style=\"white-space:nowrap\">OnHold<a name=\"hnz-service-request-status-reason-codes-OnHold\"> </a></td><td>On Hold</td><td>The outreach request has been temporarily suspended and may resume in the future.</td></tr><tr><td style=\"white-space:nowrap\">EnteredInError<a name=\"hnz-service-request-status-reason-codes-EnteredInError\"> </a></td><td>Entered in error</td><td>The service request was created in error and is to be formally revoked.</td></tr></table></div>"^^rdf:XMLLiteral
      ] ; #
      fhir:url [ fhir:v "https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-service-request-status-reason-codes"^^xsd:anyURI] ; #
      fhir:version [ fhir:v "0.4.5"] ; #
      fhir:name [ fhir:v "ServiceRequestStatusReasonCodes"] ; #
      fhir:title [ fhir:v "Status Reason for ServiceRequest"] ; #
      fhir:status [ fhir:v "active"] ; #
      fhir:experimental [ fhir:v false] ; #
      fhir:date [ fhir:v "2026-03-03T21:51:04+00:00"^^xsd:dateTime] ; #
      fhir:publisher [ fhir:v "Te Whatu Ora"] ; #
      fhir:contact ( [
    fhir:name [ fhir:v "Te Whatu Ora" ] ;
        ( fhir:telecom [
    fhir:system [ fhir:v "url" ] ;
    fhir:value [ fhir:v "https://www.tewhatuora.govt.nz/" ]     ] )
      ] [
    fhir:name [ fhir:v "Te Whatu Ora Integration Team" ] ;
        ( fhir:telecom [
    fhir:system [ fhir:v "email" ] ;
    fhir:value [ fhir:v "integration@tewhatuora.govt.nz" ] ;
    fhir:use [ fhir:v "work" ]     ] )
      ] ) ; #
      fhir:description [ fhir:v "Each code represents the type of referral request"] ; #
      fhir:jurisdiction ( [
        ( fhir:coding [
    fhir:system [ fhir:v "urn:iso:std:iso:3166"^^xsd:anyURI ] ;
    fhir:code [ fhir:v "NZ" ] ;
    fhir:display [ fhir:v "New Zealand" ]     ] )
      ] ) ; #
      fhir:purpose [ fhir:v "Enables a Service Request record to populate with the appropriate status reason."] ; #
      fhir:caseSensitive [ fhir:v true] ; #
      fhir:content [ fhir:v "complete"] ; #
      fhir:count [ fhir:v "20"^^xsd:nonNegativeInteger] ; #
      fhir:concept ( [
    fhir:code [ fhir:v "ReferredToOutreach" ] ;
    fhir:display [ fhir:v "Referred to Outreach" ] ;
    fhir:definition [ fhir:v "The participant has been referred to outreach services." ]
      ] [
    fhir:code [ fhir:v "ServiceGiven" ] ;
    fhir:display [ fhir:v "Service Given" ] ;
    fhir:definition [ fhir:v "All required services have been completed for the participant, and the process is now awaiting clinical results (e.g. all required vaccinations have been administered, but waiting for the clinical record to be received)" ]
      ] [
    fhir:code [ fhir:v "ServiceDeclined" ] ;
    fhir:display [ fhir:v "Service Declined" ] ;
    fhir:definition [ fhir:v "All required services have been declined by the participant. (e.g. all required vaccinations have been declined)" ]
      ] [
    fhir:code [ fhir:v "ServiceGivenDeclined" ] ;
    fhir:display [ fhir:v "Service Given/Declined" ] ;
    fhir:definition [ fhir:v "All required services have either been completed or declined by the participant (e.g. all required vaccinations have been given or declined)" ]
      ] [
    fhir:code [ fhir:v "ClinicalRecordReceived" ] ;
    fhir:display [ fhir:v "Clinical record received" ] ;
    fhir:definition [ fhir:v "The relevant clinical record has been received, and outreach is no longer required." ]
      ] [
    fhir:code [ fhir:v "ClinicalRecordCollected" ] ;
    fhir:display [ fhir:v "Clinical record collected" ] ;
    fhir:definition [ fhir:v "Documentation confirms the participant has previously received the required services." ]
      ] [
    fhir:code [ fhir:v "ReturningToProvider" ] ;
    fhir:display [ fhir:v "Returning to provider" ] ;
    fhir:definition [ fhir:v "The participant has indicated a preference to receive services from an existing provider (e.g. GP, Iwi, or Hauora)." ]
      ] [
    fhir:code [ fhir:v "ProgrammeToBeCompleted" ] ;
    fhir:display [ fhir:v "Programme to be completed" ] ;
    fhir:definition [ fhir:v "The participant will continue with outreach services until programme completion." ]
      ] [
    fhir:code [ fhir:v "ProgrammeStatusChanged" ] ;
    fhir:display [ fhir:v "Programme status changed" ] ;
    fhir:definition [ fhir:v "The participant's programme status has changed to 'Unenrolled' or 'Withdrawn'." ]
      ] [
    fhir:code [ fhir:v "CorrespondenceStatusChanged" ] ;
    fhir:display [ fhir:v "Correspondence status changed" ] ;
    fhir:definition [ fhir:v "The participant has opted out of programme correspondence for reasons that preclude outreach engagement (e.g. illness, terminal diagnosis)." ]
      ] [
    fhir:code [ fhir:v "DeclinedOutreachServices" ] ;
    fhir:display [ fhir:v "Declined outreach services" ] ;
    fhir:definition [ fhir:v "The participant has declined engagement with outreach services." ]
      ] [
    fhir:code [ fhir:v "UnableToContact" ] ;
    fhir:display [ fhir:v "Unable to contact" ] ;
    fhir:definition [ fhir:v "Outreach has been unable to contact the participant despite multiple attempts." ]
      ] [
    fhir:code [ fhir:v "MovedOutOfArea" ] ;
    fhir:display [ fhir:v "Moved out of area" ] ;
    fhir:definition [ fhir:v "The participant no longer resides within the region supported by the outreach provider." ]
      ] [
    fhir:code [ fhir:v "GoneOverseas" ] ;
    fhir:display [ fhir:v "Gone Overseas" ] ;
    fhir:definition [ fhir:v "It has been confirmed that the participant is no longer residing in New Zealand." ]
      ] [
    fhir:code [ fhir:v "UnconfirmedOverseas" ] ;
    fhir:display [ fhir:v "Unconfirmed Overseas" ] ;
    fhir:definition [ fhir:v "Investigations suggest that the participant is no longer residing in New Zealand." ]
      ] [
    fhir:code [ fhir:v "Deceased" ] ;
    fhir:display [ fhir:v "Deceased" ] ;
    fhir:definition [ fhir:v "It has been confirmed that the participant is deceased, any open outreach service requests to be revoked with a status reason of 'Deceased'." ]
      ] [
    fhir:code [ fhir:v "UnconfirmedDeceased" ] ;
    fhir:display [ fhir:v "Unconfirmed deceased" ] ;
    fhir:definition [ fhir:v "Investigations suggest that the participant may be deceased." ]
      ] [
    fhir:code [ fhir:v "NoLongerOverdue" ] ;
    fhir:display [ fhir:v "No longer overdue" ] ;
    fhir:definition [ fhir:v "The participant is no longer considered overdue for the condition that initiated the outreach request." ]
      ] [
    fhir:code [ fhir:v "OnHold" ] ;
    fhir:display [ fhir:v "On Hold" ] ;
    fhir:definition [ fhir:v "The outreach request has been temporarily suspended and may resume in the future." ]
      ] [
    fhir:code [ fhir:v "EnteredInError" ] ;
    fhir:display [ fhir:v "Entered in error" ] ;
    fhir:definition [ fhir:v "The service request was created in error and is to be formally revoked." ]
      ] ) . #