Share Needs Assessment(s) / CHC Checklist
To support the referral for a supported discharge, health may send through additional documentation to provide third parties more information about the patient's competencies, needs, risks etc.
The API currently enables the sharing of structured content of the following
- Preliminary Needs Assessment
- COVID-19 Assessment
- CHC Checklist
Note: Sharing of content of each of the above types would need to be shared as seperate requests. For example if both the 'Preliminary Needs Assessment' and the 'COVID-19 Assessment' details changed, then two HTTPS requests would be required.
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 will depend on the data that is being sahred/updated, i.e.:
- SHD-QuestionnaireResponse-PreliminaryNeedsAssessment
- SHD-QuestionnaireResponse-COVID19
- SHD-QuestionnaireResponse-CHCChecklist
See Examples for an illustration of the Request body of a typical QuestionnaireResponse for Sharing a Needs Assessment / CHC Checklist
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 400
Bad Request
XML example of an OperationOutcome for a 400
Bad Request
Profiles
The Share Needs Assessment(s) / CHC Checklist Use Care is supported by the following profiles
StructureDefinition | Version |
---|---|
SHD-QuestionnaireResponse-PreliminaryNeedsAssessment | 0.0.1 |
SHD-QuestionnaireResponse-COVID19 | 0.0.1 |
SHD-QuestionnaireResponse-CHCChecklist | 0.0.1 |
Extensions | Version |
---|---|
None |
ValueSets | Version |
---|---|
NHS Continuing Healthcare Checklist Domain Level Score | 0.0.1 |
NHS Continuing Healthcare Checklist Outcome | 0.0.1 |
CodeSystems | Version |
---|---|
NHS Continuing Healthcare Checklist Domain Level Score | 0.0.1 |
NHS Continuing Healthcare Checklist Outcome | 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:
Data Mappings
SHD-QuestionnaireResponse-PreliminaryNeedsAssessment
FHIR Element | Card. | Type | Description/Business Context |
---|---|---|---|
QuestionnaireResponse.basedOn | 1..1 | Reference (CareConnect-SHD-ReferralRequest-1) | Reference to the ReferralRequest the Preliminary Needs Assessment relates to SHALL be provided when sent after the ReferralRequest.Note: Absolute or Relative referencing is supported, however QuestionnaireResponse.basedOn.reference value MUST be the same as the based-on Parameter Value in the request url. |
QuestionnaireResponse.status | 1..1 | code | Create a Preliminary Needs Assessment: status=completedUpdate a Preliminary Needs Assessment: status=amended |
SHD-QuestionnaireResponse-COVID19
FHIR Element | Card. | Type | Description/Business Context |
---|---|---|---|
QuestionnaireResponse.basedOn | 1..1 | Reference (CareConnect-SHD-ReferralRequest-1) | Reference to the ReferralRequest the COVID-19 Assessment relates to SHALL be provided when sent after the ReferralRequest.Note: Absolute or Relative referencing is supported, however QuestionnaireResponse.basedOn.reference value MUST be the same as the based-on Parameter Value in the request url. |
QuestionnaireResponse.status | 1..1 | code | Create a COVID-19 Assessment: status=completedUpdate a COVID-19 Assessment: status=amended |
SHD-QuestionnaireResponse-CHCChecklist
FHIR Element | Card. | Type | Description/Business Context |
---|---|---|---|
QuestionnaireResponse.basedOn | 1..1 | Reference (CareConnect-SHD-ReferralRequest-1) | Reference to the ReferralRequest the CHC Checklist relates to SHALL be provided when sent after the ReferralRequest.Note: Absolute or Relative referencing is supported, however QuestionnaireResponse.basedOn.reference value MUST be the same as the based-on Parameter Value in the request url. |
QuestionnaireResponse.status | 1..1 | code | Create a CHC Checklist: status=completedUpdate a CHC Checklist: status=amended |
Examples
Request Body
JSON example of a SHD-QuestionnaireResponse-PreliminaryNeedsAssessment
XML example of a SHD-QuestionnaireResponse-PreliminaryNeedsAssessment