MAG CFIND QUERY

TITLEVALUE
NAMEMAG CFIND QUERY
DESCRIPTION +---------------------------------------------------------------+
| Property of the US Government. |
| No permission to copy or redistribute this software is given. |
| Use of unreleased versions of this software requires the user |
| to execute a written test agreement with the VistA Imaging |
| Development Office of the Department of Veterans Affairs, |
| telephone (301) 734-0100. |
| |
| The Food and Drug Administration classifies this software as |
| a medical device. As such, it may not be changed in any way. |
| Modifications to this software may result in an adulterated |
| medical device under 21CFR820, the use of which is considered |
| to be a violation of US Federal Statutes. |
+---------------------------------------------------------------+

This RPC performs a DICOM C-FIND request.

A request is executed through a TaskMan process,
which stores the results in temporary storage (^MAGDQR(2006.5732)).

Subsequent calls to this same RPC will retrieve the
results from the result-set to the client.

A final call to this RPC will clean up the temporary storage.
TAGFIND
ROUTINEMAGDQR01
INPUT PARAMETERSSEQUENCE NUMBER1
INPUT PARAMETERTAGS
DESCRIPTIONThis parameter is an array. Each element in this array
has a value that looks like:
tag | VR | flag | value

Each 'tag' is a DICOM tag (two groups of 4 hexadecimal
digits, separated by a comma).

When the value is non-empty, it will be used as a search
criterion in the actual C-Find processing.
PARAMETER TYPELIST
REQUIREDYES
MAXIMUM DATA LENGTH32000
INPUT PARAMETERSSEQUENCE NUMBER2
INPUT PARAMETERRESULT
DESCRIPTIONThe value of this parameter is an integer number that
identifies a Result-Set.

The value of this parameter is either 0 (when a new
result-set is to be created) or equal to the internal
entry number of an existing result-set.
PARAMETER TYPELITERAL
REQUIREDYES
MAXIMUM DATA LENGTH20
INPUT PARAMETERSSEQUENCE NUMBER3
INPUT PARAMETEROFFSET
DESCRIPTIONThe value of this parameter is an integer number.
When the value of this number is equal to 0,
the RPC will either create a new result-set,
(when the value of RESULT is also equal to 0),
or else check whether TaskMan has finished building
the result-set, and if so, return the first batch of
results.

When the value of this number is greater than 0,
the RPC will return the next batch of results, starting
from the one indicated by the value of this parameter.

When the value of this number is less than 0,
the RPC will clean up the result-set.
PARAMETER TYPELITERAL
REQUIREDYES
MAXIMUM DATA LENGTH20
INPUT PARAMETERSSEQUENCE NUMBER4
INPUT PARAMETERMAX
DESCRIPTIONThe value of this parameter is an integer number.
This value indicates the number of results to be returned
in each call to this RPC.
PARAMETER TYPELITERAL
REQUIREDYES
MAXIMUM DATA LENGTH10
INPUT PARAMETERSSEQUENCE NUMBER5
INPUT PARAMETERAENAME
DESCRIPTIONThis is the name of the DICOM Application Entity performing the query. It
may be mapped to an entry on the DICOM AE SECURITY MATRIX file
(#2006.9192).
PARAMETER TYPELITERAL
REQUIREDNO
MAXIMUM DATA LENGTH127
RETURN VALUE TYPEARRAY
RETURN PARAMETER DESCRIPTIONThe return parameter of this RPC is an array.

The first element of this array indicates whether
or not the RPC completed successfully: a positive number
indicates success, a negative number indicates a failure.
A zero value indicates success, but with no further
data to be returned.

The rest of the elements in the array contain either
valid data elements (successful completion) or
error messages (failure).
AVAILABILITYRESTRICTED
INACTIVEACTIVE
CLIENT MANAGER
WORD WRAP ONFALSE
VERSION3
SUPPRESS RDV USER SETUP
APP PROXY ALLOWED