Spring til hovedindhold
GET
Hent en enkelt hjemmetestkitordre via dens UUID, inklusive den indlejrede patientprofil. Brug dette endpoint til at tjekke ordrens status, gennemgå leveringsadressen eller se de tilknyttede paneler og biomarkører. Kræver scopet home_kit_orders_view eller home_kit_orders_manage.

Forespørgsel

Stiparametre

string
påkrævet
Unik identifikator (UUID) for hjemmetestkitordren, der skal hentes.

Svar

Ved succes returnerer API’et 200 OK med hjemmetestkitordren 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. Detaljeret færdiggørelsesstatus for laboratorieresultaterne udledes fra Hent resultater.
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
Panelet, der er tilknyttet denne hjemmetestkitordre — altid præcis ét (et hjemmetestkit svarer 1:1 til et fysisk kitprodukt), og det kan udskiftes via Opdater, mens status er pending. 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=.

Gentagne kald

Aniva gemmer svaret fra dette endpoint i 60 minutter for hver API-nøgle. Et gentaget kald inden for dette tidsrum får det gemte svar, så længe hjemmetestkitordren er uændret. Efter en ændring får du et nyt svar. Headerne Cache-Status og Age viser, at svaret er gemt, og hvor gammelt det er. For at få besked om en ændring med det samme kan du abonnere på webhook-hændelserne home_kit_order.created og hændelsen for hver status, for eksempel home_kit_order.activated. Se Gentagne læsninger.

Fejlsvar