Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.1 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.1 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Active as of 2025-03-30 |
<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><a name="hnz-service-request-status-reason-codes-en-NZ"> </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 consumer has been referred to outreach.</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 services have been given to the consumer (e.g. all required vaccinations have been administered)</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 services have been declined by the consumer (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 services have been given/declined by the consumer (e.g. all required vaccinations have been given or declined)</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 consumer has declined to engaged with outreach 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 consumer would prefer to get their service from their existing provider (GP/Iwi/Hauora).</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 identified the consumer is no longer living in NZ.</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>After numerous attempts Outreach have not been able to locate or make contact with the consumer.</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 have identified that the consumer is deceased.</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>Investigations have identified the consumer is no longer living in the area/region supported by the outreach provider.</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 consumer will stay with outreach services until they complete their service programme.</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>Proof has been supplied that the consumer has previously received the overdue/due services.</td></tr><tr><td style="white-space:nowrap">Deceased<a name="hnz-service-request-status-reason-codes-Deceased"> </a></td><td>Deceased</td><td>When a consumer is confirmed deceased any open outreach service requests to be revoked with a status reason of 'Deceased'.</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 entered in error and is to be revoked.</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 expected clinical record (Test result of Clinical Event) has been received in the register and outreach is no longer required</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 either 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 requested no correspondence from the programme and the reason is one that excludes outreach services e.g. Cancer, Unwell</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 service request is on hold for a period of time.</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.1"/>
<name value="ServiceRequestStatusReasonCodes"/>
<title value="Status Reason for ServiceRequest"/>
<status value="active"/>
<experimental value="false"/>
<date value="2025-03-30T22:36:07+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="David Grainger"/>
<telecom>
<system value="email"/>
<value value="david.grainger@middleware.co.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 Task record to populate with the appropriate status reason."/>
<caseSensitive value="true"/>
<content value="complete"/>
<count value="18"/>
<concept>
<code value="ReferredToOutreach"/>
<display value="Referred to Outreach"/>
<definition value="The consumer has been referred to outreach."/>
</concept>
<concept>
<code value="ServiceGiven"/>
<display value="Service Given"/>
<definition
value="All services have been given to the consumer (e.g. all required vaccinations have been administered)"/>
</concept>
<concept>
<code value="ServiceDeclined"/>
<display value="Service Declined"/>
<definition
value="All services have been declined by the consumer (e.g. all required vaccinations have been declined)"/>
</concept>
<concept>
<code value="ServiceGivenDeclined"/>
<display value="Service Given/Declined"/>
<definition
value="All services have been given/declined by the consumer (e.g. all required vaccinations have been given or declined)"/>
</concept>
<concept>
<code value="DeclinedOutreachServices"/>
<display value="Declined outreach services"/>
<definition
value="The consumer has declined to engaged with outreach services"/>
</concept>
<concept>
<code value="ReturningToProvider"/>
<display value="Returning to provider"/>
<definition
value="The consumer would prefer to get their service from their existing provider (GP/Iwi/Hauora)."/>
</concept>
<concept>
<code value="GoneOverseas"/>
<display value="Gone Overseas"/>
<definition
value="It has been identified the consumer is no longer living in NZ."/>
</concept>
<concept>
<code value="UnableToContact"/>
<display value="Unable to contact"/>
<definition
value="After numerous attempts Outreach have not been able to locate or make contact with the consumer."/>
</concept>
<concept>
<code value="UnconfirmedDeceased"/>
<display value="Unconfirmed deceased"/>
<definition
value="Investigations have identified that the consumer is deceased."/>
</concept>
<concept>
<code value="MovedOutOfArea"/>
<display value="Moved out of area"/>
<definition
value="Investigations have identified the consumer is no longer living in the area/region supported by the outreach provider."/>
</concept>
<concept>
<code value="ProgrammeToBeCompleted"/>
<display value="Programme to be completed"/>
<definition
value="The consumer will stay with outreach services until they complete their service programme."/>
</concept>
<concept>
<code value="ClinicalRecordCollected"/>
<display value="Clinical record collected"/>
<definition
value="Proof has been supplied that the consumer has previously received the overdue/due services."/>
</concept>
<concept>
<code value="Deceased"/>
<display value="Deceased"/>
<definition
value="When a consumer is confirmed deceased any open outreach service requests to be revoked with a status reason of 'Deceased'."/>
</concept>
<concept>
<code value="EnteredInError"/>
<display value="Entered in error"/>
<definition
value="The service request was entered in error and is to be revoked."/>
</concept>
<concept>
<code value="ClinicalRecordReceived"/>
<display value="Clinical Record received"/>
<definition
value="The expected clinical record (Test result of Clinical Event) has been received in the register and outreach is no longer required"/>
</concept>
<concept>
<code value="ProgrammeStatusChanged"/>
<display value="Programme status changed"/>
<definition
value="The participant's programme status has changed to either Unenrolled or Withdrawn"/>
</concept>
<concept>
<code value="CorrespondenceStatusChanged"/>
<display value="Correspondence status changed"/>
<definition
value="The participant has requested no correspondence from the programme and the reason is one that excludes outreach services e.g. Cancer, Unwell"/>
</concept>
<concept>
<code value="OnHold"/>
<display value="On Hold"/>
<definition
value="The outreach service request is on hold for a period of time."/>
</concept>
</CodeSystem>