Description
Use the Interface Configuration page to activate and configure the inbound and/or outbound interface between the system and the selected host. Note that inbound and outbound refer to the direction the message travels from the host's perspective. Depending on the settings for your HL7 interfaces, the system may have the ability to auto-create locations and practices from HL7 interfaces' messages. This feature performs the same functionality as when synchronization (with Orchard Harvest) auto-creates a location or practice. This setting can only be enabled by Orchard Software personnel.
Select on the tab that corresponds to the task you wish to perform.
- Inbound Interface: Use the Inbound Interface tab to configure the interface parameters for all messages received by the system.
- Outbound Interface: Use the Outbound Interface tab to configure the interface parameters for all messages sent by the system.
- Miscellaneous: Use the Miscellaneous tab to configure the host-specific HL7 parameters.
- Documentation: Use the Documentation tab to record interface setting information.
Access
AdminCenter > System Setup > Hosts > Interface Configuration button
You must have the necessary security permissions to access this page.
Technical Manual
Inbound Interface Tab
Setting Up the Inbound Interface
Use the Interface Connectivity Settings (messages received by the system) section of the Interface Configuration page to configure the interface parameters for all messages received by the system. Select the hide section link to hide the Interface Connectivity Settings. Select the show section link to display the Interface Connectivity Settings.
Inbound is active | Select the checkbox to activate the inbound interface. Clear this checkbox if the inbound interface is not set. |
---|---|
Delay processing messages for __ seconds | Enter in the field the number of seconds the system should wait before processing messages in the Inbound Queue. Enter 0 to have the system immediately process incoming messages. |
Send ACK to Host | Select one or more ACK settings for the interface:
|
Parse these message types | Select one or more options to configure the framing characters of your HL7 transmissions.
|
Allow Duplicate MSH Control IDs | Select the checkbox to allow the system to accept duplicate control IDs (contents of MSH-10) on incoming HL7 messages. |
Inbound Mapper Script | Select an option from the drop-down list to use a Mapper script to convert data from one format to another.
|
Linked Order Document Path | Enter in the field the file path to the directory where the system should look for files to add as order-level attachments (not as results). The names of these files should contain either the system order ID or a system sample ID that is unique to a single order sent to a host. The system uses this file name to identify the order to which it should attach the new files. The host's inbound interface must be set as active for the system to import these files. The system currently supports PDF, JPG, GIF, and BMP file types. Files must have one of the listed extensions for the system to process them properly. Select the Test button to verify the file path. Note If the file name contains an integer and is delimited by an underscore (_), the system will accept multiple files at the same time for a single order. When the system finds files in this directory, it moves the files from the directory to the Inbound Queue, where it processes them, and allows you to view the file and edit the file name. See the Inbound Queue topic. When it finds a match, the system attaches the file to the order, and it marks as "failed" the files that it cannot attach to the intended order. If there is a problem attaching the files to the order, you may view the error on the Inbound Queue page. |
Linked Result Document Path | Enter in the field the file path to the directory where the system should look for files to attach as results to existing orders. The names of these files should contain sample ID, patient first name, and patient last name; be separated by an underscore character ("_"), and be listed in that order. The system uses this file name to identify the order to which it should attach the new results from the file. The system currently supports PDF, JPG, GIF, and BMP file types, as well as HPDF files, which are result files sent from Orchard Harvest. Files must have one of the listed extensions for the system to process them properly. Select the Test button to verify the file path. Wait to pick up file __ seconds: Enter in the field the number of seconds the system should wait before picking up linked result documents out of the configured directory in the Linked Result Document Path field. Note If the file name contains an integer and is delimited by an underscore (_), the system will accept multiple files at the same time for a single order choice. When the system finds files in this directory, it moves the files from the directory to the Inbound Queue, where it processes them, and allows you to view the file and edit the file name. See the Inbound Queue topic. When it finds a match, the system generates an order choice and test called "Attachments" for the order, and it marks as "failed" the files that it cannot attach to the intended order. If there is a problem with the embedded header information of an HPDF file, you may edit it on the Inbound Queue page when looking at the details of one of the entries. If you have established an Linked Result Document Path, you may also establish the following settings:
|
Inbox Document Path | Enter in the field the file path to the directory where the system should look for files to attach as inbox documents. |
Linked Patient Document Path | Enter in the field the file path to the directory where the system should look for files to attach to existing patients. The names of these files should contain one of the following: the patient's host code for this host, an order ID for the patient that has had at least one sample routed to this host, or a sample ID on an order for the patient that has had at least one sample routed to this host. The system uses this file name to identify the patient to which it should attach the new documents. Note that if a document's file name matches multiple patient records, the system will not link the document. |
Message Forwarding | Select the button to set up message forwarding from one host to another using the Message Forwarding page. See the Message Forwarding topic. |
None | Select the option to switch the database setting back to turn off the MLP or File Transfer options. This is selected by default. |
MLP (TCP/IP sockets) | Select the MLP (TCP/IP sockets) option to use the TCP/IP interface to transfer messages. Use the following fields to further configure the interface:
|
File Transfer | Select the option to use flat files to transfer messages. Complete the following fields to set up a shared directory structure.
|
Web Service | Select the option to transfer messages via an HL7 interface. Complete the following fields to further configure the interface:
|
Orchard Device Engine | Select the option to transfer messages via Orchard Device Engine. Device Engine File Transfer Interface: Search for and select an ODE interface using the search-as-you-type field. Select OK to save the change. File Extension: Enter the file extension of the files being sent. This field is required. |
Allow to run multi-threaded with a maximum thread count of __ | Select the option and enter a number to have the system parse multi-threaded inbound messages for a single host. The number you enter defines the maximum number of threads the system parses in inbound messages. The default value is 5. |
Allow Fix Order and Fix ADT entries to be automatically rerun for this host after 5 minutes | Select the checkbox to automatically rerun the entries on the Fix Orders and Fix ADT administration pages once. This will cause the entries associated to that host on the Fix Orders and Fix ADT administration pages to automatically rerun as if the Rerun button was selected once after five minutes. Once it has been automatically rerun, it will not rerun again unless manually selected. |
Use ORC format | Select the checkbox to enable the system to transmit or receive ORC segments. Clear the checkbox to restrict the system from sending or receiving ORC segments. |
ADT Parsing Settings
Hide section Show section | Select the hide section link to hide the ADT Parsing Settings options. Select the show section link to display the options. |
---|---|
Hold ADT messages (A04 and A08) for at least ___ seconds and then parse the most recent message for that patient | Select the checkbox to reduce the number of ADT messages that an interface will parse for each patient. This setting allows the user to configure how long the system should wait before it parses an ADT message (this applies to A04 and A08 ADT messages). During that time, the system will only determine if a more recent ADT message has been received for that patient and mark that more recent message as the one that should be parsed once the wait time period has expired. The intended use of this feature is to decrease the number of ADT messages that must be parsed for each patient when the source of the ADT messages is particularly "chatty." If the different messages reference different encounter IDs, then each of the messages with different encounter IDs will be parsed. |
Use location to identify practice for ADT | Select the checkbox to have the system look at the location designated in the PV1 segment when the ADT message is received and determine which practice that location belongs to. It will then use that practice for the patient. |
Delete encounters for A11 and A38 ADT messages | Select the checkbox to have the system delete the referenced encounter and all references to the encounter on orders when it parses an ADT message from the selected host with an event type of either A11 or A38. |
Limit orders updated by ADT A02 messages to orders with a matching encounter | Select the checkbox to limit orders updated by transfer ADT (A02) messages to those with the same encounter. |
Update patient open orders when ADT A02 and A08 change default patient insurance set | Select the checkbox to control if a patient's open orders should have their insurance information updated when the system parses an A02 or A08 ADT message from that interface for that patient. In order to utilize the ADT A08 counterparts, you must have this setting enabled. Do not change the billing status of open orders: When enabled, A02 and A08 messages that change a patient's open, uncollected order's insurance will not reassign their billing statuses. |
Update patient open orders when ADT A02 updates Ordering Location | Select the checkbox to update the ordering location for non-final orders for a patient when that patient's linked location changes via an ADT transfer message. Only orders that have an ordering location of the patient's previous linked location are considered. Update patient open orders when ADT A08 updates Ordering Location: This checkbox is used the same as the ADT A02 setting, but for ADT A08 messages. |
Update patient open orders when ADT A02 updates encounter room number | Select the checkbox to update the room number of all open orders assigned to the encounter when the system parses an ADT A02 message that updates an encounter room number. Update patient open orders when ADT A08 updates encounter room number: This checkbox is used the same as the ADT A02 setting, but for ADT A08 messages. |
Update patient open orders when ADT A02 updates Collection Location | Select the checkbox to update a collection location on all open orders when a new collection location is received in an ADT A02 message. Update patient open orders when ADT A08 updates Collection Location: This checkbox is used the same as the ADT A02 setting, but for ADT A08 messages. |
Store encounter diagnosis code mappings from ADT messages | Select the checkbox to have the system parse DG1 segments from ADT messages and add them to the corresponding encounter. |
ADT with no insurance means that the patient has no insurance | Select the checkbox to control whether or not the system should interpret that the lack of insurance information in an ADT message means that the patient has no insurance. This option is selected by default. Clear this option to have the system assume that ADT messages with no insurance mean that the patient will still use their latest default insurance. This setting controls when HL7 messages can "unset" the patient's default insurance set, which can only occur due to an ADT message. Only apply to A04, A08, and A31 ADT messages: Select the checkbox to have only A04, A08, and A31 ADT messages without insurance set the patient to have no insurance. Leave the checkbox clear to set the patient to have no insurance if any ADT messages are without insurance. |
Get insurance priority from IN1-22 | Select the checkbox to have the system set the insurance priority based on the value of the IN1-22 field in HL7 transmissions. The system allows the following values to indicate priorities: 1, P, or p for Primary; 2, S, or s for Secondary; 3, T, t for Tertiary. The system considers IN1-22 values valid if no duplicate priorities exist, and it supports up to three IN1 segments (discarding any additional segments). Note that tertiary values cannot exist without secondary, secondary cannot exist without primary, and primary must exist. If IN1-22 does not contain valid values, then the system determines priority using the order in which the IN1 segments are received. |
Minimum Valid Year | Enter a year value in to the field to specify the earliest year that the interface will accept. The interface ignores dates earlier than this value, treating the field as if there was no date value. The default entry for this field is 1800. |
Match on active insurance only | Select the checkbox to have the system match inbound insurance company/plan on active-only entries. |
Remove demographics data when field holds empty double quotes | Select the checkbox to allow HL7 messages to designate that the system should remove a demographics value from the database. Normally, the system only replaces an existing piece of demographics data with a new value that is not blank. However, when this setting is enabled, if there are empty double quotation marks ("") in a patient demographics field, then the system designates that that piece of information should be removed from the system database. |
Auto-fill Guarantor Insurance information with Primary Insured when parsing GT1 segments with a relationship to Patient to "Self" | Select the checkbox to have the system populate a specified host with the Primary Insured Information if the relationship is set to Self when any new blank guarantors are parsed in from the specified host. |
Accept transgender values for patient sex to this host | Select the checkbox to have the system accept the defined transgender value for the patient's sex from the host (e.g., M/F instead of M or F/M instead of F). When transgender values are disabled, the system interprets M/F as M and F/M as F. Note that if this setting is turned off for an interface, the system receives M or F, and the matching patient is actually the corresponding transgender value, the system will not change the patient's sex. |
Ignore expired insurances based on the date in IN1-13 | Select the checkbox to have the system ignore expired insurances sent in HL7 messages and will not be used as any of the patient's insurances. The determination of whether or not the insurance is expired is based off the date and time sent in IN1-13. If IN1-13 does not contain a date, then the insurance will also be treated as expired. |
Accept ADT change patient identifier messages (A47) | Select the checkbox to allow this host to receive ADT A47 HL7 2.5.1 messages. The A47 messages are used to change the patient's identifiers. |
ORM Parsing Settings
Use location and Sender's PID to identify patient | Select the checkbox to require the interface to look at the ordering location value (PV1-3.4.2) to identify in which practice to look for the Sender's patient ID. If the interface cannot find a match, it creates a new patient record in the specified practice when it creates orders from results. |
---|---|
Use location and Sender's PID to identify patient for SN messages | Select the checkbox to enable Use location and Sender's PID to identify patient to apply to SN messages. |
Match order components for a patient by | Select an option from the drop-down list to configure how the system determines how to group orders sent from a host into one order. Depending on what is selected, you may also set one or both of the following options.
Create duplicate order if matching order is received with different Placer Order Number: Select this option to allow the system to create new orders instead of disregarding matching orders as duplicates. When this is enabled, if the system receives an order message that would match to an already existing order, that order choice already exists on the order, that order choice cannot exist more than once on the order, and the placer order number is different than the existing order choice, then the system creates a new order. Create duplicate order if matching order choice is received with different Placer Order Number for cancelled order choice: Select this option to allow the system to create new orders instead of disregarding matching orders as duplicates for cancelled orders with different Placer Order Numbers. Uncancel order choice if matching order choice is received with the same placer ID for cancelled order choice: Select this checkbox to uncancel order choices by sending an ORM with the same placer ID as the cancelled order choice. Allow creation of multiple orders from a single ORM message: Select this option to create more than one new order when parsing a single ORM message. It is selected/enabled by default. Copy ordering provider to existing order as result recipient when order message is deemed a duplicate and is disregarded: Select this option to have the system allow an ordering provider to be added as a report recipient on an existing order when a duplicate order message for that patient is received. Force separate orders to be created based on ordering provider: Select this option to prevent electronic orders from combining with other orders if the designated ordering provider is different. When this setting is turned on, an electronic order will not be allowed to combine with an existing order, nor with an additional order in the same message if they do not specify the same ordering provider. Force separate orders to be created based on recurrence information: Select this option to prevent electronic orders from combining with other orders if the designated recurrence information is different. When this setting is turned on, an electronic order will not be allowed to combine with an existing order, nor with an additional order in the same message if they do not specify the same recurrence information. Force separate orders to be created based on proposed collection time: Select this option to prevent electronic orders from combining with other orders if the designated proposed collection date/time is different. When this setting is turned on, an electronic order will not be allowed to combine with an existing order, nor with an additional order in the same message if they do not specify the same proposed collection time. Favor matching based on order choice existing on order: Select this option to have the system attempt to match newly-ordered order choices with orders that contain the same order choice rather than just the first order found when matching orders within a five minute window. |
Use time range to match order when processing cancel order choice messages | Select the checkbox to prevent the system from using a time range constraint when finding a matching order choice for an HL7 cancellation message. |
Apply the following four, order choice status-based cancel restrictions to order recurrences (via Discontinue Message) instead of only cancelling order choice recurrences with no results | Select the checkbox to allow the cancellation message settings to be applied to the discontinued (DC) message behavior. |
Process cancel order choice messages | Select one or more options from the section to control when it is acceptable for the system to process cancellation HL7 messages received from a host. If no samples on the order have been marked collected: Select this option to only allow orders to be cancelled if the entire order is uncollected. If even one order choice on the order has been collected, the order can no longer be cancelled. Note that this setting will be overridden by all of the other settings in this section, so it is recommended that only this setting should be turned on if it is used. If the order choice has not been collected: Select this option to allow the system to process cancel order messages if the order choice has not been collected. If the order choice has not been released: Select this option to allow the system to process cancel order messages if the order choice has not been released. If the order choice is collected and no result has posted to it: Select this option to allow the system to process cancel order messages if the order choice is collected and no result has posted to it. If a preliminary result has posted to the order choice: Select this option to allow the system to process cancel order messages if a preliminary result has posted to the order choice. If a final result has posted to the order choice: Select this option to allow the system to process cancel order messages if a final result has posted to the order choice.
Only if this is the ordering host or if testing is routed to this host: Select this option to allow the system to process cancel order messages only if this is the ordering host, or if testing is routed to this host. |
Discontinue messages should only remove order choices in the message when an order has more than one order choice | Select the checkbox to discontinue messages for standing orders with more than one order choice on the order and to not cancel all recurrences of the order and will instead completely delete the order choices in the message from the specific order that the message corresponds to. When cleared, and there is only one order choice on the order, or the message contains all order choices on the order, previous functionality is maintained. |
Process most recent order match for cancel order choice messages | Select the checkbox to have the system process the most recent order match for cancel order choice messages. |
Reactivate order choice when an order request message is parsed for a cancelled order choice | Select the checkbox to have the system reactivate an order choice when an order request message is parsed for a cancelled order choice. |
Match using the filler order number if no match is found using the placer order number for cancel order choice messages | Select the checkbox to have the system match using a filler order number if there is no match found when using the placer order number for a cancel order choice message. Select the checkbox to have the system match cancellation messages to orders using the system order ID with the value in ORC-3 and OBR-3 if no match is found using ORC-2 and OBR-2. When this setting in selected for a host and an inbound order cancellation message has no match using the value in ORC-2 and OBR-2, the system will attempt to match the cancellation message to an order on the system order ID using the value in ORC-3 and OBR-3. The message will then be processed normally. |
Allow cancelling of order choices when placer ID matches on multiple orders | Select the checkbox to have the ability to cancel order choices with the same placer ID on multiple orders. When this setting is enabled, an ORM(CA) will be able to cancel order choices on multiple orders that match the placer ID given in the message. |
Accept standing order messages | Select the checkbox to allow this interface to create standing orders. It will not be able to do so, unless you enable this setting. |
Get value for Ordering Location | Select an option from the drop-down list to choose from which PV1 or ORC field the system should pull the ordering location from. Select either from PV1 field 3, from ORC field 13, or from ORC field 21. The default option for this drop-down option is from PV1 field 3. |
Get value for Collection Location | Select an option from the drop-down list to choose from which PV1 or ORC field the system should pull the collection location from. Select either from PV1 field 3, from ORC field 13, or from ORC field 21. The default option for this drop-down option is from PV1 field 3. |
Get value for Order Choice Expiration Date | Select an option from the drop-down list to choose from which OBR field the system should pull the order choice expiration date from. Select either Never or from OBR field 27.5. The default value is Never. |
Get value for MRN# | Select an option from the drop-down list to choose from which PID field the system should pull the patient MRN# when the patient's demographics are being updated (or created). |
Get value for Patient ID #2 | Select an option from the drop-down list to choose from which PID field in HL7 inbound messages the system should pull the value to put into the Patient ID #2 field. You may view or edit alternate patient IDs by selecting the More button next to the Patient ID field on the Demographics page. See the Demographics topic. |
Get value for Patient ID #3 | Select an option from the drop-down list to choose from which PID field in HL7 inbound messages the system should pull the value to put into the Patient ID #3 field. You may view or edit alternate patient IDs by selecting the More button next to the Patient ID field on the Demographics page. See the Demographics topic. |
Get value for Proposed Collection Time | Select an option from the drop-down list to choose from which field in HL7 inbound messages the system should pull the value to put into the Proposed Collection Time field. You may choose not to parse the value (default behavior), or to parse it from OBR-7, OBR.27-4, ORC-9, or ORC-15. |
Get value for Collection Time | Select an option from the drop-down list to choose from which field in HL7 inbound messages the system should pull the value to put into the Collection Time field. You may choose to parse it from the default (OBR-7), or to parse it from OBR-27.4, ORC-9, or ORC-15, or to not parse the value. Update Draw Completion Date/Time stored on the order: Select either Never, When received value exists, or When received value is more recent from the drop-down list to update the order-level draw complete stamp at the requisition level when receiving result messages. The parent setting Get value for Collection Time must not be set to Never. It utilizes that setting to determine where to find the date/time to use. Note This setting cannot be used in conjunction with the other sub-setting Get value for Collection Time because of the requirement of the parent setting to not be Never. This setting also does not affect the specimen-level draw date/time, only the order-level draw completed date/time. Allow old behavior to parse Collection Time from OBR-7 for specific cases: Select the checkbox to control whether old behavior should be retained for parsing a collection time when parsing HL7 messages. If the preceding Get value for Collection Time setting is set to Never, the user can now choose whether the system tries to parse a value from ORC-7.4 or not. If the setting Get value for Collection Time is not set to Never, this setting is not utilized. |
Get value for Order Time | Select an option from the drop-down list to choose from which field in HL7 inbound messages the system should pull the value to put into the Order Time field. You may choose to parse it from the default (OBR-27.4), or to parse it from OBR-7, ORC-9, or ORC-15, or to not parse the value. |
Get value for order choice Cancel Time | Select the drop-down list to select a value for order choice cancel time. Select either Never, Use date/time of parse, in OBR field 7, in OBR field 27.4, in ORC field 9, or in ORC field 15 from the drop-down list. Allow Order Time to update from inbound change order messages: Select the checkbox to allow the system to update the order date from a change message. This setting will cause the order date to be parsed from the setting Get value for Order Time. |
Match Orders for inbound change order messages in a window plus or minus ___ | Select the checkbox followed by a value from the drop-down list. This setting will allow the user to expand or contract the time window within which orders are queried for when the inbound queue is applying an order change message to an order. This setting will default to 28 days. You may select either Minutes, Hours, or Days from the drop-down list. The default selection is Days. |
Get value for Ordering Staff | Select an option from the drop-down list to choose from which field in HL7 inbound messages the system should pull the value to put into the Entered By field. You may choose to parse it from the default (ORC-10), or to parse it from (OBR-10), or to never parse it. |
Get value for Provider NPI | Select an option from the drop-down list to choose from which field in HL7 inbound messages the system should pull the value to put into the ORC field. Select from ORC field 12.1 from the drop-down list. Select this option to enable the Only if Provider NPI is blank checkbox. Only if Provider NPI is blank: Select the checkbox to have the system update an ordering provider's NPI value based on an inbound ORM HL7 message. |
Clinical Information delimiter in OBX-5 | Select an option from the drop-down list to define a delimiter for clinical information. Select either , or ; from the list. |
Get value for Billing Status from IN1 field 32 | Select the checkbox to have the system read Billing Status out of the IN1 segment field 32. Since this is an Order-level field, and Billing Status is set per Order Choice, the Billing Status found in the first IN1 segment only will be set as the Billing Status for all Order Choices in the message. |
Do not remove existing ICD codes from an order choice when processing a change order message | Select the checkbox to have change order messages add only new ICD codes received; when this setting is enabled, the system will not remove any of the ICD codes currently tied to the order choices to an order. |
Hold order messages for at least __ seconds to allow order choices for a patient to accumulate before ORM message parsing | Select the checkbox and enter a value to accumulate order messages (ORM) from a host for a specified amount of time and then parse all accumulated orders for each patient as a single order message. |
Prevent sample creation during ORM message parsing if the sample is not to be marked as collected | Select the checkbox to prevent the system from creating sample records for inbound ORM messages, as long as the sample would not be marked as collected. |
Use the host-specified PV1-50 value (if not blank) as the system's order ID when creating an order | Select the checkbox to have the system allow an order ID override value to be parsed from an HL7 order message from the PV1-50 field. If the order ID that is about to be used is not unique, then an order-level comment will be saved to the order that uses a system-generated order ID instead. Send to the Fix Order queue if the host-specified value is not unique: Select the checkbox to have the system force the message being parsed to be placed in the Fix Orders queue if the parsing of the message would have resulted in a new order being created with a system-generated ID due to the received order ID override already existing as an order ID in the system. Combine with an existing order if the received PV1-50 value matches the order's order ID: Select the checkbox to have the system combine the host value with an existing order if they received value matches the order ID. When both settings are turned on, ORM messages sent by the host with a PV1-50 value specified will combine with an existing order if the PV1-50 value matches the existing order's order ID. This setting requires an Orchard Superuser to enable/disable it for use. |
Use the host-specified filler order number (if not blank) as the system's sample ID when creating an order | Select the checkbox to make the system use the filler order number (ORC-3, OBR-3) as the system's sample ID. When this option is enabled and an order message from a host has the filler order number filled in, the system uses this ID as the system sample ID. If this setting is enabled and the filler order number field is blank, then the system will look to see if the Use this host's sample ID as the system's sample ID when creating an order host setting is turned on in order to determine the sample ID (see below). You may use both of these settings at the same time. If neither of these are available, the system will attempt to use the host's lab-specific setting to use the ordering host's sample ID as the system sample ID for samples routed to that lab. Do not use host-specified filler order numbers on split orders: Select the checkbox to have the system not use host-specified filler order numbers on split orders. |
Use this host's sample ID as the system's sample ID when creating an order | Select the checkbox to have the system use the external host's sample ID as the system's sample ID for any samples created for orders coming from this inbound interface, unless the Use the host-specified filler order number (if not blank) as the system's sample ID when creating an order checkbox is enabled (see above). If neither of these are available, the system will attempt to use the host's lab-specific setting to use the ordering host's sample ID as the system sample ID for samples routed to that lab. Note that the system will not perform duplicate ID checking at the time of sample ID assignment. It will detect duplicates when the results post to the Match Results page instead of posting to the proper order. |
Do not allow order choices with different collection times to combine onto the same sample when creating orders from order messages | Select the checkbox to have the system prevent order choices from being combinable, if they are received via electronic order and have different collection times. |
Do not allow order choices to combine onto collected samples when creating orders from order messages | Select the checkbox to have the system prevent an order choice that attaches to an existing order from combining with a sample that has already been marked as collected. Does not apply when rerouting on Release Samples: Select to ignore the non-combinability from the Do not allow order choices to combine onto collected samples when creating orders from order messages setting, specifically when rerouting on Release Samples. It will be treated as if the setting is unchecked. |
Parse blank values for patient fasting from result messages | Select the checkbox to have the system control whether or not to interpret a blank fasting value from result messages. With this new setting, the user can turn this functionality off and the system will ignore any blank fasting values in result messages. This setting is turned on by default. |
Display inbound parsed order choice comments on requisition and manifest | Select the checkbox to have the system display inbound parsed order choice comments on requisitions and manifests. |
Send inbound parsed order choice comments to host electronically | Select the checkbox to have the system send inbound parsed order choice comments to the host electronically. |
Parse patient comments from ORM and ORU messages | Select the checkbox to have the system control when patient comments are sent out and parsed in. For the Inbound Settings, the new setting Parse patient-level comments from messages will determine whether patient comments are expected and subsequently parsed in for Inbound messages. For the Outbound Settings, the Send patient comments out as NTE segments setting will dictate whether to send out patient comments as NTEs in outbound messages. |
Automatically associate ordering provider with ordering location's practice when parsing order messages | Select the checkbox when an order message is received by the system where the ordering provider in the message is not a member of the ordering location's practice, the provider will automatically be added to that practice. |
Default ABN Signed Status | Select an option from the drop-down list to assign the default ABN signed status for orders received via HL7. When determining a signed status contained in an HL7 segment, the system uses this setting's value if either the HL7 segment does not contain a signed status designator, or the designator in the HL7 segment is not something recognized by the system. Force match on: Select an option from the drop-down list to force a match based on the order ID and the value received in PV1-50 when reactivating a cancelled order choice by SN message. Select either Received filler order number or Order ID to value in PV1-50 from the drop-down list. |
Signed Don't Bill ABN OBR Code | Enter the value the system will send and expect to receive in the OBR-45 HL7 field in the Signed Don't Bill ABN OBR Code field when the ABN status is Signed/Don't Bill. The default value is GA. Note that when both Signed and Signed/Don't Bill use the same code, Signed takes precedence. |
No ABN Required ORC Code | Enter a value to control the code that the system uses in the ORC-20 HL7 field in the No ABN Required ORC Code field to indicate that an ABN is not required. This code does not take precedence over the existing HL7 defined codes of 1, 2, 3, and 4. The default value is 1. Note that you should normally set this to 0 (zero) for Orchard Harvest interfaces. |
Interpret blank value for patient fasting as ____ when creating an order | Select an option from the drop-down list to set the default fasting status for new orders received via HL7. The system will only apply this value if it does not receive a fasting status (i.e., OBR-13 is blank). Note that the default fasting value for orders entered on the Order Patient Samples page is controlled by a setting on the Locations administration page. See the Locations topic. |
Get value for Account Number | Select an option from the drop-down list to set where the system reads account numbers from result messages and associates them with a match result entry. |
Update a user's Provider setting using MFI-1 in MFN messages | Select the checkbox to control whether or not the parser will update the Provider setting. By default it will not parse the Provider setting updates. |
Copy clinical information | Select an option from the drop-down list to specify when the system should copy clinical information. Select either never, from previously saved order choices, or from any order choices. Never is the default selection for this setting. |
Parse medication OBXs with host code | Enter a host code into the field to specify what host code should be parsed with the medication OBX messages. The recommended value for this host code is "18816-9," which is a LOINC code for medications, but the host code can be set to whatever is desired as long as it is not used by any clinical information questions. |
Do not automatically create new medications | Select the checkbox for a host when medications are received on an inbound HL7 messages that does not exist in the system's database. It will not be automatically created if this setting is applied. |
Parse NK1 segments | Select the checkbox to parse NK1 segments. If this setting is turned off, NK1 segments will not be parsed. This setting applies to both HL7 classic messages containing veterinary owner information in NK1 segments and HL7 2.5.1 messages containing next of kin information in NK1 segments. The setting will default to being set for veterinary systems, and not being set for all other systems. In the drop-down list, select either
|
Assign the patient's most recent active encounter to new orders without encounter information | Select the checkbox to automatically assign the newest active encounter to orders created by ORM or ORU HL7 messages if the HL7 message did not contain any encounter information for the order. The setting defaults to not being set. |
Assign the message's phlebotomist to the attached order choice's samples for SN messages | Select the checkbox to use the SN message's phlebotomist for any attached order choice's samples. If the SN message does not contain a phlebotomist, then the current behavior will be maintained. Only the attached order choice in the message will have its phlebotomist set to the message's value, all other order choices on the requisition will remain unchanged, and the requisition's proposed phlebotomist will also remain unchanged. Additionally, the phlebotomist from the message will be used for the order entry rules current phlebotomist condition when the order entry rules run for the attached order choice. |
Use the sample type in OBR-15 to select the collection information on new order choices | Select the checkbox to have the inbound ORM messages that create a new order choice determine the collection information to use based upon the sample type in OBR-15. If the sample type matches the order choice's default collection set, the default collection set will be used. If the sample type does not match the default collection set, but does match one or more of the alternate collection sets, the first alternate collection set with the sample type will be used for the order choice. If the sample type does not match any collection set on the order choice, the default collection set will be used. The sample type received for the order choice will not be used to determine the collection set if a user manually changes the collection set for the order choice after it is created, or if a rule changes the collection set for the order choice. |
ORU Parsing Settings
Update collection times from result message content | Select the checkbox to have the system allow result messages from the selected host to update the collection time for samples. The host attempts to parse the date/time from the HL7 field enabled with the setting Get value for Collection Time. If the setting is not enabled, the system does not update collection times for result messages. | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update phlebotomist from results | Select the checkbox to update the phlebotomist in the system from results received from Orchard Harvest. | ||||||||||||||||
Update ordering provider from results | Select the checkbox to have the system update the ordering provider OBR-16 upon receipt of an ORU message. | ||||||||||||||||
Parse result messages with an OBX-2 value of "TX" as if "TX" were "ST" | Select the checkbox to cause TX data-typed OBX segments to be parsed as if the OBX was designated as an ST data result segment. | ||||||||||||||||
Parse suppressed microbiology antibiotic result codes in OBX-13 | Select the checkbox to parse suppressed microbiology result codes from OBX-13. When enabled, the following values will be parsed and applied to received antibiotic results
Enabling this setting will also check when a received test-level ZIF from a device engine includes a flag to suppress either the MIC or the Interpretation of the antibiotic result:
Note This setting is only available with a Microbiology license. | ||||||||||||||||
Store OBR-18, OBR-19, OBR-56, OBR-57, OBR-58, and OBR-59 values from result messages if none have been stored | Select the checkbox to allow the system to store OBR-18, OBR-19, OBR-56, OBR-57, OBR-58, and OBR-59 values when parsing result messages. Note that the system will only store a value if the order choice has not already had a value stored for that specific field. | ||||||||||||||||
Store OBX-15, OBX-23, OBX-24, and OBX-25 values from result messages if none have been stored | Select the checkbox to allow the system to store OBX-15, OBX-23, OBX-24, and OBX-25 values when parsing result messages. Note that the system will only store a value if the order choice has not already had a value stored for that specific field. | ||||||||||||||||
Skip matching results to existing orders [historic import] | Select the checkbox to disable result matching to existing orders in the system during imports. By skipping the matching, the system is able to more quickly complete imports. For some historic result imports, it is not necessary to try and match a result to an existing order, since the system knows that each message represents a new order. | ||||||||||||||||
Import historic data into the system | Select the checkbox to keep historical imports from delivering results. | ||||||||||||||||
Allow HL7 embedded binary file to be received in multiple OBX segments | Select the checkbox to accept base64 encoded PDFs in multiple OBX segments. When this setting is enabled, HL7 files can be parsed into the system as linked documents. The format is OBX|1|ED|J9998_20091223122308507.PDF|1|Clinical^multipart^Postscript^Base64^<encoded data> OBX|2|ED|J9998_20091223122308507.PDF|1|Clinical^multipart^Postscript^Base64^<encoded data> ... Note that the OBX-3.1 must be the same file name, and all the OBX segments that go with the link must be sequential and in order under the same OBR segment. The system will also look at OBX-5.2 and confirm it is multi-part. | ||||||||||||||||
Allow HL7 embedded binary files to be associated with more than one order choice | Select the checkbox to enable the ability to associate an embedded binary document received in HL7 with more than one order choice in the message. When enabled, if the system parses an HL7 file that contains an embedded binary document (ED) in an OBX, any other order choice's OBX referencing the same test host code that has no binary content under the same ORC segment will also be linked to that document. | ||||||||||||||||
Parse HL7 embedded binary files from ZEF segments | Select the checkbox to have the system parse embedded PDFs from the ZEF segments and attach them as a result link attachment to the corresponding result of the OBX the ZEF segments belong to. | ||||||||||||||||
Verify checksum for HL7 embedded binary files | Select the checkbox so that when it is enabled, the checksum will be parsed from the last component in OBX-5 or the last component in ZEF-2 if embedded binary files are sent in ZEF segments. | ||||||||||||||||
Automatically create diagnosis code records for unmatched diagnosis codes | Select the checkbox to have the system automatically create diagnosis codes if diagnosis codes are not found when parsing HL7 messages. When a new ICD code is created in the system, a message will be added to the Error Log that says, "Created a new diagnosis code (ICD), because code was not matched. Code: [new code here]." | ||||||||||||||||
If the practice is set to force unique MRNs, fail any duplicate MRNs instead of enforcing uniqueness | Select the checkbox to have the system fail duplicate MRNs and send the message to the appropriate fix queue if unique MRNs are enforced for new patients. If an ADT or order message is received, and the new patient's practice has the Force unique MRNs for all patients in this practice setting turned on, this new host setting can cause any non-unique MRNs received to go to either the Fix ADT or Fix Orders queue. | ||||||||||||||||
Display inbound parsed order choice comments on lab report | Select the checkbox to have the system display inbound parsed order choice comments on the lab report. | ||||||||||||||||
Reflex flag | Enter one or more characters in the field to define the HL7 reflex flag that the system reads and writes for the host. If you enter a value for the reflex flag for the host, the system will only mark an order choice as reflexed as it is created if the OBR-11 value matches this flag. If this field is blank, the interface will not read or write that field in HL7 messages for the selected host. This field is blank by default. | ||||||||||||||||
Use the host-specified PV1-50 value (if not blank) as the system's order ID when creating an order | Select the checkbox to have the system allow an order ID override value to be parsed from an HL7 order message from the PV1-50 field. If the order ID that is about to be used is not unique, then an order-level comment will be saved to the order that uses a system-generated order ID instead. Send to the Match Results queue if the host-specified value is not unique: Select the checkbox to have the system force the message being parsed to be placed in the Match Results queue if the parsing of the message would have resulted in a new order being created with a system-generated ID due to the received order ID override already existing as an order ID in the system. |
Matching
Field number of sender's PID | Enter the location of the sender's patient ID (PID) within the HL7 message in the field. |
---|---|
Field number of receiver's PID | Enter the location of the receiver's patient ID (PID) within the HL7 message in the field. |
Automatically create users when no match is found | Select the option to have inbound HL7 messages automatically create new users when a match is not found. When this setting is turned off, if no existing match is found for a user within an HL7 message, then no user will be created and that field will be left blank. The only exception is the order's ordering provider. If no match is found for the ordering provider, then the order will go in to Fix Orders page (or the Match Results page, if the system is creating an order from a result). This option is clear/disabled by default. Do not automatically create referring providers: Select the checkbox to have the system not automatically create referring providers. |
Automatically synchronize users with the selected hosts | Select the field to search for users to be automatically synchronized with the selected hosts when a user is created by an HL7 message. Note that this feature is available for hosts using Synch 2.x only. It is recommended to enable User Host Code Updating in the Host Code Updating section for each of the hosts that have been selected to automatically synch with. It may be necessary to adjust the Outbound Interface tab setting Hold messages for x seconds to allow the delivery of the HL7 message to be delayed long enough for the newly-created user to be synchronized with Orchard Harvest. This is a multi-select search-as-you-type field. When a user has been selected, the user appears in the table below the setting. The table displays the name, active status, and the option to select/unselect the user. Clearing the checkbox removes the name from the table. |
Allow matching received patient ID against the system's patient ID | Select the option to allow a patient in an inbound HL7 interface message to match to a system patient by specifying the system patient ID in the receiver's patient ID field in that HL7 message. |
Get value for Master Patient ID #2 | Select an option from the drop-down list to determine where to parse the new master patient ID. Select either Never, from PID field 2, from PID field 3, from PID field 4, from PID field 18, from PID field 31, or from PID field 32 from the drop-down list. Use location and Master Patient ID #2 to identify patient: Select the checkbox to determine if the initial patient matching when parsing inbound messages should be based on the new master patient ID and the received location's practice. |
Create Match Results messages for results received on cancelled order choices | Select the option to have the system add to the Match Results page when a result is received for an order choice that has been cancelled. |
Attempt to match on profile when no matching order choice is found for cancel order choice messages | Select the option to have the system attempt to cancel order choices that are configured to the profile from the order. This setting will fail for any order choices on the profile configured as Can exist on the order more than once and no matching will be attempted for the order choice. |
Attempt to match on profile host codes when no matching order choice is found for change order choice messages | Select the option to have the system attempt to change order choices that are configured to the profile's host codes from the order and apply changes to all order choices in the order that were ordered as part of that profile. This setting will fail for any order choices on the profile configured as Can exist on the order more than once and no matching will be attempted for the order choice. |
Patient Match Rules | In the Patient Match Rules section, define one or more patient matching rules for messages sent from the host system to the system. The system uses these rules when it receives messages from this interface. If it receives a message for a patient whose host code does not match an existing patient, the system tries to match the patient based on demographic information. If it finds exactly one patient that matches all of the criteria, it makes a match. When the match is made, if the system sends a host code, it updates the patient's host code for that host to the value sent in the message. If it does not send a host code sent, it does not alter the host code. Use patient match rules: Select the checkbox to enable patient matching rules. You may then define the match rules for the interface. by default, the system matches messages using patients' entire first and last names, but you may modify the options as desired. Use patient match rules even when a match is found based on the patient ID in the message: Select this checkbox to apply patient matching rules, even when a match is found on the patient ID in the incoming message. This setting is automatically selected by default. <Match> patient first name when matching a patient: Select an option from the drop-down list to set how much of the first name must match the incoming data, or select "Do not use" to have the system not consider the patient's first name when making matches. <Match> patient last name when matching a patient: Select an option from the drop-down list to set how much of the last name must match the incoming data, or select "Do not use" to have the system not consider the patient's last name when making matches. Exact match on patient name length options: Select this checkbox to avoid using unnecessary LIKE comparators in result matching queries for the patient's first and last name. This should only be enabled when the patient last names do not include a suffix. If the last name does contain the suffix, then the option should be disabled. Match patient on name suffix: Select this option to have the system consider the suffix of the patient's name (e.g., Jr, Sr, etc.). Match patient on date of birth: Select this option to have the system consider the patient's date of birth when making matches. Match patient on Sex: Select this option to have the system consider the patient's sex when making matches. Match patient on MRN: Select this option to have the system consider the patient's MRN when making matches. Match patient on SSN: Select this option to have the system consider the patient's SSN when making matches. |
Sample Matching Rules | In the Sample Matching Rules section, define one or more sample matching rules for messages sent from the host system to the system. The system uses these rules to determine to which order or sample it assigns results when it receives them from the current host. Note that the system always matches the sample ID values, so you cannot disable that rule. Omit using the sample ID when matching a result message to a sample in the system: Select this checkbox to omit using sample IDs when matching result messages to samples in the system. Use the sample collection time when matching a result message to a sample in the system: Select this checkbox to configure a system to not match an incoming result HL7 message based on Sample ID. Match samples collected in a window plus or minus ___: Select this checkbox to use the patient MRN to the result matching configurations for a host. The default value is 90. Select either Minutes, Hours, or Days from the drop-down list to specify a value. Only match to samples with at least one non-final order choice: Select this checkbox to limit possible matches for result messages to samples that have at least one order choice that has not received finals results. This setting only applies when parsing result messages. Match to first sample that is not cancelled: Select this checkbox to define a different action that should take place when parsing a result message that matches to more than one order. This setting will cause the match to be made to the sample that is not cancelled. Omit using the sample ID override when matching a message to a sample in the system: Select this checkbox to have the system not attempt to match on an order choice's sample ID override when matching to samples in the system. When enabled, the setting significantly speeds up the time it takes in order to process HL7 messages if sample ID overrides are not used. Match to orders with an order ID matching the PV1-50 value received in the result message: Select this checkbox to have the system allow a result message to match to an order using the value in the PV1-50 field to match to an order's order ID. |
The following settings affect result messages in addition to cancellation, change order, change status, and billing messages | The following settings affect result messages in addition to cancellation, change order, change status, and billing messages: <Match> patient last name when matching a result message to a sample in the system: Select an option from the drop-down list to limit how many characters of the patient's last name must match when the system assigns results. You may require that all of the name matches, none of the name matches, or the starting characters of the name (from 1 up to 9) match. <Match> patient first name when matching a result message to a sample in the system: Select an option from the drop-down list to limit how many characters of the patient's first name must match when the system assigns results. You may require that all of the name matches, none of the name matches, or the starting characters of the name (from 1 up to 9) match. Use the patient name suffix when matching a result message to a sample in the system: Select this option to narrow the search to samples where the patient's name suffix (e.g., Jr, Sr, etc.) matches. Use the patient DOB when matching a result message to a sample in the system: Select this option to narrow the search to samples where the patient's date of birth matches. Use the patient sex when matching a result message to a sample in the system: Select this option to narrow the search to samples where the patient's sex matches. Males will match on "male" or "undeclared," and females will match on "female" or "undeclared." Use the patient MRN when matching a result message to a sample in the system: Select this option to narrow the search to samples where the patient's MRN matches. Use the encounter ID when matching a result message to a sample in the system: Select this option to narrow the search to samples where the patient's encounter ID matches. |
Host Code Updating
In the Host Code Updating section, define when the system updates the host codes for the selected hosts. The update table contains an entry for each host in the system. For each host, there are checkboxes for Is Active, Patient Host Code, User Host Code, Insurance Company Host Code, and Insurance Plan Host Code.
Is Active | Select the checkbox for one or more hosts to enable host code updates. |
---|---|
Patient Host Code User Host Code Insurance Company Host Code Insurance Plan Host Code | Select one or more host code type checkboxes for a host (patient, PCP, insurance company, or insurance plan). Then, when a host sends updated host codes for one of the selected host code types via HL7, the system updates the active host's host code, as long as one does not exist and it is not a duplicate. |
OK | Select the button to accept changes on all the Interface Configuration tabs and return to the Hosts details page. Note that you must select the Save button on the Hosts details page to complete saving the changes within the system. |
Cancel | Select the button to return to the Hosts details page without saving any changes. |
HL7 2.5.1 Settings — Inbound Interfaces
Use the Inbound Interface tab of the Interface Configuration page to configure HL7 2.5.1 settings.
Expect HL7 2.5.1 formatted messages for message types | Select the checkbox to configure the format in which HL7 2.5.1 messages are formatted. When this checkbox is selected, several sub-settings become available in the HL7 2.5.1 Settings section.
|
---|---|
HL7 2.5.1 Placer Order Number universal ID | Enter text into the field to specify the universal ID for the placer order number. |
HL7 2.5.1 Placer Order Number universal ID type | Enter text into the field to specify the universal ID type for the placer order number. |
HL7 2.5.1 Placer Order Number namespace ID | Enter text into the field to specify the namespace ID for the placer order number. |
HL7 2.5.1 Placer Group Number universal ID | Enter text into the field to specify the universal ID for the placer group number. |
HL7 2.5.1 Placer Group Number universal ID type | Enter text into the field to specify the universal ID type for the placer group number. |
HL7 2.5.1 Placer Group Number namespace ID | Enter text into the field to specify the namespace ID for the placer group number. |
If a Code System Name is blank, parse it in as a Local Code System Name | Select the checkbox to have the system parse a code system name in as a Local Code System is the code system name is blank. |
Location Local Code System Name | Select the checkbox to specify the name of the Location's Local Code System. This is a required field. |
User Local Code System Name | Select the checkbox to specify the name of the User's Local Code System. This is a required field. |
Order Choice Local Code System Name | Select the checkbox to specify the name of the Order Choice's Local Code System name. This is a required field. |
Automatically create UCUM records | Select the checkbox to have the system automatically create UCUM records. |
Automatically create additive records | Select the checkbox to have the system automatically create additive records. |
Automatically create sample type records | Select the checkbox to have the system automatically create sample type records. |
Automatically create sample type modifier records | Select the checkbox to have the system automatically sample type modifier records. |
Automatically create collection method records | Select the checkbox to have the system automatically collection method records. |
Automatically create specimen source site records | Select the checkbox to have the system automatically create specimen source site records. |
Automatically create specimen source site modifier records | Select the checkbox to have the system automatically create specimen source site modifier records. |
Automatically create SNOMED records | Select the checkbox to have the system automatically create records for SNOMED codes if they do not already exist within the system if they are inbound HL7 2.5.1 results with a CWE datatype. The setting will use the identifier, text, coding system, and coding system version values in OBX-5.1, OBX-5.2, OBX-5.3, and OBX-5.7 to create the SNOMED code if OBX-5 1-3 are all populated. If they are not all populated, then the alternate identifier, alternate text, alternate coding system, and alternate coding system version values in OBX-5.4, OBX-5.5, OBX-5.6 and OBX-5.8 will be used to create the SNOMED code if OBX-5 4-6 are populated. If the alternate identifier fields are not populated either, then a SNOMED code will not be created for the CWE result. |
Parsed phone number format | Select an option from the to specify the format of the parsed phone number. Select either No formatting, 999-999-9999, (999) 999-9999, 999-999-9999 /w validation, or (999) 999-9999 /w validation from the drop-down. |
When LOINC scale does not match the results value | Select an option from the drop-down list. Select either Allow parsing to continue or Create match results message from the drop-down list. Select the Allow parsing to continue option to maintain the previous functionality of parsing results when the LOINC scale does not match the result value's data type. This setting is selected by default. Select the Create match results message option to send the entire HL7 message into the Match Results queue if the LOINC scale for any result does not match the result value's data type. Evaluate as if the outbound setting "Allow CWE data type population for OBX segments without SNOMED codes" is set: Select the checkbox to change the LOINC scale matching so that CWE results without SNOMED codes no longer cause the result message to be placed into the Match Results queue. |
HL7 2.5.1 Settings (Patient ID, Sample ID, and Fasting)
Use the Inbound Interface tab of the Interface Configuration page to configure HL7 2.5.1 settings for patient IDs, sample IDs, and fasting.
HL7 2.5.1 Patient ID Matching Criteria | Use the section to configuration matching patient IDs for HL7 2.5.1 inbound interfaces. The table displays the order number, HL7 field, ID type code, master patient ID 1 and 2, what the patient ID should match on, the ability to match on assigning authority, and the ability to delete the ID. When Master Patient ID 1 is used and there is a value in the specified field with the specified type code, the system uses that value as the Master Patient ID and attempts to find a patient that matches it. When Master Patient ID 2 is used and there is a value in the specified field with the specified type code, the system uses that value as the Master Patient ID 2 and attempts to find a patient that matches it. In both cases, the system can also match on the assigning authority, if desired. When matching on the assigning authority, the system simply checks to see if the ID received has the system's assigning authority. If it does not, no matching patient is found. Additionally, both of these settings require the ordering location for the order to have a practice defined in order to match using the master patient IDs. Add: Select the button to add patient ID matching criteria to the table. Match on Assigning Authority: Select the checkbox to perform patient matching on the assigning authority for the patient identifier in addition to the patient identifier itself. The option is available for all patient identifier types except for host code matching because an assigning authority is not sent with host codes. X: Select the button to delete the row from the table. Drag and drop the rows in the table to change the matching order of the items. Note that MRG segments will apply the same criteria to MRG-1. |
---|---|
HL7 2.5.1 Sample ID Matching Criteria (OML(CA), OML(NA), OML(NW), OML(SC), OML(SN), OML(XO), ORU) | Use the section to configure matching sample IDs for HL7 2.5.1 inbound interfaces. The table displays the order number, HL7 field, what the sample ID should match on, and the ability to delete the ID. Add: Select the button to add sample ID matching criteria to the table. X: Select the button to delete the row from the table. Drag and drop the rows in the table to change the matching order of the items. Note that matching on Parent Filler Order Number and the system's Order ID will only be performed for lab interfaces. |
HL7 2.5.1 Fasting Settings | Use the section to control how fasting information is parsed from OBX segments in HL7 2.5.1 messages. LOINC codes: Enter text into the field to determine which OBX segments should be interpreted as fasting information. If the identifier in OBX-3.1 matches any of the specified values then the OBX will be interpreted as a fasting OBX. A total of four LOINC codes can be defined to be used for fasting OBXs on a host. The default values for LOINC codes are "49541-6" and "45358-9" with the other two LOINC codes being blank. Host codes: Enter text into the field to determine which OBX segments should be interpreted as fasting information. If the identifier in OBX-3.1 matches any of the specified values then the OBX will be interpreted as a fasting OBX. A total of four host codes can be defined to be used for fasting OBXs on a host. The default values for host codes are all blank. CWE coding system: Enter text into the field to determine what answers to parse from OBX-5 when the OBX data type is a CWE. If the CWE coding system does not match the value from OBX-5.3 then the fasting OBX will be ignored. CWE yes code: Enter text into the field to specify what values to look for in OBX-5.1 to specify "yes" for when OBX-5 is a CWE data type. CWE no code: Enter text into the field to specify what values to look for in OBX-5.1 to specify "no" for when OBX-5 is a CWE data type. CWE unknown code: Enter text into the field to specify what values to look for in OBX-5.1 to specify "unknown" for when OBX-5 is a CWE data type. CWE N/A code: Enter text into the field to specify what values to look for in OBX-5.1 to specify "not available" for when OBX-5 is a CWE data type. |
Outbound Interface Tab
Setting Up the Outbound Interface
Use the Outbound Connectivity Settings (messages sent by the system) section of the Interface Configuration page to configure the interface parameters for all messages sent by the system.
Hide section Show section | Select the hide section link to hide the Outbound Connectivity Settings (messages sent by the system) options. Select the show section link to display the options. |
---|---|
Outbound is active | Select the checkbox to activate the outbound interface. Clear this checkbox if the outbound interface is not set. |
Hold messages for ___ seconds | Enter a value into the to have the system hold messages for a specific number of seconds. |
Allow to run multithreaded with a maximum thread count of ___ | Enter a value into the field to specify a maximum thread count. The default value is five. |
Attempt to send messages ___ times before marking messages as failed | Enter a value into the field to specify how many times the system attempts to send messages before marking them as failed. The default value is 3. |
Delay the creation of order messages for this host by __ seconds | Select an option from the drop-down list to delay creating order messages for this outbound interface by the designated number of seconds. This allows the system to group orders that are received electronically from other hosts onto a single order before it sends the order message to the lab. Note that this does not apply to orders sent to the order request host. This can be set for all hosts, but the system can only delay plain ORM messages. |
Expect ACK from Host | Select the checkbox to have the system wait to receive an acknowledgment message from the receiving host. Note that selecting this checkbox enables the Expect ACK in the same MLP connection checkbox (see below). If both the Expect ACK from Host and the Expect ACK in the same connection options are enabled for the outbound interface, the system expects the other host to send back the same start and end blocks that the system sent out. In addition, if this checkbox is selected, the system populates the MSH15 field in HL7 transmissions with AL, otherwise, it populates the field with NE. Note that if you select this option, you should not set the communication type to File Transfer, as this could cause serious problems. The system will alert you if you attempt to save this potentially harmful combination of settings for an outbound host interface. Expect ACK in the same connection: Select the checkbox to have the system expect an immediate ACK message. |
Replace characters that meet the following regular expression with a space | Enter a regular expression that the system will use to replace all characters that match in outbound host HL7 messages with a space. If you leave the field blank, the system won't make changes to the HL7 message. Note Use extreme caution when editing this field. The system will replace all matching characters in the HL7 message with a space, and any edits to the regular expression should be followed by rigorous testing to ensure that only the characters that are desired to be removed are removed. |
Outbound Mapper Script | Select an option from the field to use a Mapper script to convert data from one format to another. If you wish to create a new script or modify an existing script, select the Create New button (for new scripts) or Edit button (for existing scripts) to open the Edit Mapper Script page, where you may define or edit the Mapper script. See the Mapper Scripts topic. If you have selected a script before selecting the Create New button, the system makes a copy of the selected script that you use as the basis for the new script. |
Capitalization | Select an option from the drop-down list to control how the system formats patient names when sending messages.
|
None | Select the option to switch the database setting back to turn off the MLP or File Transfer options. This is selected by default. |
MLP (TCP/IP sockets) | Select the option to use the TCP/IP interface to transfer messages. Complete the following fields to set up the directory structure. Select the None option to have the system not use the MLP (TCP/IP sockets) option.
|
File Transfer | Select the option to use flat files in transferring messages. Complete the following fields to set up a shared directory structure.
|
Web Service | Select the option to transfer messages via an HL7 interface. Complete the following fields to further configure the interface. These are required fields.
|
Orchard Device Engine | Search for and select an ODE interface using the Device Engine File Transfer Interface search-as-you-type field. Select OK to save the change. |
Message Trigger Settings
Hide section Show section | Select the hide section link to hide the Message Trigger Settings options. Select the show section link to display the options. |
---|---|
Outbound ADT | Select the button to define for which practices' patients that host should receive demographics in the ADT Events page. |
Outbound DFT | Select the button to define which practices' patients need billing events, define how to schedule the delivery of billing event messages, and define the content of the DFT messages in the DFT Events page. |
Send MFN messages | Select the checkbox to send MFN messages upon addition, deactivation, or modification of locations and users. When checked, the system will send MFN messages upon modification to the properties of locations or users, if the location/user has a host code defined for the host. Do not require Placer Order Number: Select the checkbox if the system should not require hosts to have a placer order number to send cancellation messages. |
Send change order choice message | Select the checkbox to allow the system to accept and send order choice change messages ("XO"). Currently, the system will only update the priority, collection time, and diagnosis codes from the message. A change message will not be created unless one of those fields changes on an existing order in the system. Change messages will be sent though the orders interface, much like cancellation messages. Respect HL7 Break Level for change order choice messages: Select the checkbox to have the system respect the structure of change order messages sent out so that they will follow the HL7 Break Level host interface setting when creating the messages. For example, if the PID Break Level setting is selected with this new setting turned on, when XO messages are generated messages will be combined into messages based on the patient. Send change order choice message on sample collection: Select the checkbox to send an ORM(XO) message to the originating host when collecting an order choice and the order choice has already been sent to a lab. This sends out an ORM(XO) to the originating host for every qualifying order choice collected. |
Send order completed change status message | Select the checkbox to have the system send order completed change status messages. |
Send accessioned change status message | Select the checkbox to allow the system to send change status messages to the selected host. Send accessioned change status message when no placer order number is available: Select the checkbox to allow the system to send accessioned change status messages when no placer order number is available. |
Send end visit A03 ADT messages | Select the checkbox to have the system generate A03 ADT messages when either parsing A03 ADT messages or when an encounter is closed. |
Force ORM(SN) messages to be sent when this host is the order request host when parsing an ORM(NW) message | Select the checkbox to force an SN (send number) message to be sent to the order request host when parsing the order (ORM) message for the order choice. |
Send DFT messages to XIFIN web service | Select the option to have the system send DFT messages to the XIFIN web service.
|
Message Population Settings
HL7 Break Level | Select the HL7 break level from the drop-down list (PID, OBR, or ORC). Note that the break level subdivides the HL7 message by patient, order choice, or order. The system defaults to the patient break level.
| ||||||||
---|---|---|---|---|---|---|---|---|---|
Use ORC format | Select the checkbox to enable the system to transmit or receive ORC segments. Clear the checkbox to restrict the system from sending or receiving ORC segments. | ||||||||
Send multiple order choices in an ORM(SN) message | Select the checkbox to allow for order choices being sent to the same host to be combined into a single ORM(SN) message. | ||||||||
Force profile components onto their own messages | Select the checkbox to have the system force profile components onto their own messages. | ||||||||
Group profile components onto their own messages | Select the checkbox to have the system override the OBR break level for components of a profile. When this setting is turned on, it will cause components of a profile to be grouped onto a single HL7 message when the HL7 message break level is set to OBR. | ||||||||
Send preceding segment to identify profile in result messages to Harvest LIS labs | Select the checkbox to have the system populate result HL7 messages with an OBR segment to represent the profile. If you select this option. Only send the preceding profile segment. Do not send segments for profile components in order messages: Select the checkbox to only send the OBR segment representing the profile host code in order messages sent to an Orchard Harvest lab. | ||||||||
Send preceding segment to identify profile in result messages | Select the checkbox to have the system send a segment representing the profile along with the components of a profile in HL7 result messages. | ||||||||
Send UDF in ZCF segments | Select the checkbox to have the system send ZCF segments to hosts other than Orchard Harvest. Note that if a host is configured to send change order messages (not to this setting), and the only change is to a user-defined field, then it will not send the change order message. | ||||||||
Send Patient Additional Info in ZCP segments | Select the checkbox to have the system send patient-related additional info in ZCP segments. | ||||||||
Send Order Choice Additional Info in ZCO segments | Select the checkbox to have the system send order choice-related additional info in ZCO segments. | ||||||||
Send Test Additional Info in ZCT segments | Select the checkbox to have the system send test-related additional info in ZCT segments. | ||||||||
Populate ZCF, ZCP, ZCO, and ZCT segments using delimiter | Select an option from the drop-down and select either , or ; from the list. This drop-down defines the delimiter used for multi-select pre-defined text answers to user-defined questions within the respective HL7 segments. | ||||||||
Append at most __ historic result messages to all result messages sent to this host | Select a value from the drop-down list to force additional messages containing past result data to populate a single ORU message. The system will populate ORU messages with historic data for the order choices being reported. When this setting is turned on, the system can populate an ORU message with more than one MSH segment. Select a value between 0 and 5. The default value is 0. Only populate historic messages when order is final: Select the checkbox to have the system limit the population of historic data in HL7 result messages to when the order is final. | ||||||||
Send NK1 segments in messages | Select the checkbox to have the system send out and parse owner information from NK1 segments in HL7 messages. An interface will only populate NK1 segments in outbound HL7 messages if the Host interface setting is turned on. When parsing the NK1 segment, if a matching owner record is found to the Owner ID in the NK1-33 field, that matching record's information will be updated to match the information in the message that is being parsed. Populate NK1 segment: Select an option from the drop-down list to specify when the NK1 segment should be populated. Select either after PV1, before PV1, or after PID. Previously, for HL7 2.3 transmission of veterinary messages, it would have placed NK1 segments after the PV1 segment. For HL7 2.5.1, it would have placed it before the PV1 segment by default. Now, another option directly after the PID segment is selectable. The after PV1 option is selected by default. | ||||||||
Send diagnosis codes in ORU messages | Select the checkbox to have the system control if ICD codes will populate in ORU result messages. | ||||||||
Send patient comments to this host | Select the checkbox to have the system send patient comments to a specified host. | ||||||||
Force secondary and tertiary insurance segments to populate with primary insurance segment if none exist | Select the checkbox to have the system control if blank secondary and tertiary IN1 segments should populate outbound HL7 messages if no information is available. This setting will only force the additional segments to populate if the primary insurance IN1 segment populates the message. | ||||||||
Send insurance information that has not been validated | Select the checkbox to allow the system to transmit insurance information even if it has not been validated. See the Validate Insurance topic. | ||||||||
Send insurance information in number assign messages | Select the checkbox to control if number assign messages should contain insurance information. | ||||||||
Send insurance information in ORU messages | Select the checkbox to send insurance information to the selected host in result messages. | ||||||||
Send result-level linked documents in OBX segments | Select the checkbox to send all active result-level linked documents in OBX segments when sending HL7 messages. Populate each linked document content once per ORC: Select the checkbox to have the system limit the number of times a specific linked document will populate an outbound HL7 message. When this setting is turned on, a linked document that was associated with more than one order choice will only populate the encoded representation of its content in one OBX segment per ORC segment. This will prevent the same exact content from having to populate a single HL7 message many times. Order by newest linked document: Select the checkbox to order result linked document OBX segments from newest to oldest so that the newest results are sent first. | ||||||||
Send order-level linked documents in ZCU segments in ORU messages | Select the checkbox to send all active order-level linked documents in a ZCU segment when sending ORU HL7 messages. The order-level document will be sent in the Base64 encoding. The order-level linked document must exist before sending the ORU message in order for the ZCU segment to be added. | ||||||||
Send linked documents in OBX segments | Select the checkbox to have the system embed linked documents in OBX segments of the OBR of the result messages sent to the selected host. | ||||||||
Field delimiter Component delimiter Repeat delimiter Escape delimiter Subcomponent delimiter | In the Field delimiter, Component delimiter, Repeat delimiter, Escape delimiter, and Subcomponent delimiter fields, the system lists the delimiters it uses when creating outbound HL7 messages. Modify one or more delimiters, if necessary. Note that the values must be a single character, not blank, not alphanumeric, and must be different from the other delimiters for the selected host. | ||||||||
MSH fields | If appropriate, enter in the MSH fields values the system should place in the MSH segment of all outbound messages to the selected host (from the system to the host). If you enter values in the fields, the system will send that value in the field number specified. If you leave the field blank, the system assigns default values. Note that entering a space will not cause the system to leave the MSH field blank; it will interpret it as an entry. You may assign values for the following fields:
| ||||||||
Reflex flag | Enter one or more characters in the field to define the HL7 reflex flag that the system reads and writes for the host. If you enter a value for the reflex flag for the host, the system will only mark an order choice as reflexed as it is created if the OBR-11 value matches this flag. If this field is blank, the interface will not read or write that field in HL7 messages for the selected host. This field is blank by default. | ||||||||
Assign Billing Status to reflexed order choices based on the parent order choice | Select the checkbox to assign the billing status of a reflexed order choice from ORU messages to its parent order choice. When the checkbox is selected, inbound reflexed order choices from ORU messages will have their billing status values (internal and external) assigned from their parent order choice. If no parent order choice is found, then the system will fall back on the default billing status assignment. | ||||||||
Signed Don't Bill ABN OBR Code | Enter the value the system will send and expect to receive in the OBR-45 HL7 field in the field when the ABN status is Signed/Don't Bill. The default value is GA. Note that when both Signed and Signed/Don't Bill use the same code, Signed takes precedence. | ||||||||
No ABN Required ORC Code | Enter a value to control the code that the system uses in the ORC-20 HL7 field in the field to indicate that an ABN is not required. This code does not take precedence over the existing HL7 defined codes of 1, 2, 3, and 4. The default value is 1. Note that you should normally set this to 0 (zero) for Orchard Harvest interfaces. | ||||||||
Split the ABN status values of Unsigned, Not Required and Refused to Sign in outgoing HL7 messages | Select the checkbox to split ABN SignedStatus values to set Unsigned to be 6, Not Required to 5, and Refused to Sign to be 4 in outgoing HL7 messages. | ||||||||
Field number of sender's PID | Enter the location of the sender's patient ID (PID) within the HL7 message in the field. | ||||||||
Field number of receiver's PID | Enter the location of the receiver's patient ID (PID) within the HL7 message in the field. | ||||||||
Send the system's PID if a PID is not mapped for host | Select the checkbox to enable the system to send new patient information with an the system PID, if a host-specific patient ID does not exist. | ||||||||
Send CRLF in Hex Format | Select or clear the checkbox to determine how the system sends CRLF (carriage returns and line feeds) in HL7 messages. If you select this option, the system sends CRLFs in Hex format (X0d0a); if you do not select this option, the system replaces CRLFs with spaces in HL7 messages. This option is selected/enabled by default. | ||||||||
Send corrected flag in result messages | Select the checkbox to send corrected flags out as the order choice status in the OBR segment (OBR-25). So, if any of the test results being sent out under that OBR were received with a corrected flag, the system populates the order choice level status in OBR-25 with a C. This option is selected/enabled by default. | ||||||||
Send results to host for orders with external ordering providers | Select the checkbox to control whether or not the system sends HL7 result messages to the selected host if the order has an external ordering provider. It is selected/enabled by default. This setting works for host recipients on the Results To list, as well as for results sent via user and location HL7 result delivery rules. | ||||||||
Populate location namespace identifiers with | Select an option from the drop-down list to send either location IDs or names for HL7 facilities as namespace identifiers. | ||||||||
Populate PID segment with patient MRN# | Select an option from the drop-down list to choose into which PID field the system should place the patient MRN# when the patient's demographics are being updated (or created). | ||||||||
Populate PID segment with Patient ID #2 | Select an option from the drop-down list to choose into which PID field the system should place the value from the Patient ID #2 field. You may view or edit alternate patient IDs by selecting the More button next to the Patient ID field on the Demographics page. See the Demographics topic. | ||||||||
Populate PID segment with Patient ID #3 | Select an option from the drop-down list to choose into which PID field the system should place the value from the Patient ID #3 field. You may view or edit alternate patient IDs by selecting the More button next to the Patient ID field on the Demographics page. See the Demographics topic. | ||||||||
Populate PID segment with Master Patient ID #2 | Select an option from the drop-down list to determine where to populate the new master patient ID. Select either Never, from PID field 2, from PID field 3, from PID field 4, from PID field 18, from PID field 31, or from PID field 32 from the drop-down list. | ||||||||
Populate OBR segment with lab filler SID | Select an option from the drop-down list to populate the OBR segment with the lab filler sample ID in result messages (OBR segments 18-21). The system overwrites whatever was previously in the selected OBR field with the lab filler sample ID. | ||||||||
Populate OBR segment with order choice module type | Select an option from the drop-down list to include the order choice module type in OBR 4.3 or OBR 4.4. Select either Never, in field 4.3, or in field 4.4. | ||||||||
Populate ordering location address | Select an option from the drop-down list to send the order location address in outbound HL7 messages as either a repeat of PV1-3 or ORC-13. | ||||||||
Populate ordering location NPI | Select an option from the drop-down list to control where the system should populate the ordering location's NPI into HL7 messages as a repeat of PV1-3, ORC-13, or to not populate it. | ||||||||
Populate provider host code | Select an option from the drop-down list to determine the default value to use when the system needs to create a host code for a provider.
| ||||||||
Populate PV1-3.4.2 in ORM messages | Select an option from the drop-down list to populate the PV1-3.4.2 value in outbound ORM messages with one of the following:
| ||||||||
Populate PV1-20 in ADT, DFT, and ORM messages | Select an option from the drop-down list to populate the PV1-20 value in outbound ADT, DFT, and ORM messages with one of the following:
| ||||||||
Populate PV1-44 in ADT ___ when encounter open date is not set | Select an option from the drop-down list to populate PV1-44 value in outbound ADT messages with of of the following:
| ||||||||
Populate OBX-4 with received observation sub-ID | Select the checkbox to populate the OBX-4 field with the observational sub-ID for HL7 2.3 messages. Note that this will automatically be done for HL7 2.5.1 messages, and if the OBX is for a Microbiology result, the Isolate ID will still be populated in the OBX-4 field. | ||||||||
Populate OBX-5 using delimiter | Select an option from the drop-down list to define a delimiter used when sending OBX-5 messages: Select either , or ; from the drop-down list. | ||||||||
Populate OBX-15 | Select an option from the drop-down list to populate the OBX-15 value in HL7 messages with one of the following:
| ||||||||
Populate FT1-5 | Select an option from the drop-down list to populate the FT1-5 value in HL7 messages with one of the following:
| ||||||||
Populate FT1-16.4 | Select an option from the drop-down list to populate the FT1-16.4 value in HL7 messages with one of the following:
| ||||||||
Populate OBR-14 with | Select an option from the drop-down list to populate the OBR-14 value in HL7 messages with one of the following:
| ||||||||
Populate OBR-29.1 with | Select an option from the drop-down list to populate the OBR-29.1 value in HL7 messages with one of the following:
| ||||||||
Populate patient practice | Select an option from the drop-down list to populate the patient practice in HL7 messages with one of the following:
| ||||||||
Follow HL7 Standards version 2.6 to populate DG1 segments | Select the checkbox to have the system populate the description and coding system in DGI-3 and DGI-4 and will be empty if the time of message creation is past the value configured in the System Defaults setting Effective ICD-10 Start. Only follow version 2.6 after effective ICD-10 start date: Select the checkbox to have the system only follow version 2.6 standards after the effective ICD-10 start date. This setting can only be modified if Follow HL7 Standards version 2.6 to populate DG1 segments has been selected. Do not apply version 2.6 standards for ICD-9 codes: Select the checkbox to prevent the system from using HL7 version 2.6 standards when building DG1 segments for an ICD-9 code. This setting can only be modified if Follow HL7 Standards version 2.6 to populate DG1 segments has been selected. | ||||||||
Follow HL7 Standards version 2.6 to populate FT1 segments | Select the checkbox to have the system follow HL7 2.6 standards when populating FT1 segments. This setting controls if the code description and coding system components will populate field FT1-19. Only follow version 2.6 after effective ICD-10 start date: Select the checkbox to have the system only follow version 2.6 standards after the effective ICD-10 start date. | ||||||||
Send transgender values for patient sex to this host | Select the checkbox to have the system send the defined transgender value for the patient's sex to the host (e.g., M/F instead of M or F/M instead of F). When transgender values are disabled, the system interprets M/F as M and F/M as F. | ||||||||
Send double quotes in ADT message fields if an inbound message designated to remove that data | Select the checkbox to allow the system to send out HL7 fields that were received containing double quotes in order to remove demographics data from the database. | ||||||||
Allow for inactive order choice host codes to be sent to this host | Select the option to have the system send inactive order choice host codes in outbound messages. This will allow for the population of an inactive order choice host code into outbound HL7 messages. | ||||||||
Send Sample ID Suffix to this host | Select the option to have the system send/receive SID suffix via HL7. Via a new outbound Host interface, the SID suffix as, ordained by the collection information assigned to the order choice, can now be added onto the SID sent via HL7 messages. This setting will also cause the SID parsed in from result messages for matching to be treated as ID + Suffix as opposed to just the ID. | ||||||||
Insurance identifier for insurance segments when no insurance exists ___ (Applies to "Local Lab (orchard)" host type | Enter text into the field to specify an insurance identifier for insurance segments when no insurance exists. The default is SELF-PAY. | ||||||||
Use the ordering location's time zone for outbound messages | Select the option to allow the system to use the ordering location's time zone for outbound HL7 messages. A host can now be told to use the relevant order's ordering location's time zone for HL7 message sent to this host instead of the time zone assigned. This will affect order-based messages (ORM, ORU, and DFT messages). | ||||||||
Populate OBX-3.5 with the received LOINC description | Select the checkbox to have the system populate the OBX-3.5 field with the received LOINC code descriptions. | ||||||||
Populate OBX-23 with all received testing host data | Select the checkbox to have the system populate the OBX-23 field with all received testing host data. | ||||||||
Populate OBX-24 with all received testing host data | Select the checkbox to have the system populate the OBX-24 field with all received testing host data. | ||||||||
Populate OBX-25 with all received testing host data | Select the checkbox to have the system populate the OBX-25 field with all received testing host data. | ||||||||
Send medication OBXs in ORM messages with host code | Enter a host code into the field to have the system use the specified host code when sending medication OBX messages. The recommended value for this host code is "18816-9," which is a LOINC code for medications, but the host code can be set to whatever is desired as long as it is not used by any clinical information questions. In the drop-down, select either Populate no additional information, Populate alias, or Populate alias and last dose information from the list. Populate no additional information is the default option in order to preserve the current functionality and will not send any additional information from outbound medication OBX segments. The Populate alias option will send the medication alias that was selected if a selected alias exists. The Populate alias and last dose information option has the functionality of Populate alias, but will also send any last dose information that was saved with the medication. Send medications in ORU messages: Select the checkbox to include order medications in outbound ORU messages as OBX segments. When selected, in addition to delivering medications in outbound ORM messages sent to the host, they will also be delivered in outbound ORU messages. | ||||||||
Send patient time of birth for patients less than a year old | Select the checkbox if a patient has time of birth information, and the patient is less than a year old, the time of birth will be sent along with the date of birth in PID-7 for HL7 messages. | ||||||||
Send encounter comments | Select the checkbox to send the comments added to the encounter in NTE segments. | ||||||||
Populate PV1-7 with ordering provider when attending provider is not set | Select the checkbox to specify whether the system will perform its default functionality of placing the ordering provider information in the Attending Provider fields. | ||||||||
Populate PV1-7 with provider UPIN and SSN | Select the checkbox to specify whether the system will include the provider's UPIN and SSN in the DFT and ORU outbound messages to the host. | ||||||||
Outbound text to be used when fasting status is Not-Applicable | Enter text in to the field to specify outbound text that should be used when a fasting status is non-applicable. The option is required and the interfaces will not be able to be saved if it is set to be blank. HL7 messages containing fasting status in OBR-13 where the fasting status is set to N/A will now be populated with the text Fasting: followed by the text entered for the option on the host that the HL7 message is being sent to. The default text is N/A. | ||||||||
Preliminary flag for OBR-25 | The default is "P." Enter a value in this field to send out a different value in OBR-25 for preliminary order choices in HL7 messages. The value can be up to 10 characters in length. | ||||||||
Preliminary flag for OBX-11 | The default is "P." Enter a value in this field to send out a different value in OBX-11 for preliminary results in HL7 messages. The value can be up to 10 characters in length. | ||||||||
Include unapproved results in result messages | Select this checkbox to have result messages sent to the host include tests that have not had their results approved . The unapproved results will be sent as preliminary results. This setting defaults to not being set. Note This checkbox is only available with specific product licenses. | ||||||||
Microbiology Settings | |||||||||
Send microbiology results in a format | Select an option from the drop-down list to send microbiology results to the host in a Discrete, Non-Discrete, or Discrete and Non-Discrete format with all the results in a list of NTE segments structured similarly to the microbiology report. When sending microbiology results, the system will send the highest severity flag between the culture and any isolate section in OBX-8. Note This checkbox is only available with specific product licenses. Do not require send number messages for susceptibility panel result delivery: Select this checkbox to prevent send number messages from sending for susceptibility panels when the host is set to send non-discrete messages. | ||||||||
Do not send SPM segments for microbiology isolates | Select the checkbox to not send SPM segments for microbiology OBR isolates. | ||||||||
Note This checkbox is only available with specific product licenses. | |||||||||
Send suppressed microbiology antibiotic result codes in OBX-13 | Select the checkbox to include codes for antibiotic sensitivity suppression in OBX-13. When enabled, coded values will be included with antibiotic results to a host if the antibiotic's MIC or interpretation were suppressed on the Microbiology Work Card Sensitivity Panels tab. When enabled, the following codes will be sent in antibiotic result OBX-13 segments:
Note This checkbox is available only with a Microbiology module license. | ||||||||
Send Isolate Observations as NTE segments | Select the checkbox to report isolate observation tests as an NTE segment of the isolate itself instead of as a top-level OBX segment itself. This setting is available for HL7 2.3 and HL7 2.5.1. | ||||||||
AP Settings | |||||||||
Send AP results in a format | Select an option from the drop-down list to send AP order choices in a
Note This checkbox is only available with specific product licenses. | ||||||||
Send Order Placer ID When AP Part Placer ID Is Blank | Select to send the order choice's placer ID in OBR-2 and ORC-2 for the part when there is no placer ID information at the AP part level. |
HL7 2.5.1 Settings — Outbound Interfaces
Use the Outbound Interface tab of the Interface Configuration page to configure HL7 2.5.1 settings.
Send HL7 2.5.1 formatted messages | Select the checkbox to configure the format in which HL7 2.5.1 messages are formatted. When this checkbox is selected, several subsettings become available in the HL7 2.5.1 Settings section. ORM: Select this checkbox to send HL7 2.5.1 messages in the ORM format. ORU: Select this checkbox to send HL7 2.5.1 messages in the ORU format. ADT: Select this checkbox to send HL7 2.5.1 messages in the ADT format. |
---|---|
Meaningful Use | Select the checkbox to add extra information that is only required for Meaningful Use, but not necessarily required for HL7 2.5.1. |
HL7 2.5.1 output type | Select an option from the drop-down list to determine the type of output. Select either Not Specified, ELR, or LRI from the drop-down list. |
Populate truncation encoding character | Select the checkbox to control whether or not the truncation encoding character will be populated on outbound HL7 2.5.1 interfaces. |
Populate OBX for patient age at collection | Select the checkbox to populate OBX messages for a patient's age at the time of collection. The test age must be setup on the Inbound Host on the Order Choice Setup page where tests, age, abbreviation, description, LOINC codes, and host codes are configured. |
HL7 2.5.1 receiving application universal ID | Enter text into the field to specify the receiving application universal ID for HL7 2.5.1. |
HL7 2.5.1 receiving application universal ID type | Enter text into the field to specify the receiving application universal ID type for HL7 2.5.1. |
HL7 2.5.1 receiving application namespace ID | Enter text into the field to specify the receiving application namespace ID for HL7 2.5.1. |
HL7 2.5.1 receiving facility universal ID | Enter text into the field to specify the receiving facility universal ID for HL7 2.5.1. |
HL7 2.5.1 receiving facility universal ID type | Enter text into the field to specify the receiving facility universal ID type for HL7 2.5.1. |
HL7 2.5.1 receiving facility namespace ID | Enter text into the field to specify the receiving facility namespace ID for HL7 2.5.1. |
Patient visit number ID type code | Enter text into the field to specify the patient's visit number in the form of an ID type code. This field allows the user to configure the value to populate outbound HL7 2.5.1 messages with the patient visit number ID type code. The value in this configuration will define what populates HL7 2.5.1 messages as the PV1-19.5 component. |
ICD-9 coding system name | Enter text into the field to allow the ICD-9 coding system name that populates HL7 2.5.1 messages to be configurable. |
ICD-10 coding system name | Enter text into the field to allow the ICD-10 coding system name that populates HL7 2.5.1 messages to be configurable. |
Send SN data type as NM data type when SN is only numeric | Select the checkbox to change OBX-2 and OBX-5 to an NM data type in an HL7 2.5.1 message if the SN data type would have been a numeric answer. |
Populate only the LOINC description | Select the checkbox to have the system only populate the LOINC code descriptions in outbound HL7 2.5.1 messages. |
Allow CWE data type population for OBX segments without SNOMED codes | Select the checkbox to allow CWE data types to be sent in OBX segments even if there are no SNOMED codes associated with the result. In these cases, OBX-5.1 through OBX-5.8 will be blank, and OBX-5.9 will be filled in with the text from the original result. |
Send specimen rejection messages | Select the checkbox to parse incoming HL7 2.5.1 specimen rejection messages. Specimens for these messages will automatically be rejected once the inbound rejection message is parsed. |
Send order-level comments after the ORC segment | Select the checkbox to parse HL7 2.5.1 order-level comments after ORC segments. |
Send PV1-3 information in the PV1 segment of ORM messages | Select the checkbox to send PV1-3 information in order messages. |
Send patient level comments before NK1 segment | Select the checkbox to have segment ordering place the NTE segment before the NK1 segment. |
Handle LOINC scale and result data type mismatches by | Select an option from the drop-down list. Select either Sending a blank result with X in OBX-11 or Sending the result with a host code instead of the LOINC code from the drop-down list. Select the Sending a blank result with X in OBX-11 option to have the system maintain the previous functionality of clearing out OBX-2, OBX-5, and sending X in OBX-11 for the result. This option is selected by default. Select the Sending the result with a host code instead of the LOINC code option to have the system send the result that was saved to the database, but OBX-2 will be changed to either SN for numeric results or ST for all other results, and OBX-3 will be changed to use a host code instead of the mismatched LOINC code. |
Populate OBR segment with the system sample ID | Select an option from the drop-down list. Select either Never, in field 18, or in field 19. Never is selected for the setting by default. When Never is selected, the previous functionality of filling OBR-18 and OBR-19 with the values received from a host for the order will be maintained. When in field 18 is selected, OBR-18 will be populated with the sample ID for the order choice. When in field 19 is selected, OBR-19 will be populated with the sample ID for the order choice. If the order choice has multiple samples with different IDs, then OBR-18/OBR-19 will be repeated for each different ID. |
HL7 2.5.1 Patient Identifier List | Select the Add button in the HL7 2.5.1 Patient Identifier List section to allow the user to define a patient identifier list for the order of patient identifiers to be sent in the HL7 2.5.1 message. Options for the patient identifiers are MRN and SSN and Master Patient ID 1 and Master Patient ID 2. The user can define a patient identifier type code to be sent with each identifier type. The default priority of patient identifier types is MRN and SSN, and the default type codes for each patient identifier are MR and SS, respectively. When Master Patient ID 1 is added to the identifier list, the patient's master patient ID is sent in a repeat of PID-3 (if it exists). When Master Patient ID 2 is added to the identifier list, the patient's master patient ID 2 is sent in a repeat of PID-3 (if it exists). In both cases, the ID is sent out with the Identifier Type Code specified in the identifier list. |
HL7 2.5.1 User Identifier Priority List | Select the Add button in the HL7 2.5.1 User Identifier Priority List section to allow the user to define a priority list for the order of user identifiers to be sent in the HL7 2.5.1 message. Options for the identifiers are NPI, Host Code, and Record Key. The user can define an identifier type code to be sent with each identifier type. The default priority of identifier types is NPI, Host Code, then Record Key, and the default type codes for each identifier are NPI, PRN, and PN, respectively. |
HL7 2.5.1 Location Identifier Priority List | Select the Add button in the HL7 2.5.1 Location Identifier Priority List section to allow the user to define a priority list for the order of location identifiers to be sent in the HL7 2.5.1 message. Options for the identifiers are NPI, Host Code, and Record Key. The user can define an identifier type code to be sent with each identifier type. The default priority of identifier types is NPI, Host Code, then Record Key, and the default type codes for each identifier are NPI, FI, and XX, respectively. |
Miscellaneous Tab
Setting the HL7 Parameters
Use the Miscellaneous tab of the Interface Configuration page to configure the host-specific HL7 parameters.
Send to this interface the placer SID from ___ | Use the Search field to select a host for this field from the Host Selection page. See the Host Selection topic. When you populate this field with a host, the system will hold order messages until there is a host SID for the order choices from the selected host. When the system receives a Number Assign message from that host, it sends the order message to the lab for all collected order choices that were being held. |
---|---|
Hold order request messages to this interface until an ADT message is parsed for the patient | If this is enabled for a host, then in cases where the selected host is the configured order request host for an ordering location, the system will hold the order request messages until an ADT is received as long as neither of the following are true: 1. An ADT has already allowed that order to send order request messages, and 2. an ADT message was received for that patient on the same calendar day. Each of the sub-settings determine when the system will generate and transmit the send number messages to the host: Allow sending order request messages to this interface only if the order has been assigned an encounter: Select the checkbox to have the system hold SN messages for ADT update setting. This setting will wait for the order to have an encounter assigned to it. Allow sending order request messages to this interface if ADT message was parsed that calendar day: Select the checkbox to have the system limit the orders updated when parsing an ADT message to only updating the order with the most recent order date/time. |
Held orders to be updated must have an ordering location that matches the location in the ADT message received from this interface | Select the checkbox to have the system update held orders and transmit the send number request messages only for those orders where the location in the ADT message matches the held orders' ordering locations. |
Held orders to be updated must have an order date on or before the date the ADT message received from this interface is parsed | Select the checkbox to have the system update held orders and transmit the send number request messages only for those orders with the same or earlier order date than the date the ADT message is parsed. |
Held orders to be updated must have the most recent order date/time when the ADT message received from this interface is parsed | Select the checkbox to have the system update held orders and transmit the send number request messages only for the order with the most recent order date/time. |
Held orders to be updated must have an open order choice when the ADT message received from this interface is parsed | Select the checkbox to have the system update held orders and transmit the send number request messages only for those orders that still have a non-cancelled order choice that has not yet received final results. |
Update held orders' encounter when the ADT message received from this interface is parsed for the patient | Select the checkbox to have the system update the orders' encounter information when it parses an ADT message for the patient. Update encounter on collected orders only: Select the checkbox to have the system to only update encounters on collected orders. Update encounter on orders only when Admit Date (PV1-44) in ADT matches the order's: Select the checkbox to have the system restrict when encounters are updated for a patient's order when an inbound ADT message is parsed. Update encounter on orders only when the location (PV1-11) in the ADT matches the sample's collection location: Select the checkbox to limit how often an order's encounter will be updated based on the parsed ADT message's location information. A location will be read from the PV1-11 field and will be used to match to the held order's collection location. Do not update the encounter on standing orders when the Ordering Location is configured to carry the encounter: Select the checkbox to have the system not update the encounter on standing orders when the Ordering Location is configured to carry the encounter. |
Update held orders' collection location and samples' collection location when ADT message is parsed for the patient | Select the checkbox to have the system update the orders' collection location and the samples' collection location information when it parses an ADT message for the patient. |
Run order entry rules on held orders when the ADT message received from this interface is parsed for the patient | Select the checkbox to have the system run order entry rules on held orders when it parses an ADT message for the patient. |
Check patients into the Waiting Room when parsing ADT Patient Arrival (A10) messages containing Temporary Location Information (PV1-11) AND 'WR' as an Admit Source (PV1-14) | Select the checkbox to allow the host to process ADT Patient Arrival (A10) messages that contain PV1-11 information and WR in the PV1-14 field and automatically add the patient to the Waiting Room page. |
Print labels for open orders when parsing ADT Patient Arrival (A10) messages containing Temporary Location Information (PV1-11) AND NOT 'WR' as an Admit Source (PV1-14) | Select the checkbox to print labels for open orders when parsing (A10) messages containing (PV1-11) messages and not WR as a (PV1-14) message. The system will parse ADT Patient Arrival (A10) messages that contain a location in PV1-11 and does not have WR in the PV1-14 field. When receiving such a message, it will search for all open orders for the patient with a collection location equal to the location in PV1-11 and having a proposed draw stamp within the same calendar day of parsing the message and print labels for those orders to the collection location after processing the label printing rules. |
OK | Select the button to accept changes on all the Interface Configuration tabs and return to the Hosts details page. Note that you must select the Save button on the Hosts details page to complete saving the changes within the system. |
Cancel | Select the button to return to the Hosts details page without saving any changes. |
Documentation Tab
Documenting Host Interfaces
Use the Documentation tab of the Interface Configuration page to record interface setting information.
Documentation | Enter the information in the field. To edit host interface information, highlight or delete text already displayed in the field, then modify as desired. |
---|---|
Hide | Select the link to hide the field. Note that the system automatically saves the entered information. |
OK | Select the button to accept changes on all the Interface Configuration tabs and return to the Hosts details page. Note that you must select the Save button on the Hosts details page to complete saving the changes within the system. |
Cancel | Select the button to return to the Hosts details page without saving any changes. |