...

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:

...

Creating "a replacement" composition

Specification

...

Link	Link to SwaggerHub (2.

32

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

...

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

Global and configurable parameters

...

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

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

• COMPOSITION_PROCESSING_STATUS

...

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

Request structure

See on SwaggerHub (2.3239.2)

Description:

    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}

Request data validation*

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

Наприклад:

1. Validate request using JSON schema

   1. In case validation failed - generate 422 error

Processing*

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

1. Using global parameters

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

Response structure*

...

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:

...

• Creation of composition type “newborn“. Response with information on DIIA and DRACSG integration process:

[
  {
    "component": "MJU_DRACSDIIA",
    "details": {
      "personId": "fe88454e-7867-4795-8ab5-1fa54493a3d6",
    },
    "integrationStatus": "DONE",
    "taskStatus": "DONE",
    "type": "NEWBORN_POSTGET_COMPOSITION",
    "updatedAt": "2022-09-14T0814T07:3547:0300.383Z388Z"
  }
]

[,
  {
    "component": "DIIAMJU_DRACS",
    "details": {
      "personId": "8cd52d25-1136-47ef-a0a7-efac9b941b67"
    },
    "integrationStatus": "DONE",
    "taskStatus": "DONE",
    "type": "NEWBORN_GETPOST_COMPOSITION",
    "updatedAt": "2022-09-14T0714T08:4735:0011.388Z330Z"
  },
]

• Creation of composition type “newborn“. Response with information on DRACSG integration process:

[
  {
    "component": "MJU_DRACS",
    "details": {
      "personId": "8cd52d25fe88454e-11367867-47ef4795-a0a78ab5-efac9b941b671fa54493a3d6",
    },
    "integrationStatus": "DONE",
    "taskStatus": "DONE",
    "type": "NEWBORN_POST_COMPOSITION",
    "updatedAt": "2022-09-14T08:35:1103.330Z383Z"
  }
]

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

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

Post-processing processes*

...

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

 

 

Опис

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

...

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

...