...

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

...

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

Input parameters

...

    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*

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

Наприклад:

1. Validate request using JSON schema

   1. In case validation failed - generate 422 error

Processing*

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

1. Using global parameters

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

Response structure*

See on SwaggerHubSee on SwaggerHub

Parameter values for the DRACS registry:

• Creation 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*

...