Patientendaten

Patientenabsicht abfragen und Patienteneigenschaften verwalten

​

Patientendaten

Greifen Sie auf patientenspezifische Daten wie den Absichtsstatus und benutzerdefinierte Eigenschaften zu. Diese Endpoints verwenden die Shop-Kunden-ID und den Shop-Bezeichner zur Identifizierung von Patienten.

​

Patientenabsicht prüfen

Fragen Sie ab, ob ein Patient eine bestimmte Absicht abgeschlossen hat (z. B. das Ausfüllen eines Fragebogens).

GET /api/v0/patient/intent

shop_customer_id · string · erforderlich

Die Kunden-ID aus Ihrem Shop-System

shop_identifier · string · erforderlich

Ihr Shop-Bezeichner (z. B. my-store.myshopify.com)

intent · string · erforderlich

Der zu prüfende Absichtsbezeichner

​

Beispielanfrage

curl -X GET "https://api.rxscale.com/api/v0/patient/intent?shop_customer_id=CUST123&shop_identifier=my-store.myshopify.com&intent=weight-loss-questionnaire" \
  -H "X-API-Key: your-api-key-here"

​

Antwort

{
  "return_code": "signed_within_12_months"
}

Der return_code gibt an, wann der Patient zuletzt eine signierte Einreichung für die angegebene Absicht abgeschlossen hat.

Dieser Endpoint gibt 404 zurück, wenn der Patient RxScale nicht bekannt ist. Wenn der Patient gerade erst erstellt wurde (z.B. während eines Shopify-Checkouts), ist sein Profil möglicherweise nicht sofort verfügbar. Warten Sie 1–2 Sekunden und versuchen Sie es erneut, bevor Sie einen 404 als endgültiges „Patient nicht gefunden” behandeln.

​

Patienteneigenschaft abrufen

Rufen Sie einen bestimmten Eigenschaftswert für einen Patienten ab.

GET /api/v0/patient/properties

shop_customer_id · string · erforderlich

Die Kunden-ID aus Ihrem Shop-System

shop_identifier · string · erforderlich

Ihr Shop-Bezeichner

field · string · erforderlich

Der Name des abzurufenden Eigenschaftsfelds. Sie finden den Feldschlüssel im Admin-Tool unter Einstellungen > Profilfelder — verwenden Sie den dort angezeigten Key-Wert für jedes Feld.

​

Beispielanfrage

curl -X GET "https://api.rxscale.com/api/v0/patient/properties?shop_customer_id=CUST123&shop_identifier=my-store.myshopify.com&field=allergies" \
  -H "X-API-Key: your-api-key-here"

​

Patienteneigenschaft setzen

Setzen oder aktualisieren Sie einen Eigenschaftswert für einen Patienten.

POST /api/v0/patient/properties

shop_customer_id · string · erforderlich

Die Kunden-ID aus Ihrem Shop-System

shop_identifier · string · erforderlich

Ihr Shop-Bezeichner

​

Anfragekörper (form-data)

Feld	Typ	Erforderlich	Beschreibung
field	string	Ja	Der Name des Eigenschaftsfelds
value	string	Ja	Der zu setzende Wert

​

Beispielanfrage

curl -X POST "https://api.rxscale.com/api/v0/patient/properties?shop_customer_id=CUST123&shop_identifier=my-store.myshopify.com" \
  -H "X-API-Key: your-api-key-here" \
  -F "field=allergies" \
  -F "value=penicillin"

Patienteneigenschaften sind benutzerdefinierte Felder, die pro Organisation konfiguriert werden. Sie können die verfügbaren Eigenschaftsfelder im Bereich Einstellungen > Profilfelder des Admin-Tools konfigurieren.