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 running interface in three steps:
- Download and install — macOS Docker bundle, Windows installer, or Linux.
- Reset the admin user — set the administrator password.
- Import a Demo Project — a core-nodes Feature Demo (HL7 over LLP to a SQLite-backed JSON API), or an HL7 v2 to FHIR demo built on the FHIR adapter catalog.
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.AdaptersPrebuilt connectors for EHR, CRM, medical device, cloud storage, messaging, and AI systems.AI AssistantSet up the AI assistant, connect a model provider, and use it to build and diagnose interfaces.AdministrationLicensing, upgrades, deployment environments, configuration, backups, security, troubleshooting.High AvailabilityActive/standby pairs, topologies, system requirements, backup and disaster recovery.FAQQueue and database choices, and day-to-day operating practice.SupportOpen a ticket by email or the support portal, and the 24/7 urgent production support policy.
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 |
| Connect to Epic, Cerner, Salesforce, S3, or Slack | Adapters |
| Turn on the AI assistant | License and enable AI |
| Connect the AI assistant to a model | AI Model Providers |
| Learn what to ask the AI assistant | Prompt Library |
| 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 cluster | Kafka Configuration |
| Understand High Availability and pick a topology | High Availability |
| Find out why messages are not arriving | Troubleshooting |
| Move a project between environments | Project Import and Export |
| Open a support ticket | Standard Support, or the support portal |
| Report a critical production outage | 24/7 Urgent Production Support |
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.