Interface Server
The Interface Server moves clinical messages — principally HL7 v2 — between systems. Where
an integration is something you build step by step, an interface is a standing route: it watches
a source, and every message that arrives is processed and delivered to one or more destinations,
continuously, without anyone starting a run.
Use it for the traffic that never stops — an ADT feed, inbound orders, results returning from a
lab.
The objects
| Object | What it is |
|---|---|
| Interface | A route: one source, one or more destinations, and the handling in between |
| Message | A message that arrived at an interface, with a record of what happened at each destination |
| Instance | The engine process that runs interfaces. Each interface is assigned to one |
You select which instance an interface runs on, but instances themselves are provisioned and
managed by Intely. If you need another one, or need to know which you are on, ask your account
manager.
How a message travels
- A message arrives at the interface's source — a file appears in a watched directory, or
a message is received over a network connection. - It is parsed and validated according to the interface's message format and version.
- It is delivered to each enabled destination.
- The outcome is recorded against the message, per destination, and the source file is moved or
removed according to the interface's post-processing rule.
A message that fails at one destination and succeeds at another is recorded as exactly that —
the per-destination detail is why the message record is worth reading rather than just the
counts.
Where to look
| Page | Use it for |
|---|---|
| Interfaces | Configuration, and the running totals per interface |
| Messages | An individual message and what happened to it |
| Logs | Why something failed at the engine level |
Interfaces are not App Interfaces
The platform uses the word interface in two unrelated ways, which is worth pinning down:
- An App Interface (under Connectors) describes how to talk to an external application —
an Epic FHIR interface, for example. See App Interfaces. - An Interface Server interface is an HL7 message route, described here.
They are different objects with different screens. If you are configuring credentials against a
vendor API, you want App Interfaces.
Updated about 6 hours ago