| Table of Contents | ||||
|---|---|---|---|---|
|
Required parameters are marked with "*"
Якщо інформації по відповідному параметру немає, потрібно зазначити: “APIparagraph not found”.
Purpose*
This WS allows to get detailed allergy intolerance 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 allergy intolerance details.
...
Query returns single allergy intolerance by person (mpi id) and allergy intolerance identifier.
...
...
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 | Description | Example |
|---|---|---|---|---|
patient_id | String | Unique patient identifier |
| |
id | String | Unique allergy intolerance identifier |
|
...
API paragraph not found
Authorize*
...
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 = 'allergy_intolerance:practical_monitor')
return 403 (“Your scope does not allow to access this resource. Missing allowances: allergy_intolerance: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 = 'allergy_intolerance:practical_monitor')
in case of error - return 403 (“Your scope does not allow to access this resource. Missing allowances: allergy_intolerance: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
personIdsubmitted.return 404 (“not found“) in case not exist
Check required allergy intolerance
Idsubmitted.return 404 (“not found“) in case not exist or not related to person
Processing*
Service logic
...
Get allergy intolerance by id and patient_id
...
API paragraph not found
Processing*
API paragraph not found
Response structure*
See on Apiary
...