STANDARD DATA DICTIONARY #9.8 -- ROUTINE FILE 6/27/25 PAGE 1
STORED IN ^DIC(9.8, (31389 ENTRIES) SITE: WWW.BMIRWIN.COM UCI: VISTA,VISTA (VERSION 8.0)
DATA NAME GLOBAL DATA
ELEMENT TITLE LOCATION TYPE
-----------------------------------------------------------------------------------------------------------------------------------
This file is used to document system routines. Parameters and entry points may be described. When running %INDEX, some fields
will be given values as the %INDEX verification tool locates variables, globals, and routine references. When using the %Z editor,
the Edit History multiple will be filled in with date, device, user, and UCI. The %ZOSF("TEST") node may be executed, checking $T,
to determine whether a routine listed in this file exists in the current account. This file is cross-referenced by name.
DD ACCESS: #
WR ACCESS: #
DEL ACCESS: #
LAYGO ACCESS: #
APPLICATION GROUP(S): XU
CROSS
REFERENCED BY: NAME(B)
LAST MODIFIED: AUG 15,2019@16:23:40
9.8,.01 NAME 0;1 (Required)
INPUT TRANSFORM: D CHKNAME^XQ5 K:$L(X)>16!($L(X)<1)!'(X?.UN!(X?1"%".UN)) X
LAST EDITED: OCT 03, 1985
HELP-PROMPT: Please enter the NAME (1-16 characters), e.g. DIC, XM, ...
DESCRIPTION:
The name of the PACKAGE, ROUTINE, or PROGRAM being documented.
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: 9.8^B
1)= S ^DIC(9.8,"B",X,DA)=""
2)= K ^DIC(9.8,"B",X,DA)
9.8,1 TYPE 0;2 SET
'PK' FOR PACKAGE;
'R' FOR ROUTINE;
LAST EDITED: AUG 22, 1994
DESCRIPTION: This defines whether an entire PACKAGE of programs is being documented, or a single pecific
ROUTINE.
9.8,1.2 SIZE (BYTES) 0;3 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>30000)!(X<0)!(X?.E1"."1.N) X
LAST EDITED: MAY 20, 2008
HELP-PROMPT: This field is filled in by XINDEX (0 - 30000)
DESCRIPTION:
When XINDEX is run, the size of the routine is calculated and entered into this field.
9.8,1.4 DATE OF %INDEX RUN 0;4 DATE
INPUT TRANSFORM: S %DT="ETX" D ^%DT S X=Y K:3000000X) X
LAST EDITED: FEB 04, 1986
HELP-PROMPT: This field is set by %INDEX (Enter a date)
DESCRIPTION:
This field holds the date when %INDEX was run.
9.8,1.5 RSUM VALUE 0;5 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>99999999999)!(X<0)!(X?.E1"."1N.N) X
LAST EDITED: AUG 22, 1994
HELP-PROMPT: Type a Number between 0 and 99999999999, 0 Decimal Digits
DESCRIPTION:
This field is used by the Routine monitor program to store a check sum of the routine.
9.8,1.6 RSUM DATE 0;6 DATE
INPUT TRANSFORM: S %DT="EX" D ^%DT S X=Y K:Y<1 X
LAST EDITED: AUG 22, 1994
DESCRIPTION:
This field holds the date of the last change in the RSUM value.
9.8,2 DESCRIPTION 1;0 WORD-PROCESSING #9.81
DESCRIPTION:
This is a description of the PACKAGE, ROUTINE, or PROGRAM being documented.
9.8,2.1 BRIEF DESCRIPTION 2;0 WORD-PROCESSING #9.808
DESCRIPTION:
This field holds a short description of the routine.
LAST EDITED: JUL 26, 1993
HELP-PROMPT: This is a brief description for the VA tech manual.
9.8,4 PARAMETERS (IN/OUT) 3;0 Multiple #9.83 (Add New Entry without Asking)
DESCRIPTION:
Any essential or useful parameters are documented here.
9.83,.01 PARAMETERS (IN/OUT) 0;1 FREE TEXT (Multiply asked)
INPUT TRANSFORM: K:X[""""!($A(X)=45) X I $D(X) K:$L(X)>40!($L(X)<1) X
LAST EDITED: MAR 14, 1989
HELP-PROMPT: Please enter the name of the parameter being documented (1-40 characters).
DESCRIPTION:
The name of a parameter required by, or useful to, this routine.
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: 9.83^B
1)= S ^DIC(9.8,DA(1),3,"B",$E(X,1,30),DA)=""
2)= K ^DIC(9.8,DA(1),3,"B",$E(X,1,30),DA)
9.83,1 DESCRIPTION 0;2 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>72!($L(X)<2) X
HELP-PROMPT: Please enter a brief description of the parameter (2-72 characters).
DESCRIPTION:
This is a brief description of the parameter and its function.
9.83,2 DETAILED DESCRIPTION 1;0 WORD-PROCESSING #9.831
DESCRIPTION: This is a complete and detailed description of the parameter, its options, functions, and
requirements.
LAST EDITED: FEB 13, 1985
DESCRIPTION: This is a complete and detailed description of the parameter, its options, functions, and
requirements.
9.83,3 FOUND BY %INDEX 0;3 SET
'y' FOR YES;
'n' FOR NO;
LAST EDITED: FEB 04, 1986
HELP-PROMPT: This field set by %INDEX
DESCRIPTION:
This field is set to 'YES' if %INDEX finds this parameter.
9.8,5 TAG T;0 Multiple #9.801
DESCRIPTION:
Any important TAGs or ENTRY POINTs in the program are documented here.
9.801,.01 TAG 0;1 FREE TEXT (Multiply asked)
INPUT TRANSFORM: K:X[""""!($A(X)=45) X I $D(X) K:$L(X)>16!($L(X)<1) X
LAST EDITED: DEC 14, 2015
HELP-PROMPT: Please enter the name of a line in the program (1-16 characters).
DESCRIPTION:
The name of an important Line Label ("TAG") or Entry Point in this routine.
CROSS-REFERENCE: 9.801^B
1)= S ^DIC(9.8,DA(1),"T","B",$E(X,1,30),DA)=""
2)= K ^DIC(9.8,DA(1),"T","B",$E(X,1,30),DA)
9.801,1 EXPLANATION 1;0 WORD-PROCESSING #9.802
DESCRIPTION:
This is a complete and detailed description of what this line or part of the program does.
LAST EDITED: AUG 15, 1984
DESCRIPTION:
Text describing what this line of code does.
9.801,2 SUPPORTED ENTRY POINT 0;2 SET
'y' FOR YES;
'n' FOR NO;
LAST EDITED: FEB 21, 1989
9.801,3 FOUND BY %INDEX 0;3 SET
'y' FOR YES;
'n' FOR NO;
LAST EDITED: FEB 04, 1986
HELP-PROMPT: This field set by %INDEX
DESCRIPTION:
This field is set to 'YES' if %INDEX has located the tag.
9.8,6 CHECKSUM REPORT 6;1 SET
'0' FOR Local - don't report;
'1' FOR Local - report;
'2' FOR National - report;
'3' FOR National - Deleted or NOT tracked;
LAST EDITED: OCT 17, 2006
DESCRIPTION: Entries flagged with "National - report" should not be changed, with "FOR National - Deleted or NOT
tracked" for routines that do not exist in the system. Sites may determine if they want reports on
checksum differences for local routines by selecting "Local - report".
9.8,6.1 LOCALLY MODIFIED 6;2 SET
'1' FOR YES;
LAST EDITED: AUG 24, 2005
HELP-PROMPT: Enter ?? to read field description.
DESCRIPTION: This field was introduced by the VISTA Auto-patch Utility v2.0 for the purpose of not installing
patches that contain routines with local mods. If the value is set to YES for a given routine VAPU
will not install a patch or any of the routines contained in the patch.
9.8,6.2 DELETED BY PATCH 6;3 FREE TEXT
INPUT TRANSFORM: K:$L(X)>15!($L(X)<2) X
LAST EDITED: SEP 21, 2005
HELP-PROMPT: Answer must be 2-15 characters in length.
DESCRIPTION: This field is set by KIDS during an Install when the routine is sent with the 'delete at site'. It
holds the patch name.
9.8,7.1 CHECKSUM DATE 4;1 DATE
INPUT TRANSFORM: S %DT="ESTX" D ^%DT S X=Y K:Y<1 X
LAST EDITED: DEC 30, 1996
DESCRIPTION:
This field holds the date the Checksum was last saved.
9.8,7.2 CHECKSUM VALUE 4;2 FREE TEXT
INPUT TRANSFORM: K:$L(X)>15!($L(X)<2)!'(X?1A1.N) X
LAST EDITED: SEP 22, 2005
HELP-PROMPT: Answer must be 1 Alpha 1-14 Numerics in length.
DESCRIPTION: This is the saved Checksum value. The letter at the front tells us what checksum algorithm was
used. It is loaded from the KIDS build on FORUM and sent to the sites. The only application that
should load date into this field are on FORUM and the Master File Update routines in the field.
9.8,7.3 PATCH LIST AT CHECKSUM TIME 4;3 FREE TEXT
INPUT TRANSFORM: K:$L(X)>200!($L(X)<2) X
LAST EDITED: DEC 17, 2002
HELP-PROMPT: Answer must be 2-200 characters in length.
DESCRIPTION: This field holds the patch list from the second line of the routine at the time the checksum was
updated by the XTRUTL routine.
9.8,7.4 KIDS INSTALL DATE 4.1;1 DATE
INPUT TRANSFORM: S %DT="ESTX" D ^%DT S X=Y K:Y<1 X
LAST EDITED: DEC 17, 2002
DESCRIPTION: This field will be updated by KIDS when a package is installed.
9.8,8 PATCH 8;0 Multiple #9.818
9.818,.01 PATCH 0;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>50!($L(X)<2) X
LAST EDITED: MAY 09, 2006
HELP-PROMPT: Answer must be 2-20 characters in length
DESCRIPTION:
This field holds a Package or Patch name that included this routine.
CROSS-REFERENCE: 9.818^B
1)= S ^DIC(9.8,DA(1),8,"B",$E(X,1,30),DA)=""
2)= K ^DIC(9.8,DA(1),8,"B",$E(X,1,30),DA)
9.818,2 CHECKSUM 0;2 FREE TEXT
CheckSum
INPUT TRANSFORM: K:$L(X)>15!($L(X)<2)!'(X?1A1.N) X
LAST EDITED: SEP 22, 2005
HELP-PROMPT: Answer must be 1 Alpha 1-14 Numerics in length.
DESCRIPTION: This field holds the checksum (based on $$SUMB^XPDRSUM(routine)) calculated for Class I release
loaded by KIDS.
9.818,3 PATCH LIST 0;3 FREE TEXT
INPUT TRANSFORM: K:$L(X)>200!($L(X)<2) X
LAST EDITED: MAY 09, 2006
HELP-PROMPT: Answer must be 2-200 characters in length
DESCRIPTION:
This field holds the patch list at the time of the patch.
9.8,9 DEV PATCH 9;0 Multiple #9.819 (Add New Entry without Asking)
9.819,.01 Dev Patch 0;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>15!($L(X)<2) X
LAST EDITED: MAY 04, 2006
HELP-PROMPT: Answer must be 2-15 characters in length.
DESCRIPTION: This field holds the patch number. This is were KIDS will put the Checksum for the routine at
the time the the routine is exported from the account. The PATCH (#8) field is synced with the
FORUM gold account.
CROSS-REFERENCE: 9.819^B
1)= S ^DIC(9.8,DA(1),9,"B",$E(X,1,30),DA)=""
2)= K ^DIC(9.8,DA(1),9,"B",$E(X,1,30),DA)
9.819,2 Dev Checksum 0;2 FREE TEXT
INPUT TRANSFORM: K:$L(X)>20!($L(X)<2) X
LAST EDITED: MAY 04, 2006
HELP-PROMPT: Answer must be 2-20 characters in length.
DESCRIPTION:
This is the Checksum value for the routine at the time of export.
9.819,3 Dev Patch List 0;3 FREE TEXT
INPUT TRANSFORM: K:$L(X)>200!($L(X)<2) X
LAST EDITED: MAY 04, 2006
HELP-PROMPT: Answer must be 2-200 characters in length.
DESCRIPTION:
This is the patch list at the time the patch was exported from this account.
9.8,19 ROUTINE INVOKED 19;0 Multiple #9.803 (Add New Entry without Asking)
DESCRIPTION:
The names of the routines which this routine uses.
9.803,.01 ROUTINE INVOKED 0;1 FREE TEXT (Multiply asked)
INPUT TRANSFORM: K:X[""""!($A(X)=45) X I $D(X) K:$L(X)>20!($L(X)<1) X
OUTPUT TRANSFORM: S Y=$P(Y," ",2)_"^"_$P(Y," ",1)
LAST EDITED: FEB 04, 1986
HELP-PROMPT: Please enter the name of the routine this program invokes (1-20 characters).
DESCRIPTION:
The name of a routine which this routine uses.
CROSS-REFERENCE: 9.803^B
1)= S ^DIC(9.8,DA(1),19,"B",$E(X,1,30),DA)=""
2)= K ^DIC(9.8,DA(1),19,"B",$E(X,1,30),DA)
9.803,3 FOUND BY %INDEX 0;3 SET
'y' FOR YES;
'n' FOR NO;
LAST EDITED: FEB 04, 1986
HELP-PROMPT: This field set by %INDEX
DESCRIPTION:
This field is set to 'YES' if the routine invoked is found by %INDEX.
9.8,20 INVOKED BY 20;0 Multiple #9.804
DESCRIPTION:
The names of the routines which use this routine.
9.804,.01 INVOKED BY 0;1 FREE TEXT (Multiply asked)
INPUT TRANSFORM: K:X[""""!($A(X)=45) X I $D(X) K:$L(X)>20!($L(X)<1)!'(X?1"%".UN!(X?.UN)) X
LAST EDITED: FEB 04, 1986
HELP-PROMPT: Please enter the name of a routine which invokes this one (1-20 characters).
DESCRIPTION: The name of a routine which uses this routine. This is the name of the routine which invokes
this one.
CROSS-REFERENCE: 9.804^B
1)= S ^DIC(9.8,DA(1),20,"B",$E(X,1,30),DA)=""
2)= K ^DIC(9.8,DA(1),20,"B",$E(X,1,30),DA)
9.804,3 FOUND BY %INDEX 0;3 SET
'y' FOR YES;
'n' FOR NO;
LAST EDITED: FEB 04, 1986
HELP-PROMPT: This field set by %INDEX.
DESCRIPTION:
This field is set to 'YES' if %INDEX finds the invoked-by routine.
9.8,21 VARIABLES 21;0 Multiple #9.805
DESCRIPTION:
This subfile holds a list of the variables used in the routine.
9.805,.01 VARIABLES 0;1 FREE TEXT (Multiply asked)
INPUT TRANSFORM: K:X[""""!($A(X)=45) X I $D(X) K:$L(X)>8!($L(X)<1) X
LAST EDITED: FEB 05, 1986
HELP-PROMPT: ANSWER MUST BE 1-8 CHARACTERS IN LENGTH
DESCRIPTION:
This field holds the name of a variable used in the routine.
CROSS-REFERENCE: 9.805^B
1)= S ^DIC(9.8,DA(1),21,"B",$E(X,1,30),DA)=""
2)= K ^DIC(9.8,DA(1),21,"B",$E(X,1,30),DA)
9.805,2 CHANGED OR KILLED 0;2 SET
'*' FOR CHANGED;
'!' FOR KILLED;
'*!' FOR CHANGED and KILLED;
LAST EDITED: FEB 28, 1986
DESCRIPTION:
This field indicates whether the variable is changed and/or killed within the routine.
9.805,3 FOUND BY %INDEX 0;3 SET
'y' FOR YES;
'n' FOR NO;
LAST EDITED: FEB 05, 1986
DESCRIPTION:
This field is set to 'YES' if %INDEX finds this variable.
9.8,22 GLOBALS 22;0 Multiple #9.806
DESCRIPTION:
This subfile lists the globals that are referenced in this routine.
9.806,.01 GLOBALS 0;1 FREE TEXT (Multiply asked)
INPUT TRANSFORM: K:X[""""!($A(X)=45) X I $D(X) K:$L(X)>20!($L(X)<1)!'((X?1U.UN."(".E)!(X?1"%".UN."(".E)) X
LAST EDITED: JAN 26, 1988
HELP-PROMPT: ANSWER MUST BE 1-20 CHARACTERS IN LENGTH
DESCRIPTION:
This field holds the name of a global which is referenced in this routine.
CROSS-REFERENCE: 9.806^B
1)= S ^DIC(9.8,DA(1),22,"B",$E(X,1,30),DA)=""
2)= K ^DIC(9.8,DA(1),22,"B",$E(X,1,30),DA)
9.806,1 EXPLANATION 1;0 WORD-PROCESSING #9.807
DESCRIPTION:
This field may be used to describe the global.
LAST EDITED: FEB 06, 1986
9.806,3 FOUND BY %INDEX 0;3 SET
'y' FOR YES;
'n' FOR NO;
LAST EDITED: FEB 05, 1986
DESCRIPTION:
This field is set to 'YES' if %INDEX finds this global reference.
9.8,23 EDIT HISTORY 23;0 DATE Multiple #9.823 (Add New Entry without Asking)
DESCRIPTION: This subfile provides an edit history of this routine according to the date that the %Z editor was
used to modify the routine.
9.823,.01 EDIT HISTORY 0;1 DATE
INPUT TRANSFORM: S %DT="ETX" D ^%DT S X=Y K:Y<1 X
LAST EDITED: APR 01, 1987
DESCRIPTION:
This field holds the date when the %Z editor was used to modify the routine.
9.823,1 DEVICE 0;2 FREE TEXT
INPUT TRANSFORM: K:$L(X)>6!($L(X)<1) X
LAST EDITED: APR 01, 1987
HELP-PROMPT: ANSWER MUST BE 1-6 CHARACTERS IN LENGTH
DESCRIPTION:
This field holds an indication of the device used with the %Z editor to modify this routine.
9.823,2 UCI 0;3 FREE TEXT
INPUT TRANSFORM: K:$L(X)>10!($L(X)<1) X
LAST EDITED: APR 01, 1987
HELP-PROMPT: ANSWER MUST BE 1-10 CHARACTERS IN LENGTH
DESCRIPTION:
This field indicates the UCI account area where the %Z editor was used to modify this routine.
9.823,3 USER 0;4 POINTER TO NEW PERSON FILE (#200)
LAST EDITED: SEP 08, 1989
DESCRIPTION: This field indicates the user number associated with the use of the %Z editor when the routine
was modified.
9.823,11 EDIT COMMENT 1;0 WORD-PROCESSING #9.82311
LAST EDITED: AUG 15, 1989
9.8,6000 SIZE (BYTES) ; COMPUTED
MUMPS CODE: S Y=0,X=$P(^DIC(9.8,D0,0),"^",1) X:$D(^%ZOSF("SIZE"))&$D(^("TEST")) ^("TEST"),"ZL @X X ^%ZOSF(""SIZ
E"")":$T S:Y X=Y
ALGORITHM: S Y=0,X=$P(^DIC(9.8,D0,0),"^",1) X:$D(^%ZOSF("SIZE"))&$D(^("TEST")) ^("TEST"),"ZL @X X ^%ZOSF(""SIZ
E"")":$T S:Y X=Y
LAST EDITED: FEB 04, 1985
DESCRIPTION: This field may be used to calculate the size of the routine as an alternative to the %INDEX
calculation stored in Field 1.2 of this file.
FILES POINTED TO FIELDS
NEW PERSON (#200) EDIT HISTORY:USER (#3)
INPUT TEMPLATE(S):
XU ROUTINE DOC MAR 08, 1989 USER #0
PRINT TEMPLATE(S):
ONCOLOGY ROUTINE LIST MAY 28, 1992@18:52 USER #0 ONCOLOGY ROUTINE LIST
XUDOC COMPLETE MAR 14, 1989@15:47 USER #0 ROUTINE PARAMETERS AND SUPPORTED ENTRY POINTS
XUDOC ENTRY POINTS MAY 29, 1989@11:23 USER #0 ROUTINE LIST (*SUPPORTED ENTRY POINTS)
XUPRG-ROUTINE EDIT MAY 09, 1988 USER #0 EDITED ROUTINE LIST
SORT TEMPLATE(S):
ONCOLOGY ROUTINE LIST MAY 28, 1992@18:51 USER #0 'ONCOLOGY ROUTINE LIST' Print Template always used
SORT BY: NAME// From 'ONCO' To 'ONCOZ^ONCOZ'
XUDOC SUPPORTED EP MAY 29, 1989@11:27 USER #0
SORT BY: @TAG//
TAG SUB-FIELD: SUPPORTED ENTRY POINT// From 'y'
XUDOC SYSTEM ROUTINES JUL 24, 1991@11:04 USER #0
SORT BY: NAME// From 'XL' To 'ZUZ^ZUZ'
WITHIN NAME, SORT BY: @XTRTEST(NAME)=1;L1// From '0' To '1'
XUPRG-ROUTINE EDIT MAY 09, 1988 USER #0
SORT BY: NAME// (User is asked range)
WITHIN NAME, SORT BY: EDIT HISTORY//
EDIT HISTORY SUB-FIELD: EDIT HISTORY// (User is asked range)
FORM(S)/BLOCK(S):