RC_CSI-2483_Complete Device request

Purpose

This WS is designed to complete previously created Device request. Only active device request that has no quantity specified, can be completed.

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 = 'device_request:complete')

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

Validations

Validate request

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 device request

1. Validate that submitted device request relates to the patient (from URL)

   • in case of error return 404 "device request is not found"

2. Validate Device request has no quantity specified

   1. in case of error return 409 "Device request with quantity can not be completed" 

Validate transition

1. Get current device request status

   1. Check that status in ('active')

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

For more information look at https://e-health-ua.atlassian.net/wiki/spaces/RMDN/pages/17670799503

Service logic

1. Update device request status to completed (update also updated_at, updated_by)

2. Get person's authentication_method according to logic:

   1. If authorize_with exists in device request and is not empty, check:

      1. Authentication method exists in person_authentication_methods table in MPI DB (with is_active=true), is active (ended_at > now() or null)

      2. Get value of THIRD_PERSON_CONFIDANT_PERSON_RELATIONSHIP_CHECK config parameter, if it is set to true - for authentication method with type = THIRD_PERSON check that person from value is an approved confidant for a person from device request – exists active and approved confidant person relationship between person from request and confidant_person_id from authentication method value (using following logic https://e-health-ua.atlassian.net/wiki/spaces/CSI/pages/17667883028 with person_id = person from request and confidant_person_id = value from auth method - expected :ok, :approved response)

         1. in case any validation failed - do not send SMS to person

         2. else - get authentication_method from authorize_with

   2. If authorize_with does not exist in device request or is empty - get default authentication_method of person from MPI using logic https://e-health-ua.atlassian.net/wiki/spaces/CSI/pages/17613029453

3. If authentication_method == OTP or THIRD_PERSON (with OTP) :

   1. Check if sms notifications are enabled:

      1. check config parameter DEVICE_REQUESTS_SMS_ENABLED is set in true

         1. else return an error 409 “Action is disabled by the configuration”

      2. Generate text SMS with template COMPLETE_DEVICE_REQUEST_SMS_TEMPLATE.

      3. Send SMS

4. Save internal information to corresponding DB

5. Send StatusChangeEvent to the Event Manager