MAG4 INDEX GET EVENT (1936)    REMOTE PROCEDURE (8994)

Name Value
NAME MAG4 INDEX GET EVENT
TAG IGE
ROUTINE MAGSIXGT
RETURN VALUE TYPE ARRAY
AVAILABILITY AGREEMENT
INACTIVE ACTIVE
WORD WRAP ON FALSE
VERSION 3
DESCRIPTION
This call will return an array of INDEX PROCEDURE/EVENT(s)
that belong to that category.
based on the input parameters CLS (Class)
and SPEC (Specialty/subspecialty)
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 an "image category" (either an IEN
or the name of a category) and returns all "image events"
INPUT PARAMETER
  • CLS
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   90
    REQUIRED:   YES
    SEQUENCE NUMBER:   1
    DESCRIPTION:   
    This parameter is a ',' (comma) delimited string of classes
    only those index types, that match a 'class' in the string
    will be returned in the array
    
  • FLGS
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   40
    REQUIRED:   NO
    SEQUENCE NUMBER:   3
    DESCRIPTION:   
    ;  FLGS : An '^' delimited string
    ;     1 IGN: Flag to IGNore the Status field
    ;     2 INCL: Include Class in the Output string
    ;     3 INST: Include Status in the Output String
    
  • SPEC
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   60
    REQUIRED:   NO
    SEQUENCE NUMBER:   2
    DESCRIPTION:   
    This is a comma delimited list of Specialty/SubSpecialties
    Only Procedure/Events that are associated with one of these will be
    returned in the list.
    If a Procedure/Event is not associated with any Specialty/Subspecialties
    it is considered valid for all, and will be returned.
    
RETURN PARAMETER DESCRIPTION
The result array includes all Procedure/Events that match the
  OUT(i) = name of event ^ ien of event ^ abbreviation for event
Class and Specialty/SubSpecialty that were passes as input parameters.
The format of the result Array: 
  
Result(0)="0^<error message>"   <- if error
Result(0)="1^OK"                <- if success
the items in the array are in the format
Result(1..n)="Procedure/Event^Abbreviation"  and Optionally
  the 3rd and 4th '^' pieces could be CLASS^STATUS