Purpose

The method is designed to obtain information on the integration processes of interaction with 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 third-party registry.

Integration with the following third-party registries is implemented:

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

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.32.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	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.

Input parameters

Input parameter	Type	Description	Example
compositionId	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)	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_SYSTEMS
COMPOSITION_PROCESSING_TASKS
ERLN_RESULT_CODES
COMPOSITION_PROCESSING_STATUS

Request structure*

See on SwaggerHub (2.32.2)

Description:

Request example

    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

Parameter values for the DRACS registry:

Parameter	Name	Source	Description	Translation (UA)
component	MJU_DRACS
component	DIIA

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

Response example

[
  {
    "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 and DRACSG integration process:

Response example

[
  {
    "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"
  }
]

[
  {
    "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"
  }
]

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

Response example

[
  {
    "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
404

Опис

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

компонент, з яким відбувається взаємодія (параметр “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“).