Rezepte

Rufen Sie Rezeptinformationen ab, einschließlich Arztdaten und Status, und sehen Sie, wie viele Ihrer Rezepte sich in welchem Status befinden.

Rezeptdetails abrufen

GET /v1/management/prescriptions/{prescription_uid}

string

erforderlich

Die Rezept-UID

Erforderliche Berechtigung: prescription:read

Beispielanfrage

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

Antwort

{
  "uid": "px-abc123",
  "status": "signed",
  "doctor": {
    "uid": "doc-456",
    "display_name": "Dr. Schmidt"
  },
  "rendered": true,
  "lines": [
    {
      "uid": "pi-789",
      "order_item_uid": "oi-321",
      "sku_uid": "sku-654",
      "amount": 1,
      "pzn": "12345678",
      "display_name": "Example Cream 50 g",
      "prescription_name": "Example Cream 50 g",
      "product_name": "Example Cream",
      "dosage": "0.1 %",
      "pcs": "1",
      "unit": "g",
      "standard_selling_unit": 50.0,
      "total_paid_amount": 2500,
      "anamnesis_uid": "an-111",
      "note": null,
      "categories": []
    }
  ]
}

Antwortfelder

Feld	Typ	Beschreibung
`uid`	string	Eindeutiger Bezeichner für das Rezept
`status`	string	Aktueller Rezeptstatus (z.B. `signed`, `waiting for doctor`)
`doctor`	object	Der verschreibende Arzt
`doctor.uid`	string	Arzt-UID
`doctor.display_name`	string	Anzeigename des Arztes
`rendered`	boolean	`true`, wenn ein gerendertes PDF für das Rezept verfügbar ist, andernfalls `false`
`lines`	array	Die verschriebenen Positionen, ein Eintrag pro Position
`lines[].uid`	string	UID der Rezeptposition
`lines[].order_item_uid`	string	UID der Bestellposition, die diese Position verschreibt
`lines[].sku_uid`	string	SKU-UID
`lines[].amount`	integer	Verschriebene Menge: die Menge des Arztes, falls gesetzt, sonst die bestellte Menge
`lines[].pzn`	string \| null	Pharmazentralnummer: die PZN des Arztes, falls gesetzt, sonst die der SKU
`lines[].display_name`	string \| null	Medikamentenname: der Medikamententext des Arztes, falls gesetzt, sonst der Anzeigename der SKU
`lines[].prescription_name`	string \| null	Name auf dem Rezept: der Medikamententext des Arztes, falls gesetzt, sonst der Rezeptname der SKU
`lines[].product_name`	string \| null	Produktname
`lines[].dosage`	string \| null	Dosierung der SKU
`lines[].pcs`	string \| null	Stückzahl pro Packung der SKU
`lines[].unit`	string \| null	Einheit der SKU
`lines[].standard_selling_unit`	number \| null	Standard-Verkaufseinheit der SKU
`lines[].total_paid_amount`	integer \| null	Für die Bestellposition gezahlter Betrag in Cent (brutto)
`lines[].anamnesis_uid`	string \| null	Mit der Bestellposition verknüpfte Anamnese, `null`, wenn keine vorhanden ist. Nur Rezepte, deren Positionen hier alle `null` haben, können extern signiert werden
`lines[].note`	object \| null	Während der Prüfung an der Position hinterlegte Notizen als Schlüssel-Wert-Paare – zum Beispiel der Kommentar des Arztes mit dem Unix-Zeitstempel seiner Erstellung als Schlüssel oder `{"hold": "<Grund>"}` bei einem zurückgestellten Rezept. `null`, wenn keine vorhanden sind
`lines[].categories`	array	Kategorien des Produkts
`lines[].categories[].uid`	string	Kategorie-UID
`lines[].categories[].name`	string	Kategoriename
`lines[].categories[].type`	string	Kategorietyp
`lines[].categories[].priority`	integer	Priorität der Kategorie für das Produkt

Fehlerantworten

Statuscode	Beschreibung
`403`	Fehlende Berechtigung `prescription:read`
`404`	Rezept nicht gefunden oder gehört zu einer anderen Organisation

Rezeptstatistiken abrufen

GET /v1/management/prescriptions/statistics

Erforderliche Berechtigung: prescription:read Gibt zurück, wie viele Rezepte Ihrer Organisation sich aktuell in welchem Status befinden – zum Beispiel wie viele noch auf einen Arzt warten, wie viele freigegeben oder abgelehnt wurden und wie viele signiert sind. Jedes Rezept, das zu einer Ihrer Bestellungen gehört, wird einmal mit seinem aktuellen Status gezählt. Das sind dieselben Rezepte, die Sie mit GET /v1/management/prescriptions/{prescription_uid} abrufen können. Gelöschte Rezepte werden nicht gezählt. Die Zahlen geben den Stand zum Zeitpunkt der Anfrage wieder; einen Datumsfilter gibt es nicht.

Beispielanfrage

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

Antwort

{
  "statuses": {
    "waiting for doctor": 12,
    "approved": 3,
    "signed": 140,
    "declined": 9,
    "cancelled": 4,
    "ON_HOLD": 2,
    "NON_QES_SIGNED": 0,
    "EXTERNALLY_SIGNED": 5
  },
  "total": 175
}

Antwortfelder

Feld	Typ	Beschreibung
`statuses`	object	Anzahl der Rezepte pro Status. Die Schlüssel sind die Werte des Felds `status`, das `GET /v1/management/prescriptions/{prescription_uid}` zurückgibt. Jeder Status ist immer enthalten, mit `0`, wenn kein Rezept diesen Status hat.
`statuses["waiting for doctor"]`	integer	Wartet auf die Prüfung durch einen Arzt
`statuses.approved`	integer	Vom Arzt freigegeben und noch nicht signiert
`statuses.signed`	integer	Mit qualifizierter elektronischer Signatur (QES) signiert
`statuses.declined`	integer	Vom Arzt abgelehnt
`statuses.cancelled`	integer	Storniert
`statuses.ON_HOLD`	integer	Zur weiteren Prüfung durch das Support-Team zurückgestellt
`statuses.NON_QES_SIGNED`	integer	Ohne qualifizierte elektronische Signatur signiert
`statuses.EXTERNALLY_SIGNED`	integer	Außerhalb von RxScale signiert und über External-Sign registriert
`total`	integer	Summe aller Statuszähler

Rezepte, für die noch eine ärztliche Entscheidung aussteht, werden unter waiting for doctor und ON_HOLD gezählt. Rezepte mit approved sind entschieden, aber noch nicht signiert. Signierte Rezepte verteilen sich auf signed, NON_QES_SIGNED und EXTERNALLY_SIGNED. Was die einzelnen Status bedeuten, erfahren Sie unter Rezeptstatus.

Fehlerantworten

Statuscode	Beschreibung
`401`	Fehlender oder ungültiger API-Schlüssel
`403`	Fehlende Berechtigung `prescription:read`

Extern signierte Rezepte

Rezepte, deren Items mit _skip_validation (oder _rxscale_skip_validation) auf Shopify-Line-Item-Ebene, auf der Line-Item-Gruppe dieser Position (bei Bundles) oder in den zusätzlichen Details auf Bestellebene angelegt wurden – also Items ohne angehängte Anamnese – können außerhalb der rxscale-Plattform signiert und anschließend über die Management API zur Belieferung registriert werden. Sind mehrere Ebenen gesetzt, löst RxScale die Einstellung mit einer dreistufigen Rückfalllogik auf: Zuerst zählt der Wert der Bestellposition selbst, dann der Wert ihrer Line-Item-Gruppe, dann der Wert auf Bestellebene. Der Ablauf besteht aus zwei API-Aufrufen:

POST /v1/management/prescriptions/{prescription_uid}/render – fordert rxscale auf, das unsignierte Rezept-PDF zu rendern. Der Endpoint kehrt sofort zurück; das PDF wird asynchron erzeugt, und rendered wird in den Rezeptdetails true, sobald es verfügbar ist.
POST /v1/management/prescriptions/{prescription_uid}/external-sign – sobald das PDF verfügbar ist, wird das Rezept als EXTERNALLY_SIGNED markiert und an die Apotheke übermittelt.

Beide Endpoints erfordern die Berechtigung prescription:external_sign.

Nur Rezepte, bei denen alle Items keine anamnesis_uid besitzen, können extern signiert werden. Gemischte Rezepte werden mit 409 Conflict abgelehnt. Vorab prüfen können Sie das über lines[].anamnesis_uid in den Rezeptdetails.

Rezept-PDF rendern

POST /v1/management/prescriptions/{prescription_uid}/render

string

erforderlich

Die Rezept-UID

Erforderliche Berechtigung: prescription:external_sign Fordert das Rendern des unsignierten Rezept-PDFs an und antwortet sofort mit 202 Accepted; das PDF wird asynchron erzeugt. Pollen Sie GET /v1/management/prescriptions/{prescription_uid}, bis rendered true ist, bevor Sie External-Sign aufrufen. Bereits signierte Rezepte können nicht erneut gerendert werden.

Beispielanfrage

curl -X POST "https://api.rxscale.com/v1/management/prescriptions/px-abc123/render" \
  -H "X-API-Key: your-api-key-here"

Antwort (202 Accepted)

{
  "status": "accepted",
  "prescription_uid": "px-abc123"
}

Antwortfelder

Feld	Typ	Beschreibung
`status`	string	Immer `accepted`
`prescription_uid`	string	Die Rezept-UID

Fehlerantworten

Statuscode	Beschreibung
`403`	Fehlende Berechtigung `prescription:external_sign`
`404`	Rezept nicht gefunden oder gehört zu einer anderen Organisation
`409`	Rezept ist bereits signiert (`signed`, `NON_QES_SIGNED` oder `EXTERNALLY_SIGNED`) und kann nicht erneut gerendert werden

Rezept extern signieren

POST /v1/management/prescriptions/{prescription_uid}/external-sign

string

erforderlich

Die Rezept-UID

Erforderliche Berechtigung: prescription:external_sign Markiert ein bereits gerendertes Rezept als EXTERNALLY_SIGNED. Der Endpoint:

Prüft, dass das Rezept den Status waiting for doctor hat, alle Items keine Anamnese besitzen (lines[].anamnesis_uid ist null) und ein gerendertes PDF verfügbar ist (rendered ist true).
Speichert das gerenderte PDF als signiertes Rezept.
Setzt den Rezeptstatus auf EXTERNALLY_SIGNED und vermerkt die Änderung im Verlauf des Rezepts, zugeordnet zu Ihrem API-Key.
Übermittelt das Rezept an die Apotheke.

Beispielanfrage

curl -X POST "https://api.rxscale.com/v1/management/prescriptions/px-abc123/external-sign" \
  -H "X-API-Key: your-api-key-here"

Antwort (200 OK)

{
  "uid": "px-abc123",
  "status": "EXTERNALLY_SIGNED",
  "doctor": null,
  "lines": [
    {
      "uid": "pi-789",
      "order_item_uid": "oi-321",
      "sku_uid": "sku-654",
      "amount": 1,
      "pzn": "12345678",
      "display_name": "Example Cream 50 g",
      "prescription_name": "Example Cream 50 g",
      "product_name": "Example Cream",
      "dosage": "0.1 %",
      "pcs": "1",
      "unit": "g",
      "standard_selling_unit": 50.0,
      "total_paid_amount": 2500,
      "anamnesis_uid": null,
      "note": null,
      "categories": []
    }
  ]
}

Antwortfelder

Feld	Typ	Beschreibung
`uid`	string	Eindeutiger Bezeichner für das Rezept
`status`	string	`EXTERNALLY_SIGNED`
`doctor`	object \| null	Der dem Rezept zugewiesene Arzt (`uid`, `display_name`), `null`, wenn kein Arzt zugewiesen ist
`lines`	array	Die verschriebenen Positionen mit denselben Feldern wie `lines` in Rezeptdetails abrufen

Fehlerantworten

Statuscode	Beschreibung
`403`	Fehlende Berechtigung `prescription:external_sign`
`404`	Rezept nicht gefunden oder gehört zu einer anderen Organisation
`409`	Rezept ist nicht im Status `waiting for doctor`, mindestens ein Item hat eine Anamnese, oder das gerenderte PDF ist noch nicht vorhanden

Erste Schritte

Externe Apotheken-API

Management-API

Scheduling API

Öffentliche API

Patienten-API

Anamnese-API

Webhooks

Anleitungen

Rezepte

Rezepte

Rezeptdetails abrufen

Beispielanfrage

Antwort

Antwortfelder

Fehlerantworten

Rezeptstatistiken abrufen

Beispielanfrage

Antwort

Antwortfelder

Fehlerantworten

Extern signierte Rezepte

Rezept-PDF rendern

Beispielanfrage

Antwort (202 Accepted)

Antwortfelder

Fehlerantworten

Rezept extern signieren

Beispielanfrage

Antwort (200 OK)

Antwortfelder

Fehlerantworten

​Rezepte

​Rezeptdetails abrufen

​Beispielanfrage

​Antwort

​Antwortfelder

​Fehlerantworten

​Rezeptstatistiken abrufen

​Beispielanfrage

​Antwort

​Antwortfelder

​Fehlerantworten

​Extern signierte Rezepte

​Rezept-PDF rendern

​Beispielanfrage

​Antwort (202 Accepted)

​Antwortfelder

​Fehlerantworten

​Rezept extern signieren

​Beispielanfrage

​Antwort (200 OK)

​Antwortfelder

​Fehlerantworten

Rezepte

Rezeptdetails abrufen

Beispielanfrage

Antwort

Antwortfelder

Fehlerantworten

Rezeptstatistiken abrufen

Beispielanfrage

Antwort

Antwortfelder

Fehlerantworten

Extern signierte Rezepte

Rezept-PDF rendern

Beispielanfrage

Antwort (202 Accepted)

Antwortfelder

Fehlerantworten

Rezept extern signieren

Beispielanfrage

Antwort (200 OK)

Antwortfelder

Fehlerantworten