Required parameters are marked with "*"

...

Purpose*

Required parameters are marked with "*"

Якщо інформації по відповідному параметру немає, потрібно зазначити: “APIparagraph not found”.

Purpose*

This WS allows to get detailed episode info from Admin panel.

...

• Verify the validity of access token

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

• Verify that token is not expired

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

• Check user scopes in order to perform this action (scope = 'episode:practical_monitor')

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

• Check user has access to resource according to @rule @rule_-2in ABAC

  • return 403 (“Access denied. Justification required“) in case of error

Request to process the request using a token in the headers

Headers*

Наприклад:

• Content-Type:application/json

• Authorization:Bearer mF_9.B5f-4.1JqM

...

• Extract client_id from token.

• Check client scopes in order to perform this action (scope = 'episode:practical_monitor')

  • in case of error - return 403 (“Your scope does not allow to access this resource. Missing allowances: episode: episode:monitor”)

• Check legal entity status (status = ACTIVE)

  • In case of error - return 409 ('client_id refers to legal entity that is not active')

Validate request

• Check required personId submitted.

  • return 404 (“not found“) in case not exist

• Check required episode Id submitted.

  • return 404 (“not found“) in case not exist or not related to person

  • return 403 (“Access denied“) in case episode has forbidden group items. Take into account approvals granted to NHS employee on forbidden groups (look at Medical Events filtration by Forbidden groups for details)monitor”)

• Check legal entity status (status = ACTIVE)

  • In case of error - return 409 ('client_id refers to legal entity that is not active')

Validate request

• Check required personId submitted.

  • return 404 (“not found“) in case not exist

• Check required episode Id submitted.

  • return 404 (“not found“) in case not exist or not related to person

  • return 403 (“Access denied“) in case episode has forbidden group items. Take into account approvals granted to NHS employee on forbidden groups (look at Medical Events filtration by Forbidden groups for details)

Validate token

• Verify the validity of access token

  • Return 401 in case validation fails

• Verify token is not expired

  • in case error return 401 

Validate scopes

• Check user scopes in order to perform this action (scope = 'episode:read')

  1. Return 403 in case invalid scope(s)

Access to the resource is also managed by ABAC module.

Processing*

Service logic

1. Get episode by id and patient_id

2. Render detailed episode data according to schema

...