ClinicalCaseRegistries::Classes
Class RORSelectionRule

The ROR SELECTION RULES file contains definitions of the selection rules that are used to screen patients for addition tothe registries. There are two kinds of rules: top-level and lower level.   If a rule is referenced by the RORREGISTRY  PARAMETERS file, it is the top-level rule. Non-zero value of any top-level rule expression  directlydetermines that the patient should be added to the corresponding registry.   Lower level rules are referencedonly by other  rules (by rule macros in the expressions). Their expressions are evaluated in the proper order, and theresult values are used in the expressions of  other rules. Lower level rules have an indirect impact on the finalresult and can be used for complex processing of linked files and multiples.   For example, a lower level rulecan calculate  maximum and minimum values of a parameter in the sub-file, and a top-level rule will analyze thesevalues and decide if the patient should be added  to the registry. Moreover, they could be used to split a verycomplex rule into several simpler rules.   Records of the file are uniquely identified by the rule name (the "A"primary key and the uniqueness index "B" are used for this purpose).

Attributes
String expression expression

YOU MUST NOT EDIT THIS FIELD IF IT IS A PART OF NATIONAL REGISTRY DEFINITION! Enter a MUMPS expression (it may contain special macros) that implements the selection rule.

Integer file file

YOU MUST NOT EDIT THIS FIELD IF IT IS A PART OF NATIONAL REGISTRY DEFINITION! Enter a file/sub-file number that the selection rule is associated with. Each selection rule can be associated with only one file.

Boolean isNational isNational

ONLY AUTHORIZED NATIONAL REGISTRY DEVELOPERS CAN EDIT THIS FIELD! Selection rules of the national registries must have this field set to "YES". This prevents local editing of other fields of rule definitions.

«File 798.26» RORSelectionRuleDataElement rORSelectionRuleDataElement rORSelectionRuleDataElement
«File 798.25» RORSelectionRuleDescription rORSelectionRuleDescription  rORSelectionRuleDescription
String ruleName ruleName

YOU MUST NOT EDIT THIS FIELD IF IT IS A PART OF NATIONAL REGISTRY DEFINITION! Selection rule name must be unique and name spaced. Names of the rules that are used for National Registries must start with "VA".

String shortDescription shortDescription

YOU MUST NOT EDIT THIS FIELD IF IT IS A PART OF NATIONAL REGISTRY DEFINITION! The short description of the selection rule is used in the reports and GUI dialogs.


Properties:

Alias
businessRule[]
Classifier Behavior
dateAdded5/24/13
dateModified
fileNameROR SELECTION RULE
fileNumber798.2
highLevelConcept
informationDomain
Is Abstractfalse
Is Activefalse
Is Leaffalse
KeywordsFile 798.2
modReason
NameRORSelectionRule
Name Expression
NamespaceClasses
note
originalName
Owned Template Signature
OwnerClasses
Owning Template Parameter
PackageClasses
packageNameCLINICAL CASE REGISTRIES
projectID
Qualified NameHybrid::ClinicalCaseRegistries::Classes::RORSelectionRule
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
Representation
requestedBy
rootClass
StereotypeClassDictionary, VistaClassDictionary
synonym
Template Parameter
VisibilityPublic

Attribute Details

 expression
Public String expression

YOU MUST NOT EDIT THIS FIELD IF IT IS A PART OF NATIONAL REGISTRY DEFINITION! Enter a MUMPS expression (it may contain special macros) that implements the selection rule.

Constraints:
Properties:

absMaxLength250
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 798.2» RORSelectionRule
dataTypeFREE TEXT
Datatype
dateAdded05/24/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameEXPRESSION
fieldNumber1
fileNumber798.2
formatRule
formatString
generalDescriptionYOU MUST NOT EDIT THIS FIELD IF IT IS A PART OF NATIONAL REGISTRY DEFINITION! Enter a MUMPS expression (it may contain special macros) that implements the selection rule.
helpTextEnter M expression that implements the selection rule (1-250 characters).
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredTrue
Keywords
Lower1
Lower Value(1)
maxLength-
minLength-
modReason
Multiplicity1
Nameexpression
Name Expression
Namespace«File 798.2» RORSelectionRule
note
Opposite
originalClass
originalName
Owner«File 798.2» RORSelectionRule
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::ClinicalCaseRegistries::Classes::RORSelectionRule::expression
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescriptionMUMPS expression that implements the selection rule can contain special macros: {E: Field Name} - External value of the field {E: Field Number} {I: Field Name} - Internal value of the field {I: Field Number} {Rule Name} - Result value of the lower level selection rule {AVG: Rule Name} - Average value of the rule {CNT: Rule Name} - Number of calculations of the rule {MAX: Rule Name} - Maximum value of the rule {MIN: Rule Name} - Minimum value of the rule {SUM: Rule Name} - Total of the selection rule values {LS: Lab Search Name} - This macro can be used only in the selection rules associated with the LAB DATA file (#63). It is evaluated as 1 if some of the patient lab results pass the Lab search criteria (from the file #798.9). Otherwise, it is evaluated as zero. Return values of the top-level rules: 0 - Skip the patient Non-zero - Add the patient to the registry Return values of the lower level rules: Return values can be used in the expressions of the other rules. Some additional values are calculated automatically (minimum, maximum, average, etc.) for each rule. Avoid circular references in the expressions. If a rule directly or indirectly depends on itself, it cannot be evaluated. An example of the circular reference: Rule A: {MAX:B}<10 Rule B: {I:23}+{C} Rule C: {CNT:A} The rule A cannot be evaluated because it depends on the rule B, which depends on rule C, and C depends on A. Complex selection rules could be implemented by external MUMPS functions. In that case the expression should contains a full reference to the function ($$TAG^ROUTINE). Values of the necessary data elements can be loaded automatically (see description of the DATA ELEMENT multiple). See the Programmer's reference manual for more details regarding the selection rule expressions.
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 file
Public Integer file

YOU MUST NOT EDIT THIS FIELD IF IT IS A PART OF NATIONAL REGISTRY DEFINITION! Enter a file/sub-file number that the selection rule is associated with. Each selection rule can be associated with only one file.

Constraints:
Properties:

absMaxLength22
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 798.2» RORSelectionRule
dataTypeNUMERIC
Datatype
dateAdded05/24/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameFILE
fieldNumber2
fileNumber798.2
formatRule
formatString
generalDescriptionYOU MUST NOT EDIT THIS FIELD IF IT IS A PART OF NATIONAL REGISTRY DEFINITION! Enter a file/sub-file number that the selection rule is associated with. Each selection rule can be associated with only one file.
helpTextEnter (sub)file number between 1 and 999999999999, 9 Decimal Digits.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredTrue
Keywords
Lower1
Lower Value(1)
maxLength-
minLength-
modReason
Multiplicity1
Namefile
Name Expression
Namespace«File 798.2» RORSelectionRule
note
Opposite
originalClass
originalName
Owner«File 798.2» RORSelectionRule
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::ClinicalCaseRegistries::Classes::RORSelectionRule::file
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeInteger
Upper1
Upper Value(1)
VisibilityPublic


 isNational
Public Boolean isNational

ONLY AUTHORIZED NATIONAL REGISTRY DEVELOPERS CAN EDIT THIS FIELD! Selection rules of the national registries must have this field set to "YES". This prevents local editing of other fields of rule definitions.

Constraints:
Properties:

absMaxLength3
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 798.2» RORSelectionRule
dataTypeSET
Datatype
dateAdded05/24/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameNATIONAL
fieldNumber.09
fileNumber798.2
formatRule
formatString
generalDescriptionONLY AUTHORIZED NATIONAL REGISTRY DEVELOPERS CAN EDIT THIS FIELD! Selection rules of the national registries must have this field set to "YES". This prevents local editing of other fields of rule definitions.
helpText-
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
Keywords
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
NameisNational
Name Expression
Namespace«File 798.2» RORSelectionRule
note
Opposite
originalClass
originalName
Owner«File 798.2» RORSelectionRule
Owning Association
Owning Template Parameter
permissableValueMeaningsNO;YES
permissableValues0;1
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::ClinicalCaseRegistries::Classes::RORSelectionRule::isNational
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeBoolean
Upper1
Upper Value(1)
VisibilityPublic


 rORSelectionRuleDataElement
Public «File 798.26» RORSelectionRuleDataElement rORSelectionRuleDataElement
Constraints:
Properties:

AggregationNone
Alias
Association«VistaAssociationDictionary» (rORSelectionRuleDataElement:RORSelectionRuleDataElement)
Association End
businessRule[]
Class«File 798.2» RORSelectionRule
Datatype
dateAdded
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
formatRule
formatString
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isNullableFalse
Keywords
Lower0
Lower Value(0)
modReason
Multiplicity*
NamerORSelectionRuleDataElement
Name Expression
Namespace«File 798.2» RORSelectionRule
note
Opposite
originalClass
originalName
Owner«File 798.2» RORSelectionRule
Owning Association
Owning Template Parameter
Qualified NameHybrid::ClinicalCaseRegistries::Classes::RORSelectionRule::rORSelectionRuleDataElement
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary
synonym
Template Parameter
Type«File 798.26» RORSelectionRuleDataElement
Upper*
Upper Value(*)
VisibilityPublic


 rORSelectionRuleDescription
Public «File 798.25» RORSelectionRuleDescription rORSelectionRuleDescription 
Constraints:
Properties:

AggregationNone
Alias
Association«VistaAssociationDictionary» (rORSelectionRuleDescription :RORSelectionRuleDescription)
Association End
businessRule[]
Class«File 798.2» RORSelectionRule
Datatype
dateAdded
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
formatRule
formatString
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isNullableFalse
Keywords
Lower0
Lower Value(0)
modReason
Multiplicity*
NamerORSelectionRuleDescription
Name Expression
Namespace«File 798.2» RORSelectionRule
note
Opposite
originalClass
originalName
Owner«File 798.2» RORSelectionRule
Owning Association
Owning Template Parameter
Qualified NameHybrid::ClinicalCaseRegistries::Classes::RORSelectionRule::rORSelectionRuleDescription
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary
synonym
Template Parameter
Type«File 798.25» RORSelectionRuleDescription
Upper*
Upper Value(*)
VisibilityPublic


 ruleName
Public String ruleName

YOU MUST NOT EDIT THIS FIELD IF IT IS A PART OF NATIONAL REGISTRY DEFINITION! Selection rule name must be unique and name spaced. Names of the rules that are used for National Registries must start with "VA".

Constraints:
Properties:

absMaxLength30
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 798.2» RORSelectionRule
dataTypeFREE TEXT
Datatype
dateAdded05/24/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameRULE NAME
fieldNumber.01
fileNumber798.2
formatRule
formatString
generalDescriptionYOU MUST NOT EDIT THIS FIELD IF IT IS A PART OF NATIONAL REGISTRY DEFINITION! Selection rule name must be unique and name spaced. Names of the rules that are used for National Registries must start with "VA".
helpTextEnter a unique namespaced rule name (3-30 characters).
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
Keywords
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
NameruleName
Name Expression
Namespace«File 798.2» RORSelectionRule
note
Opposite
originalClass
originalName
Owner«File 798.2» RORSelectionRule
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::ClinicalCaseRegistries::Classes::RORSelectionRule::ruleName
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 shortDescription
Public String shortDescription

YOU MUST NOT EDIT THIS FIELD IF IT IS A PART OF NATIONAL REGISTRY DEFINITION! The short description of the selection rule is used in the reports and GUI dialogs.

Constraints:
Properties:

absMaxLength30
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 798.2» RORSelectionRule
dataTypeFREE TEXT
Datatype
dateAdded05/24/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameSHORT DESCRIPTION
fieldNumber4
fileNumber798.2
formatRule
formatString
generalDescriptionYOU MUST NOT EDIT THIS FIELD IF IT IS A PART OF NATIONAL REGISTRY DEFINITION! The short description of the selection rule is used in the reports and GUI dialogs.
helpTextEnter a short description of the selection rule (3-30 characters).
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
Keywords
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
NameshortDescription
Name Expression
Namespace«File 798.2» RORSelectionRule
note
Opposite
originalClass
originalName
Owner«File 798.2» RORSelectionRule
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::ClinicalCaseRegistries::Classes::RORSelectionRule::shortDescription
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic