Info |
---|
Note |
Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою. |
Info |
---|
/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document) |
Table of Contents |
---|
Properties of a REST API method document
Page Properties | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||
|
Purpose
This method allows to re-send the composition to ERLN (Electronic Register of temporary disability conclusions of the Pension Fund of Ukraine). Used only for the type of compositions - Тemporary Disability
...
Logic
This method allows to re-send Тemporary Disability Composition to ERLN in cases when the previous attempt of ERLN registration was unsuccessful, the description of the error is available and if all checks is passed.
Precondition:
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 N/A
Dictionaries
N/A
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 | ||
---|---|---|
| ||
|
Headers
...
...
Request data validation
...
Mandatory
...
Description
...
Example
...
Content-Type
...
application/json
...
M
...
Тип контенту
...
Content-Type:application/json
...
Authorization
...
Bearer c2778f3064753ea70de870a53795f5c9
...
M
...
Перевірка користувача
...
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
...
Authorization
...
Bearer {token}
...
Authorization: Bearer {token}
...
api-key
...
{secret}
...
api-key: {secret}
Request data validation
Authorize
Check user scopes in order to perform this action (scope = 'composition:create')
return 401 (Unauthorized) in case of invalid scope(s)
Validation data request
Searching for the last scheduled ERLN task for this composition
In case of error (ERLN task not found) - return 404 ('Not Found')
Searching for the composition
In case of error (composition was not found) - return 404 ('Not Found')
Check the composition’s type
In case of error (composition’s type isn’t Тemporary Disability) - return 400 ('Bad Request')
Check the composition’s status
In case of error (composition’s status isn’t “FINAL”) - return 400 ('Bad Request')
Check the composition’s integration status
In case of error (composition’s integration status isn’t “ERROR”) - return 400 ('Bad Request')
Check the previous task status
In case of error (task status is still in progress) - return 400 ('Bad Request')
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 APIN/A
Response structure examples
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 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 |
| |||
86 | 404 | Not Found | |||||||||||||
97 | Специфічні | ||||||||||||||
10 | 422 | Only for active MPI record can be created medication request!8 |
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
Page Properties Report | ||||
---|---|---|---|---|
|
...