Linkiir Documentation
Linkiir is a healthcare integration platform for designing, testing, deploying, and monitoring interfaces across HL7 v2, X12, APIs, files, and other healthcare data formats.
New to Linkiir?
Getting Started takes you from a downloaded package to a working HTTP endpoint in four steps:
- Download and install — macOS Docker bundle, Windows installer, or Linux.
- Reset the admin user — set the administrator password.
- Create a project, workflow, and HTTP source node.
- Edit the script and start the HTTP server — then call it with
curl.
About 20 minutes on a local machine.
Documentation areas
Getting StartedInstall Linkiir and build your first interface.Interface DevelopmentNode types and their fields, Lua scripting, sample interfaces, error handling.AdministrationLicensing, upgrades, deployment environments, configuration, backups, security, troubleshooting.FAQQueue and database choices, and day-to-day operating practice.
Common tasks
| I want to | Go to |
|---|---|
| Install on Windows | Install on Windows |
| Install on macOS | Install on macOS |
| Recover a lost administrator password | Reset the Admin User |
| Receive HL7 v2 over MLLP | Source Nodes |
| Look up a Lua function | Linkiir Scripting API |
| Test a script before starting a node | Testing and Debugging Lua |
| Copy a complete working interface | Sample Code |
| Connect my own Kafka or Redpanda cluster | Kafka and Redpanda Configuration |
| Find out why messages are not arriving | Troubleshooting |
| Move a project between environments | Project Import and Export |
:::info Documentation status Licensing and Notifications content is marked where commercial policy or feature availability is not yet finalized. Confirm against the release notes for your version. :::