Zum Hauptinhalt springen
PATCH
Aktualisiere Lieferadresse, Panel, Metadaten oder die E-Mails bei fertigen Ergebnissen einer Heimtest-Kit-Bestellung. Gib nur die Felder an, die du ändern möchtest. Lieferadresse und Panel können nur geändert werden, solange die Bestellung pending ist, da das physische Kit beim Versand verschickt wird. metadata dient deiner eigenen Verwaltung und bleibt über die gesamte Laufzeit der Bestellung bearbeitbar. Es gibt keine Endpunkte zum Hinzufügen oder Entfernen von Panels: Ein Heimtest-Kit enthält genau ein Panel (es entspricht 1:1 einem physischen Kit-Produkt), daher ist der Tausch hier der einzige sinnvolle Vorgang. Erfordert den Scope home_kit_orders_manage.

Anfrage

Pfadparameter

string
erforderlich
Eindeutige Kennung (UUID) der Heimtest-Kit-Bestellung, die aktualisiert werden soll.

Body-Parameter

Alle Body-Parameter sind optional – gib nur die Felder an, die du ändern möchtest.
object
Die Adresse, an die das Kit gesendet wird – in einem von zwei Formaten: 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 – entweder einen Standortverweis oder eine direkte Adresse, nicht beides.
Packstation oder Postfiliale (nur Deutschland): Setze street auf Packstation oder Postfiliale, house_number auf die dreistellige Stationsnummer und address_line_2 auf die DHL-Postnummer des Empfängers (6–10 Ziffern, Leerzeichen erlaubt). Ohne die Postnummer kann das Paket nicht gebucht werden. Ein Postfach wird nicht unterstützt.
string
UUID des Panels, das anstelle des aktuellen zugewiesen werden soll – bei genau einem Panel pro Kit ist ein Tausch der einzige sinnvolle Vorgang. Nur möglich, solange die Bestellung pending ist, und nur für ein Panel, für das Aniva ein Versand-Kit-Produkt konfiguriert hat (sonst 422); ein Tausch auf das bereits zugewiesene Panel hat keine Wirkung.
object
Deine eigenen Schlüssel-Wert-Paare. Sie werden mit den vorhandenen Metadaten zusammengeführt, statt sie zu ersetzen: Ausgelassene Schlüssel bleiben erhalten, ein Schlüssel mit dem Wert null wird gelöscht und ein leeres Objekt {} löscht alles. Die Limits entsprechen Heimtest-Kit-Bestellung erstellen, und die Validierung gilt nach dem Alles-oder-nichts-Prinzip – wird ein Schlüssel abgelehnt, wird nichts geschrieben. Speichere niemals personenbezogene oder klinische Daten in metadata – sie werden nicht als Patientendaten behandelt.
string[]
Ersetzt die Liste von bis zu 5 Adressen, die jeweils eine E-Mail erhalten, sobald alle Laborergebnisse final sind. Sende [], um die E-Mails auszuschalten. In jedem Status außer cancelled bearbeitbar. Dein Schlüssel benötigt results_view-Zugriff auf den Patienten, sonst 403. Siehe E-Mails bei fertigen Ergebnissen.

Antwort

Bei Erfolg gibt die API 200 OK mit der aktualisierten Heimtest-Kit-Bestellung und dem eingebetteten Profil 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.
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 zugewiesene Panel – immer genau eins (ein Heimtest-Kit entspricht 1:1 einem physischen Kit-Produkt), das direkt ersetzt wird, wenn du panel_id übergibst. 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.

Fehlerantworten