RC_(CSI-2483,CR-441)_Resend SMS on Service request

Purpose

This WS is designed to resend sms with OTP-code to the person’s verified phone on service request in case OTP wasn’t delivered in first time.

Specification

Apiary

Key points

1. Only authenticated and authorized user with appropriate scope can resend SMS on Service Request.

2. SMS with OTP-code can be resend only to person with verification_type = OTP.

3. SMS with OTP-code can be resend only for Service Request in ‘ACTIVE' and program processing status ‘NEW’, ‘IN QUEUE’, ’IN_PROGRESS’.

4. It is possible to send an SMS using this API even if it wasn’t sent on Create Service request due to the performer being set or a technical error.

Logic

1. Search for service_request by patient_id + service_request_id

2. Validate Legal Entity

3. Check status of service_request

4. Send SMS to the person’s verified phone

Authorization

1. Verify the validity of access token

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

2. Verify that token is not expired

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

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

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

Input parameters

• patient_id - identifier of person

• service_request_id - identifier of service_request

Validate transition

1. Check if service request with service_request_id from request is exist

   1. in case of error - return 404 (“Not found”) in case of validation fails

2. Validate person

   1. Check if person with patient_id from request is exist

      1. in case of error - return 404 (“Not found”) in case of validation fails

   2. Check if person with patient_id from request is not preperson

      1. in case of validation fails skip all steps below

3. Validate legal entity

   1. Check that legal_entity_type is included in chart variables ME_ALLOWED_TRANSACTIONS_LE_TYPES config parameter

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

   2. Check that legal_entity has status = active

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

4. Validate service_request

   1. Check that status = ‘active' and ProgramProcessinStatus in (’new', ‘in_queue', ‘in_progress’)

      1. in case of error - return 409 error ('You can not resend SMS for service request in status %status%')

      2. in case of error - return 409 error ('You can not resend SMS for service request in program processing status %program_processing_status%')

Processing

1. If inform_with exists in service 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 service 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 - return 409 ('Authentication method doesn't exist or is inactive')

      2. else - get authentication_method from inform_with

2. If inform_with does not exist in service request or is empty - get person's authentication_method of MPI

3. If authentication_method == OTP - send SMS:

   1. Generate text SMS (call Man method- templates rendering service with template SERVICE_REQUEST_CREATE_SMS.

4. Send SMS

5. Save internal information to corresponding DB