The status of the call will be returned in an array.
Two examples are given below.
Example 1: Successful Queue MAGRY(0)="111^Data has been Queued."
A Background Processor Import Queue Number '^' message is returned in the (0)
node. No other nodes are defined.
Example 2: unsuccessful Queue
MAGRY (0)="0^Required parameter is null"
MAGRY (1)="Tracking ID is Required. !"
MAGRY (2)="Status Handler is Required. !"
MAGRY (3)="Acquisition Site is Required. !"
node (0) = 0 '^' Error message
node(1..n)= all error messages incurred during validation.
An array of fully qualified file names. Each entry is
the full path of the Image using UNC notation, and optionally a short
description of the Image as the second '^' piece. If the array entry doesn't
contain a short description as the 2nd '^' piece, the API will generate a
default image short description from the procedure and procedure date. All
images in the array will be saved as a group of images. If the array only
contains 1 image, it will be saved as a single image.
The following is an example of an input array:
IMAGES(1)="\\image server\image share\filename.ext^image description"
IMAGES(2)="\\image server\image share\filename2.ext"
IMAGES(3)="\\image server\image share\filename3.ext^image description"
IMAGES(4)="\\image server\image share\filename4.ext"
An array of predefined 'nodes' and data.
MAGIX("ACQD")="COMPUTER AT EDS"
The following are possible predefine nodes that can be passed; please note
that the items with an asterick (*) are required information.
ACQD* - Acquisition Device: 'Computer Name' of Device (Domain Name for
ACQL - Hospital Location: Pointer to VistA Hospital Location File.
ACQS* - Acquisition Site: Pointer to VistA Institution File.
ACQN* - Acquisition Site Station Number : This is the Value of field #99 in
the Institution File (#4). (Note: Either ACQN or ACQS is required, An error
will be returned if the calling Application sends values for both)
CDUZ - DUZ of person capturing the image.
CMTH - Call Method: A Method to call that will generate the image(s) (Note:
Either an 'Image Array' or a 'Call Method' is required).
DFLG - Delete Flag: '1' if images should be deleted after successful
processing (The default is '0', No Deletion).
DOCCTG - Document Category: Pointer to VistA MAG DESCRPTIVE CATEGORIES file.
(Note: VistA Imaging is discontinuing the use of this Field. In a future
version of the Import API, the MAG DESCRIPTIVE CATEGORIES (#2005.81) file will
no longer be used as a description of the Image and will not be accepted as a
value in the Input Array. The new index fields: IXTYPE, IXSPEC, IXPROC,
IXORIGIN will be used for describing an Image.)
DOCDT - Document Date: (FileMan External or Internal Date)
IXTYPE* - Type Index: Internal or external entry in the IMAGE INDEX FOR TYPES
(#2005.83) file. (Note: IXTYPE and DOCCTG cannot both be included in the input
IXSPEC - Specialty/SubSpecialty Index: Internal or external entry in the IMAGE
INDEX FOR SPECIALTY/SUBSPECIALTY (#2005.84) file.
IXPROC - Procedure/Event Index: Internal or external entry in the IMAGE INDEX
FOR PROCEDURE/EVENT (#2005.85) file.
IXORIGIN - Origin Index: Set of codes that describe where the image was
produced. Possible values are VA, NON-VA, FEE and DOD. (Not required. It will
default to VA).
GDESC - Short Description for the Image or Image Group (60 chars)
IDFN* - VistA Patient DFN
IMAGE - Full path of image in UNC notation ^ Optional Image Description
ITYPE - Image Type: The type of image (file extension); please consult
Imaging for the different file types currently supported.
PASSWORD - Encrypted Password for the network\machine where the import image
PXDT - Procedure Date/Time (FileMan External or Internal Date Time)
PXIEN - Procedure IEN
PXPKG - Procedure Package
STSCB* - Status Handler: "Tag^Routine" of initiating package. Imaging will
call this to return the resulting status of the Import process.
TRKID* - Tracking ID = PackageID_;_unique identifier Example: "DOC;453"
TRTYPE - Transaction Type: 'NEW' or 'MOD' or 'DEL' (TRYTPE is for Future
use. Any value is ignored, it defaults to 'NEW'.)
USERNAME - Username for the network or machine where the import image resides.