Przejdź do głównej treści
POST
Prześlij jeden plik do profilu. Wyślij go jako multipart/form-data. Bez extract_results Aniva tylko zapisuje plik. Z extract_results: true Aniva dodatkowo odczytuje z pliku wartości laboratoryjne. Nie wskazujesz, jakiego rodzaju raportem jest plik. Decyduje o tym Aniva. Plik bez wyników laboratoryjnych, taki jak list od lekarza, kończy ze statusem stored i nie jest błędem. Odczytaj wartości za pomocą Pobierz wyniki dokumentu. Nie musisz cyklicznie odpytywać API: zasubskrybuj webhooki document.results.*. Wymaga zakresu documents_upload w grupie profili, do której należy profil. extract_results: true wymaga dodatkowo zakresu documents_extract_results w tej samej grupie. Poproś Aniva o ich dodanie. Dokument należy do tej grupy: klucze z zakresem results_view w tej grupie odczytują dokument i jego wyniki. Wyślij opcjonalny nagłówek Idempotency-Key, aby przesyłanie można było bezpiecznie ponawiać. Zobacz Idempotentność.

Co robi wyodrębnianie

Z extract_results: true:
  1. Aniva wysyła plik do swoich podwykonawców OCR i AI, aby odczytać wartości.
  2. Wartości pojawiają się w aplikacji Aniva członka, jak każdy inny wynik.
  3. Każda wartość ma origin: partner_upload oraz taki sam status jak każdy inny wynik. Wartość budząca wątpliwości automatycznej kontroli Aniva ma status likely_wrong.
Bez tego plik nie trafia do żadnej zewnętrznej usługi, jeśli wyślesz też document_date.
  • Automatyczny odczyt może błędnie odczytać wartość, jednostkę lub datę. Oryginalny plik pozostaje źródłem prawdy. Porównaj z nim wartość, zanim użyjesz jej do decyzji medycznej. Odczytane wartości nie stanowią diagnozy.
  • Podwykonawcy to Mistral AI (OCR, UE) oraz Google Cloud Vertex AI, dostępny przez Vercel AI Gateway (ekstrakcja, może przetwarzać poza UE). Przetwarzają plik wyłącznie w celu jego odczytania.
  • Potrzebujesz podstawy prawnej, aby przesłać dane zdrowotne członka, zazwyczaj jego wyraźnej zgody. Ponosisz za to odpowiedzialność.

Żądanie

Pola formularza

file
wymagane
Plik. PDF, DOC, DOCX, PNG lub JPEG, maksymalnie 4 MB.
string
wymagane
UUID profilu, do którego należy dokument.
boolean
domyślnie:"false"
true, aby odczytać wartości laboratoryjne z pliku. Wyślij true lub false.
string
Data pobrania próbki w formacie YYYY-MM-DD, jeśli ją znasz. Bez niej Aniva odczyta datę z pliku.

Odpowiedź

API zwraca 201 Created, gdy tylko zapisało plik, oraz 202 Accepted, gdy trwa ekstrakcja.
string
wymagane
ID dokumentu (UUID). Użyj go w Pobierz wyniki dokumentu i Pobierz dokument.
string
wymagane
processing, gdy Aniva odczytuje wartości, lub stored, gdy plik jest tylko zapisany.
string
wymagane
Profil, do którego należy dokument.
string
Wysłana przez ciebie data pobrania próbki lub data odczytana przez Aniva z zapisanego pliku. Może mieć wartość null.
string
wymagane
Adres URL Pobierz wyniki dokumentu dla tego dokumentu.
string
wymagane
Nazwa pliku do wyświetlenia, taka sama, jaką wysyła Pobierz dokument.
string
wymagane
Nazwa przesłanego przez ciebie pliku.
string
wymagane
Zawsze partner_upload.
string
wymagane
Typ MIME pliku, np. application/pdf.
string
Wersja zawartości pliku. Może mieć wartość null.
integer
Rozmiar pliku w bajtach. Może mieć wartość null.
string
Zawsze null dla przesłanego dokumentu.

Odpowiedzi z błędami