У цій статті описано інтерфейси API, що працюють із призначеннями, та події, які система надсилає зовнішнім сервісам через webhook.
ЗМІСТ
- Загальна інформація
- GET /api/erp/v1/referral-salepack-package/{id}
- GET /api/public/v1/patients/{id}/referral-salepack-packages
- Webhooks
Загальна інформація
- Початок роботи по інтеграції з МІС Clinica Web
- Отримання даних для авторизації
- Отримання Token для доступу до API
- Використання token
ReferralSalepackPackage:
Це об’єкт, що представляє призначення пацієнту у контексті послуги/замовлення. Він містить загальні дані про призначення, дату, пов’язаний контекст замовлення, лікаря, пацієнта та статус.
| Поле | Що описує |
|---|---|
| PackageId | ідентифікатор послуги |
| SourcePrerecordId | посилання на попередній запис в контексті якого було створене призначення (якщо таке є) |
| Status | Cтатус призначення |
| TargetDate | дату рекомендованого прийому (коли пацієнт має виконати призначення) |
| CreatedAt | Коли створено призначення |
| AssuranceAproveState | статус страхової |
| Id | ідентифікатор призначення |
| SourceDiscoveryId | Ідентифікатор лікаря що призначив |
| PatientId | ідентифікатор пацієнта |
| SourceSalepackId | ідентифікатор оформленого замовлення контексті якого було створене призначенн |
| PrerecordId | Ід попереднього запису, що створено за цим призначенням |
| SalepackIds | Ід оформлених замовлень, що створені за цим призначенням |
| SourceSalepackCreatedAt | дата оформленого замовлення (контексті якого було створене призначення) |
GET /api/erp/v1/referral-salepack-package/{id}
повертає інформацію про призначення за його ідентифікатором
Необхідний скоуп - gambit:erpдетальніше про схему даних - Swagger UI
GET /api/public/v1/patients/{id}/referral-salepack-packages
овертає інформацію про усі призначення пацієнта за його ідентифікатором
Необхідний скоуп - gambit:erpдетальніше про схему даних - Swagger UI
Webhooks
Щоб зовнішні сервіси могли миттєво реагувати на зміни, система надсилає webhook-повідомлення про створення, оновлення або видалення призначень.
Типи подій (тригерів):
- ReferralSalepackPackageCreated — нове призначення створено (код 10)
ReferralSalepackPackageDeleted — призначення видалено (код 11)
ReferralSalepackPackageUpdated — призначення оновлено (код 12)
Webhook передає об’єкт призначення разом із типом події. Це дозволяє стороннім системам обробляти дані в реальному часі.
Детальніше про схему запиту - Swagger UI