Review-Anfragen
Mit einer Review-Anfrage bitten Sie eine Ärztin oder einen Arzt Ihrer Organisation, sich einen Patienten erneut anzusehen, ohne dass der Patient zuvor verschreibungspflichtige Produkte bestellt. Der typische Fall ist ein Nachkauf: Der Patient füllt einen kurzen Folgefragebogen aus und bezahlt in Ihrem Shop eine Rezeptgebühr, und eine Ärztin oder ein Arzt entscheidet über das weitere Vorgehen. Mit der Anfrage senden Sie die neue Anamnese des Patienten. Der Arzt findet sie in einer eigenen Liste Review-Anfragen im Anamnese-Center und antwortet auf eine von drei Arten:- Behandlung erstellen. Der Arzt legt in Ihrem Shop eine Entwurfsbestellung (Draft Order) an. Der Patient bezahlt sie, und das Rezept durchläuft die übliche Prüfung und Signatur.
- Videotermin anfragen. Der Arzt sendet dem Patienten einen Buchungslink für einen Termin bei sich.
- Ablehnen, mit einer Begründung.
review_request_updated. Den aktuellen Stand
können Sie jederzeit abrufen.
Alle Endpoints beziehen sich auf die Organisation, der der API-Schlüssel gehört. Eine
Review-Anfrage, ein Shop, ein Patient oder eine Anamnese einer anderen Organisation wird wie
nicht vorhanden behandelt.
Der Ablauf im Überblick
1
Der Patient reicht den Fragebogen ein
Die Anamnese muss RxScale erreichen, bevor Sie die Prüfung anfragen. Reichen Sie sie über die
Anamnese-API ein und bewahren
Sie die Anamnese-UID auf, die RxScale zurückgibt: Die Review-Anfrage adressiert die Anamnese
ausschließlich über diese UID.
2
Der Patient bezahlt die Rezeptgebühr
Zum Beispiel in Ihrem Shopify-Shop.
3
Sie erstellen die Review-Anfrage
Rufen Sie
POST /v1/management/review-requests auf, zum Beispiel aus Shopify Flow, sobald
die Gebührenbestellung bezahlt ist.4
Der Arzt entscheidet
Sie erhalten
review_request_updated mit der Entscheidung des Arztes.5
Sie handeln entsprechend
Senden Sie dem Patienten den Buchungslink (
video_requested), senden Sie ihm die Rechnung der
Entwurfsbestellung (draft_created), oder erstatten Sie die Gebühr, wenn Ihre Bedingungen das
vorsehen (declined).6
Der Patient bezahlt die Entwurfsbestellung
RxScale verknüpft die bezahlte Bestellung mit der Anfrage, und Sie erhalten
completed.RxScale rechnet für Review-Anfragen in Ihren Shops nichts ab. Ein Buchungslink, den der Arzt
für einen Ihrer Shops erstellt, trägt in RxScale keinen Preis: Sie entscheiden, ob und wie der
Patient den Videotermin bezahlt. Lehnt der Arzt ab, meldet RxScale nur
declined. Ob Sie die
Rezeptgebühr erstatten, entscheiden Sie, und die Erstattung nehmen Sie in Ihrem Shop vor.Stellen Sie sicher, dass die Bestellung der Rezeptgebühr keine Apotheke erreicht. Markieren Sie die
SKU des Gebührenprodukts mit
skip_for_pharmacy_orders: true (siehe
SKUs).Wer die Anfrage erhält
Die Anfrage wird dem Arzt zugewiesen, der das jüngste signierte Rezept des Patienten in Ihrer Organisation ausgestellt hat. Hat der Patient kein signiertes Rezept oder ist das Konto dieses Arztes archiviert, kommt die Anfrage ohne Zuweisung an, und jeder Arzt Ihrer Organisation kann sie übernehmen. Der Arzt kann die Anfrage an einen Kollegen weitergeben, und Ihre Admins können sie im Admin-Portal zuweisen oder neu zuweisen. Jeder Wechsel des Arztes sendetassigned. Eine Anfrage
bleibt bei ihrem Arzt, bis er sie bearbeitet: Keine Frist gibt sie automatisch wieder frei.
Ob eine asynchrone Prüfung zulässig ist
RxScale entscheidet nicht, ob ein Patient ohne Sprechstunde geprüft werden darf, zum Beispiel ob zuerst eine Videosprechstunde fällig ist oder ob die letzte weniger als ein Jahr zurückliegt. Das entscheiden Sie, bevor Sie die Anfrage senden. Der Arzt sieht das Datum des letzten Videotermins des Patienten und kann statt der Behandlung einen Videotermin anfragen.Berechtigungen
review_request:write— erforderlich, um eine Review-Anfrage zu erstellen und zu stornieren.review_request:read— erforderlich, um eine Review-Anfrage abzurufen.
review_request:write erhält nicht automatisch review_request:read; fügen Sie
beide hinzu, wenn Sie schreiben und lesen möchten. Für den Webhook benötigen Sie außerdem die
Berechtigungen notification_subscription (siehe
Webhooks). Wenden Sie sich an Ihren
RxScale-Ansprechpartner, um Berechtigungen anzupassen.
Alle Anfragen authentifizieren sich über den Header X-API-Key. Details finden Sie unter
Authentifizierung.
Review-Anfrage erstellen
review_request:write
Anfragekörper
string
erforderlich
Ihre ID für diese Anfrage, 1 bis 255 Zeichen. Sie muss innerhalb Ihrer Organisation eindeutig
sein und macht den Aufruf wiederholbar: siehe Anfrage wiederholen.
string
erforderlich
Die Art der Prüfung. Derzeit nur
repurchase (Nachkauf).string
erforderlich
Identifier des Shops, dessen Kunde der Patient ist. Der Shop muss zu Ihrer Organisation gehören.
string
erforderlich
Die ID des Kunden in Ihrem Shop.
string
erforderlich
UID der Anamnese in RxScale, wie RxScale sie beim Einreichen der Anamnese zurückgegeben hat. Die
einzige Art, die Anamnese zu adressieren (siehe unten).
string
Die ID der Bestellung der Rezeptgebühr in Ihrem Shop, 1 bis 255 Zeichen. Verwenden Sie dieselbe
ID wie beim Filter
shop_order_external_id unter Bestellungen,
bei Shopify die Bestell-ID. Wird so gespeichert, wie Sie sie senden, zur Nachverfolgung, und beim
Abruf und in Webhooks zurückgegeben. RxScale muss die Bestellung noch nicht kennen: Shopify Flow
kann schneller sein, als die Bestellung RxScale erreicht.400 abgewiesen.
Patient und Anamnese identifizieren
- Der Patient über
shop_identifierundshop_customer_id. - Die Anamnese über
anamnesis_uid, ihre UID in RxScale. Die Anamnese muss vorher bei RxScale eingereicht sein, zum Beispiel mit Anamnese übermitteln, dessen Antwort diese UID enthält.
external_submission_uid, external_identifier
und provider_identifier werden als unbekannte Felder mit 400 abgewiesen. Die UID, die
Externe Anamnese übermitteln
zurückgibt, ist die UID der Einreichung, keine Anamnese-UID, und wird mit 404 beantwortet.
Ist die Anamnese noch mit keinem Patienten verknüpft, verknüpft die Review-Anfrage sie mit diesem
Patienten, genau wie der Verknüpfungs-Endpoint: Die Antworten füllen die Profilfelder des
Patienten, und die Anamnese erscheint in RxScale beim Patienten. Ist die Anamnese bereits mit
einem anderen Patienten verknüpft, wird die Anfrage mit 409 abgewiesen, und es wird nichts
angelegt.
Beispielanfrage
Antwort (201 Created)
Die Antwort nennt den Arzt nicht. Rufen Sie die Anfrage ab, um
doctor_uid zu sehen.
Anfrage wiederholen
Ein Aufruf mit einer
external_id, die Sie bereits verwendet haben, legt nichts an. Er antwortet
mit 200 OK statt 201 und liefert die bestehende Anfrage in ihrem aktuellen Stand, auch wenn
sich der übrige Anfragekörper unterscheidet. Eine Wiederholung durch Shopify Flow oder ein Aufruf,
dessen Antwort Sie nicht erhalten haben, ist daher unschädlich.Für eine neue Prüfung, zum Beispiel nachdem eine Anfrage abgelehnt oder storniert wurde, senden Sie
eine neue external_id.Fehlerantworten
Wird eine Anfrage abgewiesen, wird nichts gespeichert.
Ein
400 benennt die betroffenen Felder:
404 enthält je Ressource eine feste Meldung. Sie ist dieselbe, ob der Datensatz nicht
existiert oder zu einer anderen Organisation gehört, und bestätigt also nie, dass ein Datensatz
real ist. Geprüft wird zuerst der Shop, dann die Anamnese, dann der Patient.
409:
Review-Anfrage abrufen
review_request_updated sowie die Zeitstempel. Sie können ihn daher immer verwenden,
wenn Ihnen ein Webhook entgangen ist.
Erforderliche Berechtigung: review_request:read
string
erforderlich
Die
uid, die Sie beim Erstellen der Anfrage erhalten habenBeispielanfrage
Antwort (200 OK)
Anders als der Webhook, der
booking nur bei video_requested mitsendet, enthält diese Antwort
immer den aktuellen Buchungslink, sofern es einen gibt. Hat der Arzt einen neuen Link erstellt,
ist es der neueste.Bucht der Patient über den Link, erhalten Sie
review_request_updated mit
change: "appointment_booked" und der meeting_uid des Termins in appointment. Ab dann ist
appointment in dieser Antwort und in jedem späteren review_request_updated gefüllt. Die Buchung
meldet außerdem der Webhook patient_doctor_meeting_updated,
der auch jede spätere Änderung am Termin meldet.Fehlerantworten
Review-Anfrage stornieren
review_request:write
string
erforderlich
Die
uid, die Sie beim Erstellen der Anfrage erhalten habenstring
Warum die Anfrage storniert wird, höchstens 2000 Zeichen. Wird im Verlauf der Anfrage
festgehalten, den Ihre Admins im Admin-Portal sehen.
Was die Stornierung bewirkt
- Der Status wird
cancelled,closed_atwird gesetzt, und Sie erhaltenreview_request_updatedmitchange: "cancelled". - Die Anfrage verschwindet aus der Liste des Arztes. Ein Arzt, der sie noch geöffnet hat, erfährt bei seiner nächsten Aktion, dass der Shop sie storniert hat.
- Ein Buchungslink, den der Patient noch nicht verwendet hat, wird sofort ungültig.
- Ein Termin, den der Patient bereits gebucht hat, bleibt bestehen. Entnehmen Sie seine
meeting_uiddem Webhookappointment_bookedoder beim Abruf der Anfrageappointment.meeting_uid, und stornieren Sie ihn dann mitPOST /v1/management/scheduling/appointments/{meeting_uid}/cancel; dabei gelten die Erstattungsregeln dieses Endpoints. - Eine Entwurfsbestellung, die der Arzt bereits angelegt hat, bleibt in Ihrem Shop. Löschen
Sie sie in Shopify. Bezahlt der Patient sie trotzdem, verarbeitet RxScale die Bestellung wie
üblich, und die Anfrage bleibt
cancelled.
completed, declined oder cancelled), wird
nicht verändert, und es wird kein Webhook gesendet: Sie wird unverändert mit 200 OK
zurückgegeben. Eine wiederholte Stornierung ist daher unschädlich.
Beispielanfrage
Antwort (200 OK)
status ist cancelled oder der
Endstatus, den die Anfrage bereits hatte.
Fehlerantworten
Status-Lebenszyklus
- Ein Endstatus ändert sich nie wieder.
- Eine offene Anfrage kann aus jedem offenen Status abgelehnt oder storniert werden. Eine Ablehnung macht auch einen ungenutzten Buchungslink ungültig.
- Übernehmen oder Weitergeben ändert den Arzt, nicht den Status.
- Bucht der Patient über den Link, ändert sich der Status ebenfalls nicht. Sie erhalten
appointment_bookedmit dem Termin. - Der Arzt kann auch nach dem Anlegen der Entwurfsbestellung einen Videotermin anfragen. Der
Status bleibt dann
draft_created, und Sie erhaltenvideo_requestedmit dem Link. - Eine Anfrage hat höchstens einen nutzbaren Buchungslink. Einen neuen Link kann der Arzt erst
anfragen, wenn der aktuelle ungenutzt abgelaufen ist oder der darüber gebuchte Termin nicht mehr
besteht (abgesagt, abgelaufen, nicht erschienen oder abgeschlossen). Sie erhalten dann ein
weiteres
video_requestedmit dem neuen Link, der den alten ersetzt. Der Status ändert sich nicht.
Die Anfrage mit der bezahlten Bestellung abschließen
Erstellt der Arzt die Behandlung, trägt die Entwurfsbestellung in Ihrem Shop das Bestellattribut_rxscale_review_request_uid mit der uid der Anfrage. Bezahlt der Patient die
Entwurfsbestellung und erreicht die Bestellung RxScale, verknüpft RxScale sie mit der Anfrage,
setzt completed und sendet review_request_updated mit change: "completed" und der ID der
Bestellung in shop_order_external_id. Ein Buchungslink, den der Patient noch nicht verwendet
hat, wird ungültig. Das Rezept durchläuft danach die übliche Prüfung und Signatur.
Eine Anfrage wird durch eine Bestellung abgeschlossen. Trägt eine weitere bezahlte Bestellung
dasselbe _rxscale_review_request_uid, verarbeitet RxScale diese Bestellung wie gewohnt, die
Anfrage behält aber die erste Bestellung, und es wird kein Webhook gesendet.
RxScale akzeptiert das Attribut nur für eine Anfrage Ihrer Organisation und desselben Patienten.
Jeder andere Wert wird ignoriert, und die Bestellung wird ohne Verknüpfung verarbeitet.
Verwandte Themen
- Webhook
review_request_updated— Die Payload und allechange-Werte. - Anamnese — Der Verknüpfungs-Endpoint und seine Adressierungsarten.
- Scheduling — Einen gebuchten Termin stornieren.
- Review-Anfragen für Ärzte — Was der Arzt sieht und tut.