Zum Hauptinhalt springen
GET
Rufe eine Liste von Heimtest-Kit-Bestellungen ab. Bei einer Heimtest-Kit-Bestellung wird ein Selbsttest-Kit nach Hause geschickt – Aniva versendet das Kit, der Patient entnimmt zu Hause selbst eine Probe und schickt sie per Post zurück. Jede Heimtest-Kit-Bestellung enthält das eingebettete Patientenprofil. Ist profile_id angegeben, werden alle Heimtest-Kit-Bestellungen für dieses Profil zurückgegeben. Ohne Angabe werden alle zugänglichen Heimtest-Kit-Bestellungen zurückgegeben. Erfordert den Scope home_kit_orders_view oder home_kit_orders_manage.

Anfrage

Query-Parameter

string
Nach Profil-UUID filtern. Wenn angegeben, werden alle Heimtest-Kit-Bestellungen für dieses Profil zurückgegeben.
string
Nach Laborcode filtern (exakte Übereinstimmung) – ordne ein physisches Kit anhand des aufgedruckten Codes wieder seiner Bestellung zu, z. B. vor dem Aufruf von Aktivieren.

Antwort

Bei Erfolg gibt die API 200 OK mit einem Array von Heimtest-Kit-Bestellobjekten zurück.
string
erforderlich
Eindeutige Kennung (UUID) der Heimtest-Kit-Bestellung.
string
erforderlich
UUID des Profils, zu dem diese Heimtest-Kit-Bestellung gehört.
string
erforderlich
Aktueller Status der Heimtest-Kit-Bestellung. Einer der Werte pending, dispatched, activated oder cancelled. Der genaue Fortschritt der Laborergebnisse ergibt sich aus Ergebnisse abrufen.
object
erforderlich
Die Versandadresse für das Kit – in einer von zwei Formen: entweder { location_id } als Verweis auf einen bekannten Teststandort oder die direkten Adressfelder (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email optional – dieselben Felder wie in der Locations-API). Gib genau eine Variante an – eine Standortreferenz oder eine direkte Adresse, nicht beides.
string
Labor-Probencode, unter dem die Ergebnisse gemeldet werden – auf dem physischen Kit aufgedruckt und der Aktivierungscode, den der Patient von der Box abliest. null, bis das Kit verpackt ist. Schreibgeschützt.
string
erforderlich
Zeitstempel der Probenahme, gemeldet über Aktivieren – wann der Patient seine Probe genommen hat. null, bis das Kit aktiviert ist.
string
Die Heimtest-Kit-Bestellung, die durch diese ersetzt wird, wenn es sich um ein Ersatz-Kit handelt. null bei einer normalen Bestellung. Siehe Heimtest-Kit-Bestellung erstellen.
string
Warum der Ersatz verschickt wurde. null bei einer normalen Bestellung.
string[]
erforderlich
Adressen in Kleinbuchstaben, die jeweils eine E-Mail erhalten, sobald alle Laborergebnisse final sind. Leer, wenn deaktiviert. Siehe E-Mails bei fertigen Ergebnissen.
object
erforderlich
Vom Partner definierte Schlüssel-Wert-Paare, die unverändert zurückgegeben werden. Immer vorhanden – {}, wenn nicht gesetzt.
string
erforderlich
ISO-8601-Zeitstempel, wann die Heimtest-Kit-Bestellung erstellt wurde.
string
ISO-8601-Zeitstempel der letzten Aktualisierung. Kann null sein.
object
erforderlich
Das Patientenprofil, das mit dieser Heimtest-Kit-Bestellung verknüpft ist.
HomeKitOrderPanel[]
erforderlich
Das dieser Heimtest-Kit-Bestellung zugeordnete Panel – immer genau eines (ein Heimtest-Kit entspricht 1:1 einem physischen Kit-Produkt), austauschbar über Aktualisieren, solange der Status pending ist. Details zum Panel (Name, Biomarker) findest du über Panels auflisten.
HomeKitOrderIndividualBiomarker[]
erforderlich
Einzel-Biomarker, die dieser Heimtest-Kit-Bestellung außerhalb eines Panels zugeordnet sind. Gleiche jede biomarker_id für Anzeigedaten mit Biomarker auflisten und home_kit=true ab.
HomeKitOrderShipmentLink[]
erforderlich
Sendungen, die mit dieser Heimtest-Kit-Bestellung verknüpft sind, älteste Verknüpfung zuerst – normalerweise das Kit an den Patienten und die Probe zurück an das Labor. Leer, bis der Versand ein Etikett druckt. Rufe die vollständigen Sendungsdaten über Sendungen auflisten mit ?home_kit_order_id= ab.

Wiederholte Aufrufe

Aniva speichert die Antwort dieses Endpunkts für jeden API-Key 5 Minuten lang. Ein erneuter Aufruf innerhalb dieser Zeit erhält die gespeicherte Antwort. Die Header Cache-Status und Age zeigen, dass die Antwort gespeichert ist und wie alt sie ist. Um sofort über eine Änderung informiert zu werden, abonniere die Webhook-Events home_kit_order.created und das Event des jeweiligen Status, zum Beispiel home_kit_order.activated. Siehe Wiederholte Abrufe.

Fehlerantworten