STANDARD DATA DICTIONARY #101.24 -- OE/RR REPORT FILE 6/27/25 PAGE 1
STORED IN ^ORD(101.24, (177 ENTRIES) SITE: WWW.BMIRWIN.COM UCI: VISTA,VISTA (VERSION 3.0)
DATA NAME GLOBAL DATA
ELEMENT TITLE LOCATION TYPE
-----------------------------------------------------------------------------------------------------------------------------------
This file contains definitions and parameters used in various reports within CPRS.
Entry numbers >1000 are reserved for national use. Any local entries should be added to a number <1000. If this convention is not
followed, you run the risk of having your local entries overwritten by a patch or future release of CPRS.
DD ACCESS: @
RD ACCESS:
WR ACCESS: @
DEL ACCESS: @
LAYGO ACCESS: @
AUDIT ACCESS: @
IDENTIFIED BY: HEADING (#.23), DESCRIPTIVE TEXT (#.24)[R]
POINTED TO BY: DETAIL REPORT field (#.18) of the OE/RR REPORT File (#101.24)
ITEM field (#.01) of the ITEM sub-field (#101.241) of the OE/RR REPORT File (#101.24)
CROSS
REFERENCED BY: ID(AC), NAME(B)
101.24,.001 NUMBER NUMBER
INPUT TRANSFORM: K:+X'=X!(X>10000)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: SEP 20, 2000
HELP-PROMPT: Type a Number between 1 and 10000, 0 Decimal Digits
DESCRIPTION:
This is the Number field for the file.
101.24,.01 NAME 0;1 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>30!($L(X)<3)!'(X'?1P.E) X
LAST EDITED: MAY 10, 2001
HELP-PROMPT: Answer must be 3-30 characters in length.
DESCRIPTION:
This is the Name of the report.
CROSS-REFERENCE: 101.24^B
1)= S ^ORD(101.24,"B",$E(X,1,30),DA)=""
2)= K ^ORD(101.24,"B",$E(X,1,30),DA)
101.24,.02 ID 0;2 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>10!($L(X)<1) X
LAST EDITED: OCT 05, 2000
HELP-PROMPT: Answer must be 1-10 characters in length.
DESCRIPTION: This is the code that identifies the report. Each tab in CPRS that uses reports looks for this ID
in order to process the report. Each tab also uses a unique set of ID's. An ID of 5 on the
Reports Tab may not identify the same report on a different tab.
CROSS-REFERENCE: 101.24^AC
1)= S ^ORD(101.24,"AC",$E(X,1,30),DA)=""
2)= K ^ORD(101.24,"AC",$E(X,1,30),DA)
101.24,.03 REMOTE 0;3 SET
'1' FOR YES;
'2' FOR REMOTE ONLY;
LAST EDITED: MAY 12, 2005
DESCRIPTION:
This field is used to identify which reports allow remote access through Remote Data Views.
101.24,.04 QUALIFIER 0;4 SET
'1' FOR HSType;
'2' FOR DateTime;
'3' FOR Imaging;
'4' FOR NutrAssess;
'19' FOR MedicineProcedure;
'39' FOR ListView;
'5' FOR HSComponent;
'6' FOR HSWPComponent;
'28' FOR Surgery;
LAST EDITED: OCT 04, 2001
DESCRIPTION: This field identifies which qualifier to use when processing the report. Examples of qualifiers
are HSType, DateTime, Imaging and NutrAssess.
101.24,.05 ROUTINE 0;5 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<1) X
LAST EDITED: JAN 26, 2004
HELP-PROMPT: Answer must be 1-8 characters in length.
DESCRIPTION:
This is the routine that is invoked to produce the report.
TECHNICAL DESCR: The Labs Tab does not have a value for this field. The CPRS executable calls separate RPC's for
each report.
DELETE AUTHORITY: @
WRITE AUTHORITY: @
UNEDITABLE
101.24,.06 ENTRY POINT 0;6 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<1) X
LAST EDITED: JAN 26, 2004
HELP-PROMPT: Answer must be 1-8 characters in length.
DESCRIPTION:
This is the entry point for the ROUTINE that is invoked to produce the report.
TECHNICAL DESCR: The Labs Tab does not have a value for this field. The CPRS executable calls separate RPC's for
each report.
DELETE AUTHORITY: @
WRITE AUTHORITY: @
UNEDITABLE
101.24,.07 CATEGORY 0;7 SET
'0' FOR FIXED;
'1' FOR FIXED W/DATE;
'2' FOR FIXED W/HEADER;
'3' FOR FIXED W/DATE&HEADER;
'4' FOR SPECIALIZED;
'5' FOR GRAPHIC;
'6' FOR LISTVIEW;
LAST EDITED: FEB 15, 2001
HELP-PROMPT: Enter a category for this report
DESCRIPTION:
This field puts reports into a category that is evaluated by the GUI when the report is processed.
101.24,.08 TAB 0;8 SET
'R' FOR REPORTS TAB;
'L' FOR LABS TAB;
'C' FOR COVER SHEET;
'CD' FOR COVER SHEET DETAILS;
LAST EDITED: OCT 11, 2000
HELP-PROMPT: Enter the appropriate code for this report.
DESCRIPTION:
This fields identifies the appropriate tab for a report in CPRS.
101.24,.09 MIXEDCASE 0;9 SET
'1' FOR YES;
LAST EDITED: OCT 04, 2000
HELP-PROMPT: Enter YES to display the list in mixed case
DESCRIPTION:
This is used in the cover sheet and is used to display the returned list in mixed case.
101.24,.1 INVERT 0;10 SET
'1' FOR YES;
LAST EDITED: OCT 04, 2000
HELP-PROMPT: Enter YES to have the returned list inverted.
DESCRIPTION:
This field is used to invert a list of data returned in the Cover sheet
101.24,.11 TEXT COLOR 0;11 SET
'Black' FOR BLACK;
'Maroon' FOR MAROON;
'Green' FOR GREEN;
'Olive' FOR OLIVE;
'Purple' FOR PURPLE;
'Teal' FOR TEAL;
'Red' FOR RED;
'Lime' FOR LIME;
'Yellow' FOR YELLOW;
'Blue' FOR BLUE;
'Fuchsia' FOR FUCHSIA;
'Aqua' FOR AQUA;
LAST EDITED: OCT 04, 2000
HELP-PROMPT: Enter the color for the text
DESCRIPTION:
This field determines the text color for the returned data.
101.24,.12 TYPE 0;12 SET
'R' FOR REPORT;
'H' FOR HTML;
'L' FOR LISTMAN ONLY;
'S' FOR SELECTION LIST;
'V' FOR LISTVIEW;
'M' FOR MENU;
'G' FOR GRAPH;
LAST EDITED: DEC 08, 2004
HELP-PROMPT: Enter the type for this entry.
DESCRIPTION:
This field identifies the type for an entry.
101.24,.13 RPC 0;13 POINTER TO REMOTE PROCEDURE FILE (#8994)
LAST EDITED: OCT 04, 2000
HELP-PROMPT: Select the RPC that produces this report.
DESCRIPTION:
This is the RPC that is called inside the GUI to produce the report.
101.24,.14 DATE FORMAT 0;14 SET
'D' FOR DATE ONLY;
'T' FOR DATE WITH TIME;
LAST EDITED: OCT 04, 2000
HELP-PROMPT: Enter the code for the desired date format.
DESCRIPTION:
This field determines what kind of format to display date/time fields.
101.24,.15 DATE PIECE 0;15 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>15)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: OCT 04, 2000
HELP-PROMPT: Type a Number between 1 and 15, 0 Decimal Digits
DESCRIPTION:
This is used on the Cover Sheet to determine which piece the date field occupies.
101.24,.16 TAB POSITIONS 0;16 FREE TEXT
INPUT TRANSFORM: K:$L(X)>15!($L(X)<1) X
LAST EDITED: OCT 05, 2000
HELP-PROMPT: Answer must be 1-15 characters in length.
DESCRIPTION: This is the value that will be used for the Tab property for the listbox associated with this
report on the Cover Sheet.
101.24,.17 PIECES 0;17 FREE TEXT
INPUT TRANSFORM: K:$L(X)>20!($L(X)<1) X
LAST EDITED: OCT 11, 2000
HELP-PROMPT: Answer must be 1-20 characters in length.
DESCRIPTION:
This field is used by the Cover Sheet to determine what pieces of data to display in the listbox.
101.24,.18 DETAIL REPORT 0;18 POINTER TO OE/RR REPORT FILE (#101.24)
INPUT TRANSFORM: S DIC("S")="I $P(^(0),""^"",8)=""CD""" D ^DIC K DIC S DIC=DIE,X=+Y K:Y<0 X
LAST EDITED: OCT 11, 2000
HELP-PROMPT: Enter the report to get the details for this report.
DESCRIPTION:
This field is used to get the details of an item on the cover sheet.
SCREEN: S DIC("S")="I $P(^(0),""^"",8)=""CD"""
EXPLANATION: Allow only Cover sheet detail type reports
101.24,.19 REPORT TAG 0;19 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<1) X
LAST EDITED: JUL 20, 2011
HELP-PROMPT: Answer must be 1-8 characters in length.
DESCRIPTION:
This is the entry point tag for a report extract.
101.24,.191 REPORT ROUTINE 0;20 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<3) X
LAST EDITED: JUL 20, 2011
HELP-PROMPT: Answer must be 3-8 characters in length.
DESCRIPTION:
This is the routine associated with the REPORT TAG for report extracts.
101.24,.192 REPORT COMPONENT 0;21 POINTER TO HEALTH SUMMARY COMPONENT FILE (#142.1)
LAST EDITED: MAY 03, 2001
DESCRIPTION:
This is the report component associated with this report.
101.24,.21 PARAM 1 2;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>30!($L(X)<1) X
LAST EDITED: OCT 04, 2000
HELP-PROMPT: Answer must be 1-30 characters in length.
DESCRIPTION:
This is the 1st parameter passed to the RPC, if needed.
101.24,.22 PARAM 2 2;2 FREE TEXT
INPUT TRANSFORM: K:$L(X)>30!($L(X)<1) X
LAST EDITED: OCT 04, 2000
HELP-PROMPT: Answer must be 1-30 characters in length.
DESCRIPTION:
This is the 2nd parameter passed to the RPC, if needed.
101.24,.23 HEADING 2;3 FREE TEXT
INPUT TRANSFORM: K:$L(X)>75!($L(X)<1) X
LAST EDITED: MAY 10, 2001
HELP-PROMPT: Answer must be 1-75 characters in length.
DESCRIPTION:
This is the heading used on the Cover sheet for the list of items.
101.24,.24 DESCRIPTIVE TEXT 2;4 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>55!($L(X)<2) X
LAST EDITED: MAY 10, 2001
HELP-PROMPT: Answer must be 2-55 characters in length.
DESCRIPTION:
This is a more descriptive name than what might be included in the NAME field.
101.24,.25 NODE 2;5 FREE TEXT
INPUT TRANSFORM: K:$L(X)>10!($L(X)<1) X
LAST EDITED: OCT 05, 2000
HELP-PROMPT: Answer must be 1-10 characters in length.
DESCRIPTION:
This is used by the Cover Sheet routines to define the node in the ^XTMP global to store the data.
101.24,.26 PRINT TAG 2;6 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<1) X
LAST EDITED: JAN 26, 2004
HELP-PROMPT: Answer must be 1-8 characters in length.
DESCRIPTION:
This is the entry point tag used when printing reports that do their own Write statements.
UNEDITABLE
101.24,.27 PRINT ROUTINE 2;7 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<1) X
LAST EDITED: JAN 26, 2004
HELP-PROMPT: Answer must be 1-8 characters in length.
DESCRIPTION:
This is the entry point routine used when printing reports that do their own Write statements.
UNEDITABLE
101.24,.28 EXTRACT TAG 2;8 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<1) X
LAST EDITED: DEC 22, 2005
HELP-PROMPT: Answer must be 1-8 characters in length.
DESCRIPTION: This is the entry point for the extract routine that pulls the data from package API's and/or
package files.
UNEDITABLE
101.24,.29 EXTRACT ROUTINE 2;9 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<1) X
LAST EDITED: JAN 26, 2004
HELP-PROMPT: Answer must be 1-8 characters in length.
DESCRIPTION:
This is the extract routine that pulls data from package API's and/or package files.
UNEDITABLE
101.24,.41 SORT ORDER 4;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>15!($L(X)<3)!'(X?1N1":"1N) X
LAST EDITED: JUL 17, 2001
HELP-PROMPT: Answer must be 3-15 characters in length.
DESCRIPTION: This field is used when sorting columns of data on at grid within CPRS. It determines the sort
order to be used in a multi-column sort. The primary sort column is always the column header
clicked on by the user. If this field has values in the form #:#, then a multi-column sort is
done, using the column numbers identified in this field for the second and third level sorting.
101.24,.42 MAXIMUM DAYS BACK 4;2 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>9999)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: OCT 04, 2001
HELP-PROMPT: Type a Number between 1 and 9999, 0 Decimal Digits
DESCRIPTION:
This field restricts the report date range to the maximum value specified.
101.24,.43 FHIE REPORT 4;3 FREE TEXT
INPUT TRANSFORM: K:$L(X)>10!($L(X)<2) X
LAST EDITED: OCT 08, 2003
HELP-PROMPT: Answer must be 2-10 characters in length.
DESCRIPTION: This field identifies reports that are available through FHIE. The item in this field is the code
for the report available through the FHIE server.
TECHNICAL DESCR: This field is not looked at by reports that have a 'listview' format. It is only used by straight
text reports that go through the routine:
ORDV01
101.24,.44 DIRECT 4;4 SET
'0' FOR NO;
'1' FOR YES;
LAST EDITED: FEB 01, 2005
HELP-PROMPT: ENTER YES TO MAKE DIRECT REMOTE DATA CALLS
DESCRIPTION: This field allows a report to make a direct remote data call to a remote site. Use caution in
setting this field to yes. It has the effect of disabling CPRS until the remote call is finished,
but also may speed up the query by bypassing taskman latency.
101.24,.45 HDR REPORT 4;5 SET
'1' FOR YES;
LAST EDITED: OCT 06, 2005
HELP-PROMPT: Enter 'YES' if this report comes from the HDR.
DESCRIPTION:
This field flags reports that are generated from the HDR.
101.24,.46 HDR ROUTINE 4;6 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<1) X
LAST EDITED: OCT 06, 2005
HELP-PROMPT: Answer must be 1-8 characters in length.
DESCRIPTION:
This is the HDR routine that modifies HDR data for CPRS.
101.24,.47 HDR ENTRY POINT 4;7 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<1) X
LAST EDITED: OCT 06, 2005
HELP-PROMPT: Answer must be 1-8 characters in length.
DESCRIPTION:
This is the HDR entry point that modifies HDR data for CPRS.
101.24,.48 FHIE DATA 4;8 SET
'1' FOR YES;
LAST EDITED: FEB 08, 2007
HELP-PROMPT: Enter YES if this report gets data from DOD/FHIE
DESCRIPTION: This field is used to tell CPRS that DOD/FHIE data can be accessed for this report. Special code
has to be written by CPRS and DOD for this to happen.
101.24,.49 FHIE/REMOTE DATA ONLY 4;9 SET
'1' FOR YES;
LAST EDITED: MAR 02, 2010
HELP-PROMPT: Enter YES if Local data should be excluded from this report.
DESCRIPTION: This field determines if a report can show local VA data and Remote data. Enter YES if LOCAL data
should be excluded from the report. Some Department of Defense (DOD) reports don't have a VistA
equivalent (Questionnaires, Histories). An entry of YES would be appropriate for those kinds of
reports.
101.24,.491 DISABLE 4;10 SET
'1' FOR YES;
LAST EDITED: APR 16, 2008
HELP-PROMPT: Enter YES to disable this report.
DESCRIPTION:
This field will disable a report.
101.24,3 COLUMN HEADERS 3;0 Multiple #101.243
101.243,.01 COLUMN HEADERS 0;1 FREE TEXT (Multiply asked)
INPUT TRANSFORM: K:$L(X)>60!($L(X)<1) X
LAST EDITED: JUL 09, 2001
HELP-PROMPT: Answer must be 1-60 characters in length.
DESCRIPTION:
These are the column headings used on a report in ListView format.
CROSS-REFERENCE: 101.243^B
1)= S ^ORD(101.24,DA(1),3,"B",$E(X,1,30),DA)=""
2)= K ^ORD(101.24,DA(1),3,"B",$E(X,1,30),DA)
101.243,.02 VISIBLE 0;2 SET
'0' FOR YES;
'1' FOR NO;
LAST EDITED: APR 20, 2001
HELP-PROMPT: Set this field to NO to hide the column.
DESCRIPTION:
This field determines the visible property of the column.
101.243,.03 SEQUENCE 0;3 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>9999)!(X<.1)!(X?.E1"."2N.N) X
LAST EDITED: MAR 21, 2001
HELP-PROMPT: Type a Number between .1 and 9999, 1 Decimal Digit
DESCRIPTION:
This is the sequence for the column header.
CROSS-REFERENCE: 101.243^C
1)= S ^ORD(101.24,DA(1),3,"C",$E(X,1,30),DA)=""
2)= K ^ORD(101.24,DA(1),3,"C",$E(X,1,30),DA)
101.243,.04 TYPE 0;4 SET
'0' FOR SINGLE PIECE VALUE;
'1' FOR WORD PROCESSING;
LAST EDITED: APR 20, 2001
HELP-PROMPT: Enter '1' if the value of this column contains multiple lines of text.
DESCRIPTION:
This field identifies columns that contain multiple lines of text.
101.243,.05 INCLUDE ON DETAIL 0;5 SET
'0' FOR NO;
'1' FOR YES;
LAST EDITED: JUN 28, 2001
HELP-PROMPT: Enter YES to include this field in detailed report
DESCRIPTION:
This field is used to determine what data to include in the details of a report.
101.243,.06 PRINT LENGTH 0;6 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>20)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: JUN 28, 2001
HELP-PROMPT: Type a Number between 1 and 20, 0 Decimal Digits
DESCRIPTION:
This is the field length used when printing this column on a report.
101.243,.07 INCLUDE ON PRINT 0;7 SET
'0' FOR NO;
'1' FOR YES;
LAST EDITED: JUN 28, 2001
DESCRIPTION:
This field determines which columns are included when a printout is requested.
101.243,.08 PRINT TITLE 0;8 FREE TEXT
INPUT TRANSFORM: K:$L(X)>20!($L(X)<1) X
LAST EDITED: JUN 28, 2001
HELP-PROMPT: Answer must be 1-20 characters in length.
DESCRIPTION:
This field is used when printing this field in lieu of the Column Header.
101.243,.09 DATA TYPE 0;9 SET
'0' FOR FREE TEXT;
'1' FOR NUMERIC;
'2' FOR DATE/TIME;
LAST EDITED: JUL 18, 2001
HELP-PROMPT: Enter the type of data that is in this column.
DESCRIPTION: This is the data type of the column. It is used when sorting columns. The default data type is
0 - FREE TEXT. If no value is entered, it is assumed to be FREE TEXT.
101.243,.1 WIDTH 0;10 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>4000)!(X<-2)!(X?.E1"."1N.N) X
LAST EDITED: JUL 27, 2001
HELP-PROMPT: Type a Number between -2 and 4000, 0 Decimal Digits
DESCRIPTION: This field is for the column width. No value needs to be entered because the value is actually
obtained from a User level parameter. The field is defined here to reserve the 10 piece of this
node so that future field definitions won't break the RPC used in CPRS to get column properties
where the width is stored in the 10 piece.
101.243,1 HDR MODIFIER 1;E1,245 MUMPS
INPUT TRANSFORM: K:$L(X)>245 X D:$D(X) ^DIM
LAST EDITED: OCT 06, 2005
HELP-PROMPT: This is Standard MUMPS code.
DESCRIPTION: This is code executed when HDR data needs to be modified. When this field is executed, the
variable ORX will have the value passed in from the HDR. If this value needs to be manipulated,
set the new value into ORX. If the value is ignored (not to be displayed), then set the value of
ORX="-1-"
WRITE AUTHORITY: @
101.24,10 ITEM 10;0 POINTER Multiple #101.241
101.241,.01 ITEM 0;1 POINTER TO OE/RR REPORT FILE (#101.24) (Multiply asked)
LAST EDITED: FEB 15, 2001
DESCRIPTION:
This is used in building a treeview of reports for CPRS GUI.
CROSS-REFERENCE: 101.241^B
1)= S ^ORD(101.24,DA(1),10,"B",$E(X,1,30),DA)=""
2)= K ^ORD(101.24,DA(1),10,"B",$E(X,1,30),DA)
101.241,.02 HEADER TEXT 0;2 FREE TEXT
INPUT TRANSFORM: K:$L(X)>30!($L(X)<1) X
LAST EDITED: FEB 15, 2001
HELP-PROMPT: Answer must be 1-30 characters in length.
DESCRIPTION:
This is the header to be used.
101.241,.03 SEQUENCE 0;3 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>99999)!(X<.1)!(X?.E1"."2N.N) X
LAST EDITED: FEB 15, 2001
HELP-PROMPT: Type a Number between .1 and 99999, 1 Decimal Digit
DESCRIPTION:
This is the sequence number for this report.
FILES POINTED TO FIELDS
HEALTH SUMMARY COMPONENT
(#142.1) REPORT COMPONENT (#.192)
OE/RR REPORT (#101.24) DETAIL REPORT (#.18)
ITEM:ITEM (#.01)
REMOTE PROCEDURE (#8994) RPC (#.13)
INPUT TEMPLATE(S):
PRINT TEMPLATE(S):
SORT TEMPLATE(S):
FORM(S)/BLOCK(S):