Zum Hauptinhalt springen

​
Patienten

Suchen Sie Patienten anhand ihrer E-Mail-Adresse, zeigen Sie Patientenprofile an und prüfen Sie den Intent-Status von Patienten.

​
Patient per E-Mail suchen

Finden Sie einen Patienten anhand seiner E-Mail-Adresse. Gibt den zuletzt erstellten Patienten zurück, dessen Bestellungen die angegebene E-Mail enthalten. 
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=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

StatuscodeBeschreibung
400Fehlender oder ungültiger E-Mail-Parameter
404Kein 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": "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}
​
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

CodeBeschreibung
VALIDDer Patient hat eine gültige, aktuelle Einreichung für diesen Intent
EXPIREDDie letzte Einreichung des Patienten ist abgelaufen
NOT_FOUNDKeine Einreichung für diesen Intent gefunden