Sub-Field: 8993.03

Parent File	Name	Number	Package
XULM LOCK DICTIONARY(#8993)	COMPUTABLE FILE REFERENCES	8993.03	Kernel

Details

Field # Name Loc Type Details

Field #	Name	Loc	Type	Details
.01	FILE	0;1	POINTER TO FILE FILE (#1)	FILE(#1) LAST EDITED: `JUL 18, 2012` HELP-PROMPT: `Enter the file for which a reference may be computed based on the lock.` DESCRIPTION: `This field identifies a VistA file referenced directly or indirectly by the locked data structure. Most locks of interest to users of the Lock Manager will relate in some way to a specific patient, so most entries in the` `lock dictionary should contain a reference to the PATIENT file (#2)` CROSS-REFERENCE: `8993.03^B` `1)= S ^XLM(8993,DA(1),3,"B",$E(X,1,30),DA)=""` `2)= K ^XLM(8993,DA(1),3,"B",$E(X,1,30),DA)` CROSS-REFERENCE: `8993^D` `1)= S ^XLM(8993,"D",$E(X,1,30),DA(1),DA)=""` `2)= K ^XLM(8993,"D",$E(X,1,30),DA(1),DA)` `This allows lock templates to be found that refer to a particular file. The lock may refer to the file either directly or indirectly via the navigation logic.` FIELD INDEX: `C (#1555) REGULAR IR LOOKUP & SORTING` `Unique for: Key A (#139), File #8993.03` `Short Descr: Uniqueness Index for Key 'A' of Subfile #8993.03` `Description: This index guarantees that a particular file will be entered at most once in this multiple.` `Set Logic: S ^XLM(8993,DA(1),3,"C",X,DA)=""` `Kill Logic: K ^XLM(8993,DA(1),3,"C",X,DA)` `Whole Kill: K ^XLM(8993,DA(1),3,"C")` `X(1): FILE (8993.03,.01) (Subscr 1)`
1	FILE REFERENCE LOGIC	1;E1,245	MUMPS	**********************REQUIRED FIELD******************** INPUT TRANSFORM: `K:$L(X)>245 X D:$D(X) ^DIM` LAST EDITED: `AUG 29, 2012` HELP-PROMPT: `Enter Standard MUMPS code that returns record identifiers for the record that is locked. The variables in the LOCK TEMPLATE may be used within the code.` DESCRIPTION: `This field contains MUMPS code that references the file. At the time this code is executed, all the variables defined in the lock template will be defined with the values found in the actual lock.` `The MUMPS code should return the ien of the matching record and a list of identifiers that can be displayed to the user. The identifiers will be displayed to the user.` `The MUMPS code should NEW all variables it uses, other than the variables defined in the lock template and the variable ID.` `The variable ID should be returned with the the ien and a list of identifiers that can be displayed to the user. The format should be:` `ID(0) = ID("IEN")= If the record is not in a subfile, then:` `If the record is in a subfile, then:` `<(IEN of top-most file record)^` `(IEN of record in top-most sub-file)^etc.>` `ID(1) = : ID(2) = : ... etc.` `* NOTE *** For computable references to the PATIENT file, applications should call the API PATIENT^XULMU(). This will provide a uniform set of identifiers for the patient.` `Example: Supposing the lock is on a record of a subfile of the PATIENT file containing insurance policies owned by the user, and the lock template is ^DPF(DFN,"INS",IEN,0)` `The FILE REFERENCES LOGIC may use the variables DFN and IEN, which will be defined at the time the code is executed, and their values will be parsed from the actual lock as found in the lock table.` `The returned value of ID might look like this:` `ID(0)=4` `ID("IEN")="999483^4" <-- where 999483=DFN, 4 is the IEN in the sub-file.` `ID(1)="Patient Name:SMITH,JOHN"` `ID(2)="Patient DOB:JULY 1,1995"` `ID(3)="Policy #: 1345E5"` `ID(4)="Company: AETNA"` `Note that the print template actually references two files, the PATIENT file and a subfile. It is the application's choice as to whether or not to return information via two separate entries for the FILE REFERENCE LOGIC` `field or to combine it in one as in the above example.` TECHNICAL DESCR: `WRITE AUTHORITY: @`
2	DESCRIPTION	2;0	WORD-PROCESSING #8993.32	DESCRIPTION: `The description should consist of a list of the identifiers returned from the referenced file and optionally a description of the relationship between the lock and this file.` LAST EDITED: `JUL 13, 2012` HELP-PROMPT: `What identifiers are returned?` DESCRIPTION: `This field should be used to document the information returned from the file by the FILE REFERENCE LOGIC.` TECHNICAL DESCR:

.01

FILE

0;1

POINTER TO FILE FILE (#1)

FILE(#1)

LAST EDITED: JUL 18, 2012
HELP-PROMPT: Enter the file for which a reference may be computed based on the lock.
DESCRIPTION: This field identifies a VistA file referenced directly or indirectly by the locked data structure. Most locks of interest to users of the Lock Manager will relate in some way to a specific patient, so most entries in the
lock dictionary should contain a reference to the PATIENT file (#2)
CROSS-REFERENCE: 8993.03^B
1)= S ^XLM(8993,DA(1),3,"B",$E(X,1,30),DA)=""
2)= K ^XLM(8993,DA(1),3,"B",$E(X,1,30),DA)
CROSS-REFERENCE: 8993^D
1)= S ^XLM(8993,"D",$E(X,1,30),DA(1),DA)=""
2)= K ^XLM(8993,"D",$E(X,1,30),DA(1),DA)
This allows lock templates to be found that refer to a particular file. The lock may refer to the file either directly or indirectly via the navigation logic.
FIELD INDEX: C (#1555) REGULAR IR LOOKUP & SORTING
Unique for: Key A (#139), File #8993.03
Short Descr: Uniqueness Index for Key 'A' of Subfile #8993.03
Description: This index guarantees that a particular file will be entered at most once in this multiple.
Set Logic: S ^XLM(8993,DA(1),3,"C",X,DA)=""
Kill Logic: K ^XLM(8993,DA(1),3,"C",X,DA)
Whole Kill: K ^XLM(8993,DA(1),3,"C")
X(1): FILE (8993.03,.01) (Subscr 1)

FILE REFERENCE LOGIC

1;E1,245

MUMPS

************************REQUIRED FIELD************************

INPUT TRANSFORM: K:$L(X)>245 X D:$D(X) ^DIM
LAST EDITED: AUG 29, 2012
HELP-PROMPT: Enter Standard MUMPS code that returns record identifiers for the record that is locked. The variables in the LOCK TEMPLATE may be used within the code.
DESCRIPTION: This field contains MUMPS code that references the file. At the time this code is executed, all the variables defined in the lock template will be defined with the values found in the actual lock.
The MUMPS code should return the ien of the matching record and a list of identifiers that can be displayed to the user. The identifiers will be displayed to the user.
The MUMPS code should NEW all variables it uses, other than the variables defined in the lock template and the variable ID.
The variable ID should be returned with the the ien and a list of identifiers that can be displayed to the user. The format should be:
ID(0) = ID("IEN")= If the record is not in a subfile, then:
If the record is in a subfile, then:
<(IEN of top-most file record)^
(IEN of record in top-most sub-file)^etc.>
ID(1) = : ID(2) = : ... etc.
*** NOTE *** For computable references to the PATIENT file, applications should call the API PATIENT^XULMU(). This will provide a uniform set of identifiers for the patient.
Example: Supposing the lock is on a record of a subfile of the PATIENT file containing insurance policies owned by the user, and the lock template is ^DPF(DFN,"INS",IEN,0)
The FILE REFERENCES LOGIC may use the variables DFN and IEN, which will be defined at the time the code is executed, and their values will be parsed from the actual lock as found in the lock table.
The returned value of ID might look like this:
ID(0)=4
ID("IEN")="999483^4" <-- where 999483=DFN, 4 is the IEN in the sub-file.
ID(1)="Patient Name:SMITH,JOHN"
ID(2)="Patient DOB:JULY 1,1995"
ID(3)="Policy #: 1345E5"
ID(4)="Company: AETNA"
Note that the print template actually references two files, the PATIENT file and a subfile. It is the application's choice as to whether or not to return information via two separate entries for the FILE REFERENCE LOGIC
field or to combine it in one as in the above example.
TECHNICAL DESCR:
WRITE AUTHORITY: @

DESCRIPTION

2;0

WORD-PROCESSING #8993.32

DESCRIPTION: The description should consist of a list of the identifiers returned from the referenced file and optionally a description of the relationship between the lock and this file.
LAST EDITED: JUL 13, 2012
HELP-PROMPT: What identifiers are returned?
DESCRIPTION: This field should be used to document the information returned from the file by the FILE REFERENCE LOGIC.
TECHNICAL DESCR:

Customize PDF page

Package: Kernel

XULM LOCK DICTIONARY(#8993)-->8993.03

Sub-Field: 8993.03

Information

Details