Hoppa till huvudinnehåll
GET
Hämta en enskild beställning av hemtestkit med dess UUID, inklusive den inbäddade patientprofilen. Använd den här slutpunkten för att kontrollera beställningens status, granska leveransadressen eller titta på de kopplade panelerna och biomarkörerna. Kräver behörigheten home_kit_orders_view eller home_kit_orders_manage.

Förfrågan

Sökvägsparametrar

string
obligatorisk
Unik identifierare (UUID) för beställningen av hemtestkit som ska hämtas.

Svar

Vid lyckat anrop returnerar API:et 200 OK med beställningen av hemtestkit och dess inbäddade profil.
string
obligatorisk
Unik identifierare (UUID) för beställningen av hemtestkit.
string
obligatorisk
UUID för profilen som den här beställningen av hemtestkit tillhör.
string
obligatorisk
Aktuell status för beställningen av hemtestkit. Ett av värdena pending, dispatched, activated eller cancelled. Detaljerad status för klara labbresultat får du från Hämta resultat.
object
obligatorisk
Adressen som kitet ska skickas till – i ett av två format: antingen { location_id } som refererar till en känd testplats, eller inline-adressfälten (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email är valfria – samma fältnamn som i locations-API:et). Ange exakt ett alternativ – en platsreferens eller en inline-adress, inte båda.
string
Laboratoriets provkod som resultaten rapporteras under – tryckt på det fysiska kitet, och det som patienten läser av från lådan som aktiveringskod. null tills kitet är packat. Skrivskyddad.
string
obligatorisk
Tidsstämpel för provtagning rapporterad via Aktivera – när patienten tog sitt prov. null tills kitet är aktiverat.
string
Beställningen av hemtestkit som den här ersätter, när det rör sig om ett ersättningskit. null för en vanlig beställning. Se Skapa beställning av hemtestkit.
string
Anledningen till att ersättningen skickades. null för en vanlig beställning.
string[]
obligatorisk
Adresser som var och en får ett mejl när alla labbresultat är slutgiltiga, i gemener. Tom när funktionen är avstängd. Se Mejl när resultat är klara.
object
obligatorisk
Partnerdefinierade nyckel/värde-par som returneras exakt som de skickades. Finns alltid med – {} när inga värden angetts.
string
obligatorisk
ISO 8601-tidsstämpel för när beställningen av hemtestkit skapades.
string
ISO 8601-tidsstämpel för den senaste uppdateringen. Kan vara null.
object
obligatorisk
Patientprofilen som är kopplad till den här beställningen av hemtestkit.
HomeKitOrderPanel[]
obligatorisk
Panelen som är kopplad till denna beställning av hemtestkit – alltid exakt en (ett hemtestkit motsvarar 1:1 en fysisk kitprodukt), och den kan bytas via Uppdatera medan status är pending. Slå upp paneldetaljer (namn, biomarkörer) via Lista paneler.
HomeKitOrderIndividualBiomarker[]
obligatorisk
Enskilda biomarkörer som är kopplade till denna beställning av hemtestkit utanför en panel. Stäm av varje biomarker_id mot Lista biomarkörer med home_kit=true för visningsdata.
HomeKitOrderShipmentLink[]
obligatorisk
Paket kopplade till denna beställning av hemtestkit, äldsta kopplingen först – vanligtvis kitet till patienten och provet tillbaka till laboratoriet. Tom tills lagret skriver ut en fraktetikett. Läs fullständig paketinformation med Lista försändelser och ?home_kit_order_id=.

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 är oförändrad. 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.created och händelsen för varje status, till exempel home_kit_order.activated. Se Upprepade läsningar.

Felsvar