Image Viewer > Basic Viewing > Hanging Protocols

Creating a Hanging Protocol

In order to use hanging protocols, you must first create a protocol for each type of study you wish to view. A protocol is created by "capturing" information about the state of the viewer. To create a protocol, do the following:

1.	Open a study that is representative of the type of study for which you would like to create a protocol.

2.	Adjust the image box layout to the preferred dimensions (e.g. 1x2, 2x2...) and populate each image box with the preferred display set.

3.	Adjust image orientation, window/level and invert state, and image sort order, as desired.

4.	Click the Hanging Protocols button on the viewer toolbar to open the Hanging Protocol (HP) Designer.

5.	On the Protocols toolbar in the HP Designer, click the New Protocol button. This creates a new protocol which captures the state of the active viewer workspace. Note that the protocol is given a default name based on the DICOM Modality and Study Description tags from the primary study.

Applying a Hanging Protocol to a study

Typically, you don't need to take any action to apply a hanging protocol. When a study is opened, the viewer will look for any applicable protocols and automatically apply the most applicable [see Protocol Applicability for more on protocol applicability]. All applicable protocols will be listed in the Hanging Protocols drop-down on the viewer toolbar, ordered by applicability such that the most applicable protocol appears at the top of the list. A check-mark is displayed beside the protocol that is currently applied. You can manually apply a different protocol by selecting another item in this list [see Navigating Protocols and Layouts].

An indicator is displayed on the toolbar icon if you have not yet viewed all layouts in the currently applied protocol. Additionally, you will be notified If you try to close the study before having viewed all layouts.

Note

•	You can disable the automatic application of hanging protocols through the Tools > Preferences > Layout > Hanging Protocols configuration page by ensuring the check box labeled Automatically apply hanging protocols when a study is opened in the viewer is not checked.

•	You can also disable the unviewed layouts notification from the same configuration page by clearing the Prompt me when closing a study without having viewed all layouts checkbox.

Creating and updating Layouts

Notice that when you create a new protocol, a Default Layout entry, captured from the current state of the viewer, is automatically added to the Layouts list in the HP designer. The layout is where the instructions regarding image box configuration, the display set to be shown in each image box, and other aspects of the presentation intent (like Window/Level and Orientation), are stored. A protocol can have more than one associated layout, and you can navigate between layouts during reading.

To add an additional layout to an existing protocol:

1.	Select the protocol in the Protocols list in the HP designer.

2.	Follow steps 1-3 in the Creating a Hanging Protocol section to configure the workspace as desired.

Click the Capture to new Layout button on the Layouts toolbar in the HP designer. Like the New Protocol button, this button will capture the state of the active viewer workspace, but rather than create a whole new protocol, it will add a new layout (named Layout 2 by default) to the selected protocol.

To update an existing layout from the state of the workspace:

1.	Select the layout that you wish to update in the Layout list in the HP designer.

2.	Follow steps 1-3 in the Creating a Hanging Protocol section to configure the workspace as desired.

3.	Click the Capture to selected Layout button on the Layouts toolbar in the HP designer. This captures the state of the active workspace to the currently selected layout, overwriting any information that was previously stored in that layout.

Reordering Layouts

If a protocol has multiple layouts, you can adjust the ordering of these layouts using the HP designer. Layout ordering determines the order in which layouts are cycled through during reading. To re-order layouts:

1.	Select a layout in the Layouts list in the HP designer.

2.	Use the Move Layout Up or Move Layout Down buttons on the Layouts toolbar to change the position of the selected layout.

Navigating Protocols and Layouts during reading

When a study is opened, all applicable protocols will be listed in the Hanging Protocols drop-down on the viewer toolbar, ordered by applicability, such that the most applicable protocol appears at the top of the list. A check-mark is displayed beside the protocol that is currently applied. The first entry in the list is automatically applied by the viewer, and you can manually apply a different protocol by selecting another item in the list.

When a protocol is applied, its first layout is applied to the workspace. Use the Next Layout button on the viewer toolbar to advance to the next layout in the protocol. Pressing Next Layout on the last layout in the protocol will cycle around to the first layout.

Note that an analogous Previous Layout button is also available, however it is hidden by default. To make it visible, go to Tools > Customize and enable the Previous Layout entry.

You can also use the Next Layout drop-down on the viewer toolbar to go directly to a given layout.

Residual Layouts

You may notice that additional layout entries appear in the Next Layout drop-down list, with names like Residual Layout 1. These additional layouts, known as residual layouts, are created dynamically by the viewer, with the goal of ensuring that all images in a study are visible in at least one layout in a protocol. This is a safety feature - it helps to ensure that use of the Hanging Protocols feature does not inadvertently hide any images during reading.

Note

•	You can disable the creation of residual layouts through the Tools > Preferences > Layout > Hanging Protocols configuration page by u-checking the check box labeled Append residual layouts for unmatched display sets from primary study.

Importing and Exporting protocols

When you create a hanging protocol, the viewer stores it as part of your user profile. The HP designer allows you to export a protocol from your user profile to a file, or import a protocol from a file to your user profile. This may be useful, for example, if you would like to share a protocol with a colleague.

To export a protocol:

1.	Select the protocol you would like to export in the Protocols list.

2.	Click the Export Protocol button. When prompted, choose a file name to save your protocol as.

To import a protocol:

1.	Click the Import Protocol button. Choose the file that you would like to import.

2.	If the file contains a protocol that already exists in your user profile (i.e. a protocol that was originally exported from your user profile), you will be asked if you want to overwrite the existing protocol, or import the file as a new protocol.

Viewing non-applicable protocols

By default, the Protocols list in the HP designer shows only those protocols that are applicable to the study that is open in the currently active viewer workspace. In some cases, it may be useful to see protocols that aren't applicable to the currently active study. To do so:

1.	Click the Show non-applicable protocols button on the Protocols toolbar in the HP designer.

2.	Note that the protocol list now shows all the protocols you have defined, regardless of whether they are applicable to the current study or not.

3.	Note that a search box appears on the toolbar next to the button. Typing in this box allows you to search for a specific protocol by name.

4.	Click the Show non-applicable protocols button again to revert back to the default mode.