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": "max@example.com",
    "fields": [
      {
        "field": "first_name",
        "value": "Max",
        "source": "shop"
      }
    ]
  }'

string

erforderlich

UID des Shops, zu dem der Kunde gehört

string

erforderlich

Kennung des Kunden im Shop

string

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

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}

string

erforderlich

Die zu suchende E-Mail-Adresse

Erforderliche Berechtigung: patient:read

Beispielanfrage

curl -X GET "https://api.rxscale.com/v1/management/patients?email=max@example.com" \
  -H "X-API-Key: your-api-key-here"

Antwort

{
  "uid": "pp-abc123",
  "data": {
    "display_name": "Max Mustermann",
    "email": "max@example.com",
    "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}

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": "max@example.com",
    "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}

string

erforderlich

Die Patienten-UID

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

Patientenprofilfeld löschen

Löschen Sie den Wert eines Patienten für ein einzelnes Profilfeld.

DELETE /v1/management/patients/{patient_uid}/patient-profile-fields/{field_key}

string

erforderlich

Die Patienten-UID

string

erforderlich

Schlüssel des Profilfelds, dessen Patientenwert gelöscht werden soll

Der Feldschlüssel ist derselbe Wert, den Sie in fields[].field senden, wenn Sie einen Wert über Patient erstellen oder auflösen setzen — zum Beispiel first_name. 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

Dies ist ein endgültiges Löschen (Hard Delete). Der Feldwert wird aus dem Patientenprofil entfernt, nicht archiviert oder soft-deleted. Ein interner Audit-Log-Eintrag, der die Löschung dokumentiert (und den ausführenden API-Schlüssel benennt), wird im selben Aufruf geschrieben — danach ist dieser Log-Eintrag der einzige verbleibende Nachweis, dass der Wert jemals existiert hat.

Beispielanfrage

curl -X DELETE "https://api.rxscale.com/v1/management/patients/pp-abc123/patient-profile-fields/first_name" \
  -H "X-API-Key: your-api-key-here"

Antwort (200 OK)

{
  "message": "Field deleted successfully"
}

Fehlerantworten

Statuscode	Beschreibung
`401`	Fehlender oder ungültiger API-Schlüssel
`403`	Fehlende Berechtigung `patient_profile_field:delete`
`404`	Patient nicht gefunden, gehört zu einer anderen Organisation, der Shop definiert kein Feld mit diesem Schlüssel, oder der Patient hat keinen Wert dafür gesetzt

Erste Schritte

Externe Apotheken-API

Management-API

Scheduling API

Öffentliche API

Patienten-API

Anamnese-API

Webhooks

Anleitungen

Patienten

Patienten

Patient erstellen oder auflösen

Patient per E-Mail suchen

Beispielanfrage

Antwort

Fehlerantworten

Patientenprofil abrufen

Beispielanfrage

Antwort

Patienten-Intent prüfen

Beispielanfrage

Antwort

Rückgabecode-Werte

Patientenprofilfeld löschen

Beispielanfrage

Antwort (200 OK)

Fehlerantworten

​Patienten

​Patient erstellen oder auflösen

​Patient per E-Mail suchen

​Beispielanfrage

​Antwort

​Fehlerantworten

​Patientenprofil abrufen

​Beispielanfrage

​Antwort

​Patienten-Intent prüfen

​Beispielanfrage

​Antwort

​Rückgabecode-Werte

​Patientenprofilfeld löschen

​Beispielanfrage

​Antwort (200 OK)

​Fehlerantworten

Patienten

Patient erstellen oder auflösen

Patient per E-Mail suchen

Beispielanfrage

Antwort

Fehlerantworten

Patientenprofil abrufen

Beispielanfrage

Antwort

Patienten-Intent prüfen

Beispielanfrage

Antwort

Rückgabecode-Werte

Patientenprofilfeld löschen

Beispielanfrage

Antwort (200 OK)

Fehlerantworten