Print Page as PDF
DSICDUZ ICR (5317)

DSICDUZ    ICR (5317)

Name Value
NUMBER 5317
IA # 5317
DATE CREATED 2008/12/23
CUSTODIAL PACKAGE VA CERTIFIED COMPONENTS - DSSI
USAGE Controlled Subscription
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE DSICDUZ
NAME DSICDUZ
ORIGINAL NUMBER 5317
GENERAL DESCRIPTION

This ICR records API's in the DSICDUZ routine.  This routine is used by DSS
applications for NEW PERSON (#200) file accesses.  The routine is a wrapper
around Standard FILEMAN calls to derive results.

Associated RPCs: DSIC ACTIVE USER, DSIC USER DEF DIV,
DSIC USER ID, DSIC ACTIVE USER LIST,
DSIC ACTIVE PERSON CLASS, DSIC ACTIVE CPRS PROVIDER



ROUTINE: DSICDUZ
COMPONENT:  ACT
VARIABLES:  DSIC   Type: Output
A subscripted array with a value of 1
or 0 to indicated if user is active.

XDUZ   Type: Input   (Required)
A single value or a subscripted array
of security keys to be evaluated.
DSISCR Type: Input   (Optional)
DSISCR(n) = string
where n = 0,1,2,3,4,...
Allowable formats of DSISCR(n) =
flag^val1^val2^val3^..

security key ck = KEY^security key
name
kernel param ck = PARM^parameter
name^ parameter instance
M code = M^<return message>^
<executable M code which
sets $T>

FUN    Type: Input (Optional)  Default is zero (0).
I $G(FUN) then extrinsic function,
else RPC.

This API is used by the "DSIC USER ACTIVE USER" rpc.
This API can be used to verify if a user is an active
VistA user.
The calling routine will send the DUZ to check and the
API will return a subscripted array with a value of 1
(user owns key) or 0 (key not found).

COMPONENT:  CK
VARIABLES:  XDUZ   Type: Input   (Required)
A single DUZ value to check.



This API does a basic check on a DUZ to see if user is active.

COMPONENT:  DIV
VARIABLES:  DSIC   Type: Output
return p1^p2^p3:

p1=pointer to file 4
p2=institution name
p3=station number

XDUZ   Type: Input   (Required) default is currect user
DUZ.
A single value or a subscripted array
of security keys to be evaluated.
SITE   Type: Input   (Optional)
if SITE=1 and user has no divisions,
then return facility's  default
division

FUN    Type: Input (Optional)  Default is zero (0).
I $G(FUN) then extrinsic function,
else RPC.

Return default division for user.  If that user has
only one division in the file 200 DIVISION multiple,
then that entry is assumed to be the default division
unless it is explicitly marked as NO.  This component is
used for the "DSIC USER DEF DIV" rpc.

COMPONENT:  ID
VARIABLES:  DSIC   Type: Output
return p1^p2^p3^p4 for n=1,2,3,...
where
If error, return -1^message
If RPC or M API,
return List[n] = p1^p2^p3^p4
for n=1,2,3,4,...
If Ext. Function,
return
p1^p2^p3^p4;p1^p2^p3^p4;p1^p2^p3^p4;...
where p1 - ID mnemonic
p2 - ID value
p3 - location
(valid for OAI mnemonics
only)
p4 = 1 (valid for OAI only.)
(If 1, then default
Alt ID)

XDUZ   Type: Input   pointer to NEW PERSON file,
if optional default to DUZ

FLAGS  Type: Input   (Optional)
default to "AaDNSTVv"
FLAGS["A" - return alternate IDS in
field 21600 only
"a" - return default alternate
ID only
- either one must be
flagged as default or if
there is only one entry
in alt id.
"D" - return DEA#
"N" - return NPI#
"S" - return SSN
"T" - TAX ID
"v" - VA#
"V" - VPID

FUN    Type: Input (Optional)  Default is zero (0).
I $G(FUN) then extrinsic function,
else RPC.

Return all user IDs for a given user.  This component
is used for the "DSIC USER ID" rpc.

COMPONENT:  LIST
VARIABLES:  DSIC   Type: Output
Return ^TMP("DSIC",$J,"DILIST",#,0) = p1^p2^p3^...^p8
where:
p1 = ien                      p6 = initials
p2 = name (.01 field)         p7 = title
p3 = sig block printed name   p8 = service
p4 = sig block title          p9 = division
p5 = first m last

VAL   Type: Input   (Required)
lookup value for NEW PERSON file.

SCR   Type: Input   (Optional)
array of additional screens to
perform:

string   where n = 0,1,2,3,4,...
Allowable formats of SCR(n) =
flag^val1^val2^val3^..
security key ck = KEY^security key
name
kernel param ck = PARM^parameter
name^ parameter instance
M code = M^<return message>^
<executable M code which sets $T>

Return list of active users for a lookup value.  This
component is used for the "DSIC ACTIVE USER LIST" rpc.



COMPONENT:  PER
VARIABLES:  DSIC   Type: Output

Return user's current active person classification for
PCE.
Return p1^p2^p3^...^p8  where
p1 = IEN to file 8932.1     p5 = Effective date
p2 = Occupation             p6 = expiration date
p3 = specialty              p7 = VA Code
p4 = sub-specialty          p8 = specialty code

USER   Type: Input   pointer to NEW PERSON file,
if optional default to DUZ.

DATE    Type: Input   ;  DATE - default=today
Fileman date to check for
active person class.

FUN    Type: Input (Optional)  Default is zero (0).
I $G(FUN) then extrinsic function,
else RPC.

Return user's current active person classification for
PCE. This component is used for the "DSIC ACTIVE PERSON
CLASS" rpc.


COMPONENT:  PROV
VARIABLES:  DSIC   Type: Output

Return: 3 if active user
2 if user is active via the XUORES security key
1 if user is a RDV visitor and you passed RDV=1
0 if user is a RDV visitor and you passed RDV=0
-1^message if problems or not a provider

XDUZ   Type: Input  (Required) default is current user DUZ.

A single value of the DUZ to return values for.


RDV    Type: Input   (Optional) default = today
Boolean flag to indicate whether or not to
include remote data view visitors - default to 0
to not include.

FUN    Type: Input (Optional)  Default is zero (0).
I $G(FUN) then extrinsic function, else RPC.

Return all user IDs for a given user.  This component
is used for the "DSIC ACTIVE CPRS PROVIDER" rpc.
STATUS Active
DURATION Till Otherwise Agreed
ID DSICDUZ
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
ACT

VARIABLES:  DSIC   Type: Output
A subscripted array with a value of 1
or 0 to indicated if user is active.
XDUZ   Type: Input  (Required)
A single value or a subscripted array
of security keys to be evaluated.
DSISCR Type: Input  (Optional)
DSISCR(n) = string where n = 0,1,2,3,4,... Allowable
formats of DSISCR(n) =
flag^val1^val2^val3^..

security key ck = KEY^security key name
kernel param ck = PARM^parameter name^
parameter instance
M code = M^<return message>^
<executable M code which sets $T>

FUN    Type: Input (Optional)  Default is zero (0).
I $G(FUN) then extrinsic function,
else RPC.

This API is used by the "DSIC USER ACTIVE USER" rpc.
This API can be used to verify if a user is an active
VistA user.  The calling routine will send the DUZ to
check and the api will return a subscripted array with a
value of 1 (user owns key) or 0 (key not found).
VARIABLES TYPE VARIABLES DESCRIPTION
DSIC Output
A subscripted array with a value of 1 or 0 to
indicate if user is active. 1 = Active, 0 = Inactive.
XDUZ Input
A single value or a subscripted array of security
keys to be evaluated.
DSISCR Input
DSISCR(n) = string where n = 0,1,2,3,4,...

Allowable formats of DSISCR(n) = flag^val1^val2^val3^.. where:

security key ck = KEY^security key name

kernel param ck = PARM^parameter name^ parameter instance

M code = M^<return message>^ <executable M code which sets $T>
FUN Input
If $G(FUN) then extrinsic function, else RPC.
CK
This API does a basic check on a DUZ to see if user
is active.
VARIABLES TYPE VARIABLES DESCRIPTION
XDUZ Input
A single DUZ value to check.
DIV
Return default division for user.  If that user has
only one division in the file 200 DIVISION multiple, then that entry is
assumed to be the default division unless it is explicitly marked as NO.  This
component is used for the "DSIC USER DEF DIV" rpc.
VARIABLES TYPE VARIABLES DESCRIPTION
DSIC Output
return p1^p2^p3:

p1=pointer to file 4
p2=institution name
p3=station number
XDUZ Input
A single value or a subscripted array of security
keys to be evaluated.
SITE Input
if SITE=1 and user has no divisions, then return
facility's  default division.
FUN Input
Default is zero (0). I $G(FUN) then extrinsic
function, else RPC
ID
Return all user IDs for a given user.  This component
is used for the "DSIC USER ID" rpc.
VARIABLES TYPE VARIABLES DESCRIPTION
DSIC Output
return p1^p2^p3^p4 for n=1,2,3,... where
If error, return -1^message
If RPC or M API,
return List[n] = p1^p2^p3^p4
for n=1,2,3,4,...
If Ext. Function,
return
p1^p2^p3^p4;p1^p2^p3^p4;p1^p2^p3^p4;...
where p1 - ID mnemonic
p2 - ID value
p3 - location
(valid for OAI mnemonics only)
p4 = 1 (valid for OAI only.)
(If 1, then default Alt ID)
XDUZ Input
Pointer to NEW PERSON (#200) file, if optional
default to DUZ.
FLAGS Input
default to "AaDNSTVv".

FLAGS["A" - return alternate IDS in field 21600 only
"a" - return default alternate ID only - either one must be flagged
as default or if there is only one entry in alt id.
"D" - return DEA#
"N" - return NPI#
"S" - return SSN
"T" - TAX ID
"v" - VA#
"V" - VPID
FUN Input
Default is zero (0). I $G(FUN) then extrinsic
function, else RPC.
LIST
Return list of active users for a lookup value.  This
component is used for the "DSIC ACTIVE USER LIST" rpc.
VARIABLES TYPE VARIABLES DESCRIPTION
DSIC Output
Return ^TMP("DSIC",$J,"DILIST",#,0) = p1^p2^p3^...^p8
where:

p1 = ien                      p6 = initials
p2 = name (.01 field)         p7 = title
p3 = sig block printed name   p8 = service
p4 = sig block title          p9 = division
p5 = first m last
VAL Input
lookup value for NEW PERSON file.
SCR Input
(Optional) Array of additional screens to perform:

string   where n = 0,1,2,3,4,...
Allowable formats of SCR(n) = flag^val1^val2^val3^..

security key ck = KEY^security key name
kernel param ck = PARM^parameter name^
parameter instance
M code = M^<return message>^
<executable M code which sets $T
PER
Return user's current active person classification
for PCE. This component is used for the "DSIC ACTIVE PERSON CLASS" rpc.
VARIABLES TYPE VARIABLES DESCRIPTION
DSIC Output
Return user's current active person classification
for PCE.

Return p1^p2^p3^...^p8  where
p1 = IEN to file 8932.1     p5 = Effective date
p2 = Occupation             p6 = expiration date
p3 = specialty              p7 = VA Code
p4 = sub-specialty          p8 = specialty code
USER Input
Pointer to NEW PERSON (#200) file.  If optional,
default to DUZ.
DATE Input
Default=today.  Fileman date to check for active
person class.
FUN Input
Default is zero (0). I $G(FUN) then extrinsic
function, else RPC.
PROV
Return all user IDs for a given user.  This component
is used for the "DSIC ACTIVE CPRS PROVIDER" rpc.
VARIABLES TYPE VARIABLES DESCRIPTION
DSIC Output
Return: 3 if active user
2 if user is active via the XUORES security key
1 if user is a RDV visitor and you passed RDV=1
0 if user is a RDV visitor and you passed RDV=0
-1^message if problems or not a provider
XDUZ Input
(Required) Default is current user DUZ. A single
value of the DUZ to return values for.
RDV Input
Boolean flag to indicate whether or not to include
remote data view visitors - default to 0 to not include.
FUN Input
(Optional)  Default is zero (0). I $G(FUN) then
extrinsic function, else RPC.
SUBSCRIBING PACKAGE INSURANCE CAPTURE BUFFER
CREATOR CAREY,BILL
DATE ACTIVATED 2009/06/11
DATE/TIME EDITED
DATE/TIME EDITED ACTION AT THE REQUEST OF WITH CONCURRENCE OF
2009/06/11 11:44 APPROVED CLARK,KAREN CAREY,WILLIAM
Generated from JAN 24, 2019@ IA Listing Descriptions