[AH] Recall Service Request v.2 [04.09.24]

Purpose

This WS is designed to recall previously created Service request.

Specification

Apiary

Authorization

1. Verify the validity of access token

   • in case of error - return 401 (“Invalid access token”) in case of validation fails

2. Verify that token is not expired

   • in case of error - return 401 (“Invalid access token”)

3. Check user scopes in order to perform this action (scope = 'service_request:recall')

   • return 403 (“Your scope does not allow to access this resource. Missing allowances: service_request:recall”) in case of invalid scope(s)

Validations

Validate request using JSON Schema

Return 422 with the list of validation errors in case validation fails

Validate legal entity

1. Check legal entity type: it has to be in me_allowed_transactions_le_types config parameter, has status = active and nhs_verified = true

   1. in case of error return 409 "Action is not allowed for the legal entity"

Validate digital signature

1. Validate request is signed

   1. in case of error - return 400 (“document must be signed by 1 signer but contains 0 signatures”)

2. Check DS is valid and not expired

3. Validate that DS belongs to the user

   1. Check that DRFO from DS and party.tax_id matches

      1. in case of error - return 422 (“Does not match the signer drfo“)

4. Ensure that $.requester.identifier.value matches with user employees

   1. Check if service request based on Care plan if not match:

      1. Determine at least one of the user employees has an active approval on write this Care plan 

         1. in case of error - return 409 ('Employees related to this party_id not in current MSP')

Validate transition

Only active service request can be recalled

1. Get current service request status

   1. Check that status in ('active')

      1. in case of error - return 409 error ('Service request in status %status% cannot be recalled')

Validate cancelation reason

1. Validate $.reject_reason_code is a value from eHealth/service_request_recall_reasons dictionary

   • in case of error - return 422 ("value is not allowed in enum")

Validate content

Signed content must match with service request in DB in order to be recalled

1. Render service request from DB

2. Exclude $.status_reason and $.explanatory_letter from signed content

3. Compare rendered service request and signed content

   1. In case both object doesn't match - return 422 ('Signed content doesn't match with previously created service request')

Service logic

1. Save signed content to media storage

2. Update service request status to recalled (update also updated_at, updated_by)

3. Write record to status history

4. Send SMS to patient (if authentication_method_current == SMS, do NOT send sms in case performer is present in SR)

5. Async! Revoke all approvals made by this service request

6. If the service request is based on activity with quantity:

   1. Recalculate and set remaining_quantity for the activity as described at RC._PreQualify Service Request_EN