Print Page as PDF
VADPT ICR (10061)

VADPT    ICR (10061)

Name Value
NUMBER 10061
IA # 10061
DATE CREATED 1994/03/07
CUSTODIAL PACKAGE REGISTRATION
CUSTODIAL ISC Albany
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE VADPT
NAME VADPT
ORIGINAL NUMBER 10061
GENERAL DESCRIPTION 
VADPT is a utility routine designed to provide a
central point where a programmer can obtain information concerning a patient's
record.  Supported entry points are provided which will return demographics,
inpatient status, eligibility information, etc.

Access to patient information is not limited to using the supported entry
points in VADPT.  Integration agreements can be established through the DBA
between REGISTRATION and other packages to reference information.

This integration agreement does not document the input and output variables
for any of the components of VADPT except SVC. That documentation is located
in the PIMS technical manual, section 12.2 CALLABLE ENTRY POINTS IN VADPT.

Revision History:
7/18/24: Added VASV(16) and VASV(17) variables to the SVC component,
effective with DG*5.3*1121.
3/26/24: Added "; otherwise a ^UNKNOWN is returned)" to the end of
VASV(15).
8/23/24: Effective with DG*5.3*1121, changed the variable help text for
the VAHOW Variable. Included additional examples of how the data
will be returned when VAHOW is set to 1.
STATUS Active
ID VADPT
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
DEM 
Basic patient demographic information along with
VA("BID") and VA("PID")
OPD 
Returns other demographics not returned in DEM call.
ADD 
Patient Confidential Mailing, Temporary Mailing, and
Residential Address Information. If there is no active Temporary Mailing, the
Mailing Address is returned.
ORD 
Other patient variables
IN5 
More extensive information related to inpatient
stays.
ELIG 
Patient eligibility information
MB 
Monetary benefits.
SVC 
Returns Service-related information for a patient.
VARIABLES TYPE VARIABLES DESCRIPTION
DFN Input 
This required variable is the internal entry number
in the PATIENT (#2) file.
VAHOW Input 
This optional variable can be set to a requested
format for the output array.  If this variable is not defined or is 0(zero)
the output array is returned with numeric subscripts. If VAHOW is 1 the output
array is returned with alpha subscripts; see "Description o Returns the
Comprehensive Prevention, Access to Care, and Treatment (COMPACT) indicator
for enrolled Veterans and non-enrolled Veterans.

The optional input variable VAHOW can be set to return the data in alpha
subscripts. The PERSIAN GULF INDICATOR is returned in the "PGI" subscript.
For example: VASV("PGI")="0^NO". The PERSIAN GULF LAST CHANGE DATE is returned
in the "LCD" subscript. For example: VASV("LCD")="3230629^JUN 29,2023"
VASV Output 
VASV(1)-If the VIETNAM SERVICE INDICATED field is
YES, a "1" is returned; otherwise, a "0" is returned (e.g., 0).

VASV(1,1)-If Vietnam Service, the VIETNAM FROM DATE in internal^external
format (e.g., 2680110^JAN 10,1968).

VASV(1,2)-If Vietnam Service, the VIETNAM TO DATE in internal^external format
(e.g., 2690315^MAR 15,1969).

VASV(2)-If the AGENT ORANGE EXPOS. INDICATED field is YES, a "1" is returned;
otherwise, a "0" is returned (e.g., 0).

VASV(2,1)-If Agent Orange exposure, the AGENT ORANGE REGISTRATION DATE in
internal^external format (e.g., 2870513^MAY 13,1987).

VASV(2,2)-If Agent Orange exposure, the AGENT ORANGE EXAMINATION DATE in
internal^external format (e.g., 2871101^NOV 1,1987).

VASV(2,3)-If Agent Orange exposure, AGENT ORANGE REPORTED TO C.O. date in
internal^external format (e.g., 2871225^DEC 25,1987).

VASV(2,4)-If Agent Orange exposure, AGENT ORANGE REGISTRATION # (e.g.,
123456).

VASV(2,5)-If Agent Orange exposure, the AGENT ORANGE EXPOSURE LOCATION in
internal^external format (e.g., V^VIETNAM).

VASV(3)-If the RADIATION EXPOSURE INDICATED field is YES, a "1" is returned;
otherwise, a "0" is returned (e.g., 0).

VASV(3,1)-If Radiation Exposure, RADIATION REGISTRATION DATE in
internal^external format (e.g., 2800202^FEB 02,1980).

VASV(3,2)-If Radiation Exposure, RADIATION EXPOSURE METHOD in
internal^external format (e.g., T^NUCLEAR TESTING).

VASV(4)-If the POW STATUS INDICATED field is YES, a "1" is returned;
otherwise, a "0" is returned (e.g., 0).

VASV(4,1)-If POW status, POW FROM DATE in internal^external format (e.g.,
2450319^MAR 19,1945).

VASV(4,2)-If POW status, POW TO DATE in internal^external format (e.g.,
2470101^JAN 1,1947).

VASV(4,3)-If POW status, POW CONFINEMENT LOCATION in internal^external format
(e.g., 2^WORLD WAR II - EUROPE).

VASV(5)-If the COMBAT SERVICE INDICATED field is YES, a "1" is returned;
otherwise, a "0" is returned (e.g., 0).

VASV(5,1)-If combat service, COMBAT FROM DATE in internal^external format
(e.g., 2430101^JAN 1,1943).

VASV(5,2)-If combat service, COMBAT TO DATE in internal^external format (e.g.,
2470101^JAN 1,1947).

VASV(5,3)-If combat service, COMBAT SERVICE LOCATION in internal^external
format (e.g., 2^WORLD WAR II - EUROPE).

VASV(6)-If a SERVICE BRANCH [LAST] field is indicated, a "1" is returned in
the first piece; otherwise, a "0" is returned (e.g., 0).

VASV(6,1)-If service branch, BRANCH OF SERVICE field in internal^external
format (e.g., 3^AIR FORCE).

VASV(6,2)-If service branch, SERVICE NUMBER field in internal^external format
(e.g., 123456789).

VASV(6,3)-If service branch, SERVICE DISCHARGE TYPE in internal^external
format (e.g., 1^HONORABLE).

VASV(6,4)-If service branch, SERVICE ENTRY DATE in internal^external format
(e.g., 2440609^JUN 9,1944).

VASV(6,5)-If service branch, SERVICE SEPARATION DATE in internal^external
format (e.g., 2480101^JAN 1,1948).

VASV(6,6)-If service branch, SERVICE COMPONENT in internal code^external
format (e.g., R^REGULAR).

VASV(7)-If a SERVICE SECOND EPISODE field is indicated, a "1" is returned;
otherwise, a "0" is returned (e.g., 0).

VASV(7,1)-If second episode, BRANCH OF SERVICE field in internal^external
format (e.g., 3^AIR FORCE).

VASV(7,2)-If second episode, SERVICE NUMBER field in internal^external format
(e.g., 123456789).

VASV(7,3)-If second episode, SERVICE DISCHARGE TYPE in internal^external
format (e.g., 1^HONORABLE).

VASV(7,4)-If second episode, SERVICE ENTRY DATE in internal^external format
(e.g., 2440609^JUN 9,1944).

VASV(7,5)-If second episode, SERVICE SEPARATION DATE in internal^external
format (e.g., 2480101^JAN 1,1948).

VASV(7,6)-If second episode, SERVICE COMPONENT in internal^external format
(e.g., R^REGULAR).

VASV(8)-If a SERVICE THIRD EPISODE field is indicated, a "1" is returned;
otherwise, a "0" is returned (e.g., 0).

VASV(8,1)-If third episode, BRANCH OF SERVICE field in internal^external
format (e.g., 3^AIR FORCE).

VASV(8,2)-If third episode, SERVICE NUMBER field in internal^external format
(e.g., 123456789).

VASV(8,3)-If third episode, SERVICE DIS-CHARGE TYPE in internal^external
format (e.g., 1^HONORABLE).

VASV(8,4)-If third episode, SERVICE ENTRY DATE in internal^external format
(e.g., 2440609^JUN 9,1944).

VASV(8,5)-If third episode, SERVICE SEPARATION DATE in internal^external
format (e.g., 2480101^JAN 1,1948).

VASV(8,6)-If third episode, SERVICE COMPONENT in internal code^external
format.(e.g., R^REGULAR).

VASV(9)-If the CURRENT PH INDICATOR field is YES, a "1" is returned;
otherwise, a "0" is returned (e.g., 0).

VASV(9,1)-If the CURRENT PH INDICATOR field is YES, CURRENT PURPLE HEART
STATUS in internal^external format.(e.g., 2^IN PROCESS).

VASV(9,2)-If the CURRENT PH INDICATOR field is NO, CURRENT PURPLE HEART
REMARKS in internal^external format (e.g., 5^VAMC).

VASV(10)-Is either 1 or 0, 1 if there is a value for Combat Vet End Date, 0 if
not.

VASV(10,1)-Internal Combat Vet End Date ^external Combat Vet End Date (e.g.,
3060101^JAN 1, 2006).

VASV(11)-The number of OIF conflict entries found for the Veteran in the
SERVICE [OEF OR OIF] (#2.3215) SUB-FILE [n = 1-Total number of OIF conflict
entries].

VASV(11,n,1)-SERVICE LOCATION (#2.3215; .01) internal code=1^external (e.g.,
1^OIF). Where "n" is the number used to provide a unique number for each OIF
or a conflict being returned.

VASV(11,n,2)-OEF/OIF FROM DATE (#2.3215; .02) internal format ^external format
(e.g., 3060101^JAN 1, 2006). Where "n" is the number used to provide a unique
number for each OIF conflict being returned.

VASV(11,n,3)-OEF/OIF TO DATE (#2.3215; .03) internal format ^external format
(e.g., 3060101^MAR 1, 2006). Where "n" is the number used to provide a unique
number for each OIF conflict being returned.

VASV(12)-The number of OEF conflict entries found for the Veteran in the
SERVICE [OEF OR OIF] #2.3215 SUB-FILE. [n = 1-VASV(12)].

VASV(12,n,1)-SERVICE LOCATION (#2.3215; .01) internal code = 2 ^external
(e.g., 2^OEF). Where "n" is the number used to provide a unique number for
each OEF conflict being returned.

VASV(12,n,2)-OEF/OIF FROM DATE (#2.3215; .02) internal format ^external format
(e.g., 3060101^JAN 1, 2006). Where "n" is the number used to provide a unique
number for each OEF conflict being returned.

VASV(12,n,3)-OEF/OIF TO DATE (#2.3215; .03) internal format ^external format
(e.g., 3060101^MAR 1, 2006). Where "n" is the number used to provide a unique
number for each OEF conflict being returned.

VASV(13)-The number of UNKNOWN OEF/OIF conflict entries found for the Veteran
in the SEVICE [OEF OR OIF] #2.3215 SUB-FILE. [n = 1-VASV(13)].

VASV(13,n,1)-SERVICE LOCATION (#2.3215; .01) internal CODE = 3^external format
(e.g., 3^UNKNOWN OEF/OIF). Where "n" is the number used to provide a unique
number for each UNKNOWN OEF/OIF conflict being returned.

VASV(13,n,2)-OEF/OIF FROM DATE (#2.3215; .02) internal format ^external format
(e.g., 3060101^JAN 1, 2006). Where "n" is the number used to provide a unique
number for each UNKNOWN OEF/OIF conflict being returned.

VASV(13,n,3)-OEF/OIF TO DATE (#2.3215; .03) internal format ^external format
(e.g., 3060101^MAR 1, 2006). Where "n" is the number used to provide a unique
number for each UNKNOWN OEF/OIF conflict being returned.

VASV(14)-If the PROJ 112/ SHAD field is populated, a "1" is returned;
otherwise, a "0" is returned (e.g., 0).

VASV(14,1)-If the PROJ 112/SHAD field is populated, PROJ 112/SHAD in
internal^external format (e.g., 1^YES).

VASV(15)-If the TOXIC EXPOSURE RISK ACTIVITY (TERA) field is populated, TERA
will be returned in internal^external format (e.g.,1^YES is returned for YES;
otherwise, a 0^NO is returned for NO; otherwise a ^UNKNOWN is returned).

VASV(16)-If the PERSIAN GULF INDICATOR (#.32117) field is populated, the
stored value will be returned in internal^external format (e.g.,1^YES is
returned for YES; a 0^NO is returned for NO; otherwise ^UNKNOWN is returned
for UNKNOWN).

VASV(17)-PERSIAN GULF LAST CHANGE DATE (#.32118) field - the date of the last
change made to the PERSIAN GULF INDICATOR will be returned in
internal^external format (e.g.,3230629^JUN 29,2023).
VAERR Output 
VAERR-The error flag has one of the following values:
o 0-No errors encountered. o 1-Error encountered: DFN or ^DPT(DFN,0) is not
defined.
REG 
Patient registration/disposition information
SDE 
Active clinic enrollment data
SDA 
Returns appointment information for a patient.
OERR 
Will return the demographic and inpatient [INP]
arrays.  Same as DEM and INP.
1 
Will return the demographic and inpatient [INP]
arrays.  Same as DEM and INP.
2 
Will return the demographic and eligibility arrays.
Same as DEM and ELIG.
3 
Will return the eligibility and inpatient [INP]
arrays.  Same as ELIG and INP.
4 
Will return the demographic and address arrays.  Same
as DEM and ADD.
5 
Will return the address and inpatient [INP] arrays.
Same as INP and ADD.
6 
Will return the demographic, eligibility and address
arrays.  Same as DEM, ELIG, and ADD.
7 
Will return the eligibility and service arrays.  Same
as ELIG and SVC.
8 
Will return the eligibility, service and monetary
arrays.  Same as ELIG, SVC, and MB.
9 
Will return the demographic, registration, clinic
enrollment and appointment arrays.  Same as DEM, REG, SDE, and SDA.
10 
Will return the enrollment and appointment arrays.
Same as SDE and SDA.
51 
Will return the demographic and inpatient [IN5]
arrays with version 5.0 of MAS.  Same as DEM and IN5.
52 
Will return the eligibility and inpatient [IN5]
arrays with version 5.0 of MAS.  Same as ELIG and IN5.
53 
Will return the address and inpatient [IN5] arrays
with version 5.0 of MAS.  Same as IN5 and ADD.
ALL 
Will return all arrays supported by this routine.
Tag INP will be used to determine inpatient array.  All calls EXCEPT IN5.
A5 
Will return all arrays supported by this routine
after version 5.0 of the MAS module is up and running.  IN5 will be used to
determine the inpatient array.  All calls EXCEPT INP.
SEL 
Caller specifies a list of components to execute.
INP 
Inpatient-related information.
OAD 
Address information for next-of-kin, emergency
contacts, designee, employer, or spouse's employer.
PID 
Returns VA("BID") and VA("PID") variables.
KVAR 
Used to clean-up variables used by VADPT utilities.
KVA 
Same as KVAR^VADPT, but also kills the VA variable
(and its subcomponents VA("BID") and VA("PID")).
CAI 
Will return the Comprehensive Prevention, Access to
Care, and Treatment (COMPACT) indicator for enrolled Veterans and non-enrolled
Veterans.

Indicator is '1' (for TRUE) if:
- Enrollment Category from current enrollment record is "ENROLLED".
OR
- The patient has the "COMPACT ACT ELIGIBLE" eligibility code.
VARIABLES TYPE
VAHOW Input
DATE ACTIVATED 2024/08/26