Print Page as PDF
DBIA3035-B ICR (3038)

DBIA3035-B    ICR (3038)

Name Value
NUMBER 3038
IA # 3038
DATE CREATED 2000/02/22
CUSTODIAL PACKAGE PCE PATIENT CARE ENCOUNTER
CUSTODIAL ISC Albany
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE PXAAVHF
NAME DBIA3035-B
ORIGINAL NUMBER 3035
GENERAL DESCRIPTION
The following is a description of the available APIs
for the V HEALTH FACTORS (#9000010.23) file.  The V HEALTH FACTORS
(#9000010.23) file is used for storing patient health factors identified
during a visit.
STATUS Active
KEYWORDS PXAA
DURATION Next Version
ID PXAAVHF
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$GETIENS(VSITIEN,ARRAY)
Use this API to retrieve all Internal Entry Numbers
(IEN) from the V HEALTH FACTORS (#9000010.23) file associated with the given
visit IEN, VSITIEN.
VARIABLES TYPE VARIABLES DESCRIPTION
VSITIEN Input
(required) This number represents the Internal Entry
Number for a given patient visit.
ARRAY Input
(required) This array variable is populated by the
API with the Internal Entry Numbers of records found to be associated in the V
HEALTH FACTORS (#9000010.23) file with the patient visit IEN, VSITIEN.
$$GETIENS Output
If the value returned is equal to 0, no record was
found in the V HEALTH FACTORS (#9000010.23) file for the given visit IEN.  If
the value returned is equal to 1, one or more records were found in the V
HEALTH FACTORS (#9000010.23) file.
$$LOADFLDS(IEN,ARRAY)
This API loads all the field values for a given V
HEALTH FACTORS (#9000010.23) record.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the V HEALTH FACTORS (#9000010.23) file.
ARRAY Input
(required) All the field values of the V HEALTH
FACTORS (#9000010.23) file for the given record IEN such as; Patient Name,
Health Factor, Event Date and Time, etc are loaded into this array variable.
$$LOADFLDS Output
If the value returned is equal to 0, no record was
found in the V HEALTH FACTORS (#9000010.23) file for the given IEN.  Returns 1
if the API has successfully loaded all the field values into the ARRAY
variable.
$$HEALFACT(IEN)
This API returns field (#.01) - HEALTH FACTOR, of the
V HEALTH FACTORS (#9000010.23) file.  A pointer to the Health Factor
(#9999999.64) file that most closely represents the patient's health factor
status during the encounter for a given health factor category.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the V HEALTH FACTORS (#9000010.23) file.
$$HEALFACT Output
A pointer to the Health Factor (#9999999.64) file.
$$PATINAME(IEN)
This API returns field (#.02) - PATIENT NAME, of the
V HEALTH FACTORS (#9000010.23) 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 V HEALTH FACTORS (#9000010.23) file.
$$PATINAME Output
A pointer to the PATIENT/IHS (#9000001) file.
$$VISIT(IEN)
This API returns field (#.03) - VISIT, of the V
HEALTH FACTORS (#9000010.23) file.  A pointer to the VISIT (#9000010) file.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the V HEALTH FACTORS (#9000010.23) file.
$$VISIT Output
A pointer to the Visit (#9000010) file.
$$LEVESEVE(IEN)
This API returns field (#.04) - LEVEL/SEVERITY, of
the V HEALTH FACTORS (#9000010.23) file.  This field indicates the
Level/Severity of the patient's Health Factors identified during the visit.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the V HEALTH FACTORS (#9000010.23) file.
$$LEVESEVE Output
'M' - Minimal level of severity.  'MO' - Moderate
level of severity.  'H' - Heavy/Severe level of severity.
$$EVENTDT(IEN)
This API returns field (#1201) - EVENT DATE & TIME,
of the V HEALTH FACTORS (#9000010.23) fil.  The date and time the health
factor was recorded by the provider.  Note : This date and time may be
different from  the visit date and time.  For example, for clinic appointment
visits, the visit date and time is the date and time of the appointment, not
the time the provider performed the clinical event.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the V HEALTH FACTORS (#9000010.23) file.
$$EVENTDT Output
The Date and Time that the procedure took place.
$$ORDEPROV(IEN)
This API returns field (#1202) -  ORDERING PROVIDER,
of the V HEALTH FACTORS (#9000010.23) file.  A pointer to the NEW PERSON
(#200) file identifying the provider who ordered this health factor to be
recorded.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the V HEALTH FACTORS (#9000010.23) file.
$$ORDEPROV Output
A pointer to the NEW PERSON (#200) file identifying
the provider who ordered this health factor to be recorded.
$$ENCOPROV(IEN)
This API returns field (#1204) - ENCOUNTER PROVIDER,
of the V HEALTH FACTORS (#9000010.23) file.  A pointer to the NEW PERSON
(#200) file identifying the provider who recorded the health factor.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the V HEALTH FACTORS (#9000010.23) file.
$$ENCOPROV Output
A pointer to the NEW PERSON (#200) file identifying
the provider who recorded the health factor.
$$EDITED(IEN)
This API returns field (#80101) - EDITED FLAG, of the
V HEALTH FACTORS (#9000010.23) file.  A value indicating if PCE detects that
any original health factor data is being edited.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the V HEALTH FACTORS (#9000010.23) file.
$$EDITED Output
Returns '1' indicating if PCE detects that any
original data is being edited.
$$AUDITRAI(IEN)
This API returns field (#80102) - AUDIT TRAIL, of the
V HEALTH FACTORS (#9000010.23) file.  This field is populated automatically by
the PCE filing logic. The format of the field is as follows:  Pointer to PCE
data source file_"-"_A for Add or E for Edit_" "_DUZ of the person who entered
the data_";".
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the V HEALTH FACTORS (#9000010.23) file.
$$AUDITRAI Output
A Free Text value in the format; Pointer to PCE data
source file_"-"_A for Add or E for Edit_" "_DUZ of the person who entered the
data_";"
$$COMMENTS(IEN)
This API returns field (#81101) - COMMENTS, of the V
HEALTH FACTORS (#9000010.23) file.  Any comments related to the patient's
health factors.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the V HEALTH FACTORS (#9000010.23) file.
$$COMMENTS Output
A Free Text value indicating any comments related to
the patient's health factors.
$$VERIFIED(IEN)
This API returns field (#81201) - VERIFIED, of the V
HEALTH FACTORS (#9000010.23) file.  A flag indicating whether the record was
Electronically Signed or Verified by the Package.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the V HEALTH FACTORS (#9000010.23) file.
$$VERIFIED Output
1 - Electronically Signed.  2 - Verified by the
Package.
$$PACKAGE(IEN)
This API returns field (#81202) - PACKAGE, of the V
HEALTH FACTORS (#9000010.23) 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 V HEALTH FACTORS (#9000010.23) file.
$$PACKAGE Output
Pointer to the Package (#9.4) file.
$$DATASRC(IEN)
This API returns field (#81203) - DATA SOURCE, of the
V HEALTH FACTORS (#9000010.23) 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 V HEALTH FACTORS (#9000010.23) file.
$$DATASRC Output
Pointer to the PCE Data Source (#839.7) file.

GOOD ONLY FOR VERSION 1.0