Global: ^DIC(19

Each option must be preceded by its package prefix (a 2-4 character) code specified in the PACKAGE file, or the letter "Z" or "A".

1)= S ^DIC(19,"B",$E(X,1,30),DA)=""

2)= K ^DIC(19,"B",$E(X,1,30),DA)

1)= X ^DD(19,.01,1,2,1.3) I X S X=DIV S Y(1)=$S($D(^DIC(19,D0,0)):^(0),1:"") S X=$P(Y(1),U,5),X=X S DIU=X K Y S X=DIV S X=DUZ X ^DD(19,.01,1,2,1.4)

1.3)= K DIV S DIV=X,D0=DA,DIV(0)=D0 S Y(0)=X S Y(1)=$S($D(^DIC(19,D0,0)):^(0),1:"") S X=$S('$D(^VA(200,+$P(Y(1),U,5),0)):"",1:$P(^(0),U,1))=""

1.4)= S DIH=$S($D(^DIC(19,DIV(0),0)):^(0),1:""),DIV=X X "F %=0:0 Q:$L($P(DIH,U,4,99))  S DIH=DIH_U" S %=$P(DIH,U,6,999),DIU=$P(DIH,U,5),^(0)=$P(DIH,U,1,4)_U_DIV_$S(%]"":U_%,1:""),DIH=19,DIG=3.6 D ^DICR:$O(^DD(DIH,DIG,1,0))

>0

2)= Q

3)= This trigger is used to record the user who created this option.

CREATE CONDITION)= CREATOR=""

CREATE VALUE)= S X=DUZ

DELETE VALUE)= NO EFFECT

FIELD)= CREATOR

This trigger is used to record the user who created this option at the time that the name was created.

This field will be set to '1' if the option has an entry action.

WRITE AUTHORITY:  ^

1)= D REDO^XQ7

2)= D REDO^XQ7

This cross-reference causes the option to be flagged for updating in the menu trees so that the changes effecting display and/or access to the option are correctly updated.

This field will be set to '1' if this option has a reverse key assigned to it.

WRITE AUTHORITY:  ^

This field is set to 1 by a trigger on field #26 when MUMPS code is entered into it.

WRITE AUTHORITY:  ^

The name as the option as it will be displayed to the user within the menu system.  ** The 'C' X-ref has been moved to the uppercase field. **

1)= Q  ;The C X-ref has been moved to field 1.1

2)= Q

3)= This is a null cross-reference used to overwrite the previous x-ref which set the uppercase text.

This is a null cross-reference used to over-write the previous x-ref.

1)= I $P(^DIC(19,DA,0),U,4)="O"!($P(^(0),U,4)="Q") S ^DIC(19,"AOR",X,DA)=""

2)= K ^DIC(19,"AOR",X,DA)

This sets the "AORK" cross-reference on the file if the option type is either a protocol or a protocol menu.

1)= D REDO^XQ7

2)= D REDO^XQ7

This cross-reference causes the option to be flagged for updating in the menu trees so that the changes effecting display and/or access to the option are correctly updated.

1)= K DIV S DIV=X,D0=DA,DIV(0)=D0,DIU=$P($G(^DIC(19,D0,"U")),U) K Y X ^DD(19,1,1,4,1.1) X ^DD(19,1,1,4,1.4)

1.1)= S X=$E(DIV,1,30),X=$TR(X,"abcdefghijklmnopqrstuvwxyz","ABCDEFGHIJKLMNOPQRSTUVWXYZ"),Y(1)=X

1.4)= S DIH=$S($D(^DIC(19,DIV(0),"U")):^("U"),1:""),DIV=X S $P(^("U"),U,1)=DIV,DIH=19,DIG=1.1 D ^DICR:$O(^DD(DIH,DIG,1,0))>0

2)= K DIV S DIV=X,D0=DA,DIV(0)=D0 S Y(1)=$S($D(^DIC(19,D0,"U")):^("U"),1:"") S X=$P(Y(1),U,1),X=X S DIU=X K Y S X="" X ^DD(19,1,1,4,2.4)

2.4)= S DIH=$S($D(^DIC(19,DIV(0),"U")):^("U"),1:""),DIV=X S $P(^("U"),U,1)=DIV,DIH=19,DIG=1.1 D ^DICR:$O(^DD(DIH,DIG,1,0))>0

3)= This X-ref Triggers the UPPERCASE MENU TEXT field.

CREATE VALUE)= $E(UPPERCASE(MENU TEXT),1,30)

DELETE VALUE)= @

FIELD)= UPPERCASE

This X-ref triggers the UPPERCASE MENU TEXT field that builds the C cross-reference. It is also used by the menu system to build the compiled menus.

WRITE AUTHORITY:  ^

1)= S ^DIC(19,"C",$E(X,1,30),DA)=""

2)= K ^DIC(19,"C",$E(X,1,30),DA)

3)= Used by the Menu system

This field builds the UPPERCASE menu text C X-ref.

This field is used to temporarily disable an option. If it is filled in, the message here will be displayed whenever the user attempts to select the option.

1)= D REDO^XQ7

2)= D REDO^XQ7

This cross-reference causes the option to be flagged for updating in the menu trees so that the changes effecting display and/or access to the option are correctly updated.

This field is used to deny access to users which have this option as part of their menu. If an option has a lock, then only users which hold the matching key can access it.

1)= D REDO^XQ7

2)= D REDO^XQ7

This cross-reference causes the option to be flagged for updating in the menu trees so that the changes effecting display and/or access to the option are correctly updated.

This field may contain a pointer to the Key File.  If it does, the user may not access this option if he or she holds that key.

1)= K DIV S DIV=X,D0=DA,DIV(0)=D0 S Y(1)=$S($D(^DIC(19,D0,0)):^(0),1:"") S X=$P(Y(1),U,16),X=X S DIU=X K Y S X=DIV S X="1" X ^DD(19,3.01,1,1,1.4)

1.4)= S DIH=$S($D(^DIC(19,DIV(0),0)):^(0),1:""),DIV=X S $P(^(0),U,16)=DIV,DIH=19,DIG=.16 D ^DICR:$O(^DD(DIH,DIG,1,0))>0

2)= K DIV S DIV=X,D0=DA,DIV(0)=D0 S Y(1)=$S($D(^DIC(19,D0,0)):^(0),1:"") S X=$P(Y(1),U,16),X=X S DIU=X K Y S X="" S DIH=$S($D(^DIC(19,DIV(0),0)):^(0),1:""),DIV=X S $P(^(0),U,16)=DIV,DIH=19,DIG=.16 D ^DICR:$O(^DD(DIH,DIG,1,

0))>0

CREATE VALUE)= "1"

DELETE VALUE)= @

FIELD)= REV KEY PRESENT

Trigger to set a value of 1 into field .16 if a reverse key is present on this option.

1)= D REDO^XQ7

2)= D REDO^XQ7

This cross-reference causes the option to be flagged for updating in the menu trees so that the changes effecting display and/or access to the option are correctly updated.

This field contains a brief explanation of the particular option.  It will be displayed in the menu system to the user when '???' are entered to the selection choice of the parent menu.

This field defaults to the DUZ of the user who originally set up this option.

WRITE AUTHORITY:  ^

This field contains a pointer to the help text which describes this option.  The help text is displayed to the user on entering '?OPTION'.

1)= S ^DIC(19,"AC",$E(X,1,30),DA)=""

2)= K ^DIC(19,"AC",$E(X,1,30),DA)

This regular cross-reference provides a look-up by Help Frame internal entry number for those options referencing the desired help frame.

1)= D REDO^XQ7

2)= D REDO^XQ7

This cross-reference causes the option to be flagged for updating in the menu trees so that the changes effecting display and/or access to the option are correctly updated.

If this field is null, the option will run at the current priority, otherwise, priorities range from 1-10, a low number indicating lower priority. The priority is in effect while the current option is being executed.

1)= D REDO^XQ7

2)= D REDO^XQ7

This cross-reference causes the option to be flagged for updating in the menu trees so that the changes effecting display and/or access to the option are correctly updated.

This specifies a time range during which this option cannot be accessed.  The time should be entered in military format. For example, to prohibit an option from running between 9 AM and 2 PM, enter 0900-1400.

1)= D REDO^XQ7

2)= D REDO^XQ7

This cross-reference causes the option to be flagged for updating in the menu trees so that the changes effecting display and/or access to the option are correctly updated.

This subfile may contain dasy and time during which this option may not be envoked.  This subfile replaces field 3.9, Prohibited Times, in the 0th node of the Option File.

and times included in this file.

This field will contain a '1' if output from this option is restricted to certain days and times.

WRITE AUTHORITY:  ^

This indicates whether the option is allowed to run on selected devices only.  If this field contains a 'y', the option will be enabled only for the devices entered in the field 'PERMITTED DEVICE.'

1)= D REDO^XQ7

2)= D REDO^XQ7

This cross-reference causes the option to be flagged for updating in the menu trees so that the changes effecting display and/or access to the option are correctly updated.

This subfile may contain a list of devices upon which this option is permitted to run.

fields in the options file are filled in depending on the type.  There are several fields that will tell a print-type option what to print and how to print it, for example.  These same fields may be meaningless to another

options type.

1)= I X="O"!(X="Q") S ^DIC(19,"AOR",$P(^DIC(19,DA,0),U,2),DA)=""

2)= K ^DIC(19,"AOR",$P(^DIC(19,DA,0),U,2),DA)

This sets the "AOR" cross-reference on the file if the option type is either a protocol or a protocol menu.

1)= D REDO^XQ7

2)= D REDO^XQ7

This cross-reference causes the option to be flagged for updating in the menu trees so that the changes effecting display and/or access to the option are correctly updated.

This field points to the descendent options of this menu.

This field contains a short version of the Menu Text field (field # 1) for use with multi-column displays.  It is a mandatory field.

This field controls the action of the Menu system if the user has automenu turned on.  If this field is set then the menu system will stop and ask 'Press return to continue'. before showing the menu again.

This field indicates the package with which this option is associated.

If this field is marked 'no' in the option file then the XQSMD software will not delegate this option to a user.

This field will contain a '1' if the option has an entry action in field #20.

WRITE AUTHORITY:  ^

1)= D REDO^XQ7

2)= D REDO^XQ7

This cross-reference causes the option to be flagged for updating in the menu trees so that the changes effecting display and/or access to the option are correctly updated.

This field contains mumps code which will be executed on leaving this option.  It is applicable to all option types.

WRITE AUTHORITY:  @

1)= K DIV S DIV=X,D0=DA,DIV(0)=D0 S Y(1)=$S($D(^DIC(19,D0,0)):^(0),1:"") S X=$P(Y(1),U,15),X=X S DIU=X K Y S X=DIV S X="1" X ^DD(19,15,1,1,1.4)

1.4)= S DIH=$S($D(^DIC(19,DIV(0),0)):^(0),1:""),DIV=X S $P(^(0),U,15)=DIV,DIH=19,DIG=.15 D ^DICR:$O(^DD(DIH,DIG,1,0))>0

2)= K DIV S DIV=X,D0=DA,DIV(0)=D0 S Y(1)=$S($D(^DIC(19,D0,0)):^(0),1:"") S X=$P(Y(1),U,15),X=X S DIU=X K Y S X="" S DIH=$S($D(^DIC(19,DIV(0),0)):^(0),1:""),DIV=X S $P(^(0),U,15)=DIV,DIH=19,DIG=.15 D ^DICR:$O(^DD(DIH,DIG,1,

0))>0

CREATE VALUE)= "1"

DELETE VALUE)= @

FIELD)= X AC

This trigger sets the value 1 into field .15 when a value is entered on the current field.  This permits identification of the presence of an exit action without having to determine whether a node 15 exists or not.

for instance, it is NOT executed.  See Header field (field # 26).

WRITE AUTHORITY:  @

1)= K DIV S DIV=X,D0=DA,DIV(0)=D0 S Y(1)=$S($D(^DIC(19,D0,0)):^(0),1:"") S X=$P(Y(1),U,14),X=X S DIU=X K Y S X=DIV S X="1" X ^DD(19,20,1,1,1.4)

1.4)= S DIH=$S($D(^DIC(19,DIV(0),0)):^(0),1:""),DIV=X S $P(^(0),U,14)=DIV,DIH=19,DIG=14 D ^DICR:$O(^DD(DIH,DIG,1,0))>0

2)= K DIV S DIV=X,D0=DA,DIV(0)=D0 S Y(1)=$S($D(^DIC(19,D0,0)):^(0),1:"") S X=$P(Y(1),U,14),X=X S DIU=X K Y S X="" S DIH=$S($D(^DIC(19,DIV(0),0)):^(0),1:""),DIV=X S $P(^(0),U,14)=DIV,DIH=19,DIG=14 D ^DICR:$O(^DD(DIH,DIG,1,0

))>0

CREATE VALUE)= "1"

DELETE VALUE)= @

FIELD)= E ACT

This trigger sets the value 1 into field 14 when a value is entered on the current field.  This permits identification of the presence of an entry action without having to determine whether a node 20 exists or not.

Menu System will not attempt to return the user to their previous option, but leave the user at the present stack location.  In the case of jumps, the user may be returned to an option that is quite far away if XQNOBACK is

not defined.  Obviously, the problem that resulted in an XQUIT should first be solved before XQNOBACK is set.

If there is no code in this field the default is to return the user to their previous option.

WRITE AUTHORITY:  @

Indicate the name of the routine, e.g. ROUTINE, or TAG^ROUTINE.

executed when envoking an option from above, and not when backing up into it.

1)= K DIV S DIV=X,D0=DA,DIV(0)=D0 S Y(1)=$S($D(^DIC(19,D0,0)):^(0),1:"") S X=$P(Y(1),U,17),X=X S DIU=X K Y S X=DIV S X="1" X ^DD(19,26,1,1,1.4)

1.4)= S DIH=$S($D(^DIC(19,DIV(0),0)):^(0),1:""),DIV=X S $P(^(0),U,17)=DIV,DIH=19,DIG=.26 D ^DICR:$O(^DD(DIH,DIG,1,0))>0

2)= K DIV S DIV=X,D0=DA,DIV(0)=D0 S Y(1)=$S($D(^DIC(19,D0,0)):^(0),1:"") S X=$P(Y(1),U,17),X=X S DIU=X K Y S X="" S DIH=$S($D(^DIC(19,DIV(0),0)):^(0),1:""),DIV=X S $P(^(0),U,17)=DIV,DIH=19,DIG=.26 D ^DICR:$O(^DD(DIH,DIG,1,

0))>0

CREATE VALUE)= "1"

DELETE VALUE)= @

FIELD)= #.26

This trigger sets the field HEADER PRESENT to '1' when there is mumps code in the field HEADER.  HEADER PRESENT is carried as a flag in the 0th node of each option.

Used in conjunction with EDIT and INQUIRE type options to lookup an entry.  for use.  The global reference of the file to be used in lookup (without the '^').  For example: DPT(

A = Ask and reask entry

C = Cross reference suppression is turned off

E = Echo back the entry

F = Forget storing the lookup value (for space bar recall)

I = Ignore any special lookup program

L = Learning (LAYGO - adding a new entry) allowed

M = Look up entry using all available indexes

N = Allow internal entry number as input

O = Look up an entry in the old way

Q = Question input if match not found

X = Exact match of input required

Z = Zero entry node returned in variable Y(0) and

the external value of the .01 field in Y(0,0)

Example:     DIC(A)="Please enter patient name: "

Would display to user -  Please enter patient name:

Rather than the usual -  Select PATIENT NAME:

Example:   DIC(B)="JONES,JOHN"

Would produce the display - Select PATIENT NAME: JONES,JOHN//

Rather than the usual display - Select PATIENT NAME:

code produces a truth value of 1.  For example:

DIC(S)=I $P(^(0),U,2)="M" allows only males to be selected if the second piece of the entry's zero node contained an 'M' for Male or 'F' for Female.

WRITE AUTHORITY:  @

Example:  DIC(W)=W:$D(^(.1)) "Patient is currently on ward ",^(.1)

produces the display - JONES,JOHN  Patient is currently on ward 2SE

NOTE:  This will override identifier displays.

WRITE AUTHORITY:  @

example:  D.=C Would only check for user input against the "C" cross-reference.  If DIC(0) contains an "M" meaning multi-index look-up, then this value will be used as a starting point for the multi-index look-up.  To

restrict the look-up only to a single index then DIC(0) must NOT contain an "M".

This field contains the name of the form from the Form File enclosed in square brackets, e.g., "[MYFORM]".

This is the root of the file being edited or displayed entered without the up-arrow, e.g., "DIC(19,".

This is the global root of the subfile being edited or displayed.

This optional variable contains the page number of the first page to display to the user when the ScreenMan form is invoked.  If this variable is not defined, then by default the first page the user sees is Page 1.

C   Return the variable DDSCHANG=1 if ScreenMan detects that the user

saved a Change to the database.

E   Return Error messages in ^TMP("DIERR",$J) and return DIERR if

ScreenMan encounters problems when initially trying to load the form.

If DDSPARM does not contain an "E", ScreenMan prints messages

directly on the screen, and returns the variable DIMSG equal to null.

S   Return the variable DDSSAVE=1 if the user pressed S or E,

or entered an "Exit" or "Save" command from the Command Line, whether

or not any changes were actually made on the form.

example:  DPT(

example:

.01;.03;3;.351

or

[INPUT TEMPLATE NAME]

out of the edit but not be allowed to jump to other fields.  If an 'BACK' is entered, you may jump to a previously edited field but not entirely out.  If an 'BACKOUTOK' is entered, you may jump back to previously edited

fields and up-arrow (^) to exit.  If no entry is in this field, you may jump to other fields or up-arrow (^) out of the entire edit process.

Enter a WRITE statement in this field and the WRITE statement will be used instead of VA FileMan's regular prompt for the field being edited.

WRITE AUTHORITY:  @

example: DPT(

page 1 is assumed.

the user will be asked for sort ranges, print fields and header.

example:

.01;"PATIENT NAME";C1,.02,.1

or

[PRINT TEMPLATE NAME]

Example:

'.1,.01

or

[SORT TEMPLATE NAME]

Example:

2NE,SMITH

(if sort fields were ward & name, start with ward 2NE and patient SMITH)

example:

2NE,SMITH

(If sort fields were ward & name, end sort after ward  2NE and patient SMITH)

Used in the PRINT type option.  Enter the free text heading you want printed as the header of your output.  (Do not include quotes in your header)

Used in the PRINT type option. The number of copies desired.  SDP space must be available on your system for this option.

the entry to be printed.) At the time the code is executed, the internal entry number (IEN) of the entry is stored in the variable D0.

For example, the following would print patients who were NOT born in the 1970's:

DIS(0)=I $P(^DPT(D0,0),U,3)<2700101!($P(^(0),U,3)>2791231)

If used in conjunction with fields DIS(1), DIS(2), and DIS(3), the entry will print if DIS(0) and DIS(1) are true, OR if DIS(0) and DIS(2) are true, OR if DIS(0) and DIS(3) are true.

Note: You may have DIS(0) only, or DIS(0) in combination with DIS(1) only, or DIS(1) and DIS(2), or DIS(1), DIS(2), and DIS(3).

WRITE AUTHORITY:  @

pointed to by D0 should be printed. See the description of D(0) (field #69) for more information.

WRITE AUTHORITY:  @

pointed to by D0 should be printed. See the description of D(0) (field #69) for more information.

WRITE AUTHORITY:  @

pointed to by D0 should be printed. See the description of D(0) (field #69) for more information.

WRITE AUTHORITY:  @

The default output device.  Enter a valid Device Name or "HOME" to mean output will always go to the home device.

Used in the PRINT type option.  Enter a string of MUMPS code that will be executed for every entry after all the fields specified in FLDS have been printed.

WRITE AUTHORITY:  @

Used in the PRINT type option.  Enter a string of MUMPS code that will be executed before the printout starts.

WRITE AUTHORITY:  @

Used in the PRINT type option.  Enter a string of MUMPS code that will be executed after the printout has finished but before returning to the calling program.

WRITE AUTHORITY:  @

subscript to sort through is an internal entry number (record number) for the file being printed.  This variable should contain the static part of a cross-reference or an open global reference, without the leading

up-arrow.  Or, if printing from a list of search results, the variable should contain the name of a search template surrounded by square brackets.  Ex.:

BY(0) = TMP("ZZTEST",$J,

BY(0) = DIZ(662001,"AC",

BY(0) = [ZZSEARCH]

If this field is not null, set BY(0) equal to its contents before calling EN1^DIP.  If it is not null, field L(0) should also be set.

WRITE AUTHORITY:  ^

1 for the record number itself.  For example, if BY(0) defines a regular cross-reference, L(0)=2 (1 for the cross-referenced field value, and 1 for the record number, D0).  If sorting through a list of record numbers in

^TMP($J,D0), L(0)=1 (1 for the record number, D0).

This field is checked ONLY if BY(0) is set, and is REQUIRED if BY(0) is set.  If this field is not null, set L(0) equal to the contents before calling EN1^DIP.

WRITE AUTHORITY:  ^

Sort FROM criteria associated with the subscripts defined by the BY(0) input variable.

WRITE AUTHORITY:  ^

Sort TO criteria associated with the subscripts defined by the BY(0) input variable.

WRITE AUTHORITY:  ^

WRITE AUTHORITY:  ^

variable is set to 1, that print of the header will be suppressed and nothing will print.

Set DISUPNO to the contents of this field before calling either EN1^DIP or ENS^DIS. It is OK to set DISUPNO to this field even if it is null.

When set to 1, causes SEARCH or SORT criteria to print in the heading of the first page of a report, along with the standard header.  If called from SEARCH option, both SEARCH and SORT criteria print.

Set DIPCRIT to the contents of this field before calling EN1^DIP.  It is OK to set DIPCRIT to this field, even if it is null.

If this field is set to '1' then the variable DIASKHDR will be defined when FileMan is called to print.  The user will then be prompted for a header for the report.

template name can be enclosed in square brackets but the brackets are not required.  Note that if there are already search results on the template, they will be replaced by a new list of search results when this option is

run.

variables that would be set up if doing a normal FileMan PRINT.

example: DPT(

can be delimited by a semi-colon or a range of subscripts may be used delimiting the starting subscript and ending subscript with a colon.

NOTE: Field security is not matched against user access for this option.  Data will be displayed regardless of user READ access to those fields.

example:  DR {DIQ}=0;.1

Would display any fields whose global location was in either global node 0 or global node .1

If this field is set to "C", computed fields will be displayed.

This field contains the timestamp for when the option was created.

WRITE AUTHORITY:  ^

This field contains the timestamp of when this primary menu tree was rebuilt.

WRITE AUTHORITY:  ^

WRITE AUTHORITY:  @

WRITE AUTHORITY:  @

WRITE AUTHORITY:  @

If this field is NO then this option requires that some option or action has been done before it can be called.  If this field is YES then this option can be invoked at any time.  It is up to the developer to set this

field.

The MENU system doesn't look at this at any time.

This field is OBSOLETE,  Please use the new Option scheduling File.

1)= Q

2)= Q

This field and X-ref are beening replaced part of a package install) to set or remove the option as a task queued for the specified time.

This field is OBSOLETE,  Please use the new Option scheduling File.

1)= Q

2)= Q

This field is OBSOLETE,  Please use the new Option scheduling File.

%)

This field is OBSOLETE,  Please use the new Option scheduling File.

1)= Q

2)= Q

This field and X-ref beening replaced.  part of a package install) for the option as a queued task.

This field should be filled in by developers to allow reports of options that a site should consider seting up for background scheduling.

Normal options don't need to set this field.

This field may contain a pointer to the bulletin which will override the default bulletin XQSERVER for a server-type option.  This bulletin will be usedto notify the users in the event of a security breach, etc.

A set of codes which tell the menu system what to do when a request for this server option is received from the mail system.

This field amy contain a pointer to the Mail Group file.  This mail group will be notified in the even of a security breach etc. when a server-type option is envoked.

User (Postmaster), 4. Device (none), 5. Job #, 6. Date/time of exit from the option, 7. CPU, 8. Request result (error message, "task completed normally", etc.

fired off.

will be transmitted only in the event that an error was trapped during the attemp to run a server option, Entry or Exit Actions, or the routine associated with a server option.

If there is a 1 in this field or if this field is null, then the server request message is saved in a mailbox for the Postmaster that is named "S."option_name.

field 226 which allows you to save the server message in a Postmaster mailbox.

This field contains a pointer to the Remote Procedure file for an RPC registered to this option.

This field will have a value only if the Option is a 'high-level' menu Option, which could be assigned to a typical user.  For example, the value of this field might be "PHARMACIST", or "ADMISSIONS CLERK"

commas.  i.e. DUZ,DTIME,DT

This list is used as the indirect argument to a NEW command.

This field is OBSOLETE,  Please use the new Option scheduling File.

1)= Q

2)= Q

This cross-reference causes the updating of the option as a startup option to be started when the system is started.