Patienten

Patientenprofile über die Management API suchen und anzeigen

​

Patienten

Suchen Sie Patienten anhand ihrer E-Mail-Adresse, zeigen Sie Patientenprofile an und prüfen Sie den Intent-Status von 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 aus shop_uid und shop_customer_id bereits existiert. Dies ist der unterstützte Patientenerstellungs-Flow für API-Key-Integrationen, die anschließend Scheduling verwenden.

POST /v1/management/patients

Erforderliche Berechtigung: patient:write

curl -X POST "https://api.rxscale.com/v1/management/patients" \
  -H "X-API-Key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "shop_uid": "shop_123",
    "shop_customer_id": "customer_456",
    "email": "[e-mail]",
    "fields": [
      {
        "field": "first_name",
        "value": "Max",
        "source": "shop"
      }
    ]
  }'

shop_uid · string · erforderlich

UID des Shops, zu dem der Kunde gehört

shop_customer_id · string · erforderlich

Kennung des Kunden im Shop

email · string

Optionale Patienten-E-Mail, die auf der Shop-Patienten-Zuordnung gespeichert und für Patientensuche verwendet wird.

fields · array

Optionale Patientenprofilfelder, die für den Shop-Kunden gesetzt werden.

{
  "patient_profile_uid": "pp-abc123"
}

​

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.

GET /v1/management/patients?email={email}

email · string · erforderlich

Die zu suchende E-Mail-Adresse

Erforderliche Berechtigung: patient:read

​

Beispielanfrage

curl -X GET "https://api.rxscale.com/v1/management/patients?email=[e-mail]" \
  -H "X-API-Key: your-api-key-here"

​

Antwort

{
  "uid": "pp-abc123",
  "data": {
    "display_name": "Max Mustermann",
    "email": "[e-mail]",
    "date_of_birth": "1990-01-15"
  }
}

​

Fehlerantworten

Statuscode	Beschreibung
400	Fehlender oder ungültiger E-Mail-Parameter
404	Kein Patient mit der angegebenen E-Mail gefunden

​

Patientenprofil abrufen

Rufen Sie ein Patientenprofil anhand der UID ab.

GET /v1/management/patients/{patient_uid}

patient_uid · string · erforderlich

Die Patienten-UID

Erforderliche Berechtigung: patient:read

​

Beispielanfrage

curl -X GET "https://api.rxscale.com/v1/management/patients/pp-abc123" \
  -H "X-API-Key: your-api-key-here"

​

Antwort

{
  "uid": "pp-abc123",
  "data": {
    "display_name": "Max Mustermann",
    "email": "[e-mail]",
    "date_of_birth": "1990-01-15"
  }
}

​

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.

GET /v1/management/patients/{patient_uid}/intent/{intent}

patient_uid · string · erforderlich

Die Patienten-UID

intent · string · erforderlich

Der Intent-Bezeichner

Erforderliche Berechtigung: patient:read

​

Beispielanfrage

curl -X GET "https://api.rxscale.com/v1/management/patients/pp-abc123/intent/consultation" \
  -H "X-API-Key: your-api-key-here"

​

Antwort

{
  "return_code": "VALID"
}

​

Rückgabecode-Werte

Code	Beschreibung
VALID	Der Patient hat eine gültige, aktuelle Einreichung für diesen Intent
EXPIRED	Die letzte Einreichung des Patienten ist abgelaufen
NOT_FOUND	Keine Einreichung für diesen Intent gefunden