Healthcare Listener

The Healthcare Listener is a service that receives ADT messages from a healthcare management system and allows traffic to pass securely from the healthcare management system to Jamf Pro. When the Healthcare Listener receives an ADT message, Jamf Pro interprets the message to automatically send remote commands to mobile devices based on rules you configure. (For more information about the communication process of the Healthcare Listener, see the Healthcare Listener Communication Knowledge Base article.)

For example, you could configure a rule so that when the Healthcare Listener receives a "Patient Discharge" ADT message, Jamf Pro sends a Wipe Device command to the device assigned to the patient room.

When you configure the Healthcare Listener, you must do the following:

  • Specify IP addresses or a range of IP addresses to accept incoming messages from
    Note: The Healthcare Listener is compatible with IPv4 and IPv6 connection methods.

  • Specify a port number
    Note: The default port value is 8080. This should be changed to the port number that the Healthcare Listener uses to receive healthcare management system communications.

  • Add rules by configuring settings that enable Jamf Pro to send commands to devices (For more information, see Healthcare Listener Rules.)
    You can also enable email notifications in the event that a command is not sent.

In addition, email notifications can be sent from Jamf Pro when a remote command fails to send or remains in a pending state. (For more information, see Notifications.)

The Healthcare Listener is hosted by the Jamf Infrastructure Manager, a service that is managed by Jamf Pro. After you install an instance of the Infrastructure Manager, Jamf Pro allows you to enable the Healthcare Listener. For more information, see Jamf Infrastructure Manager Instances.

Healthcare Listener Rules

Configuring a rule enables Jamf Pro to send remote commands to devices when the Healthcare Listener receives an ADT message. If you want to send more than one type of command or use more than one type of ADT message, you must configure a separate rule for each. You can configure as many rules as your organization requires.

The following table provides an overview of the settings you must configure for each rule:

Setting

Description

Operating System

This setting allows you to apply the rule to either iOS devices or tvOS devices. For example, you can choose to wipe only the tvOS devices in your environment.

Note: For tvOS, the Wipe Device remote command is the only option available.

Remote Command

This setting allows you to specify which command you want sent from Jamf Pro when the Healthcare Listener receives an ADT message. You can choose from the following commands:

  • Wipe Device
    Note: If a mobile device has Activation Lock enabled, the Activation Lock is cleared when the device is wiped.

  • Lock Device

  • Clear Passcode

  • Enable Lost Mode
    Choosing Enable Lost Mode requires you to configure custom messaging.

  • Disable Lost Mode

For more information, see Remote Commands for Mobile Devices.

ADT Message

For Jamf Pro to send commands to devices, the Healthcare Listener must receive an ADT message. You can choose from the following ADT message types:

  • Admit/Visit Notification (ADT-A01)

  • Patient Transfer (ADT-A02)

  • Patient Discharge (ADT-A03)

  • Cancel Admit/Visit Notification (ADT-A11)

  • Cancel Transfer (ADT-A12)

  • Cancel Discharge/End Visit (ADT-A13)

Mapping Fields

ADT messages contain multiple fields of information that the Healthcare Listener can extract. You can choose which ADT message field to extract, and then map that field to an attribute from user and location information in device inventory. For example, you can choose the field that returns "bed number" and map that field to the "Room" attribute in a device's inventory information. The command you specify is then sent to devices that match the inventory attribute you select.

You can choose from the following ADT message fields:

  • Patient Visit - Person Location - Bed (PV1-3-3)

  • Patient Visit - Prior Person Location - Bed (PV1-3-6)

In addition, you can use an alternative field from the ADT message.

You can also create an extension attribute for a specific inventory attribute that fits your environment. After you create the extension attribute, it is available as an option. (For more information about creating an extension attribute for a mobile device, see Mobile Device Extension Attributes.)

Email Notifications (Optional)

Email notifications can be sent from Jamf Pro to specified users for the following events:

  • A command fails to send or is in a pending state after a specified amount of time.

  • A command is sent to a device that does not meet the requirements for the command. (For more information about mobile device remote command requirements, see Remote Commands for Mobile Devices.)

To enable email notifications, you need an SMTP server set up in Jamf Pro. (For more information, see Integrating with an SMTP Server.)

Requirements

To configure the Healthcare Listener and take full advantage of its latest features and enhancements, you must install the latest version of the Jamf Infrastructure Manager. (For more information, see the Jamf Infrastructure Manager Installation Guide.)
Note: To install the latest version of the Jamf Infrastructure Manager that hosts the Healthcare Listener, contact your Jamf account representative.

In addition, you need to ensure that your healthcare management system is compliant with Health Level Seven (HL7) messaging and that it communicates the version of HL7 protocol. For more information about HL7 messaging, see www.hl7.org.

Setting up the Healthcare Listener

  1. Log in to Jamf Pro.

  2. In the top-right corner of the page, click Settings images/download/thumbnails/16442457/Icon_Settings_Hover.png .

  3. Click Server Infrastructure.

  4. Click Infrastructure Manager Instances images/download/thumbnails/12985605/InfrastructureManager.png .
    A list of Infrastructure Manager instances is displayed along with the services that are installed on each instance.

  5. Click the Infrastructure Manager instance with the Healthcare Listener that you want to configure.

  6. Click Edit.

  7. Select the Enable Healthcare Listener checkbox.

  8. Enter a display name for the Healthcare Listener.
    This is the name that is displayed for the Healthcare Listener on the Infrastructure Manager. (For more information about viewing the services that are installed on an Infrastructure Manager instance, see Jamf Infrastructure Manager Instances.)

  9. To specify the IP addresses to accept incoming ADT messages from, do one of the following:

    • Select All IP addresses to accept incoming messages from any IP address.

    • Select Single IP address or Range of IP addresses to specify the IP addresses to accept incoming ADT messages from, and do the following:

      1. To specify a single IP address, click the (+) Add button for Single, and enter the IP address.

      2. To specify a range of IP addresses, click the (+) Add button for Range, and enter the starting and ending IP addresses.

  10. Enter the port number of your healthcare management system.

  11. Click Save.

After the Healthcare Listener is set up, you can add rules. Adding a rule enables Jamf Pro to send remote commands to devices.

Adding a Healthcare Listener Rule

  1. Log in to Jamf Pro.

  2. In the top-right corner of the page, click Settings images/download/thumbnails/16442457/Icon_Settings_Hover.png .

  3. Click Server Infrastructure.

  4. Click Infrastructure Manager Instances images/download/thumbnails/16442457/InfrastructureManager.png .
    A list of Infrastructure Manager instances is displayed along with the services that are installed on each instance.

  5. Click the Infrastructure Manager instance with the Healthcare Listener that you want to add a rule to.

  6. Click Edit, and then click the Add (+) button.

  7. Select the operating system you want to apply the rule to.

  8. Choose the remote command you want Jamf Pro to send to devices when the Healthcare Listener receives an ADT message.

  9. Choose which ADT message the Healthcare Listener can receive.

  10. Use the Field Mapping options to map a field from the ADT message to an attribute of inventory information.
    If you want to use an alternative field from the ADT message, choose "Other" from the ADT Message Field pop-up menu, and then type the field.

  11. (Optional) To enable email notifications, click the Notifications tab, and do the following:

    1. Select the events that you want to send an email notification for.

    2. Enter an email address or multiple email addresses separated by a line break or a comma.

    3. Use the Email Delay pop-up menu to choose how many minutes to wait when a command is pending before sending an email to specified email addresses.

  12. Click Save.

When the Healthcare Listener receives an ADT command, Jamf Pro sends the specified command to devices that are mapped to the field in the ADT message.

Further Considerations

  • If you edit or delete a rule that has a remote command in a pending state, the pending command is still sent to devices regardless of editing or deleting the rule.

  • If the Healthcare Listener cannot communicate with Jamf Pro (e.g., during a Jamf Pro upgrade), any ADT messages that the Healthcare Listener receives during that time are saved and then processed once communication is re-established.

Related Information

Copyright | Privacy | Terms of Use | Security
© copyright 2002-2017 Jamf. All rights reserved.