HL7 Importer

From MedITEX - Wiki

(Difference between revisions)
Jump to: navigation, search
Line 119: Line 119:
 
</table>
 
</table>
 
<p>&nbsp;</p>
 
<p>&nbsp;</p>
 +
<table border="0">
 +
<tbody>
 +
<tr>
 +
<td style="text-align: center;"><img src="/images/2HL7.png" alt="" width="598" height="404" /></td>
 +
</tr>
 +
<tr>
 +
<td style="text-align: center;"><img src="/images/3HL7.png" alt="" width="598" height="401" /></td>
 +
</tr>
 +
</tbody>
 +
</table>
 
<p>&nbsp;</p>
 
<p>&nbsp;</p>
 
<p>&nbsp;</p>
 
<p>&nbsp;</p>
 +
<h3>Additional Settings</h3>
 +
<p>Additional settings to save log files, make statistics and check the consistency of incoming data.</p>
 +
<h4>Saving</h4>
 +
<table border="0">
 +
<tbody>
 +
<tr>
 +
<td><strong>Item</strong></td>
 +
<td><strong>Description</strong></td>
 +
</tr>
 +
<tr>
 +
<td>Save Level</td>
 +
<td>
 +
<p>Each processed message can be saved with more or less information.&nbsp; &nbsp;Default is &ldquo;Errors, Hints and Debug Information&rdquo;.</p>
 +
<p>After the testing phase switch to &ldquo;<strong>Only Errors</strong>&rdquo;.</p>
 +
</td>
 +
</tr>
 +
<tr>
 +
<td>Save info for statistics</td>
 +
<td>An additional feature to gain statistical information of the processed messages.</td>
 +
</tr>
 +
<tr>
 +
<td>Automatically load protocol file</td>
 +
<td>An additional feature to display then message processing in the user interface of MexHL7Importer. The output will be according to the selection in section &ldquo;Save Level&rdquo;.</td>
 +
</tr>
 +
</tbody>
 +
</table>
 
<p>&nbsp;</p>
 
<p>&nbsp;</p>
 +
<table border="0">
 +
<tbody>
 +
<tr>
 +
<td style="text-align: center;"><img src="/images/4HL7.png" alt="" width="598" height="401" /></td>
 +
</tr>
 +
</tbody>
 +
</table>
 
<p>&nbsp;</p>
 
<p>&nbsp;</p>
 
<p>&nbsp;</p>
 
<p>&nbsp;</p>
−
<h3>Additional Settings</h3>
+
<h4>Patient Conditions</h4>
 +
<table border="0">
 +
<tbody>
 +
<tr>
 +
<td><strong>Items</strong></td>
 +
<td><strong>Description</strong></td>
 +
</tr>
 +
<tr>
 +
<td>Minimum Length of Patient Identifier</td>
 +
<td>High level check whether the message details are valid to be inserted or updated in the MedITEX IVF database. If the length of the patient&rsquo;s identifier is less than defined, an insert or update will be refused.</td>
 +
</tr>
 +
<tr>
 +
<td>Age Range (min / max)</td>
 +
<td>High level check whether the current age in within the defined range.</td>
 +
</tr>
 +
<tr>
 +
<td>Minimum Set of Fields</td>
 +
<td>High level check whether the message details are valid to be inserted or updated in the MedITEX IVF database. If the incoming data has no values in the defined fields, an insert or update will be refused.</td>
 +
</tr>
 +
</tbody>
 +
</table>
 
<p>&nbsp;</p>
 
<p>&nbsp;</p>
−
<h4>Saving</h4>
+
<table border="0">
 +
<tbody>
 +
<tr>
 +
<td style="text-align: center;"><img src="/images/5HL7.png" alt="" width="598" height="401" /></td>
 +
</tr>
 +
</tbody>
 +
</table>
 
<p>&nbsp;</p>
 
<p>&nbsp;</p>
−
<h4>Patient Conditions</h4>
 
 
<p>&nbsp;</p>
 
<p>&nbsp;</p>
 
<h4>LAB Data Conditions</h4>
 
<h4>LAB Data Conditions</h4>
 +
<table border="0">
 +
<tbody>
 +
<tr>
 +
<td><strong>Items</strong></td>
 +
<td><strong>Description</strong></td>
 +
</tr>
 +
<tr>
 +
<td>Use first available Patient ID</td>
 +
<td>A HL7 message can provide more than one possible Patient ID because the same message can trigger several target systems wherein a Patient ought to be matched via it&rsquo;s ID.</td>
 +
</tr>
 +
<tr>
 +
<td>Use Patient ID associated with IdentifierTypeCode</td>
 +
<td>If provided more than one Patient ID, each of them should be followed by a so called &ldquo;Identifier Code&rdquo;-&nbsp; which is nothing else than a second match code to decide which of the given Patient IDs is the right one for your system.</td>
 +
</tr>
 +
<tr>
 +
<td>Save Parameters as &ldquo;Something else&rdquo; if they can not be matched</td>
 +
<td>
 +
<p>Laboratory parameters are divided into several parameter groups:</p>
 +
<p>Hormone, Serology, Clinical chemistry, Genetics, Microbiology or &ldquo;<strong>Something else</strong>&rdquo;. A laboratory parameter consists of a so called <strong>short form</strong>, a <strong>long from</strong>, a <strong>unit</strong> and a <strong>value</strong>. The short form must be transmitted within the HL7 message and defined in the target system &hellip; this is the way parameters are matched. If this matching fails the parameter can be imported as &ldquo;Something else&rdquo; - what in each case demands a following manual correction.</p>
 +
</td>
 +
</tr>
 +
<tr>
 +
<td>Import Notes from NTE Structure</td>
 +
<td>Additional information from the examining laboratory &ndash; as a non-formatted text - can be imported in memo fields of the target system.</td>
 +
</tr>
 +
<tr>
 +
<td>Abnormal Flags</td>
 +
<td>Defines whether a given parameter value is inside a normal range or outside. These flags can be used to change flags in the target system.</td>
 +
</tr>
 +
<tr>
 +
<td>Date Format</td>
 +
<td>
 +
<p>Describes the textual form of date and time information</p>
 +
<p>YYYY (year) MM (month) DD (day) HH (hour) NN (minute) SS (second)</p>
 +
</td>
 +
</tr>
 +
</tbody>
 +
</table>
 +
<p>&nbsp;</p>
 +
<table border="0">
 +
<tbody>
 +
<tr>
 +
<td style="text-align: center;"><img src="/images/6HL7.png" alt="" width="598" height="401" /></td>
 +
</tr>
 +
</tbody>
 +
</table>
 +
<p>&nbsp;</p>
 
<p>&nbsp;</p>
 
<p>&nbsp;</p>
 
<h3>DB Access</h3>
 
<h3>DB Access</h3>
 +
<p>Connection parameters to access the MedITEX IVF database:</p>
 +
<table border="0">
 +
<tbody>
 +
<tr>
 +
<td><strong>Item</strong></td>
 +
<td><strong>Description</strong></td>
 +
</tr>
 +
<tr>
 +
<td>Alias</td>
 +
<td>The database alias. Default is ART.</td>
 +
</tr>
 +
<tr>
 +
<td>Server</td>
 +
<td>
 +
<p>The server address on which the Firebird server runs.</p>
 +
<p>Default is 'localhost'&nbsp; (or 127.0.0.1).</p>
 +
</td>
 +
</tr>
 +
<tr>
 +
<td>Charset</td>
 +
<td>
 +
<p>The character set according to your language.</p>
 +
<p>Ask your support for additional help.</p>
 +
</td>
 +
</tr>
 +
<tr>
 +
<td>Client Library</td>
 +
<td>
 +
<p>The name of the Firebird client library.</p>
 +
<p>Default is fbClient.dll (older versions use gds32.dll).</p>
 +
</td>
 +
</tr>
 +
<tr>
 +
<td>Backup Start</td>
 +
<td>If a backup task is defined type in the start time. This leads to a smarter and faster check whether database changings can be processed.</td>
 +
</tr>
 +
<tr>
 +
<td>Backup End</td>
 +
<td>See description for point above.</td>
 +
</tr>
 +
<tr>
 +
<td>Force restart</td>
 +
<td>During the processing of HL7 messages the memory usage of the HL7-Server increases continuously &hellip; not much, but it does. Therefore the time when backup is running can be used for a save restart of the HL7-Server.</td>
 +
</tr>
 +
<tr>
 +
<td>DB Access</td>
 +
<td>
 +
<p>Strongly recommended:</p>
 +
<p>No access to database if backup is running should be checked!</p>
 +
</td>
 +
</tr>
 +
</tbody>
 +
</table>
 +
<p>&nbsp;</p>
 +
<table border="0">
 +
<tbody>
 +
<tr>
 +
<td style="text-align: center;"><img src="/images/7HL7.png" alt="" width="598" height="404" /></td>
 +
</tr>
 +
</tbody>
 +
</table>
 +
<p>&nbsp;</p>
 
<p>&nbsp;</p>
 
<p>&nbsp;</p>
 
<h3>Service</h3>
 
<h3>Service</h3>
−
<p>requires MexHL7Service.exe</p>
+
<p>(requires MexHL7Service.exe)</p>
 +
<table border="0">
 +
<tbody>
 +
<tr>
 +
<td><strong>Item</strong></td>
 +
<td><strong>Description</strong></td>
 +
</tr>
 +
<tr>
 +
<td>Install service</td>
 +
<td>Requires <strong>MexHL7Service.exe</strong> and provides a so called background service, with full functionality, no interface, no login necessary. If successfully installed you can see a new entry in your service panel: <strong>MexHL7 Service.</strong></td>
 +
</tr>
 +
<tr>
 +
<td>Uninstall service</td>
 +
<td>Uninstalls the MexHL7 Service.</td>
 +
</tr>
 +
<tr>
 +
<td>Start service</td>
 +
<td>Starts the MexHL7 Service.</td>
 +
</tr>
 +
<tr>
 +
<td>Stop service</td>
 +
<td>Stops the MexHL7 Service.</td>
 +
</tr>
 +
<tr>
 +
<td>Automatically Interface in notification area</td>
 +
<td>
 +
<p>Provides an icon in the taskbar that indicates that the service is running and provides a GUI for configuration and statistics. This won&rsquo;t work with the new Microsoft UAC technology &hellip; older operating systems like Windows XP support this feature.</p>
 +
<p><strong><em>Try it and if you don&rsquo;t see the MexHL7 Icon please uncheck this feature.</em></strong></p>
 +
</td>
 +
</tr>
 +
</tbody>
 +
</table>
 
<p>&nbsp;</p>
 
<p>&nbsp;</p>
−
<h3>Support</h3>
+
<table border="0">
 +
<tbody>
 +
<tr>
 +
<td style="text-align: center;"><img src="/images/8HL7.png" alt="" /></td>
 +
</tr>
 +
</tbody>
 +
</table>
 
<p>&nbsp;</p>
 
<p>&nbsp;</p>
 
<p>&nbsp;</p>
 
<p>&nbsp;</p>
 +
<h3>Support</h3>
 +
<p>You can send protocol, statistic and log files to your support.<strong> Fill this formular in order to provide a smart email generator. </strong></p>
 +
<table border="0">
 +
<tbody>
 +
<tr>
 +
<td><strong>Item</strong></td>
 +
<td><strong>Description</strong></td>
 +
</tr>
 +
<tr>
 +
<td>Your Name</td>
 +
<td>Type in any name you want to describe your clinic</td>
 +
</tr>
 +
<tr>
 +
<td>Your Email</td>
 +
<td>Your email addree</td>
 +
</tr>
 +
<tr>
 +
<td>Email Body</td>
 +
<td>Any email body</td>
 +
</tr>
 +
<tr>
 +
<td>Receiver</td>
 +
<td>
 +
<p>Default: <a href="mailto:support@critex.de">support@critex.de</a></p>
 +
</td>
 +
</tr>
 +
</tbody>
 +
</table>
 +
<p>&nbsp;</p>
 +
<table border="0">
 +
<tbody>
 +
<tr>
 +
<td style="text-align: center;"><img src="/images/9HL7.png" alt="" width="598" height="404" /></td>
 +
</tr>
 +
</tbody>
 +
</table>
 
<p>&nbsp;</p>
 
<p>&nbsp;</p>
 
<p>&nbsp;</p>
 
<p>&nbsp;</p>

Revision as of 09:49, 9 September 2013

 

Contents

Scheme

<tbody> </tbody>
MedITEX HL7 Importer - Scheme

 

Configuration

General Settings

<tbody> </tbody>
General On/Off-Switch Activates or deactivates the HL7-Server

MedITEX IVF:

PMI_HL7 active

 Indicates whether your IVF tool is preconfigured for the import of additional patients data and therefore provides a special interface.
Protocol Level

Default setting is 'Errors, Hints and Debug Information'.

After the testing phase please switch to 'Only Errors' in order to reduce traffic and data storage.
IP-Address The IP address of the server where Importer is running.
Default is 'localhost' (or 127.0.0.1)
Number of Instances Defines the number of asynchronous communication queues (threads). Default is 1.
Number of Interfaces

Defines the number of protocols that can be interpreted.

Default is 1 (HL7)
Listen queue (max) The maximum of entries in the listener buffer (FIFO buffer).
Terminate wait time Defines the maximum delay in milliseconds to receive messages from the queue. Default is 10000 msec.
Thread delay Defines the delay in milliseconds to give work time for other treads. Default is 100 msec.
Reply ACK delay

Defines the delay in milliseconds to finish a processed message.

Default is 250 msec.

 

<tbody> </tbody>
<img src="/images/1HL7.png" alt="" width="598" height="404" />

 

 

COM Definitions

<tbody> </tbody>
Tab Item Description
Instances Instance Nr. Automatic counter
Active Yes or No
Port The client - server communications port
Interfaces Interface Nr. Automatic counter
Active Yes or No
Protocol Active protocol (In this version only HL7. In future versions also XML and SOAP)
Version Active version
Libary The name of the DLL which coummunicates with the database (Database-IN module)

 

<tbody> </tbody>
<img src="/images/2HL7.png" alt="" width="598" height="404" />
<img src="/images/3HL7.png" alt="" width="598" height="401" />

 

 

Additional Settings

Additional settings to save log files, make statistics and check the consistency of incoming data.

Saving

<tbody> </tbody>
Item Description
Save Level

Each processed message can be saved with more or less information.   Default is “Errors, Hints and Debug Information”.

After the testing phase switch to “Only Errors”.
Save info for statistics An additional feature to gain statistical information of the processed messages.
Automatically load protocol file An additional feature to display then message processing in the user interface of MexHL7Importer. The output will be according to the selection in section “Save Level”.

 

<tbody> </tbody>
<img src="/images/4HL7.png" alt="" width="598" height="401" />

 

 

Patient Conditions

<tbody> </tbody>
Items Description
Minimum Length of Patient Identifier High level check whether the message details are valid to be inserted or updated in the MedITEX IVF database. If the length of the patient’s identifier is less than defined, an insert or update will be refused.
Age Range (min / max) High level check whether the current age in within the defined range.
Minimum Set of Fields High level check whether the message details are valid to be inserted or updated in the MedITEX IVF database. If the incoming data has no values in the defined fields, an insert or update will be refused.

 

<tbody> </tbody>
<img src="/images/5HL7.png" alt="" width="598" height="401" />

 

 

LAB Data Conditions

<tbody> </tbody>
Items Description
Use first available Patient ID A HL7 message can provide more than one possible Patient ID because the same message can trigger several target systems wherein a Patient ought to be matched via it’s ID.
Use Patient ID associated with IdentifierTypeCode If provided more than one Patient ID, each of them should be followed by a so called “Identifier Code”-  which is nothing else than a second match code to decide which of the given Patient IDs is the right one for your system.
Save Parameters as “Something else” if they can not be matched

Laboratory parameters are divided into several parameter groups:

Hormone, Serology, Clinical chemistry, Genetics, Microbiology or “Something else”. A laboratory parameter consists of a so called short form, a long from, a unit and a value. The short form must be transmitted within the HL7 message and defined in the target system … this is the way parameters are matched. If this matching fails the parameter can be imported as “Something else” - what in each case demands a following manual correction.
Import Notes from NTE Structure Additional information from the examining laboratory – as a non-formatted text - can be imported in memo fields of the target system.
Abnormal Flags Defines whether a given parameter value is inside a normal range or outside. These flags can be used to change flags in the target system.
Date Format

Describes the textual form of date and time information

YYYY (year) MM (month) DD (day) HH (hour) NN (minute) SS (second)

 

<tbody> </tbody>
<img src="/images/6HL7.png" alt="" width="598" height="401" />

 

 

DB Access

Connection parameters to access the MedITEX IVF database:

<tbody> </tbody>
Item Description
Alias The database alias. Default is ART.
Server

The server address on which the Firebird server runs.

Default is 'localhost'  (or 127.0.0.1).
Charset

The character set according to your language.

Ask your support for additional help.
Client Library

The name of the Firebird client library.

Default is fbClient.dll (older versions use gds32.dll).
Backup Start If a backup task is defined type in the start time. This leads to a smarter and faster check whether database changings can be processed.
Backup End See description for point above.
Force restart During the processing of HL7 messages the memory usage of the HL7-Server increases continuously … not much, but it does. Therefore the time when backup is running can be used for a save restart of the HL7-Server.
DB Access

Strongly recommended:

No access to database if backup is running should be checked!

 

<tbody> </tbody>
<img src="/images/7HL7.png" alt="" width="598" height="404" />

 

 

Service

(requires MexHL7Service.exe)

<tbody> </tbody>
Item Description
Install service Requires MexHL7Service.exe and provides a so called background service, with full functionality, no interface, no login necessary. If successfully installed you can see a new entry in your service panel: MexHL7 Service.
Uninstall service Uninstalls the MexHL7 Service.
Start service Starts the MexHL7 Service.
Stop service Stops the MexHL7 Service.
Automatically Interface in notification area

Provides an icon in the taskbar that indicates that the service is running and provides a GUI for configuration and statistics. This won’t work with the new Microsoft UAC technology … older operating systems like Windows XP support this feature.

Try it and if you don’t see the MexHL7 Icon please uncheck this feature.

 

<tbody> </tbody>
<img src="/images/8HL7.png" alt="" />

 

 

Support

You can send protocol, statistic and log files to your support. Fill this formular in order to provide a smart email generator.

<tbody> </tbody>
Item Description
Your Name Type in any name you want to describe your clinic
Your Email Your email addree
Email Body Any email body
Receiver

Default: <a href="mailto:support@critex.de">support@critex.de</a>

 

<tbody> </tbody>
<img src="/images/9HL7.png" alt="" width="598" height="404" />

 

 

<tbody> </tbody>
<a href="/index.php?title=Main_Page">Back to MedITEX products </a> <a href="#top">Back to top</a>