Print Page as PDF
DBIA3035-H ICR (3048)

DBIA3035-H    ICR (3048)

Name Value
NUMBER 3048
IA # 3048
DATE CREATED 2000/02/22
CUSTODIAL PACKAGE PCE PATIENT CARE ENCOUNTER
CUSTODIAL ISC Albany
USAGE Controlled Subscription
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE PXAAVSIT
NAME DBIA3035-H
ORIGINAL NUMBER 3035
GENERAL DESCRIPTION
The following is a description of the available APIs
for the VISIT (#9000010) file.  The VISIT (#9000010) file contains a record of
all patient visits at health care facilities or by health care providers,
including direct outpatient and clinic visits, as well as inpatient encounters
with providers of care.
STATUS Active
KEYWORDS PXAA
DURATION Till Otherwise Agreed
ID PXAAVSIT
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$GETFIELD(IEN,FIELD,EXTERNAL)
Returns the value of one field in the VISIT
(#9000010) file.
VARIABLES TYPE VARIABLES DESCRIPTION
IEN Input
The IEN of the VISIT (#9000010) file.
FIELD Input
This is the field number or name to be returned.
EXTERNAL Input
Should the value be returned in external format?
(1/0; Optional; Defaults to 0).
$$GETFIELDS(ARRAY,IEN,FIELDS,EXTERNAL)
Retrieves one or more field values from a VISIT
(#9000010) record and places the values in an array.

Will return: 1  - If was able to successfully retrieve the data.  0  - If
record did not exist.  -1 - If invalid field list passed in.
VARIABLES TYPE VARIABLES DESCRIPTION
ARRAY Output
Should be passed by reference. If the API was able to
retrieve the data, ARRAY will be returned in the following format:
ARRAY(field_number)=value

If the API returned -1, ARRAY will be returned as follows: ARRAY(1)="Invalid
field list."
IEN Input
The IEN of the VISIT (#9000010) file.
FIELDS Input
The fields to retrieve. Can be one of the following:

- A single field number.

- A list of field numbers, separated by semicolons.

- A range of field numbers, in the form M:N; where M and N are the end points
of the inclusive range. All field numbers within this range are retrieved.

- Asterisk (*) for all fields.
EXTERNAL Input
Should the values be returned in external format?
(1/0; Optional; Defaults to 0).
SUBSCRIBING PACKAGE ORDER ENTRY/RESULTS REPORTING
DATE ACTIVATED 2023/08/30
GOOD ONLY FOR VERSION 1.0