| Page Properties | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
|
REST API method / Метод REST API (настанова) (remove the link block before publishing the document)
Properties of a REST API method document
...
Document type
...
Метод REST API
...
Document title
...
Get declaration Request details via Cabinet
...
Guideline ID
...
GUI-0011
...
Author
...
Viacheslav Tybin (SoE eHealth)
...
Document version
...
1
...
Document status
...
DRAFT
...
Date of creation
...
ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)
...
Date of update
...
ХХ.ХХ.ХХХХ (дата зміни версії)
...
Method API ID
...
API-005-010-002-0196
...
Microservices (namespace)
...
IL
...
Component
...
Patient Cabinet
...
Component ID
...
COM-001-001
...
Link на API-специфікацію
...
...
Resource
...
{{host}}//api.ehealth.gov.ua/api/patients/id/encounter_package
...
Scope
...
Protocol type
...
REST
...
Request type
...
Sync/Async
...
Public/Private
Purpose
Describe the purpose of the API method, add Key points (if necessary)
Logic
Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)
Configuration parameters
Description of the configuration parameters that are used when processing a request in the system
Dictionaries
Provides a list of links to dictionaries that are available in Confluence
Input parameters
Description of input parameters
...
Input parameter
...
Mandatory
...
Type
...
Description
...
Example
...
composition_id
...
M
...
String ($uuid) (path)
...
Composition object ID
...
89678f60-4cdc-4fe3-ae83-e8b3ebd35c59
...
...
...
...
...
Request structure
See on API-specification (посилання на сторінку з API-специфікацією)
Description of the REST API request structure, example
...
| title | Example |
|---|
...
Headers
...
Key
...
Value
...
Mandatory
...
Description
...
Example
...
Content-Type
...
application/json
...
M
...
Тип контенту
...
Content-Type:application/json
...
Authorization
...
Bearer c2778f3064753ea70de870a53795f5c9
...
M
...
Перевірка користувача
...
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
...
...
...
...
...
Request data validation
Describe the process of checking the input data transmitted in the request for compliance with the given rules and restrictions set in the API
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 (посилання на сторінку з API-специфікацією)
Description of the REST API response structure, example
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
| Code Block | ||||||||||||||||||
| Page Properties | ||||||||||||||||||
| ||||||||||||||||||
|
REST API method / Метод REST API (настанова) (remove the link block before publishing the document)
Properties of a REST API method document
Document type | Метод REST API |
|---|---|
Document title | Get declaration Request details via Cabinet |
Guideline ID | GUI-0011 |
Author | |
Document version | 1 |
Document status | DRAFT |
Date of creation | ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD) |
Date of update | ХХ.ХХ.ХХХХ (дата зміни версії) |
Method API ID | API-005-010-002-0196 |
Microservices (namespace) | IL |
Component | Patient Cabinet |
Component ID | COM-005-010 |
Link на API-специфікацію | |
Resource | {{host}}/api/cabinet/declaration_requests/{{id}} |
Scope | declaration_request:read |
Protocol type | REST |
Request type | GET |
Sync/Async | Sync |
Public/Private | Public |
Purpose
This WS is designed to obtain declaration request details from a patient’s cabinet.
Logic
Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)
Configuration parameters
Description of the configuration parameters that are used when processing a request in the system
Dictionaries
GENDER
DOCUMENT_TYPE
ADDRESS_TYPE
COUNTRY
SETTLEMENT_TYPE
STREET_TYPE
PHONE_TYPE
AUTHENTICATION_METHOD
PREFERRED_WAY_COMMUNICATION
CONFIDANT_PERSON_TYPE
DOCUMENT_RELATIONSHIP_TYPE
SPECIALITY_TYPE
POSITION
LEGAL_FORM
ACCREDITATION_CATEGORY
DIVISION_TYPE
Input parameters
Description of input parameters
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | id |
| String | c75f-45fb-badf-6e8d20b6a8a8 (uuid). Required. | 7e9cffd9 |
| 2 |
|
|
|
|
|
Request structure
See on API-specification (посилання на сторінку з API-специфікацією)
Description of the REST API request structure, example
| Expand | ||
|---|---|---|
| ||
|
Headers
Key | Value | Mandatory | Description | Example | |
|---|---|---|---|---|---|
| 1 | Content-Type | application/json | M | Тип контенту | Content-Type:application/json |
| 2 | Authorization | Bearer c2778f3064753ea70de870a53795f5c9 | M | Перевірка користувача | Authorization:Bearer c2778f3064753ea70de870a53795f5c9 |
| 3 |
|
|
|
|
|
Request data validation
Validate user
Extract party_user (user_id) from token.
Check if users.person_id=$.declaration_request.mpi_id
in case error return 403
Check users password is not expired
in case error return 401 - password expired
Check if users.is_blocked = false
in case error return 401 - access denied
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API
Response structure examples
Check exist declaration by $.id.
if invalid - return 404 error (message: "declaration request is not found!")
See on API-specification (посилання на сторінку з API-специфікацією)
Description of the REST API response structure, example
| Expand | ||
|---|---|---|
| ||
|
HTTP status codes
Response code | HTTP Status code | Message | Internal name |
|---|
Description
Response code | HTTP Status code | Message | Internal name | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 1 | Базові | |||||||||
Description | ||||||||||
| 1 | Базові | |||||||||
| 2 | 200 | Response |
| |||||||
| 3 | 401 | Access denied | ||||||||
| 4 | 401 | Password expired | ||||||||
| 5 | 401 | Validation failed | ||||||||
| 6 | 401 | Unauthorized |
| Помилка підтвердження | ||||||
| 7 | 403 | Your scope does not allow to access this resource. Missing allowances: declaration_request:read | Invalid scope(s) | |||||||
| 8 | 1000 | 404 | Composition not found | COMPOSITION_NOT_FOUND_404 | Не знайдено медичний висновок | |||||
| 39 |
| 401 | Unauthorized |
| Помилка підтвердження | 4404 | Declaration request is not found! | |||
| 10 | 404 | Validation failed | ||||||||
| 11 | Специфічні | |||||||||
| 512 |
| 422 | Only for active MPI record can be created medication request! |
|
| |||||
Post-processing processes
Description of actions performed on data after processing
Technical modules where the method is used
List of pages describing technical modules where the method is used
Название | ID ТМ | Статус |
|---|---|---|
TM0112 | ||