| Table of Contents | ||||
|---|---|---|---|---|
|
Required parameters are marked with "*"
...
Purpose*
This WS allows to get detailed encounter info from Admin panel.
Specification*
...
Link
...
...
Resource
...
/api/patients/{{patient_id}}/encounters/{{encounter_id}}
...
Scope
...
encounter:read
...
Components
...
Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription
...
Microservices
...
Перелік мікросервісів, які використовує метод API. Наприклад: Auth, ABAC
...
Protocol type
...
Тип протоколу, який використовується запитом, наприклад: SOAP | REST
...
Request type
...
GET
...
Sync/Async
...
Метод є синхронним чи асинхронним?
Logic*
Get encounter by id and patient id
Render detailed encounter data according to schema
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 /wiki/spaces/AFC/pages/16680386561 for monitoring exists for current user and corresponding patient (ABAC rule_-2).
Input parameters
...
Input parameter
...
Values
...
Type
| Table of Contents | ||||
|---|---|---|---|---|
|
Required parameters are marked with "*"
Якщо інформації по відповідному параметру немає, потрібно зазначити: “APIparagraph not found”.
Purpose*
Specification*
| Page Properties | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Logic*
Input parameters
Input parameter | Values | Type | Description | Example |
|---|---|---|---|---|
patient_id | String | Patient identifier |
| |
encounter_id | String | Encounter identifier |
|
...
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 = 'encounter:practical_monitor')
return 403 (“Your scope does not allow to access this resource. Missing allowances: encounter:practical_monitor”) in case of invalid scope(s)
Check user has access to resource according to @rule_-2 in 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
Request data validation*
Validate legal entity
Extract client_id from token.
Check client scopes in order to perform this action (scope = 'encounter:practical_monitor')
in case of error - return 403 (“Your scope does not allow to access this resource. Missing allowances: encounter:practical_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 encounter Id submitted.
...
return 404 (“not found“) in case not exist or not related to the person
...
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*
Processing*
API paragraph not found
...