Imaging - MAGGSIUI ICR (3567)

Name

Value

NUMBER

3567

IA #

3567

DATE CREATED

2002/04/26

CUSTODIAL PACKAGE

IMAGING

CUSTODIAL ISC

Washington

USAGE

Controlled Subscription

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

MAGGSIUI

NAME

Imaging - MAGGSIUI

GENERAL DESCRIPTION

Imaging v3.0 patch MAG*3.0*7 introduces an Image Import
API that can be used to automatically import image files into VistA Imaging.
The image files can be from a medical device (instrument) or a network or
local drive.  Once image files are imported, they are available for display
from the VistA Imaging Clinical Display application.

Importing image/report files is a two step process:

Step 1:  The calling program initiates the import proces by sending an input
array to the Import API.  The import API uses the input array to create an
entry in the Import Queue file and returns a status array to the calling
program.

Step 2:  After the entries in the Import Queue file are processed (by the
Background Processor residing on the network), the Import API reports back to
the calling program in a result array.

Note:  The Import API, as part of the VistA Imaging software, is regulated as
a medical device.  The Import API cannot be used without a written agreement
between the VistA Imaging SD&D group and the party wishing to use the Import
API.


To secure an agreement for the use of the Import API, the following criteria
must be met:


1)      Any products built or interfaced using the VistA Imaging Import API
must be tested with VistA Imaging.  Testing will be performed by the VistA
Imaging team with assistance from field sites and the calling package.  This
testing must demonstrate that there are no adverse interactions affecting the
safety, efficacy or performance of the VistA Imaging software or the devices
interfaced to VistA Imaging.

2)      Any changes to packages/product(s) using the VistA Imaging Import API
must be reported to the VistA Imaging Project Office for review and testing
before release.  Retesting of VistA Imaging with the product(s) is required
with any change.

3)      Documentation that imported reports/objects meet VHA, regulatory, and
quality requirements must be on file with the Vista Imaging Project Office
prior to any clinical use.  Sample imported reports/objects shall be provided
initially to the VistA Imaging Project Office by the package using the API.
Sites installing the VistA Imaging API must comply with all VistA Imaging
requirements and are responsible for filing all required documentation with
the VistA Imaging Project Office, including image quality and data forms and
sample reports/objects from any interfaced device.

4)      Additional requirements may apply to non-VA software using the Import
API.

STATUS

Active

KEYWORDS

IMPORT API

DURATION

Till Otherwise Agreed

MAGGSIUI

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

IMPORT

This API receives imported images from an
application. The API will return an array indicating whether the transaction
was successful or unsuccessful.

VARIABLES

TYPE

VARIABLES DESCRIPTION

MAGRY

Output

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.

IMAGES

Input

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"

MAGIX

Input

An array of predefined 'nodes' and data.

Example:

MAGIX("ACQD")="COMPUTER AT EDS"
MAGIX("ACQL")=99
MAGIX("ACQS")=688
MAGIX("DOCCTG")=19
MAGIX("DOCDT")="05/05/1999"
MAGIX("IDFN")=1033
MAGIX("STSCB")="TESTCB^MAGGSIUI"
MAGIX("TRKID")="GK;101"

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
non-NT).

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
array.)

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
is located.

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.

SUBSCRIBING PACKAGE

SUBSCRIBING PACKAGE	ISC	SUBSCRIBING DETAILS
CLINICAL PROCEDURES	Hines	Clinical Procedures is using the Imaging Import Component to import images from a Medical device into the VistA database.