blob: 1054bd9d7e0c7b8158cb3e6d16f126ecdb5c734e [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ExtractHL7Attributes</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">ExtractHL7Attributes</h1><h2>Description: </h2><p>Extracts information from an HL7 (Health Level 7) formatted FlowFile and adds the information as FlowFile Attributes. The attributes are named as &lt;Segment Name&gt; &lt;dot&gt; &lt;Field Index&gt;. If the segment is repeating, the naming will be &lt;Segment Name&gt; &lt;underscore&gt; &lt;Segment Index&gt; &lt;dot&gt; &lt;Field Index&gt;. For example, we may have an attribute named "MHS.12" with a value of "2.1" and an attribute named "OBX_11.3" with a value of "93000^CPT4".</p><h3>Tags: </h3><p>HL7, health level 7, healthcare, extract, attributes</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Display Name</th><th>API Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Character Encoding</strong></td><td>Character Encoding</td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">The Character Encoding that is used to encode the HL7 data<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Use Segment Names</strong></td><td>use-segment-names</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Whether or not to use HL7 segment names in attributes</td></tr><tr><td id="name"><strong>Parse Segment Fields</strong></td><td>parse-segment-fields</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Whether or not to parse HL7 segment fields into attributes</td></tr><tr><td id="name"><strong>Skip Validation</strong></td><td>skip-validation</td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Whether or not to validate HL7 message values</td></tr><tr><td id="name"><strong>HL7 Input Version</strong></td><td>hl7-input-version</td><td id="default-value">autodetect</td><td id="allowable-values"><ul><li>autodetect</li><li>2.2</li><li>2.3</li><li>2.3.1</li><li>2.4</li><li>2.5</li><li>2.5.1</li><li>2.6</li></ul></td><td id="description">The HL7 version to use for parsing and validation</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>A FlowFile is routed to this relationship if it is properly parsed as HL7 and its attributes extracted</td></tr><tr><td>failure</td><td>A FlowFile is routed to this relationship if it cannot be mapped to FlowFile Attributes. This would happen if the FlowFile does not contain valid HL7 data</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html>