MAG4 IMAGE LIST

TITLEVALUE
NAMEMAG4 IMAGE LIST
DESCRIPTIONThis remote procedure returns information about images that conform to
the provided criteria.
TAGGETIMGS
ROUTINEMAGSIXG1
INPUT PARAMETERSSEQUENCE NUMBER1
INPUT PARAMETERFLAGS
DESCRIPTIONFlags that control the execution (can be combined):

C Capture date range. If this flag is provided, then the
remote procedure uses values of the FROMDATE and TODATE
parameters to select images that were captured in this
date range (see the DATE/TIME IMAGE SAVED field (7) and
the "AD" cross-reference).

Otherwise, values of those parameters are treated as
the date range when procedures were performed (see the
PROCEDURE/EXAM DATE/TIME field (15) and cross-references
"APDTPX" and "APDT").

D Include only deleted images (file #2005.1)
E Include only existing images (file #2005)

S Return the sparse subset of images captured by the user
defined by the miscellaneous "SAVEDBY" filter parameter
(see the MISCPRMS parameter). The "SAVEDBY" becomes a
required parameter in this case.

Firstly, images are preselected according to the date
range and other criteria. Those of them that were captured
immediately before and after patient changes are stored to
the "priority" temporary buffer. The others are stored to
the regular temporary buffer.

Then, the requested maximum number of images is calculated
according to the total number of preselected entries and
the percentage value defined by the MAXNUM parameter.

If the number of entries in the "priority" buffer less
than the maximum number of images and the regular buffer
is not empty, then missing quantity of preselected images
is merged to the "priority" buffer from the regular one.

Finally, no more than maximum number of entries is copied
from the "priority" buffer to the remote procedure's
result array.

G Include Group Images in the list of images returned.
If any image in a group has an image that matches the
status provided in the search criteria then
the group will be returned.

If the G flag is not set then only the status of the
Group entry will be checked and the group will be
returned if it passes.

If neither 'E' nor 'D' flag is provided, then an error code (-6) is
returned.
PARAMETER TYPELITERAL
REQUIREDYES
MAXIMUM DATA LENGTH
INPUT PARAMETERSSEQUENCE NUMBER2
INPUT PARAMETERFROMDATE
DESCRIPTIONBeginning of the date range for image selection. Date 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.

Depending on the value of the FLAGS parameter, the date range filter is
applied either to the exam/procedure dates (PROCEDURE/EXAM DATE/TIME field
(15)) or image capture dates (DATE/TIME IMAGE SAVED field (7)).

Time parts of date range parameters are ignored and both ends of the date
range are included in the search. For example, in order to search images
for May 21, 2008, the internal value of both parameters should be 3080521.
PARAMETER TYPELITERAL
REQUIRED
MAXIMUM DATA LENGTH
INPUT PARAMETERSSEQUENCE NUMBER3
INPUT PARAMETERTODATE
DESCRIPTIONEnd 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.

Depending on the value of the FLAGS parameter, the date range filter is
applied either to the exam/procedure dates (PROCEDURE/EXAM DATE/TIME field
(15)) or image capture dates (DATE/TIME IMAGE SAVED field (7)).

Time parts of date range parameters are ignored and both ends of the date
range are included in the search. For example, in order to search images
for May 21, 2008, the internal value of both parameters should be 3080521.
PARAMETER TYPELITERAL
REQUIRED
MAXIMUM DATA LENGTH
INPUT PARAMETERSSEQUENCE NUMBER4
INPUT PARAMETERMAXNUM
DESCRIPTIONIf this parameter is defined and greater than 0, then it determines the
maximum number of images returned by the call.

If the S flag is included in the value of the FLAGS parameter, then the
MAXNUM parameter must be defined and greater than 0. Its value determines
the percentage of preselected images to be returned in the result array.
For example, if the value of this parameter is 35 and 230 images are
preselected (according to the user, date range, and other selection
criteria), then 81 images will be returned.
PARAMETER TYPELITERAL
REQUIRED
MAXIMUM DATA LENGTH
INPUT PARAMETERSSEQUENCE NUMBER5
INPUT PARAMETERMISCPRMS
DESCRIPTIONItems of this list define various filter parameters. Each item has 3 or
more pieces separated by '^':

^01: Parameter name
^02: Index (for multiples and word-processing values)
^03: Value1
^04: Value2
...

The following filter parameters are supported by this remote procedure:

CAPTAPP^^{Name or Code}^{Name or Code}^...
Internal or external values of the CAPTURE APPLICATION
field (8.1) of the file #2005.

GDESC^^{Text}
Text that should be present in the SHORT DESCRIPTION
field (10) of the IMAGE file (#2005). The comparison
is case-insensitive.

IDFN^^{DFN}
Patient IEN (DFN). If this parameter is not defined, all
patients' images are considered.

ISTAT^^{Name or Code}^{Name or Code}^...
Internal or external values of the STATUS field (113)
of the file #2005. 0 (zero) code selects image records
with empty STATUS field.

IXCLASS^^{Name or IEN}^{Name or IEN}^...
Image class names or IENs (see the CLASS INDEX field (41)
of the file #2005 for details).

IXORIGIN^^{Name or Code}^{Name or Code}^...
Internal or external values of the ORIGIN INDEX field (45)
of the file #2005.

IXPKG^^{Name or Code}^{Name or Code}^...
Internal or external values of the PACKAGE INDEX field (40)
of the file #2005.

IXPROC^^{Name or IEN}^{Name or IEN}^...
Procedure/Event names or IENs (see the PROC/EVENT INDEX
field (43) of the file #2005 for details).

IXSPEC^^{Name or IEN}^{Name or IEN}^...
Specialty/SubSpecialty names or IENs (see the SPEC/SUBSPEC
INDEX field (44) of the file #2005 for details).

IXTYPE^^{Name or IEN}^{Name or IEN}^...
Image type names or IENs (see the TYPE INDEX field (42) of
the file #2005 for details).

SAVEDBY^^{DUZ}
If this parameter is defined, then only those images that were
captured by this user (see the IMAGE SAVE BY field (8) of the
file #2005 for details) are considered.

SENSIMG^^{Name or Code}^{Name or Code}^...
Internal or external values of the CONTROLLED IMAGE field (112)
of the file #2005.

For pointer type parameters, pure numeric values are always treated as
internal entry numbers (IEN).

Parameters can be added to the list in any order. See comments preceding
the GETIMGS^MAGSIXG1 for more details.

Example:

with RPCBroker.Param[4] do
begin
PType := list;
Mult[1] := 'IXPKG^^RAD^LAB';
Mult[2] := 'IXCLASS^^1^ADMIN';
Mult[3] := 'IXORIGIN^^NON-VA^F';
Mult[4] := 'IDFN^^2341';
end;
PARAMETER TYPELIST
REQUIRED
MAXIMUM DATA LENGTH
RETURN VALUE TYPEARRAY
RETURN PARAMETER DESCRIPTIONZero value of the first '^'-piece of the Results[0] indicates that an
error occurred during the execution of the procedure. In this case, the
errors are returned in the Results array as shown below:

Results[0] Result descriptor
^01: 0
^02: Message

Results[i] Error descriptor
^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:

Results[0] Result descriptor
^01: 1
^02: Description of the image selection
criteria (filter).
^03: Non-zero if there are more records
available. This piece is populated
only if the MAXNUM parameter is
defined and greater than 0.

If the S flag is included in the
value of the FLAGS parameter, then
a non-zero value of this piece
indicates that not all "priority"
entries are returned. See the
description of the FLAGS parameter
for more details.

Results[1] '^'-delimited list of column headers used
in the cMagListView (see the BLDHDR1^MAGSIXG2
for details).

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).
AVAILABILITYRESTRICTED
INACTIVE
CLIENT MANAGER
WORD WRAP ONTRUE
VERSION
SUPPRESS RDV USER SETUP
APP PROXY ALLOWED