STANDARD DATA DICTIONARY #727.833 -- BCMA EXTRACT FILE 9/29/25 PAGE 1
STORED IN ^ECX(727.833, *** 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 BCMA (Bar Code Medication
Administration) extract from existing DHCP files. Entries into this file are made by extracting data from several files. The BCM
MEDICATION LOG (#53.79) file is a major source of fields within this file. 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
(#2) field. 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.
CROSS
REFERENCED BY: EXTRACT NUMBER(AC), SEQUENCE NUMBER(B)
LAST MODIFIED: NOV 18,2023@19:04:19
727.833,.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: MAR 08, 2010
HELP-PROMPT: Type 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
CROSS-REFERENCE: 727.833^B
1)= S ^ECX(727.833,"B",$E(X,1,30),DA)=""
2)= K ^ECX(727.833,"B",$E(X,1,30),DA)
727.833,1 YEAR MONTH 0;2 FREE TEXT
INPUT TRANSFORM: K:$L(X)>6!($L(X)<6)!'(X?6N) X
OUTPUT TRANSFORM: S Y=$$ECXYMX^ECXUTL(Y)
LAST EDITED: OCT 25, 2010
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.833,2 EXTRACT NUMBER 0;3 POINTER TO DSS EXTRACT LOG FILE (#727)
Extract Number
LAST EDITED: OCT 25, 2010
HELP-PROMPT: Enter the extract number for this entry.
DESCRIPTION:
The corresponding entry in the DSS EXTRACT LOG (#727) file for this extract.
TECHNICAL DESCR: A pointer to the DSS EXTRACT LOG (#727) file. The primary purpose is to pick up the header for the
mail message.
CROSS-REFERENCE: 727.833^AC
1)= S ^ECX(727.833,"AC",$E(X,1,30),DA)=""
2)= K ^ECX(727.833,"AC",$E(X,1,30),DA)
3)= DO NOT DELETE.
This cross reference is essential for managing and purging data in this file.
727.833,3 FACILITY 0;4 FREE TEXT
Facility
INPUT TRANSFORM: K:$L(X)>7!($L(X)<3) X
MAXIMUM LENGTH: 7
LAST EDITED: SEP 05, 2017
HELP-PROMPT: Answer must be 3-7 characters in length.
DESCRIPTION:
This is the Station Number of the Division where the medication was administered.
TECHNICAL DESCR: The Station Number of the Division where the medication was administered. It is derived from the
DIVISION field (#.015) of the WARD LOCATION file (#42), which points to the MEDICAL CENTER DIVISION
file (#40.8). The resulting value is the STATION NUMBER field (#99) from the INSTITUTION file (#4).
727.833,4 PATIENT NO. - DFN 0;5 POINTER TO PATIENT FILE (#2)
Patient No. - DFN
LAST EDITED: NOV 15, 2010
HELP-PROMPT: Enter the patient for this extract record.
DESCRIPTION:
An identifying number for the patient at the local site.
TECHNICAL DESCR: Derived from the PATIENT (#.01) field in the BCMA MEDICATION LOG (#53.79) file. PATIENT NO. - DFN
is a pointer to the NAME (#.01) field of the PATIENT (#2) file. This data represents the patient
DFN.
727.833,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: NOV 10, 2010
HELP-PROMPT: Answer must be 9-10 characters in length.
DESCRIPTION:
This is the patient's social security number.
TECHNICAL DESCR: Using the patient pointer (DFN) stored in the PATIENT NO. - DFN (#4) field in this file, SSN data
is derived from the SOCIAL SECURITY NUMBER (#.09) field in the PATIENT (#2) file.
"Test" patient status is determined in PAT^ECXUTL3. Any patient with an SSN beginning with "00000"
will not be included in the extract.
727.833,6 NAME 0;7 FREE TEXT
Name
INPUT TRANSFORM: K:$L(X)>4!($L(X)<4) X
LAST EDITED: NOV 16, 2010
HELP-PROMPT: 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 (#4) field in the BCMA EXTRACT file
(#727.833), NAME data is derived from the NAME field (#.01) in the PATIENT (#2) file. 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.833,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.833,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: NOV 19, 2010
HELP-PROMPT: Answer must be 8 characters in length.
DESCRIPTION:
Date on which the patient was administered medication.
TECHNICAL DESCR: This field is always exactly 8 numeric characters in length. Taken from the ACTION DATE/TIME
(#.06) field of the BCMA MEDICATION LOG (#53.79) file. It is parsed so that only the date portion
is stored in YYYYMMDD format, for example 19970201.
727.833,9 DATE OF BIRTH 0;10 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<8) X
OUTPUT TRANSFORM: S Y=$$ECXDATEX^ECXUTL(Y)
LAST EDITED: NOV 23, 2010
HELP-PROMPT: Answer must be 8 characters in length.
DESCRIPTION:
The patient's date of birth.
TECHNICAL DESCR: Data source:
PATIENT file (#2); DATE OF BIRTH field (#.03)
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.833,10 SEX 0;11 SET
'M' FOR MALE;
'F' FOR FEMALE;
LAST EDITED: NOV 15, 2010
HELP-PROMPT: Enter the gender 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 gender is returned by DEM^VADPT.
727.833,11 STATE 0;12 FREE TEXT
INPUT TRANSFORM: K:$L(X)>2!($L(X)<2) X
LAST EDITED: NOV 09, 2010
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 this file, STATE data
is derived from the STATE field (#.115) in the PATIENT file (#2) which points to the STATE file
(#5). For the STATE file entry, data transmitted is the two character VA STATE CODE field (#2).
727.833,12 COUNTY 0;13 FREE TEXT
INPUT TRANSFORM: K:$L(X)>3!($L(X)<3) X
LAST EDITED: NOV 08, 2010
HELP-PROMPT: Answer must be 3 characters in length.
DESCRIPTION:
This is the County in which the Patient resides.
TECHNICAL DESCR: Using the patient pointer (DFN) stored in the PATIENT NO. - DFN field (#4) in this file, data is
taken from the COUNTY field (#.117) in the PATIENT file (#2), which points to a sub-file record in
the COUNTY multiple (#3) of the STATE file (#5). The three character VA COUNTY CODE field (#2)
within the COUNTY multiple (#3) is used.
727.833,13 ZIP +4 0;14 FREE TEXT
Zip Code
INPUT TRANSFORM: K:$L(X)>10!($L(X)<5) X
LAST EDITED: NOV 02, 2010
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 the PATIENT file (#2) is a max
of 9 characters, it does put the "-" in if the ZIP code is a +4 type.
727.833,14 COUNTRY CODE 0;15 FREE TEXT
Country Code
INPUT TRANSFORM: K:$L(X)>3!($L(X)<1) X
LAST EDITED: NOV 15, 2010
HELP-PROMPT: The code for the country. Answer must be 1-3 characters in length.
DESCRIPTION:
This is the code for the country associated with the address.
TECHNICAL DESCR: The three-character alpha identifying code is copied from the CODE (#.01) field of the COUNTRY
(#779.004) file.
727.833,15 WARD 0;16 POINTER TO HOSPITAL LOCATION FILE (#44)
LAST EDITED: NOV 18, 2010
HELP-PROMPT: Enter the ward location for this patient.
DESCRIPTION:
Current ward where the patient is located.
TECHNICAL DESCR: This field is initialized to a null, indicating an outpatient status. A call to IN5^VADPT using
the patient IEN and the event date (DAY field (#8) in FM format) is made. If data is returned
identifying an inpatient episode, the value of VAIP(5), ward location, is used to get the HOSPITAL
LOCATION FILE POINTER file (#44) in the WARD LOCATION file (#42) which is a pointer to the HOSPITAL
LOCATION file (#44).
727.833,16 TREATING SPECIALTY 0;17 FREE TEXT
INPUT TRANSFORM: K:$L(X)>2!($L(X)<1) X
LAST EDITED: NOV 18, 2010
HELP-PROMPT: Answer must be 1-2 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. A call to IN5^VADPT using the
patient IEN and the event date (DAY field (#8) in FM format) is made. If data 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.833,17 PROVIDER 0;18 FREE TEXT
INPUT TRANSFORM: K:$L(X)>11!($L(X)<2) X
LAST EDITED: JUL 17, 2012
HELP-PROMPT: Answer must be 2-11 characters in length.
DESCRIPTION:
The provider assigned to this patient through the PCMM module.
TECHNICAL DESCR: Derived by calling API EN^PSJBCMA1. Using the ORDER REFERENCE NUMBER field (#26) from this file.
Provider will be returned in the 1st piece of the returning ^TMP(PTMP,$J,1) global. It is
extracted from the PHARMACY PATIENT file (#55) by either the PROVIDER field (#1) of the UNIT DOSE
multiple (#62) or the PROVIDER field (#.06) of the IV multiple (#100).
A "2" is prefixed to the pointer value to indicate that the source file is "200". For example, if
the IEN of the provider in the NEW PERSON file (#200) is 98765, the value that will be stored is
298765.
727.833,18 PROVIDER PERSON CLASS 0;19 FREE TEXT
INPUT TRANSFORM: K:$L(X)>7!($L(X)<7) X
LAST EDITED: AUG 16, 2010
HELP-PROMPT: Answer must be 7 characters in length.
DESCRIPTION:
The VA Code of the Person Class of the Provider associated with this record.
TECHNICAL DESCR: Active Person Class is determined by the supported call $$GET^XUA4A72(PERS,DATE), where PERS is the
IEN from file #200 and DATE is the date of the event. The VA CODE is determined by the 7th piece
of the returned value string.
727.833,19 PROVIDER NPI 0;20 FREE TEXT
INPUT TRANSFORM: K:$L(X)>10!($L(X)<1) X
LAST EDITED: NOV 08, 2010
HELP-PROMPT: Answer must be 1-10 characters in length.
DESCRIPTION:
A standard unique life-long identifier of the individuals providing health care services.
TECHNICAL DESCR:
The qualified identifier shall be retrieved via the supporting Kernel API:$$NPI^XUSNPI.
727.833,20 PLACEHOLD PC PROVIDER 0;21 FREE TEXT
INPUT TRANSFORM: K:$L(X)>11!($L(X)<11) X
LAST EDITED: APR 30, 2018
HELP-PROMPT: The answer must be 11 characters in length.
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.833,21 PLACEHOLD PC PROV PERSON CLASS 0;22 FREE TEXT
INPUT TRANSFORM: K:$L(X)>7!($L(X)<7) X
LAST EDITED: APR 30, 2018
HELP-PROMPT: Answer must be 7 characters in length.
DESCRIPTION: This field, previously known as PRIMARY CARE PROVIDER PC, 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.833,22 PLACEHOLD PC PROVIDER NPI 0;23 FREE TEXT
INPUT TRANSFORM: K:$L(X)>10!($L(X)<1) X
LAST EDITED: APR 30, 2018
HELP-PROMPT: Answer must be 1-10 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.833,23 PLACEHOLD PRIMARY CARE TEAM 0;24 POINTER TO TEAM FILE (#404.51)
LAST EDITED: APR 30, 2018
HELP-PROMPT: Select the patient's primary care team.
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.833,24 ORDERING STOP CODE 0;25 FREE TEXT
INPUT TRANSFORM: K:$L(X)>3!($L(X)<3) X
LAST EDITED: OCT 06, 2010
HELP-PROMPT: Answer must be 3 characters in length.
DESCRIPTION:
The field contains the stop code with the order.
TECHNICAL DESCR: For outpatients the stop code is the primary stop code for the clinic (first 3 characters of the
DSS Identifier field of this extract). 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.833,25 PLACE ORDER NUMBER 1;1 POINTER TO BCMA MEDICATION LOG FILE (#53.79)
LAST EDITED: NOV 18, 2010
HELP-PROMPT: Please select the patient's Place Order Number.
DESCRIPTION:
This is the order number of the Patient's Barcode Medication Administration record.
TECHNICAL DESCR: This is the IEN of the BCMA MEDICATION LOG file (#53.79). Derived from using the 'AADT' cross
reference of the BCMA MEDICATION LOG file (#53.79) , based on the start and end dates of the
extract.
727.833,26 ORDER REFERENCE NUMBER 1;2 FREE TEXT
INPUT TRANSFORM: K:$L(X)>15!($L(X)<1) X
LAST EDITED: NOV 08, 2010
HELP-PROMPT: Answer must be 1-15 characters in length.
DESCRIPTION: Contains the IEN to the actual order in the PHARMACY PATIENT (#55) followed by a U for Unit Dose or
V for IV.
TECHNICAL DESCR: This field is derived by using the ORDER REFERENCE NUMBER field (#.11) of the BCMA MEDICATION LOG
file (#53.79), as pointed to by the PLACE ORDER NUMBER field (#25) of this file.
727.833,27 ROUTE 1;3 POINTER TO MEDICATION ROUTES FILE (#51.2)
LAST EDITED: NOV 08, 2010
HELP-PROMPT: Select the medication route.
DESCRIPTION:
This is the route of administration for Unit Dose or IV medication for a patient.
TECHNICAL DESCR: This field is extracted from the PARMACY PATIENT file (#55) by either the MED ROUTE field (#3) of
its Unit Dose multiple (#62). Or, the MED ROUTE field (#132) of its IV multiple (#100).
727.833,28 TIME 1;4 FREE TEXT
INPUT TRANSFORM: K:$L(X)>6!($L(X)<6) X
LAST EDITED: APR 18, 2012
HELP-PROMPT: Answer must be 6 characters in length.
DESCRIPTION:
This field contains the actual time the medication was administered.
TECHNICAL DESCR: This field is taken from the ACTION DATE/TIME field (#.06) from the BCMA MEDICATION LOG file
(#53.79). It is parsed so that only the time portion of the field is stored in HHMMSS format. The
date portion is stored in the DAY field (#8) of this file.
727.833,29 COMPONENT CODE 1;5 VARIABLE POINTER
FILE ORDER PREFIX LAYGO MESSAGE
LAST EDITED: APR 18, 2012
HELP-PROMPT: Please select the patient's component code.
DESCRIPTION: The COMPONENT CODE contains either the dispensed drug, IV additive or IV solution that was
administered for this patient.
TECHNICAL DESCR: This is a variable pointer field used to identify either the DRUG file (#50), IV ADDITIVES file
(#52.6), or the IV SOLUTIONS file (#52.7).
Enter one of the following:
A.EntryName to select a IV ADDITIVES file (#52.6).
D.EntryName to select a DRUG file (#50).
S.EntryName to select a IV SOLUTIONS file (#52.7).
The COMPONENT TYPE field (#34) will contain the variable pointer letter (A=IV ADDITIVES, D=DRUG,
S=IV SOLUTIONS) from this field.
727.833,30 COMPONENT DOSE ORDERED 1;6 FREE TEXT
INPUT TRANSFORM: K:$L(X)>30!($L(X)<1) X
LAST EDITED: MAY 02, 2013
HELP-PROMPT: Answer must be 1-30 characters in length.
DESCRIPTION: COMPONENT DOSE ORDERED contains either the dispensed drug, IV additive, or IV solution dose
ordered, to which, this medication was administered for this patient.
TECHNICAL DESCR: Its value is free text derived from the DOSE ORDERED field (#.02) of the subfile multiples
(#.5),(#.6),(#.7) of the BCMA MEDICATION LOG file (#53.79).
727.833,31 COMPONENT DOSE GIVEN 1;7 FREE TEXT
INPUT TRANSFORM: K:$L(X)>30!($L(X)<1) X
LAST EDITED: SEP 01, 2015
HELP-PROMPT: Answer must be 1-30 characters in length.
DESCRIPTION: The COMPONENT DOSE GIVEN contains either the dispensed drug, IV additive, or IV solutions dose
given, to which, this medication was administered for this patient.
TECHNICAL DESCR: This field's value is free text derived from the DOSE GIVEN field (#.03) of the subfile multiples
(#.5),(#.6),(#.7) of the BCMA MEDICATION LOG file (#53.79).
727.833,32 COMPONENT UNITS 1;8 FREE TEXT
INPUT TRANSFORM: K:$L(X)>40!($L(X)<1) X
LAST EDITED: SEP 01, 2015
HELP-PROMPT: Answer must be 1-40 characters in length.
DESCRIPTION: The Component Units contains either the dispensed drug, IV additive, or IV solutions unit of
administration, to which this medication was administered for this patient.
TECHNICAL DESCR: The Component Units value is free text derived from the UNIT OF ADMINISTRATION field (#.04) of the
subfile multiples (#.5),(#.6),(#.7) of the BCMA Medication Log file (#53.79).
727.833,33 COMPONENT TYPE 1;9 SET
'D' FOR Dispensed Drug;
'A' FOR Additives;
'S' FOR Solutions;
LAST EDITED: APR 18, 2012
HELP-PROMPT: What kind of dose was ordered?
DESCRIPTION:
The Component Type is determined by the value destination of the Component Code.
TECHNICAL DESCR: This field is derived based on the COMPONENT CODE field (#30) of this file. If the component code
is from the DRUG file (#50), it will be "D", if it's from the IV ADDITIVES file (#52.6) it will be
"A", and if it is from IV SOLUTIONS file (#52.7) it will be "S".
727.833,34 ACTION STATUS 1;10 SET
'G' FOR GIVEN;
'H' FOR HELD;
'R' FOR REFUSED;
'N' FOR NOT GIVEN;
'RM' FOR REMOVED;
'I' FOR INFUSING;
'S' FOR STOPPED;
'C' FOR COMPLETED;
'M' FOR MISSING DOSE;
LAST EDITED: APR 18, 2012
HELP-PROMPT: What is the medication administration status?
DESCRIPTION:
This is the status of the medication administration.
TECHNICAL DESCR:
This field is derived from the ACTION STATUS field (#.09) of the BCMA MEDICATION LOG file (#53.79).
727.833,35 ADMINISTRATION MEDICATION 1;11 POINTER TO PHARMACY ORDERABLE ITEM FILE (#50.7)
LAST EDITED: APR 18, 2012
HELP-PROMPT: Select the proper medication.
DESCRIPTION:
Administration Medication is the medication entered for the order.
TECHNICAL DESCR: This field is derived from the ADMINISTRATION MEDICATION field (#.08) of the BCMA MEDICATION LOG
file (#53.79).
727.833,36 SCHEDULED ADMINISTRATION DATE 1;12 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<8) X
LAST EDITED: APR 18, 2012
HELP-PROMPT: Answer must be 8 characters in length.
DESCRIPTION: If a continuous order this field will contain the actual administration date the medication was
ordered for.
TECHNICAL DESCR: Derived from the SCHEDULED ADMINISTRATION TIME field (#.13) of the BCMA MEDICATION LOG file
(#53.79). It is parsed so that only the date portion is stored in format YYYYMMDD.
727.833,37 SCHEDULED ADMINISTRATION TIME 2;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>6!($L(X)<6) X
LAST EDITED: APR 18, 2012
HELP-PROMPT: Answer must be 6 characters in length.
DESCRIPTION: If a continuous order this field will contain the actual administration time the medication was
ordered for.
TECHNICAL DESCR: The time is derived from the time value of the SCHEDULED ADMINISTRATION TIME field (#.13) of the
BCMA MEDICATION LOG file (#53.79). It is parsed so that only the time portion is returned in format
HHMMSS.
727.833,38 ORDER SCHEDULE 2;2 SET
'C' FOR CONTINUOUS;
'P' FOR PRN;
'O' FOR ONE-TIME;
'OC' FOR ON-CALL;
LAST EDITED: APR 18, 2012
HELP-PROMPT: Choose an order schedule.
DESCRIPTION:
This is the schedule type of the order.
TECHNICAL DESCR:
Derived from the SCHEDULE ORDER field (#.12) of the BCMA MEDICATION LOG file (#53.79).
727.833,39 IV UNIQUE ID 2;3 FREE TEXT
INPUT TRANSFORM: K:$L(X)>30!($L(X)<3) X
LAST EDITED: APR 18, 2012
HELP-PROMPT: Answer must be 3-30 characters in length.
DESCRIPTION:
This is the unique ID number of an IV bag, which is generated from Inpatient Medications.
TECHNICAL DESCR:
Derived from the IV UNIQUE ID field (#.26) of the BCMA MEDICATION LOG file (#53.79).
727.833,40 INFUSION RATE 2;4 FREE TEXT
INPUT TRANSFORM: K:$L(X)>47!($L(X)<1) X
LAST EDITED: APR 18, 2012
HELP-PROMPT: Answer must be 1-47 characters in length.
DESCRIPTION:
This is the infusion rate for an IV bag, which is passed by Inpatient Medications.
TECHNICAL DESCR: The infusion rate is derived from the INFUSION RATE field (#.35) of the BCMA MEDICATION LOG file
(#53.79).
727.833,41 PRODUCTION DIVISION CODE 2;5 FREE TEXT
INPUT TRANSFORM: K:$L(X)>7!($L(X)<3) X
LAST EDITED: APR 18, 2012
HELP-PROMPT: Answer must be 3-7 characters in length.
DESCRIPTION:
This is the facility of the ward where the patient received medication.
TECHNICAL DESCR: Derived by getting the PATIENT DIVISION field (#.03) from the BCMA MEDICATION LOG file (#53.79),
which is a pointer to the INSTITUTION file (#4). The value is then used to call the API
RADDIV^ECXDEPT to get the STATION NUMBER field (#99) from the INSTITUTION file (#4).
727.833,42 DRUG IEN 2;6 POINTER TO VA PRODUCT FILE (#50.68)
LAST EDITED: DEC 05, 2012
HELP-PROMPT: Select the drug administered to the patient.
DESCRIPTION:
This is the drug administered to the patient.
TECHNICAL DESCR: Using the COMPONENT CODE field (#30) of this file, the IEN of the drug from the DRUG file (#50) is
used in a call to $$PHAAPI^ECXUTL5 to get the associated entry in the VA PRODUCT file (#50.68).
The COMPONENT CODE field (#30) is a variable pointer reference to the file that identifies the drug
given. If it's a dispensed drug, it references the DRUG file (#50) and the IEN can be taken
directly from there. Otherwise, the IEN will be taken from the GENERIC DRUG field (#1) from either
the IV ADDITIVES file (#52.6) or the IV SOLUTIONS file (#52.7), which is a pointer to the DRUG file
(#50).
727.833,43 NDC 2;7 FREE TEXT
INPUT TRANSFORM: K:$L(X)>20!($L(X)<5) X
LAST EDITED: APR 18, 2012
HELP-PROMPT: Answer must be 5-20 characters in length.
DESCRIPTION:
This is the National Drug Code for the drug/supply item in this order.
TECHNICAL DESCR: For sites running a version of Inpatient Medications prior to V. 4.5: Derived from the NDC field
(#31) in the DRUG file (#50) for the drug identified by the GENERIC DRUG field (#1) in either the
IV ADDITIVES file (#52.6) for additives or the IV SOLUTIONS file (#52.7) for solutions.
Using the "AC" cross reference on the IV STATS file (#50.8) and a ^TMP( array built from the "AC"
cross reference, GENERIC DRUG is derived from the following:
The IV DRUG field (#.01), the TYPE field (#6), and the IEN of the additive or solution for the IV
DRUG within the IV DRUG multiple (#2) of the DATE multiple (2#) of the IV STATS file (#50).
For sites running Inpatient Medications V. 4.5 or higher: Derived from the NDC field (#31) in the
DRUG file (#50).
727.833,44 DEA, SPECIAL HDLG 2;8 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 item.
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.833,45 VA DRUG CLASSIFICATION 2;9 FREE TEXT
INPUT TRANSFORM: K:$L(X)>5!($L(X)<1) X
LAST EDITED: APR 27, 2012
HELP-PROMPT: Answer must be 1-5 characters in length.
DESCRIPTION:
This is the VA Drug Classification for the item in this order.
TECHNICAL DESCR:
This field is derived from the VA CLASSIFICATION field (#2) of the DRUG file (#50).
727.833,46 PLACEHOLD MPI 2;10 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.833,47 DOM, PRRTP & SAARTP INDICATOR 2;11 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: APR 27, 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 exist 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.833,48 OBSERVATION PATIENT INDICATOR 2;12 SET
'N' FOR NO;
'Y' FOR YES;
LAST EDITED: APR 07, 2016
HELP-PROMPT: Enter observation patient status for this record.
DESCRIPTION:
Indicates if a 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 exist 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.833,49 ENCOUNTER NUMBER 2;13 FREE TEXT
INPUT TRANSFORM: K:$L(X)>17!($L(X)<1) X
LAST EDITED: MAY 02, 2013
HELP-PROMPT: Answer must be 1-17 characters in length.
DESCRIPTION:
The unique number assigned for 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.833,50 PLACEHOLD MEANS TEST 2;14 FREE TEXT
INPUT TRANSFORM: K:$L(X)>1!($L(X)<1) X
LAST EDITED: FEB 13, 2020
HELP-PROMPT: Enter the means test code for this patient (1 character 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.833,51 ELIGIBILITY 2;15 FREE TEXT
INPUT TRANSFORM: K:$L(X)>3!($L(X)<2) X
LAST EDITED: APR 27, 2012
HELP-PROMPT: Answer must be 2-3 characters in length.
DESCRIPTION:
A two or three digit numeric code indicating the Patient's Primary Eligibility.
TECHNICAL DESCR: Using the patient pointer (DFN) stored in the PATIENT NO. - DFN field (#4), 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.833,52 ENROLLMENT LOCATION 2;16 FREE TEXT
INPUT TRANSFORM: K:$L(X)>7!($L(X)<3) X
LAST EDITED: JUN 12, 2012
HELP-PROMPT: Enter the station number of the preferred facility for care (3 - 7 characters).
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 that file, the value in the STATION NUMBER
field (#99) is used.
727.833,53 ENROLLMENT CATEGORY 2;17 SET
'E' FOR ENROLLED;
'N' FOR NOT ENROLLED;
'P' FOR IN PROCESS;
LAST EDITED: APR 27, 2012
HELP-PROMPT: What is the patient's enrollment status?
DESCRIPTION:
Patient's enrollment category.
TECHNICAL DESCR: ENROLLMENT CATEGORY is derived from the standard call $$CATEGORY^DGENA4 using the INPUT patient DFN
and the ENROLLMENT STATUS field (#55).
727.833,54 ENROLLMENT STATUS 2;18 POINTER TO ENROLLMENT STATUS FILE (#27.15)
LAST EDITED: APR 27, 2012
HELP-PROMPT: Select the 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).
727.833,55 ENROLLMENT PRIORITY 2;19 FREE TEXT
INPUT TRANSFORM: K:$L(X)>2!($L(X)<1) X
LAST EDITED: APR 27, 2012
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 field (#.07) and the ENROLLMENT
PRIORITY SUBGROUP field (#.12) 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
727.833,56 USER ENROLLEE 2;20 SET
'U' FOR USER ENROLLEE;
LAST EDITED: APR 27, 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) file. When a user has
a current or future fiscal year in the VistA User Enrollee 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.833,57 PLACEHOLD ETHNICITY 2;21 FREE TEXT
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.833,58 PLACEHOLD RACE 1 2;22 FREE TEXT
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.833,59 VETERAN 2;23 SET
'Y' FOR VETERAN;
'N' FOR NOT VETERAN;
LAST EDITED: APR 27, 2012
HELP-PROMPT: Is the patient a veteran?
DESCRIPTION:
Patient's Veteran status.
TECHNICAL DESCR: Using the patient pointer (DFN) stored in the PATIENT NO. - DFN field (#4) in the BCMA EXTRACT file
(#727.833), VETERAN data is derived from the VETERAN (Y/N)? field (#1901) in the PATIENT file (#2).
727.833,60 PERIOD OF SERVICE 2;24 FREE TEXT
INPUT TRANSFORM: K:$L(X)>1!($L(X)<1) X
LAST EDITED: APR 27, 2012
HELP-PROMPT: Answer must be 1 character in length.
DESCRIPTION:
The period of service, which best classifies this patient based on eligibility code.
TECHNICAL DESCR: This field is derived by pulling the PERIOD OF SERVICE field (#.323) from the PATIENT file (#2).
The PERIOD OF SERVICE field (#.323) is a pointer to the PERIOD OF SERVICE file (#21). This field is
derived from the CODE field (#.03) of that file.
The veteran's period of service indicator is returned by ELIG^VADPT.
727.833,61 POW STATUS 2;25 SET
'Y' FOR YES;
'N' FOR NO;
'U' FOR UNKNOWN;
LAST EDITED: JUN 12, 2012
HELP-PROMPT: Enter the patient's POW status.
DESCRIPTION:
Indicates if patient was confined as a Prisoner of War.
TECHNICAL DESCR: Using the patient pointer (DFN) stored in the PATIENT NO. - DFN field (#4) in the BCMA EXTRACT file
(#727.833), POW data is derived from the POW STATUS INDICATED? field (#.525) in the PATIENT file
(#2).
The status indicator is returned by SVC^VADPT.
727.833,62 POW LOCATION 2;26 POINTER TO POW PERIOD FILE (#22)
LAST EDITED: APR 27, 2012
HELP-PROMPT: Select the POW location/period.
DESCRIPTION:
This is the location/period where the patient was a POW.
TECHNICAL DESCR: This field is a pointer derived by reading the POW CONFINEMENT LOCATION field (#.526) from the
PATIENT file (#2). The location is retrieved by calling SVC^VADPT.
727.833,63 RADIATION STATUS 2;27 SET
'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 12, 2012
HELP-PROMPT: Enter the Radiation Status for the patient.
DESCRIPTION:
Indicates if patient claims exposure to ionizing radiation.
TECHNICAL DESCR: Using the patient pointer (DFN) stored in the PATIENT NO. - DFN field (#4) in the BCMA EXTRACT file
(#727.833), RADIATION data is derived from the RADIATION EXPOSURE INDICATED? field (#.32103) in the
PATIENT file (#2).
The status indicator is returned by SVC^VADPT.
727.833,64 AGENT ORANGE STATUS 2;28 SET
'Y' FOR YES;
'N' FOR NO;
'U' FOR UNKNOWN;
LAST EDITED: APR 27, 2012
HELP-PROMPT: Enter the Agent Orange Status for the patient.
DESCRIPTION:
Indicates whether patient was exposed to Agent Orange.
TECHNICAL DESCR: Using the patient pointer (DFN) stored in the PATIENT NO. - DFN field (#4) in the BCMA EXTRACT file
(#727.833), AGENT ORANGE data is derived from the AGENT ORANGE EXPOS. INDICATED? field (.#32102) in
the PATIENT file (#2).
The status indicator is returned by SVC^VADPT.
727.833,65 AGENT ORANGE LOCATION 2;29 SET
'B' FOR BLUE WATER NAVY;
'K' FOR KOREAN DMZ;
'V' FOR VIETNAM;
'T' FOR THAILAND(U.S. OR ROYAL THAI MIL BASE);
'L' FOR LAOS;
'C' FOR CAMBODIA(MIMOT OR KREK,KAMPONG CHAM);
'G' FOR GUAM, AMERICAN SAMOA, OR TERRITORIAL WATERS;
'J' FOR JOHNSTON ATOLL;
'O' FOR OTHER;
LAST EDITED: JUN 09, 2023
HELP-PROMPT: Choose the location where the patient was exposed to Agent Orange.
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).
727.833,66 PURPLE HEART INDICATOR 2;30 SET
'Y' FOR YES;
'N' FOR NO;
LAST EDITED: APR 27, 2012
HELP-PROMPT: Is patient a purple heart recipient and a veteran?
DESCRIPTION:
This field Indicates whether or not a patient is a Purple Heart recipient.
TECHNICAL DESCR: The Purple Heart Indicator is derived by calling SVC^VADPT which returns the CURRENT PH INDICATOR
field (#.531) from the PATIENT file (#2).
727.833,67 MST STATUS 2;31 SET
'Y' FOR Yes, Screened reports MST;
'N' FOR No, Screened does not report MST;
'U' FOR Unknown, not screened;
'D' FOR Screened Declines to answer;
LAST EDITED: APR 27, 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 patient's 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 field (#4) and the date in
the DAY field (#8) from this file.
727.833,68 CNH STATUS 2;32 SET
'Y' FOR YES;
'N' 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.833,69 HEAD & NECK CANCER INDICATOR 2;33 SET
'Y' FOR YES;
'N' FOR NO;
LAST EDITED: APR 27, 2012
HELP-PROMPT: Has patient been diagnosed with cancer of the head and/or neck?
DESCRIPTION:
Identifies whether patient's diagnosis was for Head and/or Neck Cancer.
TECHNICAL DESCR: This indicator is derived by passing the patient pointer (DFN) to the API $$GETCUR^DGNTAPI to
retrieve the HEAD/NECK CA DX field (#2.01) of the NOSE AND THROAT RADIUM HISTORY file (#28.11).
727.833,70 SHAD STATUS 2;34 SET
'Y' FOR YES;
'N' FOR NO;
LAST EDITED: APR 27, 2012
HELP-PROMPT: Does patient meet requirements for SHAD?
DESCRIPTION:
Indicates whether patient meets requirements for Shipboard Hazard And Defense (SHAD).
TECHNICAL DESCR: This field is the Shipboard Hazard and Defense which is derived by using DBIA #4462
GETSHAD^DGUTL3(DFN). Which returns the PROJ 112/SHAD field (#.32115) from the Patient file (#2).
727.833,71 PATIENT TYPE 3;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>2!($L(X)<2) X
LAST EDITED: APR 27, 2012
HELP-PROMPT: Answer must be 2 characters in length.
DESCRIPTION:
PATIENT TYPE refers to the various types of patient which might be seen at a VA facility.
TECHNICAL DESCR: Patient type is determined by the TYPE field (#391) of the PATIENT file (#2) which points to the
TYPE OF PATIENT file (#391) entries . Every patient added to the system must have a TYPE specified.
It best classifies a patient as one of the following values listed below. PATIENT TYPE field value
shall contain only the first two characters:
AC= ACTIVE DUTY AL= ALLIED VETERAN CO= COLLATERAL EM= EMPLOYEE IN= INELIGIBLE MI= MILITARY RETIREE
NO= NON-VETERAN (OTHER) NS= NSC VETERAN SC= SC VETERAN TR= TRICARE
727.833,72 CV STATUS ELIGIBILITY 3;2 SET
'Y' FOR YES;
'E' FOR ELIGIBILITY EXPIRED;
LAST EDITED: APR 27, 2012
HELP-PROMPT: Is patient a Combat Veteran?
DESCRIPTION: This field indicates whether or not a patient can be considered a Combat Veteran (CV) at the time
of treatment.
TECHNICAL DESCR: The CV STATUS ELIGIBILITY is determined by the use of API $$CVEDT^DGCV (DFN, DAY field (#8) in
Fileman format) 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^3010106^0, the first piece is resolved as
follows.
1 - qualifies as a CV
0 - does not qualify as a CV
-1 - bad DFN or date
Based on these returns, the value for this field shall be 'Y' for 'YES' or 'E' for 'ELIGIBILITY
EXPIRED". If this field is null it indicates that the patient is not eligible.
727.833,73 CV ELIGIBILITY END DATE 3;3 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<8) X
LAST EDITED: APR 27, 2012
HELP-PROMPT: Answer must be 8 characters in length.
DESCRIPTION:
This field is the patient's Combat Veteran (CV) eligibility end date.
TECHNICAL DESCR: The CV ELIGIBILITY END DATE is determined by the use of API $$CVEDT^DGCV (DFN, DAY (#8) in Fileman
format) that checks the COMBAT VET END DATE field (#.5295) from the PATIENT file (#2) to determine
CV Status. The API returns three pieces (i.e. 1^3010106^0) the 2nd piece is the Combat Vet End
Date which is stored in YYYYMMDD format.
727.833,74 ENCOUNTER CV 3;4 SET
'Y' FOR YES;
LAST EDITED: APR 27, 2012
HELP-PROMPT: Was the patient CV eligible on the treatment date?
DESCRIPTION: This Field indicates if the patient is a Combat Veteran (CV) based on the treatment date and the
end date of combat service.
TECHNICAL DESCR: ENCOUNTER CV is determined by the use of API $$CVEDT^DGCV (DFN, DAY #(8) in Fileman format) that
checks the COMBAT VET END DATE field (#.5295), from the PATIENT file (#2) to determine CV Status
using the DAY field (#8). The API returns three pieces (i.e. 1^3010106^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 =Yes, or null.
727.833,75 NATIONAL PATIENT RECORD FLAG 3;5 SET
'Y' FOR YES;
LAST EDITED: APR 27, 2012
HELP-PROMPT: Does patient have any active record flags?
DESCRIPTION:
This field will indicate if the Patient has any type of a National Flag indicator.
TECHNICAL DESCR: NATIONAL PATIENT RECORD FLAG is located in the PRF National Flag File # 26.15. This file contains a
list of the Category 1 (National) Patient Record Flags that can be assigned to a patient. Category
I flags are established at a National level. NATIONAL PATIENT RECORD FLAG is retrieved via an API
$$GETACT^DGPFAPI(DFN, TARGET_ROOT. Field value is "Y" if a Category I flag is present and active,
otherwise it is NULL.
727.833,76 ERI 3;6 SET
'P' FOR PANDEMIC;
'K' FOR HURRICANE KATRINA;
LAST EDITED: MAY 13, 2020
HELP-PROMPT: Was the patient in a FEMA-designated impacted zip code area?
DESCRIPTION: 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).
727.833,77 SW ASIA CONDITIONS 3;7 SET
'Y' FOR YES;
'N' FOR NO;
'U' FOR UNKNOWN;
LAST EDITED: APR 27, 2012
HELP-PROMPT: Does patient claim exposure to SWA conditions?
DESCRIPTION: This field is used to indicate if this visit represents treatment of a VA patient claiming exposure
to Southwest Asia Conditions.
The South West Asia Theater of operations is defined as:
Iraq, Kuwait, Saudi Arabia, the neutral zone between Iraq and Saudi Arabia, Bahrain, Qatar, the
United Arab Emirates, Oman, the Gulf of Aden, the Gulf of Oman, the Persian Gulf, the Arabian Sea,
the Red Sea and the airspace above these locations.
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.
727.833,78 OEF/OIF 3;8 FREE TEXT
INPUT TRANSFORM: K:$L(X)>9!($L(X)<9) X
LAST EDITED: APR 27, 2012
HELP-PROMPT: Answer must be 9 characters in length.
DESCRIPTION: The Military Operation(s) in which the patient was in combat. This field is a length of nine
characters and reflects the OEF or OIF where this patient was in combat.
TECHNICAL DESCR: The value of this field is derived from the LOCATION OF SERVICE field (#.01) of the SERVICE [OEF OR
OIF] sub-file (#2.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.833,79 OEF/OIF RETURN DATE 3;9 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<8) X
LAST EDITED: APR 27, 2012
HELP-PROMPT: Answer must be 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. In cases of multiple
OEF/OIF tours, this field contains only most recent return date.
TECHNICAL DESCR: The value of this field is derived of the OEF/OIF TO DATE field (#.03) of the SERVICE [OEF OR OIF]
sub-file (#.3215) located in the PATIENT file (#2).
727.833,80 PATCAT 3;10 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: APR 27, 2012
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.
FHCC hospitals have special codes that are added to the ELIGIBILITY CODE file (#8) that are used to
identify the PATCAT status and may be unique to their facility.
727.833,81 ENCOUNTER SC 3;11 SET
'Y' FOR YES;
'N' FOR NO;
LAST EDITED: MAR 08, 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.833,82 IV ADDITIVE COST 3;12 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>10000)!(X<0)!(X?.E1"."5N.N) X
LAST EDITED: MAR 08, 2013
HELP-PROMPT: Type a number between 0 and 10000, 4 decimal digits.
DESCRIPTION:
VA pharmacy supply cost, in dollars, of the IV Additive dispensed.
TECHNICAL DESCR: This field is calculated by multiplying the DOSES GIVEN field (#.03) of the ADDITIVES subfield
(#.6) from the BCMA MEDICATION LOG file (#53.79) by AVERAGE DRUG COST PER UNIT field (#7) of the IV
ADDITIVES file (#52.6).
727.833,83 IV SOLUTION COST 3;13 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>10000)!(X<0)!(X?.E1"."5N.N) X
LAST EDITED: AUG 07, 2013
HELP-PROMPT: Type a number between 0 and 10000, 4 decimal digits.
DESCRIPTION:
VA pharmacy supply cost, in dollars, of the IV Solution dispensed.
TECHNICAL DESCR: This field is calculated by multiplying the DOSES GIVEN field (#.03) of the SOLUTIONS subfield
(#.7) from the BCMA MEDICATION LOG file (#53.79) by AVERAGE DRUG COST PER UNIT field (#7) of the IV
SOLUTIONS file (#52.7).
727.833,84 DRUG COST 3;14 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>10000)!(X<0)!(X?.E1"."5N.N) X
LAST EDITED: MAR 08, 2013
HELP-PROMPT: Type a number between 0 and 10000, 4 decimal digits.
DESCRIPTION:
VA pharmacy supply cost, in dollars, of the Drug dispensed.
TECHNICAL DESCR: This field is calculated by multiplying the DOSES GIVEN field (#.03) of the DISPENSE DRUG subfield
(#.5) from the BCMA MEDICATION LOG file (#53.79) by UNIT OF ADMINISTRATION field (#.04) of the
DISPENSE DRUG subfield (#.5) from the BCMA MEDICATION LOG file (#53.79) by PRICE PER DISPENSE UNIT
field (#16) of the DRUG file (#50).
727.833,85 CAMP LEJEUNE STATUS 3;15 SET
'Y' FOR YES;
'N' FOR NO;
LAST EDITED: MAR 08, 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.833,86 ENCOUNTER CAMP LEJEUNE 3;16 SET
'Y' FOR YES;
'N' FOR NO;
LAST EDITED: MAR 08, 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.833,87 COMBAT VETERAN INDICATOR 3;17 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.833,88 COMBAT VETERAN LOCATION 3;18 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.833,89 VISTA DEA SPECIAL HDLG 3;19 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.833,90 NEW MPI 3;20 FREE TEXT
New MPI
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.833,91 FEEDER KEY 3;21 FREE TEXT
INPUT TRANSFORM: K:$L(X)>20!($L(X)<17) X
MAXIMUM LENGTH: 20
LAST EDITED: APR 29, 2022
HELP-PROMPT: Answer must be 17-20 characters in length.
DESCRIPTION: This field contains the DRUG IEN (BCMA EXTRACT file, field #42) concatenated with the 12-digit NDC
(BCMA EXTRACT file, field #43).
TECHNICAL DESCR: The FEEDER KEY is derived from the DRUG IEN (BCMA extract field #42) padded with leading zeroes to
make 5 digits; it is concatenated with a 12-digit code from the NDC field (BCMA extract field #43).
The dashes (-) in the NDC are removed, resulting in 17-digit code.
727.833,92 PRICE PER DISPENSE UNIT 3;22 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>999999)!(X<0)!(X?.E1"."5.N) X
LAST EDITED: APR 29, 2022
HELP-PROMPT: Type 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.833,93 SELF IDENTIFIED GENDER 3;23 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: MAY 02, 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 BCMA EXTRACT file
(#727.833), this data is derived from the SELF IDENTIFIED GENDER field (#.024) in the PATIENT file
(#2).
727.833,94 DISPENSE UNIT 3;24 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 for this drug.
TECHNICAL DESCR:
This is the DISPENSE UNIT field (#14.5) of the DRUG file (#50).
FILES POINTED TO FIELDS
BCMA MEDICATION LOG (#53.79) PLACE ORDER NUMBER (#25)
DSS EXTRACT LOG (#727) EXTRACT NUMBER (#2)
ENROLLMENT STATUS (#27.15) ENROLLMENT STATUS (#54)
HOSPITAL LOCATION (#44) WARD (#15)
MEDICATION ROUTES (#51.2) ROUTE (#27)
PATIENT (#2) PATIENT NO. - DFN (#4)
PHARMACY ORDERABLE ITEM (#50.7) ADMINISTRATION MEDICATION (#35)
POW PERIOD (#22) POW LOCATION (#62)
TEAM (#404.51) PLACEHOLD PRIMARY CARE TEAM (#23)
VA PRODUCT (#50.68) DRUG IEN (#42)
INPUT TEMPLATE(S):
PRINT TEMPLATE(S):
SORT TEMPLATE(S):
FORM(S)/BLOCK(S):