Purpose

This WS is designed to revoke previously created Device request.

This method must be used to revoke existing Device Request. Method receives signed message (pkcs7) that consists of signed content, digital signature and signer public key. All signature fields will be validated (including signer certificate authority)

Specification

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 of MPI

   1. 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. Get person's authentication_method according to logic:

   1. If inform_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: Check confidant person relationship 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 inform_with

   2. If inform_with does not exist in device request or is empty - get default authentication_method of person from MPI using logic Determination of a default authentication method and return person's active auth_methods

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

   1. Check if sms notifications are enabled and generate template:

      1. if device_request and has a program specified

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

         2. if device_request is for assistive device (device_request.code OR at least one classification type of device_request.code_reference is in dictionary configuration “assistive_devices”) generate SMS text with template REVOKE_ASSISTIVE_DEVICE_REQUEST_SMS_TEMPLATE

         3. else generate text SMS with template REVOKE_DEVICE_REQUEST_SMS_TEMPLATE.

      2. if device_request has no program specified

         1. if device_request is for assistive device (device_request.code OR at least one classification type of device_request.code_reference is in dictionary configuration “assistive_devices”)

            1. check that ASSISTIVE_DEVICE_REQUESTS_SMS_ENABLED is set in true

            2. generate text SMS with template REVOKE_ASSISTIVE_DEVICE_REQUEST_SMS_TEMPLATE

         2. else check config parameter DEVICE_REQUESTS_SMS_ENABLED is set in true

            1. generate text SMS with template REVOKE_DEVICE_REQUEST_SMS_TEMPLATE.

      3. Send SMS

6. Save internal information to corresponding DB.

7. Send StatusChangeEvent to Event Manager

Request structure

See on Apiary

Example:

Authorize

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)

4. If BLOCK_UNVERIFIED_PARTY_USERS is true, then check party's data match following condition: verification_status != NOT_VERIFIED or (verification_status = NOT_VERIFIED and updated_at > current_date - UNVERIFIED_PARTY_PERIOD_DAYS_ALLOWED):

   • in case not match - return 403 ("Access denied. Party is not verified")

5. If BLOCK_DECEASED_PARTY_USERS is true, check that party is not deceased (party_verification record does not equal to: dracs_death_verification_status = VERIFIED and dracs_death_verification_reason = MANUAL_CONFIRMED):

   • in case of error - return 403 ("Access denied. Party is deceased")

Headers

• Content-Type:application/json

• Authorization:Bearer mF_9.B5f-4.1JqM

• api-key:aFBLVTZ6Z2dON1V

Request data validation

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 user

Revoking a Device Request is allowed for a user if he has one of the following active and approved employee that:

• is an Employee from legal entity where Device Request is created

  • in case of error - return 409 ("Only an employee from legal entity where device request is created can revoke device request")

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/CSI/pages/17467441235 .

Validate revoked reason

1. Validate $.status_reason.code is a value from eHealth/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')

Response structure

See on Apiary

Example:

HTTP status codes