ЕСОЗ - публічна документація
[DRAFT] Get Allergy Intolerance context [API-007-005-001-0246]
- Kateryna Yakovleva
Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.
Document type | Метод REST API |
|---|---|
Document title | [DRAFT] Get Allergy Intolerance context [API-007-005-001-0246] |
Guideline ID | GUI-0011 |
Author | @ |
Document version | 1 |
Document status | DRAFT |
Date of creation | ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD) |
Date of update | ХХ.ХХ.ХХХХ (дата зміни версії) |
Method API ID | API-007-005-001-0246 |
Microservices (namespace) | ME |
Component | EHR |
Component ID | COM-007-005 |
Link на API-специфікацію | |
Resource |
|
Scope |
|
Protocol type | REST |
Request type | GET |
Sync/Async |
|
Public/Private | Public |
Purpose
This web service is designed to return allergy intolerances info by id.
Logic
N/A
Configuration parameters
N/A
Dictionaries
N/A
Input parameters
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 |
|
|
|
|
|
| 2 |
|
|
|
|
|
Request structure
See on API-specification
Headers
Request data validation
Authorize
Request to process the request using a token in the headers
Verify the validity of access token
Return 401 in case validation fails
Verify token is not expired
in case error return 401
Check user scopes in order to perform this action (scope = 'allergy_intolerance:read')
Return 403 in case invalid scope(s)
Access to the resource is also managed by ABAC module.
Processing
N/A
Response structure examples
See on API-specification
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |
|---|---|---|---|---|---|
| 1 | Базові | ||||
| 2 |
| 200 |
|
|
|
| 3 |
| 401 |
| Access token validation failed |
|
| 4 |
| 403 |
| Invalid scope |
|
| 5 | Специфічні | ||||
| 6 |
|
|
|
|
|
Post-processing processes
N/A
Technical modules where the method is used
ЕСОЗ - публічна документація