Hopp til hovedinnhold
GET
Hent kliniske og genetiske laboratorieresultater for en bestilling av hjemmetestsett, sammen med dokumentreferanser til PDF-er av laboratorierapporter. Hver biomarkør som er bestilt for settet vises i svaret, slik at du kan følge hele bestillingen og ikke bare det som har kommet tilbake. Resultater registreres under bestillingens lab_code – laboratoriebestillingen sendes ved aktivering, og laboratoriet rapporterer markørene enkeltvis etter hvert som de analyseres, så et delvis svar er normalt og status på øverste nivå forblir in_progress til sluttrapporten foreligger. Les status på hvert resultat før du bruker value:
  • Tester som fortsatt gjenstår vises med statusen planned mens bestillingen er in_progress. Du kan kalle dette endepunktet før aktivering – da har hver bestilt markør statusen planned.
  • Resultater laboratoriet har levert, men som ikke må brukes klinisk, vises med statusen fault eller undeliverable og har en status_reason som forklarer hvorfor. Et fault-resultat har fortsatt value fylt ut – den verdien er feil. Presenter den aldri som et funn.
  • Resultater Aniva eller medlemmet er usikre på vises med statusen likely_wrong og en status_reason. Verdien er ikke bekreftet. Ikke vis den som et funn uten gjennomgang.
Bruk Last ned dokument for å laste ned PDF-er med laboratorierapporter som det vises til i documents-arrayet. Du trenger ikke å polle dette endepunktet. Abonner på webhooks for home_kit_order.results.updated eller home_kit_order.results.completed, og kall endepunktet når en hendelse kommer inn. Polling fungerer fortsatt som reserveløsning. Krever scopet results_view – laboratorieresultater og dokumenter er alltid beskyttet av det, på samme måte som resultater fra timer og Last ned dokument – i tillegg til scopet home_kit_orders_view eller home_kit_orders_manage for å få tilgang til selve bestillingen.

Forespørsel

Stiparametere

string
påkrevd
Unik identifikator (UUID) for bestillingen av hjemmetestsett som resultatene skal hentes for.

Respons

Ved suksess returnerer API-et 200 OK med resultatobjektet.
string
påkrevd
Samlet status for resultatene. En av:
  • in_progress – noen rekvisisjoner er fortsatt hos laboratoriet.
  • completed – alle rekvisisjoner er avsluttet og minst én har rapportert.
  • fault – alle rekvisisjoner feilet uten å rapportere. Ingenting utestår.
object[]
påkrevd
Én oppføring per laboratorierekvisisjon – en blodprøvetaking fordelt på flere prøverør eller laboratorier har flere. Toppnivåets status er completed når alle oppføringer er avsluttet og én har rapportert.
object[]
påkrevd
Liste med kliniske biomarkørresultater.
object[]
påkrevd
Liste med genetiske biomarkørresultater.
object[]
påkrevd
Labrapportdokumenter. Bruk GET /api/v1/documents/{id} for å laste ned hver fil.

Gjentatte kall

Aniva lagrer svaret fra dette endepunktet i 60 minutter for hver API-nøkkel. Et gjentatt kall innenfor dette tidsrommet får det lagrede svaret så lenge bestillingen av hjemmetestsett og resultatene er uendret. Etter en endring får du et ferskt svar. Headerne Cache-Status og Age viser at svaret er lagret og hvor gammelt det er. For å få beskjed om en endring med én gang kan du abonnere på webhook-hendelsene home_kit_order.results.updated, home_kit_order.results.completed og home_kit_order.results.fault. Se Gjentatte lesinger.

Feilresponser