Purpose*
Необхідно зазначити призначення методу.
Наприклад: This method allows to receive active person declarations issued by the current legal entity (based on access_token)
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 |
| Потрібно зазначити тип методу за ступенем доступності |
Logic*
Потрібно по пунктах описати логіку методу API або додати діаграму
Preconditions
Які передумови мають бути виконані системою/користувачем. Наприклад:
створений запис в MedicationRequest;
рецепт відпущений (COMPLETED)
Global and configurable parameters
Потрібно вказати глобальні та конфігураційні параметри.
Наприклад:
Variable | Values | Description |
|---|---|---|
CARE_PLAN_<category>_ICD10_AM_CONDITIONS_ALLOWED
| Values that matches with dictionary Example: “E10.32, E11.92” | Allowed diagnoses for specified care plan category. Diagnoses should match with (Example: CARE_PLAN_CLASS_1_ICD10_AM_CONDITIONS_ALLOWED) |
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
Сумісність з попередніми версіями методу