See below "attachements" for a basic presentation about the Nobi integrations

1. Purpose

An integration allows Nobi to exchange information with a third party.
This information can be about the structure/organization of the site, such as departments, housing units, rooms, residents, …
But also in case of an escalation, this third party (eg a nurse call system) can be informed, and will handle the communication of the escalation towards the nursing staff over the local IP network of the site, or via the Nobi cloud.

2. Types of integration

2.1. Master data integrations

A master data integration will synchronize data such as residents, departments, rooms, escalation history, etc.

The basic purpose of a master data integration is to synchronize the data from the Nobi database with an external database, and this to keep the residents care records up to date with regards to aftercare.

2.2. Nurse call system integrations

These systems are installed locally in a care facility. The communication with these systems is done on the local network directly from the Nobi lamps.
In case an integration is made with one of these systems, the Nobi lamp will no longer start calling itself to the telephone numbers from the escalation procedure. The Nobi lamp will send the escalation to the integrated nurse call system (Aperi, Ascom, Essec, …), and this call system will handle the communication towards the nursing staff (via the normal channels also used for the nurse call system of the site: eg DECT handphones, smartphones, …)
Here we see 3 different types of integration:

• Vendor specific integration (Aperi, Ascom, Essec, Octapi, 25-8)
• Nobi generic integration: for nurse call systems who don’t have their own API, this generic API from Nobi was developed. The specifications of this API (Nobi Escalation Integration – Nobi EI) can be found on the following location:  https://nobi.cloud/api-docs/index.html?urls.primaryName=Nobi%20EI
• Nobi Relay integration: this is for integration by means of the Shelly modules, so that an escalation can be given to a nurse call system via a (potential-free) contact. 

2.3. OAuth application

For this type of integration, no specific effort is needed from Nobi. The third party receives our API documentation, and implements our API on their system or the system from the Nobi customer. All interaction is in this case between the third party system and the Nobi cloud.

The authentication of the third party is done via OAuth.

The following elements (=scopes) can be integrated by the third party:

- Department: information of the different departments in the site can be requested or changed by the third party

- Device: information of the devices (Nobi lamps) can be requested by the third party

- Escalation Event: this command allows the third party to close an escalation

- Housing unit: information of the housing units can be requested and changed by the third party

- Occupancy: is the link between the resident and a housing unit. Information about the occupancies can be requested or changed by the third party

- Resident: the data of the residents can be requested or changed by the third

- Room: information about the rooms can be requested or changed by the third party

- Speech: a lamp can be requested to say a certain message (via the loudspeakers) to the resident. The API allows to send a command to the device (lamp) to speak the requested message

- Webhooks: the third party can “subscribe” to the webhook, requesting to be informed when a resident_measurement, device_parameter, escalation_event, activity or alert is triggered (created, deleted or updated)

3. How to integrate

3.1. Master data integrations

Nobi made a master data integration with Caresolutions. To set up this integration, go to “integrations” from the main menu, and click on the button in the upper right corner.

There select “Caresolution” under Master data integrations:

You will have to fill in the following parameters:

• Base url(*)
• Initials(*)
• Password(*)
• Application key(*)
• Database(*)

The information for these parameters can be obtained in consultation with the Nobi customer and Caresolutions. The information marked with ^(*) is mandatory.

3.2. Nurse call system integrations

Nobi support the following nurse call systems:

- Aperi
- Ascom
- Essec
- Octapi
- 25-8
- Nobi Generic
- Nobi Relay

To set up an integration with a nurse call system, go to “integrations” from the main menu, and click on the button in the upper right corner. Select the nurse call system you want to integrate for this site.

Every nurse call system has its own specific parameters to fill in. Hereafter a short overview:

Nurse call system	Parameters
	Url(*): the url (IP address, port and path) of the Aperi Alert server Username(*): the username to be used to log in with on the Aperi Alert server Password(*): the password to be used in combination with the login above In addition, an external ID needs to be added to the housing unit. This ID is defined in agreement with Aperi. By using external ID’s, they can be used for their internal routing (eg. the first digit can indicate the floor: 0 for ground floor / 1 for 1st floor). External housing unit ID’s are configured in the backend (edit Housing Unit)
	Address(*) To(*)
	Url(*): the url (IP address, port and path) of the Netrix server Username(*): the username to be used to log in with on the Netrix server Password(*):the password to be used to log in with on the Netrix server Group ID(*): this is the ID of the Netrix group For the integration with Essec, no external ID’s are used for the housing units. The Nobi ID of every housing unit needs to be given to Essec. This housing unit ID can be found in the url of the housing unit, or under “Housing Units” in the Nobi backend. To close the escalations on the Nobi dashboard via the Essec system, it is important to make sure that also the port 8081 is open from the Netrix server to the Nobi lamp. To set up a voice call from the DECTs to the Nobi lamp, the lamp needs to be registered on the SIP server. The information related to the SIP server can be given in under de device settings in the Nobi backend (edit device). See screenshot below. Remark: for the username, a reference to the housing unit can be used. Every lamp needs it own username. The password can be set the same for all housing units.
	Auth Url(*): authentication URL API Url(*): URL to be used for the API communication Client ID(*): login ID Client Secret(*): login password For the integration with Octapi, no external ID’s are used for the housing units. The Nobi ID of every housing unit needs to be given to Octapi. This housing unit ID can be found in the url of the housing unit or under “Housing Units” in the Nobi backend.
	API URL(*):URL to be used for the API communication API key(*): key to be given to secure the communication Room state fall(*): ID for a fall in the room Room state panic(*): ID for a panic button alarm in the room Room state presence: ID to indicate that a nurse is present in the room In addition, an external ID needs to be added to the housing unit. This ID is defined in agreement with 25-8. External housing unit ID’s are configured in the backend (edit Housing Unit).
	Third party server URL(*): server url, port and path Check connection endpoint(*): connection heathcheck path Escalate endpoint(*): path to report escalations Escalation open endpoint(*): path to check for open escalations Nurse present endpoint: Nurse present is a recommended option. It’s not a must since not all legacy system can provide the nurse present information. Leave it empty if not used Auth type(*): can be “No Auth” or “Basic Auth” Auth config Username Password In addition, an ID for every housing unit needs to be exchanged with the third party. For the Nobi Generic integration, both the internal ID and the external ID (if filled in) will be exchanged. The external ID is defined in agreement with the third party. It is recommended to set up these external housing unit ID's. This is a one-time configuration during startup, but it provides the advantage of preventing issues when the internal Nobi ID's changes. Additionally, it can be utilized to introduce logic into the numbering system for external routing. External housing unit ID’s are configured in the backend (edit Housing Unit)   All detailed info about this API can be found on https://nobi.cloud/api-docs/index.html Select here
	Once the Nobi relay integration has been activated, housing units can be added by going to peripherals, select the Shelly relay module . During the configuration process, you will be asked to select the function you want to use for this shelly. Here select “Nurse call system”

Integration	Closes escalation	Supports nurse presence	Supports de-escalation if Closed in app	Supports external monitoring events

Important remark: If the snooze button is used to close an escalation, note that the escalation will only be closed on the integrated system if “de-escalation if Closed in app” is supported. If not, the escalation will also need to be closed on the third party system separately.

Once the integration has been set up, the status can be checked in the Nobi cloud frontend interface. Go to the main menu, click on:

You will then get a list of all the housing units, and the actual status of every housing unit (connected, or not connected):

If the status of a housing unit is “connected”, it means that:

• the external nurse call system server is reachable (so network / firewall settings are ok)
• the (external) housing unit id exists

This DOES NOT mean that:

• an escalation can be made
• an escalation open check is working
• a de-escalation (closing the escalation) is working

This because those endpoints can still be wrongly configured at our side or mal-configured at the nurse call system side.
So it’s very important to test a full fall cycle when configuring a new site !!

3.3. OAuth application