Patienten
Suchen Sie Patienten anhand ihrer E-Mail-Adresse, zeigen Sie Patientenprofile an und prüfen Sie den Intent-Status von Patienten. Patientenantworten enthalten die Kategorisierungs-Tags Ihrer Organisation für diesen Patienten.Patient erstellen oder auflösen
Erstellen Sie ein Patientenprofil für einen Shop-Kunden oder erhalten Sie das bestehende Profil zurück, wenn die Kombination ausshop_uid und shop_customer_id bereits existiert. Das ist Schritt 1 für die Patient-Pass-Ausstellung (POST /wallet-passes braucht diese Shop-Kunden-Verknüpfung) und der unterstützte Create-Flow für Scheduling.
patient:write
Optionale Patienten-E-Mail, die auf der Shop-Patienten-Zuordnung gespeichert und für Patientensuche verwendet wird.
Optionale Patientenprofilfelder, die für den Shop-Kunden gesetzt werden. Jeder
Eintrag ist
{ "field": "<field_key>", "value": <wert>, "source": "shop" | "questionnaire" | "user" }.
source ist standardmäßig shop und muss mit der konfigurierten Quelle des
Felds unter Einstellungen → Profilfelder übereinstimmen. Bei Abweichung
oder unbekanntem Feldschlüssel wird 404 zurückgegeben.
Patientenprofilfelder
erklärt jede Quelle. Ein Wert, den Sie für ein shop-Feld setzen, wird bei der nächsten
Änderung des Kunden in Shopify ersetzt, wenn der Shopify-Kunde einen Wert für dieses Feld hat.Patient per E-Mail suchen
Finden Sie einen Patienten anhand seiner E-Mail-Adresse. Gibt den zuletzt erstellten Patienten zurück, dessen Shop-Patienten-E-Mail oder Bestell-E-Mail mit der angegebenen E-Mail übereinstimmt.patient:read
Beispielanfrage
Antwort
Fehlerantworten
Patientenprofil abrufen
Rufen Sie ein Patientenprofil anhand der UID ab.patient:read
Beispielanfrage
Antwort
tags enthält nur Kategorisierungs-Tags. Jedes Objekt hat uid, identifier, display_name und color_hex. INTENT-Tags werden ausgelassen. Ein Tag ist Freitext Ihrer Organisation und wird nur an diese Organisation zurückgegeben. Der Text kann einen Bezug zur Gesundheit haben. Das Lesen des Patienten erfordert patient:read. Das Array tags ist Teil dieser Antwort.
Patienten-Intent prüfen
Prüfen Sie den Intent-Rückgabecode für einen Patienten. Gibt einen Code zurück, der angibt, wann die letzte signierte Einreichung für diesen Intent erfolgte.patient:read
Beispielanfrage
Antwort
Rückgabecode-Werte
Patientenprofilfeld löschen
Löschen Sie den Wert eines Patienten für ein einzelnes Profilfeld.Quelle des Felds (
shop, questionnaire oder user). Muss mit der konfigurierten Quelle des Profilfelds und dem source übereinstimmen, der beim Setzen des Werts über Patient erstellen oder auflösen verwendet wurde. Standard ist shop.fields[].field senden, wenn Sie einen Wert über Patient erstellen oder auflösen setzen — zum Beispiel first_name. Übergeben Sie denselben source, den Sie beim Setzen des Werts verwendet haben. Zum Löschen eines Werts verwenden Sie also genau die Kennung, mit der Sie ihn gesetzt haben; eine separate Abfrage ist nicht erforderlich.
Erforderliche Berechtigung: patient_profile_field:delete
Beispielanfrage
Antwort (200 OK)
Fehlerantworten
Tags der Organisation auflisten
Listen Sie die Kategorisierungs-Tags der authentifizierten Organisation auf, sortiert nachidentifier. Verwenden Sie eine zurückgegebene uid oder einen identifier, wenn Sie einen Tag an einen Patienten anhängen. INTENT-Tags sind nicht enthalten.
patient_tag:read
Beispielanfrage
Antwort
Tags eines Patienten auflisten
Listen Sie die Kategorisierungs-Tags auf, die an einen Patienten angehängt sind, sortiert nachidentifier. Das ist dieselbe Menge wie das Array tags in der Patientenantwort. INTENT-Tags werden ausgelassen.
patient_tag:read
Beispielanfrage
Antwort
Fehlerantworten
Einen Tag an einen Patienten anhängen
Hängen Sie einen Kategorisierungs-Tag an einen Patienten an. Senden Sie genau eines vontag_uid oder identifier.
tag_uidhängt einen Tag an, der in dieser Organisation bereits existiert.identifierhängt den Tag Ihrer Organisation mit diesem Identifier an. Existiert keiner, wird ein Kategorisierungs-Tag angelegt und angehängt.display_nameundcolor_hexgelten nur in diesem Anlagefall.color_hexist standardmäßig#10B981.display_nameentspricht standardmäßig dem Identifier.
409.
Identifier eines bestehenden Kategorisierungs-Tags oder ein neuer Identifier, der angelegt wird. Schließt
tag_uid aus.Farbe
#RRGGBB, die nur gespeichert wird, wenn identifier neu angelegt wird. Standard ist #10B981patient_tag:write
Beispielanfrage
Antwort (201 Created)
Fehlerantworten
Einen Tag von einem Patienten entfernen
Entfernen Sie einen Kategorisierungs-Tag von einem Patienten. Der Tag bleibt für die Organisation verfügbar, und Zuordnungen desselben Tags an anderen Datensätzen bleiben bestehen. INTENT-Tags werden abgelehnt.patient_tag:write