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:

• Accessing this Page
• Accessing Interface Configuration Tabs

Inbound Interface Tab:

• Setting Up the Inbound Interface
• HL7 2.5.1 Settings - Inbound Interfaces
• HL7 2.5.1 Settings (Patient ID, Sample ID, and Fasting)

Outbound Interface Tab:

• Setting Up the Outbound Interface
• HL7 2.5.1 Settings - Outbound Interfaces

Miscellaneous Tab:

• Setting the HL7 Parameters

Documentation Tab:

• Documenting Host Interfaces

Accessing this Page

• Click the Add button, followed by the Interface Configuration button in the Interfaces section on the Hosts administration 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:
   • Select the Send ACK to Host checkbox to send an acknowledgement message back to the host system. Note that selecting this checkbox enables the Send ACK in the same MLP connection checkbox.
   • Select the Send ACK in the same connection checkbox to immediately send an ACK message once a message is received.
   • Select the Enhanced ACK mode option to send out the acknowledge codes in acknowledge message MSA segments in enhanced mode as CA (Commit Ack) and CR (Commit Reject), instead of the default mode of AA, AR.
   • Select the Parse Application & Facility for ACK option to have Copia parse the application and facility values for ACK messages from the message they correspond to, if populated. If not populated, Copia does not modify the placement of the application and facility values for ACK messages.
5. Select one or more Parse these message types options to configure the framing characters of your HL7 transmissions.
• ORM: Select the general order message to accept the initiation of order information following a trigger event; for example, when a test is ordered, changed, updated, or cancelled.
• ORU: Select the observation message to enable Copia to respond to an ORM message; for example, send results.
• ADT: Select the Admissions, Discharge, and Transfer message to accept messages containing patient demographics and information.
• DFT: Select the Detailed Financial Transaction message to accept messages containing charges and credits.
• MFN: Select the Master File Notification message to have Copia send MFN messages upon a modification to one of the properties for a location/user, if the location/user has a host code defined for the host.
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. Select the When parsing linked order documents using the sample ID, do not force a match between this lab and the sample's routed checkbox to allow hosts to match parsed linked order documents to orders using sample ID file names without forcing a match between the host and the sample's routed lab. This setting is a subsetting of the Linked Order Document Path field and will be disabled when the Linked Order Document Path text field is empty. Inbound interfaces using this new setting can ignore the lab matching requirement when matching inbound linked order documents to orders with sample ID file names. If the sample ID matches samples on more than one order, the linked order document will not be attached, and the inbound message will be marked as failed.

   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.

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:
• To fill the Default result linked document order choice priority field, click the Search button and select the desired default from the Priority Search page. See the Priority Search topic.
• Select the Suppress HL7 result generation when parsing HPDF files from this host option to control if HL7 result messages are generated when a HPDF file is parsed.
• Select the Suppress non-HL7 result delivery when parsing HL7 result messages from this host option to suppress non-HL7 result report generation and delivery when parsing HL7 result messages from the selected host. When this setting is enabled, Copia will only send out HL7 results to host interfaces when it parses an HL7 result message from the configured host.
• Select an option from the Linked Result Document Filename Format drop-down list to determine which filename format Copia should expect the selected host to use for linked result documents (SID_FirstName_LastName, SID_FirstName, SID_LastName, or SID_EncounterID). If you use the "SID_FirstName_LastName" option, you may also add optional order choice-specific information to the filename (e.g., SID_FirstName_LastName_OrderChoiceHostCode_Status_Flags). This format also supports the addition of optional order choice-specific information added to the filename.
• Select an option from the Linked Result Document HPDF Filename Format drop-down list to define the filename format to expect for HPDF files.
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:
    • Port: Enter the port name in the Port field. This field is required if the MLP option is selected. Note that there is a 5-character limit for the port number. Also, Copia throws an error if the number entered is over 65536 (the max port number).
    • Force socket closed after __ seconds: Enter a value to define how many seconds Copia allows an MLP listener to listen to a socket and not receive any data before it forces the socket closed. This helps the situation where Copia is not able to tell that the other host has terminated the socket connection. Note that entering a value of zero leaves the socket open.
    • Host's ID: Select an option from this drop-down field to determine which field Copia uses to get the Host ID. This Host ID is used to determine which host the message is coming from. By default, Copia selects MSH-4.2, but you may select from the first two components of MSH fields 3, 4, 5, and 6.
    • Frame End: Enter the ending characters for messages. This tells Copia where a message ends. Note that all hosts using the same inbound port must use the same inbound framing characters, so changing this field on one host will change this on all hosts using the same inbound port.
    • Port Mapper Script: Select an option to define the Mapper script that Copia should run on the message before it ever places it on the inbound queue. This allows the Mapper script to determine the origin of the message based on content of the message when the Mapper script assigns a sending facility. Click the Edit or Create New buttons to edit or create a script in the Edit Mapper Script page. See the Admin: Edit Mapper Script topic.
15. Select the File Transfer option to use flat files to transfer messages. Complete the following fields to set up a shared directory structure.
• File Extension: Enter the file extension of the inbound files Copia searches for and parses. This field is required.
• In Path: Enter the full path name to the host's inbound directory. Click the Test button to verify the file path. This field is required.
• Completed Path: Enter the full path name for the inbound backup directory. Click the Test button to verify the file path.
• Use a lock file: Select this option and enter a file name in the Name field to have Copia create a lock file with the specified name when it begins operating on an inbound file, and then delete it when it is finished operating on the file.
16. Select the Web Service option to transfer messages via an HL7 interface. Complete the following fields to further configure the interface:
• Web Service URI: Enter the Uniform Resource Identifier for the web service, and select the type of interface: "Quest Interface," "Orchard Interface," "Orchard Vet Interface," or "Orchard Device Engine Interface." This field is required if you are using the Quest interface.
• Poll every __ minute(s): If you select "Quest Interface," you may enter the time in minutes that Copia will wait to check with the Quest hub to see if there are any new results for the interface.
• Web Service User Name: Enter the user name for the web service account. This field is required.
• Web Service Password: Enter the password for the web service account. This field is required.
• Confirm Web Service Password: Re-enter the password for the web service account. This field is required.
• Record in Activity Log: Select this checkbox to add logging capabilities to inbound and outbound vet data hosts in Copia. This is only available if "Orchard Vet Interface" is selected.
17. Select the Allow to run multi-threaded 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 Allow Fix Order entries to be automatically rerun for this host after 5 minutes checkbox to automatically rerun the entries on the Fix Orders administration once. This will cause the entries associated to that host on the Fix Orders administration page to automatically rerun as if the Rerun button was clicked once after five minutes. Once it has been automatically rerun, it will not rerun again unless manually selected.
19. 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.
20. Select the Hold ADT messages (A04 and A08) for at least ___ seconds and then parse the most recent message for that patient 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.
21. 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.
22. 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.
23. 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.
24. 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.
25. 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.
26. 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.
27. 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.
28. 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.
29. 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.
30. 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.
31. 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.
32. Select the Match on active insurance only checkbox to have Copia match inbound insurance company/plan on active-only entries.
33. 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.
34. 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.
35. 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.
36. Select the Ignore expired insurances based on the date in IN1-13 checkbox to have Copia 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.
37. Select the Accept ADT change patient identifier messages (A47) 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.
38. 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.
39. 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.
40. 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.
    • Using a five minute window of time: Combines incoming orders into one order if: the messages are for the same patient and the orders were sent within a 5-minute time period, based on the collection date and time of the orders. Copia looks at the order date/time to group the orders. This feature looks 2.5 minutes into the past, and 2.5 minutes into the future, creating a 5-minute time period.
    • Using the host specified placer ID: Combines incoming orders into one order if: the placer IDs match, the messages are for the same patient, and the orders were sent within a 28-day time period, based on the collection date and time of the orders.
    • Using the host specified placer group number: Combines incoming orders into one order if: the placer group numbers match, the messages are for the same patient, and the orders were sent within a 28-day time period, based on the collection date and time of the orders.
    • Create duplicate order if matching order is received with different Placer Order Number: Select this option to allow Copia to create new orders instead of disregarding matching orders as duplicates. When this is enabled, if Copia 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 Copia 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 Copia 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.
    • Copy ordering provider to existing order as result recipient when order message is deemed a duplicate and is disregarded: Select this option to have Copia 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 Copia 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.
41. 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.
42. Select the 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 checkbox to allow the cancellation message settings to be applied to the discontinued (DC) message behavior.
43. 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.
    • 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 Copia to process cancel order messages if the order choice has not been collected.
    • If the order choice is collected and no result has posted to it: Select this option to allow Copia 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 Copia 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 Copia to process cancel order messages if a final result has posted to the order choice.
      • Only allow cancellation if ORC-3 is populated: Select this option to make the cancellation message process for an order choice with final results conditional on the message content in field ORC-3. The setting If a final result has posted to the order choice must be selected for this checkbox to be available.
    • Only if this is the ordering host or if testing is routed to this host: Select this option to allow Copia to process cancel order messages only if this is the ordering host, or if testing is routed to this host.
44. 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.
45. Select the Reactivate order choice when an order request message is parsed for a cancelled order choice checkbox to have Copia reactivate an order choice when an order request message is parsed for a cancelled order choice.
46. 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 using a filler order number if there is no match found when using the placer order number for a cancel order choice message.
47. Select the Allow cancelling of order choices when placer ID matches on multiple orders 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.
48. 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.
49. 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."
50. 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."
51. 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."
52. 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).
53. 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.
54. 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.
55. 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.
• Select the Allow old behavior to parse Collection Time from ORC-7 for specific cases 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 will now be able to choose whether the system will still try to parse a value from ORC-7 or not.
56. 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.
57. 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.
58. 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.
• Select the Allow Order Time to update from inbound change order messages checkbox to allow Copia 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.
59. 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."
60. 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.
61. 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.
• Select the Only if Provider NPI is blank checkbox to have Copia update an ordering provider's NPI value based on an inbound ORM HL7 message.
62. 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.
63. 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.
64. 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.
65. 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.
66. Select the Use the host-specified PV1-50 value (if not blank) as the Copia order ID when creating an order checkbox to have Copia 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.
    • Select the subsetting Send to the Fix Order queue if the host-specified value is not unique checkbox to have Copia 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 Copia-generated ID due to the received order ID override already existing as an order ID in the system.
67. 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.
• Select the Do not use host-specified filler order numbers on split orders checkbox to have Copia not use host specified filler order numbers on split orders.
68. 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.
69. 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.
70. 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.
71. Select the Do not allow order choices to combine onto collected samples when creating orders from order messages checkbox to have Copia prevent an order choice that attaches to an existing order from combining with a sample that has already been marked as collected.
72. 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.
73. 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.
74. 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.
75. 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.
76. Select the Automatically associate ordering provider with ordering location's practice when parsing order messages checkbox when an order message is received by Copia 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.
77. 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.
78. 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.
    • Select an option from the Force match on 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.
79. 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.
80. 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.
81. 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.
82. 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.
83. 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.
84. Select an option from the Copy clinical information drop-down to specify when Copia 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.
85. Enter a host code into the Parse medication OBXs with host code 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.
86. Select the Do not automatically create new medications checkbox for a host when medications are received on an inbound HL7 messages that does not exist in Copia's database. It will not be automatically created if this setting is applied.
87. Select the Parse NK1 segments 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, select either "Save no additional information," "Save alias," "Save alias and last dose information," "Save and create alias," or "Save and create alias and last dose information" from the list. "Save no additional information" is the default option in order to preserve the current functionality and will not parse any additional information from inbound medication OBX segments. The "Save alias" option will parse existing aliases from the medication OBXs, but will not create any aliases which do not exist. The "Save alias and last dose information" option has the functionality of "Save alias," but will parse the last dose information from the OBX as well. The "Save and create alias" option will parse existing aliases from the medication OBXs and will create any aliases which do not exist. The "Save and create alias and last dose information" option has the functionality of "Save alias," but will parse the last dose information from the OBX as well.
88. Select the Assign the patient's most recent active encounter to new orders without encounter information 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.
89. Select the Assign the message's phlebotomist to the attached order choice's samples for SN messages 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.
90. 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.
91. Select the Update phlebotomist from results checkbox to update the phlebotomist in Copia from results received from Harvest LIS.
92. Select the Update ordering provider from results checkbox to have Copia update the ordering provider OBR-16 upon receipt of an ORU message.
93. Select the Parse result messages with an OBX-2 value of "TX" as if "TX" were "ST" checkbox to cause TX data-typed OBX segments to be parsed as if the OBX was designated as an ST data result segment.
94. 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.
95. 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.
96. 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.
97. Select the Import historic data into Copia checkbox to keep Historical Imports from delivering results.
98. 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.
99. 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.
100. 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.
101. Select the Verify checksum for HL7 embedded binary files 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.
102. 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]."
103. 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.
104. 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.
105. 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.
106. Select the Use the host-specified PV1-50 value (if not blank) as the Copia order ID when creating an order checkbox to have Copia 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.
     • Select the subsetting Send to the Match Results queue if the host-specified value is not unique checkbox to have Copia 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 Copia-generated ID due to the received order ID override already existing as an order ID in the system.
107. Enter the location of the sender's patient ID (PID) within the HL7 message in the Field number of sender's PID field.
108. Enter the location of the receiver's patient ID (PID) within the HL7 message in the Field number of receiver's PID field.
109. 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).
• Select the Do not automatically create referring providers option to have Copia not automatically create referring providers.
110. 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.
111. 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.
112. Select an option from the Get value for Master Patient ID #2 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.
     • Select the Use location and Master Patient ID #2 to identify patient 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.
113. 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.
114. 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.
115. 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.
116. 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.
• Use patient match rules even when a match is found based on the patient ID in the message: Select this option 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 Copia 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 Copia 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 Copia consider the suffix of the patient's name (e.g., Jr, Sr, etc.).
• Match patient on date of birth: Select this option to have Copia consider the patient's date of birth when making matches.
• Match patient on Sex: Select this option to have Copia consider the patient's sex when making matches.
• Match patient on MRN: Select this option to have Copia consider the patient's MRN when making matches.
• Match patient on SSN: Select this option to have Copia consider the patient's SSN when making matches.
117. 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.
• 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.
• Match to orders with an order ID matching the PV1-50 value received in the result message: Select this checkbox to have Copia 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.
118. 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 Copia 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 Copia 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.
119. 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.
120. 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]

HL7 2.5.1 Settings - Inbound Interfaces

Use the Outbound Interface tab of the Interface Configuration page to configure HL7 2.5.1 settings.

1. Select the Expect HL7 2.5.1 formatted messages for message types 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.
2. Enter text into the HL7 2.5.1 Placer Order Number universal ID field to specify the universal ID for the placer order number.
3. Enter text into the HL7 2.5.1 Placer Order Number universal ID type field to specify the universal ID type for the placer order number.
4. Enter text into the HL7 2.5.1 Placer Order Number namespace ID field to specify the namespace ID for the placer order number.
5. Enter text into the HL7 2.5.1 Placer Group Number universal ID field to specify the universal ID for the placer group number.
6. Enter text into the HL7 2.5.1 Placer Group Number universal ID type field to specify the universal ID type for the placer group number.
7. Enter text into the HL7 2.5.1 Placer Group Number namespace ID field to specify the namespace ID for the placer group number.
8. Select the If a Code System Name is blank, parse it in as a Local Code System Name checkbox to have Copia parse a code system name in as a Local Code System is the code system name is blank.
9. Select the Location Local Code System Name checkbox to specify the name of the Location's Local Code System. This is a required field.
10. Select the User Local Code System Name checkbox to specify the name of the User's Local Code System. This is a required field.
11. Select the Order Choice Local Code System Name checkbox to specify the name of the Order Choice's Local Code System name. This is a required field.
12. Select the Automatically create UCUM records checkbox to have Copia automatically create UCUM records.
13. Select the Automatically create additive records checkbox to have Copia automatically create additive records.
14. Select the Automatically create sample type records checkbox to have Copia automatically create sample type records.
15. Select the Automatically create sample type modifier records checkbox to have Copia automatically sample type modifier records.
16. Select the Automatically create collection method records checkbox to have Copia automatically collection method records.
17. Select the Automatically create specimen source site records checkbox to have Copia automatically create specimen source site records.
18. Select the Automatically create specimen source site modifier records checkbox to have Copia automatically create specimen source site modifier records.
19. Select the Automatically create SNOMED records checkbox to have Copia 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 identifer, 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.
20. Select an option from the Parsed phone number format 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.
21. Select an option from the When LOINC scale does not match the results value drop-down. 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.
    • Select the Evaluate as if the outbound setting "Allow CWE data type population for OBX segments without SNOMED codes" is set 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.

[Return to Top]

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.

1. Use the HL7 2.5.1 Patient ID Matching Criteria section to configuration matching patient IDs for HL7 2.5.1 inbound interfaces.
   • The table displays the order number, HL7 field, ID type code, what the patient ID should match on, the ability to match on assigning authority, and the ability to delete the ID.
   • Click the Add button to add patient ID matching criteria to the table.
   • Select the Match on Assigning Authority 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.
   • Click the X 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.
2. Use the HL7 2.5.1 Sample ID Matching Criteria (OML(CA), OML(NA), OML(NW), OML(SC), OML(SN), OML(XO), ORU) 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.
   • Click the Add button to add sample ID matching criteria to the table.
   • Click the X 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 "Copia Order ID" will only be performed for lab interfaces.
3. Use the HL7 2.5.1 Fasting Settings section to control how fasting information is parsed from OBX segments in HL7 2.5.1 messages.
   • Enter text into the LOINC codes 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.
   • Enter text into the Host codes 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.
   • Enter text into the CWE coding system 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.
   • Enter text into the CWE yes code field to specify what values to look for in OBX-5.1 to specify "yes" for when OBX-5 is a CWE data type.
   • Enter text into the CWE no code field to specify what values to look for in OBX-5.1 to specify "no" for when OBX-5 is a CWE data type.
   • Enter text into the CWE unknown code field to specify what values to look for in OBX-5.1 to specify "unknown" for when OBX-5 is a CWE data type.
   • Enter text into the CWE N/A code 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.

[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.
• No change: Select this option to have Copia leave the capitalization of transferred information as it exists in the files.
• Entire patient name upper (LAST, FIRST M): Select this option to have Copia format patients' names as "LAST, FIRST M."
• All of patient last name and first letter of first name upper (LAST, First m): Select this option to have Copia format patients' names as "LAST, First m."
• First letter of each patient name upper (First, Last M): Select this option to have Copia format patients' names as "Last, First M."
• Entire patient name lower (last, first m): Select this option to have Copia format patients' names as "last, first m."
• Entire HL7 message upper: Select this option to have Copia convert the entire alpha content of messages sent to this host to upper case. This rule will also be applied if a forwarded message from an inbound interface is placed on this outbound interface. This is the only host capitalization rule that is applied to forwarded message content.
• All of patient last name and first letter of first name and middle name upper (LAST, First M): Select this option to have Copia format patients' names as (LAST, First M).
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.
• Socket Batch Size: Enter the maximum number of messages that will be sent in a single socket connection.
• Wait for ACK (sec): Enter the number of seconds the interface should wait for an ACK message after sending a message using MLP. The default value is 10, but you may enter a value from 1-100. This field is disabled if MLP is not the outbound delivery method or if Expect ACK from Host and Expect ACK in the same connection are not enabled.
• ACK Listen Interval (msec): Enter the number of milliseconds Copia will wait between each time it checks for the ACK message from the host. This will only apply when the ACK message is not immediately received from the host. The default value is 500 milliseconds (or half a second). Valid values range from 10 to 5,000 milliseconds. Note that the settings Expect ACK from Host and MLP (TCP/IP sockets) must be selected in order to use this setting.
• Socket Close Delay (msec): Enter the amount of time (in milliseconds) the data stream remains open after messages are sent. Copia defaults to a 50 millisecond delay.
• Machine Address: Enter the address for the system receiving Copia's messages. This field is required. Click the Test button to verify the address.
• Port: Enter the port name in the Port field. This field is required. Note that there is a 5-character limit for the port number. Also, Copia throws an error if the number entered is over 65536 (the max port number).
• Frame Start: Enter the starting characters for messages. This tells Copia where a new message begins.
• Frame End: Enter the ending characters for messages. This tells Copia where a message ends.
• Keep socket open: Select this option to allow outbound MLP interface connections to stay connected between messages. This setting is disabled by default.
13. Select the File Transfer option to use flat files in transferring messages. Complete the following fields to set up a shared directory structure.
• File Extension: Enter the file extension of the files Copia sends to the outbound directory.
  • Out Path: Enter the full path name to the host's outbound directory. Click the Test button to verify the file path.
• Select an option from the Populate PID segment with patient MRN# drop-down list to designate into which PID segment (2, 3, 4, or 18) Copia should place the MRN#. By default, Copia selects the "Never" option, which means it will not put the MRN# in any PID segment.
• Use a lock file: Select this option and enter a file name in the Name field to have Copia create a lock file with the specified name when it begins operating on an outbound file, and then delete it when it is finished operating on the file.
• Use a manifest: Select this option and enter a file name in the Name field to have Copia create a file with the specified name that contains a list of each output file it creates. Copia will begin a new file whenever the existing file is deleted.
14. Select the Web Service option to transfer messages via an HL7 interface. Complete the following fields to further configure the interface. These are required fields.
• Web Service URI: Enter the Uniform Resource Identifier for the web service. Click the Test button to test the web service URI to ensure that it works correctly. Select an option from the drop-down list to select where to send results via the web service. Select either "GlobalVet Link," "Orchard Interface," "Orchard Vet Interface," "Prelude Dynamics," or "Quest Interface" from the drop-down list.
• Web Service User Name: Enter the web service user name.
• Web Service Password: Enter the web service password.
• Confirm Web Service Password: Enter the web service password again to confirm the password.
• Record in Activity Log: Select this checkbox to add logging capabilities to inbound and outbound vet data hosts in Copia. This is only available if "Orchard Vet Interface" is selected.
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.
• Select the Do not require Placer Order Number checkbox if Copia should not require hosts to have a placer order number to send cancellation messages.
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.
• Select the Respect HL7 Break Level for change order choice messages checkbox to have Copia 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.
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.
• Select the Send accessioned change status message when no placer order number is available checkbox to allow Copia to send accessioned change status messages when no placer order number is available.
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 Force ORM(SN) messages to be sent when this host is the order request host when parsing an ORM(NW) message 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.
23. Select the Send DFT messages to XIFIN web service option to have Copia send DFT messages to the XIFIN web service.
• Web Service URI: Displays the web service URI web address that points to the web service.
• Organization: Displays the name of the organization.
• Organization Alias: Displays the alias name of the organization.
• Web Service User Name: Displays the web service user name.
• Web Service Password: Displays the web service password.
• Confirm Web Service Password: Displays confirmation of web service password.
24. 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.
• Send single ORC segment per tube/container in messages: Select this option to have Copia limit the number of ORC segments sent for each tube and/or container in all types of messages because some host systems may not interpret the HL7 message correctly if there are multiple ORC segments for a single sample.
• Send single ORC segment per sample in messages: Select this option to have Copia limit the number of ORC segments sent for each sample in all types of messages because some host systems may not interpret the HL7 message correctly if there are multiple ORC segments for a single sample.
• Send single ORC segment per sample ID in messages: Select this option to have Copia limit the number of ORC segments sent for each sample ID in all types of messages because some host systems may not interpret the HL7 message correctly if there are multiple ORC segments for a single sample.
25. 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.
26. Select the Force profile components onto their own messages checkbox to have Copia force profile components onto their own messages.
27. 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.
28. 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.
• Select the Only send the preceding profile sement. Do not send segments for profile components in order messages checkbox to only send the OBR segment representing the profile host code in order messages sent to a Harvest LIS lab.
29. 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.
30. Select the Send UDF in ZCF segments checkbox to have Copia send ZCF segments to hosts other than Orchard Harvest LIS. 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.
31. Select the Send Patient Additional Info in ZCP segments checkbox to have Copia send patient-related additional info in ZCP segments.
32. Select the Send Order Choice Additional Info in ZCO segments checkbox to have Copia send order choice-related additional info in ZCO segments.
33. Select the Send Test Additional Info in ZCT segments checkbox to have Copia send test-related additional info in ZCT segments.
34. Select an option from the Populate ZCF, ZCP, ZCO, and ZCT segments using delimiter 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.
35. 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.
• Select the Only populate historic messages when order is final checkbox to have Copia limit the population of historic data in HL7 result messages to when the order is final.
36. 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.
37. Select the Send diagnosis codes in ORU messages checkbox to have Copia control if ICD codes will populate in ORU result messages.
38. Select the Send patient comments to this host checkbox to have Copia send patient comments to a specified host.
39. 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.
40. 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.
41. Select the Send insurance information in number assign messages checkbox to control if number assign messages should contain insurance information.
42. Select the Send insurance information in ORU messages checkbox to send insurance information to the selected host in result messages.
43. Select the Send result-level linked documents in OBX segments checkbox to send all active result-level linked documents in OBX segments when sending HL7 messages.
44. Select the Send order-level linked documents in ZCU segments in ORU messages 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.
45. 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.
• Select the Populate each linked document content once per ORC checkbox to have Copia 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.
• Select the Order by newest linked document checkbox to order result linked document OBX segments from newest to oldest so that the newest results are sent first.
46. 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.
47. 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:
• MSH field 3 Override (Sending Application)
• MSH field 4 Override (Sending Facility)
• MSH field 5 Override (Receiving Application)
• MSH field 6 Override (Receiving Facility)
• MSH field 11 Override (Processing ID)
48. 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.
49. Select the Assign Billing Status to reflexed order choices based on the parent order choice 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 Copia will fall back on the default billing status assignment.
50. 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.
51. 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.
52. Enter the location of the sender's patient ID (PID) within the HL7 message in the Field number of sender's PID field.
53. Enter the location of the receiver's patient ID (PID) within the HL7 message in the Field number of receiver's PID field.
54. 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.
55. 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.
56. 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."
57. 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.
58. 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.
59. 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).
60. 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.
61. 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.
62. Select an option from the Populate PID segment with Master Patient ID #2 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.
63. 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.
64. 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.
65. 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.
66. 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.
• From User ID: Copia will populate provider host code with user ID.
• From NPI then User ID if no NPI: Copia will populate from NPI then the user ID if there is no NPI.
• Never: Copia will never populate.
67. 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:
• With collection location: Copia will populate with the collection location.
• With collection location, else proposed collection location, else ordering location: Copia will populate with collection location, else proposed collection location, else ordering location.
• With encounter linked location: Copia will populate the encounter linked location in outbound ORM and ADT messages.
• With ordering location: Copia will populate with the ordering location.
• With proposed collection location: Copia will populate with the proposed collection location.
68. 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:
• With the financial class: Copia will populate with the financial class.
• With the insurance type: Copia will populate with the insurance type.
69. Select an option from the Populate PV1-44 in ADT ___ when encounter open date is not set drop-down list to populate PV1-44 value in outbound ADT messages with of of the following:
• With the patient create date: Copia will populate the creation date for the patient.
• With the most recent sample collection date: Copia will populate the most recent sample collection date.
• With the oldest sample collection date: Copia will populate the oldest sample collection date.
• With the order's proposed collection date: Copia will populate the order's proposed collection date.
70. Select an option from the Populate OBX-5 using delimiter drop-down list to define a delimiter used when sending OBX-5 messages:
• Select either "," or ";" from the drop-down list.
71. 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:
• Never: Copia will never populate.
• With the testing Host ID (default): Copia will populate with the testing host ID.
• With the received testing location code (the code Copia received in the OBX-15 field in the incoming message): Copia will populate with the received testing location code.
• With all received data: Copia will populate with all received data.
72. 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:
• With the time of DFT message creation: Copia will populate FT1-5 with the date and time it creates the DFT message.
• With the testing completion date: Copia will populate FT1-5 with the most recent date/time approved stamp for the reportable results for that order choice at the time of DFT creation.
73. 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:
• With testing host ID: Copia will populate FT1-16.4 with the host ID of the host record for the lab where the order choice was tested.
• With testing location ID received in result message: Copia will populate FT1-16.4 with the testing location that was received in OBX-15.1 in a result message, if it has parsed the value when it generates the billing message.
• With testing location ID if available else the testing host ID: Copia will populate FT1-16.4 with the testing location that was received in OBX-15.1 in a result message, if it has parsed the value when it generates the billing message. If that value does not exist, it will populate the field with the host ID of the host record for the lab where the order choice was tested.
74. 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:
• The sample's deliery date: Copia will populate with the sample's delivery date.
• The order's delivery date: Copia will populate with the order's delivery date.
• The order's delivery date if available else the sample's delivery date: Copia will populate with the order's delivery date if available else the sample's delivery date.
• The sample's delivery date if available else the order's delivery date: Copia will populate with the sample's delivery date if available else the order's delivery date.
75. 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:
• Parent placer order number: Copia will populate with the parent placer order number.
• Parent order choice host code: If an order choice was reflexed onto an order due to a result evaluation rule, then the host code of the order choice that triggered the reflex will be populated. If that order choice does not have a host code, or the current order choice was not reflexed, then OBR-29.1 will remain blank.
• Parent order choice host code if available else parent placer order number: Copia will populate with the parent order choice host code if it is available or else it will populate the parent placer order number.
76. Select an option from the Populate patient practice drop-down list to populate the patient practice in HL7 messages with one of the following:
• Never: Copia will never populate.
• Name in PV1-3.5: Copia will populate the name in the PV1-3.5 field.
• ID in PV1-3.5: Copia will populate with the ID in the PV1-3.5 field.
• Name in PV1-3.9: Copia will populate with the name in the PV1-3.9 field.
• ID in PV1-3.9: Copia will populate with the ID in the PV1-3.9 field.
77. 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."
• Select the Only follow version 2.6 after effective ICD-10 start date checkbox to have Copia 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.
• Select the Do not apply version 2.6 standards for ICD-9 codes checkbox to prevent Copia 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.
78. 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.
• Select the Only follow version 2.6 after effective ICD-10 start date checkbox to have Copia only follow version 2.6 standards after the effective ICD-10 start date.
79. 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.
80. 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.
81. 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.
82. 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.
83. 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.
84. 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).
85. 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.
86. 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.
87. 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.
88. 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.
89. Enter a host code into the Send medication OBXs in ORM messages with host code field to have Copia 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.
    • Select the Send medications in ORU messages 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.
90. Select the Send patient time of birth for patients less than a year old 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.
91. Select the Send encounter comments checkbox to send the comments added to the encounter in NTE segments.
92. 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]

HL7 2.5.1 Settings - Outbound Interfaces

Use the Outbound Interface tab of the Interface Configuration page to configure HL7 2.5.1 settings.

1. Select the Send HL7 2.5.1 formatted messages 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.
2. Select the Meaningful Use checkbox to add extra information that is only required for Meaningful Use, but not necessarily required for HL7 2.5.1.
3. Select an option from the HL7 2.5.1 output type drop-down list to determine the type of output. Select either "Not Specified," "ELR," or "LRI" from the drop-down list.
4. Select the Populate truncation encoding character checkbox to control whether or not the truncation encoding character will be populated on outbound HL7 2.5.1 interfaces.
5. Select the Populate OBX for patient age at collection 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.
6. Enter text into the HL7 2.5.1 receiving application universal ID field to specify the receiving application universal ID for HL7 2.5.1.
7. Enter text into the HL7 2.5.1 receiving application universal ID type field to specify the receiving application universal ID type for HL7 2.5.1.
8. Enter text into the HL7 2.5.1 receiving application namespace ID field to specify the receiving application namespace ID for HL7 2.5.1.
9. Enter text into the HL7 2.5.1 receiving facility universal ID field to specify the receiving facility universal ID for HL7 2.5.1.
10. Enter text into the HL7 2.5.1 receiving facility universal ID type field to specify the receiving facility universal ID type for HL7 2.5.1.
11. Enter text into the HL7 2.5.1 receiving facility namespace ID field to specify the receiving facility namespace ID for HL7 2.5.1.
12. Enter text into the Patient visit number ID type code 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.
13. Enter text into the ICD-9 coding system name field to allow the ICD-9 coding system name that populates HL7 2.5.1 messages to be configurable.
14. Enter text into the ICD-10 coding system name field to allow the ICD-10 coding system name that populates HL7 2.5.1 messages to be configurable.
15. Select the Send SN data type as NM data type when SN is only numeric 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.
16. Select the Populate only the LOINC description checkbox to have Copia only populate the LOINC code descriptions in outbound HL7 2.5.1 messages.
17. Select the Allow CWE data type population for OBX segments without SNOMED codes 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.
18. Select the Send specimen rejection messages 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.
19. Select the Send order-level comments after the ORC segment checkbox to parse HL7 2.5.1 order-level comments after ORC segments.
20. Select the Send PV1-3 information in the PV1 segment of ORM messages checkbox to send PV1-3 information in order messages.
21. Select an option from the Handle LOINC scale and result data type mismatches by 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 Copia 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 Copia 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.
22. Click 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." 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.
23. Click 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.
24. Click 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.

[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:
• Select the Allow sending order request messages to this interface only if the order has been assigned an encounter checkbox to have Copia hold SN messages for ADT update setting. This setting will wait for the order to have an encounter assigned to it.
• Select the Allow sending order request messages to this interface if ADT message was parsed that calendar day checkbox to have Copia limit the orders updated when parsing an ADT message to only updating the order with the most recent order date/time.
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.
• Select the Update encounter on collected orders only checkbox to have Copia to only update encounters on collected orders.
• Select the Update encounter on orders only when Admit Date (PV1-44) in ADT matches the order's checkbox to have Copia restrict when encounters are updated for a patient's order when an inbound ADT message is parsed.
• Select the Update encounter on orders only when the location (PV1-11) in the ADT matches the sample's collection location 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.
• Select the Do not update the encounter on standing orders when the Ordering Location is configured to carry the encounter checkbox to have Copia not update the encounter on standing orders when the Ordering Location is configured to carry the encounter.
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. Select the 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) 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.
12. Select the 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) checkbox to print labels for open orders when parsing (A10) messages containing (PV1-11) messages and not WR as a (PV1-14) message. Copia 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.
13. 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]

 © 2018 Orchard Software Corporation