Hopp til hovedinnhold
GET
Hent en liste over bestillinger av hjemmetestsett. En bestilling av hjemmetestsett sender ut et hjemmetestsett i posten – Aniva sender settet, pasienten tar prøven selv hjemme og sender den tilbake i posten. Hver bestilling av hjemmetestsett inkluderer den innebygde pasientprofilen. Når profile_id oppgis, returneres alle bestillinger av hjemmetestsett for denne profilen. Når det utelates, returneres alle tilgjengelige bestillinger av hjemmetestsett. Krever scopet home_kit_orders_view eller home_kit_orders_manage.

Forespørsel

Spørreparametere

string
Filtrer etter profilens UUID. Når den oppgis, returneres alle bestillinger av hjemmetestsett for denne profilen.
string
Filtrer etter labkode (nøyaktig treff) – finn bestillingen som hører til et fysisk testsett du har i hånden ved hjelp av koden som står trykt på det, f.eks. før du kaller Aktiver.

Respons

Ved suksess returnerer API-et 200 OK med et array med objekter for bestillinger av hjemmetestsett.
string
påkrevd
Unik identifikator (UUID) for bestillingen av hjemmetestsett.
string
påkrevd
UUID for profilen denne bestillingen av hjemmetestsett tilhører.
string
påkrevd
Gjeldende status for bestillingen av hjemmetestsett. En av pending, dispatched, activated eller cancelled. Detaljert ferdigstillelsesstatus for laboratorieresultater hentes fra Hent resultater.
object
påkrevd
Adressen settet skal sendes til – én av to former: enten { location_id } som refererer til et kjent teststed, eller direkte adressefelt (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email er valgfrie – samme struktur som i lokasjons-API-et). Oppgi nøyaktig én – en stedsreferanse eller en direkte adresse, ikke begge.
string
Prøvekode hos laboratoriet som resultatene rapporteres under – trykt på det fysiske settet, og det pasienten leser av esken som aktiveringskode. null til settet er pakket. Skrivebeskyttet.
string
påkrevd
Prøvetakingstidspunkt rapportert via Aktiver – når pasienten tok prøven sin. null til settet er aktivert.
string
Bestillingen av hjemmetestsett som denne erstatter, når det er et erstatningssett. null ved en vanlig bestilling. Se Opprett bestilling av hjemmetestsett.
string
Hvorfor erstatningen ble sendt. null ved en vanlig bestilling.
string[]
påkrevd
Adresser som hver får én e-post når alle labresultater er endelige, i små bokstaver. Tom når den er slått av. Se E-poster om klare resultater.
object
påkrevd
Partnerdefinerte nøkkel/verdi-par, returnert uendret. Alltid med – {} når ikke angitt.
string
påkrevd
ISO 8601-tidsstempel for når bestillingen av hjemmetestsett ble opprettet.
string
ISO 8601-tidsstempel for siste oppdatering. Kan være null.
object
påkrevd
Pasientprofilen som er knyttet til denne bestillingen av hjemmetestsett.
HomeKitOrderPanel[]
påkrevd
Panelet som er knyttet til denne bestillingen av hjemmetestsett – alltid nøyaktig ett (et hjemmetestsett tilsvarer 1:1 et fysisk testsettprodukt), og det kan byttes via Oppdater mens status er pending. Slå opp paneldetaljer (navn, biomarkører) via List opp paneler.
HomeKitOrderIndividualBiomarker[]
påkrevd
Enkeltstående biomarkører som er knyttet til denne bestillingen av hjemmetestsett utenom et panel. Kryssjekk hver biomarker_id mot List opp biomarkører med home_kit=true for visningsdata.
HomeKitOrderShipmentLink[]
påkrevd
Pakker knyttet til denne bestillingen av hjemmetestsett, med den eldste først – vanligvis settet til pasienten og prøven tilbake til laboratoriet. Tom inntil lageret skriver ut en fraktetikett. Les de fullstendige pakkedetaljene med List opp forsendelser og ?home_kit_order_id=.

Gjentatte kall

Aniva lagrer svaret fra dette endepunktet i 5 minutter for hver API-nøkkel. Et gjentatt kall innenfor denne tiden får det lagrede svaret. Headerne Cache-Status og Age viser at svaret er lagret og hvor gammelt det er. For å få beskjed om en endring med én gang kan du abonnere på webhook-hendelsene home_kit_order.created og hendelsen for hver status, for eksempel home_kit_order.activated. Se Gjentatte lesinger.

Feilresponser