Перейти до основного вмісту
POST
Завантаж один файл до профілю. Надішли його як multipart/form-data. Без extract_results Aniva лише зберігає файл. З extract_results: true Aniva також зчитує лабораторні показники з файлу. Ти не вказуєш, який це тип звіту. Це визначає Aniva. Файл без лабораторних результатів, наприклад лист лікаря, отримує статус stored, і це не є помилкою. Читай значення за допомогою Отримати результати документа. Опитувати API не потрібно: підпишись на вебхуки document.results.*. Потрібен дозвіл documents_upload для групи профілів, до якої належить профіль. Для extract_results: true також потрібен дозвіл documents_extract_results для тієї самої групи. Попроси Aniva додати їх. Документ належить цій групі: ключі з дозволом results_view для неї можуть читати документ і його результати. Надішли необов’язковий заголовок Idempotency-Key, щоб завантаження можна було безпечно повторити. Детальніше — у розділі Ідемпотентність.

Що робить витягування

З extract_results: true:
  1. Aniva надсилає файл своїм субпроцесорам OCR та ШІ, щоб зчитати значення.
  2. Значення з’являються в застосунку Aniva учасника, як і будь-який інший результат.
  3. Кожне значення має origin: partner_upload і той самий status, що й будь-який інший результат. Значення, у якому автоматична перевірка Aniva сумнівається, має статус likely_wrong.
Без нього файл не передається жодному сторонньому сервісу, якщо ти також надсилаєш document_date.
  • Автоматичне зчитування може помилково розпізнати значення, одиницю виміру або дату. Оригінальний файл залишається джерелом істини. Звір значення з ним, перш ніж використовувати його для медичного рішення. Зчитані значення не є діагнозом.
  • Субпроцесори — Mistral AI (OCR, ЄС) і Google Cloud Vertex AI, доступний через Vercel AI Gateway (видобування даних, може обробляти за межами ЄС). Вони обробляють файл лише щоб зчитати його.
  • Тобі потрібна правова підстава для завантаження даних про здоров’я учасника, зазвичай його явна згода. Ти відповідаєш за це.

Запит

Поля форми

file
обов'язково
Файл. PDF, DOC, DOCX, PNG або JPEG, не більше 4 MB.
string
обов'язково
UUID профілю, до якого належить документ.
boolean
за замовчуванням:"false"
true, щоб зчитати лабораторні значення з файлу. Надсилай true або false.
string
Дата забору зразка у форматі YYYY-MM-DD, якщо ти її знаєш. Без неї Aniva зчитає дату з файлу.

Відповідь

API повертає 201 Created, коли файл лише збережено, і 202 Accepted, коли виконується видобування.
string
обов'язково
ID документа (UUID). Використовуй його з Отримати результати документа та Завантажити документ.
string
обов'язково
processing, поки Aniva видобуває значення, або stored, коли файл лише збережено.
string
обов'язково
Профіль, до якого належить документ.
string
Надіслана тобою дата забору зразка або дата, яку Aniva зчитала зі збереженого файлу. Може бути null.
string
обов'язково
URL для Отримати результати документа цього документа.
string
обов'язково
Назва файлу для відображення — та сама, яку надсилає Завантажити документ.
string
обов'язково
Назва завантаженого тобою файлу.
string
обов'язково
Завжди partner_upload.
string
обов'язково
Медіатип файлу, наприклад application/pdf.
string
Версія вмісту файлу. Може бути null.
integer
Розмір файлу в байтах. Може бути null.
string
Завжди null для завантаженого документа.

Відповіді з помилками