| Info |
|---|
REST API method / Метод REST API (настанова) (remove the link block before publishing the document) |
...
| Page Properties | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||
|
...
Composition status is “FINAL”
Previous attempt of ERLN registration was unsuccessful (“ERROR” integration status)
The description of the error is available (statusMessage isn’t empty)
Temporarily disabled person is identified in the System (section.focus.type.coding.code = person)
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 | |
|---|---|---|---|---|---|
| 1 | compositionId |
| String ($uuid) (path) | Composition object ID | 4fd87fa2-1beb-44ff-a7cc-c1759e1c6e9b |
| 2 |
Request structure
https://e-health-ua.atlassian.net/wiki/spaces/ENS/pages/edit-v2/17571905560#Request-structure
See on API-specification (посилання на сторінку з API-специфікацією)
Description of the REST API request structure, example
| Expand | ||
|---|---|---|
| ||
|
...
Key | Value | Mandatory | Description | Example | |
|---|---|---|---|---|---|
| 1 | Content-Type | application/json | M | Тип контенту | Content-Type:application/json |
| 2 | Authorization | Bearer c2778f3064753ea70de870a53795f5c9 | M | Перевірка користувача | Authorization:Bearer c2778f3064753ea70de870a53795f5c9 |
| 3 | Authorization | Bearer {token} | Authorization: Bearer {token} | ||
| 4 | api-key | {secret} | api-key: {secret} |
...
In case if all previous checks were passed the function creates a new call task into ERLN, and completes its work with code 200
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 | ||
|---|---|---|
| ||
|
...
Response code | HTTP Status code | Message | Internal name | Description | |
|---|---|---|---|---|---|
| 1 | Базові | ||||
| 2 | 200 | The request was successfully submitted for processing |
| ||
| 3 | 400 | Bad Request | |||
| 4 | 400 | This request is not allowed to be resubmitted (inappropriate status or type of request) |
| ||
| 5 | 401 | Unauthorized | Помилка підтвердження | ||
| 6 | 1000 | 404 | Composition not found | COMPOSITION_NOT_FOUND_404 | Не знайдено медичний висновок |
| 7 | 404 | No conclusion found |
| ||
| 8 | 404 | Not Found | |||
| 9 | Специфічні | ||||
| 10 | 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
| Page Properties Report | ||||
|---|---|---|---|---|
|
...