Hoppa till huvudinnehåll
POST
Begär en hemtestkitbeställning för en patientprofil. En hemtestkitbeställning skickar hem ett testkit för egenprovtagning med posten — Aniva skickar kitet till leveransadressen, patienten tar själv ett prov hemma och postar tillbaka det. Detta skiljer sig från en bokning, som är en venös blodprovstagning på en provtagningsplats. Exakt en panel krävs. Ett hemtestkit motsvarar 1:1 en fysisk kitprodukt — panelen är kitet — och beställningen hamnar i packkön så snart den skapas, så sammansättningen måste vara klar från början. Du kan fortfarande byta panel via Uppdatera hemtestkitbeställning medan beställningen är pending.

Ersättningskit

När ett kit inte kan leverera sina resultat — patienten kunde inte fylla röret, provet kom fram med för lite material, laboratoriet kunde inte analysera det — beställ en ersättning genom att skicka replaces_home_kit_order_id. En ersättning är en ny beställning med en ny labbkod, även när det första kitet aldrig aktiverades: laboratoriet behöver en ny remiss, och två prover med samma kod går inte att skilja åt. Beställningen du ersätter rörs inte — den behåller sin egen status, sin egen labbkod och eventuella resultat som redan registrerats under den. Två saker följer av det:
  • Panelen ärvs. Utelämna panel_id så får ersättningen samma panel som beställningen den ersätter, vilket är det patienten köpte och hur lådan är märkt.
  • Du väljer vad som analyseras om. Skicka biomarker_ids med de markörer som misslyckades så analyserar laboratoriet bara dem igen, och kitet skickas bara med de rör som behövs. Utelämna fältet för att analysera om hela panelen.
Markörer analyseras om enligt panelens grupper, inte en och en. Om du anger en markör i en grupp analyseras hela den gruppen om, eftersom det inte går att lägga en laboratoriebeställning som rapporterar mer än vad som begärts. En ersättning med en markör kan därför komma med fler än ett resultat, och antalet rör kan vara större än vad markörlistan antyder. Bara en ersättning per kit får vara på väg åt gången.
Om du integrerade innan de här fälten fanns läser Aniva även metadata.original_kit_id och metadata.replacement_reason när en beställning skapas och behandlar den som en ersättning. Det här är det enda stället där metadata tolkas, det finns bara kvar för att stödja den tidigare integrationen, och fälten ovan vinner alltid. Skicka fälten.
En 201 innebär att beställningen är bekräftad och lämnas över till expediering — du behöver inte göra något mer för att kitet ska packas och skickas. Kräver scopet home_kit_orders_manage. Skicka med en valfri Idempotency-Key-header så att anropet säkert kan upprepas – om samma nyckel skickas igen returneras det ursprungliga svaret i stället för att en andra bokning skapas. Se Idempotens.

Förfrågan

Body-parametrar

string
obligatorisk
UUID för patientprofilen som hemtestkitbeställningen ska skapas för.
string
obligatorisk
UUID för katalogpanelen som ska beställas. Exakt en — ett hemtestkit motsvarar 1:1 en fysisk kitprodukt, så panelen är kitet. Panel-ID:n får du från Aniva för ditt partnerkonto; se Lista paneler. Valfritt vid en ersättning, där den som standard får panelen från beställningen du ersätter.
string
UUID för hemtestkitbeställningen som den här ersätter. Om du skickar det blir det här ett ersättningskit — se Ersättningskit ovan. Beställningen måste tillhöra samma profil och får inte redan ha en ersättning på väg.
string
Varför ersättningen behövs, i en mening (till exempel Zu wenig Material, HbA1c nicht auswertbar). Krävs när du skickar replaces_home_kit_order_id och ignoreras annars. Högst 500 tecken.
integer[]
Vid en ersättning, de markörer som laboratoriet analyserar om — normalt de som det första kitet inte kunde leverera. Varje markör måste ingå i det som beställningen du ersätter begärde; stäm av mot Lista biomarkörer med home_kit=true. Utelämna fältet för att analysera om hela panelen. Accepteras bara tillsammans med replaces_home_kit_order_id och inte tillsammans med ett annat panel_id. Detta kräver inget extra scope: att analysera om markörer som patienten redan betalat för är inget à la carte-val.
object
Dina egna nyckel/värde-par som returneras ordagrant vid varje läsning och aldrig tolkas av Aniva. Använd det för att skicka med din beställningsreferens så att du kan koppla ihop dem utan att spara våra ID:n. Högst 20 nycklar; nycklar matchar [A-Za-z0-9_-] och är högst 40 tecken; värden är en sträng, ett tal eller ett booleskt värde, med strängar på högst 500 tecken; totalt 16 384 byte serialiserat. Nycklar som börjar med aniva_ är reserverade. Lägg aldrig personuppgifter eller kliniska data i metadata — det behandlas inte som patientdata.
string[]
Upp till 5 adresser som vardera får ett mejl när alla labbresultat är klara. Mejlet länkar till resultatsidan i Anivas adminpanel. Din nyckel behöver behörigheten results_view för patienten, annars returneras 403. Utelämna fältet för att använda standardadresserna för patientens grupp. En tom lista stänger av mejlen. Se Mejl när resultat är klara.
object
obligatorisk
Adressen som kitet ska skickas till — i en av två former: antingen { location_id } som refererar till en känd provtagningsplats, eller adressfälten direkt i objektet (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 direkt adress, inte båda.
Packstation eller Postfiliale (endast Tyskland): sätt street till Packstation eller Postfiliale, house_number till det tresiffriga stationsnumret och address_line_2 till mottagarens DHL Postnummer (6–10 siffror, mellanslag tillåtna). Utan Postnummer kan paketet inte bokas. Postfach stöds inte.

Svar

Vid lyckat anrop returnerar API:et 201 Created med den nya hemtestkitbeställningen.
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
Nuvarande status för hemtestkitbeställningen. Ett av pending, dispatched, activated eller cancelled. En nyskapad beställning börjar i pending.
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.
object
obligatorisk
De nyckel/värde-par du angav. Alltid med — {} om du inte angav några.
string
Hemtestkitbeställningen som den här ersätter. null på en vanlig beställning.
string
Anledningen du angav. null på 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.
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
Tidpunkt för provtagning rapporterad via Aktivera. null tills kitet aktiveras.
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 den här hemtestkitbeställningen — den du angav som panel_id, med tidsstämpel för när beställningen skapades. Alltid exakt en. Slå upp paneldetaljer (namn, biomarkörer) via Lista paneler.
HomeKitOrderIndividualBiomarker[]
obligatorisk
Biomarkörer kopplade utanför panelen. Tom när en vanlig beställning skapas — hemtestkitbeställningar beställs per panel, och att ändra den här listan i efterhand kräver behörighetsscopet home_kit_orders_individual_biomarker_selection. Vid en ersättning innehåller den de biomarker_ids du skickade, vilket är det laboratoriet analyserar om.
HomeKitOrderShipmentLink[]
obligatorisk
Paket kopplade till den här hemtestkitbeställningen, äldsta kopplingen först. Alltid tom när beställningen skapas — hämta de fullständiga paketen med Lista försändelser och ?home_kit_order_id=.

Felsvar