Cancel Referral
Whilst the trigger for some cancellations (and the reason for cancellation) can be determined automatically by a source system, many may need to be triggered with manual intervention – for example where the Patient's condition has deteriorated, they are making their own arrangements, the referral was sent in error, etc.
A structured notification in these circumstances, enables social care providers to automatically update their case management systems, so that hey do not waste resources assessing and setting up care for patient who no longer require it.
Where the referral has an associated Assessment Notice, cancelling the referral will also withdraw that notice (Note: it is not possible to withdraw an assessment notice without cancelling the referral)
HTTPS Request
Method:
PUT
Request URL:
The request URL will consist of 'https
Host Environments:
The Host URLs will determined by the service provider, for example the host URLs for the Nottinghamshire County Council Social Care Data Service are:
Environment | Host |
---|---|
Test | health-interoperability-test.nottscc.gov.uk |
Live | health-interoperability.nottscc.gov.uk |
Base URL:
/ReferralService/v3/Encounter
Query String /Parameters:
Name | Value |
---|---|
identifier | The identifier as per Encounter the asscoiated ReferralRequest, in the format {identifier.system |identifier.value} |
Example Request Url:
https
Request Body:
The Request body should be in either json or xml format
The primary base FHIR resource is a CareConnect-SHD-Encounter-1 with references to other resources as per the Entity Relationship Model below:
See Examples for an illustration of the Request body of a typical Referral to Social Care for a Supported Hospital Discharge.
Response
Success
SHALL return a HTTP status code 200
OK on successful execution of the request
Error
An Error SHALL return one of the following HTTP Status Codes and an OperationOutcome with details of the issue:
HTTP Code | Display | Description |
---|---|---|
400 |
Bad Request | Poor Syntax or breaks a core FHIR constraint |
401 |
Unauthorized | User is not authorised to perform the request. |
403 |
Forbidden | The request is forbidden, authorization will not help. |
409 |
Conflict | User has requested to create a resource that already exists. |
422 |
Unprocessable Entity | The syntax is valid, but cannot be processed, e.g. breaks a business rule. |
500 |
Internal Error | The server encountered an unexpected condition which prevented it from fulfilling the request. |
JSON example of an OperationOutcome for a Unprocessable Entity
XML example of an OperationOutcome for a 422
Unprocessable Entity
Profiles
The Refer Patient (to Social Care for Supported Hospital Discharge) Use Care is supported by the following profiles
StructureDefinition | Version |
---|---|
CareConnect-SHD-Encounter-1 | 0.0.1 |
CareConnect-SHD-Location-1 | 0.0.1 |
CareConnect-SHD-Organization-1 | 0.0.1 |
CareConnect-SHD-Practitioner-1 | 0.0.1 |
Extensions | Version |
---|---|
Extension-SHD-MedicallyFitDetails | 0.0.1 |
Extension-SHD-EncounterStatusChangeReason | 0.0.1 |
ValueSets | Version |
---|---|
Supported Hospital Discharge Medically Fit Status | 0.0.1 |
Supported Hospital Discharge Referral Cancellation Reason | 0.0.1 |
CodeSystems | Version |
---|---|
Supported Hospital Discharge Medically Fit Status | 0.0.1 |
Supported Hospital Discharge Referral Cancellation Reason | 0.0.1 |
ConceptMap | Version |
---|---|
ConceptMap-SHD-Cancellation Reason | 0.0.1 |
Rules and Mappings
The generic business context data mappings for the 'Madatory' and 'Must Support' elements are detailed in the Profiles section, however the section below deatils any specific rules or contrains that apply to this use case.
Pre-requisites
The patient MUST have an Active Referral Request The patient NO LONGER requires the Social Care provider with the open referral to support the Hospital Discharge
Data Mappings
CareConnect-SHD-Encounter-1
FHIR Element | Card. | Type | Description/Business Context |
---|---|---|---|
Encounter.status | 1..1 | code | Encounter.status SHALL be "cancelled" |
Encounter.statusHistory | 1..* | BackboneElement | Status History is SHALL be provided for the previous "in-progress" state on update where Encounter.status="cancelled", where Encounter.statusHistory.period.end = Actual Discharge Date |
Encounter.statusHistory.extension |
1..1 | Extension | SHALL be provided where Encounter.status="cancelled". |
Encounter.statusHistory.extension |
1..1 | code | SHALL be provided Binding Supported Hospital Discharge Referral Cancellation Reason |
Encounter.statusHistory.extension |
0..1 | string | Constraint: MUST be provided if reason = 'Other' (i.e. Encounter. |
Encounter.period.end | 1..1 | dateTime | SHALL be provided where Encounter.status="cancelled", and in which case the Encounter.period.end will relate to the Cancellation Date. |
Examples
Request Body
JSON example of a CareConnect-SHD-Encounter-1
XML example of a CareConnect-SHD-Encounter-1