STANDARD DATA DICTIONARY #601.95 -- MH INSTRUMENT EXCHANGE FILE 6/27/25 PAGE 1
STORED IN ^YTT(601.95, (110 ENTRIES) SITE: WWW.BMIRWIN.COM UCI: VISTA,VISTA (VERSION 5.01)
DATA NAME GLOBAL DATA
ELEMENT TITLE LOCATION TYPE
-----------------------------------------------------------------------------------------------------------------------------------
An Instrument Exchange entry contains the specification for one or more Mental Health instruments, formatted as JSON. An entry can
be created in a source account, then transmitted to destination accounts. In the destination account, the JSON data may be used to
update Mental Health instrument files. This allows the specification for Mental Health instruments to be transmitted via a KIDS
build or a host file. It also allows instrument specifications to be backed up.
DD ACCESS: @
RD ACCESS: @
WR ACCESS: @
DEL ACCESS: @
LAYGO ACCESS: @
AUDIT ACCESS: @
PRIMARY KEY: A (#45)
Uniqueness Index: C (#1511)
File, Field: 1) NAME (601.95,.01) 2) DATE CREATED (601.95,.02)
CROSS
REFERENCED BY: NAME(B)
INDEXED BY: NAME & DATE CREATED (C)
LAST MODIFIED: JUN 1,2018@13:47:07
601.95,.01 NAME 0;1 FREE TEXT (Required) (Key field)
INPUT TRANSFORM: K:$L(X)>30!(X?.N)!($L(X)<3)!'(X'?1P.E) X
LAST EDITED: JAN 24, 2017
HELP-PROMPT: Name must be 3-30 characters, not numeric or starting with punctuation
DESCRIPTION:
This is a name for an exchange entry. It is combined with the creation date to form a unique key.
CROSS-REFERENCE: 601.95^B
1)= S ^YTT(601.95,"B",$E(X,1,30),DA)=""
2)= K ^YTT(601.95,"B",$E(X,1,30),DA)
RECORD INDEXES: C (#1511)
601.95,.02 DATE CREATED 0;2 DATE (Required) (Key field)
INPUT TRANSFORM: S %DT="ESTXR" D ^%DT S X=Y K:Y<1 X
LAST EDITED: JAN 23, 2017
HELP-PROMPT: Enter the date/time this entry was created.
DESCRIPTION: This is the creation date/time. A unique key is formed by combining the creation date with the
name.
RECORD INDEXES: C (#1511)
601.95,.03 SOURCE 0;3 FREE TEXT
INPUT TRANSFORM: K:$L(X)>50!($L(X)<3) X
LAST EDITED: JAN 24, 2017
HELP-PROMPT: Enter the source information (site, author) for this entry, 3 to 50 characters.
DESCRIPTION: This contains descriptive information about the source of the entry. By default, the account name
is used.
601.95,1 SPECIFICATION 1;0 WORD-PROCESSING #601.951 (NOWRAP) (IGNORE "|")
LAST EDITED: AUG 03, 2016
DESCRIPTION:
This is the JSON description of the instrument.
LAST EDITED: JAN 24, 2017
HELP-PROMPT: Packed JSON -- do not edit directly.
DESCRIPTION:
The contains packed JSON for an instrument definition.
601.95,2 DESCRIPTION 2;0 WORD-PROCESSING #601.952 (IGNORE "|")
DESCRIPTION:
Optional descriptive text for this exchange entry may be placed here.
LAST EDITED: JAN 23, 2017
HELP-PROMPT: Enter a description for this instrument exchange entry.
DESCRIPTION:
This contains descriptive text of the instrument exchange entry.
601.95,3 INSTALL HISTORY 3;0 DATE Multiple #601.953
DESCRIPTION:
This lists the dates when the exchange entry was installed into the local account.
601.953,.01 INSTALL DATE 0;1 DATE
INPUT TRANSFORM: S %DT="ESTXR" D ^%DT S X=Y K:X<1 X
LAST EDITED: JAN 23, 2017
HELP-PROMPT: Enter the date that this exchange entry was installed locally.
DESCRIPTION: This multiple contains an entry for each time this instrument exchange entry was installed in the
local account.
CROSS-REFERENCE: 601.953^B
1)= S ^YTT(601.95,DA(1),3,"B",$E(X,1,30),DA)=""
2)= K ^YTT(601.95,DA(1),3,"B",$E(X,1,30),DA)
601.953,.02 INSTALLED BY 0;2 POINTER TO NEW PERSON FILE (#200)
LAST EDITED: JAN 23, 2017
HELP-PROMPT: Select the user that performed the install.
DESCRIPTION:
This references the user that performed the install on the date for this entry.
601.95,4 ADDENDUM 4;0 WORD-PROCESSING #601.954 (NOWRAP) (IGNORE "|")
DESCRIPTION: This contains JSON that is to be included with the exchange entry. It allows special handling
information to be added to the exchange entry after it is built.
LAST EDITED: JAN 23, 2017
HELP-PROMPT: Enter JSON that should be appended to each instrument.
DESCRIPTION: This contains JSON formatted data that handles special cases. As each instrument is installed,
this JSON is added to the specification for that instrument.
TECHNICAL DESCR: The exchange tool currently supports the following addendum JSON nodes:
ignoreConflicts: array of file:ien that should allow overwrite even
for different instrument. Example:
{"ignoreConflicts":["601.72:6488","601.72:6491","601.72:6734"]}
FILES POINTED TO FIELDS
NEW PERSON (#200) INSTALL HISTORY:INSTALLED BY (#.02)
File #601.95
Record Indexes:
C (#1511) RECORD REGULAR IR LOOKUP & SORTING
Unique for: Key A (#45), File #601.95
Short Descr: Uniqueness Index for Key 'A' of File #601.95
Description: This index uses NAME and DATE CREATED to provide a unique key for instrument exchange entries. The combination
is used to provide a level of certainty that the correct entry is being distributed.
Set Logic: S ^YTT(601.95,"C",X(1),X(2),DA)=""
Kill Logic: K ^YTT(601.95,"C",X(1),X(2),DA)
Whole Kill: K ^YTT(601.95,"C")
X(1): NAME (601.95,.01) (Subscr 1)
X(2): DATE CREATED (601.95,.02) (Subscr 2)
INPUT TEMPLATE(S):
PRINT TEMPLATE(S):
SORT TEMPLATE(S):
FORM(S)/BLOCK(S):