Nurse Call Systems Integration with Wildix W-AIR - Admin Guide

This document describes how to configure the integration between W-AIR and any Nurse call system. 

User Guide: Nurse Call Systems Integration with Wildix W-AIR - User Guide.

Created: June 2024

Permalink: https://wildix.atlassian.net/wiki/x/UATOAQ

Introduction

The integration is used for the following in terms of nurse call systems:

  • Sending/ receiving SMS on W-AIR handsets
  • Sending alarms from W-AIR handsets to a Message server
  • Receiving alarms on W-AIR handsets from a Message server
  • Sending beacon information to a Message server

The integration is based on sending UDP packets and an acknowledge that the UDP packets are received.

Here is an example of sending beacon information from a beacon to a Message server through W-AIR handset and base station:

Here is an example of sending an alarm from a Message server to W-AIR handset:

Requirements

  • WMS 6.0X
  • W-AIR firmware version 730b200
  • Supported devices
    • W-AIR base station: W-AIR Sync Plus, W-AIR Base Station
    • W-AIR handset: W-AIR Med, W-AIR LifeSaver, W-AIR LifeSaver-EX

Message types and format

There are 5 different message types that can be used between a Message server and W-AIR base station:

XML tag

Description

Direction

Systeminfo

Messages that handle synchronization between W-AIR base station (BS) and a Message server (MS)

MS -> BS

BS -> MS

Login

Messages that inform a Message server about location of W-AIR handset on a specific W-AIR base station

BS -> MS

Job





Alarms sent from a Message server to W-AIR base station and displayed on W-AIR handset under an alarm icon

MS -> BS

SMS sent from a Message server to W-AIR base station and displayed under an SMS icon

MS -> BS

SMS sent from W-AIR base station/ handset to another W-AIR base station/ handset via a Message server

BS -> MS

alarm

Alarms sent from W-AIR base station/ handset to a Message server

BS -> MS

beacon

Beacon information sent from W-AIR base station/ handset to a Message server

BS -> MS


Systeminfo and Login are only used when a Message server needs to send alarms/ SMS to W-AIR base station/ handset. For those Message servers that only receive beacons/ alarms from W-AIR base station/ handset, Systeminfo and Login procedures can be skipped.

Below there is a description of message formats between a Message server and W-AIR base station, followed by different message types.

XML interface: total length of XML packet is 4096 bytes. The interface follows the XML standards. Here are some basic rules:

  • All XML packets need to start with this XML header: 

    <?xml version="1.0" encoding="UTF-8"?>
  • No spaces in the < > elements, except for separating attributes. Examples: 

    <element> is valid
    < element > is not valid (spaces before and after “element”) 
    <element > is not valid (space after “element”)
    <element attribute=”attribute1”> is valid 
    <element attribute = “attribute1” > is not valid (spaces before and after = and after the second “)
    <element /> is not valid (space before /)
  • All elements have to be properly closed

  • UTF-8 is not supported, only the below extended ASCII table is supported:

XML schema description

This is XML schema description for the generic outgoing XML-based interface from a Message server. W-AIR base station should ignore unknown fields and packages received from a Message server.

 FrameDef
<xs:element name="request" type="FrameDef" />
<xs:element name="response" type="FrameDef" />
<xs:complexType name="FrameDef">
<xs:attribute name="version" type="xs:string" /> 
<xs:attribute name="type" type="xs:string" /> 
<xs:sequence>
<xs:element name="externalid" type="xs:string" minOccurs="1"/> 
<xs:element name="status" type="xs:decimal" minOccurs="0"/> 
<xs:element name="statusinfo" type="xs:string" minOccurs="0"/> 
<xs:element name="systemdata" type="SystemDataDef" minOccurs="1"/> 
<xs:element name="jobdata" type="JobDataDef" minOccurs="0"/> 
<xs:element name="alarmdata" type="AlarmDataDef" minOccurs="0"/> 
<xs:element name="beacondata" type="BeaconDataDef" minOccurs="0"/> 
<xs:element name="rssidata" type="RssiDataDef" minOccurs="0"/> 
<xs:element name="logindata" type="LoginDataDef" minOccurs="0"/> 
<xs:element name="persondata" type="PersonDataDef" minOccurs="0"/> 
<xs:element name="senderdata" type="PersonDataDef" minOccurs="0"/>
</xs:sequence> 
</xs:complexType>
 SystemDataDef