Print Page as PDF
DBIA3035-J ICR (3050)

DBIA3035-J    ICR (3050)

Name Value
NUMBER 3050
IA # 3050
DATE CREATED 2000/02/22
CUSTODIAL PACKAGE PCE PATIENT CARE ENCOUNTER
CUSTODIAL ISC Albany
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE PXAAVTRT
NAME DBIA3035-J
ORIGINAL NUMBER 3035
GENERAL DESCRIPTION
The following is a description of the available APIs
for the V TREATMENT (#9000010.15) file.  The V TREATMENT (#9000010.15) file
stores a record for each treatment provided to a patient on a given patient
visit.
STATUS Active
KEYWORDS PXAA
DURATION Next Version
ID PXAAVTRT
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 TREATMENT (#9000010.15) 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
TREATMENT (#9000010.15) file with the patient visit IEN.
$$GETIENS Output
Returns 0 if no record was found in the V TREATMENT
(#9000010.15) file for the given visit IEN.  Returns 1 if one or more records
were found in the V TREATMENT (#9000010.15) file for the given visit IEN.
$$LOADFLDS(IEN,ARRAY)
This API loads all the field values for a given
record IEN in the V TREATMENT (#9000010.15) file.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the V TREATMENT (#9000010.15) file.
$$LOADFLDS Output
Returns 0 if no record was found in the V TREATMENT
(#9000010.15) file for the given patient IEN.  Returns 1 if the API has
successfully loaded all the field values into the ARRAY variable.
ARRAY Input
(required) All the field values of the V TREATMENT
(#9000010.15) file for the given record IEN such as; Patient Name, Provider
Narrative, Treatment type, etc.
$$TREATMEN(IEN)
This API returns field (#.01) - TREATMENT, of the V
TREATMENT (#9000010.15) file.  A pointer to the TREATMENT (#9999999.17) file.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the V TREATMENT (#9000010.15) file.
$$TREATMEN Output
A pointer to the TREATMENT (#9999999.17) file.
$$PATINAME(IEN)
This API returns field (#.02) - PATIENT NAME, of the
V TREATMENT (#9000010.15) 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 TREATMENT (#9000010.15) file.
$$PATINAME Output
A pointer to the PATIENT/IHS (#9000001) file.
$$VISIT(IEN)
This API returns field (#.03) - VISIT, of the V
TREATMENT (#9000010.15) file.  A pointer to the VISIT (#9000010) file
indicating the date and time for the encounter when the treatment was given.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the V TREATMENT (#9000010.15) file.
$$VISIT Output
A pointer to the Visit (#9000010) file.
$$HOWMANY(IEN)
This API returns field (#.04) - HOW MANY, of the V
TREATMENT (#9000010.15) file.  A numeric value indicating how many times the
treatment was provided.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the V TREATMENT (#9000010.15) file.
$$HOWMANY Output
A numeric value indicating how many times the
treatment was administered.
$$PROVNARR(IEN)
This API returns field (#.06 - PROVIDER NARRATIVE, of
the V TREATMENT (#9000010.15) file.  A pointer to the PROVIDER NARRATIVE
(#9999999.27) file indicating the provider's preferred text used to represent
the treatment provided.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the V TREATMENT (#9000010.15) file.
$$PROVNARR Output
A pointer to the PROVIDER NARRATIVE (#9999999.27)
file.
$$EVENTDT(IEN)
This API returns field (#1201) - EVENT DATE AND TIME,
of the V TREATMENT (#9000010.15) file.  Date and time the  treatment was
provided.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the V TREATMENT (#9000010.15) file.
$$EVENTDT Output
The date and time the treatment was provided.
$$ORDEPROV(IEN)
This API returns field (#1202) - ORDERING PROVIDER,
of the V TREATMENT (#9000010.15) file.  A pointer to the NEW PERSON (#200)
file identifying the provider who ordered the treatment.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the V TREATMENT (#9000010.15) file.
$$ORDEPROV Output
A pointer to the NEW PERSON (#200) file.
$$ENCOPROV(IEN)
This API returns field (#1204) - ENCOUNTER PROVIDER,
of the V TREATMENT (#9000010.15) file.  A pointer to the NEW (#200) file
identifying the provider who gave the treatment.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the V TREATMENT (#9000010.15) file.
$$ENCOPROV Output
A pointer to the NEW PERSON (#200) file identifying
the provider who gave the treatment.
$$EDITFLAG(IEN)
This API returns field (#80101) - EDITED FLAG, of the
V TREATMENT (#9000010.15) file.  This field indicates if PCE detects that any
original treatment data is being edited.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the V TREATMENT (#9000010.15) file.
$$EDITFLAG Output
Returns 1 if PCE detects that any original treatment
data is being edited.
$$AUDITRAI(IEN)
This API returns field (#80102) - AUDIT TRAIL, of the
V TREATMENT (#9000010.15) 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 TREATMENT (#9000010.15) 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_";"
$$PRONARCA(IEN)
This API returns field (#80201) - PROVIDER NARRATIVE
CATEGORY, of the V TREATMENT (#9000010.15) file.  A pointer to the PROVIDER
NARRATIVE (#9999999.27) file indicating the category narrative related to the
treatment.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the V TREATMENT (#9000010.15) file.
$$PRONARCA Output
A pointer to the PROVIDER NARRATIVE (#9999999.27)
file.
$$COMMENTS(IEN)
This API returns field (#81101) - COMMENTS, of the V
TREATMENT (#9000010.15) file.  Any comments related to the patient's
treatment.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
(required) This number represents the Internal Entry
Number for a record in the V TREATMENT (#9000010.15) file.
$$COMMENTS Output
A Free Text value indicating any comments related to
the patient's treatment.
$$VERIFIED(IEN)
This API returns field (#81201) - VERIFIED, of the V
TREATMENT (#9000010.15) file.  This field 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 TREATMENT (#9000010.15) file.
$$VERIFIED Output
1 - Electronically Signed, 2 - Verified by the
Package.
$$PACKAGE(IEN)
This API returns field (#81202) - PACKAGE, of the V
TREATMENT (#9000010.15) 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 TREATMENT (#9000010.15) file.
$$PACKAGE Output
Pointer to the Package (#9.4) file.
$$DATASRC(IEN)
This API returns field (#81203) - DATA SOURCE, of the
V TREATMENT (#9000010.15) 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 TREATMENT (#9000010.15) file.
$$DATASRC Output
Pointer to the PCE Data Source (#839.7) file.

MAIL MESSAGE 30948205
GOOD ONLY FOR VERSION 1.0