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 |
{
"resourceType" : "CodeSystem",
"id" : "hnz-service-request-status-reason-codes",
"text" : {
"status" : "generated",
"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><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>"
},
"url" : "https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-service-request-status-reason-codes",
"version" : "0.4.1",
"name" : "ServiceRequestStatusReasonCodes",
"title" : "Status Reason for ServiceRequest",
"status" : "active",
"experimental" : false,
"date" : "2025-03-30T22:36:07+00:00",
"publisher" : "Te Whatu Ora",
"contact" : [
{
"name" : "Te Whatu Ora",
"telecom" : [
{
"system" : "url",
"value" : "https://www.tewhatuora.govt.nz/"
}
]
},
{
"name" : "David Grainger",
"telecom" : [
{
"system" : "email",
"value" : "david.grainger@middleware.co.nz",
"use" : "work"
}
]
}
],
"description" : "Each code represents the type of referral request",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "NZ",
"display" : "New Zealand"
}
]
}
],
"purpose" : "Enables a Task record to populate with the appropriate status reason.",
"caseSensitive" : true,
"content" : "complete",
"count" : 18,
"concept" : [
{
"code" : "ReferredToOutreach",
"display" : "Referred to Outreach",
"definition" : "The consumer has been referred to outreach."
},
{
"code" : "ServiceGiven",
"display" : "Service Given",
"definition" : "All services have been given to the consumer (e.g. all required vaccinations have been administered)"
},
{
"code" : "ServiceDeclined",
"display" : "Service Declined",
"definition" : "All services have been declined by the consumer (e.g. all required vaccinations have been declined)"
},
{
"code" : "ServiceGivenDeclined",
"display" : "Service Given/Declined",
"definition" : "All services have been given/declined by the consumer (e.g. all required vaccinations have been given or declined)"
},
{
"code" : "DeclinedOutreachServices",
"display" : "Declined outreach services",
"definition" : "The consumer has declined to engaged with outreach services"
},
{
"code" : "ReturningToProvider",
"display" : "Returning to provider",
"definition" : "The consumer would prefer to get their service from their existing provider (GP/Iwi/Hauora)."
},
{
"code" : "GoneOverseas",
"display" : "Gone Overseas",
"definition" : "It has been identified the consumer is no longer living in NZ."
},
{
"code" : "UnableToContact",
"display" : "Unable to contact",
"definition" : "After numerous attempts Outreach have not been able to locate or make contact with the consumer."
},
{
"code" : "UnconfirmedDeceased",
"display" : "Unconfirmed deceased",
"definition" : "Investigations have identified that the consumer is deceased."
},
{
"code" : "MovedOutOfArea",
"display" : "Moved out of area",
"definition" : "Investigations have identified the consumer is no longer living in the area/region supported by the outreach provider."
},
{
"code" : "ProgrammeToBeCompleted",
"display" : "Programme to be completed",
"definition" : "The consumer will stay with outreach services until they complete their service programme."
},
{
"code" : "ClinicalRecordCollected",
"display" : "Clinical record collected",
"definition" : "Proof has been supplied that the consumer has previously received the overdue/due services."
},
{
"code" : "Deceased",
"display" : "Deceased",
"definition" : "When a consumer is confirmed deceased any open outreach service requests to be revoked with a status reason of 'Deceased'."
},
{
"code" : "EnteredInError",
"display" : "Entered in error",
"definition" : "The service request was entered in error and is to be revoked."
},
{
"code" : "ClinicalRecordReceived",
"display" : "Clinical Record received",
"definition" : "The expected clinical record (Test result of Clinical Event) has been received in the register and outreach is no longer required"
},
{
"code" : "ProgrammeStatusChanged",
"display" : "Programme status changed",
"definition" : "The participant's programme status has changed to either Unenrolled or Withdrawn"
},
{
"code" : "CorrespondenceStatusChanged",
"display" : "Correspondence status changed",
"definition" : "The participant has requested no correspondence from the programme and the reason is one that excludes outreach services e.g. Cancer, Unwell"
},
{
"code" : "OnHold",
"display" : "On Hold",
"definition" : "The outreach service request is on hold for a period of time."
}
]
}