| Table of Contents | ||||
|---|---|---|---|---|
|
Purpose
...
Необхідно зазначити призначення методу, а також посилання на бізнес процеси, в яких він задіяний
Наприклад: This method allows to receive active person declarations issued by the current legal entity (based on access_token)
...
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
...
| Expand | ||
|---|---|---|
| ||
|
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
...
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
...