DBIA3035-I ICR (3049)

Name

Value

NUMBER

3049

IA #

3049

DATE CREATED

2000/02/22

CUSTODIAL PACKAGE

PCE PATIENT CARE ENCOUNTER

CUSTODIAL ISC

Albany

USAGE

Supported

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

PXAAVSK

NAME

DBIA3035-I

ORIGINAL NUMBER

3035

GENERAL DESCRIPTION

The following is a description of the available APIs
for the V SKIN TEST (#9000010.12) file.  The V SKIN TEST (#9000010.12) file
stores record details for each type of skin test given to a patient on a given
visit.

STATUS

Active

KEYWORDS

PXAA

DURATION

Next Version

PXAAVSK

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

$$GETIENS(VSITIEN,ARRAY)

Use this API to retrieve all Internal Entry Numbers
(IEN) from the V SKIN TEST (#9000010.12) 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
SKIN TEST (#9000010.12) file with the patient visit IEN.

$$GETIENS

Output

Returns 0 if no record was found in the V SKIN TEST
(#9000010.12) file for the given visit IEN.  Returns 1 if one or more records
were found in the V SKIN TEST (#9000010.12) file for the given visit IEN.

$$LOADFLDS(IEN,ARRAY)

This API loads all the field values for a given
record IEN in the V SKIN TEST (#9000010.12) file.

VARIABLES

TYPE

VARIABLES DESCRIPTION

IEN

Input

(required) This number represents the Internal Entry
Number for a record in the V SKIN TEST (#9000010.12) file.

ARRAY

Input

(required) All the field values of the V SKIN TEST
(#9000010.12) file for the given record IEN such as; Patient Name, Skin Test,
Readings, etc

$$LOADFLDS

Output

Returns 0 if no record was found in the V SKIN TEST
(#9000010.12) file for the given patient IEN.  Returns 1 if the API has
successfully loaded all the field values into the ARRAY variable.

$$SKINTEST(IEN)

This API returns field (#.01) - SKIN TEST, of the V
SKIN TEST (#9000010.12) file.  A pointer to the SKIN TEST (#9999999.28) file
which indicates the type of  Skin Test that was given to the patient at the
encounter.

VARIABLES	TYPE	VARIABLES DESCRIPTION
IEN	Input	(required) This number represents the Internal Entry Number for a record in the V SKIN TEST (#9000010.12) file.
$$SKINTEST	Output	A pointer to the SKIN TEST (#9999999.28) file.

$$PATINAME(IEN)

This API returns field (#.02) - PATIENT NAME, of the
V SKIN TEST (#9000010.12) 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 SKIN TEST (#9000010.12) file.
$$PATINAME	Output	A pointer to the PATIENT/IHS (#9000001) file.

$$VISIT(IEN)

This API returns field (#.03) - VISIT, of the V SKIN
TEST (#9000010.12) file.  A pointer to the VISIT (#9000010) file, indicating
the date and time when the immunization was given.

VARIABLES	TYPE	VARIABLES DESCRIPTION
IEN	Input	(required) This number represents the Internal Entry Number for a record in the V SKIN TEST (#9000010.12) file.
$$VISIT	Output	A pointer to the Visit (#9000010) file.

$$RESULTS(IEN)

This API returns field (#.04) - RESULTS, of the V
SKIN TEST (#9000010.12) file.  A numeric value indicating if the test results
were positive, negative, doubtful or no take, if known.

VARIABLES	TYPE	VARIABLES DESCRIPTION
IEN	Input	(required) This number represents the Internal Entry Number for a record in the V SKIN TEST (#9000010.12) file.
$$RESULTS	Output	Returns; 'P' - POSITIVE, 'N' - NEGATIVE, 'D' - DOUBTFUL, 'O' - NO TAKE

$$READING(IEN)

This API returns field (#.05) - READING, of the V
SKIN TEST (#9000010.12) file.  A value representing the reading of the skin
test.

VARIABLES	TYPE	VARIABLES DESCRIPTION
IEN	Input	(required) This number represents the Internal Entry Number for a record in the V SKIN TEST (#9000010.12) file.
$$READING	Output	A numeric value representing the reading of the skin test.

$$DATEREAD(IEN)

This API returns field (#.06) - DATE READ, of the V
SKIN TEST (#9000010.12) file.  The Date of the Reading.

VARIABLES	TYPE	VARIABLES DESCRIPTION
IEN	Input	(required) This number represents the Internal Entry Number for a record in the V SKIN TEST (#9000010.12) file.
$$DATEREAD	Output	Date of the Reading.

$$EVENTDT(IEN)

This API returns field (#1201) - EVENT DATE AND TIME,
of the V SKIN TEST (#9000010.12) file.  The date and time the skin test was
performed.

VARIABLES	TYPE	VARIABLES DESCRIPTION
IEN	Input	(required) This number represents the Internal Entry Number for a record in the V SKIN TEST (#9000010.12) file.
$$EVENTDT	Output	The date and time the skin test was performed.

$$ORDEPROV(IEN)

This API returns field (#1202) - ORDERING PROVIDER,
of the V SKIN TEST (#9000010.12) file.  A pointer to the NEW PERSON (#200)
file identifying the provider who ordered the skin test.

VARIABLES	TYPE	VARIABLES DESCRIPTION
IEN	Input	(required) This number represents the Internal Entry Number for a record in the V SKIN TEST (#9000010.12) file.
$$ORDEPROV	Output	A pointer to the NEW PERSON (#200) file.

$$ENCOPROV(IEN)

This API returns field (#1204) - ENCOUNTER PROVIDER,
of the V SKIN TEST (#9000010.12) file.  A pointer to the NEW (#200) file
identifying the provider who performed the skin test.

VARIABLES	TYPE	VARIABLES DESCRIPTION
IEN	Input	(required) This number represents the Internal Entry Number for a record in the V SKIN TEST (#9000010.12) file.
$$ENCOPROV	Output	A pointer to the NEW PERSON (#200) file.

$$EDITFLAG(IEN)

This API returns field (#80101) - EDITED FLAG, of the
V SKIN TEST (#9000010.12) file.  This field indicates if PCE detects that any
original skin test data is being edited.

VARIABLES	TYPE	VARIABLES DESCRIPTION
IEN	Input	(required) This number represents the Internal Entry Number for a record in the V SKIN TEST (#9000010.12) file.
$$EDITFLAG	Output	Returns 1 if PCE detects that any original skin test data is being edited.

$$AUDITRAI(IEN)

This API returns field (#80102) - AUDIT TRAIL, of the
V SKIN TEST (#9000010.12) 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 SKIN TEST (#9000010.12) 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
SKIN TEST (#9000010.12) file.  Any comments related to the skin test.

VARIABLES	TYPE	VARIABLES DESCRIPTION
IEN	Input	(required) This number represents the Internal Entry Number for a record in the V SKIN TEST (#9000010.12) file.
$$COMMENTS	Output	A Free Text value indicating any comments related to the skin test.

$$VERIFIED(IEN)

This API returns field (#81201) - VERIFIED, of the V
SKIN TEST (#9000010.12) 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 SKIN TEST (#9000010.12) file.
$$VERIFIED	Output	Returns; 1 - Electronically Signed or 2 - Verified by the Package.

$$PACKAGE(IEN)

This API returns field (#81202) - PACKAGE, of the V
SKIN TEST (#9000010.12) 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 SKIN TEST (#9000010.12) file.
$$PACKAGE	Output	Pointer to the Package (#9.4) file.

$$DATASRC(IEN)

This API returns field (#81203) - DATA SOURCE, of the
V SKIN TEST (#9000010.12) 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 SKIN TEST (#9000010.12) file.
$$DATASRC	Output	Pointer to the PCE Data Source (#839.7) file.

GOOD ONLY FOR VERSION

1.0