Die API-Schnittstelle dient dem sicheren Datenaustausch zwischen dem Patientenportal und der Kliniksoftware.
Über die Schnittstelle kann die Kliniksoftware abgeschlossene Portalvorgänge automatisiert abrufen, die zugehörigen Patientendaten herunterladen und den erfolgreichen Import bestätigen.
Die Kommunikation erfolgt ausschließlich authentifiziert. Jede Klinik erhält dafür einen eigenen API-Schlüssel. Dieser Schlüssel darf nicht öffentlich dokumentiert, weitergegeben oder in öffentlich zugänglichen Skripten gespeichert werden.
Die Schnittstelle unterstützt grundsätzlich folgende Arbeitsschritte:
- Abruf offener Portalvorgänge
Die Kliniksoftware fragt regelmäßig ab, ob neue, vom Patienten verbindlich abgesendete Vorgänge vorliegen.
- Abruf von Statusinformationen
Zu jedem Vorgang werden technische Informationen bereitgestellt, zum Beispiel die Zuordnung zur Klinik, die Patientenzuordnung und vorhandene Upload-Dateien.
- Abruf der Patientendaten
Die Patientendaten können in verschiedenen Formaten bereitgestellt werden.
Unterstützt werden je nach Konfiguration:
JSON
INI
XML
HTML
Die HTML-Datei dient der lesbaren Ansicht für Ärzte, Therapeuten oder Verwaltung.
Die strukturierten Formate dienen dem technischen Import in das Kliniksystem.
- Abruf hochgeladener Dateien
Vom Patienten hochgeladene Dokumente können automatisiert übernommen werden.
Beispiele:
Befunde
Arztberichte
Entlassungsberichte
Medikamentenpläne
- Importbestätigung
Nach erfolgreichem Import bestätigt die Kliniksoftware den Vorgang.
Erst danach gilt der Vorgang als abgeholt und wird bei weiteren Abrufen nicht erneut bereitgestellt.
Sicherheitsprinzipien
Die Schnittstelle ist nicht für den direkten Aufruf durch Patienten oder Browser vorgesehen.
Der Zugriff ist nur mit gültigem API-Schlüssel möglich.
Jede Klinik erhält ausschließlich Zugriff auf die für sie bestimmten Vorgänge.
Der API-Schlüssel muss vertraulich behandelt werden.
Ein Import sollte nur von autorisierten Systemen innerhalb der Klinik erfolgen.
Empfehlung für die Klinik-IT
Das Importskript sollte regelmäßig automatisiert ausgeführt werden.
Der API-Schlüssel sollte nicht im Klartext in frei zugänglichen Dateien gespeichert werden.
Der Importpfad sollte nur für berechtigte Benutzer und Dienste zugänglich sein.
Nach erfolgreichem Import sollte die Importbestätigung gesendet werden.
Fehler beim Import sollten protokolliert und regelmäßig geprüft werden.
Hinweis
Die konkreten technischen Endpunkte, Parameter und Beispielskripte werden nicht öffentlich dokumentiert.
Sie werden ausschließlich im Rahmen der technischen Einrichtung durch ASPI bereitgestellt.