ClinicalCaseRegistries::Classes
Class RORMetadataDataElement

Sub-File of ROR METADATA file 799.2.

Attributes
Integer code code

This field stores the unique code of the data element. Data elements can be referenced either by their names (only in the file context) or by their codes. You can enter "+" to get the next available code for a new data element.

String dataName dataName

The value of this field is the name of the data element supported by the search engine. The names must be unique in the file context. The data element is supported if either the routine that processes the file can load the value using an application API or there is a DBIA that allows access to the corresponding field via the 'GETS^DIQ' FileMan procedure.

String externalData externalData

This field can contain any optional data that helps to load the external value of the data element (variable name, subscript, position, etc.). Many data elements use the following data structure: PN[^SN]. The 'SN' is a subscript of the node in the local array (optional) and the 'PN' is the number of the "^"-piece of the node value. These values are used to extract the value from the local variable created by the API.

Integer fieldNumber fieldNumber

The FIELD NUMBER field holds the number of the field (referenced hereinafter as the search field) that the data element is loaded from. If the FileMan API #1 (GETS^DIQ) is used to load the value of the data element, the FIELD NUMBER field must have a value. Otherwise, this field can be empty. However, it is recommended to populate it for clarity.

String internalData internalData

This field can contain any optional data that helps to load the internal value of the data element (variable name, subscript, position, etc.). Many data elements use the following data structure: PN[^SN]. The 'SN' is a subscript of the node in the local array (optional) and the 'PN' is the number of the "^"-piece of the node value. These values are used to extract the value from the local variable created by the API.

Boolean isRequired isRequired

If the value of the data element is required by the search engine itself, the REQUIRED field should be set to "YES" so that the value of the element will be loaded whether it is referenced by the selection rules or not.

Integer loaderApi loaderApi

This field stores the code of the API that is used to load a value of the data element defined by the descriptor. The descriptor of this API must be defined in the "API" multiple (subfile #799.23). The only exception is the API #1. It is always considered as the 'GETS^DIQ' FileMan procedure.

DataElementValueTypeList valueType valueType

The VALUE TYPE field contains the code of the data element value type(s) supported by the search engine. The corresponding API must be able to load the value(s).


Properties:

Alias
businessRule[]
Classifier Behavior
dateAdded5/24/13
dateModified
fileNameDATA ELEMENT
fileNumber799.22
highLevelConcept
informationDomain
Is Abstractfalse
Is Activefalse
Is Leaffalse
KeywordsFile 799.22
modReason
NameRORMetadataDataElement
Name Expression
NamespaceClasses
note
originalName
Owned Template Signature
OwnerClasses
Owning Template Parameter
PackageClasses
packageNameCLINICAL CASE REGISTRIES
projectID
Qualified NameHybrid::ClinicalCaseRegistries::Classes::RORMetadataDataElement
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
Representation
requestedBy
rootClass
StereotypeClassDictionary, VistaClassDictionary
synonym
Template Parameter
VisibilityPublic

Attribute Details

 code
Public Integer code

This field stores the unique code of the data element. Data elements can be referenced either by their names (only in the file context) or by their codes. You can enter "+" to get the next available code for a new data element.

Constraints:
Properties:

absMaxLength9
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 799.22» RORMetadataDataElement
dataTypeNUMERIC
Datatype
dateAdded05/24/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameCODE
fieldNumber.02
fileNumber799.22
formatRule
formatString
generalDescriptionThis field stores the unique code of the data element. Data elements can be referenced either by their names (only in the file context) or by their codes. You can enter "+" to get the next available code for a new data element.
helpTextType a Number between 1 and 999999999, 0 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
Namecode
Name Expression
Namespace«File 799.22» RORMetadataDataElement
note
Opposite
originalClass
originalName
Owner«File 799.22» RORMetadataDataElement
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::ClinicalCaseRegistries::Classes::RORMetadataDataElement::code
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescriptionThe secondary "A" key and the whole-file "DEC" index (new style) guarantee uniqueness of the data element codes.
Template Parameter
TypeInteger
Upper1
Upper Value(1)
VisibilityPublic


 dataName
Public String dataName

The value of this field is the name of the data element supported by the search engine. The names must be unique in the file context. The data element is supported if either the routine that processes the file can load the value using an application API or there is a DBIA that allows access to the corresponding field via the 'GETS^DIQ' FileMan procedure.

Constraints:
Properties:

absMaxLength30
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 799.22» RORMetadataDataElement
dataTypeFREE TEXT
Datatype
dateAdded05/24/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameDATA NAME
fieldNumber.01
fileNumber799.22
formatRule
formatString
generalDescriptionThe value of this field is the name of the data element supported by the search engine. The names must be unique in the file context. The data element is supported if either the routine that processes the file can load the value using an application API or there is a DBIA that allows access to the corresponding field via the 'GETS^DIQ' FileMan procedure.
helpTextAnswer must be 3-30 characters in length.
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
NamedataName
Name Expression
Namespace«File 799.22» RORMetadataDataElement
note
Opposite
originalClass
originalName
Owner«File 799.22» RORMetadataDataElement
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::ClinicalCaseRegistries::Classes::RORMetadataDataElement::dataName
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescriptionThe primary "B" key and the "B" index (new style) guarantee uniqueness of the names in the file context.
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 externalData
Public String externalData

This field can contain any optional data that helps to load the external value of the data element (variable name, subscript, position, etc.). Many data elements use the following data structure: PN[^SN]. The 'SN' is a subscript of the node in the local array (optional) and the 'PN' is the number of the "^"-piece of the node value. These values are used to extract the value from the local variable created by the API.

Constraints:
Properties:

absMaxLength50
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 799.22» RORMetadataDataElement
dataTypeFREE TEXT
Datatype
dateAdded05/24/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameEXTERNAL DATA
fieldNumber4.1
fileNumber799.22
formatRule
formatString
generalDescriptionThis field can contain any optional data that helps to load the external value of the data element (variable name, subscript, position, etc.). Many data elements use the following data structure: PN[^SN]. The 'SN' is a subscript of the node in the local array (optional) and the 'PN' is the number of the "^"-piece of the node value. These values are used to extract the value from the local variable created by the API.
helpTextAnswer must be 1-50 characters in length.
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
NameexternalData
Name Expression
Namespace«File 799.22» RORMetadataDataElement
note
Opposite
originalClass
originalName
Owner«File 799.22» RORMetadataDataElement
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::ClinicalCaseRegistries::Classes::RORMetadataDataElement::externalData
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescriptionSee definition of the API #2 associated with the file #45 and source code of the $$LOADFLDS^RORUPD09 function for an example.
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 fieldNumber
Public Integer fieldNumber

The FIELD NUMBER field holds the number of the field (referenced hereinafter as the search field) that the data element is loaded from. If the FileMan API #1 (GETS^DIQ) is used to load the value of the data element, the FIELD NUMBER field must have a value. Otherwise, this field can be empty. However, it is recommended to populate it for clarity.

Constraints:
Properties:

absMaxLength19
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 799.22» RORMetadataDataElement
dataTypeNUMERIC
Datatype
dateAdded05/24/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameFIELD NUMBER
fieldNumber6
fileNumber799.22
formatRule
formatString
generalDescriptionThe FIELD NUMBER field holds the number of the field (referenced hereinafter as the search field) that the data element is loaded from. If the FileMan API #1 (GETS^DIQ) is used to load the value of the data element, the FIELD NUMBER field must have a value. Otherwise, this field can be empty. However, it is recommended to populate it for clarity.
helpTextType a field number between .000000001 and 999999999, 9 Decimal Digits
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
NamefieldNumber
Name Expression
Namespace«File 799.22» RORMetadataDataElement
note
Opposite
originalClass
originalName
Owner«File 799.22» RORMetadataDataElement
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::ClinicalCaseRegistries::Classes::RORMetadataDataElement::fieldNumber
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeInteger
Upper1
Upper Value(1)
VisibilityPublic


 internalData
Public String internalData

This field can contain any optional data that helps to load the internal value of the data element (variable name, subscript, position, etc.). Many data elements use the following data structure: PN[^SN]. The 'SN' is a subscript of the node in the local array (optional) and the 'PN' is the number of the "^"-piece of the node value. These values are used to extract the value from the local variable created by the API.

Constraints:
Properties:

absMaxLength50
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 799.22» RORMetadataDataElement
dataTypeFREE TEXT
Datatype
dateAdded05/24/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameINTERNAL DATA
fieldNumber4.2
fileNumber799.22
formatRule
formatString
generalDescriptionThis field can contain any optional data that helps to load the internal value of the data element (variable name, subscript, position, etc.). Many data elements use the following data structure: PN[^SN]. The 'SN' is a subscript of the node in the local array (optional) and the 'PN' is the number of the "^"-piece of the node value. These values are used to extract the value from the local variable created by the API.
helpTextAnswer must be 1-50 characters in length.
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
NameinternalData
Name Expression
Namespace«File 799.22» RORMetadataDataElement
note
Opposite
originalClass
originalName
Owner«File 799.22» RORMetadataDataElement
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::ClinicalCaseRegistries::Classes::RORMetadataDataElement::internalData
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescriptionSee definition of the API #2 associated with the file #45 and source code of the $$LOADFLDS^RORUPD09 function for an example.
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 isRequired
Public Boolean isRequired

If the value of the data element is required by the search engine itself, the REQUIRED field should be set to "YES" so that the value of the element will be loaded whether it is referenced by the selection rules or not.

Constraints:
Properties:

absMaxLength3
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 799.22» RORMetadataDataElement
dataTypeSET
Datatype
dateAdded05/24/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameREQUIRED
fieldNumber2
fileNumber799.22
formatRule
formatString
generalDescriptionIf the value of the data element is required by the search engine itself, the REQUIRED field should be set to "YES" so that the value of the element will be loaded whether it is referenced by the selection rules or not.
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
NameisRequired
Name Expression
Namespace«File 799.22» RORMetadataDataElement
note
Opposite
originalClass
originalName
Owner«File 799.22» RORMetadataDataElement
Owning Association
Owning Template Parameter
permissableValueMeaningsNO;YES
permissableValues0;1
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::ClinicalCaseRegistries::Classes::RORMetadataDataElement::isRequired
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeBoolean
Upper1
Upper Value(1)
VisibilityPublic


 loaderApi
Public Integer loaderApi

This field stores the code of the API that is used to load a value of the data element defined by the descriptor. The descriptor of this API must be defined in the "API" multiple (subfile #799.23). The only exception is the API #1. It is always considered as the 'GETS^DIQ' FileMan procedure.

Constraints:
Properties:

absMaxLength2
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 799.22» RORMetadataDataElement
dataTypeNUMERIC
Datatype
dateAdded05/24/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameLOADER API
fieldNumber1
fileNumber799.22
formatRule
formatString
generalDescriptionThis field stores the code of the API that is used to load a value of the data element defined by the descriptor. The descriptor of this API must be defined in the "API" multiple (subfile #799.23). The only exception is the API #1. It is always considered as the 'GETS^DIQ' FileMan procedure.
helpTextType a Number between 1 and 99, 0 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
NameloaderApi
Name Expression
Namespace«File 799.22» RORMetadataDataElement
note
Opposite
originalClass
originalName
Owner«File 799.22» RORMetadataDataElement
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::ClinicalCaseRegistries::Classes::RORMetadataDataElement::loaderApi
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeInteger
Upper1
Upper Value(1)
VisibilityPublic


 valueType
Public DataElementValueTypeList valueType

The VALUE TYPE field contains the code of the data element value type(s) supported by the search engine. The corresponding API must be able to load the value(s).

Constraints:
Properties:

absMaxLength8
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 799.22» RORMetadataDataElement
dataTypeSET
Datatype
dateAdded05/24/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameVALUE TYPE
fieldNumber4
fileNumber799.22
formatRule
formatString
generalDescriptionThe VALUE TYPE field contains the code of the data element value type(s) supported by the search engine. The corresponding API must be able to load the value(s).
helpText-
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
NamevalueType
Name Expression
Namespace«File 799.22» RORMetadataDataElement
note
Opposite
originalClass
originalName
Owner«File 799.22» RORMetadataDataElement
Owning Association
Owning Template Parameter
permissableValueMeaningsExternal;Internal;Both
permissableValuesE;I;EI
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::ClinicalCaseRegistries::Classes::RORMetadataDataElement::valueType
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeDataElementValueTypeList
Upper1
Upper Value(1)
VisibilityPublic