> ## 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>サンプルファイルをアップロードすると、接続されているCSV Map またはXML Map コネクタでのマッピングが容易になります。</em></p>

    <p><strong>Sample Files</strong> タブを使用して、<a href="/26.2/self-hosted/ja/connectors/map">CSV Map</a> または<a href="/26.2/self-hosted/ja/connectors/xml-map/xml-map">XML Map</a> コネクタで使用するソースまたは宛先のXML テンプレートを生成します。<strong>Add Sample File</strong> をクリックします。</p>

    <p style={{
  paddingLeft: '1.5rem',
  marginTop: '0.25rem',
  marginBottom: '0.25rem'
}}>1. データの想定される形式と構造を反映したサンプルファイルが既にある場合は、<strong>File Upload</strong> を選択してファイルを参照します。あるいは、<strong>Manually Create</strong> を選択して、アプリケーション内で直接ファイルを作成します。<strong>Manually Create</strong> を選択した場合は、サンプルファイルに名前を付けます。<strong>Next</strong> をクリックします。</p>
    <p style={{
  paddingLeft: '1.5rem',
  marginTop: '0.25rem',
  marginBottom: '0.25rem'
}}>2. 既存のファイルを参照した場合、<strong>View File</strong> タブにその内容が表示されます。手動でファイルを作成することを選択した場合は、このタブにサンプルデータを入力します。<strong>Next</strong> をクリックします。</p>
    <p style={{
  paddingLeft: '1.5rem',
  marginTop: '0.25rem',
  marginBottom: '0.25rem'
}}>3. <strong>Translate and Preview</strong> タブには、XML に変換されたサンプルデータのプレビューが表示されます。サンプルに問題がなければ、<strong>Add</strong> をクリックします。</p>
  </>;

export const EdiUploadTestFile = ({fileFormat = "EDI", documentType}) => {
  const docLabel = documentType || fileFormat;
  return <>
      <p>入力ファイルのXML 表現を生成するには、次の手順を実行します。</p>
      <p style={{
    paddingLeft: '1.5rem',
    marginTop: '0.25rem',
    marginBottom: '0.25rem'
  }}>1. コネクタの<strong>Transactions</strong> タブで、<strong>More</strong> ドロップダウンをクリックし、<strong>Upload Test File</strong> をクリックします。</p>
      <p style={{
    paddingLeft: '1.5rem',
    marginTop: '0.25rem',
    marginBottom: '0.25rem'
  }}>2. XML としてモデル化したいディスク上のファイルに移動し、それを選択して<strong>OK</strong> をクリックします。</p>
      <p style={{
    paddingLeft: '1.5rem',
    marginTop: '0.25rem',
    marginBottom: '0.25rem'
  }}>3. フロー内で{fileFormat} コネクタをXML Map コネクタに接続します。この接続はいずれの方向でも可能です。XML Map コネクタへのインバウンド、またはXML Map コネクタからのアウトバウンドのいずれかです。</p>
      <p>XML Map コネクタは、テストファイルの構造を自動的に検出します。{fileFormat} コネクタを配置した場所に応じて、ファイルはXML Map コネクタの<strong>Source File</strong> または<strong>Destination File</strong> ドロップダウンメニューに表示されます。</p>
      <Note>XML Map コネクタにはソーステンプレートとデスティネーションテンプレートの両方が必要なため、残りのテンプレートは、データの元となる構造、または変換先となる構造に基づいて設定する必要があります。例えば、{docLabel} ドキュメントのデータをデータベースに挿入する必要がある場合、XML Map コネクタのもう一方のテンプレートはデータベース挿入のXML モデルになります。2 つのテンプレートファイル間のマッピングの作成について詳しくは、XML Map コネクタの<a href="/26.2/self-hosted/ja/connectors/xml-map/xml-map-designer">マッピングエディタの使用</a>を参照してください。</Note>
    </>;
};

export const EdiXmlMapIntro = ({fileFormat = "EDI"}) => <p>Arc の規約に従い、{fileFormat} コネクタは2 つのうちいずれかの動作を行います。XML 入力を受け取るか、XML 出力を生成するかのいずれかです。入力ファイルと出力ファイルが正しいXML 構造を持つようにするため、CData は、送信{fileFormat} ドキュメントを生成する際にはフロー内の前のステップとして、また受信{fileFormat} ドキュメントを受け取る際にはフロー内の次のステップとして、<a href="/26.2/self-hosted/ja/connectors/xml-map/xml-map">XML Map コネクタ</a>を使用することを強く推奨します。XML Map コネクタと{fileFormat} コネクタ間のやり取りは、以下で説明する<strong>Upload Test File</strong> 機能によって簡単になります。</p>;

export const DynamicallyProcessPartnersDetail = ({customImage1 = "edi_partners_tab.png", customImage2 = "edi_dynamically_process_partners_disabled.png"}) => <>
    <p>デフォルトでは、コネクタの<strong>Settings</strong> タブにある<strong>Dynamically process partners</strong> チェックボックスは有効になっています。これは、コネクタがEDI トランザクションからトレーディングパートナーとの関係を自動的に識別し追跡することを意味します。この場合、コネクタはライセンス上限までのすべてのパートナーを動的に管理し、上限に達したときに通知するため、手動でのパートナー設定は不要です。コネクタは処理するファイルに基づいて識別子を追跡するため、すべてのパートナーに対して単一のコネクタを使用できる可能性があります。</p>

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

    <p><strong>EDI Partners</strong> タブは、Arc がパートナーを動的に処理している場合にのみ有効になります。このタブには、コネクタが識別した各関係のパートナー識別子およびローカル識別子と、そのパートナーのファイルの最終処理日が表示されます。<strong>EDI Partners</strong> タブでは、最終処理日が30 日以上前のパートナーを、パートナーにカーソルを合わせてゴミ箱アイコンをクリックすることで削除できます。</p>

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

    <p>この設定を有効にすると、コネクタが識別したすべてのパートナーとの関係が、ライセンスの目的で自動的に追跡されます。これらは<strong>Settings &gt; License</strong> タブの<a href="/26.2/self-hosted/ja/getting-started/administration/settings/license-settings#connector-usage">Connector Usage</a> 部分に表示されます。ここでは、パートナー識別子およびローカル識別子、関連するコネクタ、日付情報を確認できます。</p>

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

    <p>この設定を無効にする場合は、次の画像に示すように、<strong>Settings</strong> タブの<strong>Partner Identifier</strong> および<strong>Personal Identifier</strong> フィールドでパートナーとの関係を明示的に設定する必要があります。</p>

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

    <p>手動で定義したパートナーとの関係も、<strong>Settings &gt; License</strong> タブの<a href="/26.2/self-hosted/ja/getting-started/administration/settings/license-settings#connector-usage">Connector Usage</a> 部分に表示されます。</p>
  </>;

export const SlasTab = ({siteName = "CData Arc"}) => <>
    <p><em>サービスレベルアグリーメント（SLA）の設定に関する設定です。</em></p>
    <p>
      SLA を使用すると、フロー内のコネクタが送受信すると見込まれるボリュームを設定し、そのボリュームを達成すると見込まれる期間を設定できます。{siteName} は、SLA が達成されない場合にユーザーへ警告するメールを送信し、SLA を<em>At Risk</em> としてマークします。これは、SLA が間もなく達成されない場合に<em>Violated</em> としてマークされることを意味します。これにより、ユーザーは介入してSLA が達成されない理由を特定し、適切な対応を取る機会を得られます。At Risk 期間の終了時点でもSLA が達成されない場合、SLA はviolated としてマークされ、ユーザーに再度通知されます。
    </p>
    <p>
      SLA を定義するには、<strong>Expected Volume</strong> をオンに切り替え、<strong>Settings</strong> タブをクリックします。
    </p>
    <img src="/public/images/sla_empty.png" alt="SLA Empty" />
    <ul>
      <li>コネクタに送信と受信の個別のアクションがある場合は、ラジオボタンを使用してSLA がどちらの方向に適用されるかを指定します。</li>
      <li>ウィンドウの<strong>Expect at least</strong> 部分で、次を設定します。
        <ul>
          <li>処理を見込む最小トランザクション数（ボリューム）を設定します。</li>
          <li><strong>Every</strong> フィールドを使用して期間を指定します。</li>
          <li>SLA を有効にするタイミングを指定します。<strong>Starting on</strong> を選択した場合は、日付および時刻フィールドを入力します。</li>
          <li>SLA を有効にしたい曜日のチェックボックスをオンにします。必要に応じて、ドロップダウンで<strong>Everyday</strong> を選択します。</li>
        </ul>
      </li>
      <li>ウィンドウの<strong>Set status to 'At Risk'</strong> 部分で、SLA をAt Risk としてマークするタイミングを指定します。
        <ul>
          <li>デフォルトでは、SLA が違反状態になるまで通知は送信されません。これを変更するには、<strong>Send an 'At Risk' notification</strong> をオンにします。</li>
        </ul>
      </li>
    </ul>
    <p>
      次の例は、月曜日から金曜日まで毎日1000 件のファイルを受信すると見込むコネクタ向けに設定されたSLA を示しています。1000 件のファイルが受信されていない場合、期間の終了の1時間前にAt Risk 通知が送信されます。
    </p>
    <img src="/public/images/sla_defined.png" alt="SLA Configuration Example" />
    <Note>
      必要に応じてSLA アラートをオフにすることができます。これはメンテナンスウィンドウ中に役立ちます。navbar で<strong>Settings</strong> をクリックし、<strong>Alerts &gt; General Alerts</strong> に移動します。タブレットと鉛筆のアイコンをクリックして編集し、<strong>SLA Alerts</strong> 設定のチェックを外します。
    </Note>
  </>;

export const AlertsTab = ({siteNameShort = "Arc"}) => <>
    <p><em>アラートの設定に関する設定です。</em></p>
    <p>
      サービスレベルアグリーメント（SLA）を実行する前に、通知用のメールアラートをセットアップする必要があります。デフォルトでは、{siteNameShort} は<a href="/26.2/self-hosted/ja/getting-started/administration/settings/alerts">Alerts</a> タブのグローバル設定を使用します。このコネクタに別の設定を使用するには、<strong>Override global setting</strong> をオンに切り替えます。
    </p>
    <p>
      デフォルトではエラーアラートが有効になっており、エラーが発生するたびにメールが送信されます。これをオフにするには、<strong>Enable</strong> チェックボックスのチェックを外します。
    </p>
    <p>
      <strong>Subject</strong>（必須）を入力し、必要に応じて<strong>Recipient</strong> のメールアドレスをカンマ区切りのリストで入力します。
    </p>
  </>;

export const Message = () => <>
    <p><em>Message 設定は、コネクタがメッセージを検索する方法と、処理後にメッセージを管理する方法を決定します。</em></p>
    <table>
      <thead>
        <tr><th>設定</th><th>説明</th></tr>
      </thead>
      <tbody>
        
          <tr>
            <td><strong>Save to Sent Folder</strong></td>
            <td>コネクタが処理したファイルをコネクタのSent フォルダにコピーするには、これをオンにします。</td>
          </tr>
        
        <tr>
          <td><strong>Sent Folder Scheme</strong></td>
          <td>選択した間隔に従って、コネクタが<strong>Sent</strong> フォルダ内のファイルをグループ化するよう指示します。例えば、<strong>Weekly</strong> オプションは、コネクタが毎週新しいサブフォルダを作成し、その週のすべての送信済みファイルをそのフォルダに保存するよう指示します。空白の設定は、コネクタがすべてのファイルを<strong>Sent</strong> フォルダに直接保存するよう指示します。多数のトランザクションを処理するコネクタでは、サブフォルダを使用することでファイルを整理しやすくなり、パフォーマンスを向上できます。</td>
        </tr>
      </tbody>
    </table>
  </>;

export const MiscConnector = () => <>
    <p><em>Miscellaneous 設定は、特定のユースケース向けの設定です。</em></p>
    <table>
      <thead>
        <tr>
          <th>設定</th>
          <th>説明</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>Other Settings</strong></td>
          <td>非表示のコネクタ設定をセミコロン区切りのリストで設定できます（例：<code>setting1=value1;setting2=value2</code>）。通常のコネクタのユースケースや機能では、これらの設定の使用は必要ありません。</td>
        </tr>
      </tbody>
    </table>
  </>;

export const Logging = () => <>
    <p><em>ログの作成と保存を制御する設定です。</em></p>
    <table>
      <thead>
        <tr>
          <th>設定</th>
          <th>説明</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>Log Level</strong></td>
          <td>コネクタが生成するログの詳細度です。サポートを依頼する際は、これを<strong>Debug</strong> に設定してください。</td>
        </tr>
        <tr>
          <td><strong>Log Subfolder Scheme</strong></td>
          <td>選択した間隔に従って、コネクタがLogs フォルダ内のファイルをグループ化するよう指示します。<strong>Weekly</strong> オプション（デフォルト）は、コネクタが毎週新しいサブフォルダを作成し、その週のすべてのログをそのフォルダに保存するよう指示します。この設定を空白のままにすると、コネクタはすべてのログをLogs フォルダに直接保存します。多数のトランザクションを処理するコネクタでは、サブフォルダを使用することでログを整理しやすくなり、パフォーマンスが向上します。</td>
        </tr>
        <tr>
          <td><strong>Log Messages</strong></td>
          <td>処理したファイルのログエントリにファイル自体のコピーを含めるには、これをオンにします。これを無効にすると、<strong>Transactions</strong> タブからファイルのコピーをダウンロードできなくなる場合があります。</td>
        </tr>
      </tbody>
    </table>
  </>;

export const MacrosExamples = ({extraMacros = []}) => <>
    <p>
      %Ext% や %ShortDate% などの一部のマクロは引数を必要としませんが、引数を必要とするものもあります。
      引数を取るすべてのマクロは次の構文を使用します。<code>%Macro:argument%</code>
    </p>

    <p>引数を取るマクロの例を次に示します。</p>

    <ul>
      <li>%Header:headername%：<code>headername</code> はメッセージ上のヘッダーの名前です。</li>
      <li>%Header:mycustomheader% は、入力メッセージに設定された<code>mycustomheader</code> ヘッダーの値に解決されます。</li>
      <li>%Header:ponum% は、入力メッセージに設定された<code>ponum</code> ヘッダーの値に解決されます。</li>
      <li>%RegexFilename:pattern%：<code>pattern</code> は正規表現パターンです。例えば、<code>%RegexFilename:^([\w][A-Za-z]+)%</code> は、ファイル名の最初の単語にマッチしてそれに解決され、大文字・小文字を区別しません（<code>test_file.xml</code> は<code>test</code> に解決されます）。</li>
      <li>%Vault:vaultitem%：<code>vaultitem</code> は<a href="/26.2/self-hosted/ja/getting-started/administration/settings/global-settings-vault">Vault</a> 内のアイテムの名前です。例えば、<code>%Vault:companyname%</code> は、Vault に保存された<code>companyname</code> アイテムの値に解決されます。</li>
      <li>%DateFormat:format%：<code>format</code> は許容される日付形式です（詳細は<a href="/26.2/self-hosted/ja/scripting/value-formatters/date-formatters#sample-date-formats">日付形式のサンプル</a>を参照してください）。例えば、<code>%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%</code> は、ファイルの日付とタイムスタンプに解決されます。</li>
      {extraMacros.filter(item => item.example).map(item => <li key={`ex-${item.name}`}>{item.example}</li>)}
    </ul>

    <p>次の例に示すように、より高度なマクロを作成することもできます。</p>

    <ul>
      <li>1 つのファイル名で複数のマクロを組み合わせる：<code>%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%%EXT%</code></li>
      <li>マクロの外側にテキストを含める：<code>MyFile_%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%</code></li>
      <li>マクロの内側にテキストを含める：<code>%DateFormat:'DateProcessed-'yyyy-MM-dd_'TimeProcessed-'HH-mm-ss%</code></li>
    </ul>
  </>;

export const MacrosTable = ({siteName = "CData Arc", extraMacros = []}) => <>
    <p>
      ファイル命名戦略でマクロを使用すると、データの整理効率と文脈の理解を高めることができます。
      ファイル名にマクロを組み込むことで、識別子、タイムスタンプ、ヘッダー情報などの関連情報を
      動的に含めることができ、各ファイルに有用な文脈を提供します。
    </p>

    <p>{siteName} は次のマクロをサポートしています。これらはすべて次の構文を使用します。<code>%Macro%</code></p>

    <table>
      <thead>
        <tr><th>マクロ</th><th>説明</th></tr>
      </thead>
      <tbody>
        <tr><td>ConnectorID</td><td>コネクタのConnectorID に評価されます。</td></tr>
        <tr><td>Ext</td><td>コネクタが現在処理しているファイルの拡張子に評価されます。</td></tr>
        <tr><td>Filename</td><td>コネクタが現在処理しているファイルのファイル名（拡張子を含む）に評価されます。</td></tr>
        <tr><td>FilenameNoExt</td><td>コネクタが現在処理しているファイルのファイル名（拡張子を除く）に評価されます。</td></tr>
        <tr><td>MessageId</td><td>コネクタが出力しているメッセージのMessageId に評価されます。</td></tr>
        <tr><td>RegexFilename:<em>pattern</em></td><td>コネクタが現在処理しているファイルのファイル名に正規表現パターンを適用します。</td></tr>
        <tr><td>Header:<em>headername</em></td><td>コネクタが現在処理しているメッセージ上の対象ヘッダー（<code>headername</code>）の値に評価されます。</td></tr>
        <tr><td>LongDate</td><td>システムの現在の日時を長い形式（例：Wednesday, January 24, 2024）で評価します。</td></tr>
        <tr><td>ShortDate</td><td>システムの現在の日時をyyyy-MM-dd 形式（例：2024-01-24）で評価します。</td></tr>
        <tr><td>DateFormat:<em>format</em></td><td>システムの現在の日時を指定された形式（<code>format</code>）で評価します。利用可能な日時形式については、<a href="/26.2/self-hosted/ja/scripting/value-formatters/date-formatters#date-formats-with-literal-characters">日付形式のサンプル</a>を参照してください。</td></tr>
        <tr><td>Vault:<em>vaultitem</em></td><td>指定されたVault アイテムの値に評価されます。</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>コネクタへのリソースの割り当てに関する設定です。</em></p>
    <table>
      <thead>
        <tr>
          <th>設定</th>
          <th>説明</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>Max Workers</strong></td>
          <td>このコネクタでファイルを処理するためにスレッドプールから消費されるワーカースレッドの最大数です。設定すると、<a href="/26.2/self-hosted/ja/getting-started/administration/settings/advanced-settings">Advanced Settings</a> ページの<a href="/26.2/self-hosted/ja/getting-started/administration/settings/performance-settings">Performance Settings</a> 部分にあるデフォルト設定が上書きされます。</td>
        </tr>
        <tr>
          <td><strong>Max Files</strong></td>
          <td>コネクタに割り当てられた各スレッドが送信するファイルの最大数です。設定すると、<a href="/26.2/self-hosted/ja/getting-started/administration/settings/advanced-settings">Advanced Settings</a> ページの<a href="/26.2/self-hosted/ja/getting-started/administration/settings/performance-settings">Performance Settings</a> 部分にあるデフォルト設定が上書きされます。</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#ローカルファイルシステムとのやり取り) 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 />