Zum Hauptinhalt springen

Ärzte

Rufen Sie eine Liste der Ärzte in Ihrer Organisation ab und sehen Sie deren Rezeptstatistiken über einen bestimmten Zeitraum ein.
Um Rezeptstatistiken für jeden Arzt der Organisation in einem einzigen paginierten Aufruf abzurufen, siehe stattdessen GET /statistics/doctors.

Ärzte auflisten

integer
Standard:"0"
Seitennummer (0-indexiert)
integer
Standard:"50"
Anzahl der Ärzte pro Seite
Erforderliche Berechtigung: doctor:read

Beispielanfrage

Antwort

Arztstatistiken abrufen

Rufen Sie Rezeptstatistiken für einen bestimmten Arzt über einen Zeitraum ab.
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

Antwort

Die Status-Schlüssel sind die wörtlichen PrescriptionStatus-Werte: waiting for doctor, approved, signed, declined, cancelled, ON_HOLD, NON_QES_SIGNED, EXTERNALLY_SIGNED. Siehe Rezeptstatus für die Bedeutung der einzelnen Werte. Nur Status mit mindestens einem passenden Rezept im Zeitraum werden angezeigt.

Antwortfelder

Fehlerantworten

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

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.
Groß-/Kleinschreibung ignorierender Teilstring-Filter. Trifft auf den Anzeigenamen der SKU, den Anzeigenamen des Produkts oder die PZN zu.

Beispielanfrage

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.

Antwortfelder

Fehlerantworten

SKU sperren

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

Antwort (201)

Fehlerantworten

Der 409-Körper nennt beide UIDs:

SKU wieder freigeben

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

Antwort

204 No Content mit leerem Körper.

Fehlerantworten