MAG FIND IMAGE TEXT FILE (2853)    REMOTE PROCEDURE (8994)

Name Value
NAME MAG FIND IMAGE TEXT FILE
TAG FINDFIL
ROUTINE MAGDOD01
RETURN VALUE TYPE SINGLE VALUE
AVAILABILITY RESTRICTED
INACTIVE ACTIVE
WORD WRAP ON FALSE
VERSION .1
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.                     |
  +---------------------------------------------------------------+
 
This Remote Procedure allows the invoking client to use a filename 
(without extension) to find the path and nearest location of an image 
file.
  | 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
  • FILENAME
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   199
    REQUIRED:   YES
    SEQUENCE NUMBER:   1
    DESCRIPTION:   
    The value of this parameter is the name of an image file, without path or 
    extension.
    
RETURN PARAMETER DESCRIPTION
The return value of this remote procedure is a string.
   -21,Image file name must be specified
   -22,Invalid filename format (no control characters allowed)
   -23,Image filename not found on VistA
 
Otherwise, the first pipe-separated piece of the return value will be the
internal entry number of the image found.
The second pipe-separated piece will either be the name of the text file
for that image, including full path specification, or a negative number.
The third pipe-separated piece will be one of the following values,
indicating the proximity of the nearest version of the file:
 
   M:  magnetic
   W:  WORM (jukebox)
   A:  archive
   O:  offline
   I:  invalid/undeterminable
The fourth pipe-separated piece will contain the value D if and only if 
there is a possible duplicate file with the same name.
The fifth pipe-separated piece will contain the value IQ if and only if 
there is a possible integrity problem with the file.
The sixth pipe-separated piece will contain 1 if there are any updatable 
If the client is not authorized to call this remote procedure,
fields on this image record, 0 otherwise.  Updatable fields include 
Series Instance UID, Image Instance UID, Document Date, DICOM Series, 
DICOM image number.
input parameter value is not valid, or the image file is not found,
the appropriate string will be returned from the following list in the 
second pipe-separated piece of the return value.
 
   -12,No permission to call this Remote Procedure
   -13,Image has been deleted