ЕСОЗ - публічна документація
[DRAFT] PIS. Get declarations [API-013-001-001-0468]
- Anzhela Kovalenko (SoE eHealth)
https://e-health-ua.atlassian.net/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)
- 1 Properties of a REST API method document
- 2 Purpose
- 2.1 Key points
- 3 Logic
- 3.1 Service logic
- 4 Configuration parameters
- 5 Dictionaries
- 6 Input parameters
- 7 Request structure
- 8 Headers
- 9 Request data validation
- 9.1 Authorization
- 9.2 Validate Person
- 10 Processing
- 11 Response structure examples
- 12 HTTP status codes
- 13 Post-processing processes
- 14 Technical modules where the method is used
Properties of a REST API method document
Document type | Метод REST API |
|---|---|
Document title | [DRAFT] PIS. Get declarations [API-013-001-001-0468] |
Guideline ID | GUI-0011 |
Author | @ |
Document version | 1 |
Document status | DRAFT |
Date of creation | ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD) |
Date of update | ХХ.ХХ.ХХХХ (дата зміни версії) |
Method API ID | API-013-001-001-0468 |
Microservices (namespace) | IL |
Component | Declaration |
Component ID | COM-013-001 |
Link на API-специфікацію | |
Resource | {{host}}/api/pis/declarations |
Scope | declaration:read_pis |
Protocol type | REST |
Request type | GET |
Sync/Async | Sync |
Public/Private | Public |
Purpose
This method allows to find patient's declarations and filter them.
Key points
Declarations filtered by the user based on token details
Logic
Service logic
Get person_id from token (x-person-id header)
Get declaration’s details from ops.declarations table using person_id filter them by:
status,
start_date_from,
start_date_to,
end_date_from,
end_date_to,
page,
page_size
Render response according to specification.
Страница:
RC (CSI-1758) Submit Encounter Package (E-Health)
Страница:
Submit Encounter Package (по шаблону) (Анжела Коваленко)
Страница:
Copy of Submit Encounter Package (Анжела Коваленко)
Страница:
(CSI-1713) Submit Encounter Package (CSI TEAM)
Страница:
(PCR-124) Submit Encounter Package (CSI TEAM)
Страница:
Submit Encounter Package (E-Health)
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
Authorization
Verify the validity of access token
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 = 'declaration:read_pis')
Return (403, 'Your scope does not allow to access this resource. Missing allowances: declaration:read_pis ') in case of invalid scope(s)
Validate Person
Get person_id from token (x-person-id header)
Validate patient status is active (status = ‘active' & is_active = 'true’)
in case of error - return 404 ('not found')
Processing
N/A
Response structure examples
See on API-specification
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |
|---|---|---|---|---|---|
| 1 | Базові | ||||
| 2 |
|
|
|
|
|
| 3 |
|
|
|
|
|
| 4 | Специфічні | ||||
| 5 |
|
|
|
|
|
Post-processing processes
N/A
Technical modules where the method is used
Название |
|---|
|
Related content
ЕСОЗ - публічна документація