STANDARD DATA DICTIONARY #727.812 -- MENTAL HEALTH EXTRACT FILE 3/24/25 PAGE 1
STORED IN ^ECX(727.812, *** NO DATA STORED YET *** SITE: WWW.BMIRWIN.COM UCI: VISTA,VISTA (VERSION 3.0)
DATA NAME GLOBAL DATA
ELEMENT TITLE LOCATION TYPE
-----------------------------------------------------------------------------------------------------------------------------------
CROSS
REFERENCED BY: EXTRACT NUMBER(AC)
727.812,.01 SEQUENCE NUMBER 0;1 NUMBER (Required)
INPUT TRANSFORM: K:+X'=X!(X>999999999)!(X<1)!(X?.E1"."1N.N) X S:$D(X) DINUM=X
LAST EDITED: JUL 26, 1999
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
727.812,1 YEAR MONTH 0;2 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>6!($L(X)<6) X
LAST EDITED: MAY 05, 1999
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:
Format is YYYYMM; Year 2000 compliant.
727.812,2 EXTRACT NUMBER 0;3 POINTER TO DSS EXTRACT LOG FILE (#727) (Required)
LAST EDITED: MAY 11, 1999
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
MailMan transmission message.
CROSS-REFERENCE: 727.812^AC^MUMPS
1)= S ^ECX(727.812,"AC",$E(X,1,30),DA)=""
2)= K ^ECX(727.812,"AC",$E(X,1,30),DA)
3)= DO NOT DELETE
The "AC" cross-reference is essential for managing and purging data in this file.
727.812,3 FACILITY 0;4 FREE TEXT
INPUT TRANSFORM: K:$L(X)>7!($L(X)<3) X
LAST EDITED: MAY 05, 1999
HELP-PROMPT: Answer must be 3-7 characters in length.
DESCRIPTION:
Identifies the facility associated with the extract data by its station number.
TECHNICAL DESCR: STATION NUMBER field (#99) of the INSTITUTION file (#4) record pointed to by the NAME field (#.01)
of the DSS EXTRACTS file (#728).
727.812,4 PATIENT NO. - DFN 0;5 POINTER TO PATIENT FILE (#2) (Required)
LAST EDITED: MAY 05, 1999
DESCRIPTION: Internal entry number of the PATIENT file (#2) record identifying the patient associated with the
Mental Health information.
TECHNICAL DESCR: One of three possible sources: (1) NAME field (#.01) of the PSYCH INSTRUMENT PATIENT file (#601.2)
(2) NAME field (#.02) of the ADDICTION SEVERITY INDEX file (#604) (3) PATIENT NAME field (#.02) of
the DIAGNOSTIC RESULTS - MENTAL
HEALTH file (#627.8)
727.812,5 SSN 0;6 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>10!($L(X)<9) X
LAST EDITED: MAY 05, 1999
HELP-PROMPT: Answer must be 9-10 characters in length.
DESCRIPTION: The patient's social security number.
Any patient with an SSN beginning with "00000" is considered a "test patient" and will not be
included in the extract.
TECHNICAL DESCR: Using the patient pointer (DFN) stored in the PATIENT NO. - DFN field (#4) of this extract file
(#727.812), 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.812,6 NAME 0;7 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>4!($L(X)<4) X
LAST EDITED: MAY 05, 1999
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 field (#4) of this extract file
(#727.812), 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.
727.812,7 IN OUT PATIENT INDICATOR 0;8 FREE TEXT
INPUT TRANSFORM: K:$L(X)>1!($L(X)<1) X
LAST EDITED: NOV 29, 2001
HELP-PROMPT: Answer must be 1 character in length.
DESCRIPTION: Indicates whether the patient was an inpatient or an outpatient on the date in the DAY field (#8)
for this extract record.
TECHNICAL DESCR:
In FY2002, this field has been changed and will contain "O"=Outpatient or "I"=Inpatient.
727.812,8 DAY 0;9 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>8!($L(X)<8) X
LAST EDITED: MAY 05, 1999
HELP-PROMPT: Answer must be 8 characters in length.
DESCRIPTION:
Date in format YYYYMMDD; date with which the Mental Health extract data is associated.
TECHNICAL DESCR: One of three possible sources: (1) COMPLETION DATE field (#.01) of the DATE field (#1), #601.22
sub-file, of the (#1) INSTRUMENT field, #601.21 sub-file, of
the PSYCH INSTRUMENT PATIENT file (#601.1) (2) DATE OF INTERVIEW field (#.05) of the ADDICTION
SEVERITY INDEX
file (#604) (3) DATE/TIME OF DIAGNOSIS field (#.03) of the DIAGNOSTIC RESULTS -
MENTAL HEALTH file (#627.8)
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.812,9 PLACEHOLDER 0;10 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>1!($L(X)<1) X
LAST EDITED: MAR 01, 2004
HELP-PROMPT: Answer must be 1 character in length.
727.812,10 ADMISSION DATE 0;11 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<8) X
LAST EDITED: MAY 06, 1999
HELP-PROMPT: Answer must be 8 characters in length.
DESCRIPTION: This 8-character string represents the date on which the admission occurred, if the patient
referenced in the PATIENT NO. - DFN field is an inpatient on the date shown in the DAY field.
TECHNICAL DESCR: PATIENT MOVEMENT file (#405); DATE/TIME field (#.01)
This field is always exactly 8 numeric characters in length. The format is YYYYMMDD; for example,
19970923. The standard FM date for the admission is returned by IN5^VADPT.
727.812,11 DISCHARGE DATE 0;12 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<8) X
LAST EDITED: MAY 06, 1999
HELP-PROMPT: Answer must be 8 characters in length.
DESCRIPTION: This 8-character string represents the date on which the discharge occurred, if the patient
referenced in the PATIENT NO. - DFN field was an inpatient on the date shown in the DAY field, but
has been discharged before the run date of the extract.
TECHNICAL DESCR: PATIENT MOVEMENT file (#405); DATE/TIME field (#.01)
This field is always exactly 8 numeric characters in length. The format is YYYYMMDD; for example,
19970923. The standard FM date for the discharge is returned by IN5^VADPT.
727.812,12 DSS IDENTIFIER 0;13 FREE TEXT
INPUT TRANSFORM: K:$L(X)>6!($L(X)<6) X
LAST EDITED: MAY 06, 1999
HELP-PROMPT: Answer must be 6 characters in length.
DESCRIPTION: The DSS Identifier is defined as the stop code pair associated with an outpatient encounter. The
Mental Health data currently being extracted cannot be associated with a specific patient
encounter. Therefore, a new unique DSS Identifier will be used for every Mental Health extract
record.
TECHNICAL DESCR:
The DSS Identifier has not yet been determined. The field will be set to null.
727.812,13 PRIMARY CARE TEAM 0;14 FREE TEXT
INPUT TRANSFORM: K:$L(X)>4!($L(X)<1) X
LAST EDITED: MAY 06, 1999
HELP-PROMPT: Answer must be 1-4 characters in length.
DESCRIPTION:
The Primary Care Team assigned to this patient.
TECHNICAL DESCR: The date in the DAY field ((#8) along with the patient pointer in the PATIENT NO. - DFN field (#4)
of the extract record is used to make a call to the Scheduling API, OUTPTTM^SDUTL3. The pointer
(IEN) to the TEAM file (#404.51), retuned by the API, is used. The data is stored as free text.
727.812,14 PRIMARY CARE PROVIDER 0;15 FREE TEXT
INPUT TRANSFORM: K:$L(X)>11!($L(X)<2) X
LAST EDITED: MAY 06, 1999
HELP-PROMPT: Answer must be 2-11 characters in length.
DESCRIPTION:
The Primary Care Provider assigned to this patient.
TECHNICAL DESCR: The date in the DAY field ((#8) along with the patient pointer in the PATIENT NO. - DFN field (#4)
of the extract record is used to make a call to the Scheduling API, OUTPTTM^SDUTL3. The pointer
(IEN) to the NEW PERSON file (#200), retuned by the API, is used.
A "2" is prefixed to the pointer value to indicate that the source file is "200", and the data is
stored as free text.
727.812,15 PLACEHOLDER 0;16 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.812,16 PC PROVIDER PERSON CLASS 0;17 FREE TEXT
INPUT TRANSFORM: K:$L(X)>7!($L(X)<7) X
LAST EDITED: MAY 06, 1999
HELP-PROMPT: Answer must be 7 characters in length.
DESCRIPTION: The field will hold the VA Code associated with the active Person Class of the Primary Care
Provider as assigned by through the PCMM application. The VA Code is always of the form "V"_six
numeric digits; exactly 7 characters in length.
TECHNICAL DESCR: NEW PERSON file #200, Field #5; file #8932.1. Active Person Class is determined by
$$GET^XUA4A71(PERS,DATE), where PERS is the IEN from file #200.
727.812,17 PROVIDER 0;18 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>11!($L(X)<2) X
LAST EDITED: MAY 06, 1999
HELP-PROMPT: Answer must be 2-11 characters in length.
DESCRIPTION: The person who administered or ordered the Mental Health test/interview associated with this
extract record.
TECHNICAL DESCR: A pointer to the NEW PERSON file (#200) is obtained from one of three possible sources: (1) ORDERED
BY field (#2) of the DATE field (#1), #601.22 sub-file, of the (#1) INSTRUMENT field, #601.21
sub-file, of the PSYCH INSTRUMENT PATIENT file (#601.2). (2) INTERVIEWER field (#.09) of the
ADDICTION SEVERITY INDEX file (#604). (3) DIAGNOSIS BY field (#.04) of the DIAGNOSTIC RESULTS -
MENTAL HEALTH file (#627.8).
A numeric character 2 is prefixed to the IEN, and it is stored as free text.
727.812,18 PLACEHOLDER 0;19 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.812,19 PROVIDER PERSON CLASS 0;20 FREE TEXT
INPUT TRANSFORM: K:$L(X)>7!($L(X)<7) X
LAST EDITED: MAY 06, 1999
HELP-PROMPT: Answer must be 7 characters in length.
DESCRIPTION: The field will hold the VA Code associated with the active Person Class of the Provider. The VA
Code is always of the form "V"_six numeric digits; exactly 7 characters in length.
TECHNICAL DESCR: NEW PERSON file #200, Field #5; file #8932.1. Active Person Class is determined by
$$GET^XUA4A71(PERS,DATE), where PERS is the IEN from file #200.
727.812,20 TEST NAME 0;21 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>5!($L(X)<3) X
LAST EDITED: MAY 06, 1999
HELP-PROMPT: Answer must be 3-5 characters in length.
DESCRIPTION: The acronym that represents the name of test, interview, or diagnostic data contained in this
extract record.
TECHNICAL DESCR: The acronym placed in this field will depend upon which Mental Health file is the source of the
data.
(1) If data is extracted from the PSYCH INSTRUMENT PATIENT file (#601.2), then TEST NAME is derived
from the INSTRUMENT field (#.01) of the MH INSTRUMENT file (#601) which is pointed to by the
INSTRUMENT field (#.01) of the INSTRUMENT field (#1), sub-file #601.21, of file #601.2. (2) If
data is extracted from the ADDICTION SEVERITY INDEX file (#604), then TEST NAME is ASI. (3) If
data is extracted from the DIAGNOSTIC RESULTS - MENTAL HEALTH file (#627.8), then TEST NAME is GAF.
727.812,21 TEST IEN 0;22 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>9999)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: MAY 06, 1999
HELP-PROMPT: Type a Number between 1 and 9999, 0 Decimal Digits
DESCRIPTION:
The internal entry number in the MH INSTRUMENT file (#601) for the test data, if appropriate.
TECHNICAL DESCR: If data is extracted from the PSYCH INSTRUMENT PATIENT file (#601.2), then TEST IEN will be the
internal entry number of file MH INSTRUMENT file (#601) contained in the INSTRUMENT field (#.01) of
the INSTRUMENT field (#1), sub-file #601.21, of file #601.2.
If data is extracted form the ADDICTION SEVERITY INDEX file (#604) or the DIAGNOSTIC RESULTS -
MENTAL HEALTH file (#627.8), then TEST IEN is null.
727.812,22 SCALE NUMBER 0;23 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>999)!(X<0)!(X?.E1"."1N.N) X
LAST EDITED: JUL 29, 1999
HELP-PROMPT: Type a Number between 0 and 999, 0 Decimal Digits
DESCRIPTION: SCALE NUMBER is an identifying element for data extracted from PSYCH INSTRUMENT PATIENT file
(#601.2).
TECHNICAL DESCR: If data is extracted from PSYCH INSTRUMENT PATIENT file (#601.2), then this field contains data
taken from the SCALE NUMBER field (#.01) of the TEST SCALE NUMBER field (#16), sub-file #601.01, of
the MH INSTRUMENT file (#601).
If data is extracted form the ADDICTION SEVERITY INDEX file (#604) or the DIAGNOSTIC RESULTS -
MENTAL HEALTH file (#627.8), then SCALE NUMBER is null.
727.812,23 SCALE NAME 0;24 FREE TEXT
INPUT TRANSFORM: K:$L(X)>10!($L(X)<3) X
LAST EDITED: JUL 29, 1999
HELP-PROMPT: Answer must be 3-10 characters in length.
DESCRIPTION: SCALE NAME is an identifying element for data extracted from PSYCH INSTRUMENT PATIENT file (#601.2)
or from the ADDICTION SEVERITY INDEX file (#604).
TECHNICAL DESCR: If data is extracted from PSYCH INSTRUMENT PATIENT file (#601.2), then this field contains data
taken from the SCALE NAME field (#.5) of the TEST SCALE NUMBER field (#16), sub-file #601.01, of
the MH INSTRUMENT file (#601).
If data is extracted from the ADDICTION SEVERITY INDEX file (#604), then SCALE NAME will be one of
the seven standard composite score names which are part of the ASI evaluation. These are Medical,
Emp/Sup, Alcohol, Drug, Legal, Family, and Psych.
If data is extracted from the DIAGNOSTIC RESULTS - MENTAL HEALTH file (#627.8), then SCALE NAME is
null.
727.812,24 TEST SCORE 0;25 FREE TEXT
INPUT TRANSFORM: K:$L(X)>5!($L(X)<1) X
LAST EDITED: MAY 06, 1999
HELP-PROMPT: Answer must be 1-5 characters in length.
DESCRIPTION: TEST SCORE contains the score for a Mental Health test, which is expressed as a single, overall
score, and which is not expressed as one or more scale scores.
TECHNICAL DESCR: If data is extracted from PSYCH INSTRUMENT PATIENT file (#601.2), the TEST SCORE field will contain
the resulting score calculated for the following tests: DOM80, DOM81, DOM82, and DOMG. For all
other tests contained in the MH INSTRUMENT file (#601) that are pointed to by the INSTRUMENT field
(#.01) of the INSTRUMENT field (#1), sub-file #601.21, of file #601.2, TEST SCORE will be set to
null.
If data is extracted from the ADDICTION SEVERITY INDEX file (#604), then TEST SCORE will be set to
null.
If data is extracted from the DIAGNOSTIC RESULTS - MENTAL HEALTH file (#627.8), the TEST SCORE will
contain data from the AXIS 5 field (#65) of file #627.8.
727.812,25 SCALE SCORE 0;26 FREE TEXT
INPUT TRANSFORM: K:$L(X)>6!($L(X)<1) X
LAST EDITED: MAY 06, 1999
HELP-PROMPT: Answer must be 1-6 characters in length.
DESCRIPTION: SCALE SCORE contains the score of one scale of a Mental Health test, which is expressed as one or
more scale scores.
TECHNICAL DESCR: If data is extracted from PSYCH INSTRUMENT PATIENT file (#601.2), the SCALE SCORE field will
contain the resulting score calculated for one scale associated with the following tests: BDI, CRS,
CAGE, or ZUNG. For all other tests contained in the MH INSTRUMENT file (#601) that are pointed to
by the INSTRUMENT field (#.01) of the INSTRUMENT field (#1), sub-file #601.21, of file #601.2,
SCALE SCORE will be set to null.
If data is extracted from the ADDICTION SEVERITY INDEX file (#604), then SCALE SCORE will be the
score associated with one of the seven standard composite score names that are part of the ASI
evaluation. These are Medical, Emp/Sup, Alcohol, Drug, Legal, Family, and Psych.
If data is extracted from the DIAGNOSTIC RESULTS - MENTAL HEALTH file (#627.8), the SCALE SCORE
will be null.
727.812,26 ATTENDING PHYSICIAN 0;27 FREE TEXT
INPUT TRANSFORM: K:$L(X)>11!($L(X)<2) X
LAST EDITED: MAY 06, 1999
HELP-PROMPT: Answer must be 2-11 characters in length.
DESCRIPTION: If the patient identified in the PATIENT NO. DFN field (#4) was an inpatient on the date contained
the DAY field (#8), then ATTENDING PHYSICIAN will refer to the provider who was the ward-attending
physician for the patient.
TECHNICAL DESCR: Data will be taken from the ATTENDING PHYSICIAN field (#.19) of the PATIENT MOVEMENT file (#405)
record for a treating specialty movement. Using the date in the DAY field (#8) and the patient
pointer stored in the PATIENT NO. - DFN field (#4), a call is made to IN5^VADPT which returns the
pertinent patient movement data.
727.812,27 WARD PROVIDER 0;28 FREE TEXT
INPUT TRANSFORM: K:$L(X)>11!($L(X)<2) X
LAST EDITED: MAY 06, 1999
HELP-PROMPT: Answer must be 2-11 characters in length.
DESCRIPTION: If the patient identified in the PATIENT NO. DFN field (#4) was an inpatient on the date contained
the DAY field (#8), then WARD PROVIDER will refer to the provider who was the primary ward provider
for the patient.
TECHNICAL DESCR: Data will be taken from the PRIAMRY CARE PHYSICIAN field (#.08) of the PATIENT MOVEMENT file (#405)
record for a treating specialty movement. Using the date in the DAY field (#8) and the patient
pointer stored in the PATIENT NO. - DFN field (#4), a call is made to IN5^VADPT which returns the
pertinent patient movement data.
727.812,28 MASTER PATIENT INDEX 1;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>10!($L(X)<1) X
LAST EDITED: MAY 06, 1999
HELP-PROMPT: Answer must be 1-10 characters in length.
DESCRIPTION:
A national VA system identifier which uniquely identifies a patient.
TECHNICAL DESCR: The source is not known at this time, but will likely become available in an FY2000 enhancement to
the VistA system.
727.812,29 ASSOCIATE PC PROVIDER 1;2 FREE TEXT
INPUT TRANSFORM: K:$L(X)>11!($L(X)<2) X
LAST EDITED: MAY 06, 1999
HELP-PROMPT: Answer must be 2-11 characters in length.
DESCRIPTION: This is a reference to the NEW PERSON file (#200) for the provider who is the patients Associate
Provider for Primary Care as assigned with the PCMM application. The IEN to file #200 is prefixed
with the character 2.
TECHNICAL DESCR:
This data element will be obtained by use of a function provided by the PCMM application.
727.812,30 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.812,31 ASSOC. PC PROV. PERSON CLASS 1;4 FREE TEXT
INPUT TRANSFORM: K:$L(X)>7!($L(X)<7) X
LAST EDITED: MAY 06, 1999
HELP-PROMPT: Answer must be 7 characters in length.
DESCRIPTION: The field will hold the VA Code associated with the active Person Class of the Associate Primary
Care Provider as assigned by through the PCMM appilcation. The VA Code is always of the form
"V"_six numeric digits; exactly 7 characters in length.
TECHNICAL DESCR: NEW PERSON file #200, Field #5; file #8932.1. Active Person Class is determined by
$$GET^XUA4A71(PERS,DATE), where PERS is the IEN from file #200.
727.812,32 CLASS FOR ASI 1;5 SET
'1' FOR FULL;
'2' FOR LITE;
'3' FOR FOLLOW-UP;
'4' FOR ASI-MV;
LAST EDITED: MAY 22, 2002
DESCRIPTION:
Classification for ASI data only. 1 = FULL 2 = LITE 3 = FOLLOW-UP 4 = ASI-MV
TECHNICAL DESCR:
CLASS field (#.04) of the ADDICTION SEVERITY INDEX file (#604).
727.812,33 SPECIAL FOR ASI 1;6 SET
'1' FOR PATIENT TERMINATED;
'2' FOR PATIENT REFUSED;
'3' FOR PATIENT UNABLE TO RESPOND;
'N' FOR INTERVIEW COMPLETED;
LAST EDITED: MAY 06, 1999
DESCRIPTION: Signifies completion status for ASI data only. 1 = PATIENT TERMINATED 2 = PATIENT REFUSED 3 =
PATIENT UNABLE TO RESPOND N = INTERVIEW COMPLETED
TECHNICAL DESCR:
SPECIAL field (#.11) of the ADDICTION SEVERITY INDEX file (#604).
727.812,34 ASI ENCOUNTER DATE 1;7 DATE
INPUT TRANSFORM: S %DT="E" D ^%DT S X=Y K:Y<1 X
LAST EDITED: JUN 14, 2000
DESCRIPTION:
The date the patient had the ASI encounter.
TECHNICAL DESCR:
The ASI Encounter Date is derived from the ASI Progress Note.
727.812,35 PURPLE HEART INDICATOR 1;8 SET
Purple Heart Indicator
'Y' FOR YES;
'N' FOR NO;
LAST EDITED: OCT 09, 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.812,36 DOM,PRRTP AND SAARTP INDICATOR 1;9 FREE TEXT
INPUT TRANSFORM: K:$L(X)>1!($L(X)<1) X
LAST EDITED: OCT 10, 2000
HELP-PROMPT: Answer must be 1 character in length. DOM, PRRTP and SARTP Indicator indicates the patient status
at the time of hospital service.
DESCRIPTION: DOM, PRRTP and SAARTP Indicator indicates if the patient is admitted to either a DOM, PRRTP or
SAARTP at the time hospital service is provided. Domiciliary (DOM) Psychiatric Residential
Rehabilitation Treatment Program (PRRTP) Substance Abuse Residential Rehabiltation Treatment
Program (SARRTP)
727.812,37 ENROLLMENT CATEGORY 1;10 FREE TEXT
INPUT TRANSFORM: K:$L(X)>1!($L(X)<1) X
LAST EDITED: JUN 14, 2000
HELP-PROMPT: Answer must be 1 character in length.
DESCRIPTION:
Derived from the Patient Enrollment File #27.11
727.812,38 ENROLLMENT STATUS 1;11 FREE TEXT
INPUT TRANSFORM: K:$L(X)>2!($L(X)<1) X
LAST EDITED: JUN 14, 2000
HELP-PROMPT: Answer must be 1-2 characters in length.
DESCRIPTION:
Derived from the Patient Enrollment File #27.11
727.812,39 PLACEHOLDER 1;12 FREE TEXT
INPUT TRANSFORM: K:$L(X)>1!($L(X)<1) X
LAST EDITED: MAR 01, 2004
HELP-PROMPT: Answer must be 1 character in length.
727.812,40 PERIOD OF SERVICE 1;13 FREE TEXT
INPUT TRANSFORM: K:$L(X)>1!($L(X)<1) X
LAST EDITED: JUN 14, 2000
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.812,41 OBSERVATION PATIENT INDICATOR 1;14 FREE TEXT
INPUT TRANSFORM: K:$L(X)>4!($L(X)<1) X
LAST EDITED: AUG 14, 2001
HELP-PROMPT: Answer must be 1-4 characters in length.
DESCRIPTION: This field is derived from the inpatient/outpatient status, treating specialty, and DSS Identifier
or feeder key values in the record.
727.812,42 ENCOUNTER NUMBER 1;15 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: This field is derived from the inpatient/outpatient status, SSN, admit/visit date, treating
specialty, observation patient indicator, and DSS Identifier or feeder key values in the record.
727.812,43 AGENT ORANGE LOCATION 1;16 FREE TEXT
INPUT TRANSFORM: K:$L(X)>2!($L(X)<2) X
LAST EDITED: MAY 03, 2001
HELP-PROMPT: Answer must be 2 characters in length
DESCRIPTION:
This field contains the Agent Orange exposure location.
727.812,44 PATIENT BIRTH DATE 1;17 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<8) X
LAST EDITED: MAY 03, 2001
HELP-PROMPT: Answer must be 8 characters in length
DESCRIPTION:
This field contains the patient's birth date in YYYYMMDD format.
727.812,45 PRODUCTION DIVISION CODE 1;18 FREE TEXT
INPUT TRANSFORM: K:$L(X)>6!($L(X)<1) X
LAST EDITED: APR 29, 2002
HELP-PROMPT: Answer must be 1-6 characters in length.
DESCRIPTION: This is the 3-6 character division where the work took place. This data would correspond to the
entries in the Institution (#4) file.
TECHNICAL DESCR: Data comes from the DIVISION field (#16), subfile (#200.02), of the NEW PERSON file (#200). The
DIVISION field (#.01) is a pointer to the INSTITUTION file (#4). This value is then used to call
the API RADDIV^ECXDEPT to get the STATION NUMBER field (#99) from the INSTITUTION file (#4).
727.812,46 DSS PRODUCT DEPARTMENT 1;19 FREE TEXT
INPUT TRANSFORM: K:$L(X)>10!($L(X)<1) X
LAST EDITED: MAR 02, 2004
HELP-PROMPT: Answer must be 1-10 characters in length
DESCRIPTION:
The nationally defined DSS Intermediate Department Number designated to the Mental care product.
TECHNICAL DESCR: DSS PRODUCT DEPARTMENT field value is determined via the following process: The DSS Product
Department and IP Number File # 727.6 is populated via site specific HL7 messages generated by AAC
extracts which run on a monthly basis. The file is then used by the DSS extract routines to
identify and to populate the DSS PRODUCT DEPARTMENT and DSS IP# fields in the DSS extract files
before transmitting them to AAC.
Using the combination of Feeder System, Feeder Location and Feeder Key as an identifier for each
individual record matches are resolved and the designations are made. If no match is found in file
727.6 an error message is generated and a bulletin is triggered and sent to a DSS mail group
identifying the problem.
727.812,47 HEAD & NECK CANCER INDICATOR 1;20 SET
Head and Neck Cancer Indicator
'Y' FOR YES;
'N' FOR NO;
LAST EDITED: AUG 28, 2002
HELP-PROMPT: Enter the Head & Neck Cancer Indicator for the patient.
DESCRIPTION:
Identifies whether treatment was for 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.812,48 ETHNICITY 1;21 FREE TEXT
Ethnicity
INPUT TRANSFORM: K:$L(X)>6!($L(X)<1) X
LAST EDITED: DEC 10, 2002
HELP-PROMPT: Answer must be 1-6 characters in length
DESCRIPTION:
The patient's PTF Ethnicity code.
TECHNICAL DESCR: Using the patient pointer (DFN) stored in the PATIENT NO. - DFN field (#4), ETHNICITY is derived
from the PTF VALUE field (#5) of the ETHNICITY file (#10.2) pointed to by the ETHNICITY INFORMATION
field (#.01) of the ETHNICITY INFORMATION subfile (#2.06) of the PATIENT file (#2).
The above will occur only if the METHOD OF COLLECTION field (#.02) of the ETHNICITY INFORMATION
subfile (#2.06) is set to 1 (SELF-IDENTIFICATION), otherwise ETHNICITY with be set to null.
727.812,49 RACE 1 1;22 FREE TEXT
Race 1
INPUT TRANSFORM: K:$L(X)>6!($L(X)<1) X
LAST EDITED: AUG 28, 2002
HELP-PROMPT: Answer must be 1-6 characters in length
DESCRIPTION:
The patient's PTF Race code(s).
TECHNICAL DESCR: Using the patient pointer (DFN) stored in the PATIENT NO. - DFN field (4), RACE 1 is derived from
the PTF VALUE field (#5) of the RACE file (#10) pointed to by the RACE INFORMATION field (#.01) of
the RACE INFORMATION subfile (#2.02) of the PATIENT file (#2).
Only those RACE INFORMATION values in the RACE INFORMATION subfile (#2.03) where the METHOD OF
COLLECTION field (#.02) set to 1 (SELF-IDENTIFICATION), will be include in the RACE 1 field. If
any of the RACE INFORMATION values returned is "C" (DECLINED TO ANSWER), that will be the only
value included in the RACE1 field.
727.812,50 DSS IP # 1;23 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>9999999)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: MAR 01, 2004
HELP-PROMPT: Type a Number between 1 and 9999999, 0 Decimal Digits
DESCRIPTION:
The nationally defined DSS Intermediate Product Number designated to the patient care product.
TECHNICAL DESCR: DSS IP# field value is determined via the following process: The DSS PRODUCT DEPARTMENT AND IP
NUMBER file (#727.6) is populated via site specific HL7 messages generated by AAC extracts which
run on a monthly basis. The file is then used by the DSS extract routines to identify and to
populate the DSS PRODUCT DEPARTMENT and DSS IP # fields in the DSS extract files before
transmitting them to AAC. Using the combination of Feeder System, Feeder Location and Feeder Key as
an identifier for each individual record does the matches. If no match is found an error message
is generated and a bulletin is triggered and sent to a DSS mail group identifying the problem.
727.812,51 ENROLLMENT PRIORITY 1;24 FREE TEXT
INPUT TRANSFORM: K:$L(X)>2!($L(X)<1) X
LAST EDITED: FEB 26, 2004
HELP-PROMPT: Answer must be 1-2 characters in length.
DESCRIPTION: ENROLLMENT PRIORITY field contains the enrollment piority group and the enrollment priority
subgroup from the Patient Enrollment File #27.11.
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
727.812,52 USER ENROLLEE 1;25 FREE TEXT
INPUT TRANSFORM: K:$L(X)>1!($L(X)<1) X
LAST EDITED: FEB 26, 2004
HELP-PROMPT: Answer must be 1 character in length.
DESCRIPTION: User enrollee is determined by checking the Patient Enrollment file 27.11, when a user has a
current or future fiscal year in the VistA User Enrollee Status field set value to 'U' and Null if
no date or a past year's value is contained.
727.812,53 DIVISION 1;26 FREE TEXT
INPUT TRANSFORM: K:$L(X)>3!($L(X)<1) X
LAST EDITED: SEP 22, 2004
HELP-PROMPT: Answer must be 1-3 characters in length.
DESCRIPTION: The medical center division associated with the extract data. For DSS purposes, this must
correspond to the labor pool that generated the workload. The division identifier is taken from the
DSS DIVISION IDENTIFIER file (#727.3).
TECHNICAL DESCR: The DIVISION field is then derived as follows:
(1) A pointer to the INSTITUTION file (#4) is obtained using the pointer to file #200. This is
taken from the DIVISION field (#.01) of the first sub-record of the DIVISION field (#16), sub-file
#200.02.
(2) A record in the MEDICAL CENTER DIVISION file (#40.8) which points to the same file #4 record
(3) The IDENTIFIER field (#1) of the DSS DIVISION IDENTIFIER file (#727.3) record which points to
the same Medical Center Division.
727.812,54 PATIENT TYPE 1;27 FREE TEXT
INPUT TRANSFORM: K:$L(X)>2!($L(X)<1) X
LAST EDITED: FEB 26, 2004
HELP-PROMPT: Answer must be 1-2 characters in length.
DESCRIPTION: PATIENT TYPE refers to the various types of patient which might be seen at a VA facility. It is
determined by the TYPE field of the PATIENT File #2 which points to the TYPE OF PATIENT entries in
File #391.
TECHNICAL DESCR: PATIENT TYPE refers to the various types of patient which might be seen at a VA facility. It is
determined by the TYPE field of the PATIENT File #2 which points to the TYPE OF PATIENT entries in
File #391. 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.812,55 CV STATUS ELIGIBILITY 1;28 FREE TEXT
INPUT TRANSFORM: K:$L(X)>1!($L(X)<1) X
LAST EDITED: MAR 17, 2004
HELP-PROMPT: Answer must be 1 character in length.
DESCRIPTION: 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.
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^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', E for 'ELIGIBILITY
EXPIRED' or 'NULL' for 'NOT ELIGIBLE'.
727.812,56 CV ELIGIBILITY END DATE 1;29 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<1) X
LAST EDITED: FEB 26, 2004
HELP-PROMPT: Answer must be 1-8 characters in length.
DESCRIPTION: 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.
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^3010106^0) the 2nd piece is the Combat Vet End Date.
727.812,57 ENCOUNTER CV 1;30 FREE TEXT
INPUT TRANSFORM: K:$L(X)>1!($L(X)<1) X
LAST EDITED: FEB 26, 2004
HELP-PROMPT: Answer must be 1 character in length.
DESCRIPTION: 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.
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^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' for 'NO'.
GROUP: \
727.812,58 NATIONAL PATIENT RECORD FLAG 1;31 FREE TEXT
INPUT TRANSFORM: K:$L(X)>1!($L(X)<1) X
LAST EDITED: FEB 26, 2004
HELP-PROMPT: Answer must be 1 character in length.
DESCRIPTION: 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 the Category I flag is
present and active, otherwise it is NULL.
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 the Category I flag is
present and active, otherwise it is NULL.
727.812,59 ATTENDING PHYSICIAN PC 1;32 FREE TEXT
INPUT TRANSFORM: K:$L(X)>7!($L(X)<1) X
LAST EDITED: APR 05, 2005
HELP-PROMPT: Answer must be 1-7 characters in length.
DESCRIPTION: The field will hold the VA Code associated with the active Person Class of the Attending Physician.
The VA Code is always of the form "V"_six numeric digits; exactly 7.
TECHNICAL DESCR: NEW PERSON file #200, Field #5; file #8932.1. Active Person Class is determined by
$$GET^XUA4A72(PERS,DATE), where PERS is the IEN from file #200.
727.812,60 WARD PROVIDER PERSON CLASS 1;33 FREE TEXT
INPUT TRANSFORM: K:$L(X)>7!($L(X)<1) X
LAST EDITED: APR 05, 2005
HELP-PROMPT: Answer must be 1-7 characters in length.
DESCRIPTION: The field will hold the VA Code associated with the active Person Class of the Attending Physician.
The VA Code is always of the form "V"_six numeric digits; exactly 7.
TECHNICAL DESCR: NEW PERSON file #200, Field #5; file #8932.1. Active Person Class is determined by
$$GET^XUA4A72(PERS,DATE), where PERS is the IEN from file #200.
727.812,61 AGENT ORANGE STATUS 1;34 SET
'Y' FOR YES;
'N' FOR NO;
'U' FOR UNKNOWN;
LAST EDITED: JUL 07, 2006
DESCRIPTION:
Data is Y if this patient was exposed to agent orange, N if not, or U if unknown.
TECHNICAL DESCR: Using the patient pointer (DFN) stored in the PATIENT NO. - DFN field (#4) in the MENTAL HEALTH
EXTRACT (#727.812), the api $$PAT^ECXUTL3 is called to obtain the value for Agent Orange. AGENT
ORANGE data is derived from the AGENT ORANGE EXPOS. INDICATED? field (#.32102) in the PATIENT file
(#2).
727.812,62 ASSOCIATE PC PROVIDER NPI 1;35 FREE TEXT
INPUT TRANSFORM: K:$L(X)>15!($L(X)<1) X
LAST EDITED: MAY 04, 2007
HELP-PROMPT: Answer must be 1-15 characters in length.
DESCRIPTION: A standard unique life-long identifier of the associate primary care provider. This field has a
length of fifteen characters.
TECHNICAL DESCR: ASSOCIATE PC PROVIDER NPI is a standard unique life-long identifier of the associate primary care
provider. The qualified identifier shall be retrieved via the supporting Kernel API:$$NPI^XUSNPI.
727.812,63 ATTENDING PHYSICIAN NPI 1;36 FREE TEXT
INPUT TRANSFORM: K:$L(X)>15!($L(X)<1) X
LAST EDITED: MAY 04, 2007
HELP-PROMPT: Answer must be 1-15 characters in length.
DESCRIPTION: A standard unique life-long identifier of the attending physician. This field has a length of
fifteen characters.
TECHNICAL DESCR: ATTENDING PHYSICIAN NPI is a standard unique life-long identifier of the attending physician. The
qualified identifier shall be retrieved via the supporting Kernel API:$$NPI^XUSNPI.
727.812,64 PRIMARY CARE PROVIDER NPI 1;37 FREE TEXT
INPUT TRANSFORM: K:$L(X)>15!($L(X)<1) X
LAST EDITED: MAY 04, 2007
HELP-PROMPT: Answer must be 1-15 characters in length.
DESCRIPTION: A standard unique life-long identifier of the primary care provider. This field has a length of
fifteen characters.
TECHNICAL DESCR: PRIMARY CARE PROVIDER NPI is a standard unique life-long identifier of the primary care provider.
The qualified identifier shall be retrieved via the supporting Kernel API:$$NPI^XUSNPI.
727.812,65 PROVIDER NPI 2;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>15!($L(X)<1) X
LAST EDITED: MAY 04, 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: PROVIDER NPI is a standard unique life-long identifier of the individuals providing health care
services. The qualified identifier shall be retrieved via the supporting Kernel API:$$NPI^XUSNPI.
727.812,66 WARD PROVIDER NPI 2;2 FREE TEXT
INPUT TRANSFORM: K:$L(X)>15!($L(X)<1) X
LAST EDITED: MAY 04, 2007
HELP-PROMPT: Answer must be 1-15 characters in length.
DESCRIPTION: A standard unique life-long identifier of the ward provider. This field has a length of fifteen
characters.
TECHNICAL DESCR: WARD PROVIDER NPI is a standard unique life-long identifier of the ward provider. The qualified
identifier shall be retrieved via the supporting Kernel API:$$NPI^XUSNPI.
FILES POINTED TO FIELDS
DSS EXTRACT LOG (#727) EXTRACT NUMBER (#2)
PATIENT (#2) PATIENT NO. - DFN (#4)
INPUT TEMPLATE(S):
PRINT TEMPLATE(S):
SORT TEMPLATE(S):
FORM(S)/BLOCK(S):