Request templates in the new Question Engine infrastructure use

advertisement

Question Engine Editor Control

Requirements Document

Change Log

Version Changed By

0.1 Melanie Davies

Reviewed By

Name

Associated Documents

Date

10/2/2015

Date

Change

Created

Contents

Background ................................................................................................................................................... 1

Change Requested ........................................................................................................................................ 2

Use Cases and Flow ....................................................................................................................................... 2

Location of Change ....................................................................................................................................... 2

Dependencies................................................................................................................................................ 3

Screen Mockups ............................................................................................................................................ 4

Texts .............................................................................................................................................................. 6

Access Control Impact ................................................................................................................................... 7

Background

Request templates in the new Question Engine infrastructure use the common user interface for all requests. This interface includes the ability to add criteria groups to the request and a description of how criteria groups and terms within criteria groups function. This functionality and information are not applicable for all request types. For example, Summary Table queries may not use >1 criteria group.

1

Similarly, File Distribution, Modular Program Distribution, and SQL Distribution requests do not use criteria groups or combinations of terms.

Change Requested

Create separate UIs for different request types

The following UIs should be created for the following request types:

Flexible Menu-Driven Query

See Figure 1 below. No change from current interface – the buttons to add additional criteria groups and

the informational text describing how criteria groups function are present.

Pre-set Query

See Figure 2 below. The buttons to add additional criteria groups and the informational text describing

how criteria groups function are removed. Note that in the example below, the term menu is present.

There will be a separate improvement to provide a way to hide the term menu. This provides the flexibility to create pre-set queries with or without optional terms (e.g. for an ICD-9 Diagnosis Summary

Table, the user may pick from the 3-, 4-, or 5-digit ICD-9 Diagnosis term).

File Upload

See Figure 3 below. The buttons to add additional criteria groups, the informational text describing how

criteria groups function, and the Report Selector area are removed. Only the file upload controls are displayed.

Add the ability to specify the UI for a request template

A “Composer Interface” dropdown menu will be added to the Query Composer template screen. This menu will contain the three options specified above:

-

-

-

Flexible Menu-Driven Query

Pre-Set Query

File Upload

Use Cases and Flow

1.

2.

Network Administrator creates a new request template.

Network Administrator selects a composer interface from the composer interface dropdown.

3.

4.

5.

6.

Network Administrator continues creating the request template and saves it.

Network Administrator creates a new request type and selects the new request template.

Network Administrator makes the new request type available for use within a project.

Investigator selects the new request type. When they reach the request composer stage in the workflow for that request type, they see the composer interface for the request.

Location of Change

Query Composer Template Screen

Add “Composer Interface” dropdown

2

Request composition screen

Display composer interface based on the value selected for the request template.

Dependencies

None

3

Screen Mockups

Figure 1 – Flexible Query Request Editor

4

Figure 2 – Preset Query Request Editor

5

Figure 3 – File Upload Request Editor

Texts

None

Figure 4 – Composer Interface dropdown on Query Composer Templates screen

6

Access Control Impact

None

7

Download