Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.5 - release
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
| Official URL: https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-service-request-status-reason-valueset | Version: 1.0.0 | |||
| Active as of 2026-07-20 | Computable Name: ServiceRequestStatusReason | |||
Each code represents the type of referral request
References
https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-service-request-status-reason-codes version 📦0.4.5
Expansion performed internally based on codesystem Status Reason for ServiceRequest v0.4.5 (CodeSystem)
This value set contains 20 concepts
| System | Code | Display (en) | Definition | JSON | XML |
https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-service-request-status-reason-codes | ReferredToOutreach | Referred to Outreach | The participant has been referred to outreach services. | ||
https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-service-request-status-reason-codes | ServiceGiven | Service Given | 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) | ||
https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-service-request-status-reason-codes | ServiceDeclined | Service Declined | All required services have been declined by the participant. (e.g. all required vaccinations have been declined) | ||
https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-service-request-status-reason-codes | ServiceGivenDeclined | Service Given/Declined | All required services have either been completed or declined by the participant (e.g. all required vaccinations have been given or declined) | ||
https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-service-request-status-reason-codes | ClinicalRecordReceived | Clinical record received | The relevant clinical record has been received, and outreach is no longer required. | ||
https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-service-request-status-reason-codes | ClinicalRecordCollected | Clinical record collected | Documentation confirms the participant has previously received the required services. | ||
https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-service-request-status-reason-codes | ReturningToProvider | Returning to provider | The participant has indicated a preference to receive services from an existing provider (e.g. GP, Iwi, or Hauora). | ||
https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-service-request-status-reason-codes | ProgrammeToBeCompleted | Programme to be completed | The participant will continue with outreach services until programme completion. | ||
https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-service-request-status-reason-codes | ProgrammeStatusChanged | Programme status changed | The participant's programme status has changed to 'Unenrolled' or 'Withdrawn'. | ||
https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-service-request-status-reason-codes | CorrespondenceStatusChanged | Correspondence status changed | The participant has opted out of programme correspondence for reasons that preclude outreach engagement (e.g. illness, terminal diagnosis). | ||
https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-service-request-status-reason-codes | DeclinedOutreachServices | Declined outreach services | The participant has declined engagement with outreach services. | ||
https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-service-request-status-reason-codes | UnableToContact | Unable to contact | Outreach has been unable to contact the participant despite multiple attempts. | ||
https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-service-request-status-reason-codes | MovedOutOfArea | Moved out of area | The participant no longer resides within the region supported by the outreach provider. | ||
https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-service-request-status-reason-codes | GoneOverseas | Gone Overseas | It has been confirmed that the participant is no longer residing in New Zealand. | ||
https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-service-request-status-reason-codes | UnconfirmedOverseas | Unconfirmed Overseas | Investigations suggest that the participant is no longer residing in New Zealand. | ||
https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-service-request-status-reason-codes | Deceased | Deceased | It has been confirmed that the participant is deceased, any open outreach service requests to be revoked with a status reason of 'Deceased'. | ||
https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-service-request-status-reason-codes | UnconfirmedDeceased | Unconfirmed deceased | Investigations suggest that the participant may be deceased. | ||
https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-service-request-status-reason-codes | NoLongerOverdue | No longer overdue | The participant is no longer considered overdue for the condition that initiated the outreach request. | ||
https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-service-request-status-reason-codes | OnHold | On Hold | The outreach request has been temporarily suspended and may resume in the future. | ||
https://fhir-ig.digital.health.nz/shared-care/CodeSystem/hnz-service-request-status-reason-codes | EnteredInError | Entered in error | The service request was created in error and is to be formally revoked. |
Explanation of the columns that may appear on this page:
| Level | A few code lists that FHIR defines are hierarchical - each code is assigned a level. In this scheme, some codes are under other codes, and imply that the code they are under also applies |
| System | The source of the definition of the code (when the value set draws in codes defined elsewhere) |
| Code | The code (used as the code in the resource instance) |
| Display | The display (used in the display element of a Coding). If there is no display, implementers should not simply display the code, but map the concept into their application |
| Definition | An explanation of the meaning of the concept |
| Comments | Additional notes about how to use the code |