Default Interface Hospital

Introduction

The soobr API allows external systems to trigger tasks and receive feedback upon completion. This interface serves as an efficient connection between the customer system and the soobr order management system, streamlining workflows and simplifying communication.

 

Technical Specification

Communication

The communication is conducted via a REST interface (SSL). The content of the communication is formatted in JSON.

Authentication

Incoming to the soobr API

Authentication is performed via an API key in the header. The API key is generated by soobr.

Outgoing to the customer system

Currently, two authentication methods are supported:

1. API key in the header of the customer system
2. Header username & password from the customer system (Basic Auth)

Trigger an order (Customer System -> soobr)

Description

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

The customer system sends the desired task to soobr. soobr then creates the task in the Order management.

Request (POST)

/api/push-consumer/cis/generic

Body (JSON)

Attribute	Data Type	Required	Description
transactionId	String	Yes	Unique transaction identifier from the customer system. This ID will also be used in the response from soobr to the customer system.
date	Date / Time	No	Date and time of the task in ISO Date Time format (e.g., 2023-08-09T08:00:00Z). If omitted, the timestamp when the task is received by soobr will be used.
msgType	String	Yes	Task type to be triggered in soobr (e.g., bed cleaning, OR cleaning, etc.). This must define the desired task type. If only one task type is used, this field can be set to a fixed value.
roomName	String	Yes	Room name. Must match the soobr area reference ID.
bedName	String	No	Bed identification, e.g., 048-489. Can be displayed to the cleaning staff.
bedLocation	String	No	Bed location, e.g., "next to window/door on the right." Can be displayed to the cleaning staff.
pointOfCare	String	No	Station name, e.g., "Intensive Care Unit." Can be displayed to the cleaning staff.
cleanerInfo	String	No	Additional instructions for the cleaning staff. Can be displayed to the cleaning staff.

Order executed (soobr -> Customer System)

Description

Once the task is completed by the cleaning staff, the customer system will be notified. The customer must provide an endpoint so that soobr can send the response.

Error Handling

soobr will attempt to send the notification three times, with a waiting time of 30 seconds between each attempt. If the transmission fails, an email address can be provided to receive the notification.

Request (POST)

Kunden-URL

Body (JSON)

Attribute	Data Type	Description
transactionId	String	Unique transaction identifier (see "Triggering an order").
closedDate	Date / Time	Completion timestamp of the task by the cleaning staff in ISO Date Time format (e.g., 2023-08-09T08:00:00Z).