The Master Data Model for Veteran Care

Developer Documentation » VDM » Parameter_Definition-8989_51

Parameter Definition (8989.51)

This file contains the characteristics of parameters. Entries in this file must be namespaced and they are exported by the package which owns them.

Global: ^XTV(8989.51,

Domain: Non-Clinical

Properties

Label/Field Name Field # Description Datatype Attributes Range
Name
  name
.01 This is the name of the parameter. It should be namespaced according to the
package from which the parameter originated.
STRING INDEXED
REQUIRED
 
Display Text
  display_text
.02 This is the displayable name for the parameter (allows mixed case,
non-namespaced names).
STRING    
Multiple Valued
  multiple_valued
.03 If this field is set to ‘Yes’, multiple instances of the parameter will be
allowed for a single entity. Otherwise, the value of the instance field
for a given Entity-Parameter combination will always be ‘1’.
BOOLEAN   false: 0
true: 1
Instance Term
  instance_term
.04 This is a free text term that can be used when prompting for a new instance of
the parameter (in the case where the parameter in multiple valued). If not
entered, the word “Instance” will be used.
STRING    
Value Term
  value_term
.05 This contains text that is issued as a prompt for the value. If nothing
is here, the prompt will be the word ‘Value:’.
STRING    
Prohibit Editing
  prohibit_editing
.06 This field prevents the parameter value from being edited with Fileman or
any Parameters tools.
BOOLEAN   false: 0
true: 1
Value Data Type
  value_data_type
1.1 This is the type of data this parameter will contain. This field is used to
define a call to the reader (^DIR) in most cases.
ENUMERATION   free text: F
constant: C
set of codes: S
M code: M
numeric: N
yes/no: Y
date/time: D
word processing: W
pointer: P
Value Domain
  value_domain
1.2 This is a string 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    
Value Help
  value_help
1.3 This field contains a line of help text that is displayed when the user
requests help or encounters an error while entering the VALUE field in the
PARAMETERS file.
STRING    
Value Validation Code
  value_validation_code
2 This field contains the M code that is placed in the third piece of DIR(0)
when validating a value in the PARAMETERS file.
STRING    
Value Screen Code
  value_screen_code
3 This field contains M code that is used to screen allowable entries for the
VALUE field in the PARAMETERS file. The code is placed in DIR(“S”) when
validating the entry.
STRING    
Keyword
  keyword
4   STRING    
Instance Data Type
  instance_data_type
6.1 This is the type of data that is contained in the INSTANCE field of the
PARAMETERS file, if multiple parameter instances per entity are allowed.
This field is used to define a call to the reader.
ENUMERATION   free text: F
set of codes: S
numeric: N
yes/no: Y
date/time: D
pointer: P
Instance Domain
  instance_domain
6.2 This may be used to further define the data type for the INSTANCE field of
the parameter. The string stored here should be appropriate for the second
^-piece of DIR(0) when used with the data type field.
STRING    
Instance Help
  instance_help
6.3 This field contains a line of help text that is displayed when the user
requests help or encounters an error while entering the INSTANCE field of
the PARAMETERS file.
STRING    
Instance Validation Code
  instance_validation_code
7 This field contains M code that is placed in the third piece of DIR(0) when
validating the INSTANCE field in the PARAMETERS file.
STRING    
Instance Screen Code
  instance_screen_code
8 This field contains M code that is used to screen allowable entries for the
INSTANCE field in the PARAMETERS file. The code is placed in DIR(“S”) when
validating the entry.
STRING    
Description
  description
20 A description of the parameter may be entered here. STRING    
Allowable Entities
  allowable_entities
30 This multiple contains a list of entities (pointers to files) for which the
parameter may be validly set.
OBJECT   Allowable_Entities-8989_513

↑ Return to top

Sub-Files

Allowable Entities (8989.513)

ID
Allowable_Entities-8989_513

Properties

Label/Field Name Field # Description Datatype Attributes Range
Precedence
  precedence
.01 A single parameter may be set for several different types of entities. This
lists the order in which entities are searched for a defined value. For
example, if a parameter may be set for a package, a location, and a user,
and the respective precedents are 3, 2, 1, the value of the user parameter
would be returned. If it did not exist, the value of the location
parameter. If that did not exist, then the value of the package parameter.
NUMERIC INDEXED
REQUIRED
 
Entity File
  entity_file
.02 This identifies an entity for which the parameter can be legally entered.
Entities are simply variable pointers. The files which are eligible to be
entities are listed in the PARAMETER ENTITY file.
POINTER REQUIRED Parameter_Entity-8989_518

↑ Return to top


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