...

Preconditions

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

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

• рецепт відпущений (COMPLETED)

Logic*

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

Global and configurable parameters

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

Input parameters

Потрібно вказати вхідні параметри запиту. Наприклад, для GET /patients/composition/job/{{asyncJobId}} вхідний параметр:

Filters

Потрібно вказати фільтри. Наприклад, для GET /api/medication_requests/{{id}}/dispenses?status=PROCESSED фільтр:

Dictionaries

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

Request structure*

See on Apiary

...

Authorize*

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

Request to process the request using a token in the headers

Headers

...

• Content-Type: application/json

• Authorization: Bearer c2778f3064753ea70de870a53795f5c9{token}

• api-key: uXhEczJ56adsfh3Ri9SUkc4en{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 ApiarySwaggerHub

ERLN Example:

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

Post-processing processes*

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

HTTP status codes*

Backward compatibility

Сумісність з попередніми версіями методу

API Method

https://app.swaggerhub.com/apis/ehealthua/compositions/2.32.2#/main/getIntegrationData

Бізнес-процес

2. Cтворення/підписання МВ (загальний процес)

5. Продовження / скорочення МВТН

6. Уточнення (preperson -> person) для МВТН

...

Опис

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

...