DBIA1889-E    ICR (1893)

$$VISITLST^PXAPI(DFN,BEGINDT,ENDDT,HLOC,SCREEN,APPT,PRMPT)

Use this API to display a list of encounters.  This is an interactive API that
allows the user to enter "A" to ADD a new encounter or to select an encounter
to edit or delete.  If no date range is passed, all entries in the Visit file
(9000010 ) for the identified patient will be included in the list.  If the
HLOC is not passed, all entries in the Visit file (9000010) for the identified
patient will be included in the list.  If  SCREEN is not passed, all
encounters, except those that represent historical encounters, will be
included in the list.  If APPT is not passed, no appointment/encounter
relationship will be assessed.  If PRMPT is not passed or is null, only
selection of an item from the list will be enabled.

Parameter Description:

1. DFN:     (required)  This number represents the patient and is
the internal entry number of the Patient's entry in the
Patient/IHS file (9000001) which is dinumed to the
Patient file (2).

2. BEGINDT: (optional)  This is the beginning date, in an INTERNAL
FORMAT, of the date range. If no date range is passed,
all entries in the Visit file (9000010 ) for the
identified patient will be included in the list.

3. ENDDT:   (optional)  This is the ending date, in an INTERNAL
FORMAT, of the date range.  If no date range is passed,
all entries in the Visit file (9000010 ) for the
identified patient will be included in the list.

4. HLOC:    (optional)  This is the Hospital Location.  It is a
pointer to the Hospital Location file (44).  This
restricts display of encounters to those associated
with this hospital location. If the HLOC is not passed,
all entries in the Visit file (9000010) for the
identified patient will be included in the list.

5. SCREEN:  (optional)  This is a screen based on the Primary field
(15003) and Service Category field (.07) of the Visit
file (9000010).  It is a set of codes that represents
an encounter type, e.g., primary, occasion of service,
stop code.  More than one code may be used, e.g., PO.
If  SCREEN is not passed, all encounters, except those
that represent historical encounters, will be included
in the list.  If  the screen includes E, only historical
encounters will be displayed.  If the screen does not
include E, only non-historical encounters will be
displayed.

A    Occasions of service that are passed to PCE by ancillary
packages using DATA2PCE^PXAPI.
P    Primary visits are encounters created for appointments and
standalone's either through manual data entry or via
DATA2PCE^PXAPI.
O    Occasions of Service are encounters that are created when
data for an ancillary package such as Radiology or
Laboratory is manually entered through Scheduling or PCE.
Assignment of this code is determined based on a managed set
of stop codes provided by ancillary packages.
S    Stop Codes are child encounters that are created to store
additional stop codes for a parent encounter.  This will be
discontinued after 10/1/96.
E    Historical Encounters are encounters that document clinical
activities.  They are not associated with an appointment and
are not used for billing or workload purposes.  Use "XE"
to display all historical encounters.  This screen must be
used in combination with one of the other codes.
X    All encounters, excluding historical encounters.  "X" is
the default when no SCREEN is defined.

6. APPT:    (optional)  This determines the contents of the
encounter list--whether the encounters include
appointments and standalones, just appointments or just
standalones.  If APPT is not passed, no
appointment/encounter relationship will be assessed.

1    Display only encounters related to an appointment.
0    Don't screen on encounter/appointment relationship.
-1    Display only encounters not related to an appointment
(standalones).

7. PRMPT:   (optional)  This determines the prompt used by the API.
If PRMPT is not passed or null, only selection of an
item from the list will be enabled.

A    Includes ADD in the prompt.
D    Includes DELETE in the prompt.

Returned Value:

>0        Internal entry number of the selected encounter, IEN in
the Visit file (9000010)
A        User indicated to ADD an encounter.
D^IEN    User selected an encounter to DELETE.
-1        No visit selected
-2^Text   Error encountered.  Text documents error.