Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel7

...

  • Electronic sick leave register (ERLN) - for MVTN (temporary desability).

  • State register of acts of civil status of citizens (DRACS) - for MVN (newborn).

Getting integration data processes depends on the type of composition.

Used in processes:

Create/Sign composition (general process)

...

Link

Link to SwaggerHub (2.32.2)

Resource

/patients/{patientId}/composition/{compositionId}/episode/{episodeId}/encounter/{encounterId}/integrationData

Scope

API paragraph not foundcomposition:read

Components

Composition

Microservices

API paragraph not found

Protocol type

REST

Request type

GET

Sync/Async

Async

Public/Private/Internal

Public

Preconditions

Які передумови мають бути виконані системою/користувачем. Наприклад:

  • створений запис в MedicationRequest;

  • рецепт відпущений (COMPLETED)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

Потрібно вказати посилання на сторінки з описом глобальних та конфігураційних параметрів

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

Потрібно вказати посилання на сторінки довідників, які використовує метод API

Request structure*

See on Apiary

...

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

Authorize*

Вимоги до авторизації: яким чином надається доступ до використання методу

Request to process the request using a token in the 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*

See on SwaggerHub

...

Post-processing processes*

Що має відбутися в ЦБД після опрацювання та відправлення відповіді, тощо

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

...

Метод АРІ може виконати лише користувач, у якого є доступ до МВ.

...

      • ).