ЕСОЗ - публічна документація

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

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

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

  1. An authorized user with MIS creates and signs a composition, information from which can be used in a third-party registry.

  2. The signed composition is stored in the ESOZ.

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

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_STATUS (parameter “integrationStatus“ in response)

  • COMPOSITION_PROCESSING_SYSTEMS (parameter “component“ in response):

    • DIIA

    • ERLN

    • MJU_DRACS

  • COMPOSITION_PROCESSING_TASKS (parameter “type“ in response):

    • CANCEL_ERLN_RECORD

    • CREATE_ERLN_RECORD

    • NEWBORN_GET_COMPOSITION

    • NEWBORN_POST_COMPOSITION

  • COMPOSITION_PROCESSING_TASK_STATUS (parameter “taskStatus“ in response):

    • DONE

    • FAILED

    • PENDING

  • ERLN_RESULT_CODES (parameters “statusCode“ and “statusMessage“ in response - for ERLN only):

 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:

 Request schema
    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:

  1. updatedAt” - the date of the last update of the status of the integration process

  2. 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:

 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

 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

  • No labels