Spring til hovedindhold
PATCH
Opdater leveringsadresse, panel, metadata eller e-mails om færdige resultater for en hjemmetestkitordre. Medtag kun de felter, du vil ændre. Leveringsadressen og panelet kan kun ændres, mens ordren er pending, fordi det fysiske kit sendes ved afsendelse. metadata er til din egen registrering og kan opdateres i hele ordrens levetid. Der findes ingen endpoints til at tilføje eller fjerne paneler: et hjemmetestkit har præcis ét panel (det svarer 1:1 til et fysisk kitprodukt), så den eneste meningsfulde panelhandling er det skift, du foretager her. Kræver scopet home_kit_orders_manage.

Forespørgsel

Stiparametre

string
påkrævet
Unikt id (UUID) for den hjemmetestkitordre, der skal opdateres.

Body-parametre

Alle body-parametre er valgfri — inkluder kun de felter, du vil ændre.
object
Adressen, kittet skal sendes til — i én af to former: enten { location_id }, der henviser til en kendt testlokation, eller de direkte adressefelter (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email er valgfrie — samme feltnavne som i lokations-API’et). Angiv præcis én — enten en lokationsreference eller en direkte adresse, ikke begge.
Packstation eller Postfiliale (kun Tyskland): Sæt street til Packstation eller Postfiliale, house_number til det trecifrede stationsnummer og address_line_2 til modtagerens DHL Postnummer (6–10 cifre, mellemrum tilladt). Uden Postnummer kan pakken ikke bookes. Postfach understøttes ikke.
string
UUID for det panel, der skal tilknyttes i stedet for det nuværende — med præcis ét panel pr. kit er et skift den eneste meningsfulde handling. Kun muligt, mens ordren er pending, og kun til et panel, Aniva har konfigureret med et kitprodukt til forsendelse (ellers 422); et skift til det allerede tilknyttede panel har ingen effekt.
object
Dine egne nøgle/værdi-par. Flettes ind i eksisterende metadata i stedet for at erstatte dem: nøgler, du udelader, bevares, en nøgle sendt med værdien null slettes, og et tomt objekt {} rydder alt. Grænserne svarer til Opret hjemmetestkitordre, og valideringen er alt-eller-intet — hvis en nøgle afvises, gemmes intet. Indsæt aldrig personlige eller kliniske data i metadata — de behandles ikke som patientdata.
string[]
Erstatter listen med op til 5 adresser, som hver får én e-mail, når alle laboratorieresultater er færdige. Send [] for at slå e-mails fra. Kan redigeres i alle statusser undtagen cancelled. Din nøgle skal have results_view-adgang til patienten, ellers returneres 403. Se E-mails om færdige resultater.

Svar

Ved succes returnerer API’et 200 OK med den opdaterede hjemmetestkitordre og dens indlejrede profil.
string
påkrævet
Unikt id (UUID) for hjemmetestkitordren.
string
påkrævet
UUID for den profil, som denne hjemmetestkitordre tilhører.
string
påkrævet
Aktuel status for hjemmetestkitordren. En af pending, dispatched, activated eller cancelled.
object
påkrævet
Adressen, som kittet skal sendes til — i en af to former: enten { location_id }, der henviser til en kendt testlokation, eller de direkte adressefelter (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email er valgfri — samme feltnavne som i locations-API’et). Angiv præcis én — enten en lokationsreference eller en direkte adresse, ikke begge dele.
string
Laboratoriets prøvekode, som resultaterne rapporteres under — trykt på det fysiske kit, og det, patienten aflæser på æsken som aktiveringskode. null, indtil kittet er pakket. Skrivebeskyttet.
string
påkrævet
Prøvetagningstidspunkt rapporteret via Aktivér — hvornår patienten tog sin prøve. null, indtil kittet er aktiveret.
string
Den hjemmetestkitordre, som denne erstatter, når der er tale om et erstatningskit. null på en normal ordre. Se Opret hjemmetestkitordre.
string
Årsagen til, at erstatningen blev sendt. null på en normal ordre.
string[]
påkrævet
Adresser med små bogstaver, som hver modtager én e-mail, når alle laboratorieresultater er endelige. Tom, når funktionen er slået fra. Se E-mails når resultater er klar.
object
påkrævet
Partnerdefinerede nøgle/værdi-par, der returneres uændret. Altid til stede — {} når ikke angivet.
string
påkrævet
ISO 8601-tidsstempel for, hvornår hjemmetestkitordren blev oprettet.
string
ISO 8601-tidsstempel for den seneste opdatering. Kan være null.
object
påkrævet
Patientprofilen, der er knyttet til denne hjemmetestkitordre.
HomeKitOrderPanel[]
påkrævet
Det panel, der er tilknyttet denne hjemmetestkitordre — altid præcis ét (et hjemmetestkit svarer 1:1 til et fysisk kitprodukt), som udskiftes direkte, når du sender panel_id. Slå paneldetaljer (navn, biomarkører) op via Vis paneler.
HomeKitOrderIndividualBiomarker[]
påkrævet
À la carte-biomarkører tilknyttet denne hjemmetestkitordre uden for et panel. Sammenhold hvert biomarker_id med Vis biomarkører med home_kit=true for visningsdata.
HomeKitOrderShipmentLink[]
påkrævet
Pakker knyttet til denne hjemmetestkitordre, ældste link først — normalt kittet til patienten og prøven retur til laboratoriet. Tom, indtil lageret udskriver en pakkelabel. Læs de fulde pakkeoplysninger med Vis forsendelser og ?home_kit_order_id=.

Fejlsvar