Hold Reason
The Hold Reasons preference is used on referrals or referral tests to indicate hold reasons. Hold reasons have statuses which allow one hold reason to transition through a series of steps.
An example of a hold reason might be ‘Waiting for Information’ if a referral has been received without enough detail.
Hold reasons are added to the referral on the referral screen.
Location
The Hold Reason preference is located under the Administration > Preferences area of iGene.
In order to access the preferences area, a user must be a member of a role that has the Administration: Preferences and Administration menu permissions assigned.
- Navigate to Administration > Preferences.
- Find HoldReasons in the table and click View by either:
- Scrolling through the Preferences table until the Hold Reasons preference is found.
- Performing a search using an existing saved search for Name = HoldReasons.
- Performing a search using a newly created search. See the searching guide for information on how to create searches.
- To create a new hold reason click the + button at the bottom of the table, or select New Item from the Actions menu.
- To edit an existing hold reason, click the Edit button.
The table of hold reasons will display the code, name, description and status for the hold reason.
The Status field indicates two pieces of information:
User / System: User records have been added by users manually and are fully editable. System records are generally added via a data import or provided by default. Only the name can be edited on a system record.
Active / Inactive: Shows whether the record is currently active or inactive. Inactive items will not show up for selection for new records but will continue to show on entries that are using them.
Configuration
When adding or editing a hold reason, users are presented with the below form.
Always press Save in the bottom right hand corner of the browser after adding or editing a Hold Reason.
Code
(Required, Unique)
A unique code for the hold reason. This can be the same as the name but must be unique throughout the entire system.
Name
(Required)
A name for the preference. It is advisable to keep this unique.
Description
(Required)
A textual description of the hold reason.
Allowed for Test
Checking this box allows the hold reason to be used for placing tests on hold.
Allowed for Referral
Checking this box allows the hold reason to be used for placing a referral on hold.
Active
A checkbox to activate/deactivate a hold reason. If the hold reason is not active, it will not be able to be selected for future items but it will show for existing items.
Allowed Statuses table
The Allowed Statuses table is a list of statuses that a hold reason can have.
The statuses are made up of the following items:
Name: (Required) A name for the status.
Description: A text description of that status.
Hold Active: If checked, the item (referral or test) will be held and no progress will be taken.
Default Status: The default value when the item is placed on hold, this is the initial status which is set.
Adding an Allowed Status to the Allowed Statuses table area of a Hold Reason, can be performed using the + button. This will add a new row to the table so the information can be entered.
Deactivating/Activating
Each hold reason has an active status that specifies whether the hold reason is available for selection. When deactivating a hold reason, it will no longer appear in dropdown lists for selection, but will still be displayed on any records that continue to use it.
To deactivate (or reactivate) a hold reason, either:
- Untick the Active checkbox inside the preference and Save.
Or
- Right-click on the required entry in the table and select Toggle Active Status. Click Yes when prompted.
The state of the hold reason will then be changed to either Active or Inactive.
Usage
The Hold Reasons preference is used with the following items:
- Hold Instance - A referral can have a hold instance which has a status of the hold reason attached to it. e.g. Hold instance of ‘Awaiting Information’ and a Hold Status of either ‘Pending’ or ‘Complete’.
- Hold Reason Status - A status to set the hold reason at. e.g. Pending or Complete.