Purpose
The method is designed to obtain information on the integration processes of interaction with external 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 registry.
Integration with the following external registries is implemented:
Electronic sick leave register (ERLN) - for MVTN (temporary desability).
State register of acts of civil status of citizens (DRACS) - for MVN (newborn).
Specification*
Link |
| Посилання на Apiary або Swagger |
Resource |
| Посилання на ресурс, наприклад: /api/persons/create |
Scope |
| Scope для доступу |
Components |
| Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription |
Microservices |
| Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC |
Protocol type |
| Тип протоколу, який використовується запитом, наприклад: SOAP | REST |
Request type |
| Тип запиту API, наприклад: GET, POST, PATCH… |
Sync/Async |
| Метод є синхронним чи асинхронним? |
Public/Private/Internal |
| Потрібно зазначити тип методу за ступенем доступності |
Preconditions
Які передумови мають бути виконані системою/користувачем. Наприклад:
створений запис в MedicationRequest;
рецепт відпущений (COMPLETED)
Logic*
Потрібно по пунктах описати логіку методу API або додати діаграму
Global and configurable parameters
Потрібно вказати посилання на сторінки з описом глобальних та конфігураційних параметрів
Input parameters
Потрібно вказати вхідні параметри запиту. Наприклад, для GET /patients/composition/job/{{asyncJobId}} вхідний параметр:
Input parameter | Values | Type | Description | Example |
|---|---|---|---|---|
asyncJobId |
| String | Async Job Object ID |
|
Filters
Потрібно вказати фільтри. Наприклад, для GET /api/medication_requests/{{id}}/dispenses?status=PROCESSED фільтр:
Filter | Values | Type | Description | Example |
|---|---|---|---|---|
status |
| String | Optional | PROCESSED |
Dictionaries
Потрібно вказати посилання на сторінки довідників, які використовує метод API
Request structure*
See on Apiary
Example:
Authorize*
Вимоги до авторизації: яким чином надається доступ до використання методу
Request to process the request using a token in the headers
Headers*
Наприклад:
Content-Type:application/json
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
api-key:uXhEczJ56adsfh3Ri9SUkc4en
Request data validation*
Валідація даних
Наприклад:
Validate request using JSON schema
In case validation failed - generate 422 error
Processing*
Потрібно описати процеси, які відбуваються з даними
1. Using global parameters
Потрібно викликати глобальні параметри (Global parameters), щоб отримати наведені нижче параметри
Response structure*
See on Apiary
Example:
Post-processing processes*
Що має відбутися в ЦБД після опрацювання та відправлення відповіді, тощо
HTTP status codes*
HTTP status code | Message | What caused the error |
|---|---|---|
|
|
|
|
|
|
Backward compatibility
Сумісність з попередніми версіями методу
API Method
https://app.swaggerhub.com/apis/ehealthua/compositions/2.32.2#/main/getIntegrationData
Бізнес-процес
2. Cтворення/підписання МВ (загальний процес)
5. Продовження / скорочення МВТН
6. Уточнення (preperson -> person) для МВТН
RC_7. Створення МВ “на заміну”
Опис
Метод призначений для отримання інформації про інтеграційні процеси, а саме:
компонент, з яким відбувається взаємодія (параметр “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“).
Формування даних по інтеграційних процесах відбувається в залежності від типу МВ.
Метод АРІ може виконати лише користувач, у якого є доступ до МВ.
Метод АРІ можна виконати по МВ у статусі (FINAL, AMENDED, ENTERED-IN-ERROR).