DBIA3035-C ICR (3043)

Name

Value

NUMBER

3043

IA #

3043

DATE CREATED

2000/02/22

CUSTODIAL PACKAGE

PCE PATIENT CARE ENCOUNTER

CUSTODIAL ISC

Albany

USAGE

Supported

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

PXAAVIMM

NAME

DBIA3035-C

ORIGINAL NUMBER

3035

GENERAL DESCRIPTION

The following is a description of the available APIs
for the V IMMUNIZATION (#9000010.11) file.  The V IMMUNIZATION (#9000010.11)
file is used to store immunizations specific to a particular visit for a
particular patient.  This file contains one record for each immunization.

STATUS

Active

KEYWORDS

PXAA

DURATION

Next Version

PXAAVIMM

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

$$GETIENS(VSITIEN,ARRAY)

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

$$GETIENS

Output

Returns '0' if no records were found in the V
IMMUNIZATION (#9000010.11) file for the given visit IEN.  Returns '1' if one
or more records were found in the V IMMUNIZATION (#9000010.11) file for the
given visit IEN.

$$LOADFLDS(IEN,ARRAY)

This API loads all the field values for a given
record IEN in the V IMMUNIZATION (#9000010.11) file.

VARIABLES

TYPE

VARIABLES DESCRIPTION

IEN

Input

(required) This number represents the Internal Entry
Number for a record in the V IMMUNIZATION (#9000010.11) file.

$$LOADFLDS

Output

Returns '0' if no records were found in the V
IMMUNIZATION (#9000010.11) file for the given 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 IMMUNIZATION
(#9000010.11) file for the given record IEN such as; Patient Name,
Immunization, Comments, etc are loaded into this array variable.

$$IMMUNIZA(IEN)

This API returns field (#.01) - IMMUNIZATION, of the
V IMMUNIZATION (#9000010.11) file.  A pointer to the IMMUNIZATION
(#9999999.14) file.

VARIABLES

TYPE

VARIABLES DESCRIPTION

IEN

Input

(required) This number represents the Internal Entry
Number for a record in the V IMMUNIZATION (#9000010.11) file.

$$IMMUNIZA

Output

(required) This number represents the Internal Entry
Number for a record in the V IMMUNIZATION (#9000010.11) file.

$$PATINAME(IEN)

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

$$VISIT(IEN)

This API returns field (#.03) - VISIT, of the V
IMMUNIZATION (#9000010.11) 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 IMMUNIZATION (#9000010.11) file.

$$VISIT

Output

A pointer to the Visit (#9000010) file indicating the
date and time when the immunization was given.

$$SERIES(IEN)

This API returns field (#.04) - SERIES, of the V
IMMUNIZATION (#9000010.11) file.  This field specifies which series of
immunization types were given to the patient.

VARIABLES

TYPE

VARIABLES DESCRIPTION

IEN

Input

(required) This number represents the Internal Entry
Number for a record in the V IMMUNIZATION (#9000010.11) file.

$$SERIES

Output

P - Partially Complete, C - Complete, B - Booster, 1
- Series 1, 2 - Series 2, 3 - Series 3, 4 Series 4, 5 - Series 5, 6 - Series
6, 7 - Series 7,  8 -Series 8

$$REACTION(IEN)

This API returns field (#.06) - REACTION, of the V
IMMUNIZATION (#9000010.11) file.  This field represents the patients reaction
to the immunization.

VARIABLES

TYPE

VARIABLES DESCRIPTION

IEN

Input

(required) This number represents the Internal Entry
Number for a record in the V IMMUNIZATION (#9000010.11) file.

$$REACTION

Output

0 - NONE,1 - FEVER, 2 - IRRITABILITY, 3 - LOCAL
REACTION OR SWELLING, 4 - VOMITING, 5 - RASH OR ITCHING, 6 - LETHARGY, 7 -
CONVULSIONS, 8 - ARTHRITIS or ARTHRALGIAS, 9 - ANAPHYLAXIS or COLLAPSE, 10 -
RESPIRATORY DISTRESS, 11 - OTHER

$$CONTRAIN(IEN)

This API returns field (#.07) - CONTRAINDICATED, of
the V IMMUNIZATION (#9000010.11) file.  Indicates whether the immunization was
recorded as contraindicated.

VARIABLES

TYPE

VARIABLES DESCRIPTION

IEN

Input

(required) This number represents the Internal Entry
Number for a record in the V IMMUNIZATION (#9000010.11) file.

$$CONTRAIN

Output

Returns '0' to indicate that the immunization was not
recorded as contraindicated.  Returns '1' to indicate that the immunization
was recorded as contraindicated.

$$REMARKS(IEN)

This API returns field (#1101) - REMARKS, of the V
IMMUNIZATION (#9000010.11) file.  Additional comments or remarks related to
the immunization given to the patient.

VARIABLES	TYPE	VARIABLES DESCRIPTION
IEN	Input	(required) This number represents the Internal Entry Number for a record in the V IMMUNIZATION (#9000010.11) file.
$$REMARKS	Output	Additional comments or remarks related to the immunization given to the patient.

$$EVENTDT(IEN)

This API returns field (#1201) - EVENT DATE & TIME,
of the V IMMUNIZATION (#9000010.11) file.  The date and time the immunization
was given.

VARIABLES	TYPE	VARIABLES DESCRIPTION
IEN	Input	(required) This number represents the Internal Entry Number for a record in the V IMMUNIZATION (#9000010.11) file.
$$EVENTDT	Output	The date and time the immunization was given.

$$ORDEPROV(IEN)

This API returns field (#1202) - ORDERING PROVIDER,
of the V IMMUNIZATION (#9000010.11) file.  A pointer to the NEW PERSON (#200)
file identifying the provider who ordered this immunization.

VARIABLES

TYPE

VARIABLES DESCRIPTION

IEN

Input

(required) This number represents the Internal Entry
Number for a record in the V IMMUNIZATION (#9000010.11) file.

$$ORDEPROV

Output

A pointer to the NEW PERSON (#200) file identifying
the provider who ordered this immunization.

$$ENCOPROV(IEN)

This API returns field (#1204) - ENCOUNTER PROVIDER,
of the V IMMUNIZATION (#9000010.11) file.  A pointer to the NEW PERSON (#200)
file identifying the provider who administered the immunization.

VARIABLES

TYPE

VARIABLES DESCRIPTION

IEN

Input

(required) This number represents the Internal Entry
Number for a record in the V IMMUNIZATION (#9000010.11) file.

$$ENCOPROV

Output

A pointer to the NEW PERSON (#200) file identifying
the provider who administered the immunization.

$$EDITFLAG(IEN)

This API returns field (#80101) - EDITED FLAG, of the
V IMMUNIZATION (#9000010.11) file.  This field indicates if PCE detects that
any original immunization data is being edited.

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

$$AUDITRAI(IEN)

This API returns field (#80102) - AUDIT TRAIL, of the
V IMMUNIZATION (#9000010.11) 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 IMMUNIZATION (#9000010.11) 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
IMMUNIZATION (#9000010.11) file.  Any comments related to the procedure
performed.

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

$$VERIFIED(IEN)

This API returns field (#81201) - VERIFIED, of the V
IMMUNIZATION (#9000010.11) file.  This field indictaes 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 IMMUNIZATION (#9000010.11) file.
$$VERIFIED	Output	1 - Electronically Signed, 2 - Verified by the Package.

$$PACKAGE(IEN)

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

$$DATASRC(IEN)

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

GOOD ONLY FOR VERSION

1.0