...

1. This WS is designed to create approval on entity, which aggregate other entities (episode_of_care, diagnostic_report, care_plan), OR forbidden group OR diagnoses group, OR on service_request including it’s permitted_resources OR on cancel for encounter, specimen and procedure.

2. Approvals are processed in the async way

3. Only authenticated and authorized employees with appropriate scope can create approval.

Specification

1. API Create Approval

Authorize

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 = 'approval:create ')

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

...

1. if episode_of_care is presented in request as the code of resource

   1. Check episode_of_care in the request exists and is in active or closed status in DB

      1. in case of error return - 422 (Episode is canceled)

   2. Check if resource from granted_to = 'employee':

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

2. if diagnostic_report is presented in request as the code of resource

   1. Check diagnostic_report block in the request exists and is in final status in DB

      1. in case of error return - 422 (Diagnostic report in \"entered_in_error\" status can not be referenced or Diagnostic report with such id is not found)

   2. Check if resource from granted_to = 'employee':

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

3. if care_plan is presented in request as the code of resource

   1. Check care_plan in the request exists in DB

      1. in case of error return - 422 (Care plan with such id is not found)

   2. Check there no other objects in request

      1. in case of error return - 422 (Approval for care plan can not contain other entities)

   3. Check if resource from granted_to = 'employee':

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

   4. If access_level = 'write':

      1. Check if care_plans.managing_organization = granted_to.employees.legal_entity_id:

         1. in case of error return - 422 ('User is not allowed to write care plan from another legal_entity')

4. if encounter  is presented in request as the code of resource

   1. Check encounter in the request exists in DB and is not in “entered_in_error” status in DB

      1. (Encounter in \"entered_in_error\" status can not be referenced or Encounter with such id is not found)

   2. Check if resource from granted_to = 'employee':

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

5. if procedure is presented in request as the code of resource

   1. Check procedure in the request exists in DB and is not in “entered_in_error” status in DB

      1. in case of error return - 422 (Procedure in \"entered_in_error\" status can not be referenced)

   2. Check if resource from granted_to = 'employee':

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

6. if specimen is presented in request as the code of resource

   1. Check specimen in the request exists in DB and is notin “entered_in_error” status in DB

      1. in case of error return - 422 (Specimen  in \"entered_in_error\" status can not be referencedInvalid specimen status)

   2. Check if resource from granted_to = 'employee':

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

Validate service_request

1. If service_request block is presented in request

   1. Get Service_request details (only in active status)

   2. use Response.permitted_resources as resources for approval(could be episode or diagnostic_report).

2. If resource from granted_to = 'legal_entity':

   1. Check if status of legal_entity in (ACTIVE, SUSPENDED, REORGANIZED):

      1. in case of error return - 422 (Legal entity should be active)

...

1. Validate that access_level correspond to granted_resources:

   1. In case error return 422 ("Resource types [\"$.granted_resources[].code\"] not allowed to use write access_level")

2. If employee_type of granted_to.identifier.value employee == ASSISTANT:

   1. Check that access_level == ‘read’:

      1. In case error return 422 ("Role ASSISTANT is not allowed to use write access_level for approval")

...

...