Support · Getting Started

Getting Started with LISBridge

From download to your first result in your HIS — this guide covers everything. Most labs are fully connected within 30 minutes.

Windows · macOS · LinuxRS-232 & TCP/IPASTM E1394 · HL7 v2.x7-day free trial
On this page▾
Quick Start

Five steps to your first result

This is the complete path from zero to results flowing into your HIS. Each step is covered in detail further down this page.

1

Download & install

Go to the download page or your dashboard and download the LISBridge installer for your operating system (Windows .msi, macOS .dmg, Linux .deb / .AppImage). Run the installer and launch the app.
2

Set up the database

On first launch, LISBridge will prompt you to configure the database. Choose SQLite (the default — no additional setup needed) and click Initialize SQLite Database. The database file is created in the application directory.
3

Create your account

If you don't have an account yet, create one for free. A 7-day trial subscription is created automatically — no credit card required. Then sign in at lisbridge.com/login in your browser.
4

Register & bind this device

In the app, go to Settings → License and click Register This Device. This opens your browser. Then in your web dashboard, go to Subscriptions → Manage → Bind Device, select this device, and click Open in LISBridge App. The license activates automatically.
5

Connect your instrument & forward results

Open Serial Port (RS-232) or TCP (network) from the left sidebar, configure the connection settings, and click Connect. To forward parsed results to your HIS or ERP, go to Settings → Connection and enter your endpoint URL.
Requirements

System requirements

🪟

Windows

Windows 10 or later (64-bit)

.msi · .exe
🍎

macOS

macOS 11 Big Sur or later

.dmg
🐧

Linux

Ubuntu 20.04+ / Debian 11+

.deb · .AppImage
Note: LISBridge is built with Tauri (Rust + WebView2). On Windows, WebView2 is included in the installer. No additional runtime or framework installation required.
Download & Install

Download & install

The latest version of LISBridge is always available from your dashboard. After downloading, the installer walks you through the standard OS installation flow.

Where to download

📥

Dashboard → Downloads

Log in at lisbridge.com/dashboard and click Download for your OS.

🔄

Auto-update on launch

LISBridge checks for new versions each time it launches. Update prompts appear in the app — no manual re-download needed.

Important: On macOS, you may see a Gatekeeper warning on first launch. Right-click the app icon and choose Open to bypass it, then click Open again in the dialog.
Database Setup

Set up your database

On first launch, LISBridge will display a Database Configuration Required prompt. You must configure the database before the app can store connection data, parsed results, or settings.

SQLite — Recommended for most users

Default

A lightweight, file-based database that requires no additional setup. The database file (sqlite3.db) is stored in the application directory alongside the app.

To set up SQLite:
  1. Leave the Database Type dropdown set to SQLite (File-based)
  2. Click Initialize SQLite Database
  3. Wait for the confirmation — the status changes to "SQLite Database Configured"

MySQL or PostgreSQL — For enterprise deployments

If your organisation requires a shared or managed database, select MySQL or PostgreSQL from the dropdown, enter your connection details (host, port, database name, username, password), and click Test Connection before saving.

Note: Once the database is configured, you will not be prompted again. If you ever need to switch databases, go to Settings → Database and click Reset Configuration.
License Activation

Activate your license

LISBridge uses device-based licensing. Each device is registered to your account and bound to a subscription — no manual key entry required. Follow these steps after setting up the database.

1

Create an account (or sign in)

Create a free account — a 7-day trial subscription is created automatically, no credit card required. If you already have an account, just sign in at lisbridge.com/login.

2

Register this device from the app

In LISBridge, go to Settings → License and click Register This Device. This opens your browser and registers the current machine to your account.

3

Bind the device to your subscription

In your browser dashboard, go to Subscriptions → Manage → Bind Device. Select this device from the dropdown and click Bind Device.

4

Open in LISBridge App

After binding, click Open in LISBridge App in the browser dialog. The app receives the license and the status changes to Licensed. Setup is complete.

Note: Once activated, the license is cached locally. LISBridge runs fully offline after activation — no internet required for normal operation. To move the license to a new machine, revoke the device from your dashboard first, then repeat the registration steps on the new machine.

License revocation notifications

When an admin revokes a device from the web dashboard, the LISBridge app receives an automatic in-app notification and the license status updates without requiring a restart. Active connections stay open until the session ends, but new connections will be blocked.

To transfer to a new machine: revoke the old device in your dashboard (Subscriptions → Manage → Devices → Revoke), then repeat the 4-step registration on the new machine. The slot is immediately available for re-binding.

Connect an Instrument

Connect an instrument

Use the Serial Port or TCP items in the left sidebar — choose whichever matches how your instrument communicates with the computer.

RS-232 Serial Connection

Most instruments

Used by most haematology and chemistry analysers. Connect the serial cable from your instrument to a COM port on your computer (or USB-to-serial adapter).

COM Port
COM1 – COM99Select from the dropdown — LISBridge lists all available ports
Baud Rate
9600 / 19200 / 38400Check your instrument's manual — 9600 is most common
Data Bits
8Standard for all supported instruments
Stop Bits
1Standard for all supported instruments
Parity
None / Even / OddMost instruments use None
Direction
Unidirectional / BidirectionalBidirectional enables sending orders to the analyzer — required for Order Pull (see Order Pull section below)

TCP/IP Network Connection

Modern instruments

Used by network-capable instruments. The computer and instrument must be on the same network (or accessible via a routed network).

IP Address
e.g. 192.168.1.50The instrument's static IP address
Port
e.g. 5000 / 6001Check your instrument's network settings
Mode
Server / ClientServer = instrument connects to LISBridge. Client = LISBridge connects to instrument
Direction
Unidirectional / BidirectionalBidirectional enables sending orders to the analyzer — required for Order Pull (see Order Pull section below)
Tip: If unsure whether to use Server or Client mode, check your instrument's manual. Most modern analysers are configured to connect to an external server, so LISBridge should be in Server mode.
FTP / SFTP Transport

FTP / FTPS / SFTP file transport

Some instruments do not communicate over a serial cable or TCP socket — they write result files to a shared folder or an FTP/SFTP server instead (e.g. VIDAS KUBE via BCI Connect, and other file-based analysers). LISBridge can connect to that server, poll for new result files on a configurable interval, and process them automatically.

Configuration — Settings → FTP Transport

Protocol
FTP · FTPS · SFTPChoose the protocol your server supports
Host
e.g. 192.168.1.80 or ftp.lab.localIP address or hostname of the FTP/SFTP server
Port
21 (FTP/FTPS) · 22 (SFTP)Default ports — change only if your server is non-standard
Username
e.g. lisbridgeAccount with read permission on the result directory
Password / Key
•••••••Password for FTP/FTPS; private key path for SFTP key-based auth
Remote Directory
e.g. /results or /outboxDirectory where the instrument deposits result files
Poll Interval
e.g. 30sHow often LISBridge checks the directory for new files

FTP

port 21

Plaintext — use only on an isolated local network.

FTPS

port 21 (implicit: 990)

FTP over TLS. Requires the server to have a valid TLS certificate.

SFTP

port 22

SSH file transfer — encrypted and recommended for any remote or cloud-hosted server.

Tip: After saving, click Test Connection to verify LISBridge can reach the server. Then click Poll Now to trigger an immediate check — useful to confirm a new file is picked up before waiting for the next interval.
Note: Processed files are moved to a /processed sub-directory on the remote server so they are not re-ingested on the next poll. Ensure the configured account has write permission on the remote directory.
HIS / LIMS Integration

Send results to your HIS or LIMS

Available on Pro and Enterprise plans. Once configured, LISBridge automatically forwards every parsed result to your Hospital Information System or LIMS via HTTP POST.

Configuration — Settings → Connection

Endpoint URL
https://your-his.example.com/api/resultsYour HIS or ERP POST endpoint
Auth Header
Authorization: Bearer <token>Optional — if your HIS requires authentication

LISBridge sends a JSON payload for each result. The payload includes patient ID, test codes, numeric values, units, reference ranges, and abnormal flags. See the API Reference for the full schema.

Note: Results are stored locally regardless of HIS delivery status. If your HIS is temporarily unreachable, LISBridge queues the result and retries. No data is lost during network interruptions.
Order Pull (HMS)

Receive orders from your HIS (Order Pull)

Instead of your HIS pushing orders to LISBridge (which often fails through NAT and firewalls), Order Pull lets LISBridge poll your HIS on a regular interval to fetch new worklist orders. LISBridge makes the outbound connection — so there is nothing to open in your firewall.

LISBridge Desktop→ polls every N seconds →Your HIS endpoint→ returns pending orders →Sent to analyser

Step 1 — Configure in LISBridge

Go to Settings → HIS/HMS Order Pull (Poll) and fill in three fields:

Endpoint URL
https://his.example.com/api/orders/pollThe polling endpoint on your HIS — must accept POST requests
Auth Header
x-lisbridge-tokenThe HTTP header name your endpoint reads for the token
Auth Token
••••••••••••••••A secret token your endpoint validates — you set this on the HIS side

Step 2 — What your HIS endpoint must do

LISBridge sends a POST to your endpoint on every poll cycle. The request body includes confirmations from the previous batch:

// Request body LISBridge sends each poll
{
  "source":    "LISBridge",
  "device_id": "abc123",
  "ack": [
    {
      "his_order_id": "ORD-2026-001",
      "lis_id":       42,           // internal LISBridge ID
      "status":       "recorded",   // "recorded" | "duplicate" | "rejected"
      "error":        null
    }
  ]
}

Your endpoint validates the token, marks the acknowledged orders as received, and responds with the next batch of pending orders:

// Response your HIS must return
{
  "orders": [
    {
      "his_order_id":      "ORD-2026-002",   // unique, stable ID from your HIS
      "target_instrument": "Sysmex XN-550",  // instrument name
      "priority":          "ROUTINE",        // "ROUTINE" | "URGENT"
      "patient": {
        "id":     "P-10045",
        "name":   "Ahmed Rahman",
        "age":    34,
        "gender": "M"                        // "M" | "F" | "U"
      },
      "tests": ["CBC", "WBC DIFF"]           // test codes or names
    }
  ]
}
Tip: Your endpoint should be idempotent — if LISBridge re-sends an ack for an order already confirmed, ignore it gracefully. Orders with status 'duplicate' in the ack mean LISBridge already has that order in its local DB from a previous poll.
Important: Always validate the auth token on your endpoint. Reject requests with a missing or mismatched token with HTTP 401. LISBridge will log the error and retry on the next poll cycle.
Using LIS Bridge Lab? Your lab dashboard already implements this endpoint — no custom development needed. Go to Settings → LIS Desktop, click Generate Token, and copy the three values (URL, header name, token) directly into LISBridge. See the LIS Bridge Lab setup guide for the step-by-step walkthrough.
Parameter Mapping

Parameter mapping & custom parameters

Raw parameter names from an instrument (e.g. WBC) may not match what your HIS or report expects. Parameter Mapping lets you translate names, set custom reference ranges, and define derived calculations — without touching any instrument settings.

Parameter Mapping param_map

Map a raw instrument parameter name to the alias your HIS/report expects. Also lets you override the reference range for a specific mapping context.

Raw name: WBC
→ Alias: White Blood Cells
→ Unit: ×10⁹/L
→ Range: 4.0 – 11.0

Custom Parameters custom_param

Define a derived parameter using an arithmetic formula, or a constant value. The result is appended to the result set alongside the machine-measured values.

Name: LDL Cholesterol
Formula: CHOL - HDL - (TRIG / 5)
Unit: mmol/L
Range: 0.0 – 3.0

How to configure

1

Open the instrument connection (Serial Port or TCP) and click Parameter Mapping in the top toolbar.

2

In the Mappings tab, click Add Mapping. Enter the raw parameter name (exactly as the instrument sends it), the alias, unit, and optional reference range. Click Save.

3

In the Custom Parameters tab, click Add Parameter. Enter a name, select Formula or Constant, and type the expression. Variable names must match raw instrument parameter names (case-insensitive). The formula editor highlights syntax errors in real time.

4

Click Import to bulk-load mappings from a JSON file — useful when setting up multiple workstations with the same configuration.

Tip: Formula variables are case-insensitive and must match the raw parameter name exactly as the instrument transmits it. If the instrument sends 'wbc', your formula variable should be 'wbc' (or 'WBC' — both work). Test with a live result to confirm the formula resolves correctly.
Note: Custom parameters appear in the result stream alongside machine-measured values and are included in the JSON payload forwarded to your HIS. They are clearly flagged as derived, not measured.
Dashboard

Dashboard overview

Once connected, the main dashboard shows a live panel for each instrument. Here is what each panel displays:

🟢

Connection status

Connected · Disconnected · Error — updates instantly when the instrument state changes.

⏱️

Uptime counter

How long the instrument has been continuously connected in this session.

📋

Live result stream

Every result appears as it arrives — patient ID, test codes, values, units, flags.

📊

WBC / RBC / PLT chart

Time-series graph of haematology results. Useful for spotting QC drift between runs.

📅

Result count today

Total records received from this instrument since midnight.

🕐

Last result timestamp

Time of the most recently received and parsed result.

Note: Result history is stored locally for 30 days by default. You can change this in Settings → Data Retention. Set it to 0 to keep results indefinitely.

Parser auto-updates

Every 15 minutes, LISBridge silently checks for WASM parser updates. If a new version is available (new instrument support, protocol fix, etc.), it downloads and applies in the background. No restart. No notification. Your connections stay active throughout.

Troubleshooting

Troubleshooting

Database configuration fails+
  • For SQLite: ensure the application directory is writable — check folder permissions
  • If the Initialize button does nothing, try quitting and relaunching the app, then try again
  • For MySQL/PostgreSQL: verify the host, port, database name, username, and password are all correct
  • For MySQL/PostgreSQL: ensure the database server is reachable from this machine and the port is open in any firewall
  • If you need to reset a broken database configuration, go to Settings → Database → Reset Configuration
Cannot connect — serial (RS-232)+
  • Check the COM port number in Device Manager (Windows) or /dev/tty* (macOS/Linux)
  • Verify baud rate, data bits, stop bits, and parity match your instrument's manual exactly
  • Ensure the instrument is powered on and the serial cable is securely seated
  • Try a different USB-to-serial adapter if using one — cheap adapters often cause issues
Cannot connect — TCP/IP+
  • Ping the instrument's IP address from the LISBridge computer to confirm network reachability
  • Check that the port number matches the instrument's network settings
  • If using Server mode, ensure no firewall is blocking the port LISBridge is listening on
  • Verify the instrument and LISBridge computer are on the same subnet (or the route is open)
Connected but no data appearing+
  • Run a test sample on the instrument to trigger a data transmission
  • Check the instrument's output/communication settings are enabled in its own menu
  • If the instrument has an 'Auto Send' or 'Host Query' setting, ensure it is enabled
  • Verify the baud rate — a mismatched baud rate connects successfully but produces garbled data
Results not reaching HIS/ERP+
  • Confirm the endpoint URL in Settings → Connection is correct and reachable from this machine
  • Test the URL in a browser or with curl — it should return a response
  • Check your plan supports HIS forwarding (Pro or Enterprise required)
  • Review the delivery log in the app for specific HTTP error codes
  • If an endpoint fails repeatedly, LISBridge enters a per-node reachability cooldown and pauses retries temporarily. The delivery log shows 'cooling down' alongside the endpoint. Wait for the cooldown to expire or manually clear it from Settings → Connection → Reset Cooldown.
Cannot connect — FTP / SFTP+
  • Confirm the host and port are correct — FTP/FTPS defaults to 21, SFTP defaults to 22. A wrong port produces a connection refused error, not a timeout
  • Test the credentials: log in manually using a desktop FTP client (FileZilla, Cyberduck) with the same host, port, username, and password you entered in LISBridge
  • For SFTP with key-based auth, verify the private key file path is correct and the file is readable by LISBridge. The matching public key must be in the server's authorized_keys
  • If using FTPS (FTP over TLS), ensure the server certificate is valid and trusted. Self-signed certificates may need to be added to the trust store
  • Check that the remote directory exists and the configured account has both read AND write permission on it — LISBridge moves processed files to a /processed sub-directory
  • For active-mode FTP, the server connects back to LISBridge on a random port — ensure your firewall allows inbound connections or switch to passive mode on the server
  • Click Poll Now in LISBridge after connecting to trigger an immediate check without waiting for the configured interval
No orders being pulled from HIS (Order Pull)+
  • Verify Settings → HIS/HMS Order Pull is enabled and the Endpoint URL is correct
  • Confirm the auth token in LISBridge matches what your HIS endpoint expects — mismatched tokens return HTTP 401 (check the pull log)
  • Test the endpoint manually: send a POST with an empty ack array and confirm your HIS returns a valid JSON response with an 'orders' array
  • If using LIS Bridge Lab: go to Settings → LIS Desktop, confirm a token has been generated, and that the same token is pasted into LISBridge
  • Check that at least one machine has Two Way Communication enabled in the lab dashboard — orders are only served for machines with that flag set
Cannot activate license / device not binding+
  • Ensure you are signed in to lisbridge.com in your browser before clicking Register This Device
  • After clicking Register This Device, complete the registration in the browser window that opens — do not close it early
  • In your dashboard, make sure you have an active subscription before trying to bind a device
  • After clicking Bind Device, click Open in LISBridge App — the license is sent to the app through this step
  • If the device does not appear in the bind dropdown, click Refresh Status in the app's License tab and try again
  • If the device was previously revoked or bound to another subscription, revoke it from the dashboard first
  • Contact support if the device registers but the license status stays Inactive after binding
Instrument not connecting+
  • Check the supported instruments list and ensure the correct protocol settings are configured for your model
  • If your instrument is not in the list, contact support — new instruments are added via WASM parser updates
Support

Get help

If this guide doesn't resolve your issue, our support team is here.

📧

Email support

Available on all plans. Typical response within 1 business day.

Send a message →
⭐

Priority support

Pro plan — faster response times, dedicated queue.

Contact us →
🚀

Dedicated support

Enterprise plan — direct line, same-day response, onboarding assistance.

Talk to us →

Instrument not supported?

Let us know your instrument make and model. We add new instrument parsers via WASM updates — no new version download required on your end.

Request instrument support →