We're here to help.

Butterfly Link Installation Guide

Introduction

This guide is an overview of how to install the Butterfly Link software and is intended as a reference for administrators. The Butterfly Cloud application is a Windows software application installed on a server or workstation machine that securely connects a medical facility’s DICOM and/or HL7 end-points to Butterfly CloudButterfly CloudButterfly Link communicates with DICOM devices (PACS, Ultrasound modalities, and Modality Worklists) to send and receive medical image data across the network. The software can also send and receive HL7 data between Butterfly Cloud and the facility’s EMR or interface engine(s). Butterfly Link communicates via an outbound, encrypted WebSocket connection to Butterfly Cloud and uses this connection for bi-directional data flow.

Butterfly_Link_On_Premise_Client_-_White.png
 

Frequently Asked Questions (FAQ's)

How does Butterfly Link work?

Butterfly Link is a 64-bit Windows executable that runs in the background as a Windows Service. The software has a very small installation footprint and all options are configured from Butterfly Cloud. It has no interface installed on the machine and doesn't store any Protected Health Information (PHI) data locally.

Butterfly Link makes an encrypted outbound WebSocket connection to Butterfly Cloud and this connection is used for bi-directional data flow. The connection is secured with two layers of protection:

  • A hospital specific security code is validated against Butterfly records at the beginning of every session.

  • TLS 1.2 Encryption.

Do we need a dedicated server for Butterfly Link?

No, a dedicated server is not required. The software will run in the background on a current application server as long as it meets the minimum specifications.

Can the software run in a VM environment?

Yes, Butterfly Link can run on a VM as long as the server stays on, meets specifications, and has a static IP address.

Do we need to do any special backups of the software?

No, Butterfly Link does not store any data on the machine and the configuration is stored in Butterfly Cloud. If the computer hosting the software fails, then recovery can be quickly accomplished with a reinstall and the configuration will be automatically reapplied from Butterfly Cloud.

Is there a requirement for a server to be in the DMZ?

No.

What encryption do you use to transfer data to/from Butterfly Cloud?

TLS 1.2 is used for all data transfers between Butterfly Link and Butterfly Cloud.

What are the network requirements?

The server hosting Butterfly Link needs to be able to communicate with your internal  DICOM and HL7 endpoints via TCP. Outbound HTTPS access must also be permitted to Butterfly Cloud as per the System Requirements.

 

System Requirements

Installers should confirm that they have access to Butterfly Cloud with Administrator permissions before initiating a Butterfly Link installation.

  • The installer requires local administrator rights to install software on the device due to Windows UAC, and the need for the installer to register the service.

  • The hosting server has a static or reserved IP address on the local area network.

  • The hosting server can access the Internet.

Hosting Server Minimum Requirements

  • Computer or virtual machine running Windows Server 2016 or later (64-bit)

  • 2 vCPU

  • 4 GB of RAM

  • 10 GB of free disk space

  • Network access to LAN on which hospital services are accessible (i.e. EMR, PACS, MWL, 3rd party Ultrasound machines)

 

Installation Instructions

 

Get the software

  • Log-in to Butterfly Cloud (cloud.butterflynetwork.com) using your Browser. Ensure that your user role in Butterfly Cloud is that of Administrator.

  • Navigate to the Connections menu by clicking your username in the upper right of the window and selecting Organization Settings.

    Org_Settings.png
  • Select the Connectivity tab and click the ‘+ Add’ option in the Connections section; then select ‘Butterfly Link’ to create a new Butterfly Link connection.

    Connectivity.png
  • Download the Butterfly Link installer to your hosting Windows computer.

  • Ensure that you copy the secret installation key - it will be needed for the software installation.

  • Give the Butterfly Link connection a friendly name.  Click ‘Save Butterfly Link’.

    Download.png
  • You should see confirmation of your Butterfly Link connection.

  • If you need to change the name or remove the Butterfly Link connection, select the Edit option.

 

Install the Software

  • Run the ‘butterfly-link-installer.exe’ file that you downloaded from Butterfly Cloud.

  • Input the Secret key that was provided during the Butterfly Link Connection creation step.  Click ‘Install’.

    • The installation path is - C:\Program Files\Butterfly Link\

      Configuration.png
  • Close the Installation window upon completion.

 

Verify Butterfly Link Service

  • Run the Windows Services Management application.

  • Locate the Butterfly Link service and verify that its status is ‘Running’.

    Verify.png
  • You may edit the Log on As account as needed - see Recommended Configuration in this Guide.

 

Integration Configuration

You are now able to create the appropriate DICOM or HL7 integrations to your internal systems by associating them with the newly established Butterfly Link connection. Multiple DICOM or HL7 integrations can be associated with the same Butterfly Link connection and use the connection simultaneously.

 

DICOM: PACS/VNA or Modality Worklist Integrations

  • The Integrations menu is located on the Connections tab, immediately below the Connections section.

  • Click the ‘+ Add’ option next to Integrations and select PACS/VNA or MWL to create a new DICOM Storage or Modality Worklist connection.

    PACS_VNA.png
  • Enter a friendly name for the DICOM end-point that you are adding. For the Connection Type - select the previously created Butterfly Link Connection.

    Add_PACS.png
  • A DICOM configuration screen will display after you have selected the Connection Type.

  • Proceed to enter all of the necessary DICOM connection parameters.

    • Note that the IP address must correspond to the DICOM end-point that is accessible from the computer hosting the Butterfly Link software.

    • If Hostname is used then it must be resolvable by the computer hosting Butterfly Link. Click Save when complete.

Combined_Image.png

Sample DICOM PACS/VNA/Worklist configuration screens.

Note

  • If your PACS/VNA is not operating in promiscuous mode, then you will need to add the Butterfly Cloud AE title as an approved DICOM source.

  • Please be aware that the PACS will see the IP of the server hosting Butterfly Link as the source of DICOM data from Butterfly Cloud.

 

HL7: EHR Integrations

  • The Integrations menu is located on the Connections tab, immediately below the Connections section.

  • Click the ‘+ Add’ option next to Integrations and select EHR to create a new HL7 connection.

    EHR.png
  • Enter a friendly name for the HL7 end-point that you are adding. For the Connection Type - select the previously created Butterfly Link Connection.

    EHR_Config.png
  • An HL7 destination configuration screen will display after you have selected the Connection Type.

  • Proceed to enter all of the necessary HL7 connection parameters.

    • Note that the IP address must correspond to the HL7 end-point that is accessible from the computer hosting the Butterfly Link software.

    • If Hostname is used then it must be resolvable by the computer hosting Butterfly Link. Click Save when complete.

Save_EMR_Connection.png

Sample HL7 Destination configuration screen.

 

DICOM Connection Verification and Automatic Forwarding

 

Verify the Connection from Butterfly Cloud

  • The navigate to the Integrations section located under the Connectivity tab, immediately below the Connection section.

    Connertivity_Settings.png
  • Click the ‘...’ next to a DICOM connection. Select the Echo option to perform a DICOM C-ECHO from Butterfly Cloud.

  • Verify the output is similar to below.

    DICOM_Logs.png
  • Congratulations - you have setup a secure connection to your DICOM destination. You may now send image data or query Modality Worklist.

 

(Optional) - Automatic Forwarding to DICOM Storage

  1. To automatically send any studies saved to a Butterfly Cloud folder to your DICOM end-point, you can associate it with an Archive.

  2. Select the Archive folder that you would like to associate with the DICOM connection.  Select Archive Settings.

    Archive_Settings.png
  3. Choose the DICOM Storage location to associate with the Archive folder.

    PACS_Assignment.png
  4. Now any study saved to this folder (using the Butterfly iQ App) will automatically forward to the chosen DICOM destination.

 
 
Was this article helpful?
0 out of 0 found this helpful
Thank you for your feedback

We’re sorry this didn’t answer your question. We’re here to help. Contact us