Documenti
Ottieni risultati del documento
Leggi lo stato e i valori di laboratorio estratti di un documento che hai caricato
GET
/
api
/
v1
/
documents
/
{id}
/
results
curl --request GET \
--url https://anivahealth.com/api/v1/documents/f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c/results \
--header 'x-api-key: YOUR_API_KEY'
{
"status": "stored",
"submissions": [{ "lab_code": null, "status": "completed" }],
"clinical_results": [],
"genetic_results": [],
"documents": [
{
"id": "f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c",
"file_name": "20261023 - Arztbrief.pdf",
"original_file_name": "arztbrief.pdf",
"origin": "partner_upload",
"content_type": "application/pdf",
"etag": "56104b36f860cfd5b41efc716fdf7b6f",
"size_bytes": 182311,
"lab_code": null
}
]
}
Leggi lo stato e i valori di laboratorio di un documento caricato con
Carica documento. La risposta ha la stessa struttura di
Ottieni risultati di laboratorio per un appuntamento. Consulta
Risultati per tutti i campi.
Rispondono solo i documenti caricati in un gruppo di profili in cui la tua chiave può leggere i risultati. Ogni altro
documento restituisce
404: leggi i suoi risultati dall’appuntamento o dall’ordine di kit domiciliare che lo ha generato.
Non devi fare polling. Iscriviti ai webhook document.results.updated o
document.results.completed e chiama questo endpoint quando arriva un evento.
Richiede lo scope results_view sul gruppo di profili in cui il documento è stato caricato.
Richiesta
Parametri di percorso
Header
L’
ETag di una risposta precedente. Se non è cambiato nulla, l’API risponde con 304 Not Modified
senza body.Risposta
In caso di successo, l’API restituisce200 OK con l’oggetto dei risultati e un header ETag.
Uno dei seguenti valori:
in_progress— Aniva sta estraendo i valori.completed— estrazione completata.fault— estrazione non riuscita.stored— il documento non contiene valori: lo hai caricato senzaextract_resultsoppure non contiene risultati di laboratorio.storedè definitivo: non segue alcun webhookdocument.results.completed.
I valori estratti. Ogni valore ha
origin: partner_upload. Un referto con più date di
campionamento assegna a ogni valore il proprio tested_at. Mai planned: un caricamento non ordina nulla.Risposte di errore
| Stato | Descrizione |
|---|---|
304 | Non modificato — l’etag di If-None-Match corrisponde ancora. Nessun body. |
400 | Formato dell’ID non valido. |
403 | La tua chiave API non dispone dello scope results_view. |
404 | Nessun documento caricato in uno dei tuoi gruppi di profili ha questo ID. |
500 | Errore interno del server. |
curl --request GET \
--url https://anivahealth.com/api/v1/documents/f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c/results \
--header 'x-api-key: YOUR_API_KEY'
{
"status": "stored",
"submissions": [{ "lab_code": null, "status": "completed" }],
"clinical_results": [],
"genetic_results": [],
"documents": [
{
"id": "f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c",
"file_name": "20261023 - Arztbrief.pdf",
"original_file_name": "arztbrief.pdf",
"origin": "partner_upload",
"content_type": "application/pdf",
"etag": "56104b36f860cfd5b41efc716fdf7b6f",
"size_bytes": 182311,
"lab_code": null
}
]
}
⌘I
curl --request GET \
--url https://anivahealth.com/api/v1/documents/f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c/results \
--header 'x-api-key: YOUR_API_KEY'
{
"status": "stored",
"submissions": [{ "lab_code": null, "status": "completed" }],
"clinical_results": [],
"genetic_results": [],
"documents": [
{
"id": "f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c",
"file_name": "20261023 - Arztbrief.pdf",
"original_file_name": "arztbrief.pdf",
"origin": "partner_upload",
"content_type": "application/pdf",
"etag": "56104b36f860cfd5b41efc716fdf7b6f",
"size_bytes": 182311,
"lab_code": null
}
]
}