Developer Center
Developer Center
Integration und strukturierter Datentransfer mit der OPAN® API.
Mit der OPAN® API und den Integrationsschnittstellen können Sie sich mit verschiedenen Anwendungen verbinden. Sei es als zuweisende Institution / Organisation oder als ein Anbieter der Anmeldungen verarbeitet.
Unsere flexiblen Implementierungsoptionen ermöglichen es Ihnen, eine:
- API native Integration
- Partielle Integration
- URL-Parameterschnittstelle
Flexible Integration für optimale Anpassung an betriebliche Anforderungen und bestehende Systeme. Steigert Effizienz und verbessert Datenmanagement. Eine stets aktuelle OpenAPI-Spec-Dokumentation, inklusive Postman-Collection und detaillierter Prozessbeschreibungen, unterstützt die effektive Implementierung und Nutzung der APIs mit allen notwendigen Ressourcen und Anleitungen.
Holen Sie das Maximale aus unserer Plattform: API-Docs, Tutorials, Workflow-Tipps, Integrationsideen und aktuelle Updates - alles kompakt für Sie zusammengestellt. Beantragen Sie jetzt Ihren Account und beginnen Sie mit der Integration!
Haben Sie Fragen zur Integration, den Workflows und den technischen Anforderungen? Haben Sie einen speziellen Use Case? Vereinbaren Sie unverbindlich einen Online-Termin mit unseren Entwicklern.
Werden Sie Teil unserer Slack-Community, um Support und wertvolle Infos für Ihre Integration zu bekommen. Vernetzen Sie sich, tauschen Sie Wissen aus und arbeiten Sie gemeinsam mit Gleichgesinnten.
OPAN® API V3 für Zuweiser (Sender)
Die OPAN® API V3 ist für überweisende Institutionen wie Spitäler, Kliniken, Praxen und andere Gesundheitsdienste konzipiert, um strukturierte Daten an die OPAN® Plattform zu senden. Sie erleichtert den Überweisungsprozess für Patienten, die in Nachsorgeorganisationen übergehen.
Zielgruppe: Spitäler, Kliniken, Arztpraxen und andere Gesundheitsorganisationen, die Patienten an Nachsorgeinstitutionen überweisen.
Vollständige API Integration: Die voll integrierbare API von OPAN® ermöglicht eine nahtlose Anbindung der eigenen Fachsoftware an die OPAN® Plattform. OPAN® kann komplett über die API und bedient werden. Dies erfordert jedoch erheblichen Integrationsaufwand und eignet sich insbesondere für App Anbieter.
Partielle Integration: Bei der partiellen API-Integration werden Stammdaten, Dokumente und Auftragsinformationen automatisch übermittelt. Das System generiert daraufhin einen Hash und eine Frontend-URL, die den Benutzer zur OPAN®-Oberfläche leitet. Dort kann ein geeigneter Anbieter ausgewählt und die Anmeldung abgeschlossen werden. Nach der Übermittlung können alle weiteren Interaktionen, einschliesslich Nachträge und Statusabfragen, wieder über die API erfolgen. Diese Methode eliminiert die Notwendigkeit, GUIs in der Fachapplikation zu implementieren. Zudem übernimmt OPAN® einen Grossteil der Businesslogik, was den Integrationsaufwand erheblich reduziert und eine effiziente, entwicklerfreundliche Lösung bietet.
Effizienz: Unsere API optimiert den Überweisungsprozess durch die Übertragung strukturierter Daten.
Flexibilität: Wir bieten sowohl vollständige als auch teilweise Integrationsoptionen, die flexible, systemübergreifende technische Integrationen ermöglichen.
Benutzerfreundlich: OPAN® bietet eine intuitive Benutzeroberfläche für Interaktionen, die eine einfache Handhabung und genaue Dateneingabe sicherstellt.
Weitere Details und Implementierungsrichtlinien finden Sie in unserer OpenAPI-Spec-Dokumentation, die Postman-Sammlungen und ausführliche Beschreibungen des gesamten Prozesses umfasst.
OPAN® API V3 für Anbieter (Empfänger)
Die OPAN® API für Anbieter ist für Organisationen und Institutionen wie Spitex, Heime, Rehakliniken und psychiatrische Kliniken konzipiert, die Anmeldungen über OPAN® empfangen. Das Hauptziel ist es, den Empfang strukturierter Daten von der OPAN® Plattform zu erleichtern.
Datenempfang: OPAN® ermöglicht Nachsorgeinstitutionen, strukturierte Daten von übermittelten Anmeldungen und Anfragen effizient herunterzuladen und zu verarbeiten.
Strukturierte Daten: Die API liefert detaillierte, strukturierte Informationen basierend auf den Anmeldefeldern. Je umfangreicher die bereitgestellten Daten, desto robuster ist die Verarbeitung im primären Softwaresystem der Nachsorgeinstitutionen.
Dokumentenzugriff: Bietet einfachen Zugang zu übermittelten Dokumenten und PDF-Zusammenfassungen der Anmeldungs-Details, einschliesslich Kommentaren, internen Notizen und allen relevanten Interaktionen.
Automatisierung: Ermöglicht die automatische Aktualisierung von nachträglich übermittelten Informationen und Dokumenten, was den Verwaltungsaufwand minimiert.
Compliance-konforme Archivierung: Unterstützt die langfristige, gesetzeskonforme Datenspeicherung beim Kunden durch Bereitstellung umfassender Zusammenfassungen.
Effizienz: OPAN® optimiert den Datenempfangsprozess, indem es ermöglicht, die über die API übermittelten Anmeldedaten direkt in die Fachapplikation zu integrieren. Dies streamlint den gesamten Workflow und reduziert manuelle Eingaben.
Umfassende Daten: Das System gewährleistet, dass alle relevanten Anmeldedaten in einem strukturierten und leicht zugänglichen Format bereitgestellt werden.
Nahtlose Integration: Bei optimaler API-Integration durch den Softwarehersteller können sämtliche in OPAN® verfügbaren Daten direkt über die API abgerufen werden. Dies eliminiert Medienbrüche und ermöglicht einen durchgängig digitalen Prozess.
Weitere Details und Implementierungsrichtlinien finden Sie in unserer OpenAPI-Spec-Dokumentation, die Postman-Sammlungen und ausführliche Beschreibungen des gesamten Prozesses umfasst.
OPAN® UPI (URL Parameter Interface)
Die OPAN® UPI (URL Parameter Interface) bietet eine vereinfachte Methode, um strukturierte Daten mithilfe von URL-Parametern an die OPAN® Plattform zu senden. Diese Integrationsmethode ist ideal für schnelle und unkomplizierte Datenübermittlung mit bestimmten Einschränkungen.
Vereinfachte Datenübermittlung: Nutzt URL-Parameter zum Senden von Daten, was die Implementierung erleichtert. Das Zeichenlimit ist jedoch auf 2048 Zeichen beschränkt.
Fire-and-Forget Mechanismus: Entwickelt für einmalige Datenübermittlung ohne Bedarf an Statusaktualisierungen und Bezug zur Anmeldung (Backlink).
Broker UPI: Mit Fokus auf Hersteller von Praxissoftware. Bei dieser Version ist der API-Schlüssel mit der Praxissoftware verknüpft, nicht mit dem Endempfänger. Benutzer müssen bei der Übermittlung einer Anmeldung die eigene Praxis oder Organisation auswählen, was eine flexible Datenweiterleitung ermöglicht. Eine Praxissoftware kann das OPAN® UPI somit einmal generisch integrieren, um den Zugang für alle ihre Benutzer zu ermöglichen. Dies ist besonders leistungsfähig mit dem HIN Login, einer unterstützten Funktionalität der OPAN® Plattform.
Fire-and-Forget Prinzip: Nach dem Senden der Daten erfolgt keine weitere automatische Interaktion mit OPAN®. Dies entspricht dem Ablauf beim klassischen Webformular. Statusaktualisierungen oder automatische Rückmeldungen sind in diesem Modus nicht verfügbar. Es existiert kein direkter Backlink zur ursprünglichen Anwendung.
Eingeschränkter Dokumentenupload: Die Parameterschnittstelle unterstützt keinen direkten Dokumentenupload. Für das Einreichen von Dokumenten muss das reguläre Browser-Upload-Formular genutzt werden. Dies erfordert einen separaten Schritt für Dokumentenuploads.
Um auf die UPI-Dokumentation zuzugreifen und die OPAN® UPI zu nutzen, müssen Sie sich für einen Developer Account registrieren.
Häufig gestellte Fragen (FAQ)
-
Wie erhalte ich einen API-Key?
Registrieren Sie sich als Entwickler bei OPAN®. Im Entwickler-Account erhalten Sie Zugriff auf eine Test-Organisation und können den Test-API-Key abrufen. Für die Produktivschaltung, z.B. bei einem Kunden (wenn Sie Softwareanbieter sind), kann der Kunde Ihnen den produktiven API-Key zur Verfügung stellen.
-
Welche Testumgebungen bietet OPAN®?
OPAN® bietet drei relevante System-Instanzen:
- PRODUCTION: Das Livesystem für den produktiven Einsatz.
- TESTING: Testumgebung für Integratoren zur API-Erprobung und für automatisierte Tests. Sie entspricht dem aktuellen Produktivstand.
- STAGING: Abnahmesystem für neue Funktionen vor dem Production-Release. Hier werden Updates getestet und freigegeben.
-
Welche Daten können übermittelt und abgerufen werden?
Über die API können Sie alle Daten und Felder, die im Anmeldeformular enthalten sind, übermitteln oder abrufen.
-
Wie erstelle ich eine Support-Anfrage oder einen Change-Request?
Melden Sie sich mit Ihrem Entwickler-Account an und klicken Sie auf das Support-Icon (?) unten rechts. Übermitteln Sie Ihre Anfrage über unser Ticketing-System. So behalten Sie den Überblick über den Status Ihrer Anfrage, und sie geht nicht in einer E-Mail-Inbox verloren.