DBIA1889-B    ICR (1890)

$$DELVFILE^PXAPI(WHICH,VISIT,PKG,SOURCE,ASK,ECHO,USER)

This function may be used to delete data from the Visit file (9000010) and V
files, including V CPT (9000010.18), V EXAM (9000010.13), V HEALTH FACTORS
(9000010.11), V PATIENT ED (9000010.16), V POV (9000010.07), V PROVIDER
(9000010.06), V SKIN TEST (9000010.12) and V TREATMENT (9000010.15).

Parameter Description:

1. WHICH:  (required)  An ^ delimited string where two or three
characters separated by an ^ designate the V file from
which data should be deleted, e.g., "PRV^POV^CPT^HF".
"ALL" may be used to delete data from all V files.  VISIT
is the string which will delete the administrative data
and STOP is the string which will delete the additional
stop codes.  An example of a function call which will
delete data typically deleted through Delete Check Out is:
$$DELVFILE^PXAPI("ALL",VISIT,,,1,1)

Possible individual strings which may be included in WHICH
include:

ALL     To delete all items
CPT     To delete procedures
HF      To delete health factors
IMM     To delete immunizations
PEP     To delete patient education
POV     To delete problem of visit (diagnoses)
PRV     To delete provider
SK      To delete skin tests
STOP    To delete additional stop codes.  The primary
clinic stop will not be deleted.
TRT     To delete treatments
VISIT   To delete Service Connected, Classification
question data, check out date.
XAM To delete examinations

2. VISIT:  (required)  A number which is a pointer to the VISIT file
(9000010).  This is the visit for which related data will
be deleted.

3. PKG:    (optional)  The internal entry number of the package in the
Package file (9.4) or the namespace for the package.  If
passed, only items created by this package will be
deleted.

4. SOURCE: (optional)  A string denoting the source of the data.  This
is an entry in the Data Source file (839.7).  If  passed,
only items created by this source will be deleted.

5. ASK:    (optional)  If ASK is passed and it does not equal 0 or
"", then PCE will prompt the user to verify that they
want to delete the data before proceeding with the
deletions.  PCE recommends setting ASK to 1 to indicate
that the user should be asked to confirm that the data
should be deleted.

6. ECHO:   (optional)  If ECHO is passed and it does not equal 0 or
"", then PCE will display to the user what is being
deleted.  PCE recommends setting ECHO to 1 to indicate
that the data deletions should be displayed to the user,
e.g.    Deleting Procedures....
Deleting Providers....
Deleting Diagnoses....
The message will be displayed only if data has been
deleted.

7. USER:   (optional)  Set USER to the user's DUZ to restrict deletion
of data to those entries created by the user.  If USER is
not passed, is equal to 0 or "", PCE will not apply
deletion restriction based on the user.

Returned Value:
1   If no errors occurred and deletion processed completely.
0   If errors occurred but deletion processed completely as
possible.
-1   User indicated that the data should not be deleted, or User
up-arrowed out, or errors occurred.  In any case, nothing
was deleted.
-2   If unable to identify a valid VISIT.
-3   If API was called incorrectly.
-4   If dependent entry count is still greater than zero.