> ## Documentation Index
> Fetch the complete documentation index at: https://docs.healos.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# HL7 feeds

> Connect a hospital or EHR interface engine to HealOS over HL7 v2: what your team does and what HealOS does

HealOS accepts **inbound HL7 v2 feeds** from hospital and EHR interface engines (for example MEDITECH, or an engine such as Mirth, Corepoint, Cloverleaf or Rhapsody). The feed keeps HealOS's patients, appointments and results current, so AI Scribe starts each visit with the patient's recent labs, imaging and documents.

> [!NOTE]
>
> HL7 is **inbound only**. HealOS does not send notes or results back over HL7. Finished notes reach the chart through the EHR's own connection or the [Chrome extension](https://docs.healos.ai/guides/scribe/chrome-extension.md).

## What HealOS does with each message

| Message | HealOS does | Key fields |
| - | - | - |
| **ADT** (admit, register, update) | Creates or updates the patient | PID-3 MRN (the match key), PID-5 name, PID-7 date of birth, PID-8 sex, PID-13 phone |
| **SIU** (scheduling) | Updates the patient, then creates or updates the appointment and assigns it to the HealOS user mapped to the provider | SCH-1 appointment id (else PV1-19), SCH-11 start, SCH-9 duration (default 30 min), SCH-7 type, SCH-25 status, AIP-3 provider |
| **ORM** (orders) | Creates or updates the patient | PID segment |
| **ORU** (results) | Stores the report and its observations, grouped as lab, microbiology, blood bank, pathology, radiology or provider document | OBR, OBX-3/5/6/7/8/14, NTE |
| Anything else | Kept, not processed. Ask HealOS if you need another message type | MSH-9 |

Patients are matched within your organization by MRN, so the same MRN from your feed always updates the same HealOS patient.

**In AI Scribe**, recent results appear as visit context, grouped as Recent Labs, Imaging, Pathology, Microbiology, Blood Bank and Provider Documents. By default HealOS uses the last 90 days, up to 30 reports; HealOS can tune this for your organization.

## How the feed reaches HealOS

| Option | Use it when | Your side | HealOS side |
| - | - | - | - |
| **A. HTTPS from your interface engine** (recommended) | Your engine can send HTTPS with OAuth 2.0 | Point an outbound channel at the endpoint HealOS gives you, using the service credentials HealOS issues | A dedicated, per-customer HL7 store and delivery pipeline; issues the credentials |
| **B. MLLP over a site-to-site VPN** | Your system speaks only MLLP over TCP, or policy requires IPsec | An IPsec VPN tunnel to HealOS, and an MLLP channel through it | The VPN endpoint, the MLLP listener and the same per-customer pipeline |

Your system gets the HL7 acknowledgement from the receiving endpoint. HealOS processes each message after it arrives: a temporary failure is retried automatically, and a message that still fails is set aside for review instead of being lost.

## Who does what

| Step | Your IT / interface team | HealOS |
| - | - | - |
| 1. Scope | Tell us what sends the feed (MEDITECH directly or an interface engine), whether it can send HTTPS, whether IPsec is required, and which message types | Recommends option A or B and confirms which messages HealOS will use |
| 2. Provision | For option B: VPN details your network team needs to exchange | Creates your dedicated HL7 store and pipeline for test and production, and sends you a **tenant code** |
| 3. Bind | An organization admin opens **Integrations → Connect HL7 Feed** in HealOS and pastes the tenant code | Links the feed to your organization. Messages are not processed until the feed is active and linked |
| 4. Test | Send test messages with **test patients only**: one ADT, one SIU and one ORU | Confirms the patient, appointment and results appear correctly; maps your providers (AIP-3) to HealOS users |
| 5. Go live | Switch the channel to production | Watches the first days of traffic with you |

## Monitoring and support

* HealOS tracks when it last received each message type. If the feed goes quiet, HealOS shares the last-received time per message type with your interface team, which is usually the fastest way to find a stopped channel.
* Messages that fail processing are kept and reviewed; send corrected messages again as usual.
* To add a message type (for example pharmacy), contact HealOS: each new type needs a handler before it is used.

## Security

* Option A uses TLS with OAuth service credentials; option B carries MLLP inside an IPsec tunnel.
* Each customer has its own HL7 store and pipeline; HealOS accepts messages only from your configured feed and links them only to your organization.
* Use test patients for all testing; HL7 messages contain PHI.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.