...
Page Properties |
---|
id | page_properties_method_REST API |
---|
|
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-001006-001-001-00010217 |
---|
Microservices (namespace) | MC |
---|
Component | Compositions |
---|
Component ID | COM-006-001 |
---|
Link на API-специфікацію | https://app.swaggerhub.com/apis/ehealthua/compositions/Prod#/main/getIntegrationData |
---|
Resource | {{host}}/patients/{patientId}/composition/{compositionId}/episode/{episodeId}/encounter/{encounterId}/integrationData |
---|
Scope | composition:read |
---|
Protocol type | REST |
---|
Request type | GET |
---|
Sync/Async | Sync |
---|
Public/Private | Public |
---|
|
...
An authorized user with MIS creates and signs a composition, information from which can be used in a third-party registry.
The signed composition is stored in the ESOZ.
An authorized user can make a request and receive in response the status of processing in a third-party register.
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 ConfluenceLink to page with configurable parameters
VAR NAME:
EMAL_INTEGRATION_NEWBORN_CLIENTS_MEMBER_CODE_NAMES (Mapping request components by getComposition MVN (integration data))
Dictionaries
COMPOSITION_PROCESSING_STATUS (parameter “integrationStatus“ in response)
COMPOSITION_PROCESSING_SYSTEMS (parameter “component“ in response):
COMPOSITION_PROCESSING_TASKS (parameter “type“ in response):
COMPOSITION_PROCESSING_TASK_STATUS (parameter “taskStatus“ in response):
ERLN_RESULT_CODES (parameters “statusCode“ and “statusMessage“ in response - for ERLN only):
Expand |
---|
title | ERLN_RESULT_CODES (parameter “statusCode“ in response - for ERLN only): |
---|
|
Code | Translate message (UA) |
---|
1000 | Неочікувана помилка при створенні | 1101 | ЕЛН створено успішно | 1102 | ЕЛН створено успішно в статусі "Недійсний" (існує інший випадок непрацездатності з іншої причини) | 1201 | Непрацездатну особу не знайдено в Реєстрі застрахованих осіб | 1202 | Помилка однозначного пошуку в РЗО / Перевірте коретність ПІБ та документ | 1203 | Помилка однозначного пошуку в РЗО / За направленими персональними даними знайдено більше однієї особи / Перевірте ПІБ та документ особи | 1301 | Відсутня інформація про трудові відносини на дату початку періоду непрацездатності | 1401 | Направлений МВТН вже було оброблено | 2000 | Неочікувана помилка при продовження | 2101 | ЕЛН продовжено успішно | 2201 | Продовження випадку неможливе щодо ЕЛН, який має статус "Помилково сформований" | 2202 | Продовження випадку неможливе - МВТН який продовжується не останній (вже продовжено/скорочено) | 2203 | Продовження випадку неможливе - для попереднього МВТН не було створено ЕЛН | 2204 | Продовження неможливе - ЕЛН який продовжується заборонено змінювати (ЕЛН в статусі "Готовий до сплати") | 3000 | Неочікувана помилка при скороченні | 3101 | ЕЛН скорочено успішно | 3201 | Скорочення випадку неможливе щодо ЕЛН, який має статус "Помилково сформований" | 3202 | Скорочення випадку неможливе - МВТН який скорочується не останній (вже продовжено/скорочено) | 3203 | Скорочення неможливе - ЕЛН який скорочується заборонено змінювати (ЕЛН в статусі "Готовий до сплати") | 3204 | Скорочення випадку неможливе - випадок непрацездатності, який продовжується уже завершено новим МВТН іншої категорії | 3205 | Скорочення випадку неможливе - для попереднього МВТН не було створено ЕЛН | 4000 | Неочікувана помилка при продовженні як створенні | 4101 | ЕЛН створено успішно як продовження випадку | 4201 | Продовження випадку неможливе - для попереднього МВТН не було створено ЕЛН | 4202 | Продовження випадку неможливе щодо ЕЛН, який має статус "Помилково сформований" | 4203 | Продовження випадку неможливе - дати строку дії МВТН не припустима відносно періоду непрацездатності в раніше створеному ЕЛН (дата початку строку дії менша за початок періоду в ЕЛН або більша за дату кінця періоду ЕЛН більше ніж на 1 день) | 4204 | Продовження випадку неможливе - МВТН який продовжується не останній (вже продовжено/скорочено) | 4205 | Продовження випадку неможливе - випадок непрацездатності, який продовжується уже завершено новим МВТН іншої категорії | 5000 | Неочікувана помилка при скасуванні | 5101 | ЕЛН позначено як помилково створений | 5201 | Статус "Помилково сформований" було встановлено раніше | 5202 | Неможливо встановити статус "Помилково сформований" по ЕЛН, щодо якого є продовження випадку | 5203 | Неможливо встановити статус "Помилково сформований" по ЕЛН в статусі "Готовий до сплати" | 5204 | ЕЛН створений за таким МВТН відсутній у реєстрі |
|
Input parameters
Description of input parameters
MandatoryValues | Type | Description | Example |
---|
1 | composition_id | McompositionId | | String($uuid) (path) | Composition object ID | 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59 |
patientId | | String($uuid) (path) | Patient object ID | 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59 |
episodeId | | String($uuid) (path) |
Composition Episode of Care object ID |
89678f6089678f60-4cdc-4fe3-ae83-e8b3ebd35c59 |
2 |
encounterId | | String($uuid) (path) | Encounter object ID | 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59 |
Request structure
See on SwaggerHub (2.39.2)
See on API-specification (посилання на сторінку з API-специфікацією)Description of the REST API request structure, example
Expand |
---|
| Code Block |
---|
|
Code Block |
---|
get:
description: 'Отримання інформації про інтеграційні процеси'
operationId: getIntegrationData
tags: [ 'main' ]
parameters:
- $ref: '#/components/parameters/compositionId'
- $ref: '#/components/parameters/patientId'
- $ref: '#/components/parameters/episodeId'
- $ref: '#/components/parameters/encounterId' |
|
| Key | Value | Mandatory | Description | Example |
---|
1 | Content-Type | application/json | M | Тип контенту | Content-Type:application/json |
2 | Authorization | Bearer c2778f3064753ea70de870a53795f5c9 | M | Перевірка користувача | {token} | | | Authorization: Bearer c2778f3064753ea70de870a53795f5c9{token} |
3 | api-key | {secret} | | | api-key: {secret} |
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
...
...
See on SwaggerHub
In addition to parameters from the Dictionaries, the response contains the following subparameters, depending on parameter values:
“updatedAt” - the date of the last update of the status of the integration process
“details“ - the data set defined by the integration component:
“component“: “MJU_DRACZ“
"type": "NEWBORN_POST_COMPOSITION"
“personId“ - the identifier of the created record about the identified child.
“component“: “ERLN“
"type": "CREATE_ERLN_RECORD”
“SL_NUM” - ELN registration number
“SL_REG_DATETIME” - ELN registration date and hour
“SL_STOP” - ELN closing date
“SL_START” - ELN open (extension) date
“IC_NUM” - Number of temporary disability case
"type": "CANCEL_ERLN_RECORD”
"SL_NUM" - ELN registration number
"SL_REG_DATETIME" - ELN registration date and hour
"IC_NUM" - Number of temporary disability case
Response examples:
Creation of composition type “temp_disability“. Response with information on the ERLN integration process:
Expand |
---|
|
Code Block |
---|
[
{
"component": "ERLN",
"details": {
"SL_NUM": "517-2000002845-1",
"SL_REG_DATETIME": "2022-09-21T10:17:51Z",
"SL_STOP": "2022-09-29T00:00:00Z",
"SL_START": "2022-09-19T00:00:00Z",
"IC_NUM": "517"
},
"integrationStatus": "DONE",
"statusCode": 1101,
"statusMessage": "ЕЛН створено успішно",
"taskStatus": "DONE",
"type": "CREATE_ERLN_RECORD",
"updatedAt": "2022-09-21T07:18:48.274Z"
}
] |
|
Creation of composition type “newborn“. Response with information on DIIA integration process:
Expand |
---|
|
Code Block |
---|
[
{
"component": "DIIA",
"details": {
},
"integrationStatus": "DONE",
"taskStatus": "DONE",
"type": "NEWBORN_GET_COMPOSITION",
"updatedAt": "2022-09-14T07:47:00.388Z"
},
{
"component": "MJU_DRACS",
"details": {
"personId": "8cd52d25-1136-47ef-a0a7-efac9b941b67"
},
"integrationStatus": "DONE",
"taskStatus": "DONE",
"type": "NEWBORN_POST_COMPOSITION",
"updatedAt": "2022-09-14T08:35:11.330Z"
}
] |
|
Creation of composition type “newborn“. Response with information on DRACSG integration process:
Expand |
---|
|
Code Block |
---|
[
{
"component": "MJU_DRACS",
"details": {
"personId": "fe88454e-7867-4795-8ab5-1fa54493a3d6",
},
"integrationStatus": "DONE",
"taskStatus": "DONE",
"type": "NEWBORN_POST_COMPOSITION",
"updatedAt": "2022-09-14T08:35:03.383Z"
}
] |
|
Cancellation of composition type “temp_disability“. Response with information on the ERLN integration process:
Expand |
---|
|
Code Block |
---|
[
{
"component": "ERLN",
"details": {
"SL_NUM": "520-2000002848-1",
"SL_REG_DATETIME": "2022-09-22T12:36:08Z",
"SL_STOP": "2022-09-30T00:00:00Z",
"SL_START": "2022-09-20T00:00:00Z",
"IC_NUM": "520"
},
"integrationStatus": "DONE",
"statusCode": 1101,
"statusMessage": "ЕЛН створено успішно",
"taskStatus": "DONE",
"type": "CREATE_ERLN_RECORD",
"updatedAt": "2022-09-22T09:37:07.290Z"
},
{
"component": "ERLN",
"details": {
"SL_NUM": "520-2000002848-2",
"SL_REG_DATETIME": "2022-09-22T12:36:08Z",
"IC_NUM": "520"
},
"integrationStatus": "DONE",
"statusCode": 5101,
"taskStatus": "DONE",
"type": "CANCEL_ERLN_RECORD",
"updatedAt": "2022-09-22T09:39:33.749Z"
}
] |
|
HTTP status codes
| Response code | HTTP Status code | Message | Internal name | Description |
---|
1 | Базові |
2 | | 200 | Composition found | If the request is completed and the information is found | |
3 | | 401 | Unauthorized | | Помилка підтвердження |
4 | | 404 | Composition not found | In case the information is not found for any reason | |
5 | 1000 | 404 | Composition not found | COMPOSITION_NOT_FOUND_404 | Не знайдено медичний висновок |
3 | 401 | Unauthorized | Помилка підтвердження | 4 | 6 | Специфічні |
57 | | 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 |
---|
headings | ID ТМ, Статус |
---|
cql | label = "tr-mis" |
---|
|
...