Print Page as PDF
DBIA3035-H ICR (3048)

DBIA3035-H    ICR (3048)

Name Value
NUMBER 3048
IA # 3048
DATE CREATED 2000/02/22
CUSTODIAL PACKAGE PCE PATIENT CARE ENCOUNTER
CUSTODIAL ISC Albany
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE PXAAVSIT
NAME DBIA3035-H
ORIGINAL NUMBER 3035
GENERAL DESCRIPTION
The following is a description of the available APIs
for the VISIT (#9000010) file.  The VISIT (#9000010) file contains a record of
all patient visits at health care facilities or by health care providers,
including direct outpatient and clinic visits, as well as inpatient encounters
with providers of care.
STATUS Active
KEYWORDS PXAA
DURATION Next Version
ID PXAAVSIT
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$LOADFLDS(IEN,ARRAY)
This API loads all the field values for a given
record IEN in the VISIT (#9000010) file.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the VISIT (#9000010) file.
ARRAY Input
(required) All the field values of the VISIT
(#9000010) file for the given record IEN such as; Patient Name, Provider
Narrative, Modifier, etc.
$$LOADFLDS Output
Returns 0 if no record was found in the VISIT
(#9000010) file for the given patient IEN.  Returns 1 if the API has
successfully loaded all the field values into the ARRAY variable.
$$VISADDAT(IEN)
This API returns field (#.01) - VISIT/ADMIT DATE AND
TIME, of the VISIT (#9000010) file.  The date and time of the visit.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the VISIT (#9000010) file.
$$VISADDAT Output
The date and time of the visit.
$$DATVISCR(IEN)
This API returns field (#.02) - DATE VISIT CREATED,
of the VISIT (#9000010) file.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the VISIT (#9000010) file.
$$DATVISCR Output
The date and time of the visit was created.
$$TYPE(IEN)
This API returns field (#.03) - VISIT TYPE, of the
VISIT (#9000010) file.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the VISIT (#9000010) file.
$$TYPE Output
Returns; 'I' - HIS, 'C' - CONTRACT, 'T' - TRIBAL, 'O'
- OTHER, '6' - 638 PROGRAM, 'V' - VA
$$PATINAME(IEN)
This API returns field (#.05) - PATIENT NAME, of the
VISIT (#9000010) file.  A pointer to the PATIENT/IHS (#9000001) file.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the VISIT (#9000010) file.
$$PATINAME Output
A pointer to the PATIENT/IHS (#9000001) file.
$$LOCOFENC(IEN)
This API returns field (#.06) - LOCATION OF
ENCOUNTER, of the VISIT (#9000010) file.  A pointer to the LOCATION
(#9999999.06) file.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the VISIT (#9000010) file.
$$LOCOFENC Output
A pointer to the LOCATION (#9999999.06) file.
$$SERVCATE(IEN)
This API returns field (#.07) - SERVICE CATEGORY, of
the VISIT (#9000010) file.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the VISIT (#9000010) file.
$$SERVCATE Output
Returns; 'A' - AMBULATORY, 'H' - HOSPITALIZATION, 'I'
- IN HOSPITAL, 'C' - CHART REVIEW, 'T' - TELECOMMUNICATIONS, 'N' - NOT FOUND,
'S' - DAY SURGERY, 'O' - OBSERVATION, 'E' - EVENT (HISTORICAL), 'R' - NURSING
HOME, 'D' - DAILY HOSPITALIZATION DATA, 'X' - ANCILLARY PACKAGE DAILY DATA
$$DSSID(IEN)
This API returns field (#.08) - DSS ID, of the VISIT
(#9000010) file.  A pointer to the CLINIC STOP (#40.7) file and indicates the
organized clinic in which this visit took place.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the VISIT (#9000010) file.
$$DSSID Output
A pointer to the CLINIC STOP (#40.7) file.
$$DEPENTCO(IEN)
This API returns field (#.09) - DEPENDENT ENTRY
COUNT, of the VISIT (#9000010) file.  A number representing how many "V" file
entries are pointing to this visit.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the VISIT (#9000010) file.
$$DEPENTCO Output
A number representing how many "V" file entries are
pointing to this visit.
$$DELEFLAG(IEN)
This API returns field (#.11) - DELETE FLAG, of the
VISIT (#9000010) file.  Flag set to signify that the visit has been deleted.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the VISIT (#9000010) file.
$$DELEFLAG Output
Returns; '1' - YES or '0' - NO.
$$PARVISLI(IEN)
This API returns field (#.12) - PARENT VISIT LINK, of
the VISIT (#9000010) file.  A pointer to the VISIT (#9000010) file, the PARENT
VISIT LINK field points back to the VISIT file.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the VISIT (#9000010) file.
$$PARVISLI Output
A pointer to the VISIT (#9000010) file.
$$DATLASMO(IEN)
This API returns field (#.13) - DATE LAST MODIFIED,
of the VISIT (#9000010) file.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the VISIT (#9000010) file.
$$DATLASMO Output
Date last modified.
$$CHEOUDAT(IEN)
This API returns field (#.18) - CHECK OUT DATE AND
TIME, of the VISIT (#9000010) file.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the VISIT (#9000010) file.
$$CHEOUDAT Output
Check out date and time.
$$ELIGIBIL(IEN)
This API returns field (#.21) - ELIGIBILITY, of the
VISIT (#9000010) file.  A pointer to the ELIGIBILITY CODE (#8) file which
defines the patient's eligibility for this visit.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the VISIT (#9000010) file.
$$ELIGIBIL Output
A pointer to the ELIGIBILITY CODE (#8) file.
$$HOSPLOCA(IEN)
This API returns field (#.22) - HOSPITAL LOCATION, of
the VISIT (#9000010) file.  A pointer to the HOSPITAL LOCATION (#44) file.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the VISIT (#9000010) file.
$$HOSPLOCA Output
A pointer to the HOSPITAL LOCATION (#44) file.
$$CREABYUS(IEN)
This API returns field (#.23) - CREATED BY USER, of
the VISIT (#9000010) file.  A pointer to the NEW PERSON (#200) file,
indicating the name of the user who created this visit entry.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the VISIT (#9000010) file.
$$CREABYUS Output
A pointer to the NEW PERSON (#200) file.
$$OPTUSTOC(IEN)
This API returns field (#.24) - OPTION USED TO
CREATE, of the VISIT (#9000010) file.  A pointer to the OPTION (#19) file,
indicating the option which was used to create the visit.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the VISIT (#9000010) file.
$$OPTUSTOC Output
A pointer to the OPTION (#19) file.
$$PROTOCOL(IEN)
This API returns field (#.25) - PROTOCOL, of the
VISIT (#9000010) file.  A pointer to the PROTOCOL (#101) file, indicating the
protocol which was used to create the visit.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the VISIT (#9000010) file.
$$PROTOCOL Output
A pointer to the PROTOCOL (#101) file.
$$OUTSLOCA(IEN)
This API returns field (#2101) - OUTSIDE LOCATION, of
the VISIT (#9000010) file.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the VISIT (#9000010) file.
$$OUTSLOCA Output
Free text indicating the location of service.
$$VISITID(IEN)
This API returns field (#15001) - VISIT ID, of the
VISIT (#9000010) file.  A unique visit id and is set by Visit Tracking and
cannot be changed.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the VISIT (#9000010) file.
$$VISITID Output
Visit ID.
$$PATSTINO(IEN)
This API returns field (#15002) - PATIENT STATUS
IN/OUT, of the VISIT (#9000010) file.  An indicator of the patient's status at
the time of the visit.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the VISIT (#9000010) file.
$$PATSTINO Output
Returns; '1' - IN or '0' - OUT.
$$ENCOTYPE(IEN)
This API returns field (#15003) - ENCOUNTER TYPE, of
the VISIT (#9000010) file.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the VISIT (#9000010) file.
$$ENCOTYPE Output
Returns; 'P' - PRIMARY, 'O' - OCCASION OF SERVICE,
'S' - STOP CODE, 'A' - ANCILLARY, 'C' - CREDIT STOP
$$SERVCONN(IEN)
This API returns field (#80001) - SERVICE CONNECTED,
of the VISIT (#9000010) file.  This field indicates whether the problem
treated was service connected.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the VISIT (#9000010) file.
$$SERVCONN Output
Returns; 1 - YES or 0 - NO.
$$AGEORAEX(IEN)
This API returns field (#80002) - AGENT ORANGE
EXPOSURE, of the VISIT (#9000010) file.  This field indicates if the problem
treated is related to Agent Orange exposure.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the VISIT (#9000010) file.
$$AGEORAEX Output
Returns; 1 - YES or 0 - NO.
$$IONRADEX(IEN)
This API returns field (#80003) - IONIZING RADIATION
EXPOSURE, of the VISIT (#9000010) file.  This field indicates if the problem
treated is related to Ionizing Radiation Exposure.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the VISIT (#9000010) file.
$$IONRADEX Output
Returns; 1 - YES or 0 - NO.
$$PERGULEX(IEN)
This API returns field (#80003) - PERSIAN GULF
EXPOSURE, of the VISIT (#9000010) file.  This field indicates if the problem
treated is related to Persian Gulf Exposure.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the VISIT (#9000010) file.
$$PERGULEX Output
Returns; 1 - YES or 0 - NO.
$$COMMENTS(IEN)
This API returns field (#81101) - COMMENTS, of the
VISIT (#9000010) file.  Any comments related to the purpose of visit.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the VISIT (#9000010) file.
$$COMMENTS Output
A Free Text value indicating any comments related to
the purpose of visit.
$$DATASRC(IEN)
This API returns field (#81203) - DATA SOURCE, of the
VISIT (#9000010) file.  A pointer to the PCE Data Source (#839.7) file.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the VISIT (#9000010) file.
$$DATASRC Output
Pointer to the PCE Data Source (#839.7) file.
$$PACKAGE(IEN)
This API returns field (#81202) - PACKAGE, of the
VISIT (#9000010) file.  A pointer to the Package (#9.4) file.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the VISIT (#9000010) file.
$$PACKAGE Output
Pointer to the Package (#9.4) file.
$$MLTYSXTR(IEN)
This API returns field (#80005) - MILITARY SEXUAL
TRAUMA, of the VISIT (#9000010) file.  This field indicates if the problem
treated is related to Military Sexual Trauma.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required)  This number represents the Internal Entry
Number for a record in the VISIT (#9000010) file.
$$MLTYSXTR Output
Returns; 1 - YES  or 0 - NO

MAIL MESSAGE 30948205
GOOD ONLY FOR VERSION 1.0