DBIA3035-G ICR (3047)

Name

Value

NUMBER

3047

IA #

3047

DATE CREATED

2000/02/22

CUSTODIAL PACKAGE

PCE PATIENT CARE ENCOUNTER

CUSTODIAL ISC

Albany

USAGE

Supported

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

PXAAVPRV

NAME

DBIA3035-G

ORIGINAL NUMBER

3035

GENERAL DESCRIPTION

The following is a description of the available APIs
for the V PROVIDER (#9000010.06) file.  This file, along with a Purpose of
Visit (POV), is required for each patient encounter at a facility.

STATUS

Active

KEYWORDS

PXAA

DURATION

Next Version

PXAAVPRV

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

$$GETIENS(VSITIEN,ARRAY)

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

$$GETIENS

Output

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

$$LOADFLDS(IEN,ARRAY)

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

VARIABLES

TYPE

VARIABLES DESCRIPTION

IEN

Input

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

ARRAY

Input

(required) All the field values of the V PROVIDER
(#9000010.06) file for the given record IEN such as; Patient Name, Provider
Narrative, Modifier, etc

$$LOADFLDS

Output

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

$$PROVIDER(IEN)

This API returns field (#.01) - PROVIDER, of the V
PROVIDER (#9000010.06) file.  A pointer to the NEW PERSON (#200) file.

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

$$PATINAME(IEN)

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

$$VISIT(IEN)

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

$$VISIT

Output

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

$$PRIMSECO(IEN)

This API returns field (#.04) - PRIMARY/SECONDARY, of
the V PROVIDER (#9000010.06) file.  This field indicates that the provider was
the primary or secondary care giver for the encounter.

VARIABLES	TYPE	VARIABLES DESCRIPTION
IEN	Input	(required) This number represents the Internal Entry Number for a record in the V PROVIDER (#9000010.06) file.
$$PRIMSECO	Output	Returns 'P' - PRIMARY or 'S' - SECONDARY

$$OPERATTE(IEN)

This API returns field (#.05) - OPERATING/ATTENDING,
of the V PROVIDER (#9000010.06) file.  This field indicates whether the
provider was Operating or Attending.

VARIABLES	TYPE	VARIABLES DESCRIPTION
IEN	Input	(required) This number represents the Internal Entry Number for a record in the V PROVIDER (#9000010.06) file.
$$OPERATTE	Output	Returns 'A' - ATTENDING or 'O' - OPERATING.

$$PERSCLAS(IEN)

This API returns field (#.06) - PERSON CLASS, of the
V PROVIDER (#9000010.06) file.  This field indicates class of the provider at
the time of the encounter and is a pointer to the PERSON CLASS (#8932.1) file.

VARIABLES	TYPE	VARIABLES DESCRIPTION
IEN	Input	(required) This number represents the Internal Entry Number for a record in the V PROVIDER (#9000010.06) file.
$$PERSCLAS	Output	A pointer to the PERSON CLASS (#8932.1) file.

$$EVENTDT(IEN)

This API returns field (#1201) - EVENT DATE AND TIME,
of the V PROVIDER (#9000010.06) file.  The date and time the provider had the
encounter with the patient.

VARIABLES	TYPE	VARIABLES DESCRIPTION
IEN	Input	(required) This number represents the Internal Entry Number for a record in the V PROVIDER (#9000010.06) file.
$$EVENTDT	Output	The date and time the provider had the encounter with the patient.

$$EDITFLAG(IEN)

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

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

$$AUDITRAI(IEN)

This API returns field (#80102) - AUDIT TRAIL, of the
V PROVIDER (#9000010.06) 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 PROVIDER (#9000010.06) 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
PROVIDER (#9000010.06) file.  Any comments related to the patient's provider.

VARIABLES	TYPE	VARIABLES DESCRIPTION
IEN	Input	(required) This number represents the Internal Entry Number for a record in the V PROVIDER (#9000010.06) file.
$$COMMENTS	Output	A Free Text value indicating any comments related to the patient's provider.

$$VERIFIED(IEN)

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

$$PACKAGE(IEN)

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

$$DATASRC(IEN)

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

GOOD ONLY FOR VERSION

1.0