Required parameters are marked with "*"

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

Purpose*

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

...

Specification*

...

API paragraph not found

Key points

1. This is a graphQl query used in Administration panel only

2. Only authenticated and authorized NHS employee with appropriate scope can get episode details.

3. Query returns single episode by person (mpi id) and episode identifier.

4. Filtration with forbidden group items is worked here. So NHS employee should have an approval from patient to see an episode with forbidden elements.

5. Query should be invoked only if Justification for monitoring exists for current user and corresponding patient (ABAC rule_-2).

Input parameters

...

Request to process the request using a token in the headers

Headers*

Наприклад:

• Content-Type:application/json

• Authorization:Bearer mF_9.B5f-4.1JqM

...

• 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

Response structure*

See on Apiary

...