Перейти к основному содержанию
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 для загруженного документа.

Ответы с ошибками