Appointment Type

Contents ShowHide

The Appointment Type screen is used to manage a selected appointment type for the local agency and can be displayed in Add or Edit mode.

The Add Appointment Type screen allows the user to add an appointment type to the local agency. The Edit Appointment Type screen allows the user to specify a default duration for the selected appointment type for each clinic in the local agency.

Add Appointment Type screen

Edit Appointment Type screen

Screen Access

To add an appointment type:

Display the Appointment Types screen > Click the Add button.

To edit an appointment type:

Display the Appointment Types screen > Select a record in the Appointment Types data grid > Click the Edit button

Interface Initialization

Upon initial display of the screen, the following occurs:

The OK button is visible and enabled as the default.

The Cancel button is visible and enabled as the default.

In Add mode:

The title bar text is set to "Add Appointment Type".

All data controls are enabled and blank.

In Edit mode:

The title bar text is set to "Edit Appointment Type".

The Description text box is enabled and displays the value of the Description column from the selected entry in the Appointment Types data grid on the Appointment Types screen.
The Short Description text box is enabled and displays the value of the short description for the selected entry in the Appointment Types data grid on the Appointment Types screen.
The Default Duration data grid will display all clinics in the agency in order by Clinic ID.

Screen Elements

Unless otherwise stated below, all controls on the Appointment Type screen are visible and enabled when:

The screen is displayed in Add mode.

The screen is displayed in Edit mode.

If one or more special conditions exist that affect a control on the Appointment Type screen, the condition(s) are documented for that specific control below.

Description text box

Enter the description in the Description text box.

The text box allows the entry of alphabetic, numeric, and special characters. The maximum number of characters that can be entered in the text box is fifty (50) characters.

In Add mode, the text box is initially blank. In Edit mode, the text box defaults to the value of the Description column from the record selected in the Appointment Types data grid on the Appointment Types screen. An entry is required in this control.

The control is enabled when:

The screen is displayed in Edit mode and the selected Appointment Type is not a system-defined appointment.

The description or name entered cannot be the same as another description currently saved in the system. If it is, the system displays the E0031 standard error message.

Short Description text box

Enter the abbreviated description for the appointment type in the Short Description text box.

The text box allows the entry of alphabetic and numeric characters. The maximum number of characters that can be entered in the text box is ten (10) characters.

In Add mode, the text box is initially blank. In Edit mode, the text box defaults to the value of the Short Description column from the record selected in the Appointment Types data grid on the Appointment Types screen. An entry is required in this control.

The control is enabled when:

The screen is displayed in Edit mode and the selected Appointment Type is not a system-defined appointment.

Reminder Interval text box

Enter the number of days prior to an appointment that appointment reminder e-mails will be sent to clients in the Reminder Interval text box.

It accepts the entry of numeric characters. Appointment reminder e-mails will be sent when the business rule APT_REMINDEREMAILENABLED = "Y". If no data is entered, the reminder interval is set to the default value.

System Defined check box

Select the System Defined check box to indicate whether the appointment type is system defined and is not editable.

The check box is automatically checked when the record selected in the Appointment Types data grid on the Appointment Types screen is a system-defined appointment, otherwise it will be unchecked.

The control is visible and disabled when:

The screen is displayed in Edit mode.

Default Duration editable data grid

View or update the information in the Default Duration editable data grid.

This editable data grid displays all clinics defined within the local agency and allows you to update the default duration for the appointment type selected on the Appointment Types screen for each clinic displayed.

The control is visible and enabled when:

The screen is displayed in Edit mode.

The entries in the editable data grid will be sorted by the value of the Clinic ID in the Clinic column.

Enter information directly in the Default Duration (min) column for the appointment type for each clinic displayed in the editable data grid as necessary. The column will only accept entry of numeric characters. The mask for the column will be "###". The value of the Default Duration column will initially default to 20 minutes.

The data grid consists of the following control(s):

Clinic column

This column displays the name of the clinic for each record displayed within the data grid.

The title of the column is set to "Clinic". The information displayed within the column is read-only.

The column header and data are left aligned.

Default Duration (min) column

This column contains a text box for each record displayed within the editable data grid. Enter or update the duration of the appointment directly in the Default Duration (min) column.

The title of the column is set to "Default Duration (min)". The information displayed within the column is read-only.

An entry is required in the Default Duration column for each clinic. The value entered in the Default Duration (min) column must be within the range of 5 to 120 minutes inclusive. The value entered will automatically be rounded by the system to the nearest 5-minute increment. For example, if 27 is entered the system will round the value to 25; if 28 is entered the system will round the value to 30. If the entry is less than 5 minutes then the entry will be set to 5 minutes. If the entry is greater than 120 minutes then the entry will be set to the maximum of 120 minutes.

OK button

Click the OK button to process the screen.

It is the default button for the screen, unless otherwise noted.

It does not have a mnemonic. Its keyboard shortcut is the Enter key.

The Appointment Types screen displays when the button is clicked.

Cancel button

Click the Cancel button to close the screen without processing or saving data.

It does not have a mnemonic. Its keyboard shortcut is the Esc (escape) key.

The Appointment Types screen displays when the button is clicked.

Processing

If data can be validated and saved on the screen, the following processes occur when the screen is processed:

A process to check for required controls as identified in the Data Map below is performed.
A process to check for valid entries as identified individually for each applicable control in Screen Elements above is performed.
A process to check for edits and cross edits as identified for each applicable control in Screen Elements above is performed.
If any checks or processes fail, a standard error message displays.

If no data can be validated and saved on the screen:

No cross edits are performed.
All values are considered legitimate.
No data is written to the database.

Data Map

The Data Map defines the values saved for all controls on the screen. If available, any additional notes or comments are displayed in the Notes column.

Control Label	Required	Table	Column	Notes
A record is created in the DefaultDuration table for each service site in the current agency for the appointment type with the duration set to 20.
Description	X	AppointmentType	Description	·
Short Description	X	AppointmentType	ShortDescription	·
Default Duration (min)	·	DefaultDuration	DefaultDuration	·
Reminder Interval	X	AppointmentType	AppointmentReminderInterval	·

Software Version: 2.40.00