Zum Hauptinhalt springen

Documentation Index

Fetch the complete documentation index at: https://docs.rxscale.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Wartezimmer

Registrieren Sie Patienten für das virtuelle Wartezimmer, prüfen Sie deren Warteschlangenstatus und stornieren Sie Registrierungen.

​
Patient registrieren

Registrieren Sie einen Patienten für das Wartezimmer in einem bestimmten Shop. 
POST /v1/management/waiting-room/register
Erforderliche Berechtigung: waiting_room:write

​
Anfragekörper

{
  "shop_uid": "shop-abc123",
  "patient_profile_uid": "pp-xyz789",
  "preferred_doctor_uid": "doc-456",
  "visit_reason": "Follow-up consultation"
}
FeldTypErforderlichBeschreibung
shop_uidstringJaShop-UID, bei dem sich der Patient registriert
patient_profile_uidstringJaPatientenprofil-UID
preferred_doctor_uidstringNeinBevorzugte Arzt-UID
visit_reasonstringNeinGrund des Besuchs

​
Beispielanfrage

curl -X POST "https://api.rxscale.com/v1/management/waiting-room/register" \
  -H "X-API-Key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "shop_uid": "shop-abc123",
    "patient_profile_uid": "pp-xyz789",
    "preferred_doctor_uid": "doc-456",
    "visit_reason": "Follow-up consultation"
  }'

​
Antwort (201 Created)

{
  "queue_uid": "q-abc123",
  "position": 3,
  "estimated_wait_minutes": 15
}

​
Warteschlangenstatus prüfen

Rufen Sie den aktuellen Status eines Warteschlangeneintrags ab, einschließlich Position und geschätzter Wartezeit. 
GET /v1/management/waiting-room/{queue_uid}/status
​
queue_uid
string
erforderlich
Die Warteschlangeneintrag-UID
Erforderliche Berechtigung: waiting_room:read

​
Beispielanfrage

curl -X GET "https://api.rxscale.com/v1/management/waiting-room/q-abc123/status" \
  -H "X-API-Key: your-api-key-here"

​
Antwort

{
  "queue_uid": "q-abc123",
  "status": "waiting",
  "position": 2,
  "estimated_wait_minutes": 10,
  "video_room_id": null,
  "allocated_at": null
}

​
Statuswerte

StatusBeschreibung
waitingPatient wartet in der Warteschlange
allocatedPatient wurde einem Arzt zugewiesen
completedKonsultation wurde abgeschlossen
cancelledRegistrierung wurde storniert
Wenn ein Patient zugewiesen wurde, werden video_room_id und allocated_at befüllt.

​
Registrierung stornieren

Stornieren Sie eine Warteschlangenregistrierung. 
DELETE /v1/management/waiting-room/{queue_uid}
​
queue_uid
string
erforderlich
Die zu stornierende Warteschlangeneintrag-UID
Erforderliche Berechtigung: waiting_room:write

​
Beispielanfrage

curl -X DELETE "https://api.rxscale.com/v1/management/waiting-room/q-abc123" \
  -H "X-API-Key: your-api-key-here"

​
Antwort

{
  "message": "Registration cancelled"
}