REST API v2 für ivoris®
Standardisierte Schnittstellen für die Integration externer Anwendungen
Mit der ivoris® REST API v2 stellen wir eine moderne und leistungsfähige Schnittstelle zur Verfügung, über die externe Anwendungen auf ausgewählte Daten und Funktionen von ivoris® zugreifen können. Die API ermöglicht die Anbindung individueller Softwarelösungen sowie die Integration von Drittanwendungen in bestehende Praxisprozesse.
Die ivoris® REST API v2 wird kontinuierlich weiterentwickelt und um zusätzliche Funktionen ergänzt. Diese Übersicht beschreibt ausschließlich den aktuell verfügbaren Funktionsumfang. Aussagen zu geplanten Funktionen, zukünftigen Erweiterungen oder möglichen Bereitstellungsterminen werden bewusst nicht getroffen.
Bitte sehen Sie daher von allgemeinen Anfragen zu zukünftigen API-Funktionen, geplanten Erweiterungen oder Roadmaps ab. Neue Funktionen werden nach ihrer Freigabe automatisch Bestandteil der offiziellen API-Dokumentation.
Welche Funktionen einer Anwendung tatsächlich zur Verfügung stehen, hängt von den jeweils freigeschalteten API-Paketen sowie den erforderlichen Berechtigungen innerhalb von ivoris® ab.
Aktuell verfügbare Funktionsbereiche
- Patienten suchen und abrufen
- Patienten neu anlegen
- Patientendaten aktualisieren
- Patientenzusammenfassung abrufen
- Patientenspezifische Optionen abrufen
- Patienten sperren bzw. entsperren
- Datum des letzten Einlesens der Versichertenkarte abrufen
- Termine und Patiententermine abrufen
- Nächsten Termin eines Patienten ermitteln
- Termine neu anlegen
- Termine für unbekannte Patienten anlegen
- Termine ohne Patient anlegen
- Termine verschieben und absagen
- Terminstatus und Terminbestätigung ändern
- Kommentare, Dauer und Erinnerungsinformationen aktualisieren
- Prüfen, ob ein Termin angelegt werden kann
- Voraussetzungen für Terminerinnerungen prüfen
- Freie Termine ermitteln
- Terminarten und Behandlungsstühle abrufen
- Sprechzeiten und Behandlerzeiten abrufen
- Feiertage und Schulferien abrufen
- Sonderzeiten abrufen
- Planerstruktur, Auflösung und Farben abrufen
- Planeransichten abrufen
- Tagesmeldungen abrufen, anlegen und ändern
- Änderungen an Terminplanerdaten erkennen
- Dokumentationseinträge eines Patienten abrufen
- Einzelne Dokumentationseinträge abrufen
- Dokumentationseinträge neu anlegen und aktualisieren
- Dokumentationsübersichten und Zusammenfassungen abrufen
- Dokumente eines Patienten abrufen und hinzufügen
- Benutzersymbole abrufen und ändern
- Individuelle Zeilenfarben abrufen und ändern
- Bilder suchen und abrufen
- Bilder eines Patienten abrufen
- Neue Bilder hinzufügen
- Bildinformationen aktualisieren
- Bilddaten abrufen
- Bildtypen abrufen
- Sichtbarkeit von Bildern für Profile verwalten
- Allgemeine Patientenmerkmale abrufen und setzen
- Patientenkennzeichen abrufen und setzen
- Patienteninformationen abrufen und setzen
- Aktuelle Werte und Historien abrufen
- Vorlagen für Merkmale, Kennzeichen und Informationen abrufen
- Patientenlisten abrufen
- Neue Patientenlisten anlegen
- Patientenlisten aktualisieren
- Patienten zu Listen hinzufügen
- Einträge einer Patientenliste abrufen
- Status eines Listeneintrags ändern
- Barcode-Typen abrufen
- Barcode-Typ anhand eines Musters erkennen
- Barcodes eines Patienten abrufen
- Neue Barcodes anlegen
- Barcodes aktualisieren
- Alle oder nur aktive Behandler abrufen
- Behandler nach Eigenschaften oder Rollen suchen
- Einzelne Behandler abrufen
- Anzeigenamen eines Behandlers abrufen
- Änderungen an Behandlerdaten erkennen
- Aufgaben abrufen und suchen
- Aufgaben neu anlegen
- Aufgaben aktualisieren
- Aufgabenzusammenfassungen abrufen
- Neue bzw. geänderte Aufgaben abrufen
- Aufgabenindex erzeugen
- Aufgabentypen abrufen, anlegen und ändern
- Automatisierte Aufgaben ausführen
- Teams und einzelne Teams abrufen
- Teamzusammenfassungen abrufen
- Mitglieder eines Teams abrufen
- Abteilungen abrufen
- Abteilungstypen abrufen
- Krankenkasseninformationen abrufen
- Aktuelle Versicherungsinformationen eines Patienten abrufen
- Versicherungszusammenfassung abrufen
- Patienten anhand von Anspruchsnachweisen zuordnen
- Versicherungsinformationen aktualisieren
- Zahlungsverhalten eines Patienten abrufen
- Stationen abrufen
- Neue Stationen anlegen
- Stationen aktualisieren
- Patienten in Stationen abrufen
- Patienten ins Wartezimmer aufnehmen
- Patienten zwischen Stationen verschieben
- Patienten aus dem Wartezimmer austragen
- Aktuelle Station eines Patienten abrufen
- Stationsverlauf eines Patienten abrufen
- Änderungen im Wartezimmer seit einem bestimmten Zeitpunkt abrufen
- Wartezimmeransichten abrufen
- TI-Verbindungskontexte abrufen
- Verfügbare Karten eines Kontexts abrufen
- PIN-Status abrufen
- Versichertenkarte über VSDM einlesen
- Verfügbare Mandanten bzw. Profile abrufen
- Einzelnes Profil abrufen
- Anmelden und abmelden
- Aktuellen Anmeldekontext abrufen
Hinweis zur Programmierung und Support
Support zur Programmierung, Implementierung oder Fehleranalyse kundeneigener Anwendungen wird nicht geleistet.
Die ivoris® REST API v2 stellt ausschließlich die dokumentierten Endpunkte sowie die dazugehörigen technischen Schnittstelleninformationen bereit. Die Konzeption, Entwicklung, Implementierung, Wartung und Fehlerbehebung von Anwendungen, die diese Schnittstellen nutzen, erfolgen eigenverantwortlich durch die Praxis bzw. den von ihr beauftragten Entwickler oder Softwareanbieter und sind nicht Bestandteil der Leistungen der Computer konkret AG.
Anfragen zur Umsetzung individueller Programmieraufgaben, zur Erstellung von Beispielanwendungen oder zur Fehlerbehebung im kundenseitigen Quellcode können daher nicht beantwortet werden.
Sofern in Ausnahmefällen dennoch eine technische Unterstützung durch die Computer konkret AG erfolgt, werden diese Leistungen nach vorheriger Abstimmung mit einem Stundensatz von 150,00 € zzgl. gesetzlicher Mehrwertsteuer abgerechnet. Ein Anspruch auf die Erbringung solcher Unterstützungsleistungen besteht nicht.
Voraussetzungen
Die Nutzung der ivoris® REST API v2 setzt eine eingerichtete Nutzerverwaltung sowie die installierte und betriebsbereite ivoris® Webanwendung voraus.
Kunden, die diese Voraussetzungen noch nicht erfüllen, können bereits heute die benötigte security plus-Erweiterung kostenfrei durch uns freischalten lassen und sich damit frühzeitig die Installation der ivoris® Webanwendung vorbereiten bzw. sichern.
Zusätzlich ist eine ausgefüllte und unterschriebene NDA Voraussetzung für die Nutzung der ivoris® REST API v2. Bitte fügen Sie diese an das nachfolgende Bestellformular an.
Erst nach erfolgreicher Einrichtung dieser Komponenten können API-Freigaben und die entsprechenden Berechtigungen für die Nutzung der REST API bereitgestellt werden.
Termin zur Freischaltung von ivoris® security plus vereinbaren.
Bestellung einer REST API V2 für ivoris®
