Print Page as PDF
XUPSQRY API ICR (4575)

XUPSQRY API    ICR (4575)

Name Value
NUMBER 4575
IA # 4575
DATE CREATED 2006/04/18
CUSTODIAL PACKAGE KERNEL
USAGE Controlled Subscription
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE XUPSQRY
NAME XUPSQRY API
GENERAL DESCRIPTION
This API provides the functionality to query the New
Person (#200) file.  The calling application may query the New Person (#200)
file by using either the VPID of the requested entry or part or all of a last
name.  Other optional parameters may be passed to the call as additional
filters.
STATUS Active
DURATION Till Otherwise Agreed
ID XUPSQRY
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
EN1(RESULT,XUPSVPID,XUPSLNAM,...)
Format of call is:

D EN1^XUPSQRY(RESULT,XUPSVPID,XUPSLNAM,XUPSFNAM,XUPSSSN,
XUPSPROV,XUPSSTN,XUPSMNM,XUPSDATE)
VARIABLES TYPE VARIABLES DESCRIPTION
XUPSVPID Input
Contains the VPID (VA Person ID) for the requested
user.  Either VPID or last name are required.
XUPSLNAM Input
Contains all or part of a last name.  A last name or
VPID are required input variables.
XUPSFNAM Input
Optional parameter set to null or the full or partial
first name.
XUPSSSN Input
Value set to null or contains the 9 digits of the
Social Security Number.
XUPSPROV Input
Optional input parameter set to null or "P".  If set
to "P", screesn for providers (person with active user class).
XUPSSTN Input
Optional parameter set to null or station number.
XUPSMNM Input
Optional parameter set to maximum number of entries
(1-50) to be returned.  Defaults to 50.
XUPSDATE Input
Optional parameter contains the date used to
determine if person class is active.  Defaults to current date.
TMP($J,"XUPSQRY" Output
Results are returned in a global array:

^TMP($J,"XUPSQRY",1) - 1 if found, 0 if not found
^TMP($J,"XUPSQRY",n,0) - VPID^IEN^Last Name~First Name~
Middle Name^SSN^DOB^SEX^
^TMP($J,"XUPSQRY",n,1) - Provider Type^
^TMP($J,"XUPSQRY",n,2) - Provider Classification^
^TMP($J,"XUPSQRY",n,3) - Provider Area of Specialization^
^TMP($J,"XUPSQRY",n,4) - VA CODE^X12 CODE^Specialty Code^
end-of-record character "|"|
SUBSCRIBING PACKAGE REGISTRATION