Naar hoofdinhoud gaan
GET
Haal klinische en genetische labresultaten op voor een thuistestkitbestelling, samen met documentverwijzingen voor pdf’s van labrapporten. Elke biomarker die voor de kit is besteld verschijnt in het antwoord, zodat je de hele bestelling kunt volgen in plaats van alleen wat al binnen is. Resultaten worden geregistreerd onder de lab_code van de bestelling — de laboratoriumbestelling wordt geplaatst bij activering, en het lab rapporteert markers afzonderlijk zodra ze zijn geanalyseerd, dus een gedeeltelijke payload is normaal en de status op het hoogste niveau blijft in_progress tot het eindrapport. Lees status van elk resultaat voordat je de value gebruikt:
  • Tests die nog openstaan verschijnen met status planned zolang de bestelling in_progress is. Je kunt dit endpoint vóór activering aanroepen — elke bestelde marker heeft dan de status planned.
  • Resultaten die het lab heeft geleverd maar die klinisch niet gebruikt mogen worden, verschijnen met status fault of undeliverable en bevatten een status_reason die uitlegt waarom. Een fault-resultaat heeft nog steeds een ingevulde value — die waarde is onjuist. Presenteer deze nooit als een bevinding.
  • Resultaten waar Aniva of het lid aan twijfelt, verschijnen met status likely_wrong en een status_reason. De waarde is niet bevestigd. Toon deze niet als een bevinding zonder beoordeling.
Gebruik Document downloaden om pdf’s van labrapporten te downloaden waarnaar de array documents verwijst. Je hoeft dit endpoint niet te pollen. Abonneer je op de webhooks home_kit_order.results.updated of home_kit_order.results.completed, en roep het endpoint aan zodra er een event binnenkomt. Polling werkt nog steeds als terugvaloptie. Vereist de scope results_view — labresultaten en documenten zijn hier altijd door afgeschermd, net als resultaten van afspraken en Document downloaden — plus de scope home_kit_orders_view of home_kit_orders_manage voor toegang tot de kitbestelling zelf.

Verzoek

Padparameters

string
vereist
Unieke identifier (UUID) van de thuistestkitbestelling waarvoor je resultaten wilt ophalen.

Respons

Bij succes retourneert de API 200 OK met het resultatenobject.
string
vereist
Algemene status van de resultaten. Een van:
  • in_progress — sommige aanvragen liggen nog bij het laboratorium.
  • completed — elke aanvraag is afgesloten en minstens één heeft gerapporteerd.
  • fault — elke aanvraag is mislukt zonder te rapporteren. Er staat niets meer open.
object[]
vereist
Eén item per laboratoriumaanvraag — een bloedafname verspreid over meerdere buisjes of laboratoria heeft er meerdere. De status op het hoogste niveau is completed zodra elk item is afgesloten en er één heeft gerapporteerd.
object[]
vereist
Array van klinische biomarkerresultaten.
object[]
vereist
Array van genetische biomarkerresultaten.
object[]
vereist
Documenten met laboratoriumrapporten. Gebruik GET /api/v1/documents/{id} om elk bestand te downloaden.

Herhaalde aanroepen

Aniva slaat het antwoord van dit endpoint 60 minuten lang op voor elke API-sleutel. Een herhaalde aanroep binnen deze tijd krijgt het opgeslagen antwoord zolang de thuistestkitbestelling en de resultaten ongewijzigd zijn. Na een wijziging krijg je een nieuw antwoord. De headers Cache-Status en Age laten zien dat het antwoord is opgeslagen en hoe oud het is. Om direct op de hoogte te zijn van een wijziging, abonneer je je op de webhook-events home_kit_order.results.updated, home_kit_order.results.completed en home_kit_order.results.fault. Zie Herhaalde leesaanroepen.

Foutresponsen