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 TRUE
VERSION 3
DESCRIPTION
This Remote Procedure Call is used to filter out those specialty for which
 
This procedure will return a list of all images for that patient that
match the specified other input parameters.
 
NOTE: This remote procedure is kept for backward compatibility only. 
      Please use the MAG4 IMAGE LIST remote procedure for any new
      development.
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)
     
    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.
    
  • CLASS
    PARAMETER TYPE:   LITERAL
    SEQUENCE NUMBER:   3
    DESCRIPTION:   
    Image class names or IENs (see the CLASS INDEX field (41) of the IMAGE
    file (#2005) for details) separated by commas.
    Image categories are defined in file 2005.82.
    
  • TYPE
    PARAMETER TYPE:   LITERAL
    SEQUENCE NUMBER:   4
    DESCRIPTION:   
    Image type names or IENs (see the TYPE INDEX field (42) of the file #2005
    for details) separated by commas.
    Image types are defined in file 2005.83.
    
  • EVENT
    PARAMETER TYPE:   LITERAL
    SEQUENCE NUMBER:   5
    DESCRIPTION:   
    Procedure/Event names or IENs (see the PROC/EVENT INDEX field (43) of the
    file #2005 for details) separated by commas.
    Image events are defined in file 2005.85.
    
  • SPEC
    PARAMETER TYPE:   LITERAL
    SEQUENCE NUMBER:   6
    DESCRIPTION:   
    Speciality/SubSpecialty names or IENs (see the SPEC/SUBSPEC INDEX field
    (44) of the file #2005 for details) separated by commas.
    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
Zero value of the first '^'-piece of the Results[0] indicates that an
                          ^01: Error code
                          ^02: Message
                          ^03: Error location
                          ^04: Message type
 
  Results[j]            Line of the additional info (optional)
                          ^01: ""
                          ^02: Text
  
Otherwise, the Results array is formatted as follows:
error occurred during the execution of the procedure. In this case, the
 
  Results[0]            Result descriptor
                          ^01: 1
                          ^02: Description of the image selection
                               criteria (filter).
   
  Results[1]            '^'-delimited list of column headers used
                        in the cMagListView (see the HEADER^MAGSIX1
                        for details).
  
errors are returned in the Results array as shown below:
  Results[i]            Image descriptor
                          |01: Values to be displayed in the columns 
                               separated by '^'. (see the
                               BLDHDR1^MAGSIXG2 for details).
                         
                          |02: Data that is used internally by the
                               application (see the $$INFO^MAGGAII
                               for details).
  
  Results[0]            Result descriptor
                          ^01: 0
                          ^02: Message
  
  Results[i]            Error descriptor