• Purpose*

• Specification*

• Logic*

• Preconditions

• Global and configurable parameters

• Input parameters

• Filters

• Dictionaries

• Request structure*

• Authorize*

• Headers*

• Request data validation*

• Processing*

• Response structure*

• Post-processing processes*

• HTTP status codes*

• Backward compatibility

...

Specification

  "Reads a single `Episode` using its globally unique ID and person's mpi id."
  episode(personId: ID!, id: ID!): Episode

Logic*

1. Get episode by id and patient_id

2. Render detailed episode data according to schema

...

Request structure*

API paragraph not found

Specification

...

...

Authorize*

• 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_-2in ABAC

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

...

API paragraph not found

Request data validation*

Validate legal entity

• 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: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)

...