Naar hoofdinhoud gaan
GET
Haal klinische en genetische labresultaten voor een afspraak op, samen met documentverwijzingen voor pdf’s van labrapporten. Elke biomarker die voor de afspraak is aangevraagd, staat in de response, zodat je de hele aanvraag kunt volgen in plaats van alleen wat al binnen is. Lees status bij elk resultaat voordat je value gebruikt:
  • Tests die nog openstaan, verschijnen met de status planned zolang de afspraak in_progress is.
  • Resultaten die het lab heeft aangeleverd maar die klinisch niet gebruikt mogen worden, hebben de status fault of undeliverable, met een status_reason die uitlegt waarom. Een resultaat met fault heeft nog steeds een ingevulde value — die waarde is onjuist. Presenteer die nooit als bevinding.
  • Resultaten waar Aniva of het lid aan twijfelt, hebben de status likely_wrong en een status_reason. De waarde is niet bevestigd. Toon deze niet als bevinding zonder controle.
Elk ontvangen resultaat en document bevat de lab_code (barcode van het buisje) waaronder het is ingediend, en de array submissions vermeldt elke laboratoriumaanvraag van de bloedafname met een eigen status — een bloedafname verspreid over meerdere buisjes of laboratoria wordt aanvraag voor aanvraag afgerond. 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 appointment.results.updated of appointment.results.completed en roep het endpoint aan zodra er een event binnenkomt. Pollen werkt nog steeds als terugvaloptie. Vereist de scope results_view.

Verzoek

Padparameters

string
vereist
Unieke identifier (UUID) van de afspraak waarvoor je de 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 op per API-sleutel. Een herhaalde aanroep binnen deze tijd krijgt het opgeslagen antwoord zolang de afspraak 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. Abonneer je op de webhook-events appointment.results.updated, appointment.results.completed en appointment.results.fault om direct van een wijziging te horen. Zie Herhaald lezen.

Foutresponsen