ЕСОЗ - публічна документація
[DRAFT] Get Active Diagnoses [API-007-008-005-0286]
Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.
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
- 10 Authorize
- 11 Processing
- 12 Response structure examples
- 13 HTTP status codes
- 14 Post-processing processes
- 15 Technical modules where the method is used
Properties of a REST API method document
Document type | Метод REST API |
---|---|
Document title | [Document status] REST API [Назва методу] [ID методу] |
Guideline ID | GUI-0011 |
Author | @ |
Document version | 1 |
Document status | DRAFT |
Date of creation | ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD) |
Date of update | ХХ.ХХ.ХХХХ (дата зміни версії) |
Method API ID | API-007-008-005-0286 |
Microservices (namespace) | ME |
Component | Patient Summary |
Component ID | COM-007-008 |
Link на API-специфікацію | |
Resource | {{host}}/api/patients/{{patient_id}}/summary/diagnoses |
Scope | patient_summary:read |
Protocol type | REST |
Request type | GET |
Sync/Async | Async |
Public/Private | Public |
Purpose
Return current diagnoses related only to active episodes.
Logic
This endpoint returns current diagnoses related only to active episodes. In order to get specific condition details, use Get Condition by ID
Configuration parameters
N/A (Not applicable)
Dictionaries
eHealth/resources - condition (parameter “condition“ in response)
eHealth/ICPC2/condition_codes or eHealth/ICD10/condition_codes (parameter “code“ in request/response)
eHealth/diagnosis_roles (parameter “role“ in response)
Input parameters
Input parameter | Mandatory | Type | Description | Example | |
---|---|---|---|---|---|
1 | patient_id | M | String | Unique MPI patient identifier |
|
2 | code |
| String | Diagnose code |
|
3 | page |
| Number | Page number |
|
4 | 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
Request data validation
Authorize
Request to process the request using a token in the headers
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API
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)
ЕСОЗ - публічна документація