The Master Data Model for Veteran Care

Developer Documentation » VDM » Oe_rr_Report-101_24

Oe/rr Report (101.24)

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.

Global: ^ORD(101.24,

Domain: Non-Clinical

Properties

Label/Field Name Field # Description Datatype Attributes Range
Number
  number
.001 This is the Number field for the file. IEN    
Name
  name
.01 This is the Name of the report. STRING INDEXED
REQUIRED
 
Id
  id-_02
.02 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.
STRING INDEXED
REQUIRED
 
Remote
  remote
.03 This field is used to identify which reports allow remote access through
Remote Data Views.
ENUMERATION   YES: 1
REMOTE ONLY: 2
Qualifier
  qualifier
.04 This field identifies which qualifier to use when processing the report.
Examples of qualifiers are HSType, DateTime, Imaging and NutrAssess.
ENUMERATION   NutrAssess: 4
HSType: 1
Surgery: 28
DateTime: 2
Imaging: 3
MedicineProcedure: 19
HSWPComponent: 6
ListView: 39
HSComponent: 5
Routine
  routine
.05 This is the routine that is invoked to produce the report. STRING    
Entry Point
  entry_point
.06 This is the entry point for the ROUTINE that is invoked to produce the
report.
STRING    
Category
  category
.07 This field puts reports into a category that is evaluated by the GUI
when the report is processed.
ENUMERATION   GRAPHIC: 5
LISTVIEW: 6
FIXED W/HEADER: 2
FIXED W/DATE&HEADER: 3
FIXED W/DATE: 1
FIXED: 0
SPECIALIZED: 4
Tab
  tab
.08 This fields identifies the appropriate tab for a report in CPRS. ENUMERATION   LABS TAB: L
REPORTS TAB: R
COVER SHEET DETAILS: CD
COVER SHEET: C
Mixedcase
  mixedcase
.09 This is used in the cover sheet and is used to display the returned
list in mixed case.
BOOLEAN   true: 1
Invert
  invert
.1 This field is used to invert a list of data returned in the Cover sheet BOOLEAN   true: 1
Text Color
  text_color
.11 This field determines the text color for the returned data. ENUMERATION   BLUE: Blue
PURPLE: Purple
AQUA: Aqua
FUCHSIA: Fuchsia
MAROON: Maroon
GREEN: Green
YELLOW: Yellow
TEAL: Teal
OLIVE: Olive
BLACK: Black
RED: Red
LIME: Lime
Type
  type-_12
.12 This field identifies the type for an entry. ENUMERATION   LISTMAN ONLY: L
MENU: M
SELECTION LIST: S
HTML: H
GRAPH: G
REPORT: R
LISTVIEW: V
Rpc
  rpc
.13 This is the RPC that is called inside the GUI to produce the report. POINTER   Remote_Procedure-8994
Date Format
  date_format
.14 This field determines what kind of format to display date/time fields. ENUMERATION   DATE WITH TIME: T
DATE ONLY: D
Date Piece
  date_piece
.15 This is used on the Cover Sheet to determine which piece the date field
occupies.
NUMERIC    
Tab Positions
  tab_positions
.16 This is the value that will be used for the Tab property for the listbox
associated with this report on the Cover Sheet.
STRING    
Pieces
  pieces
.17 This field is used by the Cover Sheet to determine what pieces of data
to display in the listbox.
STRING    
Detail Report
  detail_report
.18 This field is used to get the details of an item on the cover sheet. POINTER   Oe_rr_Report-101_24
Report Tag
  report_tag
.19 This is the entry point tag for a report extract. STRING    
Report Routine
  report_routine
.191 This is the routine associated with the REPORT TAG for report extracts. STRING    
Report Component
  report_component
.192 This is the report component associated with this report. POINTER   Health_Summary_Component-142_1
Param 1
  param_1
.21 This is the 1st parameter passed to the RPC, if needed. STRING    
Param 2
  param_2
.22 This is the 2nd parameter passed to the RPC, if needed. STRING    
Heading
  heading
.23 This is the heading used on the Cover sheet for the list of items. STRING    
Descriptive Text
  descriptive_text
.24 This is a more descriptive name than what might be included in the
NAME field.
STRING REQUIRED  
Node
  node
.25 This is used by the Cover Sheet routines to define the node in the ^XTMP
global to store the data.
STRING    
Print Tag
  print_tag
.26 This is the entry point tag used when printing reports that do their own
Write statements.
STRING    
Print Routine
  print_routine
.27 This is the entry point routine used when printing reports that do their own
Write statements.
STRING    
Extract Tag
  extract_tag
.28 This is the entry point for the extract routine that pulls the data from
package API’s and/or package files.
STRING    
Extract Routine
  extract_routine
.29 This is the extract routine that pulls data from package API’s and/or
package files.
STRING    
Sort Order
  sort_order
.41 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.
STRING    
Maximum Days Back
  maximum_days_back
.42 This field restricts the report date range to the maximum value specified. NUMERIC    
Fhie Report
  fhie_report
.43 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.
STRING    
Direct
  direct
.44 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.
BOOLEAN   false: 1
true: 0
Hdr Report
  hdr_report
.45 This field flags reports that are generated from the HDR. BOOLEAN   true: 1
Hdr Routine
  hdr_routine
.46 This is the HDR routine that modifies HDR data for CPRS. STRING    
Hdr Entry Point
  hdr_entry_point
.47 This is the HDR entry point that modifies HDR data for CPRS. STRING    
Fhie Data
  fhie_data
.48 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.
BOOLEAN   true: 1
Fhie/remote Data Only
  fhie_remote_data_only
.49 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.
BOOLEAN   true: 1
Disable
  disable
.491 This field will disable a report. BOOLEAN   true: 1
Column Headers
  column_headers
3   OBJECT   Column_Headers-101_243
Item
  item
10   OBJECT   Item-101_241

↑ Return to top

Sub-Files

Column Headers (101.243)

ID
Column_Headers-101_243

Properties

Label/Field Name Field # Description Datatype Attributes Range
Column Headers
  column_headers
.01 These are the column headings used on a report in ListView format. STRING INDEXED
REQUIRED
 
Visible
  visible
.02 This field determines the visible property of the column. ENUMERATION   YES: 0
NO: 1
Sequence
  sequence
.03 This is the sequence for the column header. NUMERIC INDEXED  
Type
  type-_04
.04 This field identifies columns that contain multiple lines of text. ENUMERATION   SINGLE PIECE VALUE: 0
WORD PROCESSING: 1
Include On Detail
  include_on_detail
.05 This field is used to determine what data to include in the details of
a report.
BOOLEAN   false: 1
true: 0
Print Length
  print_length
.06 This is the field length used when printing this column on a report. NUMERIC    
Include On Print
  include_on_print
.07 This field determines which columns are included when a printout is
requested.
BOOLEAN   false: 1
true: 0
Print Title
  print_title
.08 This field is used when printing this field in lieu of the Column Header. STRING    
Data Type
  data_type
.09 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.
ENUMERATION   DATE/TIME: 2
FREE TEXT: 0
NUMERIC: 1
Width
  width
.1 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.
NUMERIC    
Hdr Modifier
  hdr_modifier
1 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-“
STRING    

↑ Return to top

Item (101.241)

ID
Item-101_241

Properties

Label/Field Name Field # Description Datatype Attributes Range
Item
  item
.01 This is used in building a treeview of reports for CPRS GUI. POINTER INDEXED
REQUIRED
Oe_rr_Report-101_24
Header Text
  header_text
.02 This is the header to be used. STRING    
Sequence
  sequence
.03 This is the sequence number for this report. NUMERIC    

↑ Return to top


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