> For the complete documentation index, see [llms.txt](https://docs.digibee.com/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digibee.com/documentation/connectors-and-triggers/connectors/industry-solutions/hl7.md).

# HL7

**HL7** sends information to healthcare systems using the HL7 ([Health Level 7](https://info.hl7.org/orientation-station)) communications protocol, a healthcare industry standard for exchanging data between different systems and medical devices.

## **Parameters**

Configure the connector using the parameters below. Fields that support [Double Braces expressions](/documentation/connectors-and-triggers/double-braces/overview.md) are marked in the **Supports DB** column.

{% tabs %}
{% tab title="General" %}

<table><thead><tr><th width="112">Parameter</th><th width="231">Description</th><th width="83">Data type</th><th width="81">Supports DB</th><th width="100">Default value</th><th width="125">Visible when</th></tr></thead><tbody><tr><td><strong>Host</strong></td><td>HL7 server host.</td><td>String</td><td>❌</td><td><code>hl7.server.com</code></td><td>—</td></tr><tr><td><strong>Port</strong></td><td>HL7 server port. The MLLP (Minimal Lower Layer Protocol) protocol typically runs on port 2575.</td><td>Integer</td><td>❌</td><td><code>2575</code></td><td>—</td></tr><tr><td><strong>Connect Timeout (ms)</strong></td><td>Time limit, in milliseconds, for the platform to connect to the server.</td><td>Integer</td><td>❌</td><td><code>3000</code></td><td>—</td></tr><tr><td><strong>HL7 Message</strong></td><td>Message field that contains the data to send.</td><td>String</td><td>✅</td><td>N/A</td><td>—</td></tr><tr><td><strong>HL7 Message Charset</strong></td><td>Charset used to encode the HL7 message.</td><td>String</td><td>❌</td><td><code>UTF-8</code></td><td>—</td></tr><tr><td><strong>Advanced settings</strong></td><td>When enabled, displays additional configuration options.</td><td>Boolean</td><td>❌</td><td><code>false</code></td><td>—</td></tr><tr><td><strong>Connection Pool</strong></td><td>Number of available connection pools.</td><td>Integer</td><td>❌</td><td><code>10</code></td><td><strong>Advanced Settings</strong> is enabled</td></tr><tr><td><strong>Enable Retries</strong></td><td>When enabled, allows retries if execution fails.</td><td>Boolean</td><td>❌</td><td><code>false</code></td><td><strong>Advanced Settings</strong> is enabled</td></tr><tr><td><strong>Number of Retries</strong></td><td>Number of retries to attempt if execution fails.</td><td>Integer</td><td>❌</td><td><code>0</code></td><td><strong>Enable Retries</strong> is enabled</td></tr><tr><td><strong>Time to Wait Between Retries (ms)</strong></td><td>Time interval, in milliseconds, between retries.</td><td>Integer</td><td>❌</td><td><code>1000</code></td><td><strong>Enable Retries</strong> is enabled</td></tr><tr><td><strong>Fail on Error</strong></td><td>When enabled, the pipeline execution stops if an error occurs. When disabled, the pipeline continues and the <code>success</code> property returns <code>false</code>.</td><td>Boolean</td><td>❌</td><td><code>false</code></td><td>—</td></tr><tr><td><strong>Raw Pass Through</strong></td><td>When enabled, returns the original HL7 message unchanged under <code>"data"</code>, bypassing the parse-encode cycle entirely: no escape normalization, no trimming of trailing empty fields/components, and no MSH-2 regeneration. Use this when the message must reach its destination byte-for-byte (e.g., the receiving system performs its own parsing). Leave disabled for the default behavior, which parses and re-encodes the message — a normalizing process that is not guaranteed to be byte-preserving.</td><td>Boolean</td><td>❌</td><td><code>false</code></td><td>—</td></tr></tbody></table>
{% endtab %}

{% tab title="Documentation" %}

| Parameter         | Description                                                                             | Data type | Supports DB | Default value |
| ----------------- | --------------------------------------------------------------------------------------- | --------- | ----------- | ------------- |
| **Documentation** | Optional field to describe the connector configuration and any relevant business rules. | String    | ❌           | N/A           |
| {% endtab %}      |                                                                                         |           |             |               |
| {% endtabs %}     |                                                                                         |           |             |               |

## **Messages flow**

### **Output**

When the HL7 connector runs, it generates the following JSON structure:

```json
{
  "success": true,
  "exitCode": 200
}
```

* `success`: `true` if the operation completed successfully, `false` if it failed.
* `exitCode`: Exit code returned by the operation.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.digibee.com/documentation/connectors-and-triggers/connectors/industry-solutions/hl7.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.