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

Active as of 2026-03-03

Raw xml | Download

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