1. Teleboard | Support Center
  2. Solution home
  3. Apps and Integrations
  4. Apps and Integrations User guides
Open navigation

HHAeXchange Integration

The HHAeXchange integration features VoIP calling capabilities and a call notification window that displays patient-relevant details by cross-referencing his phone number with the HHAeXchange database. This is a great time saver allowing you to instantly identify the caller and offer a more personal service. 

Before you can use the integration you need to have HHAeXchange set you up with an app key. The cost of the app key is negotiated between you and HHAeXchange. If you are not an existing Telebroad user, you will also have to contact us to set you up with a TeleConsole account.

Once you receive the app key details you can proceed to install and set up the integration (see next).

Installation and Removal 

The Integration Manager and Security Software

The integration runs from the Telebroad's Integration Manager – a launcher and a settings control point for several of Telebroad's Windows apps and integrations.

The integration Manager only runs on Windows computers! Mobile devices and other operating systems are not supported.

  The installation runs two executable files that may trigger your antivirus or firewall software and interfere with the installation process. Either mark the installation as safe when prompted by your security software or, if this doesn't work, disable the relevant security software temporarily just for the duration of the installation.

Installing the Integration Manager

If you have previously installed Telebroad's Web URL, Microsoft Outlook Integration, or Directory Calling then the Integration Manager is already installed on your PC and you can proceed to sign in to the Integration Manager and set up the app Key.

Otherwise, follow these steps to install Telebroad's Integration Manager:

  • Download the integration's initial setup file by either:

    • Copying (or clicking) this link to your web browser - http://integrate.telebroad.com/Publish/setup.exe.

    • Click App Market on Telebroad's home page.

      If  your browser's window is scaled down, access Apps Marketplace from the side menu instead.

      Scroll down to the "Apps and integrations for your daily needs" section, click the HHA EXCHANGE button, and click GET IT NOW.

  • Click the installer's setup.exe file once it downloads to run it or locate it in the relevant download folder and double-click it. 

  • Depending on your version of Windows, you may see one or several notifications about the application trying to make changes to your device or that ".... this file type can potentially harm your computer...".

    These are normal and appear with most software installations. Just click Allow or Run when prompted by the notification.

  • The installer will download a Microsoft .Net Framework component (if not already installed on your computer) and the main file of the Integration Manager. Once downloaded it will ask you for permission to Install itself. 

  • Once the installation is complete the Integration Manager will run itself or you can launch it from the Telebroad folder under the Windows start menu.

Uninstalling the Integration Manager

There is a setting in HHAeXchange integration that allows you to disable it (see below). 

Still, if you need to remove the HHAeXchange integration for any reason, you will need to uninstall the entire Integration manager.

To do so, depending on your Windows version, launch either the Control Panel or Settings.

  • On Windows 10/11 you need to access the Settings screen and select Apps.

    Select Apps & features and scroll down to find "Telebroad Integration Manager".

    Click it and select Uninstall. Approve the uninstall request when prompted.

  • On Windows 8.1 and earlier versions you need to access the Control Panel screen and select Programs>Remove a program installation.

    Scroll down to find and check "Telebroad Integration Manager". Click Uninstall/Change at the top of the programs list and approve the uninstall request.

Telebroad Account Sign In and Password Reset

Once you have installed and launched the Telebroad Integration Manager you need to sign in to your Telebroad account. Enter your credentials in the User Name and Password fields and click the SIGN IN button.

If your credentials are not accepted, you can click the Forgot your password? link. A web page will open where you can recover your user name or reset your password for your TeleConsole account. You will need to provide your email address to where instructions and reset code will be delivered to. See more information here.

Resetting your password will log you out from all TeleConsole clients or Telebroad integrations!

Before doing a password reset remember that your password is case sensitive (your user name is not) so you may want to try reentering it with consideration to letter case!

Allowing Access Through the Firewall

If you are unable to make calls it might be that your firewall is blocking the certain SIP components.

To resolve this you need to allow the Integration Manager access through the firewall.

This article provides step-by-step instructions on how to do so. 

You just need to make sure to find and select "Integration Manager" (instead of "TeleConsole) in the list of "Allowed apps and features".

HHAeXchange App Key and Integration Setup

The Integration Manager screen displays all supported integrations. Click the HHAeXchange box to show the HHAeXchange setup screen. 

Follow these steps to set up the HHAeXchange integration:

  • Exchange App Key: Copy and paste the app key you received from HHAeXchange in this field. 

  • Select patient info to show up in the call notification: Use this drop-down menu to select and customize the information displayed in the notification window that appears when a patient calls you. Click next to any already selected field to remove it from the notification window.

  • Open Patient URL: This determines the patient file that will open in the HHAeXchange when you click the Open Patient button in the information window.

    For this to work copy and paste this URL to the field  https://app.hhaexchange.com/ ENT2002010000/Patient/ InternalPatientInfo.aspx? Patientid={patient_id}.

    Click Set for all users to apply the URL to all other users using the integration on your computer. If the URL changes due to updates we will send you a new one to replace it.

  • Open Caregiver URL: This determines the caregiver file that will open in the HHAeXchange when you click the Open Patient button in the information window.

    For this to work copy and paste this URL to the field  https://app.hhaexchange.com/ ENT2002010000/Aide/Aide.aspx? AideId={caregiver_id}.

    Click Set for all users to apply the URL to all other users using the integration on your computer. If the URL changes due to updates we will send you a new one to replace it.

  • Web browser: Use this drop-down menu to select or change the web browser where the patient and caregiver files (as specified in the above fields) will open.

  • Enable / Disable Integration: You need to toggle this on to start using the integration. Once you do so, after setting up all of the above, a green bell icon () will appear in the HHAeXchange box of Integration Manager's main screen to indicate it is active.

    You can toggle the integration off when you prefer not to see call notifications. 

      To prevent conflicting notifications, note that enabling the Outlook Integration will automatically disable the HHAeXchange integration and vice versa!

  • Click Save to save the settings and start using the integration.

Integration Manager General Settings 

In addition to the specific HHAeXchange settings you can click     on the main Integration Manager screen to access general settings for all integrations:

  • Select Phone Line: If your Telebroad account has more than one phone line this drop-down menu lets you select the one you prefer to use. 

  • Notification Settings

    When making or receiving calls, a notification window will show up by default. It shows the caller's information and (if activated) a list of recent calls. If you disable this window you will only get an option to answer/hang-up calls.

    • Close popup on call complete: When checked, the notification window will automatically close when a call is hung by either you or the caller. 

    • Disable notification popup: Self-explanatory. Basically when checked the notification window will not show up.  

    • Show notification popup also for outgoing calls: The notification window is most helpful for inbound calling but you can check this box to have it also display for outgoing calls. This is useful for keeping the patient's main details on the screen even if you switch away to other programs.

    • Show incoming call popup only after call is answered: When activated you will only see the answer button for incoming calls. The notification window will show only after you click this button.

    • Close popup after 30 seconds: Self-explanatory. When activated, the notification window will automatically close after 30 seconds from the time it appears on the screen.

  • App Settings 

    • Do not auto answer for outgoing calls: When dialing an outgoing call the Telebroad server will first dial the recipient and then connect the call to you. Because you initiate the call it will be answered automatically on your side, but if this box is checked you will get the option to click the answer button to pick it up. 

    • Start on system startup: Check this box to have the Integration Manager launch automatically whenever your computer starts up.

    • Show recent Calls: When checked, the recent calls option will be available in the notification window showing the last three recent calls (either received or dialed).
Using the Integration and the Notification Window

Once you have entered your app key and modified any other settings to your liking the integration will run in the background.

When you receive a call from a patient (or when you make an outgoing call if you enabled the setting for it) the pop-up notification window will appear on the screen no matter what program you are using.

The CALLER NAME field displays the caller ID of the caller as provided to Telebroad by a Caller Name Service (CNAM) database. His phone number will be shown if his name is not available.

The information displayed in the Patient Name field is pulled from the HHAeXchange database by cross-referencing the caller ID. The cross-referencing also shows the patient's Phone numbers (as listed in his file), the name of his coordinators, or any other field you selected to show.

Click Open Patient to open the patient's full records in the HHAeXchange platform. 

Click to pick up the call or to hang it up.

After you have answered a call you can toggle the Recent calls switch () to show the three most recent dialed or received calls from the caller.

Click   to copy the caller's telephone number to the clipborad. You can paste it to a new patient file if the caller is not an existing patient.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons

Feedback sent

We appreciate your effort and will try to fix the article