LHS CHECK OPTION ACCESS (4547)    REMOTE PROCEDURE (8994)

Name Value
NAME LHS CHECK OPTION ACCESS
TAG OPT
ROUTINE LHSRPC
RETURN VALUE TYPE SINGLE VALUE
AVAILABILITY RESTRICTED
APP PROXY ALLOWED Yes
DESCRIPTION
This RPC uses the Kernel supported API $$ACCESS^XQCHK to verify if a 
VistA user has access to an option or not.
INPUT PARAMETER
  • USER
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   20
    REQUIRED:   YES
    SEQUENCE NUMBER:   1
    DESCRIPTION:   
    This is the user DUZ being checked for option access.
    
  • OPTION
    PARAMETER TYPE:   LITERAL
    REQUIRED:   YES
    SEQUENCE NUMBER:   2
    DESCRIPTION:   
    This is either the IEN or the NAME of an option in the OPTION file #19.
    
RETURN PARAMETER DESCRIPTION
The return data is the same as the Kernel API $$ACCESS^XQCHK supported 
    access ^ menu tree IEN ^ a set of codes ^ key 
 
O^tree^codes^key: No access because of locks (see XQCODES below) 
  where 'tree' is the menu where access WOULD be allowed 
  and 'key' is the key preventing access 
1^OpIEN^^: Access allowed through Primary Menu 
2^OpIEN^codes^: Access found in the Common Options 
3^OpIEN^codes^: Access found in top level of secondary option 
4^OpIEN^codes^: Access through a the secondary menu tree OpIEN.  
 
through ICR #10078.
XQCODES can contain: 
  N=No Primary Menu in the User File (warning only) 
  L=Locked and the user does not have the key (forces 0 in first piece) 
  R=Reverse lock and user has the key (forces 0 in first piece)
 
-1:no such user in the New Person File 
-2: User terminated or has no access code 
-3: no such option in the Option File 
0: no access found in any menu tree the user owns 
 
    All other cases return a 4-piece string stating