Table of Contents

minLevel	1
maxLevel	7

The method is designed to obtain information on the integration processes of interaction with external third-party registries in the context of compositions. When composition data is transferred to an external registry and processed there, the method returns the status of data processing by the external third-party registry.

Integration with the following external third-party registries is implemented:

Electronic sick leave register (ERLN) - for MVTN (temporary desability).
State register of acts of civil status of citizens (DRACSDRACSG) - for MVN (newborn).

Specification*

...

Link

...

Посилання на Apiary або Swagger

...

Resource

...

Посилання на ресурс, наприклад: /api/persons/create

...

Scope

...

Scope для доступу

...

Components

...

Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription

...

Microservices

...

Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC

...

Protocol type

...

Тип протоколу, який використовується запитом, наприклад: SOAP | REST

...

Request type

...

Тип запиту API, наприклад: GET, POST, PATCH…

...

Sync/Async

...

Метод є синхронним чи асинхронним?

Also, the method transmits integration data of DIIA processing.

Getting integration data processes depends on the type of composition.

Used in processes:

Create/Sign composition (general process)

Extension / reduction MVTN

Refinement (preperson -> person) for MVTN

Creating "a replacement" composition

Specification

Link	Link to SwaggerHub (2.39.2)
Resource	/patients/{patientId}/composition/{compositionId}/episode/{episodeId}/encounter/{encounterId}/integrationData
Scope	composition:read
Components	Compositions
Microservices	API paragraph not found
Protocol type	REST
Request type	GET
Sync/Async	Async
Public/Private/Internal

Потрібно зазначити тип методу за ступенем доступності

Preconditions

Які передумови мають бути виконані системою/користувачем. Наприклад:

створений запис в MedicationRequest;
рецепт відпущений (COMPLETED)

Logic*

Потрібно по пунктах описати логіку методу API або додати діаграму

Global and configurable parameters

Потрібно вказати посилання на сторінки з описом глобальних та конфігураційних параметрів

Input parameters

...

Public

Preconditions

The method can only be executed by a user with access to composition.
The method can only be executed for a composition with the status:
- FINAL
- AMENDED
- ENTERED_IN_ERROR

Logic

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.

Configurable parameters

Link to page with configurable parameters

VAR NAME:

EMAL_INTEGRATION_NEWBORN_CLIENTS_MEMBER_CODE_NAMES (Mapping request components by getComposition MVN (integration data))

Input parameters

Input parameter	Values	Type	Description	Example

asyncJobId

compositionId

String

Async Job Object

($uuid) (path)

Composition object ID

Filters

Потрібно вказати фільтри. Наприклад, для GET /api/medication_requests/{{id}}/dispenses?status=PROCESSED фільтр:

...

Filter

...

Values

...

Type

...

Description

...

Example

...

status

...

String

...

Optional

...

PROCESSED

Dictionaries

Потрібно вказати посилання на сторінки довідників, які використовує метод API

Request structure*

See on Apiary

Example:

...

title	Request example

...

Authorize*

Вимоги до авторизації: яким чином надається доступ до використання методу

Request to process the request using a token in the headers

Headers*

Наприклад:

Content-Type:application/json
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
api-key:uXhEczJ56adsfh3Ri9SUkc4en

Request data validation*

Валідація даних

Наприклад:

Validate request using JSON schema
1. In case validation failed - generate 422 error

Processing*

Потрібно описати процеси, які відбуваються з даними

1. Using global parameters

Потрібно викликати глобальні параметри (Global parameters), щоб отримати наведені нижче параметри

Response structure*

See on Apiary

Example:

...

title	Response example

...

Post-processing processes*

Що має відбутися в ЦБД після опрацювання та відправлення відповіді, тощо

HTTP status codes*

...

HTTP status code

...

Message

...

What caused the error

...

Backward compatibility

Сумісність з попередніми версіями методу

API Method

https://app.swaggerhub.com/apis/ehealthua/compositions/2.32.2#/main/getIntegrationData

Бізнес-процес

2. Cтворення/підписання МВ (загальний процес)

5. Продовження / скорочення МВТН

6. Уточнення (preperson -> person) для МВТН

RC_7. Створення МВ “на заміну”

Опис

Метод призначений для отримання інформації про інтеграційні процеси, а саме:

компонент, з яким відбувається взаємодія (параметр “component“ з довідника COMPOSITION_PROCESSING_SYSTEMS):
- для МВН: "ДРАЦСГ" ("MJU_DRACZ"), "Дія" (“DIIA”);
- для МВТН: "ЕРЛН" ("ERLN");
підсистема інтеграційного компонету або тип задачі до компоненту (параметр “type” з довідника COMPOSITION_PROCESSING_TASKS):
- для МВН: "NEWBORN_POST_COMPOSITION" та “NEWBORN_GET_COMPOSITION” (“ДРАЦСГ”), "NEWBORN_GET_COMPOSITION" (“Дія”). Маппінг компоненти, яка робить запит за getComposition відбувається за допомогою змінної EMAL_INTEGRATION_NEWBORN_CLIENTS_MEMBER_CODE_NAMES;
- для МВТН: CREATE_ERLN_RECORD та CANCEL_ERLN_RECORD ("ЕРЛН");
результат виклику інтеграційного компоненту (параметр “statusCode”): код обробки, повернутий від компоненту, з яким відбувається взаємодія;
повідомлення про результат обробки (параметр “statusMessage”). Для компоненту "ЕРЛН" ("ERLN") для параметру “statusMessage” використовується довідник ERLN_RESULT_CODES;
статус інтеграційного процесу (параметр ”integrationStatus” з довідника COMPOSITION_PROCESSING_STATUS): в очікуванні (PENDING), в обробці (IN_PROGRESS), оброблено (DONE) або помилка обробки (ERROR);
статус задачі (параметр “taskStatus” з довідника COMPOSITION_PROCESSING_TASK_STATUS): В очікуванні (PENDING), Не виконано (FAILED) та Виконано (DONE);
дата останнього оновлення стану інтеграційного процесу (параметр “updatedAt”);
набір даних, визначений інтеграційним компонентом (параметр “details”):
- МВН: для типу виклику до компоненту (параметр “type”) "NEWBORN_POST_COMPOSITION" компоненти "ДРАЦСГ" ("MJU_DRACZ") в наборі даних буде передаватися ідентифікатор створеної ідентифікованої дитини (параметр “personId”);
- МВТН:
  - для типу виклику "CREATE_ERLN_RECORD" до компоненти "ЕРЛН" ("ERLN") в наборі даних будуть передаватися: Єдиний реєстраційний номер ЕЛН (параметр “SL_NUM“), Дата та час реєстрації ЕЛН (параметр “SL_REG_DATETIME“), Дата відкриття ЕЛН (параметр “SL_START“), Дата подовження ЕЛН (параметр “SL_PROLONGATION“), Дата закриття ЕЛН (параметр “SL_STOP“) та Номер випадку непрацездатності (параметр “IC_NUM“).
  - для типу виклику "CANCEL_ERLN_RECORD" до компоненти "ЕРЛН" ("ERLN") в наборі даних будуть передаватися: Єдиний реєстраційний номер ЕЛН (параметр “SL_NUM“), Дата та час реєстрації ЕЛН (параметр “SL_REG_DATETIME“) та Номер випадку непрацездатності (параметр “IC_NUM“).

...

Метод АРІ може виконати лише користувач, у якого є доступ до МВ.

...

89678f60-4cdc-4fe3-ae83-e8b3ebd35c59
patientId	String($uuid) (path)	Patient object ID	89678f60-4cdc-4fe3-ae83-e8b3ebd35c59
episodeId	String($uuid) (path)	Episode of Care object ID	89678f60-4cdc-4fe3-ae83-e8b3ebd35c59
encounterId	String($uuid) (path)	Encounter object ID	89678f60-4cdc-4fe3-ae83-e8b3ebd35c59

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	ЕЛН створений за таким МВТН відсутній у реєстрі

Request structure

See on SwaggerHub (2.39.2)

Description:

Expand

title	Request schema

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'

Authorize

A token in the headers.

Check user scopes in order to perform this action (scope = 'composition:read')

return 401 (Unauthorized) in case of invalid scope(s)

Headers

Content-Type: application/json
Authorization: Bearer {token}
api-key: {secret}

Response structure

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:
1. “component“: “MJU_DRACZ“
  1. "type": "NEWBORN_POST_COMPOSITION"
    1. “personId“ - the identifier of the created record about the identified child.
2. “component“: “ERLN“
  1. "type": "CREATE_ERLN_RECORD”
    1. “SL_NUM” - ELN registration number
    2. “SL_REG_DATETIME” - ELN registration date and hour
    3. “SL_STOP” - ELN closing date
    4. “SL_START” - ELN open (extension) date
    5. “IC_NUM” - Number of temporary disability case
  2. "type": "CANCEL_ERLN_RECORD”
    1. "SL_NUM" - ELN registration number
    2. "SL_REG_DATETIME" - ELN registration date and hour
    3. "IC_NUM" - Number of temporary disability case

Response examples:

Creation of composition type “temp_disability“. Response with information on the ERLN integration process:

Expand

title	Response example

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

title	Response example

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

title	Response example

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

title	Response example

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

HTTP status code	Message	What caused the error
200	Composition found	If the request is completed and the information is found
404	Composition not found	In case the information is not found for any reason

Versions Compared

Old Version 8

New Version Current

Key

Specification*

Specification

Preconditions

Logic*

Global and configurable parameters

Input parameters

Preconditions

Logic

Configurable parameters

Input parameters

Filters

Dictionaries

Request structure*

Authorize*

Headers*

Request data validation*

Processing*

1. Using global parameters

Response structure*

Post-processing processes*

HTTP status codes*

Backward compatibility

API Method

Бізнес-процес

Опис

Dictionaries

Request structure

Authorize

Headers

Response structure

Response examples:

HTTP status codes

Page Comparison

Versions Compared

Old Version 8

New Version Current

Key

Specification*

Specification

Preconditions

Logic*

Global and configurable parameters

Input parameters

Preconditions

Logic

Configurable parameters

Input parameters

Filters

Dictionaries

Request structure*

Authorize*

Headers*

Request data validation*

Processing*

1. Using global parameters

Response structure*

Post-processing processes*

HTTP status codes*

Backward compatibility

API Method

Бізнес-процес

Опис

Dictionaries

Request structure

Authorize

Headers

Response structure

Response examples:

HTTP status codes