Naar hoofdinhoud gaan
GET
Haal een lijst met thuistestkitbestellingen op. Met een thuistestkitbestelling wordt een zelftestkit per post verstuurd — Aniva verzendt de kit, de patiënt neemt thuis zelf een monster af en stuurt dit per post terug. Elke thuistestkitbestelling bevat het ingesloten patiëntprofiel. Wanneer profile_id wordt opgegeven, worden alle thuistestkitbestellingen voor dat profiel teruggegeven. Wanneer dit wordt weggelaten, worden alle toegankelijke thuistestkitbestellingen teruggegeven. Vereist de scope home_kit_orders_view of home_kit_orders_manage.

Verzoek

Queryparameters

string
Filter op profiel-UUID. Wanneer deze wordt opgegeven, worden alle thuistestkitbestellingen voor dit profiel teruggegeven.
string
Filter op labcode (exacte overeenkomst) — herleid een fysieke kit die je in handen hebt terug naar de bestelling via de code die erop staat, bijvoorbeeld voordat je Activeren aanroept.

Respons

Bij succes geeft de API 200 OK terug met een array met thuistestkitbestelling-objecten.
string
vereist
Unieke identifier (UUID) van de thuistestkitbestelling.
string
vereist
UUID van het profiel waarbij deze thuistestkitbestelling hoort.
string
vereist
Huidige status van de thuistestkitbestelling. Een van pending, dispatched, activated of cancelled. De mate van voltooiing van de labresultaten wordt afgeleid uit Resultaten ophalen.
object
vereist
Het adres waar de kit naartoe wordt gestuurd — in een van twee vormen: ofwel { location_id } dat verwijst naar een bekende testlocatie, ofwel de inline adresvelden (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email optioneel — dezelfde velden als de locations-API). Geef precies één vorm op — een locatieverwijzing of een inline adres, niet beide.
string
Monstercode van het laboratorium waaronder de resultaten worden gerapporteerd — afgedrukt op de fysieke kit, en wat de patiënt van de doos afleest als activeringscode. null totdat de kit is verpakt. Alleen-lezen.
string
vereist
Afnametijdstempel doorgegeven via Activeren — wanneer de patiënt het monster heeft afgenomen. null totdat de kit is geactiveerd.
string
De thuistestkitbestelling die door deze bestelling wordt vervangen, als het een vervangende kit is. null bij een normale bestelling. Zie Thuistestkitbestelling aanmaken.
string
Waarom de vervangende kit is verstuurd. null bij een normale bestelling.
string[]
vereist
E-mailadressen die elk één e-mail krijgen zodra alle labresultaten definitief zijn, in kleine letters. Leeg wanneer uitgeschakeld. Zie E-mails bij beschikbare resultaten.
object
vereist
Door de partner gedefinieerde sleutel-waardeparen, letterlijk teruggegeven. Altijd aanwezig — {} indien niet ingesteld.
string
vereist
ISO 8601-tijdstempel waarop de thuistestkitbestelling is aangemaakt.
string
ISO 8601-tijdstempel van de laatste update. Kan null zijn.
object
vereist
Het patiëntprofiel dat bij deze thuistestkitbestelling hoort.
HomeKitOrderPanel[]
vereist
Het panel dat aan deze thuistestkitbestelling is gekoppeld — altijd precies één (een thuistestkit komt 1:1 overeen met een fysiek kitproduct), verwisselbaar via Bijwerken zolang de status pending is. Zoek paneldetails (naam, biomarkers) op via Panels weergeven.
HomeKitOrderIndividualBiomarker[]
vereist
Losse biomarkers die buiten een panel aan deze thuistestkitbestelling zijn gekoppeld. Vergelijk elke biomarker_id met Biomarkers weergeven met home_kit=true voor weergavegegevens.
HomeKitOrderShipmentLink[]
vereist
Pakketten die aan deze thuistestkitbestelling zijn gekoppeld, oudste koppeling eerst — normaal gesproken de kit naar de patiënt en het monster terug naar het laboratorium. Leeg totdat fulfilment een label afdrukt. Lees de volledige pakketgegevens met Zendingen weergeven en ?home_kit_order_id=.

Herhaalde aanroepen

Aniva slaat het antwoord van dit endpoint 5 minuten op per API-sleutel. Een herhaalde aanroep binnen deze tijd krijgt het opgeslagen 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.created en het event van elke status, bijvoorbeeld home_kit_order.activated. Zie Herhaalde leesaanroepen.

Foutresponsen