ЕСОЗ - публічна документація
[DRAFT] REST API Get Short Episodes by search params [API-007-008-008-0291]
- Serhii Boldin (SoE eHealth)
- Anzhela Kovalenko (SoE eHealth)
- Anastasiia Prokhorova (SoE eHealth)
- Mykhaylo Khapchyk (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
- 3 Logic
- 4 Configuration parameters
- 5 Dictionaries
- 6 Input parameters
- 7 Request structure
- 8 Headers
- 9 Request data validation
- 9.1 Validate token
- 9.2 Validate scopes
- 9.3 Validate patient
- 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] REST API Get Short Episodes by search params [API-007-008-008-0291 |
Guideline ID | GUI-0011 |
Author | @ |
Document version | 1 |
Document status | DRAFT |
Date of creation | ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD) |
Date of update | ХХ.ХХ.ХХХХ (дата зміни версії) |
Method API ID | API-007-006-001-0268 |
Microservices (namespace) | ME |
Component | Patient Summary |
Component ID | COM-007-006 |
Link на API-специфікацію | |
Resource | {{host}}/api/patients/{{patient_id}}/summary/episodes |
Scope | patient_summary:read |
Protocol type | REST |
Request type | GET |
Sync/Async | Async |
Public/Private | Public |
Purpose
Return brief information in order not to disclose confidential and sensitive data.
Logic
This web service returns brief information in order not to disclose confidential and sensitive data. Access to full episode data is restricted by patient's approval. If you have an approval - you can obtain episode details and nested entities through /episode/:id/* web services.
Configuration parameters
N/A (Not applicable)
Dictionaries
eHealth/episode_statuses (parameter “status“ in response)
Input parameters
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | patient_id | M | String | Unique MPI patient identifier |
|
| 2 | period_start_from |
| String |
|
|
| 3 | period_start_to |
| String |
|
|
| 4 | period_end_from |
| String |
|
|
| 5 | period_end_to |
| String |
|
|
| 6 | page |
| Number | Page number |
|
| 7 | page_size |
| Number | A limit on the number of objects to be returned, between 1 and 100. Default: 50 |
|
Request structure
See on API-specification
Headers
See on Headers
Request data validation
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 = 'patient_summary:read')
Return 403 in case invalid scope(s)
Validate patient
Validate patient exists in MongoDB
In case of error return 404 not found
Processing
Get all patient's episodes
Filter using Forbidden Groups
Apply filters provided by user
Render reduced episode data
Response structure examples
See on API-specification
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |
|---|---|---|---|---|---|
| 1 | Базові | ||||
| 2 |
| 200 |
| Response |
|
| 3 |
| 401 |
| Access token validation failed |
|
| 4 |
| 401 |
| Access token expired |
|
| 5 |
| 403 |
| Invalid scope |
|
| 6 |
| 404 |
| Patient not found |
|
| 7 | Специфічні | ||||
Post-processing processes
N/A (Not applicable)
Technical modules where the method is used
N/A (Not applicable)
ЕСОЗ - публічна документація