Properties of a REST API method document

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

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.

Configuration parameters

Link 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):

Input parameters

Description of input parameters

Request structure

See on SwaggerHub (2.39.2)

See on API-specification (посилання на сторінку з API-специфікацією)

    get:
      description: 'Отримання інформації про інтеграційні процеси'
      operationId: getIntegrationData
      tags: [ 'main' ]
      parameters:
        - $ref: '#/components/parameters/compositionId'
        - $ref: '#/components/parameters/patientId'
        - $ref: '#/components/parameters/episodeId'
        - $ref: '#/components/parameters/encounterId'

Headers

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-специфікацією)

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:

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

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

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

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

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