EdocWriter User GuideVersion 2.403/05/2005 |
IntroductionPurpose of EdocWriterThank you for selecting EdocWriter for your patient discharge documentation requirements. The primary purpose of EdocWriter is to provide health organizations the ability to implement a system to provide meaningful instructions and reiterate important facts that patients must keep in mind when they leave the health facility. Such capabilities include the ability to create prescriptions, provide doctor notes to outside organizations, or direct the patient to specific referral doctors. A secondary purpose is to allow health organizations to deploy and customize the system to meet the requirements of diverse users. This system has evolved from a desktop focus to an enterprise focus. Specifically the product was designed to:
The product is designed to be easily implemented using default settings, and with more effort to customize every facet of the system. EdocWriter can be installed by a computer novice on a local workstation if no significant customization is undertaken. Custom or standard, once configured the product is designed to be deployed easily and rapidly to additional workstations. Computer System Requirements and ArchitectureAny new Windows computer can run EdocWriter. At a minimum you should have Windows 95 and 32mb of Ram memory. Most clients will deploy the system on a local area network, some on a wide area network, and others may choose to implement parts of the system on either a internet or intranet. Deployment on networks is more reliable but also more complex. The remainder of this section is somewhat technical, so you may want to skip it unless you have a good understanding of computer technology.
InstallationThe installation program will display a legal document indicating that the product is copyrighted, then ask for your name, and which directory to install to. During installation, EdocWriter may notify you that it wants to install MicroSoft Data Access Components or Adobe's Acrobat Reader. These products are necessary for EdocWriter to communicate with the database and to print out this guide. However if you know you already have them installed, you may not want to reinstall. Reinstallation should not cause a problem. If you want to use automatic updating from the internet, you will need MicroSoft's Internet Explorer 4.5 or above installed. Be sure to set the security rights to the directory to allow both read and writer privleges over the install directory and sub directories. Installing on Additional WorkstationsIf you have installed EdocWriter on a file server, it is necessary only to create a short-cut on the workstation desktop pointing to the EdocWriter file called "edocwriter.exe" on the file server and set the start in directory to the EdocWriter directory. EdocWriter will then configure the workstation the first time this short cut is started (i.e. clicked). EdocWriter does this by initiating an install program that will set up the workstation. It will be necessary to restart the workstation after this install program completes. Setting and Resetting the Workstation Site and PrintersThe first time you start EdocWriter on each workstation, you will be asked to select the workstation site and set the printers that are going to be used. You can reset the site information after installation by choosing the Reset Site and Printers option in the Modify Workstation Settings option on the Menu Bar. Typically there will only be one site initially, but there can be many. Each site has their own customized user list and certain specific information for output documents like the site title. These settings are specific to each user log in name. When this initial dialog appears: The system can be set to not allow the user to reset the workstation printers by disabling this feature in the Menu Button Structure XML configuration file.
The program must be terminated and restarted after initially selecting the site and printers, or resetting them. |
Getting StartedStarting the programAt this point EdocWriter should be installed. You should be able to start the program from the desktop if you:
After You Start The programThe main window will be shown. It has buttons on the top right, a Instruction Categories List on the top left, a Physician User List on the bottom right, and a Selected Items List (none so far) on the bottom left.
Example: Create and Print A Simple Patient InstructionAt a minimum you need a patient name, doctor's name, and an instruction. The most simple discharge document would require the following steps:
Example: Create and Print A Simple Patient Instruction Using the HL7 InterfaceIf your facility has the Health Level 7 interface enabled, to create a minimal patient discharge document would require the following steps:
Example: Create and Print A Simple Patient Instruction with HL7 Interface and overrides enabled
The Initial (Main) EdocWriter MenuOkay, so we can produce a simple instruction. What is the rest of this stuff on the main menu? Although this initial menu is pretty self-explanatory, here is an overview: The Menu BarOn the top is the typical Windows Menu Bar with File, Search, Search Next, and Minimize options. Here is a short description of each
You can invoke these functions without the use of the mouse by pushing the ALT key and character that is underlined at the same time (e.g. the File function would be ALT+F). Menu ButtonsIn the upper right are a number of buttons. The user can set which buttons are to be displayed. Here are the buttons available:
Patient Instructions or Diagnoses ListThere are a lot of options available here. Directions on options will be given in greater detail later, but a summary will be provided here because this part of the screen is so visible. In the upper left is a box that alternates between showing either Patient Instruction lists or Diagnoses lists. By default a Patient Instruction Category list is displayed here. If your organization wants to attach and print a diagnosis on the discharge instruction, there a number of options:
There are additional options here that dramatically affect what the user sees:
If the Patient Instruction Categories are shown and the user double clicks on one of the Patient Instruction Categories, a Patient Instruction List for that category will be displayed. Once a patient instruction has been selected from this list, the appropriate instruction is added to the list of instructions and notes to be printed on the discharge instruction. Physician User ListIn the lower right is a Physician User List. Individuals can be selected and identified as the physician of record on the instructions. Immediately after entering a patient name, the program will place the user in the Physician User List. The name of the doctor selected for the prior patient instruction is selected by default. A simple ENTER key stroke will select that doctor. EdocWriter can be set to automatically add the name of last physician, bypassing this step. Alternatively, a doctor can be selected by double-clicking on an individual entry with the mouse or by using the down arrow key to highlight the desired name, followed by an ENTER key. You can also type in the first character of the name to scroll as well. There are a number of options available that will addressed later. Assistant and Additional Care Provider ListIf an organization utilizes physician assistants or would like to add individuals other than the physician, the user can set the system to ask for this individual after the physician is selected. The Physician Assistant/Physician Users list Button will be displayed if this option is chosen. Immediately after the physician user is selected, the list of physicians is replaced by a list of assistants/additional care providers. More than one health care provider can be added to the discharge document. EdocWriter can be set to allow for none, one, or more than one additional care providers. If the more than oneoption is selected, the system will not move to the patient instruction list box automatically after a selection is made. Customizing the Initial (Main) MenuEdocWriter is designed to encourage changing the initial menu to match your preferences and business requirements. For instance, by default the patient instructions were selected first by selecting the patient instruction category, and then selecting from a list of patient instructions. You could set the program to display the diagnoses first. Display Diagnoses initially instead of the Patient Instructions
Display Patient Instructions automatically after a Diagnosis is selectedInstead of clicking on the third button, Show PI Instructions Category/Show Diagnosis Button, the user can set the list to appear right after the diagnosis selection. To change:
Select a Patient Instruction or Diagnosis by typing in the first characters of the nameDo not like to use the mouse? This will present what MicroSoft refers to as a combination edit and list boxes. Instead of scrolling to the desired item, the user can type in the first few characters, and the list will automatically scroll to the desired place (it should be noted that even in a plain list box, entering the first character will cause the list to scroll to that part of the list). To change:
The user can also create a menu buttons to allow the user to switch between the list types. An example of the display using a patient instruction combo list box:
Select physician assistants to be included on printed documentsThe printed discharge document must provide the name of the physician. The physician assistant can also be listed. If this option is set, a list of physician assistants will be presented immediately after the physician has been selected. Some clients may wish to include more than one care provider or assistant. There are three options available, to not allow for any, to allow for just one care provider (in addition to the physician), and to allow an unlimited number. To set the system for a single additional care provider/assistant: The care provider information can be then inserted into the discharge document where desired in the Patient Instruction Header Template. Allow Many Assistants to be included on discharge instructionsTo set the system for multiple care providers/assistants: The care provider information can be then inserted into the discharge document where desired in the Patient Instruction Header Template. Modifying, Deleting, Printing, and Saving a selected itemThe Selected Items list allows the user to make changes to the selected items. Double Click to edit instructions from the Selected Items ListThe user can edit items from this list by:
Using the Delete Key to delete instructions from the Selected Items ListAs the user selects instructions to add to the patient's discharge document, they are listed in the box in lower right corner of the main window - the Selected Items List. The user can delete items from this list by:
Right Click to delete, edit, print, or save from the Selected Items ListSelected items can be modified by a right click on the item in the Selected Items list. A dialog box will be displayed.
A click on an option will:
Changing the user physician name
Common ModificationsEdocWriter is designed to be customized. The more common types of modifications are presented in this section. Modifying a prior Patient Discharge Instruction
When first invoked, this presents a list of patients processed through EdocWriter for the current day. Adding a user name to the initial main menuThere are two ways to add a physician not on the Current Physician Users list.
Adding a Referral Care ProviderAdding a referral doctor or organization is the same as adding a user. If an organization is being added, enter the name you would like the organization to be identified by in the last name parameter, and leave the first name blank. Because the lists the referral care providers are selected from and the tokens used in the discharge instructions use the last name parameter, the user and patient will see a organization name or a physicians last name. To add a referral doctor or organization then requires only to:
Printing Prescriptions and Medicine InstructionsDescription of the prescription dialog windowWhen you click on the Prescriptions button from the main window, you will see a dialog window presented like the one shown here:
Here is a list of the elements in the dialog window
Creating a Prescription
Additional output documents and capabilitiesPrinting a Work slip or Doctor's NoteA work slip or Doctors Note is a note on behalf of a patient for an outside organization. It can be printed on a specific type of printer to allow for small forms. To create such a note:
Printing a Referral Note or Follow-Up NoteThis type of note inserts instructions into the discharge document indicating the need for further medical attention.
Inserting a physicians note into the discharge documentA physician note can be included in the discharge instruction to add instructions specific to the patient
Faxing a copy of the discharge document to a referral doctorA copy of the discharge document containing the referral follow-up text can be sent to the referral doctor can automatically or on an exception basis.
Including medicine instructionsIf there is an instruction for a medicine, the system will print it in the discharge document. The medicine instruction is included by default with the prescription. check box. Alternatively, medicine instructions can be printed without a prescription form being generated through the Medicine Instruction Button on the initial main menu. Resetting the Workstation Site or PrintersTo reset the printers
Using the keyboard to navigate around the menuThe Enter KeyEvery button, dialog and list should have a default value. Hitting enter will automatically select the default value. For lists, the default value is highlighted, for buttons the default value will have a rectangle of dots (hard to explain, but it is obvious when you see it). For instance, when first started, an Enter invokes the New Patient Button. After the first name is entered, an Enter key will move to the last name, and after that an Enter will move to the Physician Users list, and so on. The Tab KeyThe tab key will generally move you to the next button or list. The Up and Down Arrow KeysThese keys can be used both to navigate about the main menu and about the list and combo list boxes. Using the arrow keys will move the "focus" (be highlighted) either up or down. Hitting the Down arrow key in a combo list box will cause the first element to gain focus, thereby allowing use of the Page Up and Page Down keys The Page Up and Page Down KeyThese keys will cause lists and combo lists to rapidly scroll up and down. The lists must have "focus" (be highlighted) Keyboard Function KeysThe function keys at the top of the keyboard will immediately invoke movement to specific buttons and lists. The default mapping of the keys to the buttons or lists is -
The functions keys are mapped in a clockwise direction beginning with the upper right corner button. The user can change what buttons are displayed, the order, and the mapping of the function keys by modifying the Button Structure XML file . |
Instruction PackagesPackages: Saving and recalling sets of instructionsA package is a set of instructions that have been saved to be recalled at a later time. The reasons for doing this is to save time and increase quality of care. Here are some specific reasons:
The default library is can be can be set to be unique for each user or based upon some other value. Saving Instructions to create a Package
Retrieving saved instructions in a Package
|
The HL7 EdocWriter Interface ProgramWhat is HL7?The HL7 Interface is used in the health care industry to transmit information between computer programs. This common standard allows an organization to integrate products from a variety of vendors. Patient information is often available from your patient admission system. EdocWriter can access this information to save you the time of entering patient name and account information.Starting the HL7 EdocWriter Interface ProgramThe HL7 EdocWriter Interface Program acts as a HL7 server receiving notification of admission information from the computer software processing patient admissions. When it recieves this information, the HL7 EdocWriter Interface Program creates an XML command file containing the patient information and sends it to the Pending Patient Directory.
Description of Program User InterfaceOnce the program has started, you should see a dialog appear like the one shown below:
A list of the various controls follows:
Setting up the HL7 EdocWriter Interface ProgramThe TCP/IP socket port is used to communicate between the program and the client's HL7 facility (some other computer system). The port number will likely have to be changed to whatever arbitrary number the HL7 facility wants to use. At a minimum, this facility should send a packet consisting of a HL7 start character, MSH message, a PID message, and a HL7 end message character. The Edocwriter HL7 interface will send back to this facility a packet consisting of a HL7 start character, MSH message, a MSA message, and a HL7 end message character. In a perfect world all that is necessary to get the interface running is to start the program and wait for the data to be sent. Hl7 XML Configuration FileThe Edocwriter HL7 interface reads a file called edochl7.xml containing configuration instructions. The file can define the following: Both segments and the output XML is defined by the use of a constant or a variable pointing to another element. A variable can be recognized by the use of the & character followed by a segment field identifier. For instance: <F3><VARIABLE>MSH.9</VARIABLE></F3> means retrieve the value found in the 9th field of the MSH segment. The first field is the segment name field, and it is defined as position 1. This differs from the HL7 documentation where the MSH segment actually starts with position 0. Some segment fields contain more than one value. The HL7 name for the name (XPN) and address (XAD) fields are currently defined. An example of the file follows: <HL7-SERVER><PORT>3000</PORT> <!-- FIELD INDEX MSA STARTS WITH 1 HERE - HL7 DOC STARTS WITH 0. SO MSA 1 IS MSA 0 IN THE HL7 SPEC --> <MSA-OUTPUT> <F1>MSA</F1> <F2>AA</F2> <F3><VARIABLE>MSH.9</VARIABLE></F3> <F4>NO ERROR</F4> </MSA-OUTPUT> <!-- FIELD INDEX MSH STARTS WITH 1 HERE - HL7 DOC STARTS WITH 0 SO MSH.1 IS MSH FIELD 0 IN THE HL7 SPEC --> <MSH-OUTPUT> <F1>MSH</F1> <F2><VARIABLE>MSH.2</VARIABLE></F2> <F3><VARIABLE>MSH.3</VARIABLE></F3> <F4><VARIABLE>MSH.6</VARIABLE></F4> <F5><VARIABLE>MSH.7</VARIABLE></F5> <F6><VARIABLE>MSH.4</VARIABLE></F6> <F7><VARIABLE>MSH.5</VARIABLE></F7> <F8><VARIABLE>MSH.8</VARIABLE></F8> <F10><VARIABLE>MSH.10</VARIABLE></F10> <F11><VARIABLE>MSH.11</VARIABLE></F11> </MSH-OUTPUT> <XML-OUTPUT> <PATIENT-LASTNAME><VARIABLE>XPN.1</VARIABLE></PATIENT-LASTNAME> <PATIENT-FIRSTNAME><VARIABLE>XPN.2</VARIABLE></PATIENT-FIRSTNAME> <PATIENT-MIDDLENAME><VARIABLE>XPN.3</VARIABLE></PATIENT-MIDDLENAME> <PATIENT-ADDRESSLINE1><VARIABLE>XAD.1</VARIABLE></PATIENT-ADDRESSLINE1> <PATIENT-CITY><VARIABLE>XAD.3</VARIABLE></PATIENT-CITY> <PATIENT-STATE><VARIABLE>XAD.4</VARIABLE></PATIENT-STATE> <PATIENT-ZIPCODE><VARIABLE>XAD.5</VARIABLE></PATIENT-ZIPCODE> </XML-OUTPUT> <SITE> <DIRECTORY> PendingPatient </DIRECTORY> </SITE> <!-- this sets the delimiter for ebcdic <FIELD_DELIMITER_DECIMAL_VALUE> -1 </FIELD_DELIMITER_DECIMAL_VALUE> --> <!-- this sets the up multi-site identifier <SITE-ID-FIELD> 3 </SITE-ID-FIELD> <SITE-ID-SEGMENT> MSH </SITE-ID-SEGMENT> --> <!-- this sets the directories for multi-site <SITE> <DIRECTORY> PendingSiteOne </DIRECTORY> <SITE-ID-VALUE> SJC </SITE-ID-VALUE> </SITE> <SITE> <DIRECTORY> PendingSiteTwo </DIRECTORY> <SITE-ID-VALUE> SFC </SITE-ID-VALUE> </SITE> --> </HL7-SERVER> How to handle multiple sitesThe following is an example where the xml output is directed to one of two sites based upon the value of segment number 3 of the MSH message. If the value at this location is "SJC", then the data is sent to "PendingSiteOne", and if the value is "SFC" then the data is sent to "PendingSiteTwo". <HL7-SERVER>
<SITE-ID-MESSAGE>MSH</SITE-ID-MESSAGE>
<SITE>
<SITE> </HL7-SERVER> |
EdocWriter Internet BrowserStarting and using the browserA start the internet browser click on the File and then Go Online Menu Bar and finally the SupportSite selection. The other options listed here invoke the browser, but point to specific pages. The browser only allows the user to navigate to pages on the EdocWriter Web Site. Once the program has started, you should see a dialog appear like the one shown below:
EdocWriter Web Based FacilitiesA "Download" menu option allows the user to download patient instructions and invoke some automatic configuration tools from EdocWriter Workshop on the web site. The user can navigate to this page by clicking on the Customer Support link on the EdocWriter Home page and then clicking on the Web Workshop Link on the EdocWriter Customer Support page. Checking for updatesA customized web page for each version of EdocWriter exists to inform the user when an update is available. To check for an update, click on the File and then Go Online Menu Bar and finally the Update EdocWriter selection. Before an update is run, the user must make sure no one is using EdocWriter. |
EdocWriter Auto Fax and Auto EMailIntroduction to Email and Auto Fax FacilitiesEdocWriter can automatically notify an external agency a patient has been referred to them through either fax or email. Additionally, a prescription can automatically be sent to a pharmacy via fax or email. Patient privacy is an issue. The system has been designed to meet any privacy concerns by allowing the user to specify what information is to be transmitted. Specifically the discharge instruction is not sent, just a template associated with the selected follow-up note. If privacy is not a concern, this associated template can contain a command instructing that the entire discharge instruction is to be included. The system can be configured to send faxes or emails (or both), either through a central server, or directly from each workstation. A central server is the recommended approach because it is more reliable and provides better control. Setting up the auto Email functionThe requirements for either Email or fax are similar. The most significant difference is that the auto fax function requires the specification of fax printer. Instead of repeating the instructions, follow the instructions for Setting up the auto fax function , substituting "email" or "fax" where appropriate. Summary of basic Steps for setting up Auto Fax or Auto EmailSetting up the auto fax function
Associating fax and email templates with follow-up note templatesThe process is to first create a template of the type fax or Email, and then create a link to a template of the follow-up note type.
Including the Discharge Instruction in an Auto Fax or EmailA fax or Email template can include the token ADD_PI, which will cause the entire discharge instruction to be inserted in place of the token. The EdocWriter Auto Fax and Mail Server is designed to run on a centralized computer and process fax and email requests from all sites. This is an alternative to sending such messages directly from each workstation to the recipients. Using a centralized server should reduce maintenance issues and increase reliability. When the program is running it will periodically search for email or faxes that have been generated. When found, the program will send the information to the individual specified, and the information will be marked as have been sent. If the program is not running, email or faxes to be sent will continue to accumulate until the server program is run. After starting, the program will wait for the delay time period (approximately 20 seconds), and then begin searching. This is to allow the program to be started automatically whenever the computer server is restarted if the program is included in the list of start up tasks. Description of Program User InterfaceOnce the program has started, you should see a dialog appear like the one shown below:
The following controls are available:
EdocWriter Mail Server XML Configuration FileConfiguration information is read from a xml file called edocmailserver.xml by EdocMailerServer and EdocWriter. An example of the file is provided below. <EDOCMAILSERVER>
<POLL_SECS>30</POLL_SECS>
<FAX>
<EMAIL> </EDOCMAILSERVER> |
Modify EdocWriter Data ProgramStarting the programThis program can be started from the EdocWriter Program Group in the Windows Start or from the main program menu through the Modify Workstation Settings option in the EdocWriter menu bar. The Modify Data option in the EdocWriter menu bar can be disabled so that users are prevented from making modifications. The image presented below is the initial window:
User Access RestrictionsUser Access from the Modify Data option in the EdocWriter menu bar can be restricted by changing the Modify Command parameter in the Configuration Table. The following command line options will hide the appropriate buttons:Template Creation and ModificationTemplate Creation and Modification DialogA template is a file containing XML tokens and text used to display all the information that is given to patients. The information here is merged with information generated from the user's selections. Templates are divided into types and versions. Examples of types of templates are medicine instructions, follow-up notes, and output formatting templates such as a prescription form or discharge instruction header . Examples of versions are English Level 5 or Spanish. Click on the Template Creation and Modification button will result in the following be displayed:
The Template Maintenance Dialog two groups, the Changes to template text group has:
The Changes to table definitions group has:
How EdocWriter Text Processing WorksEdocWriter has many of the characteristics of a word processor application. It takes information stored on "boiler plate" documents and merges it with stored information and information entered by the user. EdocWriter presents information to the users using HTML, the same technology as internet browsers. For those who are technically sophisticated, the program requires the source data be well-formed HTML as well. To press this a bit further, the program does not require that the source instructions be valid to a specified DTD, however the instructions provided with the system are. Creating and editing source documents consists of using a HTML word processor to enter text and indicating the information to be inserted by placing tokens representing the desired information into the text. Although conceptually you can use any HTML capable word processor, many currently do not create well-formed HTML. We have modified the editor that comes with EdocWriter to create only well-formed text. Tokens: Inserting patient and doctor informationA token is a symbol within a template that informs EdocWriter to replace it with specific patient information. Tokens are available for almost any piece of information available on patients and doctors. When you select an instruction or note, EdocWriter will search for tokens in the templates (word processing documents) associated with those instructions and notes. EdocWriter then replaces the tokens with the actual information and adds the resulting merged information to the discharge document being created. A token to insert information looks like this:<?TOKEN "TOKEN-NAME" ?> where "TOKEN-NAME" is replaced by the name of the specific information to be inserted. The editor that comes with EdocWriter allows you to click from a list of tokens so you don't need to know this detail. However, for the more technical minded, an example follows.
Tokens: Prompting for information from the userAnother token will result in the user being prompted to enter information. It is called a prompt token. A prompt token looks like this:<PROMPT "QUESTION-TEXT" /> where "QUESTION-TEXT" will be used to form the prompt text. For instance, if the QUESTION-TEXT were to be replaced by "Please enter the number of stitches", then this will result in the Question Dialog displaying this text above a data entry box. The results of whatever the user enters replaces the prompt token in the text. Again, the editor that comes with EdocWriter allows you to click from a list of tokens so you don't need to know this detail. However, for the more technical minded, an example follows.
Modifying the template of an instruction or form
Creating a new template of an instruction or form
Care ProvidersModifying care provider informationA care provider in EdocWriter is a user or referral person or agency. The same information is maintained for all care providers. Care provider information is maintained through the EdocWriter Modify program. To make modifications: Here is an example of what should be displayed for a user:
Adding a Referral doctor
Printer TableModifying Printer Table Elements
Medicines and PrescriptionsCreating, modifying or deleting a medicineMedicines be created directly from the Prescription Dialog. Once this information is entered, it can only be modified by using the Modifiy EdocWriter Data program. New medicines can be created as well.
Creating, modifying or deleting a prescriptionPrescriptions be created directly from the Prescription Dialog. Once this information is entered, it can only be modified by using the Modifiy EdocWriter Data program. New prescriptions can be created as well.
System Settings ButtonClicking on this button allows for modification of the site configuration information. Two buttons will be shown: Internet and Configuration. The Internet selection will modify data that deals with communications over TCP/IP. This would include email servers, ftp servers, and database servers. The Configuration selection will modify data that is used to customize the program. Modifying Configuration Table Parameters
List of Configuration Table Parameters
Modifying Internet Table Elements
List of Internet Table Parameters
Workstation CommunicationWorkstation Communication DialogA picture of the dialog box invoked by the Workstation Communication button is shown below:
There are three groups of controls. Each group has an edit box indicating whether the function is enabled. Here is a brief description of each group: Also, note that the server documented below must be started before the workstation's client chat using the Command File function documented here. The client chat requires the server to be running. Terminating the server stops the clients. The function is enabled by the Read XML Command File parameter in the System Configuration Dialog. The function is enabled by the existence of a User Message File parameter in the System Configuration Dialog. This function is disabled if the parameter is empty. The function is enabled by the Chat Xml File parameter in the System Configuration Dialog. |
EdocWriter Chat ProgramHow the Chat Program WorksThis facility creates a instant message facility for users. It consists of a chat server running on a file server, and a chat client for each EdocWriter user. The chat server (filename: edoc_chat_server.exe) runs continuously directing messages. A chat client (filename: edoc_chat_client.exe) is started by EdocWriter on each workstation when it is started by the user. The chat client will be minimized in the system tray until the icon is double-clicked or a message to the workstation is recieved from the chat server. Configuration FileA chat xml file contains the parameters necessary to configure the chat function. At a minimum the file needs to specify: The administrator of the system should be assigned the name of SYSTEM. Here is an example of a configuration file:
<EDOC_CHAT> |
AppendixTemplate TokensTemplate Tokens are placed in EdocWriter templates to signal that information is to be inserted when the instruction is printed. For example, if the token <?TOKEN PATIENT-NAME ?> is found in an instruction, it is replaced with the name of the patient when the instruction is printed. If a token is found in an instruction of a template type where there is no information available, it will be ignored. For example, if the token <?TOKEN RX-MED-NAME ?> is found in a Follow-Up Note instruction, it will be ignored because it is not clear what medicine, if any, is being asked for. Listed below are the tokens available, and where they can be used. Tokens that can be placed in any templateUser Interaction Tokens User Interaction XML Markup Unlike a token which is called a processing instruction, the Template List Box is composed of several parts:
<LISTBOX > Date and Time Tokens Site Specific Tokens Additional Care Provider Tokens User Physician Tokens Patient Tokens Follow-Up Note and Email and Fax TokensThese tokens that can be placed only in Follow-Up Note and Email and Fax templates. If a Follow-Up Note template type is selected that contains the <?TOKEN REFERRAL-NAME ?> token, then a list box will be displayed to select the referral from. Email and Fax Only TokensThese tokens that can be placed only in Email and Fax templates. Email and Fax templates are currently generated only for Follow-Up Note templates. Additional Care Provider Template TokensTokens that can be placed only in the template identified as Additional Care Provider Template parameter. Prescription Form TokensTokens that can be placed only in the template identified as Prescription Filename or Rx Text Filename template parameters. Medicine Instruction TokensInitial Menu Button SpecificationThe file specified by the Button Structure XML file contains XML tokens that represent buttons to be shown to the user. If the token for a button is not present in the file, the associated button is not shown. The user can also specify the function key, labels, and order of the buttons. The order of the tokens in the file determines the order of the buttons. In general the tokens have the form: <token id=F2 ... F9 label =label text switch-label=flip side switch labels> The switch-label attribute is used only for the SWITCH-BTTN for the button that toggles the user between diagnoses and patient instructions. The url attribute is used only for the LINK-BTTN for the button that invokes the browser to go to the url specified. The button Function key F2 is associated with determines which button is invoked initially.
The available buttons and default attributes are:
Setting the system to not allow reseting of printers from the menu options
To disable or grey out the Reset Workstation Printers option from the File->Modify Workstation menu bar, insert the following token within the XML Button group shown above.
Patient Discharge Instruction SpecificationThe file specified by the Structure XML file contains XML tokens that represent the various types of instructions that can be included in the discharge instruction. The order of the component tokens determines the order of the component parts. If the token for an instruction is not present in the file, the associated instruction is not included. Some actions that are associated with printing of instructions are also supported. In general the tokens have the form: The header and trailer are always included, and therefore no tokens are necessary for them.
Available tokens are:
Changing the Default Rx, Sig, and Disp Values for PrescriptionsFour database tables are used to define these default values. All except for the Medicine Type table can be modified to better reflect the requirements of the organization. A link is provided here that presents the following information and ties it to the Prescription Dialog in a graphic form: Click here for a prescription default summary in PDF format. The Medicine Type TableThis table is provided with the system. It would not be modified by the user, but the key values of this table are used as foreign keys in the other three tables listed above. The following list are the keys and names of the valid medicine types for which default values can be assigned: Modifying the Medicine Rx Default TableThis table is designed to be modified by the user. This table will have an empty string value (i.e. " ") for each of the medicine types. This will result in having just the name of the medicine listed as a default value. The system will automatically add the medicine name to each of the values specified in this table when the information is displayed in the Prescription Dialog. This table can be modified using ACCESS or the Sqlloader program. An example of the SQL statement to add "100mg" as a default potency value would be: INSERT INTO MedicineRx (FK_MED_TYPE, rx) values (1,'100mg'); The value 1 corresponds to the "Oral" medicine type key as shown in the prior section. Modifying the Medicine Disp Default TableThis table is designed to be modified by the user. Initially this table will be empty. This table can be modified using ACCESS or the Sqlloader program. An example of the SQL statement to add "#10" as a default sig value would be: INSERT INTO MedicineDisp (FK_MED_TYPE, disp) values (1,'#10'); The value 1 corresponds to the "Oral" medicine type key as shown in the prior section. Modifying Medicine Sig Default TableThis table is designed to be modified by the user. Initially this table will be empty. This table can be modified using ACCESS or the Sqlloader program. An example of the SQL statement to add "as needed" as a default sig value would be: INSERT INTO MedicineSig (FK_MED_TYPE, sig) values (1,'as needed'); The value 1 corresponds to the "Oral" medicine type key as shown in the prior section. EdocWriter Interfaces - HL7, XML, HTML, SQL, and ODBCIndustry common standards have been used to facilitate the integration of EdocWriter into a heterogeneous software environment. XML Command File - Executing commands remotelyThe system can be set to periodically poll an Xml Command file. Because the polling will consume processing time, the user can set the number of milliseconds between polling. Any system token can be included. The most relevant one would be <SHUTDOWN/> which would cause the workstation to shutdown down. SQL - Using the SQL Loader programThe EdocWriter SQL Loader (file name sqlloader.exe) is used to update the database during initial installation and program updates. It can be used as an alternative to the Modify EdocWriter Data Program to make changes to the database. To use this product:
If a syntax error is encountered, the program will allow you to exit or continue processing. For batch processing, it is possible to invoke the program and specify the sql file on a command line. The syntax would be: sqlloader {filename} Changing DatabasesTo change the database EdocWriter uses requires an Windows ODBC driver for the particular database. This can be provided by the database vendor. EdocWriter installs two different drivers by default: MicroSoft Access and MySql (www.mysql.com). The MicroSoft Access is used for non-internet implementions and the MySql (www.mysql.com) for internet based implementations. A brief description of the process of changing to a different database than these two follows:
Installing EdocWriter on a Inter/IntranetEdocWriter can be deployed partially or fully on a inter/intranet. The ODBC database driver is responsible for handling communications between EdocWriter. To inform EdocWriter to retrieve templates from a inter/intranet (hereafter called a TCP/IP connection) it is necessary to do the following:
XML Interface - Integrating external computer systems and EdocWriterSoftware developers can use the EdocWriter DTD to construct XML command files or read EdocWriter generated XML files. There are a number of applications where this capability would be used: EdocWriter XML InterfaceWhen user the users clicks on the Existing Patient Button or Pending Patient Button or the Instruction Package Button, EdocWriter reads and processes a file containing XML instructions. Here is an example of such a file:
The user can initialize, modify, or create XML using the mark up documented in the EdocWriter DTD. The user can also create their own XML parser using standard tools to extract information from these files. Internally EdocWriter uses a single XML parsing engine to create the patient output, and (at least in theory) anything that the user does by clicking on EdocWriter buttons can be done by feed the commands directly to EdocWriter. A XML Command File can be enabled to be polled for XML commands. If the file exists, the commands will be processed as if they were entered by the user. One obvious application is to be able to integrate hand-held devices into EdocWriter. EdocWriter HTML Patient Data FilesWhen EdocWriter prints a patient discharge instruction, it also writes the HTML used to create the output to the Instruction Directory. This file is not used by EdocWriter, but is available for outside processes. The patient's XML and HTML have the same filename prefix (i.e. "YYYYMMDD_{LastName}_{FirstName}"). Message of the Day: How to Create and Implement a User MessageAn html file can be displayed the first time a user creates a patient discharge instruction after EdocWriter starts; exiting the program and restarting will cause the message to be displayed again. To implement this: |
Trouble Shooting ErrorsProblems Encountered Installing, Starting, or UpdatingThe installation program asks for a serial numberYou need to enter your password. If you do not have your password, Email edocwriter at gmail.com or call 310-546-7435 . The installation program asks for the installation directoryIf EdocWriter is being installed for the first time, then choose a directory on the file server. Do not install to the local workstation. This message should not been seen if EdocWriter has already been installed on the file server and a workstation is being set up for the first time. The system may need to be updated: Email edocwriter at gmail.com or call 310-546-7435 . If an update program is being run, then choose the home directory on the file server that has the system EdocWriter files. Cannot create or modify ODBC errorCheck the following: Nothing happens when I start the programIf nothing happens at all, run MicroSoft's Visual C++ dll redistribution installation program. A copy of the program (filename is vc6redist.exe) has been placed in the EdocWriter directory. The workstation will need to be restarted. The program abends with a run time errorThe odbc entry for the system is not correct. Reload the entries by following the directions dealing with ODBC reinstallation. A message is given saying some "dll" is missing.The program takes a long time to startThe problem is the network is slow. The amount of time between clicking on the short-cut and the "is loading" splash screen is the time required to load the program itself. The amount of time between the splash screen and the menu display is the amount of time required to read the database and XML configuration files. Every time the program is run it asks for the printers.The system will look in the registry under HKEY_LOCAL_MACHINE/Software/EdocWriter for the printer name, device name, and port name for each of the document types. If these elements are not found, or a system error is generated when the system tries to create a print connection, then the program will request the user select a valid printer. Check for these issues: A parsing error message is displayed before the main menu is shownThe program reads the following XML files for configuration information: You will encounter a parsing error if one of these files have been modified and certain XML rules were violated. Review the explanation on parsing errors to correct. A message states the database is corrupt and needs to be repaired.Probable cause is the database was not closed correctly due to the abnormal termination of the system. Repair the database by: The workstation installation program is run every time EdocWriter is statedThe system will look in the registry for the HKEY_LOCAL_MACHINE/Software/ODBC/ODBC.INI/EdocWriter key. If the key does not exist, the program assumes this is the initial use, and will configure the workstation by running the EdocWriter ODBC installation program (filename: edocinstallodbc.exe). Problems Encountered During UseA parsing error message is displayed when a instruction is selectedIf the error occurs:See for more information about correcting parsing problems. Problems with PrintersThe first approach for any printer problem is to try a different printer driver if possible. HP 5000 - Garbage added to end of documentHP Laser Printers - Wrong Bin SelectedFor version 2.2, use the HP4 driver instead of the HP4xxx driver. For version 2.3 and up, the printer dialog allows the user to select bin and paper size constants. Reset the printers, and specify DM_PAPER constant to 1. Concerning the HP 4300 and printing scripts to the manual tray, one client needed to specify no bin number but a paper size constant of 0. No paper constant exists in the list of contents for the standard size. The program will attempt to set the paper size to the specifications in the table Printer for each printer defined. The paper size constant of 0 is used in the system to indicate "use the existing value." A paper size of 0 does affect bin selection in current HP laser products. Here are the DM BIN constants provided by MicroSoft: 1 DMBIN_UPPER1 DMBIN_ONLYONE 2 DMBIN_LOWER 3 DMBIN_MIDDLE 4 DMBIN_MANUAL 5 DMBIN_ENVELOPE 6 DMBIN_ENVMANUAL 7 DMBIN_AUTO 8 DMBIN_TRACTOR 9 DMBIN_SMALLFMT 10 DMBIN_LARGEFMT 11 DMBIN_LARGECAPACITY 14 DMBIN_CASSETTE 15 DMBIN_FORMSOURCE Here are the DM PAPER constants provided by MicroSoft: 1 DMPAPER_LETTER Letter, 8 1/2- by 11-inches2 DMPAPER_LETTERSMALL Letter Small, 8 1/2- by 11-inches 3 DMPAPER_TABLOID Tabloid, 11- by 17-inches 4 DMPAPER_LEDGER Ledger, 17- by 11-inches 5 DMPAPER_LEGAL Legal, 8 1/2- by 14-inches 6 DMPAPER_STATEMENT Statement, 5 1/2- by 8 1/2-inches 7 DMPAPER_EXECUTIVE Executive, 7 1/4- by 10 1/2-inches 8 DMPAPER_A3 A3 sheet, 297- by 420-millimeters 9 DMPAPER_A4 A4 Sheet, 210- by 297-millimeters 10 DMPAPER_A4SMALL A4 small sheet, 210- by 297-millimeters 11 DMPAPER_A5 A5 sheet, 148- by 210-millimeters 12 DMPAPER_B4 B4 sheet, 250- by 354-millimeters 13 DMPAPER_B5 B5 sheet, 182- by 257-millimeter paper 14 DMPAPER_FOLIO Folio, 8 1/2- by 13-inch paper 15 DMPAPER_QUARTO Quarto, 215- by 275-millimeter paper 16 DMPAPER_10X14 10- by 14-inch sheet 17 DMPAPER_11X17 11- by 17-inch sheet 18 DMPAPER_NOTE Note, 8 1/2- by 11-inches 19 DMPAPER_ENV_9 #9 Envelope, 3 7/8- by 8 7/8-inches 20 DMPAPER_ENV_10 #10 Envelope, 4 1/8- by 9 1/2-inches 21 DMPAPER_ENV_11 #11 Envelope, 4 1/2- by 10 3/8-inches 22 DMPAPER_ENV_12 #12 Envelope, 4 3/4- by 11-inches 23 DMPAPER_ENV_14 #14 Envelope, 5- by 11 1/2-inches 24 DMPAPER_CSHEET C Sheet, 17- by 22-inches 25 DMPAPER_DSHEET D Sheet, 22- by 34-inches 26 DMPAPER_ESHEET E Sheet, 34- by 44-inches 27 DMPAPER_ENV_DL DL Envelope, 110- by 220-millimeters 28 DMPAPER_ENV_C5 C5 Envelope, 162- by 229-millimeters 29 DMPAPER_ENV_C3 C3 Envelope, 324- by 458-millimeters 30 DMPAPER_ENV_C4 C4 Envelope, 229- by 324-millimeters 31 DMPAPER_ENV_C6 C6 Envelope, 114- by 162-millimeters 32 DMPAPER_ENV_C65 C65 Envelope, 114- by 229-millimeters 33 DMPAPER_ENV_B4 B4 Envelope, 250- by 353-millimeters 34 DMPAPER_ENV_B5 B5 Envelope, 176- by 250-millimeters 35 DMPAPER_ENV_B6 B6 Envelope, 176- by 125-millimeters 36 DMPAPER_ENV_ITALY Italy Envelope, 110- by 230-millimeters 37 DMPAPER_ENV_MONARCH Monarch Envelope, 3 7/8- by 7 1/2-inches 38 DMPAPER_ENV_PERSONAL 6 3/4 Envelope, 3 5/8- by 6 1/2-inches 39 DMPAPER_FANFOLD_US US Std Fanfold, 14 7/8- by 11-inches 40 DMPAPER_FANFOLD_STD_GERMAN German Std Fanfold, 8 1/2- by 12-inches 41 DMPAPER_FANFOLD_LGL_GERMAN German Legal Fanfold, 8 1/2- by 13-inches A parsing error message is displayed when a existing or pending patient's data is retrievedThe patient data is maintained in an XML file, and is generated by the system. Email edocwriter at gmail.com or call 310-546-7435. Please use email and attach the file . Common Trouble Shooting ApproachesCorrecting XML Parsing ErrorsEdocWriter uses and creates XML files. XML is the use of tokens (i.e. <some_token>good</some_token>). An XML file must be well formed, meaning every start token ( the <some_token> ) must have a closing token ( the </some_token> ). Interleaved tokens will cause an error. Case matters in token comparisons. If the XML is not well formed then a parsing error is created. The user can edit and correct the files. If the error occurs in a template, then a selected template has a parsing error. See the template error section for more information. For all other XML files use a text editor like notepad or the html editor called wzhtml (filename: wzhtml1.exe) located in the EdocWriter installation directory. It is important for us to identify possible sources of error. Email edocwriter at gmail.com or call 310-546-7435. Please use email and attach the file . Reinstallation of ODBCListed below are the steps that should be taken in order to reinstall the various database communication components. Usually just the first step will be required. |