ЕСОЗ - публічна документація
Пропонована структура статті опису технологічного методу системи eHealth
Опис методу
Загальні дані методу:
- Бізнес процесси в яких задіюється метод
- Функціональна задача методу
- Клієнти та ролі, які використовують метод
- Результат відпрацювання методу
Модель даних методу
Даний розділ відображає необхідну модель даних методу у вигляді таблиці з переліком атрибутів та їх пояснень.
Використані валідації даних (за наявності)
Даний розділ описує процес попередньої валідації даних, що задіяні в методі. Процес валідації може відображатися як діаграмами( UML,Sequence), так і текстом.
JSON схеми валідацій (за наявності)
Даний розділ приводить JSON схеми валідації даних, що задіяні в роботі методу
"description": "settlement type Dictionary: SETTLEMENT_TYPE"
},
"settlement_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
},
Технічні параметри методу
Даний розділ приводить всі необхідні технічні прараметри для виконання методу.
Приклад
URL: Посилання для запиту метода
Headers: Заголовок повідомлення методу
Request: Приклад запиту до системи.
Response: Приклад відповіді системи на описаний запит.
Errors: Перелік можливих помилок в ході діалогу з посиланням на Довідник Помилок
ЕСОЗ - публічна документація