| Table of Contents | ||||
|---|---|---|---|---|
|
Purpose*
This WS allows to get detailed episode info from Admin panel.API paragraph not found
Specification*
| Page Properties | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
Logic*
API paragraph not found
Key points
This is a graphQl query used in Administration panel only
Only authenticated and authorized NHS employee with appropriate scope can get episode details.
Query returns single episode by person (mpi id) and episode identifier.
Filtration with forbidden group items is worked here. So NHS employee should have an approval from patient to see an episode with forbidden elements.
Query should be invoked only if Justification for monitoring exists for current user and corresponding patient (ABAC rule_-2).
Input parameters
...
Input parameter
...
Values
...
Type
...
Description
...
Example
...
patient_id
...
String
...
Patient identifier
...
70a9e15b-b71b-4caf-8f2e-ff247e8a5677
...
episode_id
...
String
...
Episode identifier
...
70a9e15b-b71b-4caf-8f2e-ff247e8a5677
Request structure*
API paragraph not found
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)
...
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
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
personIdsubmitted.return 404 (“not found“) in case not exist
Check required episode
Idsubmitted.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')
Return 403 in case invalid scope(s)
Access to the resource is also managed by ABAC module.
Processing*
Service logic
...
Get episode by id and patient_id
...
Input parameters
Input parameter | Values | Type | Description | Example |
|---|---|---|---|---|
patient_id | String | Patient identifier |
| |
episode_id | String | Episode identifier |
|
Request structure*
API paragraph not found
Authorize*
Request to process the request using a token in the headers
Headers*
Наприклад:
Content-Type:application/json
Authorization:Bearer mF_9.B5f-4.1JqM
Request data validation*
API paragraph not found
Processing*
API paragraph not found
Response structure*
See on Apiary
...