RC_(CSI-2483,CR-441)_Revoke Device request

Purpose

This WS is designed to revoke previously created Device 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 = 'device_request:revoke')

   • return 403 (“Your scope does not allow to access this resource. Missing allowances: device_request:revoke”) 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 digital signature

1. Validate request is signed

   1. in case of error - return 400 (“Invalid signed content”)

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“)

Validate transition

Only active device request can be revoked

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 revoked')

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

Validate status reason

1. Validate $.status_reason.code is a value from device_request_revoke_reasons dictionary

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

Validate status

The target status value must be submitted in the order of display in the signed content (media storage)

1. Validate $.status is revoked

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

Validate content

Signed content must match with device request in DB in order to be revoked

1. Render device request from DB

2. Exclude $status, $.status_reason from signed content

3. Compare rendered device request and signed content

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

Service logic

1. Save signed content to media storage

2. Update device request status to revoked (update also updated_at, updated_by)

3. 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

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

   1. Check if sms notifications are enabled:

      1. if device_request has a program specified

         1. check that the specified program has setting request_notification_disabled set in false or the setting is absent, else

            1. return an error 409 "Action is not allowed for the specified medical program"

      2. if device_request has no program specified

         1. check config parameter DEVICE_REQUESTS_SMS_ENABLED is set in true

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

      3. Generate text SMS with template REVOKE_DEVICE_REQUEST_SMS_TEMPLATE.

      4. Send SMS

5. Save internal information to corresponding DB

6. Send StatusChangeEvent to the Event Manager