MAG DICOM ROUTE GET PURGE (1871)    REMOTE PROCEDURE (8994)

Name Value
NAME MAG DICOM ROUTE GET PURGE
TAG PURGE
ROUTINE MAGDRPC5
RETURN VALUE TYPE ARRAY
AVAILABILITY RESTRICTED
INACTIVE ACTIVE
CLIENT MANAGER 0
WORD WRAP ON TRUE
VERSION 3.0
SUPPRESS RDV USER SETUP No
DESCRIPTION
 +---------------------------------------------------------------+
 | a medical device.  As such, it may not be changed in any way. |
 | Modifications to this software may result in an adulterated   |
 | medical device under 21CFR820, the use of which is considered |
 | to be a violation of US Federal Statutes.                     |
 +---------------------------------------------------------------+
 
 | Property of the US Government.                                |
 | No permission to copy or redistribute this software is given. |
 | Use of unreleased versions of this software requires the user |
 | to execute a written test agreement with the VistA Imaging    |
 | Development Office of the Department of Veterans Affairs,     |
 | telephone (301) 734-0100.                                     |
 |                                                               |
 | The Food and Drug Administration classifies this software as  |
INPUT PARAMETER
  • LOCATION
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   30
    REQUIRED:   YES
    SEQUENCE NUMBER:   1
    DESCRIPTION:   
    The value of this parameter is a pointer to ^DIC(4).
    This pointer identifies the location at which images were acquired.
    
  • DEST
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   30
    REQUIRED:   YES
    SEQUENCE NUMBER:   2
    DESCRIPTION:   
    The value of this parameter is a pointer to either ^MAG(2005.2)
    or ^MAGDICOM(2006.585).
    This pointer identifies the destination to which the images
    were transmitted.
    
  • MAX
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   30
    REQUIRED:   NO
    SEQUENCE NUMBER:   3
    DESCRIPTION:   
    The value of this parameter is an integer number.
    This number specifies the maximum number of names of files that
    is to be returned per call to this RPC.
    
  • DONE
    PARAMETER TYPE:   LIST
    REQUIRED:   YES
    SEQUENCE NUMBER:   4
    DESCRIPTION:   
    This parameter is an array. The values in this array (if any)
    are obtained in an earlier call to this same RPC.
    Each call to this RPC returns a list of files to be purged
    at the remote location, and each subsequent call to this RPC
    should provide (through this parameter) the list of files that
    have been successfully purged. In the VistA system, a cross-reference
    is maintained that indicates which files are to be purged when,
    and the information from this parameter array is used to clean out
    this cross-reference.
    
RETURN PARAMETER DESCRIPTION
This parameter is an array.
  d1           = secondary IEN in current FileMan table
  timestamp    = current timestamp in cross-reference being traversed
  filename     = name of file (at remote location) to be purged
The information from the first four fields is used after the
files have been purged at the remote location in a subsequent
call to this same RPC.
After the files have been purged at their remote locations,
the cross-references in the VistA system need to be cleaned up.
The values in these four fields indicate which entries
can be then be removed.
The value of OUT(1) is an integer number, describing the number
of file-names that is returned in the current call to this RPC.
The other values in the output array are strings that each
contain a number of data-fields, separated by carets ("^"):
   OUT(i) = FileManFile# ^ d0 ^ d1 ^ timestamp ^ filename
where:
  FileManFile# = either 2005 or 2005.1
  d0           = primary IEN in current FileMan table