Spring til hovedindhold
GET
Hent kliniske og genetiske laboratorieresultater for en hjemmetestkitordre samt dokumentreferencer til laboratorierapporter i PDF-format. Hver biomarkør, der er bestilt til kittet, vises i svaret, så du kan følge hele ordren og ikke kun det, der er kommet retur. Resultaterne registreres under ordrens lab_code — laboratorieordren oprettes ved aktivering, og laboratoriet indberetter markørerne enkeltvis, efterhånden som de analyseres, så et delvist svar er normalt, og den overordnede status forbliver in_progress indtil den endelige rapport. Læs status på hvert resultat, før du bruger dets value:
  • Tests, der stadig afventer svar, vises med status planned, mens ordren er in_progress. Du kan kalde dette endpoint før aktivering — alle bestilte markører har da status planned.
  • Resultater, som laboratoriet har leveret, men som ikke må bruges klinisk, vises med status fault eller undeliverable og har en status_reason, der forklarer hvorfor. Et fault-resultat har stadig sin value udfyldt — den værdi er forkert. Vis den aldrig som et fund.
  • Resultater, som Aniva eller medlemmet betvivler, vises med status likely_wrong og en status_reason. Værdien er ikke bekræftet. Vis den ikke som et fund uden gennemgang.
Brug Download dokument til at downloade PDF-laboratorierapporter, der henvises til i arrayet documents. Du behøver ikke at polle dette endpoint. Abonner på webhooks for home_kit_order.results.updated eller home_kit_order.results.completed, og kald det, når du modtager en hændelse. Polling fungerer stadig som reserveløsning. Kræver scopet results_view — laboratorieresultater og dokumenter er altid beskyttet af det, ligesom resultater fra tider og Download dokument — plus scopet home_kit_orders_view eller home_kit_orders_manage for at få adgang til selve kitordren.

Forespørgsel

Stiparametre

string
påkrævet
Unik identifikator (UUID) for hjemmetestkitordren, der skal hentes resultater for.

Svar

Ved succes returnerer API’et 200 OK med resultatobjektet.
string
påkrævet
Samlet status for resultaterne. En af følgende:
  • in_progress — nogle rekvisitioner er stadig hos laboratoriet.
  • completed — alle rekvisitioner er afsluttet, og mindst én har rapporteret.
  • fault — alle rekvisitioner fejlede uden at rapportere. Der udestår intet.
object[]
påkrævet
Én post pr. laboratorierekvisition — en blodprøvetagning fordelt på flere prøveglas eller laboratorier har flere. Den overordnede status er completed, når alle poster er afsluttet, og én har rapporteret.
object[]
påkrævet
Array af kliniske biomarkørresultater.
object[]
påkrævet
Array af genetiske biomarkørresultater.
object[]
påkrævet
Dokumenter med laboratorierapporter. Brug GET /api/v1/documents/{id} til at downloade hver fil.

Gentagne kald

Aniva gemmer svaret fra dette endpoint i 60 minutter for hver API-nøgle. Et gentaget kald inden for dette tidsrum får det gemte svar, så længe hjemmetestkitordren og dens resultater er uændrede. Efter en ændring får du et nyt svar. Headerne Cache-Status og Age viser, at svaret er gemt, og hvor gammelt det er. For at få besked om en ændring med det samme kan du abonnere på webhook-hændelserne home_kit_order.results.updated, home_kit_order.results.completed og home_kit_order.results.fault. Se Gentagne læsninger.

Fejlsvar