STANDARD DATA DICTIONARY #702.09 -- CP INSTRUMENT FILE 3/24/25 PAGE 1
STORED IN ^MDS(702.09, (23 ENTRIES) SITE: WWW.BMIRWIN.COM UCI: VISTA,VISTA (VERSION 1.0)
DATA NAME GLOBAL DATA
ELEMENT TITLE LOCATION TYPE
-----------------------------------------------------------------------------------------------------------------------------------
This file contains the list of instruments used by the Clinical Procedures package. This file is exported with data.
DD ACCESS: @
RD ACCESS:
WR ACCESS: #
DEL ACCESS: #
LAYGO ACCESS: #
AUDIT ACCESS: @
PRIMARY KEY: A (#83)
Uniqueness Index: PK (#905)
File, Field: 1) ID (702.09,.1)
POINTED TO BY: SUBMITTED TO INSTRUMENT field (#.11) of the CP TRANSACTION File (#702)
INSTRUMENT field (#.01) of the INSTRUMENT sub-field (#702.011) of the CP DEFINITION File (#702.01)
INSTRUMENT field (#.04) of the CP RESULT REPORT File (#703.1)
CROSS
REFERENCED BY: NAME(B), NAME(UC)
INDEXED BY: ID (PK)
LAST MODIFIED: JAN 3,2019@16:54:32
702.09,.01 NAME 0;1 FREE TEXT (Required)
Instrument Name
INPUT TRANSFORM: K:$L(X)>30!($L(X)<3)!'(X'?1P.E) X
LAST EDITED: AUG 05, 2002
HELP-PROMPT: Answer must be 3-30 characters in length.
DESCRIPTION:
Name or mnemonic of instrument - used by vendor in HL7 message header.
CROSS-REFERENCE: 702.09^B
1)= S ^MDS(702.09,"B",$E(X,1,30),DA)=""
2)= K ^MDS(702.09,"B",$E(X,1,30),DA)
Standard Fileman "B" index for the file.
CROSS-REFERENCE: 702.09^UC^MUMPS
1)= S ^MDS(702.09,"UC",$$UP^XLFSTR(X),DA)=""
2)= K ^MDS(702.09,"UC",$$UP^XLFSTR(X),DA)
Used to validate a new entry as unique without case sensitivity.
702.09,.02 NOTIFICATION MAILGROUP 0;2 POINTER TO MAIL GROUP FILE (#3.8)
Notification Mailgroup
LAST EDITED: NOV 05, 2001
DESCRIPTION: This field contains a pointer to a VA Mailman Mail Group that will receive error messages and other
notifications dealing with this device from the interface routines.
702.09,.03 DESCRIPTION 0;3 FREE TEXT
Description
INPUT TRANSFORM: K:$L(X)>50!($L(X)<1) X
LAST EDITED: JUL 02, 2002
HELP-PROMPT: Answer must be 1-50 characters in length.
DESCRIPTION:
This field contains a short informational description text for the instrument.
702.09,.05 DELETE WHEN SUBMITTED 0;5 SET
Delete when submitted
'0' FOR No;
'1' FOR Yes;
LAST EDITED: FEB 27, 2001
HELP-PROMPT: Enter Yes or No.
DESCRIPTION: Select 'Yes' if you want files created by this instrument deleted once they are successfully copied
to the VistA Imaging Server. Deletion will be performed by the VistA Imaging application.
702.09,.06 PRINTABLE NAME 0;6 FREE TEXT
Printable Name
INPUT TRANSFORM: K:$L(X)>30!($L(X)<3) X
LAST EDITED: JUL 24, 2000
HELP-PROMPT: Answer must be 3-30 characters in length.
DESCRIPTION:
Name of instrument that is printed on reports/etc.
702.09,.07 DEFAULT FILE EXT 0;7 FREE TEXT
Default Ext.
INPUT TRANSFORM: K:$L(X)>10!($L(X)<1)!'(X?1"."1.9UL) X
LAST EDITED: JUL 25, 2002
HELP-PROMPT: Enter in a file extension for data uploaded from this instrument (Default .txt)
DESCRIPTION:
Default file extension for vendor instrument reports (e.g. .doc .pdf).
702.09,.08 SERIAL NUMBER 0;8 FREE TEXT
Serial Number
INPUT TRANSFORM: K:$L(X)>50!($L(X)<1) X
LAST EDITED: JUL 24, 2000
HELP-PROMPT: Answer must be 1-50 characters in length.
DESCRIPTION:
Vendor serial number of the instrument (for reference only).
702.09,.09 ACTIVE 0;9 SET (Required)
Active
'0' FOR No;
'1' FOR Yes;
LAST EDITED: JUL 24, 2000
HELP-PROMPT: Enter Yes or No.
DESCRIPTION:
Whether or not the instrument is active on the network.
702.09,.1 ID ID;1 FREE TEXT (Required) (Key field)
INPUT TRANSFORM: K:$L(X)>38!($L(X)<38)!'(X?1"{"8UN1"-"4UN1"-"4UN1"-"4UN1"-"12UN1"}") X
LAST EDITED: MAY 27, 2009
HELP-PROMPT: Answer with the system generated GUID for this instrument.
DESCRIPTION: This is a Globally Unique IDentifier (GUID) for this instrument. This is maintained nationally so
it is the same throughout the enterprise. A sample ID could be
"{69DBD11E-9A8C-4ECE-AFA4-73947218807D}".
FIELD INDEX: PK (#905) REGULAR IR LOOKUP & SORTING
Unique for: Key A (#83), File #702.09
Short Descr: Uniqueness Index for Key 'A' of File #702.09
Description: This provides a quick reference to all unique instruments.
Set Logic: S ^MDS(702.09,"PK",$E(X,1,38),DA)=""
Kill Logic: K ^MDS(702.09,"PK",$E(X,1,38),DA)
Whole Kill: K ^MDS(702.09,"PK")
X(1): ID (702.09,.1) (Subscr 1) (Len 38)
702.09,.11 PROCESSING ROUTINE .1;1 FREE TEXT
M Routine
INPUT TRANSFORM: K:$L(X)>8!($L(X)<1) X
LAST EDITED: JUL 25, 2002
HELP-PROMPT: Answer must be 1-8 characters in length.
DESCRIPTION:
Name of the MUMPS routine used to process interface information.
702.09,.12 PROCESSING CODE .1;2 SET
Pkg Code
'M' FOR Medicine;
'C' FOR CP V1.0;
'O' FOR CliO;
LAST EDITED: MAY 27, 2009
HELP-PROMPT: Select the package to receive the data from this instrument.
DESCRIPTION: This field indicates whether data from this instrument will upload to the "M"edicine, "C"linical
Procedures, or Clinical "O"bservations package for processing.
702.09,.13 BI-DIRECTIONAL .1;3 SET
Bi-Directional Instrument
'0' FOR No;
'1' FOR Yes;
LAST EDITED: JUL 30, 2002
DESCRIPTION:
'Yes' or 'No" to indicate if this device can accept HL7 messages from VistA.
702.09,.14 IP ADDRESS .1;4 FREE TEXT
IP Address
INPUT TRANSFORM: K:'($$VALIDATE^XLFIPV(X)) X
LAST EDITED: SEP 25, 2015
HELP-PROMPT: Enter a valid IP address in the form: nn.nn.nn.nn (IPv4) or hhhh:hhhh:hhhh:hhhh:hhhh:hhhh:hhhh:hhhh
(IPv6)
DESCRIPTION:
This field contains the IP address of this instrument.
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
702.09,.15 PORT .1;5 NUMBER
Port
INPUT TRANSFORM: K:+X'=X!(X>99999)!(X<1000)!(X?.E1"."1N.N) X
LAST EDITED: DEC 20, 2002
HELP-PROMPT: Type a Number between 1000 and 99999, 0 Decimal Digits
DESCRIPTION:
This field contains the port number for this instrument.
702.09,.16 HL7 INSTRUMENT ID .1;6 FREE TEXT
HL7 Inst ID
INPUT TRANSFORM: K:$L(X)>30!($L(X)<3) X
LAST EDITED: JUL 25, 2002
HELP-PROMPT: Answer must be 3-30 characters in length.
DESCRIPTION: This is the name of the actual device where the device name can be 'SMC St. Louis'. This field is
used to ID the device.
702.09,.17 HL7 UNIVERSAL SERVICE ID .1;7 FREE TEXT
HL7 Unv Svc ID
INPUT TRANSFORM: K:$L(X)>48!($L(X)<1) X
LAST EDITED: JUL 25, 2002
HELP-PROMPT: Answer must be 1-48 characters in length.
DESCRIPTION: This field defines what type of procedure the device can perform if the device can perform more
than one procedure.
702.09,.18 HL7 LOGICAL LINK .1;8 POINTER TO HL LOGICAL LINK FILE (#870)
HL7 Link
LAST EDITED: JUL 25, 2002
DESCRIPTION: This field contains the HL7 Logical Link. There is one unique link for each instrument. Used to
determine where the bi-directional messages are sent. (Reference IA #1496)
702.09,.19 CP - DICOM INTEROPERABILITY .1;9 SET
'0' FOR No special action;
'1' FOR Use VistA Imaging accession number sss-GMR-nnnnnnnn;
'2' FOR Use VistA Imaging HL7 instead of CP's HL7;
LAST EDITED: JUN 06, 2018
HELP-PROMPT: Select special VistA Imaging processing
DESCRIPTION: This option improves interoperability between Clinical Procedures and VistA Imaging CPRS Consult
Request Tracking DICOM.
There are three capabilities:
First, the VistA Imaging consult accession number sss-GMR-nnnnnnnn can be used for the Clinical
Procedures Instrument Order Number.
Second, the timing of the DICOM Modality Worklist creation is changed from order release to
check-in, making it much more useful.
Third, the VistA Imaging HL7 message body can be used instead of the CP HL7 message body. (The
VistA Imaging HL7 has much more information than the CP HL7.)
Note: This is for bidirectional CP instruments only. Also, the CP must have an entry in the
CLINICAL SPECIALTY DICOM & HL7 file (#2006.5831) to have DICOM Modality Worklist and HL7.
702.09,.21 SERVER NAME .2;1 FREE TEXT
Server Name
INPUT TRANSFORM: K:$L(X)>30!($L(X)<1) X
LAST EDITED: JUL 24, 2000
HELP-PROMPT: Answer must be 1-30 characters in length.
DESCRIPTION:
Network name of instrument server application that generates the attachments.
702.09,.22 SERVER SHARE .2;2 FREE TEXT
Share Name
INPUT TRANSFORM: K:$L(X)>30!($L(X)<1) X
LAST EDITED: AUG 01, 2002
HELP-PROMPT: Answer must be 1-30 characters in length.
DESCRIPTION:
Share folder/drive on the instrument server where the report is stored.
702.09,.23 SERVER PATH .2;3 FREE TEXT
Path Name
INPUT TRANSFORM: K:$L(X)>150!($L(X)<1) X
LAST EDITED: AUG 01, 2002
HELP-PROMPT: Answer must be 1-150 characters in length.
DESCRIPTION:
Path on the network where the report is stored.
702.09,.24 SERVER EXECUTABLE .2;4 FREE TEXT
Executable Name
INPUT TRANSFORM: K:$L(X)>30!($L(X)<1) X
LAST EDITED: AUG 01, 2002
HELP-PROMPT: Answer must be 1-30 characters in length.
DESCRIPTION:
Name of server program that is ran to create the report for the interface.
702.09,.301 PROCESS UNC .3;1 SET
UNC
'0' FOR No;
'1' FOR Yes;
LAST EDITED: JUN 19, 2001
HELP-PROMPT: Enter Yes or No.
DESCRIPTION:
Enter 'Yes' or 'No' to indicate if this instrument produces UNC type data.
702.09,.302 PROCESS TEXT .3;2 SET
Text
'0' FOR No;
'1' FOR Yes;
LAST EDITED: JUN 19, 2001
HELP-PROMPT: Enter Yes or No.
DESCRIPTION:
Enter 'Yes' or 'No' to indicate if this instrument produces text type data.
702.09,.303 PROCESS URL .3;3 SET
URL
'0' FOR No;
'1' FOR Yes;
LAST EDITED: JUN 19, 2001
HELP-PROMPT: Enter Yes or No.
DESCRIPTION:
Enter 'Yes' or 'No' to indicate if this instrument produces URL type data.
702.09,.304 PROCESS DLL .3;4 SET
DLL
'0' FOR No;
'1' FOR Yes;
LAST EDITED: JUN 19, 2001
HELP-PROMPT: Enter Yes or No.
DESCRIPTION:
Enter 'Yes' or 'No' to indicate if this instrument produces DLL type data.
702.09,.305 PROCESS UUENCODE .3;5 SET
UUEncode
'0' FOR No;
'1' FOR Yes;
LAST EDITED: JUL 25, 2002
HELP-PROMPT: Enter Yes or No.
DESCRIPTION:
Enter 'Yes' or 'No" to indicate if this instrument produces UUENCODE type data.
702.09,.306 PROCESS XML .3;6 SET
XML
'0' FOR No;
'1' FOR Yes;
LAST EDITED: JUN 19, 2001
HELP-PROMPT: Enter Yes or No.
DESCRIPTION:
Enter 'Yes' or 'No' to indicate if this instrument produces XML type data.
702.09,.307 PROCESS XMS .3;7 SET
XMS
'0' FOR No;
'1' FOR Yes;
LAST EDITED: DEC 04, 2002
HELP-PROMPT: Enter Yes or No.
DESCRIPTION:
Enter 'Yes' or 'No' to indicate if this instrument produces XMS type data.
702.09,.401 CONSULT KEEP OPEN CS;1 SET
'0' FOR No;
'1' FOR Yes;
LAST EDITED: JUN 19, 2015
HELP-PROMPT: Enter Yes to keep consult note open or No to close consult note.
FILES POINTED TO FIELDS
HL LOGICAL LINK (#870) HL7 LOGICAL LINK (#.18)
MAIL GROUP (#3.8) NOTIFICATION MAILGROUP (#.02)
INPUT TEMPLATE(S):
PRINT TEMPLATE(S):
SORT TEMPLATE(S):
FORM(S)/BLOCK(S):