FrameworkHL7 Installation & User Guide

Transcription

1 FrameworkHL7 Installation & User Guide Version FrameworkHL7 Installation & User Guide 1

2 SoftWriters, Inc. has made every effort to ensure that this manual is correct and accurate, but reserves the right to make changes without notice at its sole discretion at any time. The software described in this document is supplied under a license and may be used or copied only in accordance with the terms of such license, and in particular any warranty of fitness of SoftWriters, Inc. products for any particular purpose is expressly excluded and in no event will SoftWriters, Inc. be liable for any consequential loss. The SWI logo and the SoftWriters, Inc. name are registered trademarks of SoftWriters, Inc. All other product names in this publication may be trademarks or registered trademarks of their owners. Copyright 2018 SoftWriters, Inc. All Rights Reserved FrameworkHL7 Installation & User Guide 2

3 Table of Contents FrameworkHL7 Installation & User Guide Table of Contents Overview 4 Installation 5 FrameworkHL7 Configuration Utility 14 FrameworkLTC Configuration 26 FrameworkHL7 Quantity Conversion Utility 35 Components 36 FrameworkHL7 Message Components 37 FrameworkHL7 Queue Manager 38 Troubleshooting 42 FrameworkHL7 Installation & User Guide 3

4 Overview Health Level Seven (HL7), is an non-profit, ANSI-accredited standards organization that provides a framework for the exchange, integration, sharing, and retrieval of electronic health information. These standards help to improve care delivery, optimize workflow. Level Seven refers to the seventh level of the Organization of Standardization (ISO) seven-layer communications model for Open Systems Interconnection (OSI). This seventh layer is the application level that interfaces directly to and performs common application services for the application processes. For more information about HL7 standards, visit FrameworkLTC uses FrameworkHL7 to send and receive electronic health information from third party applications, such as electronic medical records applications and dispensing machines. The FrameworkHL7 interface allows pharmacies to automatically add, update or delete records in FrameworkLTC using inbound HL7 messages from those third party applications. The interface will also notify third party applications of changes made in FrameworkLTC. FrameworkHL7 Installation & User Guide 4

5 Installation 1. To begin the installation, download FrameworkHL7 from the Application Download Center on the Customer Engagement Zone, Navigate to the FrameworkHL7 link listed under Other Interfaces. 2. When the message, Do you want to run or save FrameworkHL7_Setup.exe from emeeting.frameworkltc.com? displays, click Run. 3. The FrameworkLTC HL7 Interface InstallShield Wizard will begin. 4. Click Next on the Installer Welcome screen. FrameworkHL7 Installation & User Guide 5

6 5. Read and accept the License Agreement and click Next. 6. Enter the User Name and Organization Name into the Customer Information screen. FrameworkHL7 Installation & User Guide 6

7 7. Enter the name of the SQL server where the FrameworkLTC databases are located. Enter the appropriate SQL login credentials. (The login credentials are typically for the sa account. However, you can use any SQL login credentials that have permissions to the FrameworkLTC databases.) Click Next. FrameworkHL7 Installation & User Guide 7

8 8. Choose the Setup Type. The Complete installation will default the installation to the Program Files directory. To move the installation to another driver or directory, select Custom. Click Next. FrameworkHL7 Installation & User Guide 8

9 9. The Configuration window will appear. Configure the Service Settings and click Next. See the field descriptions below for more information. FrameworkHL7 Installation & User Guide 9

10 Configuration Field Definitions Number of Sleep Seconds Number of seconds the interface waits before checking/sending outgoing messages. Number of days to keep HL7 Messages Number of days that messages are kept in the FwLTC..HL7Messages table before being deleted. Number of days to keep Response Log Number of days that messages are kept in the FwLTC..InterfaceQueueLog table before being deleted. Number of days to keep Incoming Message Log Number of days that messages are kept in the FwLTC..IncomingHL7Messages table before being deleted. Listener IP Port Specifies which IP Port the interface should check for incoming messages. Batch ID for New Orders Batch ID where new order messages coming into FrameworkLTC will be placed. This value is limited to 6 characters. Batch ID for Reorders/Refills Batch ID where reorder/refill messages coming into FrameworkLTC will be placed. This value is limited to 6 characters. Default Days Supply for New Orders Value the days supply will be set to on incoming new orders if the value calculated from the messages results in zero. Copy Directions to Comments This option only applies to incoming messages. If this option is turned on, the application will append the directions (TQ1.11) to the comments (NTE.3) and place the entire string in the comments field on the order when processing a new order. Reject New Orders with Duplicate Placer Order Number This option only applies to incoming messages. If this option is turned on, the application will reject NEW order messages where the placer order number (ORC.2) already exists in Framework. When NEW orders come in through the interface, we store the placer order number in a custom field (External Order Id) on the prescription. This gives them ability to determine if we validate this field. Use HL7 NULL Rules on Incoming Transactions This option only applies to incoming messages. If this option is turned on, we will treat a missing value as NO CHANGE. For example, if we are processing a patient update message and the patient DOB is missing from the message, this means No Change to the value that is currently in Framework. If the vendor wants to NULL out a value, they must pass (two double quotes) in the field. Interface Engine Mode This option only applies to outgoinging messages. If this option is turned on, the application will stop sending messages as soon as it encounters an error (no connection or a value other than ACK in MSH.9 or a value other than AA in MSA.1). This prevents the machine from getting messages out of order. Mark Pre-Admits as Inactive This option only applies to incoming messages. If this option is turned on, the patient s status will be set to inactive when processing preadmit messages (ADT/A05). Suppress RDE^O11 (XO) Messages for Inactive Patients This option only applies to outgoing messages. If this option is turned on and the patient s status is inactive, update order messages (RDE/XO) will not be sent through the interface. Suppress Supply Orders This option only applies to outgoing messages. If this option is turned on, orders with a Rx Type of S will not be sent through the interface. This includes both the RDE and RDS messages. Value to be passed in RXE.15 - This option only applies to outgoing messages. It specifies the value that is to be passed in RXE.15. Valid values are Ro#, Rx# and FillerOrder#. Origin Code for New Orders This option only applies to incoming messages. This option specifies the origin code that we be used on new orders and billing OVERRIDE transactions. Valid values are 0 for Not Specified, 1 for Written, 2 for Telephone, 3 for Electronic and 4 for Facsimile. Translate TQ1.11 This option only applies to outgoing messages. The default value is False. It specifies if the value that is to be passed in TQ1.11 is translated or raw. FrameworkHL7 Installation & User Guide 10

11 Number of times to automatically resend error messages This option only applies to outgoing messages. The default value is 0. This value specifies the number of times that messages will be automatically be resent from the Error log. Include On Hand in the MFN Message This option only applies to outgoing MFN messages. The default value for this option is False. If this value is set to True then IIM.12 and IIM.13 will be populated in the MFN message. Turning this option on will also trigger an update message to be sent every time the on hand value changes in FrameworkLTC. Use Days Supply in DFT Message This option only applies to incoming DFT messages. The default value is False. If this value is set to True then the DaysSupply on the HRx record that is created in FrameworkLTC will be populated with the value in TQ1.6.1 instead of a calculated ratio using the quantity and days supply on the Reorder record. Suppress Supply Items This option only applies to outgoing messages. If this option is turned on, items marked as Supply Item on the Pharmacy Formulary will not be sent through the interface. This setting applies to the MFN message. Review Required on Patient Updates with AL1 Segment This option only applies to incoming Patient messages. The default value is False. If this value is set to True then the Patient Profile Needs Reviewed check box on the Patient Profile will be checked when updating an existing profile and at least one AL1 segment is present in the HL7 message. Require Equivalent Product on DFT Message This option only applies to incoming DFT messages. The default value is False. If this value is set to True then the interface will validate the product passed in FT1.29 matches (or is an equivalent) to the product on the order in FrameworkLTC. If it is not, an error #207 Not an equivalent product will be returned in the error response. Leave of Absence Status This option only applies to incoming ADT_A21 messages. This setting dictates which status we set the patient to when processing the message. The default value is INACTV. If this setting is set to something other than INACTV and the specified status is not considered to be active, the discharge date will not be set on the patient. If the setting is left blank or set to a status that does not exist, the patient status will be set to INACTV. Prefer Generics This option only applies to incoming OMP messages when the order control code is NW. The default value is False. If this value is set to True then the interface will attempt to dispense a generic product. See appendix A for additional information on product selection. This option only applies when orders are being placed directly into a batch. It is not used when the Process Incoming New Orders Through Queue box is checked on the interface configuration screen. Allow New Admissions to be processed as ReAdmissions This option only applies to incoming ADT_A01 messages where PV1.13 (Re-Admission Indiactor is not set to R ). The default value is False. If this setting is set to False, the application will return an error response of 205 Duplicate Key Identifier (This patient already exists in FrameworkLTC ) if the patient already exists in the FrameworkLTC database. If this setting is set to True, the application will attempt to process the message as a Readmission instead of throwing the duplicate key identifier error. Treat Invalid Attending PhNpi as Null The default value for this setting is False. If this setting is set to True, then an unknown key identifier error will not be returned when the PV1 7.1 Attending Physician NPI field contains an NPI that does not exist in FrameworkLTC when processing incoming patient messages. Instead, if the message is an admit type message, then the physician will be left blank. If the message is an update type message, then the physician will not be edited. Set Patient as Active on A02 Messages This option applies to incoming patient transfer messages (ADT_A02). If this option is set, then the patient s status will be changed to active (where the value is another other than active) when transferring a patient within a facility. The default value for the setting is True. Set Date Written to Dispense Date on DFT Messages The default value for the setting is False. If this setting is set to True, then the Written Date will be set to the Desipense Date when DFT messages are processed. The default value for the setting is False. FrameworkHL7 Installation & User Guide 11

12 Set Last Fill and Start Date on Reorder from DFT Messages The Transaction Date from FT1.4 will update the Last Fill Date and Start Date on the reorder on an incoming DFT message. If left blank, the fields will be populated with today's date. NOTE: These settings are global. They are set once for all interfaces using one installation of FrameworkHL7. In order to use a different set of configuration settings for an interface, a second FrameworkHL7 license must be purchased and installed on a separate server. Any changes required to be made to these settings after the installation is complete will need to be made in the FwHL7.exe.config file located in C:\Program Files\SoftWriters\FrameworkHL7 Interface. 10. Click the Install button on the Ready to Install the Program screen. FrameworkHL7 Installation & User Guide 12

13 11. When the installation wizard has completed, click Finish. FrameworkHL7 Installation & User Guide 13

14 FrameworkHL7 Configuration Utility The FrameworkHL7 Interface needs to be further configured after the installer completes. The installer will create the FrameworkHL7 Configuration Utility. Configuration steps will need to be completed using the utility as well as within FrameworkLTC. From the Start >Menu, select All Programs > SoftWriters, Inc. > FrameworkHL7 > FrameworkHL7 Configuration Utility. FrameworkHL7 Configuration Utility Setup 1. Click Setup on the FrameworkHL7 Configuration Utility. The Setup window will appear. 2. Click the Add button to add a new third party application to the FrameworkHL7 interface. 3. The ADD New Item window will appear. Complete the available fields and click Save. See the FrameworkHL7 Installation & User Guide 14

15 field descriptions below for more information. ADD New Item Field Descriptions Interface Description A name to identify the interface. Connection Method This is the mode in which the interface will connect to the third party application. The interface can connected via TCP/IP or Web Service. If TCP/IP is selected, then you will be required to enter an outgoing IP Address and Port. Outgoing IP Address The outbound messages will be sent to this IP address. This is the IP address of the third party application. FrameworkHL7 Installation & User Guide 15

16 Outgoing IP Port The outbound messages will be sent to this IP port. This is the IP port of the third party application. If Web Service is selected, then you will be required to enter an outgoing URL, User ID and Password as well as an Incoming User ID and Password. Using the web service option will require the interface to be installed on a server running IIS. Outgoing URL This is the URL that the FWHL7 interface will post the outbound messages to. (This is the URL should be provided by the third party application vendor.) Outgoing User ID This is the User ID that FWHL7 will use when posting outbound messages to the outgoing URL. Outgoing Password This is the password that FWHL7 will use when posting outbound messages to the outgoing URL. Incoming User ID This is the User ID the FWHL7 interface will use when retrieving messages from the third party application. Incoming Password This is the password the FWHL7 interface will use when retrieving messages from the third party application. Sending/Receiving Application ID This value will identify the third party application. It is included in the MSH.3.1 on all inbound messages. If these values do not match, the message will be rejected. Send ADT Message Check this box to send ADT messages outbound from the FWHL7 interface. Send MFN Messages Check this box to send MFN messages outbound from the FWHL7 interfaces. Include Compounds/IVs Check this box to send MFN messages for compounds/ivs outbound from the FWHL7 interface. Include OSS Changes Check this box to send MFN messages for On Site Stores outbound from the FWHL7 interface. Send RDE (Drug) Messages Check this box to send RDE messages for Drugs outbound from the FWHL7 interface. Send order change message when Total Quantity Dispensed is changed Check this box to send an order change message when the Total Quantity Dispensed is changed (except when posting prescriptions). Include quantity in Dispense Amount (RXE-10) field in messages from Reorders Check this box to populate the RXE-10 field with the quantity from the order on RDE messages from Reorders. If unchecked, this field will be populated with 0 (the previous behavior). Send RDE (Literal) Messages Check this box to send RDE messages for Literal Orders outbound from the FWHL7 interface. Send RDS Messages Check this box to send RDS messages for Drugs outbound from the FWHL7 interface. Apply Quantity Conversion Factors Check this box to apply a conversion factor to both inbound and outbound messages. This can be used if the third party is not using metric quantities. External Med ID Type This option will control how External Med IDs are assigned to all existing pharmacy formulary items when adding a new interface into the configuration utility. FrameworkHL7 Installation & User Guide 16

17 Process Incoming New Orders through Queue Check this box to process inbound NEW drug orders via the ERx Queue in FrameworkLTC instead of the FWHL7 interface placing the order directly into a batch. Using this option requires the pharmacy to be licensed for either Framework SureScripts or FrameworkERX and also have the erx Work Queue installed. Use Person Centric Admin Time Translation for outgoing messages Check this box to translate the Person Centric Administration Times from a general description (ex: Morning ) to specific time codes (ex: 8:00) when sending outgoing messages from FrameworkLTC. Users can set Person Centric Admininstration Times Times Translations in FrameworkLTC under File>Facility>Person Centric Admin Times Translations. Update cutoff date on orders when processing patient discharge (A03) and cancel admit (A11) messages Check this box to update cutoff dates on existing prescriptions when processing incoming patient discharge (A03) and Cancel Admit (A11) messages. Cutoff dates will only be updated when the cutoff date field is unpopulated or the current cutoff date is greater than the discharge date. Admit patient when processing patient transfer (A02) and patient update (A08) messages Check this box to admit a patient if the person does not exist within the database. Admit or Update patient when processing patient order (O09) messages Check this box to admit or update a patient when the order is procesed. Clarification Code for Billing Transactions Pull from Reorder record Select this option to attach the SCC (Submission Clarification Code) from the reorder record to the prescription history transaction that is created as a result of an inbound Billing message (DFT^P11^DFT_P11). Note that only short cycle codes (21-36) will be pulled. Use Specified Code Select an SCC (Submission Clarification Code) to attached to the prescription history transaction in FrameworkLTC that is created as a results of an inbound Billing message (DFT^P11^DFT_P11). This clarification code will be set for all interfaces using this setup. 4. After the item has been saved, the configuration utility will return you to the main Setup screen. Click Exit. FrameworkHL7 Installation & User Guide 17

18 License Keys In order for the FWHL7 interface to begin working, you will need to enter the license key provided by SoftWriters, Inc. 1. Click License Keys on the FrameworkHL7 Configuration Utility. 2. The Pharmacy list will be populated with the pharmacies defined in FrameworkLTC. Select the pharmacy being licensed. Select the correct pharmacy from the drop-down menu. 3. Click the Edit button. 4. Enter the FrameworkHL7 license key into the License Key field. (This information will be provided to you by SoftWriters, Inc.) 5. The facilities defined in FrameworkLTC will be listed next to the columns for each of the interfaces defined in Setup. Any interfaces/third party applications columns are defined in the Setup function of the FrameworkHL7 Configuration Utility. Place a check in a column to enable an interface/third party application for the corresponding facility. 6. Click Save when the licensing is complete. FrameworkHL7 Installation & User Guide 18

19 Route Mappings Route mappings can be defined between the Medi-Span and HL7 Route of Administration Codes. The list of HL7 routes are hard-coded and stored within the route mapping screen. The crossover between the Medi-Span route and the HL7 route are held in the HL7RouteTranslations in the FwLTC database. 1. Click Route Mappings on the FrameworkHL7 Configuration Utility. 2. The Medi-Span Route codes will be listed in the first column. The HL7 Route will be listed in the second column. To map the routes, select an HL7 Route from the drop down lists in the column on the right to correspond with the Medi-Span Route. 3. After the mappings are complete, click Save. 4. Click Exit to return the the FrameworkHL7 Configuration Utility menu. FrameworkHL7 Installation & User Guide 19

20 Allergy Mappings Allergy Mappings can be defined between Medi-Span and another vendor. This menu allows users to translate allergy information from vendors who not using the Medi-Span drug databases. Allergy mappings can be entered manually or imported from an Excel spreadsheet. A correctly formatted Excel spreadsheet is included in the Program Files during FrameworkHL7 installation. The spreadsheet is installed into the FrameworkHL7 Interface directory. The spreadsheet is located as the following path: C:\Program Files (x86)\softwriters\frameworkhl7 Interface\Configuration Utility\FwAllergyTrans.xlxs The spreadsheet will need to be populated with the Allergy Code, Description, the Medi-Span Allergy Class, and the Medi-Span Allergy Drug. The Allergy Code and Description are from the third party vendor and will need to be manually entered into the spreadsheet. The user can choose either a Medi-Span Allergy Class or a Medi-Span Allergy drug for mapping, but not both. The Medi-Span Allergy Class will be selected from the drop-down list in the field. The Medi- Span Allergy Drug can be found using a search dialog by clicking the browse button to the right of the field. The Allergy Mappings are held in the HL7AllergyTranslations in the FwLTC database. FrameworkHL7 Installation & User Guide 20

21 1. Click Allergy Mappings on the FrameworkHL7 Configuration Utility. 2. The Allergy Mappings window will appear. Click Import. 3. Enter a description for the coding system. The Coding System must match the value being passed in the Patient Allergy Information Segment (AL1). Sequence 3.3. Click Continue. 4. An Open window will display. Browse to the import spreadsheet location, C:\Program Files (x86)\softwriters\frameworkhl7 Interface\Configuration Utility. Highlight the FwAllergyTans.xlsx file. Click Open. FrameworkHL7 Installation & User Guide 21

22 5. While the file is importing, the Allergy Mappings screen will indicate the import is running displaying a message of Working at the bottom of the window. 6. When the import is complete, the utility will display a message indicating the number of records that were imported. Click Ok to return to the Allergy Mapping screen. 7. The new allergy mappings will be visible in the grid. To manually enter mappings, select a row that does not contain data. Enter the Coding System, the Other Allergy Code, and the Other Allergy Description. Select the Medi-Span Allergy Code from the the drop down list. When finished entering allergy mappings, click Save. 8. Click Exit to return to the main FrameworkHL7 Configuration Utility window. FrameworkHL7 Installation & User Guide 22

23 Send Initial Data The Send Initial Data function will push data from the FrameworkLTC database to another vendor. 1. Click Send Initial Data from the FrameworkHL7 Configuration Utility. 2. The Send Initial Data window will appear. The facilities that have been enabled for at least one interface will be listed in the top grid of the Send Initial Data screen. The bottom grid will contain those interfaces that have been defined in the Setup function. 3. Select a facility and an interface to send the data for by its row in each grid. FrameworkHL7 Installation & User Guide 23

24 4. Checkboxes at the bottom of the window will determine which data is sent to the interface. The Send Intitial Data function can send messages for Active Patients, Active Drug Orders, Active Literal Orders, the Pharmacy Formulary, the On Site Store Formulary, and/or Compounds/IVs. Check the appropriate boxes. See the table below for information on the specific messages. Option Send Active Patients Send Active Drug Orders Send Active Literal Orders Send Pharmacy Formulary Send On Site Formulary Send Compound/IVs Type of Message Sent ADT^A01^ADT_A01 RDE^O11^RDE_O11 (NW) RDE^O11^RDE_O11 (NW) MFN^M15^MFN_M15 (MAD) MFN^M15^MFN_M15 (MAD) MFN^M15^MFN_M15 (MAD) 5. Once all criteria has been selected, click Send. 6. A Success message will appear if all messages have been correctly sent. Click Ok to return to the FrameworkHL7 Configuration Utility. 7. Click Exit to close the FrameworkHL7 Configuration Utility. FrameworkHL7 Installation & User Guide 24

25 Queue Manager Configuration The Queue Manager has been added as a separate component so that the user can do a custom install and only install that utility. The Queue Manager Configuration will allow for restricting access to only a specified Active Directory Group. 1. Click Queue Manager Configuration from the FrameworkHL7 Configuration Utility. 2. The Queue Manager Configuration window will appear. 3. Check the Restrict Queue Manager access to only the following Active Directory group box to not allow users access to the FrameworkHL7 Queue Manager unless they are a member of the specified Active Directory group. 4. Check the Restrict Queue Manager delete functionality to only the following Active Directory group box not allow the Delete button on the main screen of the FrameworkHL7 Queue Manager to be visible if the user is not a member of the specified Active Directory group. FrameworkHL7 Installation & User Guide 25

26 FrameworkLTC Configuration There are configuration changes that can be made in FrameworkLTC in to manage how and when outbound messages are sent. These options can be found under the General Purpose HL7 Interface in the Interfaces category of the System Options window. System Options Priority Level - Admit Patient Messages (ADT^A01^ADT_A01) This option was added in FrameworkLTC version This option only applies to outbound messages. The default value for this option is Medium. Outbound messages will be selected based on highest priority (High, Medium, Low). Priority Level - Delete Order Messages (RDE^O11^RDE_O11 - CA) This option was added in FrameworkLTC version This option only applies to outbound messages. The default value for this option is Medium. Outbound messages will be selected based on highest priority (High, Medium, Low). Priority Level - Delete Patient Messages (ADT^A23^ADT_A21) This option was added in FrameworkLTC version This option only applies to outbound messages. The default value for this option is Medium. Outbound messages will be selected based on highest priority (High, Medium, Low). Priority Level - Discharge Patient Messages (ADT^A03^ADT_A03) This option was added in FrameworkLTC version This option only applies to outbound messages. The default FrameworkHL7 Installation & User Guide 26

27 value for this option is Medium. Outbound messages will be selected based on highest priority (High, Medium, Low). Priority Level - Discontinue Order Messages (RDE^O11^RDE_O11 - DC) This option was added in FrameworkLTC version This option only applies to outbound messages. The default value for this option is Medium. Outbound messages will be selected based on highest priority (High, Medium, Low). Priority Level - Formulary Messages (MFN^M15^MFN_M15) This option was added in FrameworkLTC version This option only applies to outbound messages. The default value for this option is Medium. Outbound messages will be selected based on highest priority (High, Medium, Low). Priority Level - Literal Order Messages (RDE^O11^RDE_O11) This option was added in FrameworkLTC version This option only applies to outbound messages. The default value for this option is Low. Outbound messages will be selected based on highest priority (High, Medium, Low). Priority Level - New/Refill Order Messages (RDE^O11^RDE_O11 - NW and RF) This option was added in FrameworkLTC version This option only applies to outbound messages. The default value for this option is Medium. Outbound messages will be selected based on highest priority (High, Medium, Low). Priority Level - Transfer Patient Messages (ADT^A02^ADT_A02) This option was added in FrameworkLTC version This option only applies to outbound messages. The default value for this option is Medium. Outbound messages will be selected based on highest priority (High, Medium, Low). Priority Level - Update Order Messages (RDE^O11^RDE_O11 - XO) from a Batch This option was added in FrameworkLTC version This option only applies to outbound messages. The default value for this option is Medium. Outbound messages will be selected based on highest priority (High, Medium, Low). Priority Level - Update Order Messages (RDE^O11^RDE_O11 - XO) from Reorders This option was added in FrameworkLTC version This option only applies to outbound messages. The default value for this option is Low. Outbound messages will be selected based on highest priority (High, Medium, Low). Priority Level - Update Patient Messages (ADT^A08^ADT_A01) This option was added in FrameworkLTC version This option only applies to outbound messages. The default value for this option is Medium. Outbound messages will be selected based on highest priority (High, Medium, Low). Priority Level - Workflow Complete Messages (RDS^O13^RDS_O13) This option was added in FrameworkLTC version This option only applies to outbound messages. The default value for this option is Medium. Outbound messages will be selected based on highest priority (High, Medium, Low). Require adjudication before sending order messages This option was added in FrameworkLTC version This option applies to outbound messages. The default value is No. If this option is turned on, we will require adjudication to be completed (in addition to the standard criteria) prior to sending the RDE and RDS order messages to the vendor. Send order change message when Dispensed For is changed This option applies to outgoing order change messages. The default value is No. If this option is set to Yes, then a change message will be sent when the Dispensed For field on the Misc tab of the Rx Entry window is changed. Send RDE message for new orders prior to initial review This option only applies to outbound messages. The default value is No. If set to Yes, new prescriptions will not be required to be reviewed before the RDE^O11^RDE_O11 Drug Order message is sent. Suppress messages for inactive orders This option was added in FrameworkLTC version This option only applies to outbound messages. The default value for this option is No. If this option is turned on, we will not send RDE order messages to the vendor when the reorder is inactive. FrameworkHL7 Installation & User Guide 27

28 Suppress patient update messages for inactive patients This option was added in FrameworkLTC version This option only applies to outbound messages. The default value for this option is No. If this option is turned on, we will not send update messages to the vendor when the patient is inactive. When using the Recall function with a Linked Order, hold the Discontinue until the New Order is sent This option was added in FrameworkLTC version This option only applies to outbound messages. The default value for this option is No. If this option is turned on and you are using the Recall (with linked order) function, the discontinue message will not get sent to the vendor until the new order has completed the necessary workflow and is being sent. External Order ID Third party applications will use the External Order ID to identify orders. In order for FrameworkLTC to associate this value into an outbound message, a Custom Field will need to be added. 1. In FrameworkLTC, select File. 2. Click Pharmacy. 3. Click Custom Fields. The Custom Fields window will display. 4. Click the New icon. 5. Select Reorder/Rx from the Type drop down menu. 6. Enter External Order ID in the Name field. 7. Select Alpha/Numerica from the Data Type drop down menu. 8. Click Save. Patient External Patient ID The Patent External Med ID is set on the Other Info tab of the Patients screen. 1. In FrameworkLTC, select File. 2. Click Facility. 3. Click Patients. The Patients window will display. FrameworkHL7 Installation & User Guide 28

29 4. Select the Other Info tab. Click the External IDs button. 5. The left side of the grid will display all of the applications that are available to assign External Patient IDs. Enter a value in the External ID field next to each application that will require the External Patient ID. 6. Click Save. External Facility ID The External Facility ID is set on the Misc tab of Facility Setup. 1. In FrameworkLTC, click File on the menu bar. 2. Click Facility. 3. Click Facility Setup. The Facilities window will appear. FrameworkHL7 Installation & User Guide 29

30 4. Select the Misc tab. 5. Click the External IDs button. The External Facility IDs window will appear. 6. The left side of the grid will display all of the applications that are available to assign External Facility IDs. Enter a value in the External ID field next to each application that will require the External Facility ID. 7. Click Save. FrameworkHL7 Installation & User Guide 30

31 Formulary External Med ID Each item in the formulary will be assigned an External Med ID when it is added to the Formulary. There are two methods of External Med ID generation: Passport and Normal. External Med IDs are defined on the Pharmacies window in FrameworkLTC. If the method is set to Normal, then the NDC will be used for user defined drugs, partial GPIs, and Lovenox. The GPI will be used in all other instances. If the method is set to Passport, then the same logic used for the Normal generation method is applied along with a brand/generic test. The IDs will be auto-generated using the logic and the AutoExternalMedIDs table in the Pham database. The field can be manually overwritten. 1. In FrameworkLTC, click File on the menu bar. 2. Click Pharmacy. 3. Click Formulary. 4. Click Edit Formulary. The Pharmacy Formulary window will appear. 5. Navigate to the correct drug product and select the Dispensing tab. FrameworkHL7 Installation & User Guide 31

32 6. Click the External Med IDs button at the bottom of the window. The External Med IDs window will appear. 7. Any entries in the Application column are defined on the FrameworkHL7 Configuration Utility Setup function. Enter the correct External Med ID for the drug product in the External Med ID column. 8. Once the correct External Med IDs are entered, click the Save button. 9. Click Quit to close the Pharmacy Formulary window. Nursing Station External ID Each Nursing Station can be assigned an External ID. This field will need to be manually assigned from the Nursing Station window by clicking the External IDs button. 1. In FrameworkLTC, click File on the menu bar. 2. Click Facility. FrameworkHL7 Installation & User Guide 32

33 3. Click Nursing Stations. The Nursing Stations window will appear. 4. Click the External IDs button in the bottom right corner of the window. The External Nursing Station IDs window will appear. 5. Any entries in the Application window are defined on the FrameworkHL7 Configuration Utility Setup function. Enter the External ID for each application. 6. When all external IDs are entered, click the Save button. FrameworkHL7 Installation & User Guide 33

34 7. Click the Quit button to close the Nursing Stations window. FrameworkHL7 Installation & User Guide 34

35 FrameworkHL7 Quantity Conversion Utility The FrameworkHL7 Quantity Conversion Utility is used to modify differing units of measure between FrameworkLTC and third party dispensing applications. Users should consult with their vendor to decide what drug products require conversion. Note: When displaying Pharmacy Formulary items in FrameworkHL7 Quantity Conversion Utility window, the program will evaluate the Block Pharmacy Selection and May Select Alternate Pharmacies options set on the Users window in FrameworkLTC. (File>Pharmacy>Users) 1. Click the Start menu. 2. Click All Programs. 3. Click SoftWriters, Inc. 4. Click FrameworkHL7. 5. Click FrameworkHL7 Quantity Conversion Utility. The FrameworkHL7 Quantity Conversion Utility window will display. 6. The grid can be sort by each of the columns by selection the Set Sort Order button. 7. Enter the Conversion Factor for each item in the formulary as it is needed. This value will be used to divide the quantity by when FrameworkHL7 sends messages. This value will be multiplied by the quantity when FrameworkHL7 receives messages. 8. Enter a Conversion UOM (Unit of Measure) if it is different than the Package UOM (Unit of Measure). If a Conversion UOM is not entered, then FrameworkLTC will use the Package UOM when sending messages. The Conversion UOM is passed in the TQ FrameworkHL7 Installation & User Guide 35

36 Components The components installed for the FrameworkHL7 Interface include a directory containing a folder for the Configuration Utility, Quantity Conversion Utility and Queue Manager. The FrameworkHL7 Interface service is created. Database Table Content FwLTC HL7AllergyTranslations Holds the allergy mappings set in the HL7 configuration utility. FwLTC FwLTC FwLTC FwLTC HL7Messages HL7PendingTQD HL7RouteNames HL7RouteTranslations Holds the XML string associated with outbound message. The ID value is passed in the Message Control ID (MSH.10) field. Holds a list of Reorder records that need the Total Quantity Dispensed updated. Records are added when processing an inbound DFT messages and the order is not yet in the Reorders table (new order not yet posted). Holds the HL7 route names and codes set in the HL7 configuration utility. Holds the cross references between the HL7 routes and the Medi-Span routes set in the HL7 configuration utility FwLTC IncomingHL7Message Holds the request and response for all inbound messages. FwLTC InterfaceQueue Holds incoming and outgoing messages until they have been picked up and processed by the HL7 service FwLTC FwLTC HL7DD InterfaceQueueErrors InterfaceQueueLog Holds outgoing messages and the errors associated with them. Holds the request and response for successfully processed outbound messages. Holds the definition for the supported messages, segments, etc. Holds the definition of how to populate the different messages on outbound orders. FrameworkHL7 Installation & User Guide 36

37 FrameworkHL7 Message Components FrameworkHL7 messages are made up of segments and fields. Segments are a grouping of fields related to the complete message. Fields are strings of data within a segment. Each field within a segment is divided by a character called a pipe ( ). Example Message Example Segment Example Field FrameworkHL7 Installation & User Guide 37

38 FrameworkHL7 Queue Manager The FrameworkHL7 Queue Manager can be used to view sent, received, and error messages. The FrameworkHL7 Queue Manager can be located from the Start menu in the SoftWriters, Inc. folder under FrameworkHL7. Error Messages The FrameworkHL7 Queue Manager will open to display the error messages. The top portion of the application will show all of the error messages. The bottom portion of the application window will display the details for one error message. The error details will show the XML request message, the HL7 request message and the resulting error message. The error details will allow you to locate why a message could not be sent or received. The pharmacy should monitor this queue and take appropriate action on all items shown. Error messages can be deleted or re-sent. The error list will refresh approximately every minute. The user can for a refresh of the list by unchecking the Auto Refresh checkbox and clicking the Refresh button. The top grid on the Error Messages screen will list all messages currently contained in the FwLTC..InterfaceQueueErrors. The XML Request, HL7 Request and Error Messages will be display at the bottom of the screen for the individual transaction highlighted in the top grid. The error messages can be filtered by one or more of the following criteria: Interface, Facility, Transaction Date and Patient. The screen below will be displayed after clicking the Filter button on the Error Messages screen. FrameworkHL7 Installation & User Guide 38

39 Check the Filter Transactions by Interface, Filter Transactions by Facility, Filter Transactions by Date, and Filter Transactions by Patient box to enable the filter. Once a filter is enabled, define the desired criteria and click Apply Filter to enable the filter. Sent Transactions The messages that have been sent outbound from FrameworkLTC can also be viewed in the FrameworkHL7 Queue Manager. The sent messages can be accessed by clicking the View Sent Transactions button on the Error Messages screen. As with the error messages, the sent message can also be filtered. The messages can be filter by one or more of the following criteria: Interface, Facility, Transaction Date and Patient. Check the Filter Transactions by Interface, Filter Transactions by Facility, Filter Transactions by Date, and Filter Transactions by Patient box to enable the filter. Once a filter is enabled, define the desired criteria and click Apply Filter to enable the filter. The top grid on the Sent Messages screen will list all messages sent outbound currently contained in the FwLTC..InterfaceQueueLog. The XML Request, HL7 Request and Response Messages will be display at the bottom of the screen for the individual transaction highlighted in the top grid. The messages in this view will be purged based on the value entered into the DaysToKeepResponseLog in the configuration settings. FrameworkHL7 Installation & User Guide 39

40 Received Transactions The messages that have been sent inbound to FrameworkLTC can also be viewed in the FrameworkHL7 Queue Manager. The received messages can be accessed by clicking the View Transactions Received button on the Error Messages screen. The top grid on the Messages Received screen will list all messages sent inbound currently contained in the FwLTC..IncomingHL7Messages. The XML Request, HL7 Request and Response Messages will be display at the bottom of the screen for the individual transaction highlighted in the top grid. These messages will be deleted based on the value set for the DaysToKeepIncomingMessages in the configuration settings. FrameworkHL7 Installation & User Guide 40

41 The Received Messages can also be filtered by clicking the Filter button. 1. The Apply Filter window will display. The application allows the filter to be completed by Transaction Date. 2. Check the Filter Transactions by Date box to enable the filter. 3. Select a filter from the drop-down menu. Available options are Greater Than, Less Than, Equal, and Not Equal. 4. Enter a date into the available field using the MM/DD/YYYY format. Alternatively, select a date from the drop-down calendar. FrameworkHL7 Installation & User Guide 41

42 Troubleshooting Message Flow Understanding how messages are delivered to FrameworkLTC is a key part of troubleshooting issues with FrameworkHL7. Incoming message arrive via the Listening Port (9005 by default) into the IncomingHL7Messages table of the FwLTC database. Outgoing messages are triggered by actions within FrameworkLTC. The trigger will insert records into the InterfaceQueue table. For example, a new order message is sent when a new Rx goes through initial review. The XML string is created and inserted into the InterfaceQueue table in the FwLTC database. This XML string contains the key information the interface needs in order to build the message. If the message is successfully sent, then it is moved to the InterfaceQueueLog in the FwLTC database. If the message fails, then it is moved to the InterfaceQueueErrors table in the FwLTC database. Error Messages When a message is sent, the receiving system will generate and send an acknowledgement message. A positive acknowledgement is referred to as an ACK. An error message or negative acknowledgement is referred to as a NACK. The acknowledgement messages will be in HL7 standard format. It will contain an MSA segment. MSA- 1 will contain the acknowledgement status: Application Accepted (AA), Application Error (AE), and Application Rejection (AR). Application errors indicate there was a problem processing the message. The error could be related to the message structure, or the message itself. Application rejections indicate there is a problem with a field 9, 11 or 12 of the MSH segment or there was a problem with the receiving application not related to the message structure. Error Example 1: External Facility ID Not Set for ' FacilityID'. This error indicates that the External Order ID is not set on the Facility. Navigate to the Misc tab of the Facilities window in FrameworkLTC and click the External IDs button. Assign the External IDs to each to the application that generated the error. FrameworkHL7 Installation & User Guide 42

43 Error Example 2: Table Value Not Found The error segment of this NACK is indicating that field 3 in the MSH segment cannot be found. Use the FrameworkHL7 Interface Specification document to determine which data should be placed in the message. The specification document contains a listing of each segment type along with the fields for each. The FrameworkHL7 Interface Specification can be located from the Start menu in the SoftWriters, Inc folder under FrameworkHL7. In the example, MSH.3 for an incoming message is the 3rd Party Application. This value must match the Sending/Receiving Application ID set for the interface in the FrameworkHL7 Configuration Setup. Use the configuration setup and verify the correct ID is set. FrameworkHL7 Installation & User Guide 43