Home Package List Routine Alphabetical List Global Alphabetical List FileMan Files List FileMan Sub-Files List Package Component Lists Package-Namespace Mapping

Print Page as PDF

Sub-Field: 799.22

Package: Clinical Case Registries

ROR METADATA(#799.2)-->799.22

Sub-Field: 799.22

Information

Parent File	Name	Number	Package
ROR METADATA(#799.2)	DATA ELEMENT	799.22	Clinical Case Registries

Details

Field #	Name	Loc	Type	Details
.01	DATA NAME	0;1	FREE TEXT	INPUT TRANSFORM: `Q:$$VAEDT^RORDD(799.2,,-1) K:($L(X)>30)!($L(X)<3)!(+X=X) X` LAST EDITED: `MAR 28, 2002` HELP-PROMPT: `Answer must be 3-30 characters in length.` DESCRIPTION: `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.` TECHNICAL DESCR: `The primary "B" key and the "B" index (new style) guarantee uniqueness of the names in the file context.` DELETE TEST: `1,0)= I $$VADEL^RORDD(799.2,,-1)` `DELETE AUTHORITY: @` `WRITE AUTHORITY: @` NOTES: `XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER` FIELD INDEX: `B (#165) REGULAR IR LOOKUP & SORTING` `Unique for: Key B (#27), File #799.22` `Short Descr: Data element name uniqueness index.` `Set Logic: S ^ROR(799.2,DA(1),2,"B",$E(X,1,30),DA)=""` `Kill Logic: K ^ROR(799.2,DA(1),2,"B",$E(X,1,30),DA)` `Whole Kill: K ^ROR(799.2,DA(1),2,"B")` `X(1): DATA NAME (799.22,.01) (Subscr 1) (Len 30) (forwards)`
.02	CODE	0;2	NUMBER	**********************REQUIRED FIELD********************** INPUT TRANSFORM: `Q:$$VAEDT^RORDD(799.2,,-1) S:X="+" X=$O(^ROR(799.2,"DEC",""),-1)+1 K:+X'=X!(X>999999999)!(X<1)!(X?.E1"."1N.N) X` LAST EDITED: `MAR 27, 2002` HELP-PROMPT: `Type a Number between 1 and 999999999, 0 Decimal Digits.` DESCRIPTION: `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.` TECHNICAL DESCR: `The secondary "A" key and the whole-file "DEC" index (new style) guarantee uniqueness of the data element codes.` `DELETE AUTHORITY: @` `WRITE AUTHORITY: @` `UNEDITABLE` NOTES: `XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER` CROSS-REFERENCE: `799.22^C` `1)= S ^ROR(799.2,DA(1),2,"C",$E(X,1,30),DA)=""` `2)= K ^ROR(799.2,DA(1),2,"C",$E(X,1,30),DA)` `3)= List of data element codes.` FIELD INDEX: `DEC (#164) REGULAR IR LOOKUP & SORTING WHOLE FILE (#799.2)` `Unique for: Key A (#26), File #799.22` `Short Descr: Global list of Data Element Codes.` `Set Logic: S ^ROR(799.2,"DEC",X,DA(1),DA)=""` `Kill Logic: K ^ROR(799.2,"DEC",X,DA(1),DA)` `Whole Kill: K ^ROR(799.2,"DEC")` `X(1): CODE (799.22,.02) (Subscr 1) (forwards)`
1	LOADER API	0;5	NUMBER	**********************REQUIRED FIELD********************** INPUT TRANSFORM: `Q:$$VAEDT^RORDD(799.2,,-1) K:+X'=X!(X>99)!(X<1)!(X?.E1"."1N.N) X` LAST EDITED: `MAR 26, 2002` HELP-PROMPT: `Type a Number between 1 and 99, 0 Decimal Digits.` DESCRIPTION: `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.` EXECUTABLE HELP: `D APILST^RORDD($G(DA(1)))` `DELETE AUTHORITY: @` `WRITE AUTHORITY: @` NOTES: `XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER`
2	REQUIRED	0;3	SET	'0' FOR NO; '1' FOR YES; INPUT TRANSFORM: `Q:$$VAEDT^RORDD(799.2,,-1)` LAST EDITED: `MAR 08, 2002` DESCRIPTION: `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.` DELETE TEST: `1,0)= I $$VADEL^RORDD(799.2,,-1)` `DELETE AUTHORITY: @` `WRITE AUTHORITY: @` NOTES: `XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER` CROSS-REFERENCE: `799.22^AR` `1)= S ^ROR(799.2,DA(1),2,"AR",$E(X,1,30),DA)=""` `2)= K ^ROR(799.2,DA(1),2,"AR",$E(X,1,30),DA)` `3)= List of required fields.`
4	VALUE TYPE	0;4	SET	**********************REQUIRED FIELD********************** 'E' FOR External; 'I' FOR Internal; 'EI' FOR Both; INPUT TRANSFORM: `Q:$$VAEDT^RORDD(799.2,,-1)` LAST EDITED: `MAR 08, 2002` DESCRIPTION: `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).` `DELETE AUTHORITY: @` `WRITE AUTHORITY: @` NOTES: `XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER`
4.1	EXTERNAL DATA	4.1;E1,50	FREE TEXT	INPUT TRANSFORM: `Q:$$VAEDT^RORDD(799.2,,-1) K:$L(X)>50!($L(X)<1) X` LAST EDITED: `MAR 11, 2002` HELP-PROMPT: `Answer must be 1-50 characters in length.` DESCRIPTION: `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.` TECHNICAL DESCR: `See definition of the API #2 associated with the file #45 and source code of the $$LOADFLDS^RORUPD09 function for an example.` DELETE TEST: `1,0)= I $$VADEL^RORDD(799.2,,-1)` `DELETE AUTHORITY: @` `WRITE AUTHORITY: @` NOTES: `XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER`
4.2	INTERNAL DATA	4.2;E1,50	FREE TEXT	INPUT TRANSFORM: `Q:$$VAEDT^RORDD(799.2,,-1) K:$L(X)>50!($L(X)<1) X` LAST EDITED: `MAR 11, 2002` HELP-PROMPT: `Answer must be 1-50 characters in length.` DESCRIPTION: `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.` TECHNICAL DESCR: `See definition of the API #2 associated with the file #45 and source code of the $$LOADFLDS^RORUPD09 function for an example.` DELETE TEST: `1,0)= I $$VADEL^RORDD(799.2,,-1)` `DELETE AUTHORITY: @` `WRITE AUTHORITY: @` NOTES: `XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER`
6	FIELD NUMBER	0;6	NUMBER	INPUT TRANSFORM: `Q:$$VAEDT^RORDD(799.2,,-1) K:+X'=X!(X>999999999)!(X<0)!(X?.E1"."10.N) X X:$D(X)&$G(DA(1)) "N RORFILE S RORFILE=$P($G(^ROR(799.2,DA(1),0)),U) I RORFILE K:'$$VFIELD^DILFD(RORFILE,X) X"` LAST EDITED: `MAR 26, 2002` HELP-PROMPT: `Type a field number between .000000001 and 999999999, 9 Decimal Digits` DESCRIPTION: `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.` DELETE TEST: `1,0)= I $$VADEL^RORDD(799.2,,-1)` `DELETE AUTHORITY: @` `WRITE AUTHORITY: @` NOTES: `XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER`