Standard Schnittstelle Krankenhaus

Einleitung

Die Schnittstelle kann verwendet werden um von einem externen System Aufträge in soobr auszulösen und eine Rückantwort nach der Ausführung von dem Auftrag zu erhalten.

 

Technische Spezifikation

Kommunikation

Die Kommunikation findet über eine REST-Schnittstelle (SSL)  statt. Für den Inhalt der Kommunikation wird ein JSON Format verwendet.

Authentifizierung

Eingehend zu der soobr API

Die Authentifizierung wird über einen Header API Key gemacht. Der API Key wird von soobr generiert.

Ausgehend zu dem Kundensystem

Aktuell werden zwei Authentifizierungen unterstützt:

• Header API Key vom Kundensystem
• Header Benutzername & Passwort vom Kundensystem (Basic Auth)

Auftrag auslösen (Kundensystem -> soobr)

Beschreibung

Das Kundensystem übertrag den gewünschten Auftrag an soobr. soobr löst damit einen Auftrag im Auftragsmanagement (Cockpit) aus.

Request (POST)

/api/push-consumer/cis/generic

Body (JSON)

Attribut	Datentyp	Zwingend	Beschreibung
transactionId	String	Ja	Kundensystem Transaktionsidentifikation. Diese Nummer muss eindeutig sein und wird in der Antwort (soobr -> Kundensystem) als Identifikation verwendete
date	Date / Time	Nein	Datum & Zeit des Aufrages im ISO Date Time Format (z.B. 2023-08-09T08:00:00Z). Sofern nicht enthalten, wird Datum / Zeit von soobr gesetzt (Zeitpunkt an dem der Auftrag bei soobr einging).
msgType	String	Ja	In soobr werden Leistungsarten (z.B. Bettreinigung, OP Reinigung etc.) ausgelöst. Damit soobr die richtige Leistungsart auslösen kann, muss im msgType die gewünschte Leistungsart definiert werden. Sofern nur eine Leistungsart benötigt wird, kann dieses Feld fix gesetzt werden.
roomName	String	Ja	Raumname. Muss mit der soobr Flächen Referenz-ID übereinstimmen
bedName	String	Nein	Bettidentifikation z.B. 048-489. Kann der Reinigungskraft angezeigt werden.
bedLocation	String	Nein	Bettstandort z.B. Fenster / Tür rechts. Kann der Reinigungskraft angezeigt werden.
pointOfCare	String	Nein	Stationsname z.B. Intensivstation. Kann der Reinigungskraft angezeigt werden.
cleanerInfo	String	Nein	Weitere Anweisungen für die Reinigungskraft. Kann der Reinigungskraft angezeigt werden.

Auftrag ausgeführt (soobr -> Kundensystem)

Beschreibung

Sobald der Auftrag durch die Reinigungskraft abgeschlossen wurde, wird dies dem Kundensystem gemeldet. Dafür muss der Kunde einen Endpoint zur Verfügung stellen, damit soobr die Antwort übertragen kann.

Fehlerbehandlung

soobr versucht die Meldung 3 Mal zu übertragen mit einer Wartezeit von 30 Sekunden. Ist die Übertragung nicht möglich, kann eine E-Mail Adresse hinterlegt werden. Auf diese E-Mail Adresse wird dann eine Meldung gesendet.

Request (POST)

Kunden-URL

Body (JSON)

Attribut	Datentyp	Beschreibung
transactionId	String	Eindeutige Transaktionsidentifikation (siehe Auftrag auslösen)
closedDate	Date / Time	Zeitpunkt vom Abschluss des Auftrags durch die Reinigungskraft im ISO Date Time Format (z.B. 2023-08-09T08:00:00Z)