/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)
...
Properties of a REST API method document
Document type | Метод REST API |
|---|---|
Document title | [Document statusDRAFT] REST API [Назва методуNEW] [ID методуCreate Composition Title [API-007-011-001-0471] |
Guideline ID | GUI-0011 |
Author | @ |
Document version | 1 |
Document status | DRAFT |
Date of creation | ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD) |
Date of update | ХХ.ХХ.ХХХХ (дата зміни версії) |
Method API ID | API-007-011-001-0471 |
Microservices (namespace) | MPIME |
Component | AuthCompositions_ME |
Component ID | COM-007-011 |
Link на API-специфікацію | |
Resource | {{host}}//api.ehealth.gov.ua/api/patients/id/encounter_package |
Scope | |
Protocol type | REST |
Request type | |
Sync/Async | |
Public/Private |
...
Generate requisition number using Human readable requisition number algorithm based on patient_id
Use prefix from configuration instead of first 4 symbols: {{composition_type}}
_TITLE_PREFIX(ex.ADOPTION_TITLE_PREFIX) If prefix can't be get from chart-parameters Return 500 errorCheck that there is no Composition in ME.Compositions collection with such title
if it already exists generate new requisition as it is described in https://e-health-ua.atlassian.net/wiki/spaces/EH/pages/583402257/Human+readable+requisition+number#Solution section
Check that there is no record in ME.requisition_number with such requisition
if it already exists generate new requisition as it is described in https://e-health-ua.atlassian.net/wiki/spaces/EH/pages/583402257/Human+readable+requisition+number#Solution section
Save generated title in ME.requisition_number
requisition_number = generated requisition
patient_id = patient id from the request
expiration_date = current datetime + COMPOSITION_TITLE_EXPIRATION_PERIOD (config parameter in ehealth.charts)
composition_type = composition_type from query parameters
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 ConfluenceN/A
Dictionaries
N/A
Input parameters
Description of input parameters
Input parameter | Mandatory | Type | Description | Example | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 1 | composition_id | M | String ($uuid) (path) | Composition object ID | 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59||||||
| 2 |
|
|
|
|
|
Request structure
See on API-specification (посилання на сторінку з API-специфікацією)Description of the REST API request structure, example
| Expand | ||
|---|---|---|
| ||
|
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
Validate composition_type is
COMPOSITION_TYPESdictionaryin case of error - return 422 ('value is not allowed in enum')
Check that сomposition_type is NOT from COMPOSITION_TYPE_BLACK_LIST
Return 422 ("сomposition_type is not allowed by configuration") in case of error
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST APIN/A
Response structure examples
See on API-specification (посилання на сторінку з API-специфікацією)Description of the REST API response structure, example
| Expand | ||
|---|---|---|
| ||
|
...
Response code | HTTP Status code | Message | Internal name | Description | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | Базові | ||||||||||
| 2 | 401 | Invalid access token | |||||||||
| 3 |
| 401 | Unauthorized |
| Помилка підтвердження | 4 | 403 | Access denied. Party is not verified | |||
| 54 | 403 | Access denied. Party is deceased | |||||||||
| 65 | 403 | Your scope does not allow to access this resource. Missing allowances: composition:create | |||||||||
| 7 | 1000 | 404 | Composition not found | COMPOSITION_NOT_FOUND_404 | Не знайдено медичний висновок | ||||||
| 8 | 6 | 422 | сomposition_type is not allowed by configuration | ||||||||
| 97 | 422 | value is not allowed in enum | |||||||||
| 108 | Специфічні | ||||||||||
| 119 | 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 N/A
Technical modules where the method is used
Название | ID ТМ | Статус |
|---|---|---|
TM0112 | ||
...