Print Page as PDF
DBIA3035-E ICR (3045)

DBIA3035-E    ICR (3045)

Name Value
NUMBER 3045
IA # 3045
DATE CREATED 2000/02/22
CUSTODIAL PACKAGE PCE PATIENT CARE ENCOUNTER
CUSTODIAL ISC Albany
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE PXAAVPED
NAME DBIA3035-E
ORIGINAL NUMBER 3035
GENERAL DESCRIPTION 
The following is a description of the available APIs
for the V PATIENT ED (#9000010.16) file.  The V PATIENT ED (#9000010.16) file
is used to store stores the patient education given to a patient or his
responsible care given.
STATUS Active
KEYWORDS PXAA
DURATION Next Version
ID PXAAVPED
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 PATIENT ED (#9000010.16) 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
PATIENT ED (#9000010.16) file with the patient visit IEN.
$$GETIENS Output 
Returns 0 if no record was found in the V PATIENT ED
(#9000010.16) file for the given visit IEN.  Returns 1 if one or more records
were found in the V PATIENT ED (#9000010.16)  file for the given visit IEN.
$$LOADFLDS(IEN,ARRAY) 
This API loads all the field values for a given
record IEN in the V PATIENT ED (#9000010.16) file.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input 
(required) This number represents the Internal Entry
Number for a record in the V PATIENT ED (#9000010.16) file.
ARRAY Input 
(required) Loads all the field values of the V
PATIENT ED (#9000010.16) file for the given record IEN such as; Patient Name,
Topic, Level of Understanding.
$$LOADFLDS Output 
Returns 0 if no record was found in the V PATIENT ED
(#9000010.16) file for the given patient IEN.  Returns 1 if the API has
successfully loaded all the field values into the ARRAY variable.
$$TOPIC(IEN) 
This API returns field (#.01) - TOPIC, of the V
PATIENT ED (#9000010.16) file.  A pointer to the EDUCATION TOPICS
(#9999999.09) file indicating the education given to the patient.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input 
(required) This number represents the Internal Entry
Number for a record in the V PATIENT ED (#9000010.16) file.
$$TOPIC Output 
A pointer to the EDUCATION TOPICS (#9999999.09) file.
$$PATINAME(IEN) 
This API returns field (#.02) - PATIENT NAME, of the
V PATIENT ED (#9000010.16) 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 PATIENT ED (#9000010.16) file.
$$PATINAME Output 
A pointer to the PATIENT/IHS (#9000001) file.
$$VISIT(IEN) 
This API returns field (#.03) - VISIT, of the V
PATIENT ED (#9000010.16) 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 PATIENT ED (#9000010.16) file.
$$VISIT Output 
A pointer to the Visit (#9000010) file indicating the
date and time when the immunization was given.
$$LEVEOFUN(IEN) 
This API returns field (#.06) - LEVEL OF
UNDERSTANDING, of the V PATIENT ED (#9000010.16) file.  A number which best
rates the patient's level of understanding of the education given.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input 
(required) This number represents the Internal Entry
Number for a record in the V PATIENT ED (#9000010.16) file.
$$LEVEOFUN Output 
1 - POOR, 2 - FAIR, 3 - GOOD, 4 - GROUP-NO
ASSESSMENT, 5 - REFUSED.
$$EVENTDT(IEN) 
This API returns field (#1201) - EVENT DATE & TIME,
of the V PATIENT ED (#9000010.16) file.  The date and time the patient
education was given.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input 
(required) This number represents the Internal Entry
Number for a record in the V PATIENT ED (#9000010.16) file.
$$EVENTDT Output 
The date and time the patient education was given.
$$ORDEPROV(IEN) 
This API returns field (#1202) - ORDERING PROVIDER,
of the V PATIENT ED (#9000010.16) file.  A pointer to the NEW PERSON (#200)
file identifying the provider who ordered the patient education.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input 
(required) This number represents the Internal Entry
Number for a record in the V PATIENT ED (#9000010.16) file.
$$ORDEPROV Output 
A pointer to the NEW PERSON (#200) file identifying
the provider who ordered the patient education.
$$ENCOPROV(IEN) 
This API returns field (#1204) - ENCOUNTER PROVIDER,
of the V PATIENT ED (#9000010.16) file.  A pointer to the NEW PERSON (#200)
file identifying the provider who gave the patient education.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input 
(required) This number represents the Internal Entry
Number for a record in the V PATIENT ED (#9000010.16) file.
$$ENCOPROV Output 
A pointer to the NEW PERSON (#200) file identifying
the provider who gave the patient education.
$$EDITFLAG(IEN) 
This API returns field (#80101) - EDITED FLAG, of the
V PATIENT ED (#9000010.16) file.  This field indicates if PCE detects that any
original exam data is being edited.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input 
(required) This number represents the Internal Entry
Number for a record in the V PATIENT ED (#9000010.16) file.
$$EDITFLAG Output 
Returns 1 if PCE detects that any original exam data
is being edited.
$$AUDITRAI(IEN) 
This API returns field (#80102) - AUDIT TRAIL, of the
V PATIENT ED (#9000010.16) 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 PATIENT ED (#9000010.16) 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
PATIENT ED (#9000010.16) file.  Any comments related to the patient's
education.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input 
(required) This number represents the Internal Entry
Number for a record in the V PATIENT ED (#9000010.16) file.
$$COMMENTS Output 
A Free Text value indicating any comments related to
the patient's education.
$$VERIFIED(IEN) 
This API returns field (#81201) - VERIFIED, of the V
PATIENT ED (#9000010.16) file.  This field flag indicates 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 PATIENT ED (#9000010.16) file.
$$VERIFIED Output 
1 - Electronically Signed, 2 - Verified by the
Package.
$$PACKAGE(IEN) 
This API returns field (#81202) - PACKAGE, of the V
PATIENT ED (#9000010.16) 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 PATIENT ED (#9000010.16) file.
$$PACKAGE Output 
Pointer to the Package (#9.4) file.
$$DATASRC(IEN) 
This API returns field (#81203) - DATA SOURCE, of the
V PATIENT ED (#9000010.16) 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 PATIENT ED (#9000010.16) file.
$$DATASRC Output 
Pointer to the PCE Data Source (#839.7) file.
GOOD ONLY FOR VERSION 1.0