STANDARD DATA DICTIONARY #727.809 -- UNIT DOSE LOCAL EXTRACT FILE 3/24/25 PAGE 1
STORED IN ^ECX(727.809, *** NO DATA STORED YET *** SITE: WWW.BMIRWIN.COM UCI: VISTA,VISTA (VERSION 3.0)
DATA NAME GLOBAL DATA
ELEMENT TITLE LOCATION TYPE
-----------------------------------------------------------------------------------------------------------------------------------
This file contains data elements as specified by the Decision Support System (DSS) Program Office for the Pharmacy Unit Dose
extract from existing DHCP files. Entries into this file are made by extracting data from several files. Once approved by the DSS
site manager, entries in this file are loaded into an electronic mail message and sent to the commercial vendor. This file is
intended to be used for validation purposes only. Entries should be made only by the extract load routine.
Since validation techniques will be determined by the local site, it is intended that the site add whatever cross references deemed
necessary. However, this file contains one nationally determined cross reference, the "AC" cross reference on the EXTRACT NUMBER
field (#2). This cross reference is used by the DSS Extracts software package as an essential feature for managing and purging
data in this file and should not be modified.
This file should NOT be modified directly using VA FileMan.
COMPILED CROSS-REFERENCE ROUTINE: ECX809
CROSS
REFERENCED BY: EXTRACT NUMBER(AC)
LAST MODIFIED: NOV 18,2023@19:04:17
727.809,.01 SEQUENCE NUMBER 0;1 NUMBER (Required)
Sequence Number
INPUT TRANSFORM: K:+X'=X!(X>999999999)!(X<1)!(X?.E1"."1N.N) X S:$D(X) DINUM=X
LAST EDITED: AUG 12, 1998
HELP-PROMPT: Enter a number between 1 and 999999999, 0 decimal digits.
DESCRIPTION:
The record number for this extract entry.
TECHNICAL DESCR:
The internal entry number (IEN) for this record. This entry is DINUMed.
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
727.809,1 YEAR MONTH 0;2 FREE TEXT
Year/Month
INPUT TRANSFORM: K:$L(X)>6!($L(X)<6)!'(X?6N) X
OUTPUT TRANSFORM: S Y=$$ECXYMX^ECXUTL(Y)
LAST EDITED: SEP 24, 1997
HELP-PROMPT: Answer must be 6 characters in length.
DESCRIPTION:
A six character string representing the year and the month for which this extract was performed.
TECHNICAL DESCR: YEAR MONTH is derived by parsing the fileman format end date of the extract. The month is
determined by taking the 4th and 5th characters of the end date, the year by taking the 2nd and 3rd
characters, and the century is then calculated by taking the 1st character of the end date, and
adding 17 to it. The Century is then concatenated with the year and month, giving the results in
YYYYMM format.
727.809,2 EXTRACT NUMBER 0;3 POINTER TO DSS EXTRACT LOG FILE (#727)
Extract Number
LAST EDITED: SEP 13, 1996
HELP-PROMPT: Enter the extract number for this extract.
DESCRIPTION:
The corresponding entry in the DSS EXTRACT LOG file (#727) for this extract.
TECHNICAL DESCR: A pointer to the DSS EXTRACT LOG file (#727). The primary purpose is to pick up the header for the
mail message.
CROSS-REFERENCE: 727.809^AC
1)= S ^ECX(727.809,"AC",$E(X,1,30),DA)=""
2)= K ^ECX(727.809,"AC",$E(X,1,30),DA)
3)= DO NOT DELETE.
This cross reference is essential for managing and purging data in this file.
727.809,3 FACILITY 0;4 POINTER TO MEDICAL CENTER DIVISION FILE (#40.8)
Facility
LAST EDITED: MAY 30, 2012
HELP-PROMPT: Enter the medical center division associated with this admission.
DESCRIPTION:
This is the medical center division where the extract was performed.
TECHNICAL DESCR: An indicator of the division where this event happened. It is derived from the DIVISION field
(#.015) of the WARD LOCATION file (#42) which points to the MEDICAL CENTER DIVISION file (#40.8).
727.809,4 PATIENT NO. - DFN 0;5 POINTER TO PATIENT FILE (#2)
Patient No. - DFN
LAST EDITED: OCT 18, 1996
HELP-PROMPT: Enter the name of the patient for this extract record.
DESCRIPTION:
An identifying number for the patient at the local site.
TECHNICAL DESCR: Pointer to the NAME field (#.01) of the PATIENT file (#2). PATIENT NO. - DFN data is derived from
the DFN field (#1) of the UNIT DOSE EXTRACT DATA file (#728.904).
727.809,5 SSN 0;6 FREE TEXT
Social Security Number
INPUT TRANSFORM: K:$L(X)>10!($L(X)<9)!'(X?9N!X?9N1"P") X
LAST EDITED: SEP 13, 1996
HELP-PROMPT: Your answer must be 9 to 10 characters in length.
DESCRIPTION:
The patient's social security number.
TECHNICAL DESCR: Using the patient pointer (DFN) stored in the PATIENT NO. - DFN field (#4) in the UNIT DOSE LOCAL
EXTRACT file (#727.809), SSN data is derived from the SOCIAL SECURITY NUMBER field (#.09) in the
PATIENT file (#2).
"Test" patient status is determined in PAT^ECXUTL3. Any patient with an SSN beginning with "00000"
will not be included in the extract.
727.809,6 NAME 0;7 FREE TEXT
Name
INPUT TRANSFORM: K:$L(X)>4!($L(X)<4) X
LAST EDITED: SEP 13, 1996
HELP-PROMPT: Your answer must be 4 characters in length.
DESCRIPTION:
The first four characters of the patient's last name.
TECHNICAL DESCR: Using the patient pointer (DFN) stored in the PATIENT NO. - DFN field (#4) in the UNIT DOSE LOCAL
EXTRACT file (#727.809), NAME data is derived from the NAME field (#.01) in the PATIENT file (#2).
The first four characters of the first "," piece are used, padded with trailing spaces if
necessary.
The name value is returned by the supported call DEM^VADPT.
727.809,7 IN OUT PATIENT INDICATOR 0;8 SET
In Out Patient Indicator
'I' FOR INPATIENT;
'O' FOR OUTPATIENT;
'A' FOR ASIH (OTHER FACILITY);
LAST EDITED: JUN 29, 2018
HELP-PROMPT: Enter the patient's status for this extract entry.
DESCRIPTION:
Indicates the patient's status for this extract entry.
TECHNICAL DESCR: To determine the value of this field a call is made to $$PATDEM^ECXUTL2. Within this call,
$$INP^ECXUTL2 is called to determine patient status. If the patient is an outpatient, processing
stops and the field is set to O. If the patient is an inpatient then $$INOUTP^ECXUTL4 is called
to look at the treating specialty. If the patient's treating specialty exists in the DSS TREATING
SPECIALTY TRANSLATION file (#727.831) then the value of the INPAT/OUTPAT CODE field (#5) of the DSS
TREATING SPECIALTY TRANSLATION file (#727.831) is used. If the treating specialty is not found in
the DSS TREATING SPECIALTY TRANSLATION file (#727.831) then the indicator is set to I.
If the patient is ASIH to another facility at the date/time in question then the indicator is set
to A.
727.809,8 DAY 0;9 FREE TEXT
Day
INPUT TRANSFORM: K:$L(X)>8!($L(X)<8) X
OUTPUT TRANSFORM: S Y=$$ECXDATEX^ECXUTL(Y)
LAST EDITED: SEP 24, 1997
HELP-PROMPT: Answer must be 8 characters in length.
DESCRIPTION: This 8-character string represents the date on which the Unit Dose event (dispense or return)
occurred.
TECHNICAL DESCR: Data source:
(1) UNIT DOSE EXTRACT DATA file (#728.904); DATE field (#2) Data is inserted in this field by
Pharmacy routines PSGPLF and PSGAMSA; these routines derive the data from -- (2) UNIT DOSE PICK
LIST STATS file (#57.6); DATE field (#.01)
PICK LIST file (#53.5); START DATE/TIME field (#.03)
or
DT (i.e., FileMan variable for Today's Date)
This field is always exactly 8 numeric characters in length. The format is YYYYMMDD; for example,
19970923. If the date cannot be determined, then a default is used. The default date value is the
value of the YEAR MONTH field (#1) concatenated with "01" for the day (DD) portion. Year 2000
compliant per vendor.
727.809,9 VA DRUG CLASSIFICATION 0;10 FREE TEXT
VA Drug Classification
INPUT TRANSFORM: K:$L(X)>5!($L(X)<5) X
LAST EDITED: SEP 13, 1996
HELP-PROMPT: Your answer must be 5 characters in length.
DESCRIPTION:
The VA Drug Classification for the item in this order.
TECHNICAL DESCR: Derived from the VA CLASSIFICATION field (#2) in the DRUG file (#50) for the drug identified by the
DRUG field (#3) in the UNIT DOSE EXTRACT DATA file (#728.904).
The DRUG field (#3) is populated from the DISPENSE DRUG field (#.01) within the DISPENSE DRUG
multiple (#2) within the UNIT DOSE multiple (#62) of the PHARMACY PATIENT file (#55).
727.809,10 QUANTITY 0;11 NUMBER
Quantity
INPUT TRANSFORM: K:+X'=X!(X>10000)!(X<0)!(X?.E1"."3N.N) X
LAST EDITED: SEP 04, 2018
HELP-PROMPT: Type a number between 0 and 10000, 2 decimal digits.
DESCRIPTION: Drug quantity dispensed in the unit of issue for that drug. Unit of issue may vary from product to
product and site to site.
TECHNICAL DESCR: QUANTITY is derived from the QUANTITY field (#4) of the UNIT DOSE EXTRACT DATA file (#728.904).
The QUANTITY (#4) field gets its value from the #DOSES ACTUALLY DISPENSED field (#.03) within the
DISPENSE DRUG multiple (#1) within the ORDER multiple (#1) within the PATIENT multiple (#1) of the
PICK LIST file (#53.5).
727.809,11 WARD 0;12 POINTER TO HOSPITAL LOCATION FILE (#44)
Ward
LAST EDITED: SEP 13, 1996
HELP-PROMPT: Enter the ward location for this patient.
DESCRIPTION:
Current ward where the patient is located when patient is an inpatient.
TECHNICAL DESCR: If the patient is an inpatient at the time of the order then the ward is derived from the WARD
field (#5) in the UNIT DOSE EXTRACT DATA file (#728.904) which is a pointer to the WARD LOCATION
file (#42). Using the ward pointer, the data is derived from the HOSPITAL LOCATION FILE POINTER
field (#44) in the WARD LOCATION file (#42) which is a pointer to the HOSPITAL LOCATION file (#44).
The WARD (#5) is populated with the value found in the WARD field (#.03) within the PATIENT
multiple (#1) of the PICK LIST file (#53.5).
If this is a clinic order (inpatient medication for an outpatient) then the ward will be null.
727.809,12 PROVIDER 0;13 FREE TEXT
Provider
INPUT TRANSFORM: K:$L(X)>11!($L(X)<1) X
LAST EDITED: OCT 18, 1996
HELP-PROMPT: Enter provider assigned to this patient.
DESCRIPTION:
The provider assigned to this patient.
TECHNICAL DESCR: PROVIDER data is derived from the PROVIDER field (#6) of the UNIT DOSE EXTRACT DATA file
(#728.904).
The PROVIDER (#6) field comes from the PROVIDER field (#1) within the UNIT DOSE multiple (#62) of
the PHARMACY PATIENT file (#55).
It is a pointer to the NEW PERSON file (#200). This data is stored as "2"_pointer value.
727.809,13 COST 0;14 NUMBER
Cost
INPUT TRANSFORM: S:X["$" X=$P(X,"$",2) K:X'?.N.1".".2N!(X>10000)!(X<0) X
LAST EDITED: SEP 13, 1996
HELP-PROMPT: Enter a dollar amount between 0 and 10000, 2 decimal digits.
DESCRIPTION:
VA pharmacy supply cost of drug dispensed.
TECHNICAL DESCR:
COST data is derived from the TOTAL COST field (#7) of the UNIT DOSE EXTRACT DATA file (#728.904).
727.809,14 MOVEMENT FILE # 0;15 POINTER TO PATIENT MOVEMENT FILE (#405)
Movement File Number
LAST EDITED: SEP 13, 1996
HELP-PROMPT: Enter the patient movement number associated with this extract record.
DESCRIPTION:
Current patient movement record associated with this extract record.
TECHNICAL DESCR: A call to IN5^VADPT (using the patient IEN and the event date) returns a patient movement number
(indicating inpatient status). This field is set to the value of VAIP(1), which is a pointer to the
PATIENT MOVEMENT file (#405).
727.809,15 TREATING SPECIALTY 0;16 FREE TEXT
Treating Specialty
INPUT TRANSFORM: K:$L(X)>3!($L(X)<2) X
LAST EDITED: NOV 03, 2009
HELP-PROMPT: Answer must be 2-3 characters in length
DESCRIPTION:
The PTF CODE of the treating specialty associated with this extract record.
TECHNICAL DESCR: This field is initialized to a null, indicating an outpatient status. If a call to IN5^VADPT (using
the patient IEN and the event date) returns a patient movement number (indicating inpatient
status), then the value of VAIP(8), which is the pointer to the FACILITY TREATING SPECIALTY file
(#45.7), is used to get the SPECIALTY field (#1) which points to the SPECIALTY file (#42.4). Then,
the PTF CODE field (#7) of the SPECIALTY file (#42.4) is obtained and stored instead of the IEN of
the specialty.
727.809,16 NDC 0;17 FREE TEXT
National Drug Code
INPUT TRANSFORM: K:$L(X)>15!($L(X)<1) X
LAST EDITED: SEP 13, 1996
HELP-PROMPT: Your answer must be 1 to 15 characters in length.
DESCRIPTION:
This is the National Drug Code for the drug/supply item in this order.
TECHNICAL DESCR: Derived from the NDC field (#31) in the DRUG file (#50) for the drug identified by the DRUG field
(#3) in the UNIT DOSE EXTRACT DATA file (#728.904).
DRUG (#3) is derived from the DISPENSE DRUG field (#.01) within the DISPENSE DRUG multiple (#2)
within the UNIT DOSE multiple (#62) of the PHARMACY PATIENT file (#55).
727.809,17 NEW FEEDER KEY 0;18 FREE TEXT
New Feeder Key
INPUT TRANSFORM: K:$L(X)>17!($L(X)<17) X
LAST EDITED: MAY 30, 2012
HELP-PROMPT: Answer must be 17 characters in length.
DESCRIPTION:
Code that uniquely identifies a DSS drug/supply product.
TECHNICAL DESCR: NEW FEEDER KEY is derived for the drug identified by the DRUG field (#6) in the PRESCRIPTION file
(#52), which is a pointer to the DRUG file (#50).
The PSNDF VA PRODUCT NAME ENTRY field (#22) from the DRUG file (#50), which is a pointer to the VA
PRODUCT file (#50.68) is padded to 5 digits. This is concatenated with a 12-digit code derived
from the NDC field (#31) from the DRUG file (#50) to form a 17-digit Feeder Key.
727.809,18 DEA, SPECIAL HDLG 0;19 SET
'I' FOR INVESTIGATIONAL;
'1' FOR SCHEDULE 1 ITEM;
'2' FOR SCHEDULE 2 ITEM;
'3' FOR SCHEDULE 3 ITEM;
'4' FOR SCHEDULE 4 ITEM;
'5' FOR SCHEDULE 5 ITEM;
LAST EDITED: MAY 31, 2013
HELP-PROMPT: Enter I if the drug is investigational or 1-5 depending on the drug's schedule.
DESCRIPTION:
Indicates if the drug in this record is Investigational, or Schedule 1-5.
TECHNICAL DESCR: Derived from the DEA, SPECIAL HDLG field (#3) in the DRUG file (#50). If the field contains a
"1","2","3","4" or "5" (DRUG SCHEDULE) it will be set to that number. Otherwise, if it contains an
I, it will be set to I.
727.809,19 UDP TIME 0;20 FREE TEXT
UDP Time
INPUT TRANSFORM: K:$L(X)>6!($L(X)<6) X
OUTPUT TRANSFORM: S Y=$$ECXTIMEX^ECXUTL(Y,1)
LAST EDITED: SEP 24, 1997
HELP-PROMPT: Answer must be 6 characters in length.
DESCRIPTION:
Time that the drug was dispensed.
TECHNICAL DESCR: Data source:
UNIT DOSE EXTRACT DATA file (#728.904); DATE field (#2). Data is inserted in this field by Pharmacy
routines PSGPLF and PSGAMSA. These routines derive the data from either the UNIT DOSE PICK LIST
STATS file (#57.6); DATE field (#.01) or the PICK LIST file (#53.5); START DATE/TIME field (#.03).
Currently, only the 1st "." piece (date) has data. The 2nd "." piece (time) is padded with trailing
zeros to 6 characters, and stored. If no data is available then DT (i.e., FileMan variable for
Today's Date) is used.
The source for this data element does NOT provide any time information; only date is provided.
Consequently, the UDP TIME field is always set to "000000".
727.809,20 ADMISSION DATE 0;21 FREE TEXT
Admission Date
INPUT TRANSFORM: K:$L(X)>8!($L(X)<8) X
MAXIMUM LENGTH: 8
OUTPUT TRANSFORM: S Y=$$ECXDATEX^ECXUTL(Y)
LAST EDITED: AUG 22, 2018
HELP-PROMPT: Answer must be 8 characters in length (YYYYMMDD).
DESCRIPTION:
This 8-character numeric string represents the date on which the patient's admission occurred.
TECHNICAL DESCR: A call is made to $$INP^ECXUTL2 using the patient's DFN and the date/time the unit dose medication
was given. The call will return the admission date/time associated with this episode of care.
In the case of a patient who is ASIH OTHER FACILITY, it will be the date/time of the movement that
put the patient into ASIH OTHER FACILITY status.
The date portion of the DATE/TIME field (#.01) of the PATIENT MOVEMENT file (#405) is used to
populate this field.
This field is always exactly 8 numeric characters in length. The format is YYYYMMDD; for example,
19970923. If the date cannot be determined, then a default is used. The default date value is the
value of the YEAR MONTH field (#1) concatenated with "01" for the day (DD) portion.
727.809,21 ADMISSION TIME 0;22 FREE TEXT
Admission Time
INPUT TRANSFORM: K:$L(X)>6!($L(X)<6) X
MAXIMUM LENGTH: 6
OUTPUT TRANSFORM: S Y=$$ECXTIMEX^ECXUTL(Y,0)
LAST EDITED: AUG 22, 2018
HELP-PROMPT: Answer must be 6 characters in length (HHMMSS).
DESCRIPTION:
Time of day at which the patient admission occurred.
TECHNICAL DESCR: A call is made to $$INP^ECXUTL2 using the patient's DFN and the date/time the unit dose medication
was given. The call will return the admission date/time associated with this episode of care.
In the case of a patient who is ASIH OTHER FACILITY, it will be the date/time of the movement that
put the patient into ASIH OTHER FACILITY status.
The time portion of the DATE/TIME field (#.01) of the PATIENT MOVEMENT file (#405) is used to
populate this field.
This field is always exactly 6 numeric characters in length; if time cannot be determined, then
"000300" is used as default.
727.809,22 PLACEHOLD MPI 1;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>10!($L(X)<1) X
LAST EDITED: APR 29, 2022
HELP-PROMPT: Answer must be 1-10 characters in length.
DESCRIPTION: This field, previously known as MASTER PATIENT INDEX, is no longer needed. The name has been
changed to PLACEHOLD MPI and its value will be set to null.
TECHNICAL DESCR:
This field is no longer in use as of patch ECX*3*184.
727.809,23 PLACEHOLDER 1;2 FREE TEXT
INPUT TRANSFORM: K:$L(X)>10!($L(X)<1) X
LAST EDITED: APR 19, 2016
HELP-PROMPT: Answer must be 1-10 characters in length.
DESCRIPTION: This field, previously known as DSS PRODUCT DEPARTMENT, is no longer needed. The name has been
changed to PLACEHOLDER and its value will be set to null.
TECHNICAL DESCR:
This field is no longer in use as of patch ECX*3*161.
727.809,24 PLACEHOLDER 1;3 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<1) X
LAST EDITED: APR 26, 2007
HELP-PROMPT: Answer must be 1-8 characters in length.
DESCRIPTION:
Currently NULL.
TECHNICAL DESCR:
Currently NULL.
727.809,25 DOM,PRRTP AND SAARTP INDICATOR 1;4 SET
'P' FOR GEN. PRRTP;
'T' FOR PTSD PRRTP;
'S' FOR DOM. PRRTP;
'H' FOR HOMELESS CWT/TR;
'A' FOR SA CWT/TR;
'D' FOR DOMICILIARY;
'B' FOR PTSD CWT/TR;
'C' FOR GEN. CWT/TR;
LAST EDITED: MAY 30, 2012
HELP-PROMPT: Enter the indicator associated with the treating specialty assigned to this record.
DESCRIPTION: Indicates if the patient is admitted to either a RRTP, PRRTP, or SARRTP at the time care is
provided.
TECHNICAL DESCR: If the patient's treating specialty exists in the DSS TREATING SPECIALTY TRANSLATION file
(#727.831), data is derived from the DOM/PRRTP/SARRTP CODE field (#2) of the DSS TREATING SPECIALTY
TRANSLATION file (#727.831).
Otherwise, the value is null.
727.809,26 OBSERVATION PATIENT INDICATOR 1;5 SET
'NO' FOR NO;
'YES' FOR YES;
LAST EDITED: MAY 30, 2012
HELP-PROMPT: Enter observation patient status for this record.
DESCRIPTION:
Indicates if patient is considered to be an observation patient.
TECHNICAL DESCR: Data (YES, NO) is retrieved from API call $$OBSPAT^ECXUTL4:
If the patient's treating specialty exists in the DSS TREATING SPECIALTY TRANSLATION file
(#727.831), data is derived from the OBSERVATION PAT INDICATOR field (#4) of the DSS TREATING
SPECIALTY TRANSLATION file (#727.831).
If patient is outpatient and treating specialty not in file, AND Feeder Key (CLI) or DSS ID
(MTL,IVP,ECQ,NOS,SUR) is 290-297, Observation Patient Ind=YES. Else, Observation Patient Ind=NO.
Otherwise, Observation Patient Ind=NO.
727.809,27 ENCOUNTER NUMBER 1;6 FREE TEXT
INPUT TRANSFORM: K:$L(X)>18!($L(X)<1) X
LAST EDITED: MAY 03, 2001
HELP-PROMPT: Answer must be 1-18 characters in length.
DESCRIPTION:
The unique number assigned to each encounter within DSS.
TECHNICAL DESCR: This field is determined by a call to $$ENCNUM^ECXUTL4. Within this call the inpatient/outpatient
status, SSN, admit/visit date, treating specialty, observation patient indicator, and DSS
Identifier or feeder key values of the record are used to create a unique encounter number.
727.809,28 PRODUCTION DIVISION CODE 1;7 FREE TEXT
INPUT TRANSFORM: K:$L(X)>7!($L(X)<3) X
LAST EDITED: MAY 30, 2012
HELP-PROMPT: Answer must be 3-7 characters in length.
DESCRIPTION:
Identifies the division/facility where the work was performed.
TECHNICAL DESCR: Data comes from the WARD field (#5) of the UNIT DOSE EXTRACT DATA file (#727.904), which is a
pointer to the WARD LOCATION file (#42). This value is then used to get the DIVISION field
(#.015), a pointer to the MEDICAL CENTER DIVISION file (#40.8), which is then used to call API
GETDIV^ECXDEPT to get the STATION NUMBER field (#99) from the INSTITUTION file (#4).
727.809,29 PLACEHOLD MEANS TEST 1;8 FREE TEXT
Means Test
INPUT TRANSFORM: K:$L(X)>1!($L(X)<1) X
MAXIMUM LENGTH: 1
LAST EDITED: MAY 26, 2020
HELP-PROMPT: Enter the means test code for this patient (1character in length).
DESCRIPTION: This field, previously known as MEANS TEST, is no longer needed. The name has been changed to
PLACEHOLD MEANS TEST and its value will be set to null.
TECHNICAL DESCR:
This field is no longer in use as of patch ECX*3*178.
727.809,30 ELIGIBILITY 1;9 FREE TEXT
Eligibility
INPUT TRANSFORM: K:$L(X)>3!($L(X)<1) X
LAST EDITED: JUN 12, 2002
HELP-PROMPT: Answer must be 1-3 characters in length
DESCRIPTION:
Appropriate eligibility code based on veteran or non-veteran status.
TECHNICAL DESCR: Using the patient pointer (DFN) stored in the PATIENT NO. - DFN field (4) in the UNIT DOSE LOCAL
EXTRACT file (#727.809), ELIGIBILITY data is derived from the PRIMARY ELIGIBILITY CODE field (.361)
in the PATIENT file (#2). PRIMARY ELIGIBILITY CODE is a pointer to the ELIGIBILITY CODE file (#8).
The data is derived from the MAS ELIGIBILITY CODE field (8) in the ELIGIBILITY CODE file (#8) which
in turn is a pointer to the MAS ELIGIBILITY CODE file (#8.1).
The pointer value to file #8.1 is converted by ELIG^ECXUTL3 to the corresponding eligibility code
used by NPCD. This code is composed of two or three numeric characters.
727.809,31 DATE OF BIRTH 1;10 FREE TEXT
Date of Birth
INPUT TRANSFORM: K:$L(X)>8!($L(X)<8) X
LAST EDITED: JUN 12, 2002
HELP-PROMPT: Answer must be 8 characters in length.
DESCRIPTION:
Patient's date of birth.
TECHNICAL DESCR: Date of Birth is returned through the supported call DEM^VADPT. It is then represented by an
8-character numeric string in the YYYYMMDD format.
727.809,32 SEX 1;11 SET
Sex
'M' FOR MALE;
'F' FOR FEMALE;
LAST EDITED: JUN 07, 2002
HELP-PROMPT: Enter the sex of the patient.
DESCRIPTION:
Patient's gender.
TECHNICAL DESCR: Data is taken from the SEX field (#.02) of the patient's record in the PATIENT file (#2).
The status indicator is returned by DEM^VADPT.
727.809,33 STATE 1;12 FREE TEXT
State
INPUT TRANSFORM: K:$L(X)>2!($L(X)<2) X
LAST EDITED: JUN 07, 2002
HELP-PROMPT: Answer must be 2 characters in length.
DESCRIPTION:
The state in which the patient resides.
TECHNICAL DESCR: Using the patient pointer (DFN) stored in the PATIENT NO. - DFN field (#4) in the UNIT DOSE LOCAL
EXTRACT file (#727.809), data is derived from the STATE field (#.115) in the PATIENT file (#2)
which points to the STATE file (#5). From the STATE file record, use the two character VA STATE
CODE field (#2).
727.809,34 COUNTY 1;13 FREE TEXT
County
INPUT TRANSFORM: K:$L(X)>3!($L(X)<3) X
LAST EDITED: JUN 07, 2002
HELP-PROMPT: Answer must be 3 characters in length.
DESCRIPTION:
The county in which the patient resides.
TECHNICAL DESCR: Using the patient pointer (DFN) stored in the PATIENT NO. - DFN field (#4) in the UNIT DOSE LOCAL
EXTRACT file (#727.809), data is taken from the COUNTY field (#.117) in the PATIENT file (#2) which
points to a subfile record in the COUNTY multiple field (#3) of the STATE file (#5). A pointer to
the STATE file (#5) is obtained from the STATE field (#.115) of the file #2 record.
From the subfile record of field #3 of file #5, use the value of the VA COUNTY CODE field (#2).
727.809,35 ZIP+4 1;14 FREE TEXT
Zip+4
INPUT TRANSFORM: K:$L(X)>10!($L(X)<5) X
LAST EDITED: JUN 07, 2002
HELP-PROMPT: Answer must be 5-10 characters in length.
DESCRIPTION: The ZIP code for where the patient resides. The 5-character ZIP code is provided if ZIP+4 is not
available.
TECHNICAL DESCR: The patient's ZIP code with optional 4-digit extension as found in the ZIP+4 field (#.1112) of the
patient's record in the PATIENT file (#2). While the ZIP+4 field in file 2 is a max of 9
characters, it does put the "-" in if the ZIP code is a +4 type.
727.809,36 VETERAN 1;15 SET
Veteran
'Y' FOR YES;
'N' FOR NO;
LAST EDITED: JUN 07, 2002
HELP-PROMPT: Select the appropriate veteran status for this patient.
DESCRIPTION:
Patient's veteran status.
TECHNICAL DESCR: Using the patient pointer (DFN) stored in the PATIENT NO. - DFN field (#4) in the UNIT DOSE LOCAL
EXTRACT file (#727.809), VETERAN data is derived from the VETERAN (Y/N)? field (#1901) in the
PATIENT file (#2).
727.809,37 PERIOD OF SERVICE 1;16 FREE TEXT
Period of Service
INPUT TRANSFORM: K:$L(X)>1!($L(X)<1) X
LAST EDITED: JUN 07, 2002
HELP-PROMPT: Answer must be 1 character in length
DESCRIPTION:
The period of service that best classifies the patient based on eligibility code.
TECHNICAL DESCR:
Period of Service is derived from the Period of Service field (#.323) in the Patient file (#2).
727.809,38 POW STATUS 1;17 SET
POW Status
'Y' FOR YES;
'N' FOR NO;
'U' FOR UKNOWN;
LAST EDITED: JUN 10, 2002
HELP-PROMPT: Enter the patient's POW Status.
DESCRIPTION:
Indicates if patient was confined as a Prisoner of War.
TECHNICAL DESCR: PATIENT file (#2); POW STATUS INDICATED? field (#.525). The status indicator is returned by
SVC^VADPT.
727.809,39 POW LOCATION 1;18 POINTER TO POW PERIOD FILE (#22)
POW Location
LAST EDITED: JUN 12, 2002
HELP-PROMPT: Enter the patient's POW location.
DESCRIPTION: If POW Status is indicated, then this is the POW confinement location/period.
1 WORLD WAR I
2 WORLD WAR II - EUROPE
3 WORLD WAR II - PACIFIC
4 KOREAN
5 VIETNAM
6 OTHER
TECHNICAL DESCR: PATIENT file (#2); POW CONFINEMENT LOCATION field (#.526). This is a pointer value to the POW
PERIOD file (#22). The location indicator is returned by SVC^VADPT.
727.809,40 RADIATION STATUS 1;19 SET
Radiation Status
'Y' FOR YES;
'N' FOR NO;
'U' FOR UNKNOWN;
'1' FOR NO RADIATION;
'2' FOR HIROSHIMA/NAGASAKI;
'3' FOR ATMOSPHERIC NUCLEAR TESTING;
'4' FOR H/N AND ATMOSPHERIC TESTING;
'5' FOR UNDERGROUND NUCLEAR TESTING;
'6' FOR EXPOSURE AT NUCLEAR FACILITY;
'7' FOR OTHER;
LAST EDITED: JUN 10, 2002
HELP-PROMPT: Enter the Radiation Status for the patient.
DESCRIPTION:
Indicates if patient claims exposure to ionizing radiation.
TECHNICAL DESCR: PATIENT file (#2); RADIATION EXPOSURE INDICATED? field (#.32103). The status indicator is returned
by SVC^VADPT.
727.809,41 AGENT ORANGE STATUS 1;20 SET
Agent Orange Status
'Y' FOR YES;
'N' FOR NO;
'U' FOR UNKNOWN;
LAST EDITED: JUN 10, 2002
HELP-PROMPT: Enter the Agent Orange Status for the patient.
DESCRIPTION:
Indicates whether patient was exposed to Agent Orange.
TECHNICAL DESCR: PATIENT file (#2); AGENT ORANGE EXPOS. INDICATED? field (#.32102). The status indicator is
returned by SVC^VADPT.
727.809,42 AGENT ORANGE LOCATION 1;21 FREE TEXT
Agent Orange Location
INPUT TRANSFORM: K:$L(X)>1!($L(X)<1) X
MAXIMUM LENGTH: 1
LAST EDITED: MAY 24, 2023
HELP-PROMPT: Choose the location where the patient was exposed to Agent Orange. Answer must be 1 character in
length.
DESCRIPTION: This field indicates the location where the patient was exposed to Agent Orange. Values are:
"B" = BLUE WATER NAVY
"K" = KOREAN DMZ
"V" = VIETNAM
"T" = THAILAND(U.S. OR ROYAL THAI MIL BASE)
"L" = LAOS
"C" = CAMBODIA(MIMOT OR KREK,KAMPONG CHAM)
"G" = GUAM, AMERICAN SAMOA, OR TERRITORIAL WATERS
"J" = JOHNSTON ATOLL
"O" = OTHER
TECHNICAL DESCR: The location is returned by a call to SVC^VADPT which gets its data from the AGENT ORANGE EXPOSURE
LOCATION field (#.3213) of the PATIENT file (#2). Values are:
"B" = BLUE WATER NAVY
"K" = KOREAN DMZ
"V" = VIETNAM
"T" = THAILAND(U.S. OR ROYAL THAI MIL BASE)
"L" = LAOS
"C" = CAMBODIA(MIMOT OR KREK,KAMPONG CHAM)
"G" = GUAM, AMERICAN SAMOA, OR TERRITORIAL WATERS
"J" = JOHNSTON ATOLL
"O" = OTHER
727.809,43 PURPLE HEART INDICATOR 1;22 SET
Purple Heart Indicator
'Y' FOR YES;
'N' FOR NO;
LAST EDITED: JUN 10, 2002
HELP-PROMPT: Enter the Purple Heart Indicator for the patient.
DESCRIPTION:
Indicates whether or not a patient is a Purple Heart recipient.
TECHNICAL DESCR: PATIENT file (#2); CURRENT PH INDICATOR field (#.531). The status indicator is returned by
SVC^VADPT.
727.809,44 MST STATUS 1;23 SET
MST Status
'Y' FOR Yes, screened reports MST;
'N' FOR Screened, does not report MST;
'D' FOR Screened, declines to answer;
'U' FOR Unknown, not screened;
LAST EDITED: JUN 13, 2012
HELP-PROMPT: Enter the patient's MST Status.
DESCRIPTION:
Indicates the Military Sexual Trauma (MST) status of a patient on the date of the encounter.
TECHNICAL DESCR: The MST HISTORY file (#29.11) holds data regarding military sexual trauma claims and effective
dates. The patients MST status is stored in the MST STATUS field (#3). A call will be made to
$$GETSTAT^DGMSTAPI(DFN,DGDATE) using the DFN in the PATIENT NO. - DFN (#4) field and the date in
the DAY field (#8).
727.809,45 CNH STATUS 1;24 SET
'YES' FOR YES;
'NO' FOR NO;
LAST EDITED: MAR 12, 2014
HELP-PROMPT: Enter the CNH status for this patient.
DESCRIPTION:
This field is used to indicate whether a patient is currently in a contract nursing home.
TECHNICAL DESCR: Using the CNHSTAT^ECXUTL4(DFN) call, the CNH status is returned based on the CNH CURRENT field
(#148) of the PATIENT file (#2).
727.809,46 ENROLLMENT LOCATION 1;25 FREE TEXT
Enrollment Location
INPUT TRANSFORM: K:$L(X)>7!($L(X)<3) X
LAST EDITED: JUN 10, 2002
HELP-PROMPT: Answer must be 3-7 characters in length
DESCRIPTION:
The facility that the patient chooses to designate as his preferred location for care.
TECHNICAL DESCR: The PREFERRED FACILITY field (# 27.02) of the PATIENT file (#2) is defined as the facility that the
patient chooses to designate as his preferred location for care. The PREFERRED FACILITY field (#
27.02) is a pointer to the INSTITUTION file (#4). From file #4, the value in the STATION NUMBER
field (#99) is used.
727.809,47 ENROLLMENT CATEGORY 1;26 SET
Enrollment Category
'E' FOR Enrolled;
'N' FOR Not Enrolled;
'P' FOR In Process;
LAST EDITED: MAY 31, 2012
HELP-PROMPT: Enter patient's enrollment category.
DESCRIPTION:
Patient's enrollment category.
TECHNICAL DESCR: ENROLLMENT CATEGORY is derived from the standard call CATEGORY^DGENA4 using the patient DFN and the
ENROLLMENT STATUS.
727.809,48 ENROLLMENT STATUS 1;27 POINTER TO ENROLLMENT STATUS FILE (#27.15)
Enrollment Status
LAST EDITED: MAY 31, 2012
HELP-PROMPT: Enter patient's enrollment status.
DESCRIPTION:
Patient's enrollment status.
TECHNICAL DESCR: ENROLLMENT STATUS is derived from the PATIENT ENROLLMENT file (#27.11) ENROLLMENT STATUS field
(#.04) which is a pointer to the ENROLLMENT STATUS file (#27.15).
727.809,49 SHAD STATUS 1;28 SET
'Y' FOR YES;
'N' FOR NO;
'U' FOR UNKNOWN;
LAST EDITED: FEB 12, 2010
HELP-PROMPT: Enter SHAD Status
DESCRIPTION:
Indicates whether patient meets requirements for Shipboard Hazard and Defense (SHAD).
TECHNICAL DESCR: Using the patient pointer (DFN) stored in the PATIENT NO. - DFN field (#4) in the UNIT DOSE LOCAL
EXTRACT file (#727.809), Shipboard Hazard and Defense data is derived from using DBIA #4462
GETSHAD^DGUTL3(DFN).
727.809,50 PLACEHOLD PRIMARY CARE TEAM 1;29 FREE TEXT
Primary Care Team
INPUT TRANSFORM: K:$L(X)>4!($L(X)<1) X
LAST EDITED: MAY 01, 2018
HELP-PROMPT: Enter primary care team assigned to this patient.
DESCRIPTION: This field, previously known as PRIMARY CARE TEAM, is no longer needed. The name has been changed
to PLACEHOLD PRIMARY CARE TEAM and its value will be set to null.
TECHNICAL DESCR:
This field is no longer in use as of patch ECX*3*170.
727.809,51 PLACEHOLD PC PROVIDER 1;30 FREE TEXT
Primary Care Provider
INPUT TRANSFORM: K:$L(X)>11!($L(X)<1) X
LAST EDITED: MAY 01, 2018
HELP-PROMPT: Enter primary care provider assigned to this patient.
DESCRIPTION: This field, previously known as PRIMARY CARE PROVIDER, is no longer needed. The name has been
changed to PLACEHOLD PC PROVIDER and its value will be set to null.
TECHNICAL DESCR:
This field is no longer in use as of patch ECX*3*170.
727.809,52 PLACEHOLDER 1;31 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<1) X
LAST EDITED: APR 26, 2007
HELP-PROMPT: Answer must be 1-8 characters in length
DESCRIPTION:
Currently NULL.
TECHNICAL DESCR:
Currently NULL.
727.809,53 PLACEHOLD PC PROV PERSON CLASS 1;32 FREE TEXT
PC Provider Person Class
INPUT TRANSFORM: K:$L(X)>7!($L(X)<7) X
LAST EDITED: MAY 01, 2018
HELP-PROMPT: Answer must be 7 characters in length.
DESCRIPTION: This field, previously known as PC PROVIDER PERSON CLASS, is no longer needed. The name has been
changed to PLACEHOLD PC PROV PERSON CLASS and its value will be set to null.
TECHNICAL DESCR:
This field is no longer in use as of patch ECX*3*170.
727.809,54 PLACEHOLD ASSOC PC PROVIDER 1;33 FREE TEXT
Associate PC Provider
INPUT TRANSFORM: K:$L(X)>11!($L(X)<2) X
LAST EDITED: MAY 01, 2018
HELP-PROMPT: Answer must be 2-11 characters in length.
DESCRIPTION: This field, previously known as ASSOCIATE PC PROVIDER, is no longer needed. The name has been
changed to PLACEHOLD ASSOC PC PROVIDER and its value will be set to null.
TECHNICAL DESCR:
This field is no longer in use as of patch ECX*3*170.
727.809,55 PLACEHOLDER 1;34 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<1) X
LAST EDITED: APR 26, 2007
HELP-PROMPT: Answer must be 1-8 characters in length
DESCRIPTION:
Currently NULL.
TECHNICAL DESCR:
Currently NULL.
727.809,56 PLACEHOLD AS PC PROV PERSON CL 1;35 FREE TEXT
Associate PC Provider Person Class
INPUT TRANSFORM: K:$L(X)>7!($L(X)<7) X
LAST EDITED: MAY 01, 2018
HELP-PROMPT: Answer must be 7 characters in length.
DESCRIPTION: This field, previously known as ASSOC. PC PROV. PERSON CLASS, is no longer needed. The name has
been changed to PLACEHOLD AS PC PROV PERSON CL and its value will be set to null.
TECHNICAL DESCR:
This field is no longer in use as of patch ECX*3*170.
727.809,57 ORDERING DATE 2;1 FREE TEXT
Ordering Date
INPUT TRANSFORM: K:$L(X)>8!($L(X)<8) X
LAST EDITED: JUN 11, 2002
HELP-PROMPT: Answer must be 8 characters in length.
DESCRIPTION:
The date the order was first dispensed.
TECHNICAL DESCR: UNIT DOSE EXTRACT DATA file (#728.904); ORDER DATE field (#9). ORDER DATE is the START DATE/TIME
field (#10) of the UNIT DOSE multiple (#55.06) of the PHARMACY PATIENT file (#55). The format is
YYYYMMDD.
727.809,58 ORDERING STOP CODE 2;2 FREE TEXT
INPUT TRANSFORM: K:$L(X)>3!($L(X)<3) X
LAST EDITED: JUN 11, 2002
HELP-PROMPT: Answer must be 3 characters in length.
DESCRIPTION:
This field contains the stop code associated with the order.
TECHNICAL DESCR: For outpatients the stop code is the primary stop code for the clinic as determined by the AMIS
REPORTING STOP CODE field (#1) of the CLINIC STOP file (#40.7) as pointed to by the STOP CODE
NUMBER field (#8) of the HOSPITAL LOCATION file (#44) as pointed to by the CLINIC FIELD (#130) of
the UNIT DOSE multiple (#62) of the PHARMACY PATIENT file (#55). If none exists, the value is set
to null.
For observation patients the stop code is translated using the following table.
Treating Specialty Observation Stop Code
18 293
23 295
24 290
36 296
41 294
65 291
94 292
1J 297
727.809,59 HEAD & NECK CANCER INDICATOR 2;3 SET
Head and Neck Cancer Indicator
'Y' FOR YES;
'N' FOR NO;
LAST EDITED: AUG 29, 2002
HELP-PROMPT: Enter the Head & Neck Cancer Indicator for the patient.
DESCRIPTION:
Identifies whether patient has head and/or neck cancer.
TECHNICAL DESCR: Using the patient pointer (DFN) stored in the PATIENT NO. - DFN field (#4), a call is made to
$$GETCUR^DGNTAPI to retrieve the HEAD/NECK CA DX field (#2.01) of the NOSE AND THROAT RADIUM
HISTORY file (#28.11).
727.809,60 PLACEHOLD ETHNICITY 2;4 FREE TEXT
Ethnicity
INPUT TRANSFORM: K:$L(X)>6!($L(X)<1) X
LAST EDITED: MAR 15, 2018
HELP-PROMPT: Answer must be 1-6 characters in length.
DESCRIPTION: This field, previously known as ETHNICITY, is no longer needed. The name has been changed to
PLACEHOLD ETHNICITY and its value will be set to null.
TECHNICAL DESCR:
This field is no longer in use as of patch ECX*3*170.
727.809,61 PLACEHOLD RACE 1 2;5 FREE TEXT
Race 1
INPUT TRANSFORM: K:$L(X)>6!($L(X)<1) X
LAST EDITED: MAR 15, 2018
HELP-PROMPT: Answer must be 1-6 characters in length.
DESCRIPTION: This field, previously known as RACE 1, is no longer needed. The name has been changed to
PLACEHOLD RACE 1 and its value will be set to null.
TECHNICAL DESCR:
This field is no longer in use as of patch ECX*3*170.
727.809,62 PLACEHOLDER 2;6 POINTER TO DRUG FILE (#50)
LAST EDITED: APR 05, 2013
HELP-PROMPT: Enter the drug dispensed via BCMA.
DESCRIPTION:
Currently NULL. This field is not currently used.
TECHNICAL DESCR:
Currently NULL.
727.809,63 PLACEHOLDER 2;7 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>50)!(X<0)!(X?.E1"."3N.N) X
LAST EDITED: APR 05, 2013
HELP-PROMPT: Type a Number between 0 and 50, 2 Decimal Digits.
DESCRIPTION:
Currently NULL. This field is not currently used.
TECHNICAL DESCR:
Currently NULL.
727.809,64 PLACEHOLDER 2;8 FREE TEXT
INPUT TRANSFORM: K:$L(X)>40!($L(X)<1) X
LAST EDITED: APR 05, 2013
HELP-PROMPT: Answer must be 1-40 characters in length.
DESCRIPTION:
Currently NULL. This field is not currently used.
TECHNICAL DESCR:
Currently NULL.
727.809,65 PLACEHOLDER 2;9 FREE TEXT
INPUT TRANSFORM: K:$L(X)>1!($L(X)<1) X
LAST EDITED: APR 05, 2013
HELP-PROMPT: Answer must be 1 character in length.
DESCRIPTION:
Currently NULL. This field is not currently used.
TECHNICAL DESCR:
Currently NULL.
727.809,66 ORDERING PROVIDER PERSON CLASS 2;10 FREE TEXT
Ordering Provider Person Class
INPUT TRANSFORM: K:$L(X)>7!($L(X)<7) X
LAST EDITED: JUN 24, 2003
HELP-PROMPT: Answer must be 7 characters in length
DESCRIPTION:
The VA code of the Person Class of the Ordering Provider as of the date of this extract record.
TECHNICAL DESCR: ORDERING PROVIDER PERSON CLASS format of the field will be V999999, where the 999999 will be six
numeric digits. ORDERING PROVIDER PERSON CLASS is the Active Person which is determined by
$$GET^XUA4A72(PERS,DATE), where PERS is the IEN from NEW PERSON file (#200).
727.809,67 PLACEHOLD DSS IP # 2;11 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>9999999)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: FEB 04, 2019
HELP-PROMPT: Type a Number between 1 and 9999999, 0 Decimal Digits.
DESCRIPTION: This field, previously known as DSS IP #, is no longer needed. The name has been changed to
PLACEHOLD DSS IP # and its value will be set to null.
TECHNICAL DESCR:
This field is no longer in use as of patch ECX*3*174.
727.809,68 ENROLLMENT PRIORITY 2;12 FREE TEXT
INPUT TRANSFORM: K:$L(X)>2!($L(X)<1) X
LAST EDITED: MAR 01, 2004
HELP-PROMPT: Answer must be 1-2 characters in length.
DESCRIPTION:
This field contains the enrollment priority group and the enrollment priority subgroup.
TECHNICAL DESCR: ENROLLMENT PRIORITY field contains the enrollment priority group and the enrollment priority
subgroup from the PATIENT ENROLLMENT file (#27.11).
ENROLLMENT PRIORITY Groups determined for a patient enrollment include:
'1' FOR GROUP 1
'2' FOR GROUP 2
'3' FOR GROUP 3
'4' FOR GROUP 4
'5' FOR GROUP 5
'6' FOR GROUP 6
'7' FOR GROUP 7
'8' FOR GROUP 8
ENROLLMENT PRIORITY Subgroups determined for a patient enrollment include:
'a' FOR 1
'c' FOR 3
'e' FOR 5
'g' FOR 7
Data is obtained from a call to $$ENRSBGRP^DGENA4(DFN) using the patient's DFN.
727.809,69 USER ENROLLEE 2;13 SET
'U' FOR USER ENROLLED;
LAST EDITED: JUN 01, 2012
HELP-PROMPT: Enter patient's current enrollment status.
DESCRIPTION:
Indicates whether a Veteran has User Enrollee status for the current or future fiscal year.
TECHNICAL DESCR: User enrollee is determined by checking the PATIENT ENROLLMENT file (#27.11). When a user has a
current or future fiscal year in the ENROLLMENT STATUS field (#.04) the value is set to 'U' and
Null if no date or a past year's value is contained. Determined by the use of an API:
$$UESTAT^EASUSER where the Patient Identifier (DFN) is passed in.
727.809,70 PATIENT TYPE 2;14 SET
'AC' FOR ACTIVE DUTY;
'AL' FOR ALLIED VETERAN;
'CO' FOR COLLATERAL;
'EM' FOR EMPLOYEE;
'IN' FOR INELIGIBLE;
'MI' FOR MILITARY RETIREE;
'NO' FOR NON-VETERAN (OTHER);
'NS' FOR NSC VETERAN;
'SC' FOR SC VETERAN;
'TR' FOR TRICARE;
LAST EDITED: JUN 01, 2012
HELP-PROMPT: Enter type of patient.
DESCRIPTION: Refers to the various types of patient which may be seen at a VA facility. Every patient in the
system must have a TYPE specified.
TECHNICAL DESCR: PATIENT TYPE is derived from a call to TYPE^ECXUTL5(DFN). Using the patient's DFN, the NAME field
(#.01) of the TYPE OF PATIENT file (#391) as pointed to by the TYPE field (#391) of the PATIENT
file (#2) is shortened to the first two characters to determine the value stored in the PATIENT
TYPE field (#70).
727.809,71 CV STATUS ELIGIBILITY 2;15 SET
'Y' FOR YES;
'E' FOR ELIGIBILITY EXPIRED;
LAST EDITED: JUN 01, 2012
HELP-PROMPT: Enter patient's combat veteran eligibility.
DESCRIPTION: Records if veteran served on active duty in a theater of combat operations during a period of war
after the Persian Gulf War or in combat against a hostile force during a period of hostilities
after November 11, 1998.
TECHNICAL DESCR: CV STATUS ELIGIBILITY is determined by the use of API $$CVEDT^DGCV(DFN,DATE) that checks the COMBAT
VET END DATE field (#.5295) from the PATIENT file (#2) to determine CV Status. API returns three
pieces (i.e. 1^20010106^0) and the first piece is resolved as follows.
1 - veteran qualifies as a CV
0 - veteran does not qualify as a CV
-1 - bad DFN
Based on this result the field will be set to 'Y' for 'YES' or 'E' for 'ELIGIBILITY EXPIRED' or
'NULL' for not eligible.
727.809,72 CV ELIGIBILITY END DATE 2;16 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<8) X
LAST EDITED: JUN 01, 2012
HELP-PROMPT: Answer must be 8 characters in length.
DESCRIPTION: Records the Combat Veteran eligibility expiration date of the veteran who served on active duty in
a theater of combat operations during a period of war after the Persian Gulf War or in combat
against a hostile force during a period of hostilities after November 11, 1998
TECHNICAL DESCR: CV ELIGIBILITY END DATE is determined by the use of API $$CVEDT^DGCV(DFN,DATE) that checks the
COMBAT VET END DATE field (#.5295) from the PATIENT file (#2) to determine CV Status. API returns
three pieces (i.e. 1^20010106^0) the 2nd piece is the COMBAT VET END DATE in HL7 format.
727.809,73 ENCOUNTER CV 2;17 SET
'Y' FOR YES;
LAST EDITED: JUN 01, 2012
HELP-PROMPT: Enter patient's combat veteran eligibility.
DESCRIPTION: Records if a veteran served on active duty in a theater of combat operations during a period of war
after the Persian Gulf War or in combat against a hostile force during a period of hostilities
after November 11, 1998.
TECHNICAL DESCR: ENCOUNTER CV is determined by the use of API $$CVEDT^DGCV(DFN,DATE) that checks the COMBAT VET END
DATE field (#.5295) from the PATIENT file #(2) to determine CV Status. API returns three pieces
(i.e. 1^20100106^0). The third piece returns:
1 - vet was eligible on date specified
0 - vet was not eligible on date specified
Based on these returns, the value for this field shall be Y for Yes if value is 1 or left blank if
0 to indicate ineligibility.
727.809,74 NATIONAL PATIENT RECORD FLAG 2;18 SET
'Y' FOR YES;
LAST EDITED: JUN 01, 2012
HELP-PROMPT: Indicate if patient is associated with a category 1 patient record flag.
DESCRIPTION: This field records whether the patient's record contains 1 or more active category 1 (National)
Patient Record Flags.
TECHNICAL DESCR: The NATIONAL PATIENT RECORD FLAG field is set based on the results of the
$$GETACT^DGPFAPI(DFN,TARGET ARRAY) call. This call looks at the category 1 national patient record
flags as recorded in the PRF NATIONAL FLAG file (#26.15). The resulting value of this call is the
number of active category I patient record flags assigned to this patient. This field is set to Y
(YES) if the result is greater than zero. A value of zero causes this field to be left null.
727.809,75 ERI 2;19 FREE TEXT
INPUT TRANSFORM: K:$L(X)>2!($L(X)<1) X
MAXIMUM LENGTH: 2
LAST EDITED: MAY 05, 2020
HELP-PROMPT: Answer must be 1-2 characters in length.
DESCRIPTION: This field identifies patients from impacted zip code areas designated by the Federal Emergency
Management Agency (FEMA).
TECHNICAL DESCR: This field is extracted from the EMERGENCY RESPONSE INDICATOR field (#.181) located in the PATIENT
file (#2). Values are:
"K" = Hurricane Katrina
"P" = Pandemic
Null
727.809,76 SW ASIA CONDITIONS 2;20 SET
'Y' FOR YES;
'N' FOR NO;
'U' FOR UNKNOWN;
LAST EDITED: MAY 27, 2009
DESCRIPTION: This field is used to indicate if this visit represents treatment of a VA patient claiming exposure
to Southwest Asia Conditions.
TECHNICAL DESCR: This field is derived from the SOUTHWEST ASIA CONDITIONS? field (#.322013) in the Patient File (#2)
using the patient's DFN. The status indicator is returned by SVC^VADPT. The SVC^VADPT called is
made from routine PAT^ECXUTL3. The field values are:
Y = YES
N = NO
U = UNKNOWN
727.809,77 OEF/OIF 2;21 FREE TEXT
INPUT TRANSFORM: K:$L(X)>9!($L(X)<1) X
LAST EDITED: MAY 02, 2007
HELP-PROMPT: Answer must be 1-9 characters in length.
DESCRIPTION: The Military Operation in which the patient was in combat during the specified time period. This
field is a length of nine characters and reflects the OEF or OIF where this patient was in combat.
TECHNICAL DESCR: The Military Operation in which the patient was in combat during the specified time period. This
field is a length of nine characters and reflects the OEF or OIF where this patient was in combat.
The value of this field is derived from the LOCATION OF SERVICE field (#.01) from SERVICE [OEF OR
OIF] sub-file (#2.3215) of field (#.3215) located in the PATIENT file (#2). DSS will capture once,
each location where the veteran served. In order to accommodate multiple locations, the values for
this field are concatenated into this 9-character field. Possible field values are one or more
combinations of the following: OEF = Operation Enduring Freedom OIF = Operation Iraqi Freedom
UNK = Unknown OEF/OIF
727.809,78 OEF/OIF RETURN DATE 2;22 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<1) X
LAST EDITED: MAY 02, 2007
HELP-PROMPT: Answer must be 1-8 characters in length.
DESCRIPTION: The date the patient left the OEF/OIF area, if known. Otherwise, it is the end date of military pay
for this OEF/OIF deployment. This date field has a format equal to YYYYMMDD.
TECHNICAL DESCR: The date the patient left the OEF/OIF area, if known. Otherwise, it is the end date of military pay
for this OEF/OIF deployment. This date field has a format equal to YYYYMMDD.
727.809,79 PLACEHOLD ASSOC PC PROV NPI 2;23 FREE TEXT
INPUT TRANSFORM: K:$L(X)>15!($L(X)<1) X
LAST EDITED: MAY 01, 2018
HELP-PROMPT: Answer must be 1-15 characters in length.
DESCRIPTION: This field, previously known as ASSOCIATE PC PROVIDER NPI, is no longer needed. The name has been
changed to PLACEHOLD ASSOC PC PROV NPI and its value will be set to null.
TECHNICAL DESCR:
This field is no longer in use as of patch ECX*3*170.
727.809,80 PLACEHOLD PC PROVIDER NPI 2;24 FREE TEXT
INPUT TRANSFORM: K:$L(X)>15!($L(X)<1) X
LAST EDITED: MAY 01, 2018
HELP-PROMPT: Answer must be 1-15 characters in length.
DESCRIPTION: This field, previously known as PRIMARY CARE PROVIDER NPI, is no longer needed. The name has been
changed to PLACEHOLD PC PROVIDER NPI and its value will be set to null.
TECHNICAL DESCR:
This field is no longer in use as of patch ECX*3*170.
727.809,81 PROVIDER NPI 2;25 FREE TEXT
INPUT TRANSFORM: K:$L(X)>15!($L(X)<1) X
LAST EDITED: MAY 02, 2007
HELP-PROMPT: Answer must be 1-15 characters in length.
DESCRIPTION: A standard unique life-long identifier of the individuals providing health care services. This
field has a length of fifteen characters.
TECHNICAL DESCR: A standard unique life-long identifier of the individuals providing health care services. This
field has a length of fifteen characters. The qualified identifier is retrieved via the supporting
Kernel API: $$NPI^XUSNPI.
727.809,82 COUNTRY CODE 2;26 FREE TEXT
INPUT TRANSFORM: K:$L(X)>3!($L(X)<1) X
LAST EDITED: JUN 09, 2009
HELP-PROMPT: The code for the country. Answer must be 1-3 characters in length.
DESCRIPTION:
The code for the country associated with the address.
TECHNICAL DESCR: The three-character alpha identifying code is copied from the CODE field (#.01) of the COUNTRY file
(#779.004).
727.809,83 PATCAT 2;27 SET
'AD' FOR Active Duty;
'ADD' FOR Active Duty Dependent;
'FNRS' FOR Former Non-Remarried Spouse;
'RET' FOR Retired;
'RETD' FOR Retiree Dependent;
'RES' FOR Reservist;
'REC' FOR Recruit;
'TDRL' FOR Temporary Disability;
'TFL' FOR TRICARE for Life;
LAST EDITED: SEP 03, 2010
HELP-PROMPT: Select the Patient's Category for the FHCC Reconciliation process.
DESCRIPTION: This is the Patient's category which will be used for FHCC (Federal Health Care Center)
Reconciliation. DSS must capture and report DoD patients so that the FHCC reconciliation process
can function as designed. "Reconciliation" is the process used within the new FHCC to determine
which patients DoD pays for and which VA pays for.
TECHNICAL DESCR: If the VistA Patient Type Code (TYPE field (#391) of the PATIENT file (#2)
= Active Duty, Military Retiree, or TRICARE, then the value(s) in the VistA Other Eligibility
multiple (PATIENT ELIGIBILITIES field (#361) of the PATIENT file (#2), which points to locally
modifiable ELIGIBILITY CODE file (#8) should be evaluated. If the value in the ELIGIBILITY CODE is
equal to any entry in the set of codes in this field, the value should be placed in this field.
727.809,84 ENCOUNTER SC 2;28 SET
'Y' FOR YES;
'N' FOR NO;
LAST EDITED: MAR 10, 2013
HELP-PROMPT: Is this Encounter Service Connected?
DESCRIPTION:
Indicates if treatment provided during this patient encounter is Service Connected.
TECHNICAL DESCR: Using a pointer to the VISIT file (#9000010) a call is made to API VISIT^ECXSCX1 which in turn
calls ENCEVENT^PXAPI. This call returns visit data, including the SERVICE CONNECTED field (#80001)
in the VISIT file (#9000010).
727.809,85 CAMP LEJEUNE STATUS 2;29 SET
'Y' FOR YES;
'N' FOR NO;
LAST EDITED: MAR 10, 2013
HELP-PROMPT: Indicate Camp Lejeune status for the patient.
DESCRIPTION: Indicates if patient was exposed to contaminated water while stationed at Camp Lejeune, NC between
January 1, 1957 and December 31, 1987.
TECHNICAL DESCR: Using the patient's DFN, a call is made to PAT^ECXUTL3, which in turn calls SVC^VADPT. This call
returns all service related information for a patient, including their Camp Lejeune status.
727.809,86 ENCOUNTER CAMP LEJEUNE 2;30 SET
'Y' FOR YES;
'N' FOR NO;
LAST EDITED: MAR 10, 2013
HELP-PROMPT: Indicate if this encounter is related to exposure at Camp Lejeune.
DESCRIPTION: Indicates if episode of care is related to exposure to contaminated water while stationed at Camp
Lejeune, NC between January 1, 1957 and December 31, 1987.
TECHNICAL DESCR: Using a pointer to the VISIT file (#9000010) a call is made to API VISIT^ECXSCX1 which in turn
calls ENCEVENT^PXAPI. The ENCEVENT^PXAPI returns the encounter Camp Lejeune data from the VISIT
file (#9000010).
727.809,87 COMBAT VETERAN INDICATOR 2;31 SET
'Y' FOR YES;
'N' FOR NO;
LAST EDITED: MAR 06, 2014
HELP-PROMPT: Enter 'YES' if this patient is a Combat Veteran.
DESCRIPTION:
Identifies if the patient served in a combat zone.
TECHNICAL DESCR: Using the patient pointer (DFN) stored in the PATIENT NO. - DFN field (#4) in this file, COMBAT
SERVICE INDICATOR data is derived from the COMBAT SERVICE INDICATED field (#.5291) in the PATIENT
file (#2). COMBAT SERVICE INDICATED is returned by the supported call SVC^VADPT.
727.809,88 COMBAT VETERAN LOCATION 2;32 FREE TEXT
INPUT TRANSFORM: K:$L(X)>14!($L(X)<1) X
LAST EDITED: APR 03, 2014
HELP-PROMPT: Answer must be 1-14 characters in length.
DESCRIPTION:
Identifies the war in which the combat service was incurred.
TECHNICAL DESCR: Using the patient pointer (DFN) stored in the PATIENT NO. - DFN field (#4) in this file, COMBAT
SERVICE LOCATION data is derived from the COMBAT SERVICE LOCATION field (#.5292) in the PATIENT
file (#2). The COMBAT SERVICE LOCATION IEN is returned by the supported call SVC^VADPT, this IEN
is then used to retrieve the ABBREVIATION field(#1) from the POW PERIOD file (#22).
727.809,89 NEW SCRIPT 2;33 SET
'Y' FOR YES;
'N' FOR NO;
LAST EDITED: MAR 06, 2014
HELP-PROMPT: Enter 'YES' if the dispensing of this medication required pharmacist review.
DESCRIPTION: Identifies those UDP pharmacy transactions where the pharmacist reviewed the patient's medications
before a new prescription was filled or an existing one renewed.
TECHNICAL DESCR: To determine whether the pharmacist needed to review this medication before it was dispensed the
ACTION field (#2) of the ACTIVITY LOG multiple (#29) of the UNIT DOSE multiple (#62) of the
PHARMACY PATIENT file (#55) is scanned for an activity of pharmacist verification or pharmacist
verification (renewal).
If this is the first time this medication was dispensed since verification then this field is
marked as "yes", indicating that the pharmacist took action on the prescription. If this is a
subsequent dispensing of the same order then this field is marked "no".
The source for each dispensing of the medication is the UNIT DOSE EXTRACT DATA file (#728.904),
which is populated for the Decision Support Software (DSS) package directly by the Pharmacy
package.
727.809,90 PATIENT DIVISION 2;34 FREE TEXT
INPUT TRANSFORM: K:$L(X)>7!($L(X)<3) X
MAXIMUM LENGTH: 7
LAST EDITED: JUN 29, 2017
HELP-PROMPT: Enter the 3 to 7 character Station Number of the facility where the work was performed.
DESCRIPTION:
This field is the Station Number of the facility that performed the work.
TECHNICAL DESCR: Data comes from the WARD field (#5) of the UNIT DOSE EXTRACT DATA file (#727.904), which is a
pointer to the WARD LOCATION file (#42). This value is then used to get the DIVISION field (#.015),
a pointer to the MEDICAL CENTER DIVISION file (#40.8), which is the input parameter for the
RADDIV^ECXDEPT API. RADDIV returns the STATION NUMBER field (#99) from the INSTITUTION file (#4).
727.809,91 VISTA DEA SPECIAL HDLG 3;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>6!($L(X)<1) X
MAXIMUM LENGTH: 6
LAST EDITED: MAR 11, 2019
HELP-PROMPT: Answer must be 1-6 characters in length.
DESCRIPTION:
Identifies the DEA codes assigned to the drug associated with this record.
TECHNICAL DESCR:
Derived from the DEA, SPECIAL HDLG field (#3) in the DRUG file (#50).
727.809,92 PLACEHOLD CERNER 4;1 FREE TEXT
Placehold Cerner
INPUT TRANSFORM: K:$L(X)>439!($L(X)<1) X
MAXIMUM LENGTH: 439
LAST EDITED: APR 29, 2022
HELP-PROMPT: Answer must be 1-439 characters in length.
DESCRIPTION:
This field is for the Cerner extract data.
TECHNICAL DESCR:
This field is reserved for CERNER extract data.
727.809,93 NEW MPI 5;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>20!($L(X)<1) X
MAXIMUM LENGTH: 20
LAST EDITED: APR 29, 2022
HELP-PROMPT: Answer must be 1-20 characters in length.
DESCRIPTION: A national VA system IDENTIFIER which uniquely identifies a patient.
Commonly called "Patient ICN" or "Patient IEN"; not to be confused with the IEN from the VistA
PATIENT file.
TECHNICAL DESCR: Derived by calling API $$GETICN^MPIF001 (supported DBIA #2701) that returns the Integration Control
Number (ICN) and the ICN checksum for the given patient in the PATIENT file (#2).
727.809,94 SELF IDENTIFIED GENDER 5;2 SET
'M' FOR Male;
'F' FOR Female;
'TM' FOR Transgender Male;
'TF' FOR Transgender Female;
'O' FOR Other;
'N' FOR Does not wish to disclose;
'B' FOR Non-Binary;
LAST EDITED: APR 29, 2022
HELP-PROMPT: Answer must be 1-2 characters in length.
DESCRIPTION: The SELF IDENTIFIED GENDER value indicates the patient's personal sense of their gender identity
(if they choose to provide it).
Self-identified gender may be the same or different as the sex assigned at birth.
TECHNICAL DESCR: Using the patient pointer (DFN) stored in the PATIENT NO. - DFN field (#4) in the UNIT DOSE LOCAL
EXTRACT file (#727.809), this data is derived from the SELF IDENTIFIED GENDER field (#.024) in the
PATIENT file (#2).
727.809,95 PRICE PER DISPENSE UNIT 5;3 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>999999)!(X<0)!(X?.E1"."5.N) X
LAST EDITED: MAR 31, 2023
HELP-PROMPT: Enter the price per dispense unit for the drug. Value must be a number between 0 and 999999, 4
decimal digits.
DESCRIPTION:
This is the price per dispense unit for this drug.
TECHNICAL DESCR:
This is the PRICE PER DISPENSE UNIT field (#16) of the DRUG file (#50).
727.809,96 DISPENSE UNIT 5;4 FREE TEXT
INPUT TRANSFORM: K:$L(X)>10!($L(X)<1) X
MAXIMUM LENGTH: 10
LAST EDITED: MAR 31, 2023
HELP-PROMPT: Enter the dispense unit for the drug. Answer must be 1-10 characters in length.
DESCRIPTION:
This is the dispense unit of this drug.
TECHNICAL DESCR:
This is the DISPENSE UNIT field (#14.5) of the DRUG file (#50).
FILES POINTED TO FIELDS
DRUG (#50) PLACEHOLDER (#62)
DSS EXTRACT LOG (#727) EXTRACT NUMBER (#2)
ENROLLMENT STATUS (#27.15) ENROLLMENT STATUS (#48)
HOSPITAL LOCATION (#44) WARD (#11)
MEDICAL CENTER DIVISION (#40.8) FACILITY (#3)
PATIENT (#2) PATIENT NO. - DFN (#4)
PATIENT MOVEMENT (#405) MOVEMENT FILE # (#14)
POW PERIOD (#22) POW LOCATION (#39)
INPUT TEMPLATE(S):
PRINT TEMPLATE(S):
SORT TEMPLATE(S):
FORM(S)/BLOCK(S):