The Master Data Model for Veteran Care

Developer Documentation » VDM » Order_Dialog-101_41

Order Dialog (101.41)

This file contains the information needed to define how to prompt for each order, what values are acceptable, etc.

Global: ^ORD(101.41,

Domain: Non-Clinical

Properties

Label/Field Name Field # Description Datatype Attributes Range
Name
  name
.01 This is the name of the dialog; entries that were converted from the
Protocol file will retain the same name. Namespacing is not required,
but still encouraged.
STRING REQUIRED  
Display Text
  display_text
2 The text of this dialog’s name as it appears on a menu or subheader. STRING INDEXED  
Disable
  disable
3 This field disables use of this dialog when it contains text. The text
should be a short message explaining why use of this dialog has been
disabled, as it will be displayed if this dialog is selected.
STRING    
Type
  type-4
4 This field defines the type of order dialog to be processed. Control
will be passed to the OE/RR Dialog Processor for dialog items; menu types
are used for displaying and selecting dialog items. Action types will only
execute the entry and exit actions, ignoring any items that may exist; these
dialogs should not create entries in the Orders file.
ENUMERATION REQUIRED prompt: P
dialog: D
menu: M
order set: O
quick order: Q
action: A
Display Group
  display_group
5 This field determines what display group this dialog has been defined for.
It will define which orderable items are selectable with this dialog,
as well as what service to send the order to when it is complete.
POINTER   Display_Group-100_98
Signature Required
  signature_required
6 This field indicates what signature will be required for orders created by
this dialog, to be considered complete and ready to release to the service
for action. If this flag is set to NO and the dialog contains a prompt
for item(s) from the Orderable Item file, the order created may still
require a signature if any of the items ordered are individually flagged
as requiring a signature.
ENUMERATION   NONE: 0
ORELSE: 1
ORES: 2
Package
  package
7 This is the VISTA package that is intended to receive orders created by
this dialog; this is required for creating the HL7 messages to pass the
order.
POINTER INDEXED Package-9_4
Verify Order
  verify_order
8 This field is a flag, which determines if the order created by this dialog
will be presented to the user for verification before saving in the Orders
file; for most quick orders, this flag should be set to 0 (no).
BOOLEAN   false: 0
true: 1
Ask For Another Order
  ask_for_another_order
9 This field allows the user to add another order from this dialog, when the
initial order is accepted and placed; if set to YES, the user will be
asked “Add another order?" to allow for either
exiting the processor or adding an additional order of the same type.
This field can also be set to YES-DON'T ASK to force the processor to
automatically drop into prompting for another order without asking first.
ENUMERATION   YES: 1
YES-DON'T ASK: 2
NO: 0
Items
  items
10 This field contains the components for dialogs:
Dialogs -> prompts
Quick orders -> prompts (completed)
Order sets -> dialogs or quick orders
Menus -> dialogs, quick orders, or order sets
OBJECT   Items-101_412
Data Type
  data_type
11 This is the type of data being prompted for; this field is used to define
a call to the reader (^DIR) in most cases.
ENUMERATION   free text: F
set of codes: S
numeric: N
yes/no: Y
date/time: D
word processing: W
free text date/time: R
pointer: P
Domain
  domain
12 This is a parameter that may be used to further specify the data type.
The string stored here should be appropriate for the second ^-piece of
DIR(0) when used with the data type field.
STRING    
Id
  id-13
13 This field may contain a single word identifier which will be
stored with the user response in the Orders file #100, where it
will be indexed for quick reference to certain values in the
order dialog. The following are some examples of values
currently in use:

START -> Start date/time
STOP -> Stop date/time
SCHEDULE -> Administration Schedule
ORDERABLE -> Orderable Item
DRUG -> Dispense Drug
CANCEL -> Cancel Future Orders flag
COMMENT -> Word processing comments

These values must be unique among entries within an order dialog
but do not need to be unique across the entire file. Be sure to
check the IDs assigned to generic text entries to make sure that
all IDs are unique. In order to avoid potential problems it’s
recommended that you use unique IDs for any local entries that you
create.
STRING    
Validation
  validation
17 This is MUMPS code that will be executed at the time of releasing an
order created with this dialog; dialog responses may be checked again
here before releasing the order to the service.
STRING    
Additional Text
  additional_text
19 This is MUMPS code that will be executed when order ORIFN created by this
dialog is about to be displayed; any string that should be appended to the
order text should be returned in Y.
STRING    
Description
  description
20 This is a description of the dialog and its uses. STRING    
Responses
  responses
21 This multiple contains any responses to prompts that have been pre-answered
to create a quick order.
OBJECT   Responses-101_416
Entry Action
  entry_action
30 This is MUMPS code that will be executed at the top of a dialog, prior to
the execution of any prompts; it may perform functions such as listing
the recent Radiology exams before ordering a new one, or alerting the
user to an existing diet order before making a change.
STRING    
Quick Setup
  quick_setup
31 This is MUMPS code that will be executed in the place of the Entry Action
when creating quick orders for this dialog; variables may be set here
instead to bypass the usual dependence on specific patient values.
STRING    
Exit Action
  exit_action
40 This is MUMPS code that will be executed upon completion of processing the
dialog; it is currently used only with dialog-type entries.
STRING    
Controls
  controls
50   OBJECT   Controls-101_415
Column Width
  column_width
51 This is the width, in characters, for each column in a menu. For example,
to have 3 columns on an 80 character device, enter a width of 26.
NUMERIC    
Mnemonic Width
  mnemonic_width
52 This field allows the width of item mnemonics to be varied; the default
value is 5.
NUMERIC    
Path Switch
  path_switch
53 This switch allows the user, when traversing back UP the tree of menus and
items, to select a new path back down the tree. In other words, the menu
is redisplayed when returning to that menu’s level in the tree and
processing back down the tree is possible from that point. If nothing is
selected from the menu, the path continues back up the tree.
BOOLEAN   false: 0
true: 1
Listbox Text
  listbox_text
54   STRING    
Window Form Id
  window_form_id
55 This field tells the GUI DELPHI code which form to use to process the
order dialog. Each number represents a unique form. Following are some
of the more common codes and their corresponding form in DELPHI.

Form Name Windows Form ID
——— —————
OD_ACTIVITY 100
OD_ALLERGY 105
OD_CONSULT 110
OD_PROCEDURE 112
OD_DIET_TXT 115
OD_DIET 117
OD_LAB 120
OD_MEDINPT 130
OD_MEDS 135
OD_MEDOUTPT 140
OD_NURSING 150
OD_MISC 151
OD_GENERIC 152
OD_IMAGING 160
OD_VITALS 171
OD_MEDIV 180
OD_TEXTONLY 999
NUMERIC    
Create Parent Order
  create_parent_order
56 This flag indicates whether a parent order should be created to group
together all the orders created by this order set; this flag is only
valid with SET type order dialogs. If this value is YES, a parent
order will be created, and only the parent will be presented on the
orders list for display and action; NO will prevent a parent from being
created and all orders will be created and displayed independently.
BOOLEAN   false: 0
true: 1
Display Subheader
  display_subheader
57 This flag indicates whether a subheader is to be displayed for each order
in this set as it is processed and placed; this flag is only valid with
SET type order dialogs.
BOOLEAN   false: 0
true: 1
Auto-accept Quick Order
  autoaccept_quick_order
58 This can be set to yes for a quick order so that it can be placed simply
by clicking on it in the GUI (no ordering dialog is displayed).
BOOLEAN   true: 1
Timestamp
  timestamp
99 For menus, this contains the $H time the menu was last compiled for use
with the Unwinder utility (^XQOR).
STRING    

↑ Return to top

Sub-Files

Items (101.412)

ID
Items-101_412

Properties

Label/Field Name Field # Description Datatype Attributes Range
Sequence
  sequence
.01 This field specifies the order in which this item will be displayed or
processed.
NUMERIC INDEXED
REQUIRED
 
Input Transform
  input_transform
.1 This is code that will be used as the third piece of DIR(0) when asking
this prompt.
STRING    
Parent
  parent
1 This field controls the behavior of this prompt. If a parent is defined
here, this prompt will be asked from within the parent’s dialog; when it
is invoked independently based on its position sequence number, the child
prompt will be ignored.
POINTER   Order_Dialog-101_41
Item
  item
2 This field points to an order dialog which is subordinate to this dialog.
NOTE: The parent dialog menu or one of its ancestors may not be entered
as an item.
POINTER INDEXED Order_Dialog-101_41
Mnemonic
  mnemonic
3 This is a short abbreviation for this item dialog to be used when this
dialog is displayed for selection.
STRING    
Display Text
  display_text
4 This field allows the text that normally appears for this item to be
replaced with alternate text for use in this dialog or menu.
STRING    
Display Only?
  display_only
5 This field identifies an item as being free text for display purposes
only. The text in the Display Text field will be displayed, but it
is not selectable; if designated as a header, the text will be underlined.
ENUMERATION   YES: 1
YES-HEADER: 2
NO: 0
Required
  required
6 This field indicates that the user must enter a response to this prompt. BOOLEAN   false: 0
true: 1
Multiple Valued
  multiple_valued
7 This field determines if this prompt will be allowed to have multiple
values, or be prompted for only once; if this prompt is a sub-dialog,
the entire dialog will be asked once or many times, as a group.
BOOLEAN   false: 0
true: 1
Max Number Of Multiples
  max_number_of_multiples
7.1 This is the maximum number of values that may be entered for this prompt,
if it is flagged as being multiple-valued. For example, a diet order may
have up to 5 diet modifications entered, where 5 is the maximum allowed
that would be entered here.
NUMERIC    
Title
  title
7.2 This is text that will be used in place of the prompt when the order is
displayed for place, edit, or cancel, or at the top of a multiple-valued
prompt. The Display Text for the prompt will be used together with the
instance number to prompt for user input; for example if Title=”Lab Tests:”
and Display Text=”Test:” the user would see
Lab Tests:
1. Test:
2. Test:
STRING    
Prompt
  prompt
7.3 This field contains text that will be appended to the beginning of the
display text when prompting for additional values; if this field is
empty, then “Another “ will be used.
STRING    
Ask On Edit Only
  ask_on_edit_only
8 This field determines the behaviour of the dialog driver for this prompt;
if no value or the defined default is usually correct for this prompt,
enter YES here to have this prompt skipped on the first pass through this
dialog when creating an order.
BOOLEAN   false: 0
true: 1
Ask On Action
  ask_on_action
9 This field determines the behaviour of the dialog driver for this prompt
when taking a particular action on an order created by this dialog. If
this string contains “R”, this prompt will be asked when renewing an order;
if this string contains “C”, this prompt will be asked when changing an
order; if this string contains “W”, this prompt will be asked when
rewriting an order.
STRING    
Index
  index
10 For pointer-type prompts, this is the index to use when searching the file;
it must be in the form of a regular cross-reference. To search on multiple
indices, enter a string of index names separated by semi-colons, i.e. “B;C”.
STRING    
Help Message
  help_message
11 This field contains the help message to be presented when the user enters
a question mark at this prompt.
STRING    
Special Lookup Routine
  special_lookup_routine
12 This field contains a routine to execute that will replace the standard
DIC lookup for this prompt; it must be entered here as LINETAG;ROUTINE
using a ; instead of ^ and where LINETAG is optional.
STRING    
Ask On Condition
  ask_on_condition
13 This is MUMPS code that sets $T to determine if this prompt should be asked
or simply given a default value and presented to the user for acceptance
or editing. For example, the prompt “Pregnant: “ may have code here to
check the sex of the current patient, i.e. I ORSEX=”F” will allow it to be
asked only for female patients.
STRING    
Screen
  screen
14 For pointer-type prompts, this field may contain MUMPS code that will be
set into DIC(“S”) to screen the possible choices in the pointed-to file.
STRING    
Post-selection Action
  postselection_action
15 This is code that will be executed after a response is entered to this
prompt; if this prompt should be re-asked, kill the variable DONE.
If execution of the ordering dialog should be stopped, set ORQUIT=1.
STRING    
Xecutable Help
  xecutable_help
16 This is code that is to be executed when the user enters two or more
question marks at this prompt.
STRING    
Default
  default
17 This is code that is to be executed to determine the appropriate default
value for this prompt, setting Y=internal form of this value.
STRING    
Default Word-processing Text
  default_wordprocessing_text
18 This is default text to be stuffed into this word-processing prompt. STRING    
Entry Action
  entry_action
19 This is code that will be executed at the beginning of the processing of
this prompt, before the Default and Ask on Condition fields are executed;
any special setup required for this field should be done here.
STRING    
Exit Action
  exit_action
20 This is code that will be executed at the very end of the processing of
this prompt, after prompting and the Validation field is executed;
any special cleanup should be done here.
STRING    
Order Text Sequence
  order_text_sequence
21 This field indicates the order in which values will be concatenated
together to build the order text; this may differ from the prompting
order defined in the .01 Sequence field.
NUMERIC INDEXED  
Format
  format
22 This is a string of characters that will define any exceptions to how
the external form of this value is generated. Possible values include:
Pointer -> <field #>~<piece in RPC list of field #>, default =.01
Set of Codes -> 1~ to use code for name
Date/Time -> Format string to pass $$FMTE^XLFDT (default = 2)

Suppress value -> @
Replace value -> @ where ptr is the Dialog IEN of the prompt
whose value, when present, supersedes this value
Required value -> * where ptr is the Dialog IEN of the prompt
whose value is required to be present to include
this value
Ignore if same -> = where ptr is the Dialog IEN of the prompt
whose value, if the external form is the same,
supersedes this value
STRING    
Omit Text
  omit_text
23 This is the external form of a value that is not to be included when building
the order text. E.g. to include the urgency in the order text unless it
is routine, enter “ROUTINE” here.
STRING    
Leading Text
  leading_text
24 This field contains text that will be appended to the order text
immediately in front of this value, e.g. “Instructions:”. If this text
is contained in a variable, enter @NAME where NAME is the variable name.
STRING    
Trailing Text
  trailing_text
25 This field contains text that will be appended to the order text
immediately following this value, e.g. “refills”. If this text is
contained in a variable, enter @NAME where NAME is the variable name.
STRING    
Start New Line
  start_new_line
26 This field determines if this value is concatenated onto the current line
when building the order text, or if a new line is started with this value.
BOOLEAN   false: 0
true: 1
Word-wrap
  wordwrap
27 This field determines if this text should be wrapped when added to the
order text, or appended line by line as stored in the file; this is only
used for word-processing type prompts.
ENUMERATION   DON'T WRAP: 1
WRAP: 0
Windows Control
  windows_control
101 Stores the type of Windows control necessary to get the data for this
prompt.
STRING    
Api Name
  api_name
102 This is the API that should be called when the control is used. How the API
is used varys with the control. Examples are: filling list boxes, getting
boilerplate text, etc.
STRING    
Api Parameter #1
  api_parameter_number1
103 A parameter that is used by the API call may be stored here. STRING    
Windows Condition
  windows_condition
113 This is silent code that is executed when building the dialog for windows.
It identifies which prompts should be included in the dialog. The condition
should leave $T false if the prompt should not be asked.
STRING    
Windows Default
  windows_default
117 This code should silently set the default value of a prompt when it is
selected.
STRING    

↑ Return to top

Responses (101.416)

ID
Responses-101_416

Properties

Label/Field Name Field # Description Datatype Attributes Range
Item Entry
  item_entry
.01 This is the internal entry number of the prompt in the Item multiple
by which this response was obtained.
NUMERIC REQUIRED  
Dialog
  dialog
.02 This is a pointer to the dialog prompt, which is in the Order Dialog file
as type prompt.
POINTER INDEXED Order_Dialog-101_41
Instance
  instance
.03 In the case of multiple answers for the same item, this identifies the
individual instance.
NUMERIC    
Value
  value
1 This contains the actual response, unless the value is a word processing
type.
STRING    
Text
  text
2 This contains the actual response, for word-processing type prompts. STRING    

↑ Return to top

Controls (101.415)

ID
Controls-101_415

Properties

Label/Field Name Field # Description Datatype Attributes Range
Logical Name
  logical_name
.01 This is the name by which controls can refer to each other. STRING INDEXED
REQUIRED
 
Item
  item
2   POINTER   Order_Dialog-101_41
Create Sequence
  create_sequence
3   NUMERIC INDEXED  
Control Type
  control_type
4   ENUMERATION   LongCombo: 7
Edit: 2
Button: 1
Label: 0
SimpleCombo: 5
ListBox: 4
Memo: 3
DropDownList: 6
Label
  label-5
5   STRING    
Beside
  beside
6   STRING    
Below
  below
7   STRING    
Width
  width
8   NUMERIC    
Left Control
  left_control
9   STRING    
Right Control
  right_control
10   STRING    
Height
  height
11   NUMERIC    
Upper Control
  upper_control
12   STRING    
Lower Control
  lower_control
13   STRING    
Tab Sequence
  tab_sequence
14   NUMERIC    

↑ Return to top


Document generated on August 31st 2017, 2:55:41 pm