Admin: Interface Configuration

Page Description

Use the Interface Configuration page to activate and configure the inbound and/or outbound interface between Copia 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, Copia may have the ability to auto-create locations and practices from HL7 interfaces' messages. This feature performs the same functionality as when synchronization (with a Harvest LIS) auto-creates a location or practice. This setting can only be enabled by Orchard Software personnel.

Click on the tab that corresponds to the task you wish to perform.

Inbound Interface Tab

Use the Inbound Interface tab to configure the interface parameters for all messages received by Copia.

Outbound Interface Tab

Use the Outbound Interface tab to configure the interface parameters for all messages sent by Copia.

Miscellaneous Tab

Use the Miscellaneous tab to configure the host-specific HL7 parameters.

Documentation Tab

Use the Documentation tab to record interface setting information.

For more help, click one of the following links:

Inbound Interface Tab:

Outbound Interface Tab:

Miscellaneous Tab:

Documentation Tab:

Accessing this Page

[Return to Top]

Accessing Interface Configuration Tabs

  1. Click the Inbound Interface tab to configure the interface parameters for all messages received by Copia.
  2. Click the Outbound Interface tab to configure the interface parameters for all messages sent by Copia.
  3. Click the Miscellaneous tab to configure the host-specific HL7 parameters.
  4. Click the Documentation tab to record interface setting information.

[Return to Top]

Setting up the Inbound Interface

Use the Inbound Interface (messages received by Copia) tab of the Interface Configuration page to configure the interface parameters for all messages received by Copia.

  1. Open the Inbound Interface tab. See the "Accessing Interface Configuration Tabs" section above.
  2. Select the Inbound is active checkbox to activate the inbound interface. Clear this checkbox if the inbound interface is not set.
  3. Enter in the Delay processing messages for __ seconds field the number of seconds Copia should wait before processing messages in the Inbound Queue. Enter "0" to have Copia immediate process incoming messages.
  4. Select one or more ACK settings for the interface:
  5. Select one or more Parse these message types options to configure the framing characters of your HL7 transmissions.
  6. Select the Allow Duplicate MSH Control IDs checkbox to allow Copia to accept duplicate control IDs (contents of MSH-10) on incoming HL7 messages.
  7. Select an option from the Inbound Mapper Script 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, click 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 Admin: Edit Mapper Script topic. If you have selected a script before clicking the Create New button, then Copia makes a copy of the selected script that you use as the basis for the new script.
  8. Enter in the Linked Order Document Path field the file path to the directory where Copia should look for files to add as order-level attachments (not as results). The names of these files should contain either the Copia order ID or a Copia sample ID that is unique to a single order sent to a host. Copia 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 Copia to import these files. Copia currently supports PDF, JPG, GIF, and BMP file types. Files must have one of the listed extensions for Copia to process them properly. Click the Test button to verify the file path.

    Note that if the file name contains an integer and is delimited by an underscore (_), Copia will accept multiple files at the same time for a single order.

    When Copia 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 Admin: Inbound Queue topic. When it finds a match, Copia 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.

  9. Enter in the Linked Result Document Path field the file path to the directory where Copia 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. Copia uses this file name to identify the order to which it should attach the new results from the file. Copia currently supports PDF, JPG, GIF, and BMP file types, as well as HPDF files, which are result files sent from Orchard Harvest LIS. Files must have one of the listed extensions for Copia to process them properly. Click the Test button to verify the file path. Enter in the Wait to pick up file __ seconds field the number of seconds Copia should wait before picking up linked result documents out of the configured directory in the Linked Result Document Path field.

    10. Note that if the file name contains an integer and is delimited by an underscore (_), Copia will accept multiple files at the same time for a single order choice.

    When Copia 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 Admin: Inbound Queue topic. When it finds a match, Copia 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.

  10. If you have established an Inbox Document Path, you may also establish the following settings:
  11. Enter in the Linked Patient Document Path field the file path to the directory where Copia 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. Copia 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, Copia will not link the document.
  12. Click the Message Forwarding button to set up message forwarding from one host to another using the Message Forwarding page. See the Admin: Message Forwarding topic.
  13. Select the None option to switch the database setting back to turn off the MLP or File Transfer options. This is selected by default.
  14. 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:
  15. Select the File Transfer option to use flat files to transfer messages. Complete the following fields to set up a shared directory structure.
  16. Select the Web Service option to transfer messages via an HL7 interface. Complete the following fields to further configure the interface:
  17. Select the Allow to run multithreaded with a maximum thread count of __ option and enter a number to have Copia parse multi-threaded inbound messages for a single host. The number you enter defines the maximum number of threads Copia parses in inbound messages. The default value is 5.
  18. Select the Use ORC format checkbox to enable Copia to transmit or receive ORC segments. Clear the checkbox to restrict Copia from sending or receiving ORC segments.
  19. Select the Use location to identify practice for ADT checkbox to have Copia 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.
  20. Select the Delete encounters for A11 and A38 ADT messages checkbox to have Copia 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.
  21. Select the Limit orders updated by ADT A02 messages to orders with a matching encounter checkbox to limit orders updated by transfer ADT (A02) messages to those with the same encounter.
  22. Select the Update patient open orders when ADT A02 and A08 change default patient insurance set checkbox to control if a patient's open orders should have their insurance information updated when Copia parses an A02 or A08 ADT message from that interface for that patient.
  23. Select the Update patient open orders when ADT A02 updates Ordering Location 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.
  24. Select the Update patient open orders when ADT A02 updates encounter room number checkbox to update the room number of all open orders assigned to the encounter when Copia parses an ADT A02 message that updates an encounter room number.
  25. Select the Update patient open orders when ADT A02 updates Collection Location checkbox to update a collection location on all open orders when a new collection location is received in an ADT A02 message.
  26. Select the Store encounter diagnosis code mappings from ADT messages checkbox to have Copia parse DG1 segments from ADT messages and add them to the corresponding encounter.
  27. Select the ADT with no insurance means that the patient has no insurance checkbox to control whether or not Copia 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 Copia 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.
  28. Select the Get insurance priority from IN1-22 checkbox to have Copia set the insurance priority based on the value of the IN1-22 field in HL7 transmissions. Copia allows the following values to indicate priorities: 1, P, or p for Primary; 2, S, or s for Secondary; 3, T, t for Tertiary. Copia 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 Copia determines priority using the order in which the IN1 segments are received.
  29. Enter a year value in to the Minimum Valid Year 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.
  30. Select the Match on active insurance only checkbox to have Copia match inbound insurance company/plan on active-only entries.
  31. Select the Remove demographics data when field holds empty double quotes checkbox to allow HL7 messages to designate that Copia should remove a demographics value from the database. Normally, Copia 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 Copia designates that that piece of information should be removed from the Copia database.
  32. Select the Auto-fill Guarantor Insurance information with Primary Insured when parsing GT1 segments with a relationship to Patient to "Self" checkbox to have Copia 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.
  33. Select the Accept transsexual values for patient sex to this host checkbox to have Copia accept the defined transsexual value for the patient's sex from the host (e.g., M/F instead of M or F/M instead of F). When transsexual values are disabled, Copia interprets M/F as M and F/M as F. Note that if this setting is turned off for an interface, Copia receives M or F, and the matching patient is actually the corresponding transsexual value, Copia will not change the patient's sex.
  34. Select the Use location and Sender's PID to identify patient 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.
  35. Select the Use location and Sender's PID to identify patient for SN messages checkbox to enable "Use location and Sender's PID to identify patient" to apply to SN messages.
  36. Select an option from the Match order components for a patient by drop-down list to configure how Copia 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.
  37. Select the Use time range to match order when processing cancel order choice messages checkbox to prevent Copia from using a time range constraint when finding a matching order choice for an HL7 cancellation message.
  38. Select one or more options from the Process cancel order choice messages section to control when it is acceptable for Copia to process cancellation HL7 messages received from a host.
  39. Select the Process most recent order match for cancel order choice messages checkbox to have Copia process the most recent order match for cancel order choice messages.
  40. Select the Accept standing order messages checkbox to allow this interface to create standing orders. It will not be able to do so, unless you enable this setting.
  41. Select an option from the Get value for Ordering Location drop-down list to choose from which PV1 or ORC field Copia 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."
  42. Select an option from the Get value for Collection Location drop-down list to choose from which PV1 or ORC field Copia 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."
  43. Select an option from the Get value for Order Choice Expiration Date drop-down list to choose from which OBR field Copia should pull the order choice expiration date from. Select either "Never" or "from OBR field 27.5." The default value is "Never."
  44. Select an option from the Get value for MRN# drop-down list to choose from which PID field Copia should pull the patient MRN# when the patient's demographics are being updated (or created).
  45. Select an option from the Get value for Patient ID #2 drop-down list to choose from which PID field in HL7 inbound messages Copia should pull the value to put into the Patient ID #2 field. You may view or edit alternate patient IDs by clicking the More button next to the Patient ID field on the Demographics page. See the Demographics topic.
  46. Select an option from the Get value for Patient ID #3 drop-down list to choose from which PID field in HL7 inbound messages Copia should pull the value to put into the Patient ID #3 field. You may view or edit alternate patient IDs by clicking the More button next to the Patient ID field on the Demographics page. See the Demographics topic.
  47. Select an option from the Get value for Proposed Collection Time drop-down list to choose from which field in HL7 inbound messages Copia 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.
  48. Select an option from the Get value for Collection Time drop-down list to choose from which field in HL7 inbound messages Copia 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.
  49. Select an option from the Get value for Order Time drop-down list to choose from which field in HL7 inbound messages Copia 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.
  50. Click the Get value for order choice Cancel Time 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.
  51. Select the Match Orders for inbound change order messages in a window plus or minus ___ 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."
  52. Select an option from the Get value for Ordering Staff drop-down list to choose from which field in HL7 inbound messages Copia 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.
  53. Select an option from the Get value for Provider NPI drop-down list to choose from which field in HL7 inbound messages Copia 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.
  54. Select an option from the Clinical Information delimiter in OBX-5 drop-down list to define a delimiter for clinical information. Select either "," or ";" from the list.
  55. Select the Get value for Billing Status from IN1 field 32 checkbox to have Copia 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.
  56. Select the Hold order messages for at least __ seconds to allow order choices for a patient to accumulate before ORM message parsing 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.
  57. Select the Prevent sample creation during ORM message parsing if the sample is not to be marked as collected checkbox to prevent Copia from creating sample records for inbound ORM messages, as long as the sample would not be marked as collected.
  58. Select the Use the host-specified filler order number (if not blank) as the Copia sample ID when creating an order checkbox to make Copia use the filler order number (ORC-3, OBR-3) as Copia's sample ID. When this option is enabled and an order message from a host has the filler order number filled in, Copia uses this ID as the Copia sample ID. If this setting is enabled and the filler order number field is blank, then Copia will look to see if the Use this host's sample ID as the Copia 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, Copia will attempt to use the host's lab-specific setting to use the ordering host's sample ID as the Copia sample ID for samples routed to that lab.
  59. Select the Match using the filler order number if no match is found using the placer order number for cancel order choice messages checkbox to have Copia match cancellation messages to orders using the Copia 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, Copia will attempt to match the cancellation message to an order on the Copia order ID using the value in ORC-3 and OBR-3. The message will then be processed normally.
  60. Select the Use this host's sample ID as the Copia sample ID when creating an order checkbox to have Copia use the external host's sample ID as Copia'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 Copia sample ID when creating an order checkbox is enabled (see above). If neither of these are available, Copia will attempt to use the host's lab-specific setting to use the ordering host's sample ID as the Copia sample ID for samples routed to that lab. Note that Copia 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.
  61. Select the Do not allow order choices with different collection times to combine onto the same sample when creating orders from order messages checkbox to have Copia prevent order choices from being combinable, if they are received via electronic order and have different collection times.
  62. Select the Parse blank values for patient fasting from result messages checkbox to have Copia 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 Copia will ignore any blank fasting values in result messages. This setting is turned on by default.
  63. Select the Display inbound parsed order choice comments on requisition and manifest checkbox to have Copia display inbound parsed order choice comments on requisitions and manifests.
  64. Select the Send inbound parsed order choice comments to host electronically checkbox to have Copia send inbound parsed order choice comments to the host electronically.
  65. Select the Parse patient comments from ORM and ORU messages checkbox to have Copia 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.
  66. Select the Automatically create users when no match is found checkbox 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 Copia is creating an order from a result).
  67. Select an option from the Default ABN Signed Status 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, Copia 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 Copia.
  68. Select the Reactivate order choice when an order request message is parsed for a cancelled order choice checkbox to have Copia reactivate order choices when an order request message is parsed for a cancelled order choice.
  69. Enter the value Copia 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.
  70. Enter a value to control the code that Copia 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 Harvest LIS interfaces.
  71. Select an option from the Interpret blank value for patient fasting as ____ when creating an order drop-down list to set the default fasting status for new orders received via HL7. Copia 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 Admin: Locations topic.
  72. Select an option from the Get value for Account Number drop-down list to set where Copia reads account numbers from result messages and associates them with a match result entry.
  73. Select the Update a user's Provider setting using MFI-1 in MFN messages checkbox to control whether or not the parser will update the Provider setting. By default it will not parse the Provider setting updates.
  74. Select the Update collection times from result message content checkbox to have Copia allow result messages from the selected host to update the collection time for samples.
  75. Select the Update phlebotomist from results checkbox to update the phlebotomist in Copia from results received from Harvest LIS.
  76. Select the Update ordering provider from results checkbox to have Copia update the ordering provider OBR-16 upon receipt of an ORU message.
  77. Select the Store OBR-18, OBR-19, OBR-56, OBR-57, OBR-58, and OBR-59 values from result messages if none have been stored checkbox to allow Copia to store OBR-18, OBR-19, OBR-56, OBR-57, OBR-58, and OBR-59 values when parsing result messages. Note that Copia will only store a value if the order choice has not already had a value stored for that specific field.
  78. Select the Store OBX-15, OBX-23, OBX-24, and OBX-25 values from result messages if none have been stored checkbox to allow Copia to store OBX-15, OBX-23, OBX-24, and OBX-25 values when parsing result messages. Note that Copia will only store a value if the order choice has not already had a value stored for that specific field.
  79. Select the Skip matching results to existing orders [historic import] checkbox to disable result matching to existing orders in Copia during imports. By skipping the matching, Copia 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 Copia knows that each message represents a new order.
  80. Select the Import historic data into Copia checkbox to keep Historical Imports from delivering results.
  81. Select the Allow HL7 embedded binary file to be received in muliple OBX segments checkbox to accept base64 encoded PDFs in multiple OBX segments. When this setting is enabled, HL7 files can be parsed into copia 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. Copia will also look at OBX-5.2 and confirm it is multi-part.
  82. Select the Allow HL7 embedded binary files to be associated with more than one order choice 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 Copia 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.
  83. Select the Parse HL7 embedded binary files from ZEF segments checkbox to have Copia 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.
  84. Select the Automatically create diagnosis code records for unmatched diagnosis codes checkbox to have Copia automatically create diagnosis codes if diagnosis codes are not found when parsing HL7 messages. When a new ICD code is created in Copia, 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]."
  85. Select the If the practice is set to force unique MRNs, fail any duplicate MRNs instead of enforcing uniqueness checkbox to have Copia 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.
  86. Select the Display inbound parsed order choice comments on lab report checkbox to have Copia display inbound parsed order choice comments on the lab report.
  87. Enter one or more characters in the Reflex flag field to define the HL7 reflex flag that Copia reads and writes for the host. If you enter a value for the reflex flag for the host, Copia 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.
  88. Enter the location of the sender's patient ID (PID) within the HL7 message in the Field number of sender's PID field.
  89. Enter the location of the receiver's patient ID (PID) within the HL7 message in the Field number of receiver's PID field.
  90. Select the Automatically create users when no match is found 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 Copia is creating an order from a result).
  91. Click the Automatically synchronize users with the selected hosts 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 Harvest LIS. 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. Unselecting the checkbox removes the name from the table.
  92. Select the Allow matching received patient ID against Copia patient ID option to allow a patient in an inbound HL7 interface message to match to a Copia patient by specifying the Copia patient ID in the receiver's patient ID field in that HL7 message.
  93. Select the Create Match Results messages for results received on cancelled order choices option to have Copia add to the Match Results page when a result is received for an order choice that has been cancelled.
  94. Select the Attempt to match on profile when no matching order choice is found for cancel order choice messages option to have Copia 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.
  95. Select the Attempt to match on profile host codes when no matching order choice is found for change order choice messages option to have Copia 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.
  96. In the Patient Match Rules section, define one or more patient matching rules for messages sent from the host system to Copia. Copia 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, Copia 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 Copia 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. To enable patient matching rules, select the Use patient match rules option. You may then define the match rules for the interface. by default, Copia matches messages using patients' entire first and last names, but you may modify the options as desired.
  97. In the Sample Matching Rules section, define one or more sample matching rules for messages sent from the host system to Copia. Copia uses these rules to determine to which order or sample it assigns results when it receives them from the current host. Note that Copia always matches the sample ID values, so you cannot disable that rule.
  98. The following settings affect Result messages in addition to Cancellation, Change Order, Change Status, and Billing Messages.
  99. In the Host Code Updating section, define when Copia 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. Select the Is Active checkbox for one or more hosts to enable host code updates. Then, 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, Copia updates the active host’s host code, as long as one does not exist and it is not a duplicate.
  100. Click the OK button to accept changes on all the Interface Configuration tabs and return to the Hosts details page. Note that you must click the Save button on the Hosts details page to complete saving the changes within Copia. Click the Cancel button to return to the Hosts details page without saving any changes.

[Return to Top]

Setting up the Outbound Interface

Use the Outbound Interface (messages sent by Copia) tab of the Interface Configuration page to configure the interface parameters for all messages sent by Copia.

  1. Open the Outbound Interface tab. See the "Accessing Interface Configuration Tabs" section above.
  2. Select the Outbound is active checkbox to activate the outbound interface. Clear this checkbox if the outbound interface is not set.
  3. Enter a value into the Hold messages for ___ seconds to have Copia hold messages for a specific number of seconds.
  4. Enter a value into the Allow to run multithreaded with a maximum thread count of ___ field to specify a maximum thread count. The default value is 5.
  5. Enter a value into the Attempt to send messages ___ times before marking messages as failed field to specify how many times Copia attempts to send messages before marking them as failed. The default value is 3.
  6. Select an option from the Delay the creation of order messages for this host by __ seconds drop-down list to delay creating order messages for this outbound interface by the designated number of seconds. This allows Copia 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 Copia can only delay plain ORM messages.
  7. Select the Expect ACK from Host checkbox to have Copia 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, then Copia expects the other host to send back the same start and end blocks that Copia sent out. In addition, if this checkbox is selected, Copia 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. Copia will alert you if you attempt to save this potentially harmful combination of settings for an outbound host interface.
  8. Select the Expect ACK in the same connection checkbox to have Copia expect an immediate ACK message.
  9. Select an option from the Outbound Mapper Script 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, click 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 Admin: Edit Mapper Script topic. If you have selected a script before clicking the Create New button, then Copia makes a copy of the selected script that you use as the basis for the new script.
  10. Select an option from the Capitalization drop-down list to control how Copia formats patient names when sending messages.
  11. Select the None option to switch the database setting back to turn off the MLP or File Transfer options. This is selected by default.
  12. Select the MLP (TCP/IP sockets) 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 Copia not use the MLP (TCP/IP sockets) option.
  13. Select the File Transfer option to use flat files in transferring messages. Complete the following fields to set up a shared directory structure.
  14. Select the Web Service option to transfer messages via an HL7 interface. Complete the following fields to further configure the interface.
  15. Click the Outbound ADT button to define for which practices' patients that host should receive demographics in the ADT Events page. See the Admin: ADT Events topic.
  16. Click the Outbound DFT 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. See the Admin: DFT Events topic.
  17. Select the Send MFN messages checkbox to send MFN messages upon addition, deactivation, or modification of locations and users. When checked, Copia 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.
  18. Select the Send change order choice message checkbox to allow Copia to accept and send order choice change messages ("XO"). Currently, Copia will only update the priority, collection time, and diagnosis codes from the message. A change message won’t be created unless one of those fields changes on an existing order in Copia. Change messages will be sent though the orders interface, much like cancellation messages.
  19. Select the Send order completed change status message checkbox to have Copia send order completed change status messages.
  20. Select the Send accessioned change status message checkbox to allow Copia to send change status messages to the selected host.
  21. Select the Send end visit A03 ADT messages checkbox to have Copia generate A03 ADT messages when either parsing A03 ADT messages or when an encounter is closed.
  22. Select the Send DFT messages to XIFIN web service option to have Copia send DFT messages to the XIFIN web service.
  23. Select the HL7 break level from the HL7 Break Level drop-down list (PID, OBR, or ORC). Note that the break level subdivides the HL7 message by patient, order choice, or order. Copia defaults to the patient break level.
  24. Select the Use ORC format checkbox to enable Copia to transmit or receive ORC segments. Clear the checkbox to restrict Copia from sending or receiving ORC segments.
  25. Select the Force profile components onto their own messages checkbox to have Copia force profile components onto their own messages.
  26. Select the Group profile components onto their own messages checkbox to have Copia 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.
  27. Select the Send preceding segment to identify profile in result messages to Harvest LIS labs checkbox to have Copia populate result HL7 messages with an OBR segment to represent the profile. If you select this option.
  28. Select the Send preceding segment to identify profile in result messages checkbox to have Copia send a segment representing the profile along with the components of a profile in HL7 result messages.
  29. Select the Send UDF in ZCF segments checkbox to have Copia send ZCF segments to hosts other than Orchard Harvest LIS.
  30. Select the Send Patient Additional Info in ZCP segments checkbox to have Copia send patient-related additional info in ZCP segments.
  31. Select the Send Order Choice Additional Info in ZCO segments checkbox to have Copia send order choice-related additional info in ZCO segments.
  32. Select the Send Test Additional Info in ZCT segments checkbox to have Copia send test-related additional info in ZCT segments.
  33. Select a value from the Append at most __ historic result messages to all result messages sent to this host drop-down list to force additional messages containing past result data to populate a single ORU message. Copia will populate ORU messages with historic data for the order choices being reported. When this setting is turned on, Copia can populate an ORU message with more than one MSH segment. Select a value between 0 and 5. The default value is 0.
  34. Select the Send NK1 segments in messages checkbox to have Copia 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.
  35. Select the Send diagnosis codes in ORU messages checkbox to have Copia control if ICD codes will populate in ORU result messages.
  36. Select the Send patient comments to this host checkbox to have Copia send patient comments to a specified host.
  37. Select the Force secondary and tertiary insurance segments to populate with primary insurance segment if none exist checkbox to have Copia 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.
  38. Select the Send insurance information that has not been validated checkbox to allow Copia to transmit insurance information even if it has not been validated. See the Admin: Validate Insurance topic.
  39. Select the Send insurance information in number assign messages checkbox to control if number assign messages should contain insurance information.
  40. Select the Send insurance information in ORU messages checkbox to send insurance information to the selected host in result messages.
  41. Select the Send linked documents in OBX segments checkbox to have Copia embed linked documents in OBX segments of the OBR of the result messages sent to the selected host.
  42. In the Field delimiter, Component delimiter, Repeat delimiter, Escape delimiter, and Subcomponent delimiter fields, Copia 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.
  43. If appropriate, enter in the MSH fields values Copia should place in the MSH segment of all outbound messages to the selected host (from Copia to the host). If you enter values in the fields, Copia will send that value in the field number specified. If you leave the field blank, Copia assigns default values. Note that entering a space will not cause Copia to leave the MSH field blank; it will interpret it as an entry. You may assign values for the following fields:
  44. Enter one or more characters in the Reflex flag field to define the HL7 reflex flag that Copia reads and writes for the host. If you enter a value for the reflex flag for the host, Copia 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.
  45. Enter the value Copia 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.
  46. Enter a value to control the code that Copia 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 Harvest LIS interfaces.
  47. Enter the location of the sender's patient ID (PID) within the HL7 message in the Field number of sender's PID field.
  48. Enter the location of the receiver's patient ID (PID) within the HL7 message in the Field number of receiver's PID field.
  49. Select the Send PID of Copia if PID is not mapped for host checkbox to enable Copia to send new patient information with a Copia PID, if a host-specific patient ID does not exist.
  50. Select or clear the Send CRLF in Hex Format checkbox to determine how Copia sends CRLF (carriage returns and line feeds) in HL7 messages. If you select this option, Copia sends CRLFs in Hex format (X0d0a); if you do not select this option, Copia replaces CRLFs with spaces in HL7 messages.
  51. Select the Send corrected flag in result messages 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, Copia populates the order choice level status in OBR-25 with a "C."
  52. Select the Send results to host for orders with external ordering providers checkbox to control whether or not Copia sends HL7 result messages to the selected host if the order has an external ordering provider. It is disabled 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.
  53. Select an option from the Populate location namespace identifiers with drop-down list to send either location IDs or names for HL7 facilities as namespace identifiers.
  54. Select an option from the Populate PID segment with patient MRN# drop-down list to choose into which PID field Copia should place the patient MRN# when the patient's demographics are being updated (or created).
  55. Select an option from the Populate PID segment with Patient ID #2 drop-down list to choose into which PID field Copia should place the value from the Patient ID #2 field. You may view or edit alternate patient IDs by clicking the More button next to the Patient ID field on the Demographics page. See the Demographics topic.
  56. Select an option from the Populate PID segment with Patient ID #3 drop-down list to choose into which PID field Copia should place the value from the Patient ID #3 field. You may view or edit alternate patient IDs by clicking the More button next to the Patient ID field on the Demographics page. See the Demographics topic.
  57. Select an option from the Populate OBR segment with lab filler SID drop-down list to populate the OBR segment with the lab filler sample ID in result messages (OBR segments 18-21). Copia overwrites whatever was previously in the selected OBR field with the lab filler sample ID.
  58. Select an option from the Populate ordering location address drop-down list to send the order location address in outbound HL7 messages as either a repeat of PV1-3 or ORC-13.
  59. Select an option from the Populate ordering location NPI drop-down list to control where Copia should populate the ordering location's NPI into HL7 messages as a repeat of PV1-3, ORC-13, or to not populate it.
  60. Select an option from the Populate provider host code drop-down list to determine the default value to use when the system needs to create a host code for a provider.
  61. Select an option from the Populate PV1-3.4.2 in ORM messages drop-down list to populate the PV1-3.4.2 value in outbound ORM messages with one of the following:
  62. Select an option from the Populate PV1-20 in ADT, DFT, and ORM messages drop-down list to populate the PV1-20 value in outbound ADT, DFT, and ORM messages with one of the following:
  63. Select an option from the Populate OBX-5 using delimiter drop-down list to define a delimiter used when sending OBX-5 messages:
  64. Select an option from the Populate OBX-15 drop-down list to populate the OBX-15 value in HL7 messages with one of the following:
  65. Select an option from the Populate FT1-5 drop-down list to populate the FT1-5 value in HL7 messages with one of the following:
  66. Select an option from the Populate FT1-16.4 drop-down list to populate the FT1-16.4 value in HL7 messages with one of the following:
  67. Select an option from the Populate OBR-14 with drop-down list to populate the OBR-14 value in HL7 messages with one of the following:
  68. Select an option from the Populate OBR-29.1 with drop-down list to populate the OBR-29.1 value in HL7 messages with one of the following:
  69. Select an option from the Populate patient practice drop-down list to populate the patient practice in HL7 messages with one of the following:
  70. Select the Follow HL7 Standards version 2.6 to populate DG1 segments checkbox to have Copia 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."
  71. Select the Follow HL7 Standards version 2.6 to populate FT1 segments checkbox to have Copia follow HL7 2.6 standards when populating FT1 segments. This settinc controls if the code description and coding system components will populate field FT1-19.
  72. Select the Send transsexual values for patient sex to this host option to have Copia send the defined transsexual value for the patient's sex to the host (e.g., M/F instead of M or F/M instead of F). When transsexual values are disabled, Copia interprets M/F as M and F/M as F.
  73. Select the Send double quotes in ADT message fields if an inbound message designated to remove that data option to allow Copia to send out HL7 fields that were received containing double quotes in order to remove demographics data from the database.
  74. Select the Allow for inactive order choice host codes to be sent to this host option to have Copia 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.
  75. Select the Send Sample ID Suffix to this host option to have Copia 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.
  76. Enter text into the Insurance identifier for insurance segments when no insurance exists ___ (Applies to "Local Lab (orchard)" host type field to specify an insurance identifier for insurance segments when no insurance exists. The default is SELF-PAY.
  77. Select the Use the ordering location's time zone for outbound messages option to allow Copia 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).
  78. Select the Populate OBX-3.5 with the received LOINC description checkbox to have Copia populate the OBX-3.5 field with the received LOINC code descriptions.
  79. Select the Populate OBX-23 with all received testing host data checkbox to have Copia populate the OBX-23 field with all received testing host data.
  80. Select the Populate OBX-24 with all received testing host data checkbox to have Copia populate the OBX-24 field with all received testing host data.
  81. Select the Populate OBX-25 with all received testing host data checkbox to have Copia populate the OBX-25 field with all received testing host data.
  82. Click the OK button to accept changes on all the Interface Configuration tabs and return to the Hosts details page. Note that you must click the Save button on the Hosts details page to complete saving the changes within Copia. Click the Cancel button to return to the Hosts details page without saving any changes.

[Return to Top]

Setting the HL7 Parameters

Use the Miscellaneous tab of the Interface Configuration page to configure the host-specific HL7 parameters.

  1. Open the Miscellaneous tab. See the "Accessing Interface Configuration Tabs" section above.
  2. 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 Admin: Host Selection topic. When you populate this field with a host, Copia will hold order messages until there is a host SID for the order choices from the selected host. When Copia 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.
  3. 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, Copia 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 Copia will generate and transmit the send number messages to the host:
  4. Select the Held orders to be updated must have an ordering location that matches the location in the ADT message received from this interface checkbox to have Copia 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.
  5. Select the Held orders to be updated must have an order date on or before the date the ADT message received from this interface is parsed checkbox to have Copia 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.
  6. Select the Held orders to be updated must have the most recent order date/time when the ADT message received from this interface is parsed checkbox to have Copia update held orders and transmit the send number request messages only for the order with the most recent order date/time.
  7. Select the Held orders to be updated must have an open order choice when the ADT message received from this interface is parsed checkbox to have Copia 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.
  8. Select the Update held orders' encounter when the ADT message received from this interface is parsed for the patient checkbox to have Copia update the orders' encounter information when it parses an ADT message for the patient.
  9. Select the Update held orders' collection location and samples' collection location when ADT message is parsed for the patient checkbox to have Copia update the orders' collection location and the samples' collection location information when it parses an ADT message for the patient.
  10. Select the Run order entry rules on held orders when the ADT message received from this interface is parsed for the patient checkbox to have Copia run order entry rules on held orders when it parses an ADT message for the patient.
  11. Click the OK button to accept changes on all the Interface Configuration tabs and return to the Hosts details page. Note that you must click the Save button on the Hosts details page to complete saving the changes within Copia. Click the Cancel button to return to the Hosts details page without saving any changes.

[Return to Top]

Documenting Host Interfaces

Use the Documentation tab of the Interface Configuration page to record interface setting information.

  1. Open the Documentation tab. See the "Accessing Interface Configuration Tabs" section above.
  2. Enter the information in the Documentation field.
  3. To edit host interface information, highlight or delete text already displayed in the field, then modify as desired.
  4. Click the Hide link to hide the field. Note that Copia automatically saves the entered information.
  5. Click the OK button to accept changes on all the Interface Configuration tabs and return to the Hosts details page. Note that you must click the Save button on the Hosts details page to complete saving the changes within Copia. Click the Cancel button to return to the Hosts details page without saving any changes.

[Return to Top]

 © 2015 Orchard Software Corporation