Hoppa till huvudinnehåll
GET
Hämta kliniska och genetiska labbresultat för en beställning av hemtestkit, tillsammans med dokumentreferenser för labbrapporter i PDF-format. Varje biomarkör som beställts för kitet visas i svaret, så att du kan följa hela beställningen och inte bara det som kommit in. Resultat registreras under beställningens lab_code – laboratoriebeställningen läggs vid aktivering, och labbet rapporterar markörer var för sig när de analyseras, så ett delsvar är normalt och status på toppnivå förblir in_progress tills slutrapporten är klar. Läs av status på varje resultat innan du använder dess value:
  • Tester som ännu inte är klara visas med status planned medan beställningen har status in_progress. Du kan anropa den här slutpunkten före aktivering – då har varje beställd markör status planned.
  • Resultat som labbet levererat men som inte får användas kliniskt visas med status fault eller undeliverable, och har en status_reason som förklarar varför. Ett resultat med status fault har fortfarande ett ifyllt value – det värdet är felaktigt. Presentera det aldrig som ett fynd.
  • Resultat som Aniva eller medlemmen tvivlar på visas med status likely_wrong och en status_reason. Värdet är inte bekräftat. Visa det inte som ett fynd utan granskning.
Använd Ladda ner dokument för att ladda ner PDF-filer med labbrapporter som refereras i arrayen documents. Du behöver inte polla den här slutpunkten. Prenumerera på webhooks för home_kit_order.results.updated eller home_kit_order.results.completed, och anropa den när en händelse kommer in. Polling fungerar fortfarande som reservlösning. Kräver behörigheten results_view – labbresultat och dokument kräver alltid den, precis som resultat från bokningar och Ladda ner dokument – samt behörigheten home_kit_orders_view eller home_kit_orders_manage för att komma åt själva kitbeställningen.

Förfrågan

Sökvägsparametrar

string
obligatorisk
Unik identifierare (UUID) för den beställning av hemtestkit vars resultat ska hämtas.

Svar

Vid framgång returnerar API:et 200 OK med resultatobjektet.
string
obligatorisk
Övergripande status för resultaten. Ett av följande:
  • in_progress — vissa remisser är fortfarande hos laboratoriet.
  • completed — varje remiss har avslutats och minst en har rapporterat.
  • fault — varje remiss avbröts utan att rapportera. Inget återstår.
object[]
obligatorisk
En post per laboratorieremiss — en blodprovstagning som omfattar flera rör eller laboratorier har flera. status på toppnivå är completed när varje post har avslutats och en har rapporterat.
object[]
obligatorisk
Array med kliniska biomarkörresultat.
object[]
obligatorisk
Array med genetiska biomarkörresultat.
object[]
obligatorisk
Dokument med labbrapporter. Använd GET /api/v1/documents/{id} för att ladda ner varje fil.

Upprepade anrop

Aniva sparar svaret från den här slutpunkten i 60 minuter per API-nyckel. Ett upprepat anrop inom den tiden får det sparade svaret så länge beställningen av hemtestkit och dess resultat är oförändrade. Efter en ändring får du ett nytt svar. Huvudena Cache-Status och Age visar att svaret är sparat och hur gammalt det är. För att få reda på en ändring direkt kan du prenumerera på webhook-händelserna home_kit_order.results.updated, home_kit_order.results.completed och home_kit_order.results.fault. Se Upprepade läsningar.

Felsvar