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

# HL7 Connector

> Configuration and usage guide for the CData Arc HL7 connector.

export const SampleFilesTab = () => <>
    <p><em>Uploading a sample file allows for easy mapping in any connected CSV Map or XML Map connectors.</em></p>

    <p>Use the <strong>Sample Files</strong> tab to generate a source or destination XML template for use in a <a href="/26.3/self-hosted/en/connectors/map">CSV Map</a> or <a href="/26.3/self-hosted/en/connectors/xml-map/xml-map">XML Map</a> connector. Click <strong>Add Sample File</strong>.</p>

    <p style={{
  paddingLeft: '1.5rem',
  marginTop: '0.25rem',
  marginBottom: '0.25rem'
}}>1. If you already have an example file that reflects the expected format and structure of your data, choose <strong>File Upload</strong> and browse to your file. Alternatively, select <strong>Manually Create</strong> to create a file directly in the application. If you choose <strong>Manually Create</strong>, give your sample file a name. Click <strong>Next</strong>.</p>
    <p style={{
  paddingLeft: '1.5rem',
  marginTop: '0.25rem',
  marginBottom: '0.25rem'
}}>2. If you browsed to an existing file, the <strong>View File</strong> tab is populated with its contents. If you chose to manually create a file, enter your sample data on this tab. Click <strong>Next</strong>.</p>
    <p style={{
  paddingLeft: '1.5rem',
  marginTop: '0.25rem',
  marginBottom: '0.25rem'
}}>3. The <strong>Translate and Preview</strong> tab displays a preview of your sample data converted to XML. When you are satisfied with your sample, click <strong>Add</strong>.</p>
  </>;

export const EdiUploadTestFile = ({fileFormat = "EDI", documentType}) => {
  const docLabel = documentType || fileFormat;
  return <>
      <p>Follow these steps to generate an XML representation of an input file:</p>
      <p style={{
    paddingLeft: '1.5rem',
    marginTop: '0.25rem',
    marginBottom: '0.25rem'
  }}>1. In the <strong>Transactions</strong> tab of the connector, click the <strong>More</strong> dropdown and click <strong>Upload Test File</strong>.</p>
      <p style={{
    paddingLeft: '1.5rem',
    marginTop: '0.25rem',
    marginBottom: '0.25rem'
  }}>2. Navigate to a file on disk that you want to model as XML, select it, and click <strong>OK</strong>.</p>
      <p style={{
    paddingLeft: '1.5rem',
    marginTop: '0.25rem',
    marginBottom: '0.25rem'
  }}>3. Connect the {fileFormat} connector to an XML Map connector in the flow. This connection can go in either direction: inbound to the XML Map connector, or outbound from the XML Map connector.</p>
      <p>The XML Map connector automatically detects the structure of the test file. Based on where you placed the {fileFormat} connector, the file appears in the <strong>Source File</strong> or <strong>Destination File</strong> drop-down menu of the XML Map connector.</p>
      <Note>XML Map connectors require both a source and destination template, so the remaining template must be set based on the structure the data originates from, or the structure it should be converted to. For example, if the data from the {docLabel} document needs to be inserted into a database, the other template in the XML Map connector would be the XML model of a database insert. See the XML Map connector's <a href="/26.3/self-hosted/en/connectors/xml-map/xml-map-designer">Using the Mapping Editor</a> for more information on creating the mapping between two template files.</Note>
    </>;
};

export const EdiXmlMapIntro = ({fileFormat = "EDI"}) => <p>In accordance with Arc convention, the {fileFormat} connector does one of two things: it receives XML input or generates XML output. To ensure that the input and output files have the correct XML structure, CData strongly recommends that you use the <a href="/26.3/self-hosted/en/connectors/xml-map/xml-map">XML Map connector</a> as the previous step in the flow when generating outbound {fileFormat} documents, or as the following step in the flow when receiving inbound {fileFormat} documents. The interaction between the XML Map connector and the {fileFormat} connector is made simple by the <strong>Upload Test File</strong> feature described below.</p>;

export const DynamicallyProcessPartnersDetail = ({customImage1 = "edi_partners_tab.png", customImage2 = "edi_dynamically_process_partners_disabled.png"}) => <>
    <p>By default, the <strong>Dynamically process partners</strong> checkbox on the connector <strong>Settings</strong> tab is enabled. This means that the connector automatically identifies and tracks trading partner relationships from EDI transactions. In this case, no manual partner configuration is required because the connector dynamically manages all partners up to your license limit, and notifies you when you reach the limit. The connector keeps track of the identifiers based on the files that it processes, which means that you might be able to use a single connector for all of your partners.</p>

    <img src="/public/images/edi_dynamically_process_partners.png" alt="Dynamically process partners setting" width="200" />

    <p>The <strong>EDI Partners</strong> tab is only enabled when Arc is dynamically processing partners. It is populated with the partner and personal identifiers of each relationship that the connector identifies, as well as the last processing date of a file for that partner. You can delete partners whose last processed date is more than 30 days ago in the <strong>EDI Partners</strong> tab by hovering over the partner and clicking the bin icon.</p>

    <img src={`/public/images/${customImage1}`} alt="EDI Partners tab" width="600" />

    <p>When this setting is enabled, all partner relationships identified by the connector are automatically tracked for licensing purposes. They appear in the <a href="/26.3/self-hosted/en/getting-started/administration/settings/license-settings#connector-usage">Connector Usage</a> portion of the <strong>Settings &gt; License</strong> tab. Here you can view the partner and personal identifiers, the associated connectors, and date information.</p>

    <img src="/public/images/edi_partner_licenses.png" alt="EDI partner licenses" width="800" />

    <p>If you disable this setting, you must explicitly configure a partner relationship in the <strong>Partner Identifier</strong> and <strong>Personal Identifier</strong> fields on the <strong>Settings</strong> tab, as shown in the following image.</p>

    <img src={`/public/images/${customImage2}`} alt="Dynamically process partners disabled" width="700" />

    <p>Manually defined partner relationships also appear in the <a href="/26.3/self-hosted/en/getting-started/administration/settings/license-settings#connector-usage">Connector Usage</a> portion of the <strong>Settings &gt; License</strong> tab.</p>
  </>;

export const SlasTab = ({siteName = "CData Arc"}) => <>
    <p><em>Settings related to configuring Service Level Agreements (SLAs).</em></p>
    <p>
      SLAs enable you to configure the volume you expect connectors in your flow to send or receive, and to set the time frame in which you expect that volume to be met. {siteName} sends emails to warn the user when an SLA is not met, and marks the SLA as <em>At Risk</em>, which means that if the SLA is not met soon, it will be marked as <em>Violated</em>. This gives the user an opportunity to step in and determine the reasons the SLA is not being met, and to take appropriate actions. If the SLA is still not met at the end of the at-risk time period, the SLA is marked as violated, and the user is notified again.
    </p>
    <p>
      To define an SLA, toggle <strong>Expected Volume</strong> on, then click the <strong>Settings</strong> tab.
    </p>
    <img src="/public/images/sla_empty.png" alt="SLA Empty" />
    <ul>
      <li>If your connector has separate send and receive actions, use the radio buttons to specify which direction the SLA pertains to.</li>
      <li>In the <strong>Expect at least</strong> portion of the window:
        <ul>
          <li>Set the minimum number of transactions you expect to be processed (the volume)</li>
          <li>Use the <strong>Every</strong> fields to specify the time frame</li>
          <li>Indicate when the SLA should go into effect. If you choose <strong>Starting on</strong>, complete the date and time fields.</li>
          <li>Check the boxes for the days of the week that you want the SLA to be in effect. Use the dropdown to choose <strong>Everyday</strong> if necessary.</li>
        </ul>
      </li>
      <li>In the <strong>Set status to 'At Risk'</strong> portion of the window, specify when the SLA should be marked as at risk.
        <ul>
          <li>By default, notifications are not sent until an SLA is in violation. To change that, check <strong>Send an 'At Risk' notification</strong>.</li>
        </ul>
      </li>
    </ul>
    <p>
      The following example shows an SLA configured for a connector that expects to receive 1000 files every day Monday-Friday. An at-risk notification is sent 1 hour before the end of the time period if the 1000 files have not been received.
    </p>
    <img src="/public/images/sla_defined.png" alt="SLA Configuration Example" />
    <Note>
      You can turn off SLA alerts if necessary. This can be useful during maintenance windows. Click <strong>Settings</strong> on the navbar, then navigate to <strong>Alerts &gt; General Alerts</strong>. Click the tablet and pencil icon to edit, and uncheck the <strong>SLA Alerts</strong> setting.
    </Note>
  </>;

export const AlertsTab = ({siteNameShort = "Arc"}) => <>
    <p><em>Settings related to configuring alerts.</em></p>
    <p>
      Before you can execute Service Level Agreements (SLAs), you need to set up email alerts for notifications. By default, {siteNameShort} uses the global settings on the <a href="/26.3/self-hosted/en/getting-started/administration/settings/alerts">Alerts</a> tab. To use other settings for this connector, toggle <strong>Override global setting</strong> on.
    </p>
    <p>
      By default, error alerts are enabled, which means that emails are sent whenever there is an error. To turn them off, uncheck the <strong>Enable</strong> checkbox.
    </p>
    <p>
      Enter a <strong>Subject</strong> (mandatory). Check <strong>Allow {siteNameShort}Script in Subject</strong> to use {siteNameShort}Script in the <strong>Subject</strong> field. When you select this, the <strong>{siteNameShort}Script Editor</strong> button appears (<img src="/public/images/rest_arcscript_editor.png" alt="arcscript editor button" style={{
  display: 'inline',
  verticalAlign: 'middle',
  margin: 0
}} />).
    </p>
    <p>
      Optionally, enter a comma-separated list of <strong>Recipient</strong> emails.
    </p>
  </>;

export const Message = () => <>
    <p><em>Message settings determine how the connector searches for messages and manages them after processing.</em></p>
    <p><strong>Note:</strong> The settings below are deprecated and hidden by default. They appear only on connectors where they were previously enabled or configured to a non-default value. To retain copies of successfully processed files, right-click the connector in the flow, choose <strong>Show Success Path</strong>, and connect the success path to a <a href="/26.3/self-hosted/en/connectors/file">File connector</a>.</p>
    <table>
      <thead>
        <tr><th>Setting</th><th>Description</th></tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>Save to Sent Folder</strong> (Deprecated)</td>
          <td>Copies files processed by the connector to the Sent folder. Disabled by default. Files saved to the Sent folder are not covered by <a href="/26.3/self-hosted/en/getting-started/administration/settings/encryption-at-rest">Encryption at Rest</a>.</td>
        </tr>
        <tr>
          <td><strong>Sent Folder Scheme</strong> (Deprecated)</td>
          <td>Groups files in the <strong>Sent</strong> folder by the selected time interval. Only relevant when <strong>Save to Sent Folder</strong> is enabled.</td>
        </tr>
      </tbody>
    </table>
  </>;

export const MiscConnector = () => <>
    <p><em>Miscellaneous settings are for specific use cases.</em></p>
    <table>
      <thead>
        <tr>
          <th>Setting</th>
          <th>Description</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>Other Settings</strong></td>
          <td>Enables you to configure hidden connector settings in a semicolon-separated list (for example, <code>setting1=value1;setting2=value2</code>). Normal connector use cases and functionality should not require the use of these settings.</td>
        </tr>
      </tbody>
    </table>
  </>;

export const Logging = () => <>
    <p><em>Settings that govern the creation and storage of logs.</em></p>
    <table>
      <thead>
        <tr>
          <th>Setting</th>
          <th>Description</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>Log Level</strong></td>
          <td>The verbosity of logs generated by the connector. When you request support, set this to <strong>Debug</strong>.</td>
        </tr>
        <tr>
          <td><strong>Log Subfolder Scheme</strong></td>
          <td>Instructs the connector to group files in the Logs folder according to the selected interval. The <strong>Weekly</strong> option (which is the default) instructs the connector to create a new subfolder each week and store all logs for the week in that folder. Leaving this setting blank tells the connector to save all logs directly in the Logs folder. For connectors that process many transactions, using subfolders helps keep logs organized and improves performance.</td>
        </tr>
        <tr>
          <td><strong>Log Messages</strong></td>
          <td>Check this to have the log entry for a processed file include a copy of the file itself. If you disable this, you might not be able to download a copy of the file from the <strong>Transactions</strong> tab.</td>
        </tr>
      </tbody>
    </table>
  </>;

export const MacrosExamples = ({extraMacros = []}) => <>
    <p>
      Some macros, such as %Ext% and %ShortDate%, do not require an argument, but others do. All
      macros that take an argument use the following syntax: <code>%Macro:argument%</code>
    </p>

    <p>Here are some examples of the macros that take an argument:</p>

    <ul>
      <li>%Header:headername%: Where <code>headername</code> is the name of a header on a message.</li>
      <li>%Header:mycustomheader% resolves to the value of the <code>mycustomheader</code> header set on the input message.</li>
      <li>%Header:ponum% resolves to the value of the <code>ponum</code> header set on the input message.</li>
      <li>%RegexFilename:pattern%: Where <code>pattern</code> is a regex pattern. For example, <code>%RegexFilename:^([\w][A-Za-z]+)%</code> matches and resolves to the first word in the filename and is case insensitive (<code>test_file.xml</code> resolves to <code>test</code>).</li>
      <li>%Vault:vaultitem%: Where <code>vaultitem</code> is the name of an item in the <a href="/26.3/self-hosted/en/getting-started/administration/settings/global-settings-vault">vault</a>. For example, <code>%Vault:companyname%</code> resolves to the value of the <code>companyname</code> item stored in the vault.</li>
      <li>%DateFormat:format%: Where <code>format</code> is an accepted date format (see <a href="/26.3/self-hosted/en/scripting/value-formatters/date-formatters#sample-date-formats">Sample Date Formats</a> for details). For example, <code>%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%</code> resolves to the date and timestamp on the file.</li>
      {extraMacros.filter(item => item.example).map(item => <li key={`ex-${item.name}`}>{item.example}</li>)}
    </ul>

    <p>You can also create more sophisticated macros, as shown in the following examples:</p>

    <ul>
      <li>Combining multiple macros in one filename: <code>%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%%EXT%</code></li>
      <li>Including text outside of the macro: <code>MyFile_%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%</code></li>
      <li>Including text within the macro: <code>%DateFormat:'DateProcessed-'yyyy-MM-dd_'TimeProcessed-'HH-mm-ss%</code></li>
    </ul>
  </>;

export const MacrosTable = ({siteName = "CData Arc", extraMacros = []}) => <>
    <p>
      Using macros in file naming strategies can enhance organizational efficiency and contextual
      understanding of data. By incorporating macros into filenames, you can dynamically include
      relevant information such as identifiers, timestamps, and header information, providing
      valuable context to each file.
    </p>

    <p>{siteName} supports these macros, which all use the following syntax: <code>%Macro%</code>.</p>

    <table>
      <thead>
        <tr><th>Macro</th><th>Description</th></tr>
      </thead>
      <tbody>
        <tr><td>ConnectorID</td><td>Evaluates to the ConnectorID of the connector.</td></tr>
        <tr><td>ConnectorName</td><td>Evaluates to the name of the connector. Enables you to include the connection name in file names or paths: for example, to tag backup files by which database connection produced them.</td></tr>
        <tr><td>Ext</td><td>Evaluates to the file extension of the file currently being processed by the connector.</td></tr>
        <tr><td>Filename</td><td>Evaluates to the filename (extension included) of the file currently being processed by the connector.</td></tr>
        <tr><td>FilenameNoExt</td><td>Evaluates to the filename (without the extension) of the file currently being processed by the connector.</td></tr>
        <tr><td>MessageId</td><td>Evaluates to the MessageId of the message being output by the connector.</td></tr>
        <tr><td>RegexFilename:<em>pattern</em></td><td>Applies a RegEx pattern to the filename of the file currently being processed by the connector.</td></tr>
        <tr><td>Header:<em>headername</em></td><td>Evaluates to the value of a targeted header (<code>headername</code>) on the current message being processed by the connector.</td></tr>
        <tr><td>LongDate</td><td>Evaluates to the current datetime of the system in long-handed format (for example, Wednesday, January 24, 2024).</td></tr>
        <tr><td>ShortDate</td><td>Evaluates to the current datetime of the system in a yyyy-MM-dd format (for example, 2024-01-24).</td></tr>
        <tr><td>DateFormat:<em>format</em></td><td>Evaluates to the current datetime of the system in the specified format (<code>format</code>). See <a href="/26.3/self-hosted/en/scripting/value-formatters/date-formatters#date-formats-with-literal-characters">Sample Date Formats</a> for the available datetime formats.</td></tr>
        <tr><td>Vault:<em>vaultitem</em></td><td>Evaluates to the value of the specified vault item.</td></tr>
        {extraMacros.map(item => <tr key={item.name}>
            <td>{item.name}</td>
            <td>{item.description}</td>
          </tr>)}
      </tbody>
    </table>
  </>;

export const Performance = () => <>
    <p><em>Settings related to the allocation of resources to the connector.</em></p>
    <table>
      <thead>
        <tr>
          <th>Setting</th>
          <th>Description</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>Max Workers</strong></td>
          <td>The maximum number of worker threads consumed from the threadpool to process files on this connector. If set, this overrides the default setting on the <a href="/26.3/self-hosted/en/getting-started/administration/settings/performance-settings">Performance Settings</a> portion of the <a href="/26.3/self-hosted/en/getting-started/administration/settings/advanced-settings">Advanced Settings</a> page.</td>
        </tr>
        <tr>
          <td><strong>Max Files</strong></td>
          <td>The maximum number of files sent by each thread assigned to the connector. If set, this overrides the default setting on the <a href="/26.3/self-hosted/en/getting-started/administration/settings/performance-settings">Performance Settings</a> portion of the <a href="/26.3/self-hosted/en/getting-started/administration/settings/advanced-settings">Advanced Settings</a> page.</td>
        </tr>
      </tbody>
    </table>
  </>;

export const companyName = "CData";

export const siteNameShort = "Arc";

export const siteName = "CData Arc";

export const fileFormat = "HL7";
export const documentType = "HL7";

Health Level-7 is a set of standards for the transfer of clinical data used by hospitals and other healthcare providers. HL7 connectors support generating HL7 documents from XML and converting HL7 documents into XML.

## Key Capabilities

* Healthcare data exchange with full HL7 message standard support
* MSH header validation and generation for compliant message structure
* Original mode acknowledgment processing for reliable healthcare communications
* Support for multiple HL7 versions with strict schema validation options

## Overview

When receiving HL7 documents, HL7 connectors validate interchange headers and convert the HL7 document into XML. This is useful as a staging step, because XML is the primary format that {siteNameShort} uses to manipulate data in a flow. The HL7 connector automatically reads the input file to determine the appropriate schema, then parses the document according to this schema.

When generating HL7 documents, HL7 connectors convert XML into HL7 document syntax and apply the appropriate interchange headers. This is useful as the final step for creating an HL7 document, after the XML data has been fetched and transformed elsewhere in the flow.

## Connector Configuration

This section contains all of the configurable connector properties.

### Settings Tab

#### Translation Configuration

*Settings related to the core operation of the connector.*

| Setting                          | Description                                                                                                                                                                                                                                            |
| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Connector Id**                 | The static, unique identifier for the connector.                                                                                                                                                                                                       |
| **Connector Type**               | Displays the connector name and a description of what it does.                                                                                                                                                                                         |
| **Connector Description**        | An optional field to provide a free-form description of the connector and its role in the flow.                                                                                                                                                        |
| **Translation Type**             | Whether the connector should convert HL7 documents into XML, or generate HL7 documents from XML.                                                                                                                                                       |
| **Dynamically process partners** | When enabled, the connector automatically identifies and tracks trading partner relationships from EDI transactions. When disabled, you must manually define the partner relationship. See [EDI Partners Tab](#edi-partners-tab) for more information. |

#### EDI Partner

| Setting                  | Description                                                                                                                                                            |
| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Partner Id (MSH3.1)**  | In conjunction with the other 3.X elements, identifies the application sending the HL7 document. Only applicable when **Dynamically process partners** is unchecked.   |
| **Personal Id (MSH5.1)** | In conjunction with the other 5.X elements, identifies the application receiving the HL7 document. Only applicable when **Dynamically process partners** is unchecked. |

#### MSH Settings

*Settings related to the message headers. When converting HL7 documents into XML, the document headers are validated against these settings; when generating HL7 documents from XML, these settings are used to generate document headers.*

| Setting                                             | Description                                                                                        |
| --------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
| **Partner Application Universal Id (MSH3.2)**       | In conjunction with the other 3.X elements, identifies the application sending the HL7 document.   |
| **Partner Application Universal Id Type (MSH3.3)**  | In conjunction with the other 3.X elements, identifies the application sending the HL7 document.   |
| **Partner Facility Namespace Id (MSH4.1)**          | In conjunction with the other 4.X elements, identifies the facility sending the HL7 document.      |
| **Partner Facility Universal Id (MSH4.2)**          | In conjunction with the other 4.X elements, identifies the facility sending the HL7 document.      |
| **Partner Facility Universal Id Type (MSH4.3)**     | In conjunction with the other 4.X elements, identifies the facility sending the HL7 document.      |
| **Personal Application Universal Id (MSH5.2)**      | In conjunction with the other 5.X elements, identifies the application receiving the HL7 document. |
| **Personal Application Universal Id Type (MSH5.3)** | In conjunction with the other 5.X elements, identifies the application receiving the HL7 document. |
| **Personal Facility Namespace Id (MSH6.1)**         | In conjunction with the other 6.X elements, identifies the facility receiving the HL7 document.    |
| **Personal Facility Universal Id (MSH6.2)**         | In conjunction with the other 6.X elements, identifies the facility receiving the HL7 document.    |
| **Personal Facility Universal Id Type (MSH6.3)**    | In conjunction with the other 6.X elements, identifies the facility receiving the HL7 document.    |

The following options are only visible when the **Translation Type** is XML to HL7.

| Setting                                     | Description                                                                                                                                                                                                                                                      |
| ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Security (MSH8)**                         | Used to implement security features.                                                                                                                                                                                                                             |
| **Processing Id (MSH11.1)**                 | Defines whether the document is part of a production, training, or debugging system.                                                                                                                                                                             |
| **Processing Mode (MSH11.2)**               | Defines whether the document is part of an archival process or an initial load. Options are: not present-current processing, archive, restore from archive, or initial load.                                                                                     |
| **Version Id (MSH12)**                      | This field is matched by the receiving system to its own version to ensure the document is interpreted correctly.                                                                                                                                                |
| **Sequence Number (MSH13)**                 | A non-null value in this field indicates that the sequence number protocol is in use.                                                                                                                                                                            |
| **Continuation Pointer (MSH14)**            | Used to define continuations in application-specific ways.                                                                                                                                                                                                       |
| **Accept Acknowledgment Type (MSH15)**      | Identifies the conditions under which accept acknowledgments are required to be returned in response to the document. Required for enhanced acknowledgment mode. Options are: always, never, error or reject conditions only, or successful completion only.     |
| **Application Acknowledgment Type (MSH16)** | Contains the conditions under which application acknowledgements are required to be returned in response to the document. Required for enhanced acknowledgment mode. Options are: always, never, error or reject conditions only, or successful completion only. |

#### Acknowledgments

*Settings related to generating and requesting acknowledgments.*

| Setting                 | Description                                                                                                                      |
| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| **Acknowledgment Type** | Whether or not acknowledgments should be generated and requested. See [Acknowledgments](#acknowledgements) for more information. |

### Sample Files Tab

<SampleFilesTab />

### Advanced Tab

#### EDI Delimiters

*Settings that specify which characters separate elements, segments, and so on.*

| Setting                         | Description                                                                                                                                                                                                     |
| ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Data Element Separator**      | The character that separates individual data elements in the document.                                                                                                                                          |
| **Component Element Separator** | The character that separates elements within a composite data structure in the document.                                                                                                                        |
| **Segment Terminator**          | The character that indicates the end of a segment in the document.                                                                                                                                              |
| **Release Char**                | The character that *releases* (escapes) the next character, overriding its usual meaning. This allows reserved characters to appear as data within documents, as long as they are preceded by the Release Char. |
| **Repetition Char**             | The character that indicates repetition of element values.                                                                                                                                                      |
| **Suffix**                      | Appended to the **Segment Terminator** to distinguish segments.                                                                                                                                                 |

#### Advanced Settings

*Settings not included in the previous categories.*

| Setting                      | Description                                                                                                                                                                                                                                                                                                                                                                                |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Batch Transactions**       | Whether multiple transactions should be grouped together in a single output file. When this is not checked, the connector creates a separate output file for each transaction. When checked, the connector groups all transactions into a single output file. Only applicable when the **Translation Type** is HL7 to XML.                                                                 |
| **Expand Qualifier Values**  | When translating HL7 into XML, whether elements containing an HL7 qualifier should include child elements to express the qualifier code and value. Only applicable when the **Translation Type** is HL7 to XML. For example:<br /><code>\<N101></code><br />  <code>\<Code>ST\</Code></code><br />  <code>\<Value>Ship To\</Value></code><br /><code>\</N101></code>                       |
| **Generate Description As**  | When translating HL7 into XML, descriptions of the HL7 segments and elements can be provided as context for the HL7 data. Use this dropdown to choose whether to add this context as an XML comment or as XML attributes.                                                                                                                                                                  |
| **Strict Schema Validation** | Whether the connector should Ignore, Warn, or Fail when the following are detected: repeat counts above the allowed number, missing required elements or segments, invalid qualifier and code values, disallowed element lengths, and invalid element values.                                                                                                                              |
| **Transmission Control**     | Whether the connector should wait for a transmission to be acknowledged before beginning the next transmission. Only applicable when the **Translation Type** is XML to HL7.                                                                                                                                                                                                               |
| **Processing Delay**         | The amount of time (in seconds) by which the processing of files placed in the **Transactions** tab is delayed. This is a legacy setting. Best practice is to [use a File connector](../flows/designing-a-flow#interacting-with-the-local-file-system) to manage local file systems instead of this setting.                                                                               |
| **Local File Scheme**        | A scheme for assigning filenames to messages that are output by the connector. You can use macros in your filenames dynamically to include information such as identifiers and timestamps. For more information, see [Macros](#macros).                                                                                                                                                    |
| **Validate Identifiers**     | When checked, the connector ensures that the identifiers in the translated document match the identifiers specified in the connector configuration.                                                                                                                                                                                                                                        |
| **Duplicate File Action**    | How the connector should behave when it receives a message with a control number that the connector has seen before (a duplicate). When set to `Ignore`, the connector silently skips the duplicate and continues processing. When set to `Warn`, the connector processes the file but returns a warning. When set to `Fail`, the connector does not accept the file and returns an error. |
| **Upload Schema**            | Use this to upload a schema and install it in the connector's Schema folder. If a schema already exists, you are asked if you want to overwrite it.                                                                                                                                                                                                                                        |
| **Reset State**              | EDI connectors keep track of control numbers that have been used and increment that number to ensure that future runs do not duplicate data. Use this button to reset the counter to its initial state without changing any of the configured settings.                                                                                                                                    |

#### Message

<Message />

#### Logging

<Logging />

#### Miscellaneous

<MiscConnector />

### EDI Partners Tab

<DynamicallyProcessPartnersDetail customImage1="edi_hl7_partners_tab.png" customImage2="edi_hl7_partner_config_disabled.png" />

### Automation Tab

#### Automation

*Settings related to the automatic processing of files by the connector.*

| Setting                  | Description                                                                                                                                                                                                                                                                                                                                                                   |
| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Send**                 | A toggle that instructs the connector to automatically send files when they are ready.                                                                                                                                                                                                                                                                                        |
| **Resend Interval**      | The interval the connector waits before resending a file that received a negative ACK. For example, if a trading partner receives the file but something is wrong with it and they send back a negative ACK, this setting specifies how long to wait before sending the file again.                                                                                           |
| **Max Attempts (async)** | The maximum number of times the connector processes the input file when a functional ACK is requested. Success is based on the return of a functional ACK within the **Resend Interval**. If a successful functional ACK is not returned, the connector resends the file until **Max Attempts** is reached. If this is set to 0, the connector resends the file indefinitely. |

#### Performance

<Performance />

### Alerts Tab

<AlertsTab />

### SLAs Tab

<SlasTab />

## XML to HL7

When generating HL7 files, set the **Translation Type** to *XML to HL7*. The application then reads the header information from the settings configured on the [Settings tab](#settings-tab).

Once you have configured the connector with the settings from your trading partner agreement, click the **Transactions** tab and select **More > Create Test Files**. The application creates a set of test XML files which provide example data of what the XML should look like for the connector to generate an HL7 document. After these test files are processed by the connector, navigate to the **Transactions** tab to see the resulting HL7 document.

## HL7 to XML

When generating XML, set the **Translation Type** to *HL7 to XML*. Then complete the trading partner agreement settings so the application can validate the information in the HL7 documents during processing. XML files are generated into the Output folder.

To create test HL7 files for several HL7 documents, click the **Transactions** tab and select **More > Create Test Files**. After these test files are processed by the connector, navigate to the **Transactions** tab to see the resulting XML.

## Use With the XML Map Connector

<EdiXmlMapIntro fileFormat={fileFormat} />

### Upload Test File

<EdiUploadTestFile fileFormat={fileFormat} documentType={documentType} />

## Acknowledgements

Acknowledgements can be automatically generated and processed by the application.

#### Original Mode Acknowledgements

This is an indication that an interchange has taken place between the two parties (although not necessarily that any individual message has been exchanged). It is automatically generated in response to a request in the interchange.

### Message Originator

#### Requesting Acknowledgements

HL7 connectors in XML to HL7 mode can be configured so that original mode acknowledgements are requested for an interchange. Select *Original Mode* in the **Acknowledgement Type** field on the [Settings tab](#settings-tab) to direct the connector to maintain a Pending ACK status for the transmission until the appropriate acknowledgements have been returned and processed.

<img src="https://mintcdn.com/cdata-arc/6KwLqCromZpN96Gn/public/images/edifact-ack-receive.png?fit=max&auto=format&n=6KwLqCromZpN96Gn&q=85&s=40ca886630d620f7a3fcc6381a3ff916" alt="Receive ACK" width="639" height="407" data-path="public/images/edifact-ack-receive.png" />

The diagram above shows a complete message exchange from the standpoint of the message originator. An HL7 connector in HL7 to XML mode generates the document to be exchanged **(1)** and holds it in a Pending ACK state. The trading partner processes the transmission in their business logic and creates acknowledgements in accordance with the configured exchange parameters and the bidirectional agreement between parties **(2)**. When the acknowledgements are returned, they are parsed with an HL7 to XML HL7 connector and routed to the original XML to HL7 connector to resolve the status of the transfer **(3)**.

<Note>The **Transmission Control** setting in the [Advanced Settings](#advanced-settings) section of the **Advanced** tab controls the flow of documents as it relates to their acknowledgements. When this is checked, the connector waits for an acknowledgement of the current message before processing the next message.</Note>

#### Processing Acknowledgements

When HL7 acknowledgements are received at an HL7 connector in HL7 to XML mode, the connector can be configured to automatically route any detected acknowledgements to the XML to HL7 connector that originated the transmission. Routing ACKs between HL7 connectors is configured visually on the Flows canvas by dragging the gray dot at the bottom of the HL7 connector in XML to HL7 mode onto the HL7 connector that is in HL7 to XML mode. The receiving XML to HL7 connector then pairs the acknowledgements to the original message and resolves the matching message.

### Message Recipient

#### Generating Acknowledgements

When an HL7 connector in HL7 to XML mode is processing received messages from the originator and generating XML, you can tell the connector to automatically generate original mode acknowledgements by selecting *Original Mode* in the **Acknowledgement Type** field on the [Settings tab](#settings-tab). You must route these acknowledgements to an HL7 connector in XML to HL7 mode to generate the HL7 acknowledgement. To route the ACK appropriately, drag the gray dot at the bottom of the HL7 connector in HL7 to XML mode onto the HL7 connector that is in XML to HL7 mode.

<img src="https://mintcdn.com/cdata-arc/6KwLqCromZpN96Gn/public/images/edifact-ack-create.png?fit=max&auto=format&n=6KwLqCromZpN96Gn&q=85&s=9694a5d7b85e809a73a7c2e8dd74afcb" alt="Generate ACKs" width="639" height="407" data-path="public/images/edifact-ack-create.png" />

As shown in the diagram above, when a trading partner sends a message where an acknowledgement is expected **(1)**, the HL7 to XML HL7 connector configured for that partner automatically generates an acknowledgement **(2)** as an XML file containing the transactional information relevant for that file. This XML acknowledgement must be routed back to an HL7 connector in XML to HL7 mode **(3)** so that all of the HL7 party agreement settings used when generating the HL7 file are sent back to the trading partner.

## Macros

<MacrosTable />

### Examples

<MacrosExamples />