Issue Discharge Notice
The discharge notice is a key status in the Supported Hospital Discharge to Social Care process – it identifies that the Patient is ready for discharge (i.e. medically fit AND all other activies either completed or on track) and confirms the date that the hospital is working to re discharge.
HTTPS Request
Method:
PUT (conditional update).
Alternatively, the first time the QuestionnaireResponse is shared a conditional create can be used using the POST MethodRequest 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/QuestionnaireResponse
Query String /Parameters:
Name | Value |
---|---|
based-on | ReferralRequest/{Referral ID} Note: Absolute or Relative referencing is supported, however Parameter Value MUST be the same as the QuestionnaireResponse.basedOn.reference value in the request body |
Example Request Url:
https
Request Body:
The Request body should be in either json or xml format
The primary base FHIR resource is a SHD-QuestionnaireResponse-DischargeNotice
See Examples for an illustration of the Request body of a typical Referral to Social Care for a Supported Hospital Discharge.
Response
Success
PUT SHALL return a HTTP status code 200
OK on successful execution of the request
Where a POST method used, SHALL return a HTTP status code 201
Created 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
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 MUST already have been issued an Assessment Notice for the referral
Data Mappings
SHD-QuestionnaireResponse-DischargeNotice
FHIR Element | Card. | Type | Description/Business Context |
---|---|---|---|
QuestionnaireResponse.basedOn | 1..1 | Reference (CareConnect-SHD-ReferralRequest-1) | Reference to the ReferralRequest the Assessment Notice relates to SHALL be provided when sent after the ReferralRequest.Note: Absolute or Relative referencing is supported |
QuestionnaireResponse.status | 1..1 | code | Create DN: status=completed Date Withdrawn & Withdrawal Reason should not be present Update existing DN (implicit withdrawal & reissue): status=amended Date Withdrawn & Withdrawal Reason must not be present Re-issue DN after withdrawal: status=amended Date Withdrawn & Withdrawal Reason must not be present |
QuestionnaireResponse.authored | 1..1 | DateTime | The date/time the Discharge Notice was actually issued/given to the Local Authority |
QuestionnaireResponse.item[withdrawalDate] | 0..0 | BackboneElement | Not Allowed on Create/Update/Re-issue a Discharge Notice |
QuestionnaireResponse.item[withdrawalReason | 0..0 | BackboneElement | Not Allowed on Create/Update/Re-issue a Discharge Notice |
QuestionnaireResponse.item[withdrawalOtherReasonDetail] | 0..0 | BackboneElement | Not Allowed on Create/Update/Re-issue a Discharge Notice |
Examples
Request Body
JSON example of a SHD-QuestionnaireResponse-DischargeNotice
XML example of a SHD-QuestionnaireResponse-DischargeNotice