Calendar Event

This window is used to manage a Calendar Event.

The fields are:

Repeating Events

Calendar Events can be made to repeat one or more times, to form a series of events. Each event in the series:

• has the same details as the first event
• can be edited independently of the series

Repeat Options

Calendar Events can be made to repeat:

• Daily
  • Every day
  • On weekdays
  • Every N days
  • Every Sunday...Saturday
• Weekly
  • Every Week
  • Every N weeks
• Monthly
  • Every month
  • Every N months
  • On the first..fifth or last Sunday...Saturday every N months
  • On the 1..31 or last day(s) every N months 
• Yearly
  • Every year
  • Every N years
  • On the 1..31 January...December every N years
  • On the first..fifth or last Sunday...Saturday of January...December every N years

Calendar Events repeat until a specified date, or number of times. When using 'until date', the relative date facility can be used to calculate the date - e.g. 0ye will set the end of the current year, and 6me will set the end of the 6th month ahead.

Restrictions

• at most only 729 recurring events can be scheduled (i.e. for a total of 730 in a series)
• if an event is set to repeat on a day that is not available, it is skipped. E.g specifying a monthly repeat on the 31st of the month will skip all months without 31 days.

Deposit Accounts

This screen is used to create/edit/view the details of the bank accounts in which takings are deposited via the Reporting|Till Balancing|Deposit processing.  Most of the fields are used to provide the information to print on the Bank Deposit document obtained using Reporting|Till Balancing|Print.

The fields are as follows:
Name - the name of the Deposit Account
Account Name - the name in which the account is held
Bank - select the bank from those available in the pull-down - see Lookups|Bank
Branch - the name of the branch
Account Number - the account number
Last Deposit - the date on which the last deposit was made (this is updated by the system when the Till Balancing|Deposit processing is done)
Active - uncheck this box to deactivate the account

Locations Tab - used to set the Practice Locations for which this Deposit Account is available. Note that multiple locations can be set, but not repeated - ie an error will occur if you attempt to add one location twice

Insurance Service

This screen is used to create or edit an Insurance Service.
Insurance Services are provided by plugins and the available fields are defined by the Insurance Service provider.

Please contact your Insurance Service provider for a description of the fields.

Mail Server

Mail Server is used to configure email server settings to enable OpenVPMS to send emails.

The fields are as follows:

OTC

This screen is used to create/edit/view the OTC accounts. See also Concepts|OTC - Over The Counter.

The fields are as follows:
Name - the name of the OTC account
Description - serves to clarify the name
Active - uncheck this box to deactivate the account

Locations Tab - used to set the Practice Locations for which this OTC account is available. Note that multiple locations can be set, but not repeated - ie an error will occur if you attempt to add one location twice

Practice

This screen is used to create/edit/view the Practice. Note that you can only have one active Practice at a time.

The fields are as follows:
Practice Name - the name of the practice. This will appear on various reports and documents so it should be set as you want it to appear.
Active - uncheck this box to deactivate the practice
Currency - select the currency to be used - see Lookups|Currency
Patient Age Format - select the required format - see Lookups|Duration Formats. If you leave this set at None, default settings apply - see Lookups|Duration Formats.
Estimate Expiry - the default interval for how long estimates are valid - see Concepts|Estimates
Prescription Expiry - the default interval for how long prescriptions are valid - see Concepts|Prescriptions
Reminder Export Format - this determines the file format when exporting reminders on the Reporting|Reminders screen - it can be set to None, Comma or Tab separated values.
Auto Lock Screen - this determines how long a user's session may remain inactive before a dialog is displayed prompting the user to re-enter their password. A value of 0 disables this feature. Note that due to the way the client browser is refreshed, the dialog may be displayed up to 30 seconds after the specified period of inactivity.
In order to prevent auto-lock, you need to periodically do something that triggers synchronisation with the server. This resets the auto-lock timer. Things that trigger synchronisation include:
- pressing Enter in a field
- clicking a button (e.g. Apply)
The following will not trigger synchronisation:
- inputting text without pressing enter
- moving the mouse
- pressing tab
The reason for this is to limit the amount of network traffic between the browser and the server.
Auto Logout - this determines how long a user's session may remain inactive before the user is automatically logged out.
Scheduling Refresh - the number of seconds between automatic refreshes of the Scheduling and Work Lists displays. Use 0 to disable refreshes. When enabled, the Appointment and Task caches need to be sized correctly to ensure fast updates. See Application Caches for more details.
Show Problems in Visit - if selected, a Problems tab will be displayed in the Visit Editor. By default, it is unselected.
Ignore List Price Decreases - if selected, then if the Auto Price Update option is checked on the Product's Supplier tab and the calculated cost price is less than the existing cost price of the product, then no Auto Price Update will be done.
Log Communication - if selected, communication with a customer will be automatically logged. See Communication for more details.
Record Lock Period - the period of time after a patient medical record is created that it is locked from editing. Setting a value <= 0 disables locking. Changing this value will log an Audit message. Enabling it will schedule a job to periodically lock records. See Medical Record Locking for more details.
Minimum Quantities - used to reduce charging errors, by ensuring that a product has a minimum quantity.
When enabled, product template and estimate Low Quantities set a mininum quantity for a product. When expanding a template into an estimate or charge, the low quantity of the included product becomes the minimum quantity for an item. When invoicing an estimate, the estimate low quantities set the minimum quantities on the invoice.

• For estimates, an item is invalid if its Low Qty is less than the minimum quantity
• For charges, an item is invalid if its Quantity is less than the minimum quantity

If an item has a minimum quantity:

• it cannot be swapped for another product, if it is a service
• it can be swapped for another medication, if it is a medication
• it can be swapped for other merchandise, if it is merchandise
• it can be deleted, subject to the Override.
  This specifies the type of user that may delete items with a minimum quantity.  If unset (i.e. None), items may be deleted, but a warning will be displayed. If set, only users with the specified user type may delete the item.

When Override is set, users with the specified user type can override minimum quantities.

Show Prices Tax Inclusive - determines if fixed and unit prices in Products - Information and during product selection should be displayed inclusive or exclusive of tax.
Use Location Products - if selected, products used in charges, estimates, investigations and reminders are restricted to those available at the current location. This is useful for multi-location practices where not all products are available at each location. For:

• medication and merchandise products, this excludes products that don't have a Stock Location relationship, ie there has never been stock of the product at the stock location for the current practice location
• service and template products, this excludes products that are specifically set as not being available at the location. By default all templates and services are available at all locations. To set the 'not available at' locations for specific templates and services, use the Locations tab on the Product Information screen (which is only displayed if 'Use Location Products' is checked).

Follow Up At Checkout - check this box if you want to pop up a new task editor at check-out to optionally create a follow up task for the patient.
Use Logged In Clinician - determines how Clinician fields are populated. When:

• selected, Clinician fields default to:
  • the current user, when the logged in user is a clinician; else
  • the workflow clinician or the last selected clinician, when the logged in user is not a clinician

This is the preferred choice.

• unselected, Clinician fields default to the workflow clinician, or the last selected clinician  

Only use this if workstations are shared.

Short User Name Format - specifies the format for user and clinician names in reports. Defaults to the user's name.
Medium User Name Format - specifies the format for user and clinician names in printed Medical Records and Problems, Appointments and Tasks, and Drug Labels. Defaults to the user's title and name.
Long User Name Format - specifies the format for user and clinician names in Estimates and certificates. Defaults to the user's title, name and qualification.
Restrict Ordering - when selected, supplier orders can only be finalised by a clinician. This can be used in jurisdictions that require restricted drug ordering to be limited to clinicans.
Pharmacy Order Discontinue Period - determines how long after an invoice is finalised that any pharmacy orders are discontinued. When non-zero, this automatically schedules a Pharmacy Order Discontinuation Job to discontinue pharmacy orders after invoices have been finalised. If zero or not specified, pharmacy orders are discontinued when an invoice is finalised.
Service User - the user responsible for background services. This is required by:

• the HL7 services to update outbound messages.
• the Smart Flow Sheet interface, when processing events (e.g. treatments, discharge)
• medical record locking
• plugins

Mail Server - the default email server. This is used:

• by the email-to-SMS gateway
• when no Mail Server is specified on a Practice Location

SMS - the SMS gateway.
Appointment SMS - the default appointment reminder SMS template to use if no template is specified for a Practice Location. See also Template|Appointment Reminder SMS Template.
Reminder Configuration  - determines how patient reminders are processed. See Reminder Configuration.
Smart Flow Sheet Configuration - configuration for the Smart Flow Sheet interface. See Smart Flow Sheet Configuration.

The Contacts tab is used to view and maintain the various contacts. The types are as follows:
 

Location - you should set this so that it can appear on reports and documents
Phone - again you should set this so that it can appear on reports and documents
Email - you need to set this, not only so that it can appear on reports and documents, but also because it is used by the system when generating the From address on emails being sent out. In particular, the code that sends out Reminders and Statements via email will the Practice's email addresses for customers who do not have a Practice Location set. If you set one with the purpose 'Billing' it will be used for the Statements. If you set one with the purpose 'Reminder' it will be used for Reminders. Note however that emails initated by users are sent out using the current location's email address(es).

See Concepts|Contacts for details.

Below is the Locations tab. You can use this to set the Practice Locations, but it's more normal to attach the locations to the practice when setting up the locations.

Below is the Taxes tab. Use this to set the applicable taxes.

Below is the Templates tab. You should set the 'default' template here for each type of template for which you have multiple templates of that type. For example if you are using different Invoice templates for some Practice Locations, then you should set the default invoice template here.

Below is the Subscription tab with no current subscription. First you need to click the link to purchase the subscription. You will be sent a key file.  Upload this by clicking the Upload button.

Below is the Subscription tab showing the current subscription (with the details intentionally blurred).

Practice Location

This screen is used to create/edit/view the Practice Locations, ie the branches of the practice. See Concepts|Practice and Locations for background.

The fields are as follows:
Location Name - the name of the location. This will appear on various reports and documents so it should be set as you want it to appear.
Active - uncheck this box to deactivate the location
Stock Control - check this box to enable stock control for this location
Rostering - check this box to enable rostering at this location
Roster Check Period - determines how far into the future that the roster is checked when assigning clinicians to appointments. This is to avoid warning users that a clinician is not rostered on when the roster hasn't been established.
Logo - used to set the logo to be displayed at the top of the screen when the Practice Location is selected. Logos may be .png, .jpg, .gif, or .bmp format, and should be no more than 30 pixels high. Note that any new logo will be displayed after the location is selected.
Default Printer - use the pull-down to select the default printer for this location.
Pricing Group - the pricing group in use for the practice location. This is optional. It is used by practices that set different prices for the same product at different locations. See Concepts|Pricing for details.
Disable Discounts - if selected, disables discount entry when editing charges and estimates at this location.
Stock Locations - sets the Stock Location for the location. If you have Stock Control enabled for this location then you must have one. Multiple locations can share the one stock location. See also Organisation|Stock Location.
OTC - sets the OTC account for the location. You can only have one but multiple locations can share the one OTC account. See also Organisation|OTC.
Smart Flow Sheet Clinic API Key - specifies the API key used to connect to Smart Flow Sheet. See also Smart Flow Sheet integration.
Mail Server - specifies the email server to use when sending emails from the location. If none is specified, the mail server associated with the Practice will be used. See also Organisation|Mail Server.
Appointment SMS - specifies the appointment reminder SMS template to use when sending SMS reminders from the location. If none is specified, the template associated with the Practice will be used. See also Template|Appointment Reminder SMS Template.
Letterhead - specifies the Letterhead template to use for this location. This field is not mandatory but is needed if you want to use the Letterhead facility for easy customisation of invoice, credit notes, statements etc.
Online Booking - if selected, appointment schedules at this location that also have Online Booking selected, are available for online booking.

The Contacts tab is used to view and maintain the various contacts. The types are as follows:
Location - you should set this so that it can appear on reports, documents and the letterhead
Phone - again you should set this so that it can appear on reports, documents and the letterhead. If you have a fax number, you should enter it (as a Phone contact with purpose Fax) so that it can be shown on the letterhead.
Email - you need to set this, not only so that it can appear on reports, documents and the letterhead, but also because it is used by the system when generating the From address on emails being sent out. Although the code that sends out Reminders and Statements via email uses the Practice's email addresses, emails initiated by users are sent out using the current location's email address.  If there are multiple email addresses set, then the user can choose the required one from a pull-down list.
Website - you should set this so that it can appear on reports, documents and the letterhead

See Concepts|Contacts for details.

Below is the Practice tab. Use this to set the Practice to which this location belongs. Note that you can have a location not attached to a practice, but it can't be used because it can't be selected using the Location pull-down at the top right of the screen.

Below is the Tills tab. Use this to set theTill(s) for the location. You must have at least one, otherwise there is nowhere to put the money. It is possible for multiple locations to share tills. See also Organisation|Tills.

Below is the Deposit Accounts tab. Use this to set the Deposit Account(s) for the location. You must have at least one, otherwise there is nowhere to deposit the money. It is possible for multiple locations to share accounts. See also Organisation|Deposit Accounts.

Below is the Schedule Views tab. Use this to set the Schedule Views for the location. You must have one, but can have more. Multiple locations can share Schedule Views. See also Organisation|Schedule Views.

Below is the Work List Views tab. Use this to set the Work List Views for the location. You must have one, but can have more. Multiple locations can share Work List Views. See also Organisation|Work List Views.

Below is the Printers tab. Use this to set the printers that may be selected at the location. If no printers are listed, all will be available for selection.

The Status column indicates if a printer is Available or Unknown. If a printer is marked as Unknown, it is no longer available for selection when printing.

Below is the Templates tab. Use this to set any location specific Document Templates.These were commonly used where it was necesssary for each location to have different logos on invoices, receipts etc. However, the Letterhead facility now provides this. The facility is of use for setting location specific printers, and for testing new versions of templates.

Below is the Service Ratios tab. Use this to apply a ratio to prices of products of a specific product type, at this practice location. See Service Ratios for more details.

Follow-up Work Lists tab. Use this to configure the work lists that may be selected when:

• clicking the button in the patient summary, to add a follow-up task
• the Follow-Up At Check Out option is selected to create follow-up tasks at check-out

Roster Area

A Roster Area is an area within a Practice Location where employees work.

It is used in Workflow - Rostering to roster employees on to shifts.

A Roster Area may have optional Schedules. These determine which schedules a clinician may be rostered on to for an appointment.

The fields are as follows:

SMS Configuration: Clickatell SMTP Connection

This screen is used to configure the SMS gateway for Clickatell. See also Concepts|SMS and Reference|Setup|SMS. The screen is in two parts - the top contains the parameters, the bottom allows you to test the setup.

The fields in the top half are as follows:

Name - the name of the connection
Description - a description which serves to clarify the name
Website - Clickatell's website
Active - uncheck this box to deactivate this configuration
Country Prefix - the country code, eg 61 for Australia, 44 for the UK, etc
Area Prefix - the digit used to prefix the area code, ie 0 for Australia - see also below
User - the user name for the Clickatell account
Password - the password for the Clickatell account
API ID - the API ID provided by Clickatell
From - a valid email address
Reply To - an optional email address - responses from the gateway will be sent here
Sender ID - the SMS sender ID. If specified, it must correspond to one configured with the Clickatell account.
2 Way SMS - used to indicate that Clickatell should use Sender ID to allow mobile phone users to send SMS messages to your Clickatell account. See the Send 2 Way SMS Service for more details.
Maximum Parts - the maximum number of parts that may be sent in a single message. These are sent as multiple SMS by Clickatell, but are concatenated together so that the recipient sees a single message.
Each part is charged separately by Clickatell.
The specified number must not exceed that of the Clickatell account.

Notes:

• If your Clickatell SMS Configuration was created prior to OpenVPMS 1.7.1, you will need to recreate it to use the Sender ID field.
• If your Clickatell SMS Configuration was created prior to OpenVPMS 1.9, you will need to recreate it to use the 2 Way SMS field.

The bottom half of the screen contains:
Number - the phone number to which the test message is to be sent
Message - the text for the SMS message
SMS Button - press to send the email
Email - this panel shows the email that will be sent
Status - this shows 'OK' if all is OK else an error message indicating what is wrong
To get the Email and Status to update you must press the Enter key when the cursor is positioned in either of the Number or Message fields.

Note: The Country and Area Prefixes are used to format phone numbers so that they have the required format. That is, the customer's number will be something like 0413 123 456, but the gateway needs the full international number, ie 61413123456. However, if the customer lives in another country then their number will be something like (for Hong Kong) 852 1234 5678. You need to indicate that this is an international number by prefixing it with a +, ie +85212345678.

So the logic is:
If the number starts with a +, strip it and use that number.
Else does the customer's number start with the Area Prefix? If yes, then strip the prefix and add the Country Prefix.

SMS Configuration: Generic Email Gateway

This screen is used to configure the generic SMS gateway. See also Concepts|SMS and Reference|Setup|SMS. The screen is in two parts - the top contains the parameters, the bottom allows you to test the setup. Note that this is a generic gateway configuration screen - the screen shot below shows parameters suitable for Exetel.

The fields in the top half are as follows:
Name - the name of the connection
Description - a description which serves to clarify the name
Website - the provider's website
Active - uncheck this box to deactivate this configuration
Country Prefix - the country code, eg 61 for Australia, 44 for the UK, etc
Area Prefix - the digit used to prefix the area code, ie 0 for Australia - see also below

From & From Expression - these define the email's From address. If only From is entered, this is used. If the From Expression is provided, it is evaluated and the result used. The expression may refer to the From value as "$from".

To & To Expression -these define the email's To address. If only To is entered, this is used. If the To Expression is provided, it is evaluated and the result used. The expression may refer to the To value as "$to".

Reply To & Reply To Expression - these define the email's Reply To address. If only Reply To is entered, this is used. If the Reply To Expression is provided, it is evaluated and the result used. The expression may refer to the Reply To value as "$replyTo".

Subject & Subject Expression - these define the email's Subject. If only Subject is entered, this is used. If the Subject Expression is provided, it is evaluated and the result used. The expression may refer to the Subject value as "$subject".

Text & Text Expression - these define the email's Text. If only Text is entered, this is used. If the Text Expression is provided, it is evaluated and the result used. The expression may refer to the Text value as "$text"."

Maximum Parts - the maximum number of parts that may be sent in a single message. These are sent as multiple SMS by the gateway provider, but are concatenated together so that the recipient sees a single message.
Each part will be charged separately by the provider.
The specified number must not exceed that supported by the provider.

The bottom half of the screen contains:
Number - the phone number to which the test message is to be sent
Message - the text for the SMS message
SMS Button - press to send the email
Email - this panel shows the email that will be sent
Status - this shows 'OK' if all is OK else an error message indicating what is wrong

To get the Email and Status to update you must press the Enter key when the cursor is positioned in either of the Number or Message fields.

Note: The Country and Area Prefixes are used to format phone numbers so that they have the required format. That is, the customer's number will be something like 0413 123 456, but the gateway needs the full international number, ie 61413123456.  However, if the customer lives in another country then their number will be something like (for Hong Kong) 852 1234 5678. You need to indicate that this is an international number by prefixing it with a +, ie +85212345678.

So the logic is:
If the number starts with a +, strip it and use that number.
Else does the customer's number start with the Area Prefix? If yes, then strip the prefix and add the Country Prefix.

SMS Configuration: SMSGlobal Email2SMS

This screen is used to configure the SMS gateway for SMSGlobal. See also Concepts|SMS and Reference|Setup|SMS. The screen is in two parts - the top contains the parameters, the bottom allows you to test the setup.

The fields in the top half are as follows:
Name - the name of the connection
Description - a description which serves to clarify the name
Website - SMSGlobal's website
Active - uncheck this box to deactivate this configuration
Country Prefix - the country code, eg 61 for Australia, 44 for the UK, etc
Area Prefix - the digit used to prefix the area code, ie 0 for Australia - see also below
From - a valid email address - this must be the same as that entered in the Email to SMS settings in the Email Settings page at https://mxt.smsglobal.com/integrations/email-to-sms
Subject - placeholder email subject. This is not used by SMSGlobal, but may be set to prevent mail servers from rejecting SMS emails as spam.
Maximum Parts - the maximum number of parts that may be sent in a single message. These are sent as multiple SMS by SMSGlobal, but are concatenated together so that the recipient sees a single message.
Each part is charged separately by SMSGlobal.
The specified number must not exceed that of the Maximum Messages Split Allowed setting in the SMSGlobal Email Settings page at https://mxt.smsglobal.com/integrations/email-to-sms.

The bottom half of the screen contains:
Number - the phone number to which the test message is to be sent
Message - the text for the SMS message
SMS Button - press to send the email
Email - this panel shows the email that will be sent
Status - this shows 'OK' if all is OK else an error message indicating what is wrong

To get the Email and Status to update you must press the Enter key when the cursor is positioned in either of the Number or Message fields.

Note: The Country and Area Prefixes are used to format phone numbers so that they have the required format. That is, the customer's number will be something like 0413 123 456, but the gateway needs the full international number, ie 61413123456. However, if the customer lives in another country then their number will be something like (for Hong Kong) 852 1234 5678. You need to indicate that this is an international number by prefixing it with a +, ie +85212345678.

So the logic is:
If the number starts with a +, strip it and use that number.
Else does the customer's number start with the Area Prefix? If yes, then strip the prefix and add the Country Prefix.

Schedule

This screen is used to create/edit/view the Schedules. These together with the views (see Organisation|Schedule View) determine how the Workflow|Scheduling screen works. It also sets options to control the check-in behaviour.

The fields are as follows:

Name - the name of the schedule
Description - serves to clarify the name
Slot Size - this and Slot Units defines the size of each slot in the schedule
Slot Units - can be set to minutes or hours
Allow Double Booking - check this box to allow multiple appointments to be scheduled at the same time.
Active - uncheck this box to deactivate the schedule. Note that if you do deactivate a schedule because it is no longer needed, then you should also remove this schedule from any schedule views in which it is used, otherwise the Workflow|Scheduling screen will happily display and let you use a schedule that has been deactivated.
Start  & End Time - these define the work day - ie the times between which appointments can be booked. If left unset, they default to 08:00 to 18:00 respectively.  Enter either in hh:mm or hhmm format. If you enter just the hour the minute portion will be set to the current time (ie 9 yields 9:13 if the current time is 11:13).
If you set say 18:00 as the end time, then the last slot shown on the schedule will start at the slot size before this, ie 17:45 if you have a 15 minute slot size.
For a practice that operates on a 24 hour basis, you should set the start time to 00:00 and the end to 24:00.
Use All Work Lists - if this box is checked, then when an appointment if checked-in from this schedule, you will be able to choose any work list, otherwise only the worklists defined in the Work Lists tab will be available
Input Weight - if this box is checked, then as part of the check-in, the New Weight screen will be displayed so that the patient's weight can be entered
Use All Templates - if this box is checked, then as part of the check-in, all patient form and letter document templates will be displayed for you to select from, otherwise only those defined in the Templates tab will be available
Send Appointment Reminders - if this box is checked, SMS reminders may be sent automatically for appointments in the schedule. If not checked, then SMS reminders can still be sent manually.
Online Booking - determines if this schedule is available for online booking
Online Booking Times - specifies alternative times to the Start and End Times for online bookings.
Location - this field is mandatory and is used to set the Practice Location to be associated with this schedule when sending out SMS appointment reminders.
Cage Type - identifies a schedule as being a physical cage, used for boarding or in-hospital stay.  

Views tab - used to set the Schedule Views which this Schedule is included in

Appointments Types tab - as shown below, this is used to view, add and delete the Appointment Types that are valid for this Schedule.

The fields are as follows:
Appointment Type - the appointment type (the available types are determined by the Administration|Types|Appointment screen)
No of Slots - the lenght of this appointment type in this schedule
Default - check this box if this is the default appointment type.

Work Lists tab - as shown below, this is used to view, add and delete the Work Lists you can choose from when checking-in an appointment on this schedule.
These only apply when Use All Work Lists is not selected.
If a Work List has its Default flag selected, it will be pre-selected at patient Check-In.

The Work List flagged as the Default will be pre-selected

Templates tab - as shown below, this is used to view, add and delete the patient form and letter document templates that will be presented to choose from when checking-in an appointment to this schedule.
The templates will only be used if Use All Templates is not selected.

As you can see you can add, delete and modify the list of templates.
The Print option allows a template to be pre-selected for printing. Use this if a template is always printed when a patient is checked in to the schedule.

Schedule View

This screen is used to create/edit/view the Schedule Views. These together with the schedules themselves (see Organisation|Schedules) determine how the Workflow|Scheduling screen works.

The fields are as follows:
Name - the name of the schedule view
Description - serves to clarify the name
Active - uncheck this box to deactivate the schedule view
Display Expression - this the expression used to construct what is displayed when the schedule view contains multiple schedules. (It's not used if there is only a single schedule in the view.) See also Expressions below.
Display Notes - uncheck this if you do not want the notes icon shown on the multi-schedule version of the Workflow|Scheduling screen. On the single-schedule version, the notes text is shown in the Notes column.
Highlight - you can select None, Clinician, Event Type (ie appointment type), or Status. This determines the initial setting of the Highlight setting on the Scheduling screen. Remember that if you are going to make proper use of this highlighting facility, then you need to set different colours for each clinician (in Administration|Users), appointment type (in Administration|Types|Appointment). However if you want to change the status colours, it's more difficult - see Reference|Colours.
Multiple Day View - if selected, multiple days worth of appointments can be shown at once.
Use strikethrough for Completed/Cancelled - if selected, Completed and Cancelled appointments are displayed with strikethrough text.
Schedules tab - used to set the Schedules which this Schedule View includes.  If there are more than one, then the Workflow|Scheduling screen initially shows each schedule in its own column.  If there is only one, then a different screen format is used with columns for each of Status, Appointment Type, Customer, Patient, Reason and Notes.  Even with a multiple-schedule view, you can switch the Scheduling screen to show only a single schedule.

Test Button
Pressing the Test button opens a window that allows you to test and compose expressions. It includes documentation and examples as well as its own Test button that actually tests your expression and displays the resulting text.

Expressions
The expression shown in the screenshot above is duplicated here so you can copy it:

concat(openvpms:get(.,'clinician.name'),': ',openvpms:get(.,'customer.name'),' - ',openvpms:get(.,'patient.name'),'\n',openvpms:get(.,'act.reasonName'),' - ',openvpms:get(.,'act.statusName'))

Note that what we are doing is concatenating together bits of information from the openvpms:get calls with various separators, eg ': '. The '\n' injects a newline character to start a second line.

The following table shows the parameters that the expressions have access to, that is, each of the node names which can be used in the openvpms:get(.,'nodeName') function.

There are also a number of others which may be used, but not particularly efficiently as they require database queries.

• patient.objectReference - reference to the patient
• act.objectReference - reference to the appointment/task
• schedule.objectReference - reference to the schedule
• customer.objectReference - reference to the customer
• clinician.objectReference - reference to the clinician

To get the breed, do:

 openvpms:lookup(openvpms:get(., "patient.objectReference"), "breed")

To get the customer's last name, do:

 openvpms:get(.,"customer.objectReference.lastName") 

Notes:

• the various objectReference properties above aren't supported by the Display Expression editor and hence if you use its Test function, you will get 'Expression Error'
• if there is no patient, an empty string will be returned

However, if you need a customer's full name and address to show on a schedule view so that a house call vet can look at the schedule with his iPhone to see where to go next, then the following will do the trick:

normalize-space(openvpms:get(., "customer.objectReference.description"))

The 'normalize-space' function (one of the xpath functions) removes the newline characters to convert the multiline address into a single line.

Finally, an example where the information is displayed over three lines but is limited to 30 characters wide:

 concat(substring(concat(openvpms:get(., 'clinician.name'),': ', openvpms:get(., 'patient.name'),' ',openvpms:get(.,'customer.objectReference.lastName')),1,30),'\n', substring(concat('[',openvpms:lookup(openvpms:get(., 'patient.objectReference'),'breed'),']'),1,30),'\n', substring(concat(openvpms:get(.,'scheduleType.name'), ':', openvpms:get(.,'act.reasonName'),' ', openvpms:get(.,'waiting')),1,30)) 

Service Ratio Calendar

This screen is used to create/edit/view Service Ratio Calendars.
These are used to determine the dates and times that a Service Ratio applies.

The top part of the screen contains the calendar details.
The bottom part contains the events in the calendar.

The fields are as follows:

Calendar Events

Calendar Events determine when a Service Ratio applies.
Wherever there is:

• an event, the Service Ratio will be applied
• no event, the Service Ratio will be ignored

To add, change, or delete events, double click on a cell to edit it.
If the cell is empty, a new event will be created.
 

Stock Location

This screen is used to create/edit/view the Stock Locations, ie the store rooms where stock is held. See Concepts|Stock Control for background.

The fields are as follows:
Name - the name of the stock location. This will appear on various reports and documents so it should be set as you want it to appear.
Description - used to clarify the name if necessary
Active - uncheck this box to deactivate the stock location

The Default Author tab is used to view and maintain the user set as the author of stock management transactions generated by the system. It is possible to set an normal user for this, but it is better to create a special user - as is shown in the screen shot above.

Below is the Locations tab. Use this to set the Practice Locations to which this stock location belongs. One stock location can be used by multiple practice locations, but a practice location cannot have more than one stock location. Note that you can have a stock location not attached to a practice location, but it is of little use since all you can do is use the Products|Stock Management|Stock Transfer transaction to transfer items to it.  However, you could use this as a mechanism to keep a record of written-off stock, ie create a stock location called Write-offs unlinked to any practice location, and transfer written-off stock to it.

Till

This screen is used to create/edit/view the details of the Tills. See Concepts|Tills for background information.

The fields are as follows:
Name - the name of the till
Till Float - the float - ie the amount of cash money to be left in the till when it is cleared as part of the Reporting|Till Balancing|Clear operation
Last Cleared - the date on which the till was last cleared.  Although you can modify this field, you should not normally need to as it is set by the system.
Active - uncheck this box to deactivate the till
Printer Name - the receipt printer name. Used in conjunction with Drawer Command to open the cash drawer.
Drawer Command - a comma separated list of numbers, in the range 0..255 that may be used to trigger the cash drawer to open. The Test button can be used to verify that the Drawer Command can be used to open the drawer.

Locations tab - used to set the Practice Locations which this till is used by

Opening the Cash Drawer

Many POS terminals support opening the cash drawer by sending a set of control codes to the receipt printer. OpenVPMS supports this through the Printer Name and Drawer Command fields.

OpenVPMS will send the drawer command to the receipt printer when:

• a payment containing Cash, Cheque, or Credit line item is finalised
• a payment containing an EFT line item with non-zero Cashout is finalised
• a refund containing a Cash, Cheque or Credit line item is finalised

Consult your POS terminal vendor for the appropriate control codes to use.

Alternatively, see this list.

Work List

This screen is used to create/edit/view the Work Lists. These together with the views (see Organisation|Worklist View) determine how the Workflow|Scheduling screen works and also to control what screens are presented as part of the check-in and worklist transfer processes. See also the note at the bottom about * as the default task type.

The fields are as follows:
Name - the name of the work list
Description - serves to clarify the name
Max Slots - the maximum number of slots in the work list, ie how many entries it can contain. For normal 'list of jobs' work lists this can be left at the default of 100. However, if your work list represents some limited commodity such as the number of boarding kennels, then you should set the Max Slots to this.  
Active - uncheck this box to deactivate the work list. Note that if you do deactivate a work list because it is no longer needed, then you should also remove this work list from any work list views in which it is used, otherwise the Workflow|Work Lists screen will happily display and let you use a work list that has been deactivated.
Use All Templates - uncheck this box if you want to limit the list of document templates presented for selection at check-in and worklist transfer time. You will then need to use the Templates tab to define which templates are to be displayed for selection, and if none are defined then the document selection step will be skipped. If the box is checked, then all suitable templates will be displayed for selection. Note that even if you do want to be able to select from all available templates, you may want to uncheck this box and list all the templates in the Templates tab because you can then control the order so that the most commonly used one are listed first.
Input Weight - uncheck this box if you do not want the Weight recording window to be displayed as part of the Check In process.
Create Flow Sheet - used to create a Smart Flow Sheet for a patient on Check In, or when the patient is transferred to the Work List. Only applies if Smart Flow Sheet has been configured for the Practice Location.
Default Flow Sheet Department - the default Flow Sheet department. Only applies if if Smart Flow Sheet has been configured for the Practice Location.
Default Flow Sheet Template - the default Flow Sheet treatment template. Only applies if if Smart Flow Sheet has been configured for the Practice Location.
Expected Hospital Stay - the default expected number of days stay.

Views tab - used to set the Work List Views which this Work List is included in

Task Types tab - as shown below, this is used to view, add and delete the Task Types that are valid for this work list.

The fields are as follows:
Task Type - the task type
No of Slots - this field is not currently used by the system (every task type uses one slot in the work list irrespective of anything you set here)
Default - check this box if this is the default task type

Templates tab - as shown below, this is used to view, add and delete the Templates that are valid for this work list - i.e. those that will be suggested for use when a check-in or task transfer is done.
The templates will only be used if Use All Templates is not selected.

As you can see you can add, delete and modify the list of templates.
The Print option allows a template to be pre-selected for printing. Use this if a template is always printed when a patient is checked in or transferred to the Work List.
 

Note that in order to enable the quickest possible selection of the Task Type on the Workflow/Work Lists screen, you should define an task type "*" (description 'unspecified') and make this the default.  When you do the check-in, this will get set as the task type, and can generally be left as is BECAUSE the Notes field of the worklist entry gets automatically set to the Appointment Reason + the Appointment Notes.  However, if you do want to set a specific Task Type, you can just edit the Worklist entry and press the Task Type binoculars to show the available types (and all available types will be displayed because * acts as a wildcard mean 'show all'). 

If you don't like this approach, then be sure to set the default task type for the worklist to the most common task, so that most of the time you don't need to change it.

Work List View

This screen is used to create/edit/view the Work List Views. These together with the work lists themselves (see Organisation|Work Lists) determine how the Workflow|Work Lists screen works.

The fields are as follows:
Work List View - the name of the work list view
Description - serves to clarify the name
Active - uncheck this box to deactivate the schedule view
Display Expression - this the expression used to construct what is displayed when the work list view contains multiple work lists. (It's not used if there is only a single work list in the view.) See also Expressions below.
Display Notes - uncheck this if you do not want the notes icon shown on the multi-work list version of the Workflow|Work List screen. On the single-work list version, the notes text is shown in the Notes column.
Highlight - you can select None, Clinician, Event Type (ie task type), or Status. This determines the initial setting of the Highlight setting on the Work Lists screen. Remember that if you are going to make proper use of this highlighting facility, then you need to set different colours for each clinician (in Administration|Users), task type (in Administration|Types|Task Type). However if you want to change the status colours, it's more difficult - see Reference|Colours.
Work Lists tab - used to set the Work Lists which this Work List View includes.  If there are more than one, then the Workflow|Work Lists screen shows each work list in its own column.  If there is only one, then a different screen format is used with columns for each of Status, Appointment Type, Customer, Patient, Reason and Notes.  Even with a multiple-work list view, you can switch the Work List screen to show only a single work list.

Test Button
Pressing the Test button opens a window that allows you to test and compose expressions. It includes documentation and examples as well as its own Test button that actually tests your expression and displays the resulting text.  Note that it is possible to write a valid complex expression that the Test facility says is invalid - see the note at the bottom of this page.

Expressions
The expression shown in the screenshot above is duplicated here so you can copy it:

 concat(openvpms:get(.,'clinician.name'),':',openvpms:get(.,'patient.name'),' ',openvpms:get(.,'customer.objectReference.lastName'),' =',substring(openvpms:get(.,'act.status'),1,2),' ', openvpms:get(.,'waiting'),'{',date:format(openvpms:get(., 'act.objectReference.appointments.source.startTime'), "HH:mm"),'}',openvpms:get(.,'customer.objectReference.type.name'),'\n','[',openvpms:lookup(openvpms:get(.,'patient.objectReference'),'breed'),'] ',openvpms:get(.,'scheduleType.name'),':',openvpms:get(.,'act.objectReference.author.entity.name'),'\n',openvpms:get(.,'act.description')) 

Note that what we are doing is concatenating together bits of information from the openvpms:get calls with various separators, eg ': '. The '\n' injects a newline character to start a second line. The above expression generates output like:

ie the clinician is DQ, the patient is Miso, customer last name Liang, status is In Progress, 1 hour 32 between being checked in and the consult starting, the appointment was at 09:15, the customer Account Type is 'Creature Comforts', breed is Poodle-Toy, task type is Hospital Inpatient, the task author is 'Anita Chiu', and the bottom line gives the task notes.

The following table shows the parameters that the expressions have access to, that is, each of the node names which can be used in the openvpms:get(.,'nodeName') function.

There are also a number of others which may be used, but not particularly efficiently as they require database queries.

• patient.objectReference - reference to the patient
• act.objectReference - reference to the appointment/task
• schedule.objectReference - reference to the schedule
• customer.objectReference - reference to the customer
• clinician.objectReference - reference to the clinician
• author.objectReference - reference to the author

To get the breed, do:

openvpms:lookup(openvpms:get(., "patient.objectReference"), "breed")

To get the customer's last name, do:

openvpms:get(.,"customer.objectReference.lastName")

To get the referring practice if any, use:

expr:concatIf('\n', 'Ref: ',openvpms:get(party:getPatientReferralVetPractice(openvpms:get(., 'patient.objectReference')), 'name'))

In the above, the expr:concatIf() function ensures that things work nicely if there is no referring practice since the whole expression becomes null if one component is null.

To get the appointment start time (in 24hour format) for this task, do:

date:format(openvpms:get(., 'act.objectReference.appointments.source.startTime'), "HH:mm"))

Notes:

• the various objectReference properties above aren't supported by the Display Expression editor and hence if you use its Test function, you will get 'Expression Error'
• when you are testing a new expression, remember that you need to logout and log back in again in order for the new expression to be active
• if there is no patient, and empty string will be returned
• The various $patient, $customer, $task etc variables that are available in macro expressions are not available here

However, if you need a customer's full name and address to show on a schedule view so that a house call vet can look at the schedule with his iPhone to see where to go next, then the following will do the trick:

normalize-space(openvpms:get(., "customer.objectReference.description"))

The 'normalize-space' function (one of the xpath functions) removes the newline characters to convert the multiline address into a single line.

Confirm Delete

When you press the Delete button on the Administration|Organisation screen, a confirmation window will appear.

If the selected Organisation is not in use and can be deleted, the window will simply ask you to confirm the delete. Press OK to confirm or Cancel to abort.

If it cannot be deleted because it is in use, the text will be "xxxx has relationships and cannot be deleted. Do you want to deactivate it instead?"(where xxx is the name of the item you are trying to delete). Pressing OK will unset its Active flag, Cancel will abort.

If it is in use but can be deleted, the text will be "xxxx has relationships. Are you sure want to delete? This operation cannot be undone." (where xxx is the name of the item you are trying to delete). Pressing OK will delete the item as well as all references to it, Cancel will abort.

Confirm New

This is the New Organisation confirmation window. Select the type of Organisation to be created and then use OK to continue or Cancel to abort. Note that if you have selected a type on the Organisation screen, then this will already be selected in this window (even if it is not showing in the list of types) - thus you can normally simply click OK to proceed.

Appointment

This screen allows you to create/view/edit the details for each Appointment Type. This and Organisation|Schedule determine what appointment types can be made.

The fields are as follows:

Appointment Type - it's name
Description - you can use this to clarify the type of appointment
Colour - used to set the colour used to identify appointment types in the schedule screen. You use the mouse to select the colour via the colour and luminosity/hue boxes.  If you want to check the colours of the different appointment types, the easiest way to do this is to view the appointment type and then to use the Next and Previous buttons to run back and forth through the different types.
Note that you should avoid the 'light cream' colour f2f3b3 which displays as follows:
because this is used to highlight the selected item on the Workflow|Scheduling screen.
Active - uncheck the box to deactivate the Appointment Type
Online Booking - determines if this appointment type is available for online booking
Send Appointment Reminders - if this box is checked, SMS reminders may be sent automatically for appointments with the appointment type, providing that their schedule also has Send Appointment Reminders checked.

Cage Type

This screen allows you to create/view/edit Cage Types.

These are used to:

• indicate that an appointment Schedule is used for boarding or in-hospital stay
• determine charges for the Schedule

The fields are as follows:

• Name - the name of the Cage Type
• Description - the description of the Cage Type
• Active - determines if the Cage Type is active or inactive. If it is inactive, it is not available for selection.
• First Pet Product - Day - the product that is charged for day boarding
• Second Pet Product - Day - the product that is charged for day boarding for other pets belonging to the same customer in the same cage (i.e. the first pet is charged using the First Pet Product - Day). Optional
• First Pet Product - Overnight - the product that is charged per night for one pet.
• Second Pet Product - Overnight the product that is charged per night for other pets belonging to the same customer in the same cage (i.e. the first pet is charged using the First Pet Product - Overnight). Optional.
• Late Checkout Time - the time after which a fee is charged for late checkout. Optional.
• Late Checkout Product - the product that is charged for late checkout. Optional.

The products may be templates with weight rules, in order to support weight-based charging.  

Cage Type Invoicing Rules

All charges are based on the time of check-in, and time of check-out. The appointment times are not used charging purposes.

Single Pet

Single pets are charged the First Pet Product - Day, if they check-in and out on the same day.
If they stay multiple days, they are charged First Pet Product - Overnight, with the quantity determined set to the number of days beween the current date and the pet's visit date. Any time is ignored.

Multiple Pets, Same Cage

If a customer has multiple pets in the same cage, and the pets are entering and leaving on the same days:

• The heaviest pet is charged as per the Single Pet rule above. The heaviest pet is selected to ensure that weight based templates are applied uniformly.
• For single day stay, subsequent pets in the cage are charged Second Pet Product - Day, if present. If none is defined, they will be charged First Pet Product - Day.
• For multiple day stay, subsequent pets in the cage are charged Second Pet Product - Overnight, if present. If none is defined, they will be charged First Pet Product - Overnight.

Multiple Pets, Same Cage, Different Days.

If a customer has multiple pets in the same cage, but the pets are entering and leaving on the different days, the Single Pet rule above applies to each pet.

Multiple Pets, Different Cages

Multiple pets in different cages are each charged using the Single Pet rule above.

Late Checkout

If a Cage Type specifies a Late Checkout Time and Late Checkout Product, and the time at checkout is greater, then the Late Checkout Product will be charged, with quantity 1.

Note:

• the late checkout charge does not apply if the pet overstays, but leaves before the Late Checkout Time. It will be charged for the additional day(s) using the rules above.
• if a customer does a late checkout and has multiple pets, the Late Checkout Product for each Cage Type may be charged to the invoice.

Calendar Block

Calendar Block Types are used by Calendar Blocks to:

• determine how the Calendar Block is displayed
• reserve Calendar Blocks to specific customers

The fields are:

Name - the name of the Calendar Block Type
Description - optional description
Colour - used to set the colour used to identify blocks in the schedule screen. You use the mouse to select the colour via the colour and luminosity/hue boxes.  If you want to check the colours of the different types, the easiest way to do this is to view the type and then to use the Next and Previous buttons to run back and forth through the different types.
Note that you should avoid the 'light cream' colour f2f3b3 which displays as follows:
because this is used to highlight the selected item on the Workflow|Scheduling screen.
Active - uncheck the box to deactivate the Calendar Block Type
Reserve For Account Types - specifies any Customer Account Types to reserve times for.
Reserve For Customer Types - specifies any Customer Types to reserve times for.

Discount

This screen allows you to create/view/edit the Discount Types. See also Concepts|Discounts.

The fields are as follows:
Name - the name of the discount
Description - a description that serves to clarify the name
Discount Type - either Percentage (ie a percentage of the amount), Fixed (ie a fixed amount), or At-cost + Rate + Tax
Rate - either the fixed amount (for the Fixed type), or the percentage amount (for the Percentage and At-cost types)
Include Fixed Amount - check this box if the discount is to apply to the fixed component of the product price as well as its unit component
Active - uncheck this box to deactivate the discount

Note that the 'At-cost + Rate + Tax' type is so-named to reflect how the discount amount is calculated. Whereas with a Percentage discount of 10%, the sale price is reduced by 10% and thus the discount amount is 10% of the original sale price.

With an At-cost discount of 10%, the item is sold for (cost+10%)+tax, and thus the discount amount will depend on the markup.

Discount Group

This screen allows you to create/view/edit the Discount Groups. These are used to group together Discounts so that multiple discounts can be more easily set for a customer or patient. See also Concepts|Discounts.

The fields are as follows:
Name - the name of the discount group
Description - a description that serves to clarify the name
Active - uncheck this box to deactivate the discount group

Discounts Tab - used to add and delete the discount types in the group. Its fields are:
Discount - enter the name of the Discount or use the binoculars to display a list to select from
From and To Dates - these define the inclusive dates between which the discount applies. The From date is mandatory, the To date can be left unspecified and in this case means 'forever'.

Note that you cannot add the same discount type more than once, ie the group can only contain one of each discount type.
 

Investigation

This screen allows you to create/view/edit the details for each Investigation Type. These define the Investigations that can be:

• linked to a product via its Investigations tab
• added to the medical record
• automatically ordered via of an HL7 Laboratory

The fields are as follows:

Online Booking Times

Online Booking Times can be used to specify the availability of an appointment Schedule for the purposes of online booking.

This can be used to restrict the days and times that a schedule is available.

The fields are:

Name - the name of the Onbline Booking Time type
Description - optional description
Active - uncheck the box to deactivate the Online Booking Time type

For each day of the week, the Opening Times are set as:

• Open flag indicates if the schedule is open or closed
• Start indicates the time that online bookings can start for that day
• End indicates the end of the last appointment for that day

Patient Alert Type

This screen allows you to create/view/edit the details for Patient Alert Types.

The fields are as follows:

Name - the Alert's name
Description - the Alert's description
Reason - a default reason. This will be copied to the Reason field of the Patient Alert
Priority - can be set to High, Medium or Low. If there are too many alerts for the display space, higher priority ones get preference.
Mandatory Alert - if ticked, Patient Alerts with this alert type will be displayed in a popup window, when a patient is selected that has the alert. Users must acknowledge the alert. Acknowledgement is only required once in a 24 hour period.
Colour - used to set the colour used for the alert. You use the mouse to select the colour via the colour and luminosity/hue boxes.
Duration - used to specify a default duration for alerts. Leave empty if alerts shouldn't have an end date
Interactive - if ticked, a Patient Alert editor will be displayed when products that link to the alert type are invoiced.
Class - an optional classification for the alert. OpenVPMS provides two types by default, Allergy and Aggression. (These are set via Administration|Lookups|Patient Alert Class.) Patient alerts with these classifications will be sent to HL7 interfaces, and Smart Flow Sheet.
Active - uncheck the box to deactivate the alert type

Product

This screen allows you to create/edit/view the details for each Product Type. Each Merchandise, Medication, and Service Product can be given a Product Type. These allow you to:

a) determine how the product appears on the invoice
b) set different taxes by product type
c) set different discounts by product type

The fields are as follows:
Product Type - it's name
Description - you can use this to clarify the type of product
Invoice Sort Order - the lower the number set here, the earlier the item appears on the invoice. See below.
Detail on Invoice - untick this box if you want all the invoice items of the same type combined as one line item on the invoice. See below.
Active - uncheck the box to deactivate the Product Type
Pharmacy - this is only required if you use the HL7 facility where it is used the set a Pharmacy or Pharmacy Group for all products of this Type
Synchronise with Smart Flow Sheet - determines if products of this type will be synchronised with Smart Flow Sheet.

Taxes tab
This is used to display/set the taxes applicable to the Product Type. To adjust, click the tax in the Available or Selected box and then click the > or < button respectively.

Discounts tab
This is used to display/set the discounts applicable to the Product Type. The fields are as follows:
Discount - enter the Discount Type or click the binoculars to select one. Note that you cannot attach Discount Type Groups to a Product Type, only a Discount Type. You can add one or more.
From Date - the date from which the discount will apply
To Date - the date to which the discount will apply - left unspecified this means 'forever'

Invoices and Product Types

If you are using the standard invoice documents (or customised ones based on the standard versions), then invoice format depends on the 'Use Product Types' setting in the Letterhead record. If this is unchecked, then the Product Type is ignored.  If it is checked then:

1. the line items are grouped by patient, date, then by Invoice Sort Order, then by product name.
2. if Detail On Invoice is not checked for a given Product Type, then the product line items with that type are not displayed and only the total for the Product Type is shown. If the total is zero the line will be suppressed.  Hence if you have some 'no charge' products (such a dummy products used only to create a set of reminders) then you can assign them Product Type 'No Charge' and set this without the Detail On Invoice flag set, and if all the No Charge products do in fact have no charge, then the No Charge line will be suppressed.

Reminder

This screen allows you to view/edit the details for each Reminder Type.  For general information on the Reminder system, see Concepts|Reminders. See also Stopper Reminders and Switch Reminders below.

The fields are as follows:
Name - its name
Description - you can use this to clarify the type of reminder
Active - uncheck the box to deactivate the Reminder Type
Group By - you can select None, Patient or Customer.  Use None if you want individual reminders generated; use Patient to group multiple reminders for the one patient on one reminder, and use Customer to group multiple reminders for the customer's patients on one reminder.  See also the Grouped Reminders discussion below.
Interactive - check this box if you want confirmation when this type of reminder is generated as a result of using a product to which the reminder is attached (such as a vaccination). Note that this sets the default setting of the Interactive flag for this reminder. However, each product that uses this reminder can have its own setting of the Interactive flag.  Specifically, this means that if you have existing products using this reminder, then altering the Interactive setting here will have no effect - you will have to go and set the Interactive flag as required for each product that uses this reminder.
Reminder Interval - the period from the time that the reminder is created until it is due
Cancel Interval - the period of time after a reminder is due that it is automatically cancelled. This should be set to be a little more than the reminder count Interval set for the "last" template that you have - ie the one with the highest Count. If you set it less than the last Interval, then the reminder will be cancelled before all the reminders that you planned have been sent.
Sensitivity Interval - the period that determines the colour of the reminder when displayed on the Patient Information & Medical records screens when you click the Reminders bell icon in the left panel. It shows as follows:

If a given reminder has a sensitivity period of two weeks,  then up until two weeks before the reminder is due, it will be shown in green; in the two weeks prior to and after the due date, it will be shown in orange; and after two weeks after the reminder date, it will be shown in red.
Note - an optional note that can be used in reporting, or on reminders, or simply as an extended description.

Counts

The Counts tab determines how reminders are sent. There should be at least one Reminder Count defined. Multiple Reminder Counts can be used so that different reminder notices are generated for the initial reminder and first, second, etc overdue notices.

The fields are as follows:
Count - this is the reminder number, 0 for the initial one, 1 for the second etc.
Interval - the period from the reminder Due Date when the reminder should be sent. The interval can be:

• negative, indicating that the reminder should be sent prior to the Due Date
• zero, indicating that the reminder should be sent on the Due Date
• positive, indicating that the reminder should be sent after the Due Date

Template - required if a Reminder Rule indicates that reminders should be emailed, SMS'ed or printed. Enter the name of template or use the binoculars to search for one. Notes:

1. The template must have its Type (see Templates) set to Patient Letter or Form, and depending on the Rules, will need to have an Email and/or SMS template specified.
2. If the reminder is being sent by SMS, then the template Content is ignored and the specified SMS Template determines the text that is SMS'ed
3. If the reminder is being sent by Email, then the specified Email Template is used to generate the email itself. If 'Email Reminders as Attachments' is checked in the Reminder Configuration settings, then the template Content is used to generate the attachment otherwise the template Content is ignored and not used.

Rules

These determine how individual Reminder Counts are sent.

A Reminder Count may specify multiple rules. These are processed in order, until one is satisfied.

Each rule contains the following options, one or more of which may be selected:

• Contact - use the customer's contacts that have Reminder purpose to determine if the reminder should be printed, emailed or SMS'ed. If multiple contacts have a Reminder purpose, then Send To determines which are used.
• Email - using the customer's preferred Email contact (or first if no preferred), email the reminder to the customer
• SMS - using the customer's preferred Phone contact (or first if no preferred) with Allow SMS enabled, send the reminder via SMS
• Print - using the customer's preferred Location contact (or first location if no preferred), print the reminder for mailing to the customer
• List - list the reminder on the Patient Reminders Report
• Export - export the reminder to a CSV file. See here for the export format.
• Send To - may be one of:
  • First - send to the first matching contact. This is the default.
    E.g. if both Email and SMS is selected, the rule is satisfied if the customer has either contact.
    The precedence is Email > SMS > Print
  • Any - send to any matching contact. If a customer doesn't have a contact, then the rule isn't satisfied.
    E.g. if both Email and SMS is selected, the rule is satisfied if the customer has either contact, and the reminder will be sent to each one
  • All - send to all specified contacts.
    If a customer doesn't have a contact, then the rule isn't satisfied.
    E.g. if both Email and SMS is selected, the rule is only satisfied if the customer has both Email and SMS contacts.
    NOTE: if a customer has multiple contacts of the same type (e.g two email addresses), only one will be selected to receive the reminder

If no rule is satisfied, then the Reminder will be processed as per List.
E.g. A Reminder Type might specify the following:

• Reminder Count = 0
  • Rule 1: Contact, Send To = All
  • Rule 2: Email,SMS, Send To = All
  • Rule 3: Print, Send To = All
• Reminder Count = 1
  • Rule 1: SMS, Print, Send To = Any

In the above, the first reminder will be sent:

• to all contacts with Reminder purpose, if there are any; else
• via SMS, if the customer has a Phone contact with Allow SMS set AND by email if the customer has an Email contact; else
• via Print, if the customer has a Location contact; else
• it will be Listed

The second reminder will be sent:

• via SMS, if the customer has a Phone contact with Allow SMS set and/or via Print, if the customer has a Location contact; else
• it will be Listed

Multiple rules may be selected. If Contact and Print is selected, and both correspond to to the same customer contact, a duplicate is not created.

Species

The Species tab is used to display and edit the species to which this reminder can apply. You don't have to use this facility. It is only needed if you want to ensure that species specific reminders are applied only to the relevant species. To adjust, click the species in the Available or Selected box and then click the > or < button respectively.

Groups

The Groups is used to display and edit the group(s) to which this reminder belongs. To adjust, click the group in the Available or Selected box and then click the > or < button respectively.
This facility is optional. It is only needed if you want to group reminders so that generating reminder B will complete an existing reminder A (for example for "Stopper" and "Switch" reminders - see below). Use Administration|Lookups|Reminder Groups to create a group named say G, and the use the Groups Tab to make both reminders A and B members of group G.

"Stopper" Reminders
You may want to create a special reminder whose purpose is simply to complete other reminders. Consider the following:

Senario - have a new puppy and so manually create Desex reminder for 4 months forward. When we do the actual Desex operation we want this reminder to disappear, but with no creation of any future reminder.

Solution:

• create a reminder group called say Desexing-Complete-G
• create the Desex reminder as normal, but with group Desexing-Complete-G
• create Desex-Complete reminder with a zero Interval and zero Cancel Interval, and also set the group Desexing-Complete-G
• for all desex products, set the reminder type as 'Desex-Complete'

Now when we invoice the Desex operation, a new Desex-Complete reminder will be created. This will complete the original Desex reminder.

"Switch" Reminders
A variant of the above case is where have a product whose sale needs to generate its own reminder but stop another reminder. Consider the following:

Senario - you want to offer vaccine antibody testing. That is, instead of having the client's dog vaccinated, you offer the option of having a blood test so that you can see if the dog already has enough antibodies (and therefore doesn't need to be revaccinated).

So, if a dog has one of these blood tests, then they no longer need to have a vaccination - so it should cancel out the reminder associated with the G6 vaccination. And it should create a new reminder to redo the blood test within a year.

Solution:

• Create a reminder group called say G6 Vaccination Complete-G
• It is assumed that you already have a G6 Vaccination reminder type - edit this and set its Group to 'G6 Vaccination Complete-G'
• Create 2 new reminders types
  • G6 Vaccination-Complete with a zero Interval and zero Cancel Interval and set its Group to 'G6 Vaccination Complete-G'
  • Canine Vaccination Antibody Blood Test with the required intervals
• Create the product: Vaccine Coverage Antibody Titre Test Canine (Clotted Blood/Serum) and add the two reminders 'Canine Vaccination Antibody Blood Test' and 'G6 Vaccination-Complete'

Now when we invoice the Antibody test, it will complete any G6 reminders, but also create a new Antibody test reminder.

You will probably want to also create a cat/feline/F3 of the above.

Grouped Reminders processing
The Group By option indicates when reminders queued for Email, SMS or Print can be grouped. It does not apply to reminders that are queued for Export or List.

If a patient has:

• multiple reminders to be sent using the same method (e.g. there is multiple reminders to be emailed); and
• those reminders have types that have Group By set to Patient

then these will use the Reminder Configuration's Patient Grouped Reminder Template, irrespective of the Template specified for the applicable reminder count.

Similarly, if a customer has:

• multiple reminders to be sent using the same method (e.g. there is multiple reminders to be printed); and
• those reminders have types that have Group By set to Customer

then these will use the Reminder Configuration's Customer Grouped Reminder Template.

Consider the following, and assume that reminders will be printed in all 4 cases:

If both the G6 and Proheart reminder types have their Group By set to Customer, then one document will generated for Sir Humphry. It will be generated using the Customer Grouped Reminders Template, and it will list the 4 reminders shown.

If both the G6 and Proheart reminder types have their Group By set to Patient, then two documents will be generated, one for Dotty, and one for Twiglet. They will be generated using the Patient Grouped Reminder Template.

If only the G6 reminder type has the Group By set to Customer, then 3 documents will be printed:

• one Grouped Reminder for the G6 vaccinations showing both Dotty and Twiglet
• two Proheart reminders, one for Dotty and one for Twiglet, generated using the Document template specified for the reminder count. 

If Twiglet did not have a G6 vaccination due, then there would still be 3 documents, with the Grouped Reminder being replaced by a G6 vaccination reminder letter for Dotty.

That is, if the Group By is selected, then the appropriate Grouped Reminder Document Template will be used - but ONLY IF there are multiple reminders.  If the customer only has one reminder (and thus there is no need to group them) then the Document Template used is that specified in the Reminder Type's Templates tab for the applicable reminder count.

A sample Grouped Reminders document template is included in the standard system.  It will need tailoring for your practice.

Any Email Template linked to Grouped Reminders template follows the same format.

If the Reminder Configuration has Email Reminders as Attachments selected, the Grouped Reminder Template will be used to generate a summary of the reminders and include them as an attachment.

Reminder Configuration

This screen is used to create/edit/view the Reminder Configuration - which determines how patient reminders will be processed.

Only one Reminder Configuration record is required and it must be linked to the Practice, for it to take effect.

The fields are as follows:

Notes:

1. The templates specified for both Grouped Reminder Templates must have Type 'Grouped Reminders'. Also, since only one Reminder Configuration is used, the same templates are used for every Practice Location. This means that if you need to have location specific information in the reminder, then this must be catered for in the template. In the standard templates, this is done using the Letterhead facility.
   In the screen above the same template has been specified both the Customer and Patient Grouped Reminders. This is not an error - the standard 'Grouped Reminders' template has be designed to handle both a single patient with multiple reminders (ie group by patient) and multiple patients with one or more reminders each (ie group by customer).
    
2. If you change a Lead Time then the new lead time will only be used for reminders that are added to the queue by the Patient Reminder Job. Reminders that are already in the queue will not be affected.  If you do need them to be affected, then you need to delete the reminders individually from the queue using Patients|Medical Records|Reminders and then they will be re-queued (using the updated Lead Times) the next time the Patient Reminders Job runs.

Smart Flow Sheet Configuration

The Smart Flow Sheet Configuration provides practice-wide options for the Smart Flow Sheet interface.
It must be linked to the Practice to have any effect.

The fields are as follows:

Task

This screen allows you to view/edit the details for each Task Type. This and Organisation|Work List determine what appointment types can be made.

The fields are as follows:

Task Type - its name
Description - you can use this to clarify the type of task
Colour - used to set the colour used to identify task types in the worklist screen. You use the mouse to select the colour via the colour and luminosity/hue boxes. If you want to check the colours of the different task types, the easiest way to do this is to view the task type and then to use the Next and Previous buttons to run back and forth through the different types.
Note that you should avoid the 'light cream' colour f2f3b3 which displays as follows:
because this is used to highlight the selected item on the Workflow|Work Lists screen.
Active - uncheck the box to deactivate the Task Type

Confirm Delete

When you press the Delete button on the Administration|Types screen, a confirmation window will appear.

If the selected Type is not in use and can be deleted, the window will simply ask you to confirm the delete. Press OK to confirm or Cancel to abort.

If it cannot be deleted because it is in use, the text will be "xxxx has relationships and cannot be deleted. Do you want to deactivate it instead?" (where xxx is the name of the item you are trying to delete). Pressing OK will unset its Active flag, Cancel will abort.

If it is in use but can be deleted, the text will be "xxxx has relationships. Are you sure want to delete? This operation cannot be undone." (where xxx is the name of the item you are trying to delete). Pressing OK will delete the item as well as all references to it, Cancel will abort.

Confirm New

This is the New Type confirmation window. Select the Type to be created and then use OK to continue or Cancel to abort. Note that if you have selected one on the Type screen, then this will already be selected in this window (even if it is not showing in the list of types) - thus you can normally simply click OK to proceed.

Appointment Reminder SMS Templates

These are used to generate SMS text for appointment reminders - both those sent out by the system by the Appointment Reminder Sender, or when the Reminder button on the Workflow|Scheduling screen is used to send an ad-hoc reminder.

When sending SMS Appointment Reminders for appointments in a given schedule, the template used is determined by looking at the location set for that schedule (via Administration|Organisation|Schedule) and then using the SMS Appointment Reminder template set for that location (via Administration|Organisation|Practice Location).

This is the template selection screen for Appointment Reminder SMS Templates.

concat("Reminder: ",
        expr:if(expr:var("patient.name") != "", concat(expr:var("patient.name"), " has"), "you have"),
        " an appointment at " , $location.name," on ", date:formatDate($appointment.startTime, "short"),
        " @ ", date:formatTime($appointment.startTime, "short"), $nl,
        'Call us on ', party:getTelephone($location), ' for any queries')

expr:if($appointment.appointmentType.entity.name = 'Admit - Surgery',

concat("Reminder: East Island Vets Surgery Appointment", $nl,
        expr:var("patient.name")," ",
        date:formatDate($appointment.startTime, "short"),
        " @ ", date:formatTime($appointment.startTime, "short"), $nl,
        "Remember: water is OK but no food after 9pm ",date:formatDate(date:add($appointment.startTime,"-1d"), "short"),$nl,
        'If queries phone ', party:getTelephone($location)),

concat("Reminder: East Island Vets Appointment", $nl,
        expr:if(expr:var("patient.name") != "",expr:var("patient.name"), "is on")," ",
        date:formatDate($appointment.startTime, "short"),
        " @ ", date:formatTime($appointment.startTime, "short"), $nl,
        'If queries phone ', party:getTelephone($location))

)

        expr:if((date:formatDate($appointment.startTime) = date:formatDate(date:now())),"today",
        expr:if((date:formatDate($appointment.startTime) = date:formatDate(date:add(date:now(),"1d"))),"tomorrow",
        date:format($appointment.startTime, "dd MMM")))

Email Templates

Email Templates and System Email Templates are used to fill the subject and content of emails.

These can be used when:

• writing emails
• sending documents such as invoices or referral letters, via email. Here, the email template is linked to the relevant Document Template and it is normal to set these as System Email Templates so that they are not available to users on the email write screen

That is, System Email Templates are provided to differentiate between templates used for emailing standard documents (e.g. invoices), and the templates available in the Write Email Templates window.
Both Email Templates and System Email Templates may be used for the former, but only Email Templates may be used for the latter.

Templates can contain:

• plain text
• macros
• expressions
• documents

The following is a simple template for use when emailing a handout pdf that is not held in the OpenVPMS database - ie you use this template and then manually attached the Kidney function pdf to the email.

The following is a cover note used when emailing an invoice: (this template would be set as the 'Email Template' on the Invoice document template)

The following is used to generate a sexy looking footer block on emails:

See here for an explanation of the fields.

Documents

When the Content Type is Document the following document types are supported:

• JasperReport (.jrxml), OpenOffice (.odt), Microsoft Word (.doc)
  • The object returned by the Content Source expression will be supplied to the document to support merging.
  • When selected by the email Template option, any parameters will be prompted for.

If the Content Source expression doesn't return a valid object, the document will be converted to HTML without merging.

• Rich Text Format (.rtf)
  No merging is supported.
• HTML (.html)
  No merging is supported.

Images

Images are supported, with the following caveats:

• Images must be URLs, rather than embedded in documents.
  Popular email clients (e.g. GMail and Outlook) don't support embedded images.
• OpenOffice should be used to merge OpenOffice/Word documents. 
  LibreOffice has a bug where all images are embedded in the HTML, and are therefore not displayable in all email clients.
• Images may not be displayed automatically by email clients.
  According to this link referring to a study done in 2009, "only 48% of email recipients see images automatically".

See also How To: Email Template Tips - Open Office and How To: Email Template Tips - Jaspersoft Studio

Examples

The following shows the email generated by the invoice cover note template:

The following shows the footer generated by the third template:

$customer

$patient

Letterhead & Document Control

The Letterhead & Document Control facility provides a mechanism to customise various documents (such as invoices, credit notes, etc) for your practice without having to edit the jrxml files.

The versions of these documents provided in the standard release package use a common letterhead subreport (Letterhead.jrxml) to generate the letterhead portion of each document. The following documents use this letterhead facility:

• all customer documents (ie counter sale, credit, credit and debit adjustments, estimate, invoice, receipt and refund)
• all supplier documents (ie credit, delivery, invoice, order, refurnd,remittance and return)
• patient medical records and problems
• debtors statements
• patient reminders (grouped and non-grouped)
• customer orders (pharmacy orders and returns)

The Administration|Templates screen enables you create a new Letterhead and to select one to delete, edit or view.

You can specify the letterhead to be used for each practice location, and you can specify that multiple locations use the same letterhead.

The Letterhead record is used to define not only the items that go on the letterhead itself, but also items used to customise the various documents. For example on the debtors statement you can specify the various payment options that your practice supports.

Note that you do NOT have to create any letterhead records.  However, if you do not, you will not be able to have a logo on your letterhead (unless you customise the supplied Letterhead.jrxml or use customised invoices, etc). You also will not be able to customise the text on statements and other documents.

The letterhead facility is designed to provide good looking documents using plain paper. However, if you do wish to use your own pre-printed letterhead stationary, this is allowed for and, if your printer supports it, you can also use pre-printed stationary for the first page and plain paper for subsequent pages.

The design does assume that your letterhead stationary has the letterhead at the top of the page and that the rest of the page can be printed on - ie you have nothing pre-printed at the bottom of the page. If this is not the case then you will have to use customised versions of the various content files and you will need to use Jaspersoft Studio to clone your versions from the standard Invoice.jrxml etc content files. However, you should be able to get away with just increasing the bottom margin to avoid the pre-printed area at the bottom of the page.

The layout of the document is designed to place the customer (or supplier) address so that it is correctly positioned for use with window envelopes as follows:

• A4 - use standard DL window envelopes. Make the first fold 10.5 cm from the top of the paper.
• A5 - not supported
• Letter - use #10 window envelopes. Note that the window position in #10 envelopes is not standardised, but the positioning should suit those available from the large office supply companies. Make the first fold 4 inches from the top of the paper.

If the address block is not correctly positioned for the window envelopes that you use, then you can adjust the Letterhead AddressBlock template (which uses content 'Letterhead AddressBlock.jrxml'). See below.

If you want to use a customised letterhead then you should clone it from the standard Letterhead.jrxml using Jaspersoft Studio. You should only need to do this when:

• you simply do not like the existing design
• you have multiple practice locations that each have pre-printed letterhead stationary but with different designs
• your letterhead design is such that the pre-printed information occupies more space than the OpenVPMS templates allow for - which is as follows: A4-52.2mm, A5-37.0mm, Letter-1.93ins.

Note that if you are using an A5 template, then the A5 version of your customised letterhead (called say MyPracticeLH) is expected to be in MyPracticeLH-A5.jrxml.

You will also have to provide a customised address block (because a customised letterhead almost always required a customise address block to correctly position the address in the envelope window). This can be cloned from the standard 'Letterhead AddressBlock.jrxml' and if your letterhead is MyPracticeLH, then the address block is expected to be in 'MyPracticeLH AddressBlock.jrxml'.

Resource Bundles

The many of the templates make use of a facility called 'resource bundles'. These are a set of files named report.properties_xxx located in <TOMCAT-HOME>/webapps/openvpms/WEB-INF/classes/localisation. The following ones are supplied with the system:

As well as setting the name of the local tax, the report.properties files set the names of a number of other documents. For example if you want your printed Patient Medical History titled that rather than 'Patient Medical Records' then you need to edit the line:

text.medicalRecordsTitle=Patient Medical Records

If you do edit the file, the changes will not take effect until your restart Tomcat.

Editing the Address Block position

First use Administration|Templates|View to view the Letterhead AddressBlock document template. Then download the content by clicking on the Content button.

Now use Jaspersoft Studio to edit the downloaded Letterhead AddressBlock.jrxml file. Using Studio, simply move the frame containing the address elements as required.

If you feel intimidated by Studio, you can use a good text editor (like NotePad++) to simply edit the file.  Find line 43 (which contains the co-ordinates of the frame) and modify these as required. The units are in pixels and 10 pixels = 0.1389 inches or 3.5278 mm.

In both cases save the modified jrxml file and use Administration|Templates|Edit to edit the Letterhead AddressBlock document template and use the Upload button to upload the modified file.

Patient Reminder SMS Template

This is the create/edit/view screen for SMS patient reminder templates.

These are used to generate SMS text for patient reminders. The template can be plain text, macros, or an XPath expression.

The screen is in two parts - the top contains the fields, the bottom allows the template to be tested.

The fields are as follows:

The bottom part of the screen contains:

Note that for testing purposes, a customer, patient and reminder type must be selected.

Example XPath expressions

For single patient reminders:

concat($patient.name, ' is due for a vaccination at ',$location.name,'.', $nl, 
     'Please contact us on ',party:getTelephone($location),' to make an appointment')

The XPath expression above will generate an SMS message like:
     Fido is due for a vaccination at Main Clinic.
     Please contact us on 041312345 to make an appointment

For reminders grouped by patient:

concat($patient.name,' is due for a ',list:sortNamesOf(.,'reminderType',',',' & '),$nl, 
'Please contact us on ', party:getTelephone($location), ' to make an appointment')

To produce text like:
     Fido is due for a Grooming, Health check & Vaccination.
     Please contact us on 12345678 to make an appointment.

For reminders grouped by customer:

concat(list:sortNames(list:set('patient'),',',' and ',' is',' are'), 
    ' due for a visit to ',$location.name,'.',$nl,
    'Call ',party:getTelephone($location),' to make a booking')

To produce text like:
     Fido and Muffett are due for a visit to VetsRUs.
     Call 041312345 to make a booking.

For a single patient, it will produce text like:
     Fido is due for a visit to VetsRUs.
     Call 041312345 to make a booking.

You can include reminder types, although its not possible to indicate which reminders apply to which patients.

concat(list:sortNames(list:set('patient'),',',' & ',' is',' are'),
     ' due for a ',list:sortNames(list:set('reminderType'),', ',' & '),$nl,
     'Call ',party:getTelephone($location),' to make a booking')

Document Templates

Every form and report has a document template. The template specifies things like usage, paper format, associated printers, its content, and when it is printed.  See also Concepts|Printing for background information, and Create/View/Edit for the template details.

As shown below, the system comes with a number of standard templates. These have to be loaded using the templateload utility (see the readme.txt file in the release package for instructions). Template sets are provided for A4, A5 and Letter. You can use these but you will probably want to modify some of them. You may also want to use a report from the Resource Library set.  See below for a quick summary of how to do this.

Template Usage: One can divide the templates into three groups:
Reports - you use the Reporting|Reports screen to select the report to run
Selectable forms - (eg Patient Forms) you will be presented with a list to select from
System forms - (eg Invoices) where the system chooses the template.

For the first two you can obviously set up as many as you need - you just choose the one you want. In the last case (eg Invoices) you need to be careful because if you create three different invoice templates, the system will just use the first it finds. This is not normally a problem - after all you only need one type of invoice form. However, if you do want to use different templates for each Practice Location, then you can do this by defining the templates to be used by the location. See Administration|Organisation|Practice Location.

If you do need to create or modify reports and forms, see Reference|Reports and Forms. Note that if you want to modify an existing report or form, then if you View the template, you can then click on the Content field to download the report/form ready for editing.

Installing a new template
To install a new templatefrom the Resource Library, do as follows:

1. download the jrxml (or odt) file by right-clicking on the attachment link and using 'Save Link As' (or 'Save Target As' etc depending on your browser) - remember where you saved it
2. click the New button
3. on the resulting New Document Template screen set the Type to Report, then click the Upload button. If it's not a report, then you need to set the appropriate Type.
4. on the resulting window, click Browse and navigate to where you downloaded the file and select it. Click the Send button.
5. back at the Edit Document Template screen, click the OK button

Changing a standard report paper size
The system comes with a set of reports and documents in the <OPENVPMS-HOME>/reports directory. This is structured as follows:

You can see that there are 8 directories with most having multiple sub-directories, one per function, and each of these has a sub-directory for each paper size each containing the templates for that paper size. Note that not all paper sizes are provided. In particular, the Reports are provided only in A4 and Letter and not in A5. So if you initially loaded the A4 set, and want to change your invoices to the A5 equivalents, then you need to load the templates in Customer/Invoice/A5. Do this by editing each template, and then pressing the Upload button to load the appropriate content. For the invoices you will see that the directory contains the files Invoice.jrxml, Invoice Items.jrxml, Invoice Appointments.jrxml, Invoice Notes.jrxml and Invoice Reminders.jrxml. Hence you need to edit the Invoice, Invoice Items, Appointments, Notes and Reminders templates, and in each case upload the relevant file from the Customer/Invoice/A5 directory. Note that these A5 versions use the A5 versions of the Letterhead and Addressbock templates, but these should be present as they are loaded as part of the A4 template set in case you ever want to use some A5 versions.

Delete Template

When you press the Delete button on the Administration|Templates screen, a confirmation window will appear.

If the selected Template is not in use and can be deleted, the window will simply ask you to confirm the delete. Press OK to confirm or Cancel to abort.

If it cannot be deleted because it is in use, the text will be "xxxx has relationships and cannot be deleted. Do you want to deactivate it instead?"(where xxx is the name of the item you are trying to delete). Pressing OK will unset its Active flag, Cancel will abort.

Select

This is the screen used to select a Document Template, SMS Appointmnent Reminder Template or Letterhead. It works like a standard select screen.

It will be presented whenever you need to choose a template, for example when assigning document, templates to a Practice or Practice Location, or (more commonly) when selecting a document at check-in time. In the latter case only the relevant templates will be displayed.

The following is the screen for selecting a Document Template.

Address Format

This screen is used to create/view/edit the Address Format lookups. These are used to how addresses are formatted. Normally only one is needed and it is used to set the values in the 'Address Format' field on the Administration|Organisations|Practice screen.

The fields are as follows:

Name - the name of the format
Active - uncheck the box to deactivate the format
Single Line Format - the xpath expression used to generate the address when a single line address is needed
Multi Line Format - the xpath expression used to generate the address when a multiple line address is needed

The expressions should be a concat() of the required items. The following variables are available:

• $address - e.g "36 Nonesuch St". For single-line addresses, any '\n' will be removed
• $suburb - e.g. "Sawtell"
• $postcode - e.g. "3095"
• $state - e.g. "Victoria"
• $state.code - e.g. "VIC"

Any missing data (for example if the postcode has been omitted) is supplied as an empty string ("").

These could be used as follows:

• Single Line Format: concat($address, ', ', $suburb, ' ', $state, ' ', $postcode)
• Multi-line Format: concat($address, '\n', $suburb, ' ', $state, ' ', $postcode)

Note that the $xxx variables are shortcuts for the expression openvpms:get(.,'xxx','').

This allows for:

• single line:
  concat(expr:concatIf($address, ', '),
               expr:concatIf(toUpperCase($suburb), ' '),
               expr:concatIf($state.code, ' '),
               $postcode)
   

          E.g. 123 Gilrown Avenue, DOREEN VIC 3754

• multi-line:
  concat(expr:concatIf($address, $nl),
               expr:concatIf(toUpperCase($suburb), ' '),
               expr:concatIf($state.code, ' '),
               $postcode)

           E.g. 123 Gilrown Avenue
                   DOREEN VIC 3754
 

In countries where the state/county/area are normally omitted (eg the UK, South Africa), the state part of the above two expressions can simply omitted.

Note that the above expressions still work for the cases where, for a customer or supplier with an overseas address, you are holding the complete multi-line address in the Address field and have not set the suburb, state or postcode. (However, the single line format may be quite long.)

Bank

This screen is used to create/view/edit the Bank lookups. Note that these hold just the Bank names, details of the account such as Branch and Account Number are held elsewhere.

The fields are as follows:

Name - the name of the bank
default - check the box to make this the default bank
Active - uncheck the box to deactivate the bank

Breed

This screen is used to create/view/edit the details of the Breed lookups.

The fields are as follows:

Name - the name of the breed
Species - the species
Default - check the box to make this the default breed
Active - uncheck the box to deactivate the breed

Colour

This screen is used to create/view/edit the details of the Colour lookups. Note that currently these are not used by the system. That is, when you enter the patient details, you can set the patient's colour to anything - unlike Species and Breed, it's value does not have to be chosen from a list. If you really have a need to limit the colours that can be set, then your integrator can adjust the relevant archetype so that the Colour lookup is used to limit the colours that can be set.

Contact Purpose

This screen is used to create/view/edit the details of the Contact Purpose lookups.

The fields are as follows:

Name - the Contact Purpose
Active - uncheck the box to deactivate the Contact Purpose

The system comes with a basic set (Billing, Correspondence, Home, Mobile, Postal, Reminder and Work) which will normally suffice. However, you might want to add 'Spouse' or 'Partner' or 'Maid'.

These contact purposes are independent of the Contact Type (ie Location, Phone, Email and Fax).

The system does make use of the Contact Purpose in some situations.

• When generating Reminders it uses the Reminder contacts
• When generating Statements it uses the Billing contacts
• The various JXPath extension functions like party:getCorrespondenceAddress and party:getBillingAddress use the relevant contact purpose.  [But note that ther is no getPostalAddress function.]
• In all cases the selection logic is to look for the preferred contact of the relevant purpose, if none, then use the first found for the purpose, if none then use the first preferred contact of any purpose.
• Note however, that the system does NOT look at the Contact Purpose when providing lists of email addresses. For example, if you are emailing a customer invoice, the system will not look for a Billing Contact Purpose. Rather the list of available email addresses is determined by the current workspace as follows:

In the customer and patient workspaces, the To dropdown will include:
- the customer's email addresses
- the referral email addresses
- any practice email addresses associated with the referrals

In the supplier workspaces, the To dropdown will include:
- the supplier's email addresses

In all other workspaces, the To dropdown will be empty.

Country

This screen is used to create/view/edit the details of the Country lookups. Note that you need at least one of these - for the country that you operate in. You may need others if you have customers or suppliers located in other countries.

The fields are as follows:

Code - the code for the country. It is conventional to use the standard country codes (eg see http://en.wikipedia.org/wiki/ISO_3166-1), but you can in fact use any upper case letter string (eg AUST, or AUSTRALIA in place of the standard AU). Note that once you have created the Country Lookup, you cannot change the Code - you have to create a new one, and then use the Replace mechanism.
Country - the name of the country
Default - check the box to make this the default country
Active - uncheck the box to deactivate the country
 

States tab - this is used to display and set the States that are part of the country - use Lookup|State to create these

Credit Card

This screen is used to create/view/edit the details of each type of Credit Card. Not all of the fields are currently used by the system.

The fields are as follows:

Name - the name of the Credit Card
Floor Limit - not currently used by the system. Reserved for future use to set the minimum payment amount for which this credit card can be used.
Authorisation - not currently used by the system. Reserved for future use to so you can enter a note about the authorisation procedure required for this card.
Separate Deposit List - not currently used by the system. Reserved for future use to control whether, when processing the Bank Deposits, the system is to generate a separate report for amounts paid by this card.
default - check the box to make this the default credit card
Active - uncheck the box to deactivate the credit card

Currency

This screen is used to create/view/edit the details of the Currency lookups. Note that this is used in only one place, to set the currency used by the practice. The system runs in single currency mode and there is no support for foreign currency transactions.

The fields are as follows:

ISO code - the code for the currency. When creating the Currency, the pull-down list allows you to select from the standard set (eg see http://en.wikipedia.org/wiki/ISO_4217). Note that once you have created the Currency Lookup, you cannot change the Code - you have to create a new one, and then use the Replace mechanism.
Currency - the name of the currency
Default - check the box to make this the default currency
Rounding Mode - this determines how amounts are rounded. It can be set to Half Down, Half Up or Half Even. See below for more.
Minimum Cash Denomination - the value of the smallest coin in this currency
Minimum Price - the minimum price to round to. This can be used to round prices to the nearest 5 cents or dollar for example. If unset or zero, all prices will be rounded to the default number of decimal places for the currency. (This is specified for each currency code - see the 3^rd column (E) in the list of codes at https://en.wikipedia.org/wiki/ISO_4217#Active_codes which is 2 for most but 0 for some such as the Chilean Peso).
Active - uncheck the box to deactivate the currency

OpenVPMS assumes that all currencies are decimal and displays amounts to two decimal places, ie it assumes a dollars and cents structure. When doing calculations (say for a 20% discount on an amount of $23.57) then commonly the calculation will not yield an exact number of cents (in this case the discount amount is 23.57/5=4.714). The Rounding Mode determines how the fractional cents are rounded as follows:

Custom Payment Type

This screen is used to create/view/edit the details of the Custom Payment Type lookups. When you make a payment, there is a pull-down list of payment types (Credit Card, EFT, Cash, Cheque, Other, and Discount). If you select Other, then the available Payment Types are the Custom Payment Types.

The fields are as follows:

Name - the Custom Payment Type
default - check the box to make this the default custom payment type
Active - uncheck the box to deactivate the custom payment type

Customer Account Type

This screen is used to create/view/edit the details of the Customer Account Type lookups. You don't have to use Customer Account types, but doing so enables better financial management of debtors and provides a method of quickly identifying important groups of customers by using an alert.

The fields are as follows:

Name - the name of the Account Type
Credit Limit - not currently used by the system
Payment Terms and Payment Terms Units - define the period within which payment is expected and define how the Overdue Balance is calculated - see below. The units can be days, weeks or months.
Account Fee Type - can be set to None, Fixed, or Percentage. If not None, then when the End Period processing is done using Reporting|Debtors and statements are being generated, a check will be made to see if an overdue fee is applicable.
Fee Amount - this is either the fee amount (if the Fee Type is set to Fixed) or the percentage of the overdue balance (if the Fee Type is set to Percentage)
Minimum Fee - no fee is charged if the fee amount is less than this amount
Minimum Balance - no fee is charged if the overdue balance is less than this amount
Overdue Days - this defines how long a payment can be outstanding before it is considered to be overdue and thus liable for an Account Fee
Fee Message - if an Account Fee is charged, the Notes text of the generated Debit Adjustment transaction is set to this text, or if none has been entered, to "Account Fee". Note that because of a current bug, the text entered is ignored and the Notes text is always "Account Fee".
General Message, Overdue Message - these are displayed at the end of the statement. If payment is overdue, the Overdue message is printed, else the General message. Leave blank if you don't want a message to be displayed.
Active - uncheck the box to deactivate the the Account Type
Default Lookup - check the box to make this the default Customer Account Type - ie that set when a new customer is created.
Alert tab - here you can see an alert to be displayed in the left panel where the current customer has this Account Type.

Calculation Logic

To determine the current overdue balance:

1. the payment terms (e.g 30 days) are subtracted from the current date
2. any unpaid amounts dated prior to this new date are summed to get the overdue balance

The account fee is determined during statement generation.

A non-zero account fee will be returned if:

• the customer has an account type;
• there is a non-zero overdue balance for the account fee date (derived from the statement date - Overdue Days);
• the overdue balance is >=Minimum Balance; and
• the account fee is greater than Minimum Fee

The account fee is calculated as:

• overdue balance * Fee Amount/100 if the Account Fee Type is PERCENTAGE; or
• Fee Amount if the Account Fee Type is FIXED

Customer Alert Type

This screen allows you to create/view/edit the Customer Alert Type lookups.

The fields are as follows:

Name - the Alert's name
Priority - can be set to High, Medium or Low. If there are too many alerts for the display space, higher priority ones get preference.
Mandatory Alert - if ticked, Customer Alerts with this alert type will be displayed in a popup window, when a customer is selected that has the alert. Users must acknowledge the alert. Acknowledgement is only required once in a 24 hour period.
Colour - used to set the colour used for the alert. You use the mouse to select the colour via the colour and luminosity/hue boxes.
Default - check this box to make this alert the default type
Active - uncheck the box to deactivate the alert type

Customer Communication Reason

This screen is used to create/view/edit the Customer Communication Reason lookups.

The fields are as follows:

Customer Insurance

This screen is used to create/view/edit the Customer Insurance lookups (used in the Insurance Plan field on the customer information screen).

The fields are as follows:

Name - the name of the Insurance Plan
default - check the box to make this the default Insurance Plan
Active - uncheck the box to deactivate the Insurance Plan

Customer Referral

This screen is used to create/view/edit the Customer Referral lookups. These are used to set the 'Referred By' values on the customer information screen.

The fields are as follows:

Name - the 'referred by' value
default - check the box to make this the default
Active - uncheck the box to deactivate the referral

Customer Type

This screen is used to create/view/edit the Customer Type lookups. These are used to set the Categories available on the customer information screen.

The fields are as follows:

Name - the customer type
Active - uncheck the box to deactivate the type

Customer Vet

This screen is used to create/view/edit the Customer Vet lookups. These are used to set the 'Preferred Vet' values on the customer information screen. Note that there is no relationship between the names set here and the actual names of the vets in the practice - ie in the example below, no check is made to see that there is a Dr Bloggs on staff. This implies that you could have 'Not Dr Bloggs' as an entry.

The fields are as follows:

Name - the 'preferred vet' value
default - check the box to make this the default
Active - uncheck the box to deactivate this entry

Demographic Update

This screen is used to create/view/edit the Demographic Update lookups. These are used to set what is available under the Update tab on the product information screen. An update is used to change something in the patient record as a result of the use of the product - eg to set the desexed status after a spaying operation.

The fields are as follows:

Name - the name of the update
Expression - the jxpath expression that does the update
Node Name - the name of the node to be used
Active - uncheck the box to deactivate this entry

The following table gives examples including the above:

Diagnosis (VeNom)

Use this screen to view VeNom (Veterinary Nomenclature) Diagnosis codes.

These are used by patient Problems.

These cannot be edited as they are specified by the VeNom standard.

To add a diagnosis, create a Diagnosis instead.

Diagnosis

This screen allows you to create/view/edit a Diagnosis.

These are used by patient Problems.

In general, you should only need to create a Diagnosis if there is no equivalent Diagnosis (VeNom).

Duration Formats

This screen is used to create/view/edit the Duration Formats lookups. These are used to set how a patient's age is presented and allows the format to vary as a function of age. Normally only one is needed and it is used to set the values in the 'Patient Age Format' field on the Administration|Organisations|Practice screen.

The fields are as follows:

Name - the name of the format
Active - uncheck the box to deactivate the format
Formats tab - its fields are as follows:
Interval - sets the (inclusive) age (in units of Units) below which this format is to be used (ie less than or equal to 3 years in the above example)
Units - can be years, months, days or weeks
Show Years/Months/Weeks/Days - check the boxes to display the years/months/weeks/days

Note that when adding formats, these can be added in any order. The last entry (999 years) provides the setting for the more than 3 years case.  If no 'Patient Age Format' is set for the Practice, then the formats used are as follows:

If the age is greater than that set for the largest defined interval, then the above table is used to define the format.

Note that no rounding is done. That is, with the default settings, a patient aged 1 year, 11 months will be shown as '1 Year' rather that '2 Years'.

File Name Format

This screen allows you to create/view/edit a File Name Format.

These are used to format the names of documents generated from a Document Template.

The fields are as follows:

• Name - the format name
• Description - a description of the format
• Expression - the xpath expression to format file names

The expression is provided with:

• a $file variable. This represents the name of the template
• the object that the template is being applied to e.g. act.customerAccountChargesInvoice, act.customerAccountPayment, act.patientDocumentLetter, act.customerDocumentForm, act.supplierDocumentAttachment
• a $patient variable, if a patient is linked to the act
• a $customer variable, if a customer is linked to the act, or the owner of the patient, if a there is only a patient present
• a $supplier variable, if a supplier is linked to the act

To ensure that generated file names are valid, any illegal characters such as \, /, :, *, ?, <, >, and | are replaced with underscores.

Note that in some cases it is useful/necessary to have different templates for different practice locations. These will have different names (such as Estimate CC and Estimate EIAH), and it may not be desirable for the file name to include the location signature - ie you just want 'Estimate' rather than 'Estimate CC' or 'Estimate EIAH'.

One way to achieve this is to adopt the convention that the template name be formatted as <part1>[!<part2>] - ie something optionally followed by an ! character and more text - eg like one of the following

1. Estimate!CC
2. Estimate!EIAH
3. Estimate

then we can extract the <part1> bit (ie 'Estimate') using the expression:

concat (substring($file,1,number(not(contains($file,'!')))*string-length($file)),
       substring-before($file,'!'), .....)

This works because if there is no ! present (ie case 3 above) then the first argument will be $file (ie 'Estimate'), and the second argument will be an empty string.

In cases 1 & 2 (where there is an ! present) then the first argument will be an empty string and the second the characters up to the !, ie 'Estimate'.

So - for the 'Document name - patient full name - document date' the, the full expression for the File Name format expression is:

concat(substring($file,1,number(not(contains($file,'!')))*string-length($file)),
       substring-before($file,'!'), ' - ', $patient.name, ' ', $customer.lastName, ' - ', date:format(openvpms:get(.,'startTime'), 'd MMM yyyy'))

Macro

This screen is used to create/view/edit the Macro lookups. These are used to enable the accelerated entry of text in any text field. If you are having problems, see here.

The fields are as follows:

Code - the text that will be replaced. The code must start with a letter or @, and the other characters can be letters or numbers or _. Hence abc, A4b, a_B, a_4, @aBc, and @abc are all valid. Note however that although the case is preserved (ie you can define a macro aBBa), you then cannot have another macro abba. Also if you do create a macro with a mixed case name, eg @aBc then you must invoke it as @aBc - @abc will not find it. It is thus probably best to always use lower case letters. Also take care not to use an actual word as it will expand into text inappropriately, for example bid can transform into twice daily when you may just mean bid. Perhaps end the code in "x" to avoid this mishap. Alternatively you can use @ as a prefix.
Name - the name of the macro. Normally this reflects the text that will be generated.
Description - an optional description. It is sensible to use this to provide a hint to the user as to how the macro is invoked - because the description will be displayed as part of the Macro Select window when the user types Alt-M. A useful convention is as follows:

Active - uncheck the box to deactivate the macro
Expression - the replacement text or an expression (see below). For replacement text you have a 4,999 character limit and can format with leading spaces and paragraphs. The text should be enclosed in double quotes. You can also enclose with single quotes, but then if you use the single quote character as an apostrophe in the text, the macro will fail. For example, if you want to have text such as today's temperature, the single quote in today's will cause the macro to fail if the whole of the text is not enclosed in double-quotes.

The Expression can contain more that just text - it can incorporate the preceding number, it can invoke another macro, and it can perform a lookup.  You can also use the concat function to concatenate things, and other XPath functions.

If you do use concat, then if you need the generated text to be on separate lines, you just split the line in the middle of a string like the following:

concat('This is the first part',' and this is the end of line one
This is the second line') 

and this will expand to two lines:

This is the first part and this is the end of line one
This is the second line 

Alternatively, you can use the $nl variable as follows:

 concat('This is the first line',$nl,'This is line 2',$nl,'This is line 3') 

$number: If you define a macro, say @hrs to have the expression concat('every ',$number,' hours') then when you enter 6@hrs, it will be replaced by "every 6 hours".  That is, the number preceding the macro code ('@hrs' in this case) can be accessed using the special variable $number. As well as simple integers (like 6 or 10), you can use decimals (like 2.5) or fractions (like 1/4).

You cannot pass more than one number into the macro, but you can use the following trick. You can use a decimal and then cut it up using an expression like the following:

concat('Part1=',substring-before(string($number),'.'),' Part2=',substring-after(string($number),'.')) 

If a macro say @parts is defined with the above expression, then 12.34@parts will expand to 'Part1=12 Part2=34'.

You can even use three parts using the expression:

concat('Part1=',substring-before(string($number),'.'),' Part2=',substring-before(substring-after(string($number),'.'),'.'),' Part3=',substring-after(substring-after(string($number),'.'),'.')) 

Now 123.567.789@parts will expand into 'Part1=123 Part2=456 Part3=789'. That is, although we are passing in a number with an illegal format, we can cut it into parts.

The above trick is useful if you a building a macro to generate something like 'Take x mls y times a day for z days'.

If you prefer, you can use / as the separator rather than the decimal point by changing '.' in the above expressions to '/'. You then invoke the macro as 123/456/789@parts.

Lookups: If you define a macro, say dispensingUnits, to have the expression openvpms:lookup(openvpms:get(.,'product.entity'), 'dispensingUnits')
this will be used to look up the dispensing units for the current product. Other useful examples are:
openvpms:lookup(openvpms:get(.,'product.entity'), 'dispensingVerb') and
openvpms:lookup(openvpms:get(.,'product.entity'), 'sellingUnits')

Obviously, you need a understanding of the archetypes to make extensive use of this facility.

Macros in Macros: We can make use of the above two facilities by defining a macro, say @oid with the expression:

  concat($dispensingVerb, ' ', $number, ' ', $dispensingUnits, '(s) Once Daily')

Here we are invoking two other macros, dispensingVerb and dispensingUnits, and also making use of the $number.  Thus 4@oid will expand to something like "Give 4 Tablet(s) Once Daily"

Note that invoked macro (eg 'dispensingVerb') MUST have a name that starts with a letter, otherwise the expansion will not work. (What will happen is that the invoked macro will be immediately expanded instead of delaying its expansion until you invoke the outer macro.)

If you do really need to invoke a macro starting with @, then you need to 'hide' the macro by splitting it as in the following example:

macro:eval(concat('@', 'lea'))

Here we have hidden the macro code from expansion using concat, and then evaluated it with the macro:eval() function. If in the earlier example, the dispensing macros were in fact @dispensingVerb and @dispensingUnits, then we could write the macro as follows:

concat(macro:eval(concat('@','dispensingVerb')),' ',$number, ' ',macro:eval(concat('@','dispensingUnits')),'(s) Once Daily') 

JXPath Extension Functions

Macro expressions are JXPath expressions and may therefore use the JXPath Extension Functions.

Macro Variables

Within the OpenVPMS web application, there a number of pre-defined variables that can be used in macros.

For example, the $patient variable refers to the current selected patient. If no patient is selected, then the variable is undefined.

The standard JXPath functions can be used to access the variable fields. e.g:

• openvpms:get($patient, "name") - gets the current patient name
• openvpms:lookup($customer, "title") - gets the current customer's title (as opposed to the title code)

For convenience, the variables support the archetype dot notation, so the above can be simplified to:

• $patient.name
• $customer.title

Note: these variables are not available in reports.

The following variables are available:

Sample Expressions

$appointment

concat(expr:if(boolean($appointment.patient), concat($appointment.patient.entity.name, "'s"), 'Your'), 
       ' appointment at ', $appointment.schedule.entity.location.target.name, ' is confirmed for ', 
       date:formatDate($appointment.startTime, 'short'), ' @ ', date:formatTime($appointment.startTime, 'short'), $nl, 
       'Call us on ', party:getTelephone($appointment.schedule.entity.location.target), 
       ' if you need to change the appointment')

$task

concat('Customer: ', $task.customer.entity.name, $nl,
       'Patient: ', expr:if(boolean($task.patient), $task.patient.entity.name, 'None'), $nl,
       'Work List: ', $task.worklist.entity.name, $nl,
       'Type: ', $task.taskType.entity.name, $nl,
       'Started: ', date:formatDateTime($task.startTime, 'short'),  $nl,
       'Completed: ', date:formatDateTime($task.endTime, 'short'), $nl,
       'Status: ', $task.status)

Troubleshooting

If your macro does not expand, then the following may help:

Message Reason

This screen is used to create/view/edit the Message Reason lookups. These are used to set the Reasons available on the message create/edit screen.

The fields are as follows:

Name - the message reason
default - check the box to to make this the default reason

Message Status

This screen is used to create/view/edit the Message Status lookups. These are used to set the Statuses available on the message create/edit screen.

The fields are as follows:

Name - the message status
default - check the box to to make this the default status

Patient Alert Class

This screen allows you to create/view/edit the details for the Patient Alert Classes. These are used only to define the available Classes for Patient Alert Types. Two are present by default, 'Aggression' and 'Allergy'.

The fields are as follows:

Name - the Alert's name
Default - check this box to make this alert the default class
Active - uncheck the box to deactivate the alert class

Person Title

This screen is used to create/view/edit the Title lookups. These are used to set the Titles available on the customer create/edit screen.

The fields are as follows:

Name - the title
default - check the box to to make this the default title
Active - uncheck the box to deactivate the title

Practice Type

This screen is used to create/view/edit the Practice Type lookups. These are used to set the Categories available on the Supplier-Veterinary Practice create/edit screen.

The fields are as follows:

Name - the practice type
Active - uncheck the box to deactivate the type

Presenting Complaint (VeNom)

Use this screen to view VeNom (Veterinary Nomenclature) Presenting Complaint codes.

These are used by patient Problems.

These cannot be edited as they are specified by the VeNom standard.

To add a presenting complaint, create a Presenting Complaint instead.

Presenting Complaint

This screen allows you to create/view/edit a Presenting Complaint.

These are used by patient Problems.

In general, you should only need to create a Presenting Complaint if there is no equivalent Presenting Complaint (VeNom).

Pricing Group

This screen is used to create/view/edit Pricing Group lookups. See Concepts|Pricing for details.

These are used to classify product prices to enable different pricing between Practice Locations.

Note that since only one Pricing Group can be assigned to each Practice Location, you will normally have fewer Pricing Groups than locations.

Name - the name of the Pricing Group
Default - check the box to make this the default Pricing Group
Active - uncheck the box to deactivate the Pricing Group

Product Group

This screen is used to create/view/edit the Product Group lookups. These are used to set the Classifications available on the Product (merchandise, medication and service) create/edit screens.
Note that the Classifications available include both the Product Groups and the Product Income Types.

The fields are as follows:

Name - the group
Active - uncheck the box to deactivate the group

Product Income Type

This screen is used to create/view/edit the Product Income Type lookups. These are used to set the Classifications available on the Product (merchandise, medication and service) create/edit screens.
Note that the Classifications available include both the Product Income Types and the Product Groups.

The fields are as follows:

Name - the income type
Active - uncheck the box to deactivate the income type

Reminder Group

This screen is used to create/view/edit the Reminder Group lookups. These are used to set the Groups available on the Administration|Types|Reminders create/edit screen.

The fields are as follows:

Name - the group name
Description - an optional description used to clarify the purpose of the group
Active - uncheck the box to deactivate the reminder group

Report Macros

This screen is used to create/view/edit the Report Macro lookups. These are used to:

• enable the accelerated entry of text in any text field by running a report.
• generate email text.
• generate text in documents using macro:eval. See below.

If you are having problems, see here.

The fields are the same as for normal Macros (see Lookups|Macros) but with a different usage for the Expression field and an additional Report field.

Description - it is sensible to use a description like the above to emphasise that the macro will generate a text version of the report (and not the actual fully formatted report)

Expression - this is used to pass the data source to the report and we need to access the thing that we are going to report on. This is done using of the JXPath Extension Functions - specifically one of the party:get*() series. As you can see in the above example the expression is getting the last visit for the current patient.
Note: You need to be careful with the syntax used in the Expression. Specifically, you can only use the $xxxx argument format ($patient in the above screen shot) if the ReportMacro is to be invoked directly by the user.  If the ReportMacro is to be invoked from say an Open Office document by using the macro:eval function, then you cannot use the $xxxx argument format. Instead, simply use a period - ie party:getPatientVisit(.) and in the Open Office document the user field should be like: [macro:eval('@referral',openvpms:get(.,'patient.entity'))] - here the second argument is passing the patient entity needed by the macro expression.

Report - the Report to run. See below.
The above macro runs the Referral Letter report, using the current patient's most recent Visit. Note that if there is no current patient, then the macro simply will not expand - i.e. the user will be left with the '@referral' that they typed.

Reports

Report macros can use:

• OpenOffice documents
• Microsoft Word documents
• JasperReports templates

 OpenOffice and Word documents

If you are using OpenOffice or Word documents, you may want to do some conditional text handling (ie if sex=male use 'he', if female use 'she', else use 'it'.  This is possible - see here for OpenOffice, here for MS Word.

JasperReports templates

When using JasperReports templates, there are a number of issues to be aware of:

• a fixed size font should be used
• special properties need to be defined to indicate to JasperReports how to divide the report into a grid
• fields should start on grid boundaries to avoid text being excluded

The easiest approach is to:

• define all dimensions in pixels
• set the character width and height to a round number
• ensure the page height and width is divisible by the character size

To set the character size to 10x10 pixels in iReport:

1. right click on the report in Report Inspector
2. select Properties
3. scroll down to Properties in the displayed table
4. click on the elipsis; this will display a dialog containing the defined properties.
5. add property net.sf.jasperreports.export.text.character.width with value 10
6. add property net.sf.jasperreports.export.text.character.height with value 10

Set the page width and height to a multiple of the character width and height. E.g. 500x500. Note also:

• The 'Stretch with overflow' setting is ignored with when using this Text Export facility, hence all the text needs to fit in the field.
• With a character width of 10, and a page width of 500 the maximum number of characters in a field will be 500/10=50.  If you need more than this increase the page width to say 2000 and decrease the character width to 5 which will then allow 400 characters.
• Set the height of your fields to the same as text.character.height setting - eg 10 px
• Use a small font (say 5) so you can see the text in the fields

See also JasperReports - Text Export Sample

Using macro:eval

Report macros can be run in documents using the macro:eval function.

To access the document (e.g. Patient Letter or Form) that launched them:

• use '.' without quotes as the Expression
• use either:
  • macro:eval('<code>') or
  • macro:eval('<code>', /)

to run the macro, where <code> is the report macro code.
 

Report Type

This screen is used to create/view/edit the Report Type lookups. These are used to set the Report Types available for document templates.

The fields are as follows:

Name - the report type
Default - check the box if this is to be the default report type
Active - uncheck the box to deactivate the type

Species (IDEXX)

This screen is used to create/view/edit the details of the IDEXX Species lookups.

These are used by the HL7 interface when sending messages to IDEXX. A mapping needs to be established between OpenVPMS and IDEXX species lookups.

The fields are as follows:

Species - the IDEXX species code
Name - the name of the species
Active - uncheck the box to deactivate the species
 

Species

This screen is used to create/view/edit the details of the Species lookups.  These determine what patient species are available.

The fields are as follows:

Name - the name of the species
default - check the box to make this the default species
Active - uncheck the box to deactivate the species
Custom Fields - normally this is left at 'None'. The system supports the use of custom fields. To make use of this feature, you need to copy/modify the entity.customPatientExample archetype that is shipped with the system to make archetypes having names matching entity.customPatient* (eg entity.customPatientLastVaccination). Note that if you do make use of this facility, then:
a) for existing patients, the new custom field tab will not appear until you edit the patient, but from then on it will appear for that patient
b) when you are creating a new patient, the custom tab will not appear until you set the species (because the custom field is species specific)

Breeds tab - this is used to set/display the Breeds belonging to the species

Mapping tab - this is used to map breeds to those used in external systems.

State

This screen is used to create/view/edit the details of the State lookups. 

The fields are as follows:

Code - the code for the state. It is conventional to use the standard state codes, but you can in fact use any upper case letter string (eg VICTORIA in place of the standard VIC). Note that once you have created the State Lookup, you cannot change the Code - you have to create a new one, and then use the Replace mechanism.
Name - the name of the state
Default - check the box to make this the default state
Active - uncheck the box to deactivate the state

Suburbs tab - this is used to display and set the suburbs that are part of the state - use Lookup|Suburb to create these
 

Suburb

This screen is used to create/view/edit the details of the Suburb lookups. 

The fields are as follows:

Name - the name of the suburb
Post Code - the post or zip code
Default - check the box to make this the default suburb
Active - uncheck the box to deactivate the suburb
State - this is used to display and set the state - use Lookup|State to create this

Supplier Account Type

This screen is used to create/view/edit the Supplier Account Type lookups. These are used to set the Account Types available on the Supplier (Organisation and Person) create/edit screens.

The fields are as follows:

Name - the account type
Payment Terms and Payment Terms Units - the supplier's payment terms
Active - uncheck the box to deactive the account type

Note that the system contains no automatic payment processing system which would make use of the Payment Terms fields to pay only invoices that are due (and this functionality is usually handled by the accounting system).  However, it is quite possible to build a supplier payments due report that would use these fields.

Supplier Type

This screen is used to create/view/edit the Supplier Type lookups. These are used to set the Categories available on the Supplier (Organisation and Representative) create/edit screen.

The fields are as follows:

Name - the supplier type
Active - uncheck the box to deactive the supplier type

Tax Type

This screen is used to create/view/edit the Tax Type lookups. These set the available taxes on the Taxes tabs for Practices, Practice Locations, Product Types, Products, and Customers.

The fields are as follows:

Name - the tax name (normally its short name such as GST or VAT)
Description - the full name of the tax
Percentage - the tax rate as a percentage
Active - uncheck the box to deactive the tax type
Tax Scheme - can be set to None, Goods and services tax, or Value added tax.
Tax Category - can be set to None, Standard rated, or Zero rated.

The latter two fields (Tax Scheme and Category) are used only are used to map ESCI (e-Supply Chain Interface) taxes to their OpenVPMS equivalents.  See the ESCI documentation for more details: http://www.openvpms.org/documentation/esci  If you are not using ESCI, then these two can be left at their defaults, ie None.

Units of Measure

This screen is used to create/view/edit the Units of Measure lookups. These are used to set the units available for the Selling, Dispensing and Packaging Units on the Product Information screens.

The fields are as follows:

Name - the name of the Unit of Measure (eg Unit, Grams, Pounds, Box, Syringe, Pack of 10)
Printed Name - this is used to provide a short abbreviation that can be used when displaying quantities on invoices, credits, counter-sales and statements. See also below.
Unit Code - this is used by the ESCI facility (see below).  If you are not using ESCI, then you can happily leave this set at its default of 'each'. 
default - check this box to make this the default Unit of Measure
Active - uncheck the box to deactive the Unit of Measure

The Printed Name field can hold a maximum of 5 characters.  However the standard invoices etc in the release package allow space for 3 m characters, ie 'mmm'. Note that in the majority of cases you can leave this field empty and only set it where needed. Thus although
    Hills Feline D/D Venison Can 5.5oz   10
makes sense, you probably do want
    Atropine Injection                          0.25 ml

It is probably worth pointing out that the standard convention is that unit abbreviations should be singular (ie ml rather than mls).

The Unit Code is used by the ESCI facility to map UN/CEFACT Unit Codes* to the practice equivalents. The list contents are defined within the archetype lookup.uom and can only be added to by modifying the archetype. Note that OpenVPMS only provides a subset of the available codes, so if a required code is missing, it can be added but must be present in the list provided by http://docs.oasis-open.org/ubl/cs-UBL-2.0/cl/gc/cefact/UnitOfMeasureCode...

* UN/CEFACT Recommendation N°. 20 - Codes for Units of Measure Used in International Trade - http://www.unece.org/fileadmin/DAM/cefact/recommendations/rec20/rec20.zip

Units of Measure Group

This facility is not used in the current system. It is reserved for future use to categorise units of measure in order to set a practice wide default for weight units.

User Name Format

This screen is used to create, view or edit a User Name Format.

These are used to format user names in reports and documents.

The fields are as follows:

• Name - the format name
• Description - a description of the format
• Expression - the xpath expression to format user names

The expression is provided with the following variables:

• $username - the user's login name
• $title - the user's title
• $firstName - the user's first name
• $lastName - the user's last name
• $qualifications - the user's qualifications
• $name - the user's name (ie the field labeled 'Full Name' on the Administration|Users|Create/edit/view screen)
• $description - the user's description

User Type

This screen is used to create/view/edit the User Type lookups. These are used to set the Categories available on the Administrator|Users create/edit screen.

The system comes with four user Types, Administrator, Clinician, Nurse and Receptionist. The first two are important for the functioning of the system. Users with Type Administrator, get will have the Administration workspace available. Only users with Type Clinician can be selected as the Clinician in places where the system allows or requires the clinician to be entered.

The fields are as follows:

Name - the user type
Active - uncheck the box to deactive the user type

Veterinary Speciality

This screen is used to create/view/edit the Veterinary Speciality lookups. These are used to set the Categories available on the Supplier-Veterinarian create/edit screen.

The fields are as follows:

Name - the speciality
Active - uncheck the box to deactivate the speciality

Visit Reason (VeNom)

Use this screen to view VeNom (Veterinary Nomenclature) Visit Reason codes.

These are used to classify Appointments and Visits.

These cannot be edited as they are specified by the VeNom standard.

To add a visit reason, create a Visit Reason instead.

Visit Reason

This screen is used to create/view/edit the details of each Visit Reason.

The fields are as follows:

Name - the Visit Reason
Default - check the box to make this the default reason for appointments and visits
 

Confirm Delete

When you press the Delete button on the Administration|Lookups screen, a confirmation window will appear.

If you press OK to confirm the delete, then, if the Lookup is not in use, it will be deleted. Otherwise an error window will appear with the text:

Cannot delete lookup. It is being used.
To delete the lookup, select 'Replace' to replace it with another lookup.

Click OK to dismiss the error window and use the Replace button to replace the Lookup.

Confirm New

This is the New Lookup confirmation window. Select the type of Lookup to be created and then use OK to continue or Cancel to abort. Note that if you have selected a type on the Lookup screen, then this will already be selected in this window (even if it is not showing in the list of types) - thus you can normally simply click OK to proceed.

Confirm Replace

This is the Replace Lookup confirmation window.  As shown below it allows you to confirm the Lookup you are about to replace and choose what to replace it with.

Notes:

1. You must choose a replacement, ie you cannot leave it set as 'None' as shown above.
2. If you check the Delete Lookup? box, then the Lookup you are replacing will be deleted when the replacement is complete. ie in the above case, the Product Group Lookup 'Procedures' would be deleted.

Connectors

The Connectors screen supports viewing and editing HL7 connectors.

Connectors may be:

• Senders - used to send HL7 messages from OpenVPMS to an external system
• Receivers - used to receive HL7 messages from an external system

The buttons are as follows:

Creating a new HL7 Connector

The New button is used to create a new HL7 Connector:

The available Connectors are:

Mappings

The Mappings screen supports viewing and editing HL7 mappings.

These determine how HL7 messages are populated, and the messages that are sent.

The buttons are as follows:

Creating a Mapping

The New button is used to create a new HL7 Mapping:

The Cubex HL7 Mapping and IDEXX HL7 Mapping are pre-configured mappings for the Cubex pharmacy service and IDEXX laboratory service, respectively.

The HL7 Mapping is a generic mapping.

Select OK to create the selected mapping.

Lookup Mappings

Some HL7 applications require OpenVPMS lookups to be mapped to their format. This is supported by creating a relationship between the OpenVPMS lookup and the application specific version.

From OpenVPMS 1.9, mapping of Species is supported. For convenience, these mappings can be exported to CSV (comma-separated values), edited in a spreadsheet, and then re-imported.

Exporting Mappings

The Export Lookup Mapping button is used to export mappings to CSV. This displays a popup window:

Clicking OK generates a CSV containing the current mapping between the selected lookup archetypes.

If no mapping has been established, the file will look like:

Each column with blanks needs to be filled out. If no mapping exists, the row should be deleted.

Importing Mappings

The Import Lookup Mapping button is used to import mappings from CSV. This displays a popup window to upload the CSV file:

Click Browse to select the CSV file.

Click Send to upload the file and import it.

A message will be displayed if the file was imported successfully.

Lookup Mapping Import Errors

If errors were detected in the import, a summary will be displayed:

Correct these, and re-import until no errors are reported.

Services

The Services screen supports viewing and editing HL7 services.

The buttons are as follows:

Creating a new HL7 Service

The New button is used to create a new HL7 Service:

The available services are:

Medical Record Locker

The Medical Record Locker is a scheduled job that periodically locks patient medical records based on the Practice Record Lock Period setting.
A default instance of this job will be created when the Record Lock Period is set.

The fields are as follows:

The Batch Size and Max Records fields can be used to limit resource utilisation. If enabling locking for the first time, set Max Records to a suitably large value so that the backlog of records can be cleared.

Cron Expression

The Minutes, Hours, Day Of Month, Month, and Day Of Week fields determine when the job is run, using a simplified version of a Cron expression:

Note that only one of Day Of Month and Day Of Week may be specified. If one is specified, the other must be set to ?.

If you change the schedule, the new schedule will take effect immediately.

Examples

Document Loader

The Document Loader is a scheduled job that periodically load files from a directory and attaches them to documents or investigations.

Files are associated with documents or investigations by parsing their identifier from the file name.

The Active field:

• schedules the job to run if checked; or
• prevents it from being run if unchecked

The Source Directory is the directory to load files from.

The Destination Directory is the directory to move successfully loaded files to.

The Error Directory is the directory to move files to that couldn't be loaded.

Note that the Tomcat application must have write access to Destination and Error directories.

(nb. on linux servers you must use the direct path, not a symbolic link and the group that owns the the source and destination directories must have read and write permissions and the tomcat user must belong to that group eg. use 'sudo usermod -a -G group tomcat7'​)

The Id Pattern is a regular expression that enables the document identifier to be parsed from the file name. The default expression is [^\d]*(\d+).* - this looks for the first digit string in the file name.  For example, the following file names all have the ID 3035108:
  DAO DAO_TSANG_ _3035108_20150226_115435_4762.pdf
  3035108 CBC test.jpg
  Xray DAO DAO_TSANG 3035108.jpg

The Overwrite field determines if files should be loaded if one already exists. If selected, the existing content will be replaced, if it doesn't duplicate the existing content. For documents that support versioning*, the existing content will be saved as a version.  The following table indicates the behaviour if a document has been previously loaded:

Note that in case 2 & 3, if the document supports versioning, then the previous document is set as a version, and the primary document is replaced.

In case 2, if the previous document already exists in the Destination Directory, then the loader will fail and terminate. The file in the Destination Directory needs to be manually moved aside.

* all of the standard document archetypes with the exception of act.documentTemplate in OpenVPMS support versioning. The Document Loader cannot be used to load act.documentTemplate instances.

The Recurse Subdirectories  field determines if subdirectories of the source directory should be searched for documents to load.

The Archetypes field is a comma separated list of archetype short names, identifying the document archetypes that may be loaded to. These may include wild cards. Use of wildcards is NOT recommended, as malformed file names may result in files being loaded to incorrect documents. For Investigations, use act.patientInvestigation.

The Enable Logging field determines if loading should be logged. This can be used to help track down problems.  The information is written to the OpenVPMS logs in <TOMCAT-HOME>/logs.

If Stop On Error is selected, the loader will stop on the first error it encounters.  Note that this means 'stop this run', it does not 'stop all future scheduled runs'.  For normal operation, you should leave this unticked, otherwise, it is possible that an error with one document (say because it has a name that does not contain an ID) will prevent other documents being loaded.

The Minutes, Hours, Day Of Month, Month, and Day Of Week fields determine when the job is run. [Note that if you change the schedule, the new schedule will take effect immediately.]

These are a defined using a simplified version of a Cron expression:

Note that only one of Day Of Month and Day Of Week may be specified. If one is specified, the other must be set to ?.

Examples

The Run As field specifies the user to run the job as. This user is required to establish the permissions to:

• create and update the specified archetypes
• send notification messages

The Notify field specifies the user or user group to notify when a load has completed. Notification only occurs when documents are loaded, or errors are encountered. You may want to use a 'real' user or group of real users, or you may want to create a user such as 'Document Loader Message Receiver' used only for these notifications.

ESCI Inbox Reader

The ESCI Inbox Reader is a scheduled job that periodically checks ESCI Inboxes for messages from suppliers.

The Active field:

• schedules the job to run if checked; or
• prevents it from being run if unchecked

The Minutes, Hours, Day Of Month, Month, and Day Of Week fields determine when the job is run.

These are a defined using a simplified version of a Cron expression:

Note that only one of Day Of Month and Day Of Week may be specified. If one is specified, the other must be set to ?.

If you change the schedule, the new schedule will take effect immediately.

Examples

The Run As field specifies the user to run the job as. The selected user must have permissions to:

• update Orders
• create Supplier Deliveries
• create System Messages

Appointment Reminder Sender

The Appointment Reminder Sender is a scheduled job that periodically sends SMS appointment reminders.

The fields are as follows:

Cron Expression

The Minutes, Hours, Day Of Month, Month, and Day Of Week fields determine when the job is run, using a simplified version of a Cron expression:

Note that only one of Day Of Month and Day Of Week may be specified. If one is specified, the other must be set to ?.

If you change the schedule, the new schedule will take effect immediately.

Examples

Patient Reminder Queue

The Patient Reminder Queue is a scheduled job used to:

• queue patient reminders for sending
• cancel reminders that are no longer applicable.

It should be scheduled to run daily, preferably outside of business hours.

On completion, reminders may be manually sent via Reporting - Reminders.
Email and SMS reminders may be automatically sent by the Patient Reminder Sender.

Queueing

Reminders are selected for queueing if they have:

• a Next Due Date less than or equal to the current date; and
• an In Progress status; and
• no associated Items with Pending or Error status

It will cancel reminders if:

• the patient is deceased or inactive; or
• the Next Due Date + the Reminder Type's Cancel Time is less than the current date

For each reminder that matches the criteria, one or more Patient Reminder Items will be created according to its Reminder Type's rules, and the associated customer's contacts.

Note that the queue is not rebuilt each time the job runs. Reminders that have been previously added to the queue are left unaltered. This does mean that if you change say the Lead Times, reminders already in the queue will not affected.

The fields are as follows:

Cron Expression

The Minutes, Hours, Day Of Month, Month, and Day Of Week fields determine when the job is run, using a simplified version of a Cron expression:

Note that only one of Day Of Month and Day Of Week may be specified. If one is specified, the other must be set to ?.

If you change the schedule, the new schedule will take effect immediately.

Examples

Patient Reminder Sender

The Patient Reminder Sender is a scheduled job that sends Email and SMS reminders queued by the Patient Reminder Queue job.

It should be scheduled to run during business hours.

You do not have to use the Patient Reminder Sender job.  If you do not, then Email and SMS reminders will be sent as part of the Reporting|Reminders|Send|Send All processing.

However, since you probably want to send out Email and SMS reminders more often than printed, listed, and exported reminders, then it is convenient to set up a Patient Reminder job to do this on say a daily basis.

The create/edit/view screen is as follows:

The fields are as follows:

Cron Expression

The Minutes, Hours, Day Of Month, Month, and Day Of Week fields determine when the job is run, using a simplified version of a Cron expression:

Note that only one of Day Of Month and Day Of Week may be specified. If one is specified, the other must be set to ?.

If you change the schedule, the new schedule will take effect immediately.

Examples

Pharmacy Order Discontinuation

This job is automatically scheduled by setting the Pharmacy Order Discontinuation Period option on the Practice.

The fields are as follows:

The Batch Size and Max Records fields can be used to limit resource utilisation.

Cron Expression

The Minutes and Hours fields will be populated automatically when the Pharmacy Order Discontinuation Period option on the Practice is set. The job will be scheduled to run twice during specified period.

The Minutes, Hours, Day Of Month, Month, and Day Of Week fields determine when the job is run, using a simplified version of a Cron expression:

Note that only one of Day Of Month and Day Of Week may be specified. If one is specified, the other must be set to ?.

If you change the schedule, the new schedule will take effect immediately.

Examples

Scheduled Report

Scheduled Report is a job that can be configured to periodically run a report and write the output to a file, email it, and/or print it.

The fields are as follows:

Cron Expression

The Minutes, Hours, Day Of Month, Month, and Day Of Week fields determine when the job is run, using a simplified version of a Cron expression:

Note that only one of Day Of Month and Day Of Week may be specified. If one is specified, the other must be set to ?.

If you change the schedule, the new schedule will take effect immediately.

Examples

Confirm Delete

When you press the Delete button on the Administration|Users screen, a confirmation window will appear.

If the selected User is not in use and can be deleted, the window will simply ask you to confirm the delete. Press OK to confirm or Cancel to abort.

If it cannot be deleted because it is in use, the text will be "xxxx has relationships and cannot be deleted. Do you want to deactivate it instead?"(where xxx is the name of the item you are trying to delete). Pressing OK will unset its Active flag, Cancel will abort.

Create/Edit/View

This screen allows you to create, edit and view Users. See also Concepts|Users for background information.

The fields are as follows:
Login Name - the name with which the user logs in. Note that you can set this to have upper and lower case letters (eg Doris). The user will be able to login with doris, Doris, DORIS, or even doRis. The upper case version of the login name must be unique, ie you cannot have one user named Doris and another named DORIS.
Password and Confirm Password - the user's password
Name - the name that will be used within the system - ie that shown in the Clinician pull-downs, and the name used to send messages. As shown in the above, this need not be a full name, and it is faster to select the clinician if the name is short or has a unique first letter.
Description - if you use short names then this should be the person's full name, else if can be any useful text.
Active - uncheck this box to deactivate the user
Title - user title, used for reporting purposes.
First Name - user first name, used for reporting purposes.
Last Name - user surname, used for reporting purposes.
Qualifications - user qualifications, used for reporting purposes.
User Level - used to limit the reports a user can run
Edit Preferences - when selected, the user can edit preferences via the gear icon
Colour - used to set the colour used for the user when highlighting them on the Scheduling and Work Lists windows.  It is not necessary to set the colour for anyone who is not a clinician. You use the mouse to select the colour via the colour and luminosity/hue boxes. If you want to check the colours of the different users, the easiest way to do this is to view the user and then to use the Next and Previous buttons to run back and forth through the different user.
Note that you should avoid the 'light cream' colour f2f3b3 which displays as follows:
because this is used to highlight the selected item on the Workflow|Scheduling and Work Lists screens.
Online Booking - determines if the user can be selected for appointments by online booking services. This only applies to clinicians.

Contacts tab - this is used to display, add, delete and edit the Contacts for the user - see here. Note that adding an email contact for each staff member makes it easy to CC or BCC staff on any emails sent.

Roles tab - this is used to display, add, delete and edit the Roles for the user

Groups tab - this is used to display, add, delete and edit the User Groups the user belongs to

Category tab - this is used to display, add, delete and edit the User Types for the user. Set Administrator for all users who need to access the Administration menu and other administrative functions (Customer Accounts Check and Merge, Patient Merge, and Product maintenance [Edit, Delete, Copy, Export & Import]). Set Clinician for any user who needs to be selectable in the Clinician pull-downs. You can set multiple categories, ie both Clinician and Administrator.

Location tab - this is used to display, add, delete and edit the Practice Locations for the user. You specify Practice Locations in order to limit the Locations that the user can select at the top right of the screen.  If you do not specify any, then the user can select any Location. You should set the default flag on the user's default Location- this will then be the selected Location when the user logs in.

Follow-up Work Lists tab - this is used to configure the work lists that may be selected when:

• clicking the button in the patient summary, to add a follow-up task
• the Follow-Up At Check Out option is selected to create follow-up tasks at check-out

Select

This is the screen used to select a User. It works like a standard select screen.

Confirm Delete

When you press the Delete button on the Administration|User Groups screen, a confirmation window will appear.

If the selected Group has no members and can be deleted, the window will simply ask you to confirm the delete. Press OK to confirm or Cancel to abort.

If it has members, the text will be:

xxx has relationships. Are you sure want to delete?
This operation cannot be undone.

(where xxx is the name of the Group you are trying to delete). Pressing OK will delete the Group, Cancel will abort.

Create/Edit/View

This screen allows you to create, edit and view User Groups.

The fields are as follows:
Name - the name of the group
Description - use this to clarify the purpose of the group
Active - uncheck this box to deactivate the group

Users tab - this is used to display, add and delete users from the group

Confirm Delete

When you press the Delete button on the Administration|Roles screen, a confirmation window will appear.

If you press OK to confirm the delete, then, if the Role is not in use, it will be deleted. Otherwise an error window will appear with the text like:

Failed to delete object with reference security.role.1.0:.......

Click OK to dismiss the error window.

Create/Edit/View

This screen allows you to create, edit and view Roles.

The fields are as follows:
Name - the name of the role
Description - use this to clarify the purpose of the role
Active - uncheck this box to deactivate the group

Authorities tab - this is used to display, add and delete authorities from the role

Note that in the above you will see that the Clinician role can create or save (ie modify) everything, but remove (ie delete) only messages. If you don't include message remove, then the user will not be able to delete their own messages. However, a normal (ie non-administrator) user can happily operate with no other remove authorities - recall that in general nothing should be deleted, only deactivated.

Confirm Delete

When you press the Delete button on the Administration|Authorities screen, a confirmation window will appear.

If you press OK to confirm the delete, then, if the Authority is not in use, it will be deleted. Otherwise an error window will appear with the text like:

Failed to delete object with security.archetypeAuthority.1.0:.......

Click OK to dismiss the error window.

Create/Edit/View

This screen allows you to create, edit and view Authorities. Normally you should never need to change these.

The fields are as follows:
Authority Name - the name of the authority
Description - use this to clarify the purpose of the authority
Service Name - must be set to Archetype Service
Method Name - can be one of save, new or remove
Archetype Name - the name of the archetype

Confirm Delete

When you press the Delete button on the Administration|Archetypes screen, a confirmation window will appear.

If you press OK to confirm the delete, then, if the Archetype is not in use, it will be deleted. Otherwise an error window will appear with the text like:

Failed to delete object with descriptor.archetype.1.0:.......

Click OK to dismiss the error window.

Create/Edit/View

This is the create/edit/view screen for archetypes.  Feel free to use this screen to examine archetypes, but unless you know exactly what you are doing, do not use it to modify things.

The fields are:
ID - the id number of the archetype
Name - the name of the archetype
Display Name - its display name
Class Name - the name of the java class that defines the archetype
Latest - check this box if this is the latest version
Primary - check this box if this is a primary archetype. The primary field is used to filter similarly named archetypes from lists when wildcards are used. E.g listing archetypes for act.customerAccount* with primary=true will exclude all of the item acts (act.customerAccountPaymentCash etc). Most cases where workspaces list archetypes by archetypes (e.g. Admin|Organisation), they list primary archetypes.
That said, there aren't too many non-primary archetypes, and these wouldn't be matched on the wildcards used anyway.
Node table - this shows each 'node' or component of the archetype. In the above example there are only 4. If there are more than 10, then the display is paged.

Node tab - this shows the attributes of the selected node (microchip in the above example). Its fields are:
Name - the name of the node
Display Name - this is used as the name of the field when it appears on the screen
Type - the java class that defines the node's type
Path - defines where this node is held in the database
Min, Max Cardinality - define how many of these nodes there can be. (1,1) means there must be one only (ie the field is mandatory),  (0,1) means that the node is optional but there can be no more than one, (0,-1) means that the node is optional, but there in no limit to the number.
Min, Max Length - define the allowed number of characters if this is a string
Default Value - the default value for this node
Derived - check this box if the value of this node is to be derived from others
Derived Value - an expression that provides the derived value. For example, the Description node of the till archetype is "concat('Last Cleared : ',/details/lastCleared, ' Cash Float : ',/details/tillFloat)".
Hidden - check this box is the node is not to be displayed
Read Only - check this box if the node cannot be updated

Assertion Descriptors tab - this shows the attributes of the selected assertion. Assertions are used to validate the data for the node. There are a dozen different types (such as number, stringcase, expression, regular expression, lookup, etc). In the above example there is a single regular expression assertion. The fields are in general different for each assertion type, and are not documented here.

Application Caches

The Application Caches window displays current memory use and statistics for select caches in OpenVPMS.
This is launched by clicking Caches in Administration - System.

The table displays:

The buttons are:

Changing a Cache

The Edit button displayed a Change Cache window for the selected cache.

This displays the current maximum elements for the cache, and provides options to select a suggested value for the cache size, or enter a new one.

The cache size should be changed if:

• there are too many cache misses vs cache hits.
  This indicates that the cache is too small and that Max Elements should be increased.
• memory consumption is too high
  Here Max Elements should be decreased.

Note that the suggested size does not take into account memory consumption.

Diagnostics

The Diagnostics window supports viewing:

SHOW ENGINE INNODB STATUS

GRANT SELECT, PROCESS ON *.* TO 'openvpms'@'localhost';

Document Locks

The Document Locks tab displays the users that have locks on documents to prevent other users from overwriting their changes. These locks are created by OpenOffice when External Edit is used to edit a document.

Each row in the table displays:

• the user login name
• the user name
• the name of the locked document
• the time when the lock expires - note that this time will normally be a couple of minutes in the future. When this time is reached the system checks that the document is still being edited, and if so renews the lock.

Locks can be filtered by login name, user name or host.

The Delete button can be used to delete a lock that needs to be cleared. Normally the lock will be removed when the document has finished being edited.

Plugins

The Plugins screen displays the status of the plugin support in OpenVPMS.

Plugin support is initially disabled. To enable it, click Configure and enter the path to the plugins directory. For a standard OpenVPMS installation, this is the plugins directory located in the OpenVPMS installation directory.

Each row in the table displays the plugin:

• identifier
• name
• version
• status

The buttons are as follows:

Updating Plugins

There is currently no user interface support to directly update plugins.

To update a plugin:

1. remove the existing version from the plugins/deploy/ directory
   This must be done while OpenVPMS is running, and plugins are active.
   Verify that the original plugin has been uninstalled, by clicking Refresh
2. install the new version using Install Plugin

Failure to correctly remove the existing version of the plugin may result in multiple versions being installed, with unpredictable results.

Sessions

The Sessions tab displays current user sessions.

Each row in the table displays:

• the user login name
• the user name
• the host they are logged in from

NOTE: this may be the address of a firewall or proxy, rather than the user's actual address.

• when they logged in
• when they last accessed the session

Sessions can be filtered by login name, user name or host.

The buttons are: