MAG4 INDEX GET SPECIALTY (1937)    REMOTE PROCEDURE (8994)

Name Value
NAME MAG4 INDEX GET SPECIALTY
TAG IGS
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 SPECIALTY/SUBSPECIALTIES
that generate images in that category.
based on the input parameters CLS (Class)
and EVENT (Procedure/Event)
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 "(sub)specialties"
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 specialties that match a 'class' in the string
    will be listed in the result array.
    
  • EVENT
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   50
    REQUIRED:   NO
    SEQUENCE NUMBER:   2
    DESCRIPTION:   
    This is a ','(comma) delimited string of Procedure/Events
    only those Specialties associated with one of these Proc/Events 
    will be listed in the output.
    
  • 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
    ;     4 INSP: Include Specialty in the OutPut String
    
RETURN PARAMETER DESCRIPTION
The result array includes all Specialty/SubSpecialties that match the
The structure of the output array is:
  OUT(0) = "0^OK" or one of the above error messages
  OUT(i) = name of specialty ^ ien of specialty
Class and Procedure/Event that were passed as input parameters.
The format of the result array is : 
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)="Specialty/SubSpecialty^Abbreviation" 
  and optionally the 3rd,4th and 5th pieces could be
  CLASS^STATUS^SPECIALTY