STANDARD DATA DICTIONARY #727.818 -- CLINIC II EXTRACT FILE 9/29/25 PAGE 1
STORED IN ^ECX(727.818, *** NO DATA STORED YET *** SITE: WWW.BMIRWIN.COM UCI: VISTA,VISTA (VERSION 3.0)
DATA NAME GLOBAL DATA
ELEMENT TITLE LOCATION TYPE
-----------------------------------------------------------------------------------------------------------------------------------
DD ACCESS: @
RD ACCESS: @
WR ACCESS: @
DEL ACCESS: @
LAYGO ACCESS: @
AUDIT ACCESS: @
CROSS
REFERENCED BY: EXTRACT NUMBER(AC)
727.818,.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.818,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.818,2 EXTRACT NUMBER 0;3 POINTER TO DSS EXTRACT LOG FILE (#727) (Required)
LAST EDITED: JUL 26, 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.818^AC^MUMPS
1)= S ^ECX(727.818,"AC",$E(X,1,30),DA)=""
2)= K ^ECX(727.818,"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.818,3 FACILITY 0;4 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>7!($L(X)<1) X
LAST EDITED: MAY 05, 1999
HELP-PROMPT: Answer must be 1-7 characters in length.
DESCRIPTION:
Identifies the facility for this extract record.
TECHNICAL DESCR: An indicator of the division responsible for the patient encounter. It is a pointer to the MEDICAL
CENTER DIVISION file (#40.8).
For scheduled appointments and appended EKG visits, it is taken from the DIVISION field (3.5) of
the HOSPITAL LOCATION file (#44).
For dispositions, stand-alones, and appended lab and x-ray visits, it is derived from the LOCATION
field (#.04)in the OUTPATIENT ENCOUNTER file (#409.68). The LOCATION field points to the HOSPITAL
LOCATION file (#44). The DIVISION field (#3.5) of the pointed-to file #44 record is used.
The data is stored as free text.
727.818,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
clinic visit information.
TECHNICAL DESCR: This field points to a record in the PATIENT file (#2).
For scheduled appointments and appended EKG visits, it is taken from the PATIENT field (#.01)
within the APPOINTMENT field (#1900) multiple of the HOSPITAL LOCATION file (#44).
For dispositions, stand-alones, and appended lab and x-ray visits, it is taken from the PATIENT
field (#.02) in the OUTPATIENT ENCOUNTER file (#409.68).
727.818,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.818), 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.818,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.818), 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.818,7 IN OUT PATIENT INDICATOR 0;8 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>1!($L(X)<1) X
LAST EDITED: MAY 05, 1999
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: This status indicator corresponds to an internal entry number in the LOCATION TYPE file (#40.9),
where IEN=1 is the Clinic location, and IEN=3 is the Ward location.
This field is initialized to a 1, indicating an outpatient status. If a call to IN5^VADPT (using
the patient DFN and the event date) returns a patient movement number, then the field is reset to a
3 indicating inpatient status.
727.818,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 clinic visit extract data is associated.
TECHNICAL DESCR: For scheduled appointments and appended EKG visits -- HOSPITAL LOCATION file (#44); APPOINTMENT
sub-file (#44.001);
APPOINTMENT DATE/TIME field (#.01)
For dispositions, stand-alones, and appended lab and x-ray visits -- OUTPATIENT ENCOUNTER file
(#409.68); DATE field (#.01)
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.818,9 PRIMARY STOP CODE 0;10 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>3!($L(X)<3) X
LAST EDITED: MAY 05, 1999
HELP-PROMPT: Answer must be 3 characters in length.
DESCRIPTION: Primary Stop Code is a fixed length field of 3 numeric characters. The ACTION TO SEND field (#5) of
the CLINIC AND STOP CODES file (#728.44) for the clinic determines the how the data is derived.
TECHNICAL DESCR: Primary Stop Code is taken from the CLINICS AND STOP CODES file (#728.44). The DSS STOP CODE field
(#3) is used. If field #3 is null, then the STOP CODE field (#1) is used. If field #1 is null,
then data is taken from the STOP CODE NUMBER field (#8) of the HOSPITAL LOCATION file (#44).
727.818,10 MASTER PATIENT INDEX 0;11 FREE TEXT
INPUT TRANSFORM: K:$L(X)>10!($L(X)<1) X
LAST EDITED: MAY 05, 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.818,11 SEX 0;12 SET (Required)
'M' FOR MALE;
'F' FOR FEMALE;
LAST EDITED: MAY 05, 1999
DESCRIPTION:
Data is M if this patient is a male, or F if female.
TECHNICAL DESCR: Using the patient pointer (DFN) stored in the PATIENT NO. - DFN field (#4), this data element is
derived from the SEX field (#.02) in the PATIENT file (#2).
727.818,12 DATE OF BIRTH 0;13 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: The patient's date of birth between December 31,1870 and today's date represented by an 8-character
numeric string.
TECHNICAL DESCR: Using the pointer value in the PATIENT NO. - DFN field (#4) of the extract record, data is taken
from the DATE OF BIRTH field (#.03) of the PATIENT file (#2).
If Date of Birth cannot be determined, then January 1, 1942, is used as default. The data element
is always exactly 8 numberic characters in length. Format is YYYYMMDD. Year 2000 compliant per
vendor.
727.818,13 ELIGIBILITY 0;14 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>3!($L(X)<1) X
LAST EDITED: MAY 05, 1999
HELP-PROMPT: Answer must be 1-3 characters in length.
DESCRIPTION:
Appropriate eligibility code based on veteran or non-veteran status.
TECHNICAL DESCR: Using the patient pointer (DFN) stored in the PATIENT NO. - DFN field (#4) of the extract record,
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.818,14 VETERAN 0;15 SET (Required)
'Y' FOR YES;
'N' FOR NO;
LAST EDITED: MAY 05, 1999
DESCRIPTION:
Data is Y if this patient is a veteran, N if not.
TECHNICAL DESCR: Using the patient pointer (DFN) stored in the PATIENT NO. - DFN field (#4) of the extract record,
VETERAN data is derived from the VETERAN (Y/N)? field (#1901) in the PATIENT file (#2).
727.818,15 RACE 0;16 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>1!($L(X)<1) X
LAST EDITED: MAY 05, 1999
HELP-PROMPT: Answer must be 1 character in length.
DESCRIPTION:
Race ABBREVIATION for this patient.
TECHNICAL DESCR: Using the patient pointer (DFN) stored in the PATIENT NO. - DFN field (#4), RACE data is taken from
the ABBREVIATION field (#2) of the RACE file (#10) record pointed to by the RACE field (#.06) in
the PATIENT file (#2).
727.818,16 POW STATUS 0;17 SET
'Y' FOR YES;
'N' FOR NO;
'U' FOR UNKNOWN;
LAST EDITED: MAY 05, 1999
DESCRIPTION:
The patient's POW status. May be set to Y(es), N(o), or U(nknown).
TECHNICAL DESCR: PATIENT file (#2); POW STATUS INDICATED? field (#.525). The status indicator is returned by
SVC^VADPT.
727.818,17 POW LOCATION 0;18 POINTER TO POW PERIOD FILE (#22)
LAST EDITED: MAY 05, 1999
DESCRIPTION: If POW Status is indicated, then this is the POW confinement location/period.
1 WORLD WAR I
2 WORLD WAR II - EUROPE
3 WORLD WAR II - PACIFIC
4 KOREAN
5 VIETNAM
6 OTHER
TECHNICAL DESCR: PATIENT file (#2); POW CONFINEMENT LOCATION field (#.526). This is a pointer value to the POW
PERIOD file (#22). The location indicator is returned by SVC^VADPT.
727.818,18 RADIATION STATUS 0;19 SET
'Y' FOR YES;
'N' FOR NO;
'U' FOR UNKNOWN;
LAST EDITED: MAY 05, 1999
DESCRIPTION:
The patient's Ionizing Radiation status. (Y/N/U)
TECHNICAL DESCR: PATIENT file (#2); RADIATION EXPOSURE INDICATED? field (#.32103). The status indicator is returned
by SVC^VADPT.
727.818,19 AGENT ORANGE STATUS 0;20 SET
'Y' FOR YES;
'N' FOR NO;
'U' FOR UNKNOWN;
LAST EDITED: MAY 05, 1999
DESCRIPTION:
The patient's Agent Orange status.
TECHNICAL DESCR: PATIENT file (#2); AGENT ORANGE EXPOS. INDICATED? field (#.32102). The status indicator is
returned by SVC^VADPT.
727.818,20 MST STATUS 0;21 SET
'Y' FOR Yes, screened reports MST;
'N' FOR Screened, does not report MST;
'D' FOR Screened, declines to answer;
LAST EDITED: MAY 05, 1999
DESCRIPTION: The MST Status of the patient on the date of the outpatient encounter. Possible status values are:
Y = Yes, screened reports MST N = Screened, does not report MST D = Screened, declines to answer
TECHNICAL DESCR: The MST HISTORY file (#29.11) holds data regarding military sexual trauma claims and effective
dates. The patients MST status is stored in the MST STATUS field (#3). A call will be made to
$$GETSTAT^DGMSTAPI(DFN,DGDATE) using the DFN in the PATIENT NO. DFN field and the date in the DAY
field.
727.818,21 STATE 0;22 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>2!($L(X)<2) X
LAST EDITED: MAY 05, 1999
HELP-PROMPT: Answer must be 2 characters in length.
DESCRIPTION:
The state in which the patient resides.
TECHNICAL DESCR: Using the patient pointer (DFN) stored in the PATIENT NO. - DFN field (#4) in the extract record,
data is derived from the STATE field (#.115) in the PATIENT file (#2) which points to the STATE
file (#5). From the STATE file record, the two-character VA STATE CODE field (#2) is used.
727.818,22 COUNTY 0;23 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>3!($L(X)<3) X
LAST EDITED: MAY 05, 1999
HELP-PROMPT: Answer must be 3 characters in length.
DESCRIPTION:
The county in which the patient resides.
TECHNICAL DESCR: Using the patient pointer (DFN) stored in the PATIENT NO. - DFN field (#4) in the extract record,
data is derived from the COUNTY field (#.117) in the PATIENT file (#2), which points to a subfile
record in the COUNTY multiple field (#3) of the STATE file (#5). The three-character VA COUNTY
CODE field (#2) within the COUNTY multiple field is used.
727.818,23 ZIP+4 0;24 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>10!($L(X)<5) X
LAST EDITED: MAY 05, 1999
HELP-PROMPT: Answer must be 5-10 characters in length.
DESCRIPTION:
The patient's zipcode with optional 4-digit extension.
TECHNICAL DESCR: The patient's zipcode with optional 4-digit extension as found in the ZIP+4 field (#.1112) of the
patient's record in the PATIENT file (#2).
727.818,24 ENROLLMENT LOCATION 0;25 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:
The facility that the patient chooses to designate as his preferred location for care.
TECHNICAL DESCR: The PREFERRED FACILITY field (#27.02) of the PATIENT file (#2) is defined as the facility that the
patient chooses to designate as his preferred location for care. The PREFERRED FACILITY field
(#27.02) is a pointer to the INSTITUTION file (#4). From file #4, the value in the STATION NUMBER
field (#99) is used.
727.818,25 PLACEHOLDER1 0;26 FREE TEXT
INPUT TRANSFORM: K:$L(X)>1!($L(X)<1) X
LAST EDITED: MAY 10, 1999
HELP-PROMPT: Answer must be 1 character in length.
DESCRIPTION:
The primary care team assigned to this patient. Placeholder for future use.
TECHNICAL DESCR:
Placeholder; null.
727.818,26 PROVIDER 0;27 FREE TEXT
INPUT TRANSFORM: K:$L(X)>11!($L(X)<2) X
LAST EDITED: MAY 10, 1999
HELP-PROMPT: Answer must be 2-11 characters in length.
DESCRIPTION:
The provider primarily responsible for services to the patient during the clinic visit.
TECHNICAL DESCR: Using the internal entry number for the encounter in the OUTPATIENT ENCOUNTER file (#409.68), the
VISIT FILE ENTRY field (#.05) is determined. This entry is used to make a call to the Patient Care
Encounter API, ENCEVENT^PXAPI. The API returns all visit data in the TMP("PXKENC",$J) array. The
first provider identified as "primary" from the array is used. A default value of null is used if
no "primary" provider is found.
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.818,27 PROVIDER PERSON CLASS 0;28 FREE TEXT
INPUT TRANSFORM: K:$L(X)>7!($L(X)<7) X
LAST EDITED: MAY 10, 1999
HELP-PROMPT: Answer must be 7 characters in length.
DESCRIPTION:
The VA Code of the Person Class of the primary Provider of services during the clinic visit.
TECHNICAL DESCR: The NEW PERSON file (#200) record for the Provider contains pointer fields to the PERSON CLASS file
(#8932.1). This data is returned by $$GET^XUA4A71(PERS,DATE), where PERS is the IEN from file
#200.
The field will hold the VA Code associated with the active Person Class of the primary Provider
associated with the extracted clinic visit.
The VA Code is always of the form "V"_six numeric digits; exactly 7 characters in length.
727.818,28 PROVIDER NPI 0;29 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<1) X
LAST EDITED: MAY 10, 1999
HELP-PROMPT: Answer must be 1-8 characters in length.
DESCRIPTION:
The Provider's National Provider Identifier code.
TECHNICAL DESCR: When National Provider Identifier (NPI) codes become available, this field will hold the Provider
NPI.
Field will be set to null until data becomes available.
727.818,29 SHARING AGREEMENT PAYOR 0;30 FREE TEXT
INPUT TRANSFORM: K:$L(X)>1!($L(X)<1) X
LAST EDITED: MAY 05, 1999
HELP-PROMPT: Answer must be 1 character in length.
DESCRIPTION:
An indicator used for patients participating in sharing agreements.
TECHNICAL DESCR: The ALIAS sub-field (#.01) of the ALIAS multiple field (#1) of the PATIENT file (#2) is used to
indicate a patient who participates in a sharing agreement. If the #.01 field contains any one of
the specified key words, then the patient is considered to be included for Sharing Agreement
information. The keywords are: SHARING AGREEMENT, CHAMPVA, CHAMPUS, TRICARE, CAT C, CATEGORY C.
A one character code for the keyword found in the ALIAS multiple field is obtained by the following
conversion: SHARING AGREEMENT = A TRICARE = B CAT C = C CATEGORY C = C CHAMPVA = D CHAMPUS = E
727.818,30 SHARING AGREEMENT INSURANCE 0;31 FREE TEXT
INPUT TRANSFORM: K:$L(X)>11!($L(X)<1) X
LAST EDITED: MAY 05, 1999
HELP-PROMPT: Answer must be 1-11 characters in length.
DESCRIPTION:
Used to indicate insurer, if patient participates in a sharing agreement.
TECHNICAL DESCR: Data will be taken from the INSURANCE TYPE sub-field (#.01) of the INSURANCE TYPE field (#.3121),
sub-file #2.312, of the PATIENT file (#2). This is a pointer value for the INSURANCE COMPANY file
(#36). Only the first insurance company found in the multiple field is used. The data is stored
as free text.
727.818,31 RADIATION ENCOUNTER INDICATOR 0;32 SET
'Y' FOR YES;
'N' FOR NO;
LAST EDITED: MAY 05, 1999
DESCRIPTION: Indicates whether treatment provided during this encounter was related to the patient's ionizing
radiation exposure.
TECHNICAL DESCR: In the OUTPATIENT ENCOUNTER file (#409.68), the VISIT FILE ENTRY field (#.05) points to the VISIT
file (#9000010). From VISIT file (#9000010), data is taken from the IONIZING RADIATION EXPOSURE
field (#80003).
727.818,32 AO ENCOUNTER INDICATOR 0;33 SET
'Y' FOR YES;
'N' FOR NO;
LAST EDITED: MAY 05, 1999
DESCRIPTION: Indicates whether treatment provided during this encounter was related to the patient's Agent
Orange exposure.
TECHNICAL DESCR: In the OUTPATIENT ENCOUNTER file (#409.68), the VISIT FILE ENTRY field (#.05) points to the VISIT
file (#9000010). From VISIT file (#9000010), data is taken from the AGENT ORANGE EXPOSURE field
(#80002).
727.818,33 MST ENCOUNTER INDICATOR 0;34 SET
'Y' FOR YES;
'N' FOR NO;
LAST EDITED: MAY 05, 1999
DESCRIPTION: Indicates whether treatment provided during this encounter was related to the patient's military
sexual trauma.
TECHNICAL DESCR: In the OUTPATIENT ENCOUNTER file (#409.68), the VISIT FILE ENTRY field (#.05) points to the VISIT
file (#9000010). From VISIT file (#9000010), data is taken from the MILITARY SEXUAL TRAUMA field
(#80005).
727.818,34 DSS DEPT. 0;35 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:
The DSS Department Code for the clinic product.
TECHNICAL DESCR:
A free text field of 4-10 characters; data not yet available. Field is set to null.
727.818,35 ICD-9 CODES 1;1 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>63!($L(X)<63) X
LAST EDITED: MAY 07, 1999
HELP-PROMPT: Answer must be 63 characters in length.
DESCRIPTION: The primary ICD-9 code followed by upto eight secondary IDC-9 codes concatenated together in a
string. Only the primary IDC-9 code is required. Each ICD-9 code is composed of exactly 7
characters, padded on the right with space characters as needed.
TECHNICAL DESCR: Using a pointer to the VISIT file (#9000010) a call to the PCE API, ENCEVENT^PXAPI, is made. This
returns ICD-9 data as pointers to the ICD DIAGNOSIS file (#80). A default value of 799.9 is used
if no "primary" ICD-9 code is found. The remaining ICD-9 pointers values are used tp obtain
secondary ICD-9 codes, upto a total of 8 secondary codes.
Each ICD-9 code is composed of a minimum of 4 characters, i.e., 3 alphanumerics followed by a
decimal point.
There may be fewer than 9 ICD-9 codes for a visit record, but the total length of field #36 is
always 63 characters, many of which may be space characters (i.e., ASCII code 32).
FILES POINTED TO FIELDS
DSS EXTRACT LOG (#727) EXTRACT NUMBER (#2)
PATIENT (#2) PATIENT NO. - DFN (#4)
POW PERIOD (#22) POW LOCATION (#17)
INPUT TEMPLATE(S):
PRINT TEMPLATE(S):
SORT TEMPLATE(S):
FORM(S)/BLOCK(S):