Ärzte

Rufen Sie eine Liste der Ärzte in Ihrer Organisation ab und sehen Sie deren Rezeptstatistiken über einen bestimmten Zeitraum ein.

Ärzte auflisten

GET /v1/management/doctors

integer

Standard:"0"

Seitennummer (0-indexiert)

integer

Standard:"50"

Anzahl der Ärzte pro Seite

Erforderliche Berechtigung: doctor:read

Beispielanfrage

curl -X GET "https://api.rxscale.com/v1/management/doctors?page=0&limit=25" \
  -H "X-API-Key: your-api-key-here"

Antwort

{
  "doctors": [
    {
      "uid": "doc-abc123",
      "display_name": "Dr. Schmidt"
    },
    {
      "uid": "doc-def456",
      "display_name": "Dr. Meier"
    }
  ],
  "total": 15,
  "totalPages": 1
}

Arztstatistiken abrufen

Rufen Sie Rezeptstatistiken für einen bestimmten Arzt über einen Zeitraum ab.

GET /v1/management/doctors/{doctor_uid}/statistics

string

erforderlich

Die Arzt-UID

integer

erforderlich

Beginn des Zeitraums (Unix-Zeitstempel in Sekunden)

integer

erforderlich

Ende des Zeitraums (Unix-Zeitstempel in Sekunden)

Erforderliche Berechtigung: doctor_statistics:read

Beispielanfrage

curl -X GET "https://api.rxscale.com/v1/management/doctors/doc-abc123/statistics?from=1709251200&to=1711929600" \
  -H "X-API-Key: your-api-key-here"

Antwort

{
  "uid": "doc-abc123",
  "display_name": "Dr. Schmidt",
  "prescription_statistics": {
    "signed": 42,
    "waiting_for_doctor": 3,
    "rejected": 1
  }
}

Antwortfelder

Feld	Typ	Beschreibung
`uid`	string	Arzt-UID
`display_name`	string	Anzeigename des Arztes
`prescription_statistics`	object	Rezeptanzahlen gruppiert nach Status

Fehlerantworten

Statuscode	Beschreibung
`400`	Fehlende oder ungültige `from`-/`to`-Parameter
`404`	Arzt nicht gefunden oder gehört zu einer anderen Organisation

SKU-Sperrliste eines Arztes

Einzelne SKUs können für eine Ärztin oder einen Arzt gesperrt werden. Eine gesperrte SKU steht dieser Person beim Verschreiben nicht mehr zur Verfügung; alle anderen Ärztinnen und Ärzte der Organisation sind nicht betroffen. Alle drei Endpoints lösen den Arzt innerhalb der Organisation auf, der der API-Schlüssel gehört. Eine Arzt-UID aus einer anderen Organisation gilt als nicht gefunden.

Gesperrte SKUs auflisten

GET /v1/management/doctors/{doctor_uid}/blacklisted-skus

Gibt eine paginierte Liste der SKUs zurück, die dieser Arzt nicht verschreiben darf. Erforderliche Berechtigung: doctor_blacklist:read

string

erforderlich

Die Arzt-UID

integer

Standard:"0"

Seitennummer (nullbasiert)

integer

Standard:"50"

Anzahl SKUs pro Seite. Begrenzt auf 200.

string

Groß-/Kleinschreibung ignorierender Teilstring-Filter. Trifft auf den Anzeigenamen der SKU, den Anzeigenamen des Produkts oder die PZN zu.

Beispielanfrage

curl -X GET "https://api.rxscale.com/v1/management/doctors/doc-abc123/blacklisted-skus?page=0&limit=25" \
  -H "X-API-Key: ihr-api-schluessel"

Antwort

Dieser Endpoint liefert seine Zeilen unter blacklisted_skus, nicht unter data wie die übrigen paginierten Endpoints. totalRegistries und totalPages verhalten sich wie unter Paginierung beschrieben.

{
  "doctor_uid": "doc-abc123",
  "blacklisted_skus": [
    {
      "uid": "sku-abc123",
      "display_name": "Beispiel-SKU 10g",
      "product_uid": "prod-abc123",
      "product_display_name": "Beispielprodukt",
      "pzn": "12345678"
    }
  ],
  "totalRegistries": 1,
  "totalPages": 1
}

Antwortfelder

Feld	Typ	Beschreibung
`doctor_uid`	string	Der Arzt, zu dem die Sperrliste gehört
`blacklisted_skus[].uid`	string	SKU-UID
`blacklisted_skus[].display_name`	string	Anzeigename der SKU
`blacklisted_skus[].product_uid`	string	UID des Produkts, zu dem die SKU gehört
`blacklisted_skus[].product_display_name`	string \| null	Anzeigename des Produkts, oder `null`, wenn die SKU kein Produkt hat
`blacklisted_skus[].pzn`	string \| null	Pharmazentralnummer, falls gesetzt
`totalRegistries`	integer	Gesamtzahl der gesperrten SKUs, die dem Filter entsprechen
`totalPages`	integer	Gesamtzahl der Seiten

Fehlerantworten

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

SKU sperren

POST /v1/management/doctors/{doctor_uid}/blacklisted-skus

Sperrt eine SKU für diesen Arzt. Erforderliche Berechtigung: doctor_blacklist:write

string

erforderlich

Die Arzt-UID

string

erforderlich

UID der zu sperrenden SKU. Die SKU muss zur selben Organisation gehören.

Beispielanfrage

curl -X POST "https://api.rxscale.com/v1/management/doctors/doc-abc123/blacklisted-skus" \
  -H "X-API-Key: ihr-api-schluessel" \
  -H "Content-Type: application/json" \
  -d '{
    "sku_uid": "sku-abc123"
  }'

Antwort (201)

{
  "doctor_uid": "doc-abc123",
  "sku_uid": "sku-abc123"
}

Fehlerantworten

Statuscode	Beschreibung
`400`	`sku_uid` fehlt im Anfragekörper
`403`	Fehlende Berechtigung `doctor_blacklist:write`
`404`	Arzt oder SKU nicht gefunden oder gehört zu einer anderen Organisation
`409`	Diese SKU ist für diesen Arzt bereits gesperrt

Der 409-Körper nennt beide UIDs:

{
  "error": "SKU sku-abc123 is already blacklisted for doctor doc-abc123"
}

SKU wieder freigeben

DELETE /v1/management/doctors/{doctor_uid}/blacklisted-skus/{sku_uid}

Erlaubt diesem Arzt wieder, die SKU zu verschreiben. Erforderliche Berechtigung: doctor_blacklist:write

string

erforderlich

Die Arzt-UID

string

erforderlich

UID der SKU, die von der Sperrliste entfernt werden soll

Beispielanfrage

curl -X DELETE "https://api.rxscale.com/v1/management/doctors/doc-abc123/blacklisted-skus/sku-abc123" \
  -H "X-API-Key: ihr-api-schluessel"

Antwort

204 No Content mit leerem Körper.

Fehlerantworten

Statuscode	Beschreibung
`403`	Fehlende Berechtigung `doctor_blacklist:write`
`404`	Arzt nicht gefunden, oder diese SKU steht nicht auf der Sperrliste des Arztes

Erste Schritte

Externe Apotheken-API

Management-API

Scheduling API

Öffentliche API

Patienten-API

Anamnese-API

Webhooks

Anleitungen

Ärzte

Ärzte

Ärzte auflisten

Beispielanfrage

Antwort

Arztstatistiken abrufen

Beispielanfrage

Antwort

Antwortfelder

Fehlerantworten

SKU-Sperrliste eines Arztes

Gesperrte SKUs auflisten

Beispielanfrage

Antwort

Antwortfelder

Fehlerantworten

SKU sperren

Beispielanfrage

Antwort (201)

Fehlerantworten

SKU wieder freigeben

Beispielanfrage

Antwort

Fehlerantworten

​Ärzte

​Ärzte auflisten

​Beispielanfrage

​Antwort

​Arztstatistiken abrufen

​Beispielanfrage

​Antwort

​Antwortfelder

​Fehlerantworten

​SKU-Sperrliste eines Arztes

​Gesperrte SKUs auflisten

​Beispielanfrage

​Antwort

​Antwortfelder

​Fehlerantworten

​SKU sperren

​Beispielanfrage

​Antwort (201)

​Fehlerantworten

​SKU wieder freigeben

​Beispielanfrage

​Antwort

​Fehlerantworten

Ärzte

Ärzte auflisten

Beispielanfrage

Antwort

Arztstatistiken abrufen

Beispielanfrage

Antwort

Antwortfelder

Fehlerantworten

SKU-Sperrliste eines Arztes

Gesperrte SKUs auflisten

Beispielanfrage

Antwort

Antwortfelder

Fehlerantworten

SKU sperren

Beispielanfrage

Antwort (201)

Fehlerantworten

SKU wieder freigeben

Beispielanfrage

Antwort

Fehlerantworten