Hoppa till huvudinnehåll
PATCH
Uppdatera leveransadress, panel, metadata eller e-postadresser för klara resultat för en hemtestkitbeställning. Ta bara med de fält du vill ändra. Leveransadressen och panelen kan bara ändras medan beställningen är pending, eftersom det fysiska kitet skickas vid utskick. metadata är din egen bokföring och går att skriva till under hela beställningens livstid. Det finns inga endpoints för att lägga till eller ta bort paneler: ett hemtestkit har exakt en panel (det motsvarar 1:1 en fysisk kitprodukt), så den enda meningsfulla panelåtgärden är bytet du gör här. Kräver scopet home_kit_orders_manage.

Förfrågan

Sökvägsparametrar

string
obligatorisk
Unik identifierare (UUID) för hemtestkitbeställningen som ska uppdateras.

Body-parametrar

Alla body-parametrar är valfria – ta bara med de fält du vill ändra.
object
Adressen som kitet ska skickas till — i ett av två format: antingen { location_id } som hänvisar till en känd provtagningsplats, eller inline-adressfälten (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email är valfria — samma vokabulär som i plats-API:et). Ange exakt ett av dem — en platsreferens eller en inline-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.
string
UUID för panelen som ska kopplas i stället för den nuvarande — med exakt en panel per kit är ett byte den enda meningsfulla åtgärden. Gäller bara medan beställningen är pending, och bara till en panel som Aniva har konfigurerat med en kitprodukt för leverans (annars 422); ett byte till den redan kopplade panelen gör ingenting.
object
Dina egna nyckel/värde-par. Slås ihop med befintlig metadata i stället för att ersätta den: nycklar du utelämnar bevaras, en nyckel som skickas med värdet null tas bort och ett tomt objekt {} rensar allt. Gränserna motsvarar Skapa hemtestkitbeställning och valideringen är allt-eller-inget — om någon nyckel avvisas skrivs ingenting. Lägg aldrig personuppgifter eller kliniska data i metadata — det behandlas inte som patientdata.
string[]
Ersätter listan med upp till 5 adresser som får ett mejl vardera när alla labbresultat är slutgiltiga. Skicka [] för att stänga av mejlen. Kan redigeras i alla statusar utom cancelled. Din nyckel behöver results_view-åtkomst till patienten, annars returneras 403. Se Mejl när resultat är klara.

Svar

Vid framgång returnerar API:et 200 OK med den uppdaterade hemtestkitbeställningen 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 hemtestkitbeställningen. Ett av värdena pending, dispatched, activated eller cancelled.
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 hör till den här hemtestkitbeställningen — alltid exakt en (ett hemtestkit motsvarar 1:1 en fysisk kitprodukt), och byts ut på plats när du skickar panel_id. 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=.

Felsvar