MAG4 PAT GET IMAGES (1938)    REMOTE PROCEDURE (8994)

Name Value
NAME MAG4 PAT GET IMAGES
TAG PGI
ROUTINE MAGSIXG1
RETURN VALUE TYPE ARRAY
AVAILABILITY RESTRICTED
INACTIVE ACTIVE
WORD WRAP ON FALSE
VERSION 3
DESCRIPTION
This Remote Procedure Call is used to filter out those
 
This procedure will return a list of all images for that
patient that match the specified other input parameters.
specialty for which a given image category may be relevant.
 
When images are displayed, it is desirable to limit the
list of presented images to only those that are likely
to be relevant in the current context.
 
This procedure accepts a patient-IEN (DFN) and optionally
also a category, type, event and specialty.
INPUT PARAMETER
  • DFN
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   15
    REQUIRED:   YES
    SEQUENCE NUMBER:   1
    DESCRIPTION:   
    The value of this parameter is the IEN in the Patient File (#2)
    of a patient.
    
  • FLAGS
    PARAMETER TYPE:   LITERAL
    SEQUENCE NUMBER:   11
    DESCRIPTION:   
    Flags that control the execution (can be combined):
     
      D  Include only deleted images (file #2005.1)
      E  Include only existing images (file #2005)
      O  Omit non-printable and delimiter characters from SHORT DESCRIPTION
     
    By default, the "E" value is assumed. 
    
  • PKG
    PARAMETER TYPE:   LITERAL
    SEQUENCE NUMBER:   2
    DESCRIPTION:   
    Internal or external values of the PACKAGE INDEX field (40) of the file
    #2005 separated by commas.
    
  • CATEGORY
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   50
    REQUIRED:   NO
    SEQUENCE NUMBER:   2
    DESCRIPTION:   
    The value of this parameter is either an IEN or a string that
    identifies an "image category".
    Image categories are defined in file 2005.82.
    
  • TYPE
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   50
    REQUIRED:   NO
    SEQUENCE NUMBER:   3
    DESCRIPTION:   
    The value of this parameter is either an IEN or a string that
    identifies an "image type".
    Image types are defined in file 2005.83.
    
  • EVENT
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   50
    REQUIRED:   NO
    SEQUENCE NUMBER:   4
    DESCRIPTION:   
    The value of this parameter is either an IEN or a string that
    identifies an "image event".
    Image events are defined in file 2005.85.
    
  • SPECIALTY
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   50
    REQUIRED:   NO
    SEQUENCE NUMBER:   5
    DESCRIPTION:   
    The value of this parameter is either an IEN or a string that
    identifies an "image specialty or subspecialty".
    Image specialties are defined in file 2005.84.
    
  • FROMDATE
    PARAMETER TYPE:   LITERAL
    SEQUENCE NUMBER:   7
    DESCRIPTION:   
    Beginning of the date range for image selection. Dates can be in internal
    or external FileMan format. If the parameter is not defined or empty, then
    the date range remains open on this side.
     
    The date range filter is applied to the exam/procedure dates
    (PROCEDURE/EXAM DATE/TIME field (15)).
    
  • TODATE
    PARAMETER TYPE:   LITERAL
    SEQUENCE NUMBER:   8
    DESCRIPTION:   
    End of the date range for image selection. Dates can be in internal or
    external FileMan format. If the parameter is not defined or empty, then
    the date range remains open on this side.
     
    The date range filter is applied to the exam/procedure dates
    (PROCEDURE/EXAM DATE/TIME field (15)).
    
  • ORIGIN
    PARAMETER TYPE:   LITERAL
    SEQUENCE NUMBER:   9
    DESCRIPTION:   
    Internal or external values of the ORIGIN INDEX field (45) of the file
    #2005 separated by commas.
    
  • DATA
    PARAMETER TYPE:   LITERAL
    SEQUENCE NUMBER:   10
    DESCRIPTION:   
    Reserved for future use.
    
RETURN PARAMETER DESCRIPTION
The output of this procedure is an array.
The structure of the output array is:
  OUT(0) = "0^OK" or one of the above error messages
  OUT(2) = list of headers
  OUT(i) = list of image information fields
 
The list of headers consists of the following "^" separated texts:
   1: Proc DT~S1
   2: Procedure
   3: Ct~S2
   4: Short Desc
 
   5: Category
   6: Type
   7: Event
   8: (Sub)Specialty
 
A list of image information fields consists of the following
"^" separated pieces
   1: Field 2005, 15 (Timestamp for Procedure)
   2: Field 2005,  6 (Name of Procedure)
   3: Count (number of images in group)
This procedure may report the following errors:
   4: Field 2005, 10 (Short Description)
   5: Field 2005, 41 (Category)
   6: Field 2005, 42 (Type)
   7: Field 2005, 43 (Event)
   8: Field 2005, 44 ((Sub)Specialty)
 
Following this list appears a vertical bar ("|") and
the IEN of the image in question.
  -1: Invalid Category: "[category]".
  -2: Invalid Event: "[event]".
  -3: Invalid Specialty: "[specialty]".
  -4: Invalid Type: "[type]".
  -6: No images found for "[dfn]", "[category]", "[type]", "[event]", "[specialty]".