STANDARD DATA DICTIONARY #8992.1 -- ALERT TRACKING FILE 3/24/25 PAGE 1
STORED IN ^XTV(8992.1, (871 ENTRIES) SITE: WWW.BMIRWIN.COM UCI: VISTA,VISTA (VERSION 8.0)
DATA NAME GLOBAL DATA
ELEMENT TITLE LOCATION TYPE
-----------------------------------------------------------------------------------------------------------------------------------
This file is used to track the content and interactions with an alert. Every alert which is generated is initially filed within
this file. Each entry has the date and time the alert was generated, which user generated the alert, whether the alert was
generated in a background task, what action was to be taken if any (the entry point or option name to be used) and the data string,
if any, for use with the alert. There is a multiple field which also identifies each user that the alert was sent to, and when the
user initially saw the displayed text, when the alert was selected for processing, when the processing was completed, and when the
alert was deleted after processing or associated with another user's processing, or when the alert was deleted by a clean-up
operation.
Unless a longer lifetime is specified for the specific alert, it will be deleted from the file after 30 days. If a longer lifetime
is specified, it will not be deleted until after that period passes.
DD ACCESS: @
RD ACCESS: @
WR ACCESS: @
DEL ACCESS: @
LAYGO ACCESS: @
AUDIT ACCESS: @
CROSS
REFERENCED BY: ALERT DATE/TIME(AUD), NAME(B), PATIENT(C), DATE CREATED(D), PKG ID(PKGID), RECIPIENT(R)
INDEXED BY: PROCESSED ALERT & RECIPIENT (PAR)
LAST MODIFIED: OCT 5,2022@14:51:37
8992.1,.01 NAME 0;1 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>50!($L(X)<3)!'(X'?1P.E) X
LAST EDITED: DEC 15, 1994
HELP-PROMPT: Answer must be 3-50 characters in length.
UNEDITABLE
CROSS-REFERENCE: 8992.1^B
1)= S ^XTV(8992.1,"B",$E(X,1,50),DA)=""
2)= K ^XTV(8992.1,"B",$E(X,1,50),DA)
8992.1,.02 DATE CREATED 0;2 DATE
INPUT TRANSFORM: S %DT="ESTXR" D ^%DT S X=Y K:Y<1 X
LAST EDITED: DEC 15, 1994
HELP-PROMPT: This is the date and time that the alert was created.
UNEDITABLE
CROSS-REFERENCE: 8992.1^D
1)= S ^XTV(8992.1,"D",$E(X,1,30),DA)=""
2)= K ^XTV(8992.1,"D",$E(X,1,30),DA)
8992.1,.03 PKG ID 0;3 FREE TEXT
INPUT TRANSFORM: K:$L(X)>30!($L(X)<1) X
LAST EDITED: NOV 10, 1999
HELP-PROMPT: Answer must be 1-30 characters in length
UNEDITABLE
CROSS-REFERENCE: 8992.1^PKGID
1)= S ^XTV(8992.1,"PKGID",$E(X,1,30),DA)=""
2)= K ^XTV(8992.1,"PKGID",$E(X,1,30),DA)
8992.1,.04 PATIENT 0;4 POINTER TO PATIENT FILE (#2)
LAST EDITED: DEC 15, 1994
HELP-PROMPT: This is the patient which is indicated by the alert.
UNEDITABLE
CROSS-REFERENCE: 8992.1^C
1)= S ^XTV(8992.1,"C",$E(X,1,30),DA)=""
2)= K ^XTV(8992.1,"C",$E(X,1,30),DA)
8992.1,.05 GENERATED BY 0;5 POINTER TO NEW PERSON FILE (#200)
LAST EDITED: DEC 15, 1994
HELP-PROMPT: This is the individual who generated the alert
UNEDITABLE
8992.1,.06 GENERATED WHILE QUEUED 0;6 SET
'1' FOR YES;
LAST EDITED: DEC 15, 1994
HELP-PROMPT: This field is used to indicate alerts which were generated by queued jobs.
UNEDITABLE
8992.1,.07 STATUS 0;7 SET
'U' FOR UNREAD-REMOVED BY DATE;
'C' FOR COMPLETELY READ;
'P' FOR PARTIALLY READ - REMOVED;
LAST EDITED: DEC 15, 1994
HELP-PROMPT: This field is used to indicate the status of the alert
UNEDITABLE
8992.1,.08 RETENTION DATE 0;8 DATE
INPUT TRANSFORM: S %DT="EX" D ^%DT S X=Y K:Y<1 X
LAST EDITED: FEB 09, 1998
DESCRIPTION: This field is used to set a retention date that will prevent the deletion of the alert by the
"Delete old (>14 day) Alerts" option until this date.
8992.1,1.01 DISPLAY TEXT 1;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>95!($L(X)<2) X
MAXIMUM LENGTH: 95
LAST EDITED: OCT 09, 2018
HELP-PROMPT: Answer must be 2-95 characters in length.
DESCRIPTION:
This field stores the information that will be displayed on the alert.
UNEDITABLE
8992.1,1.02 OPTION FOR PROCESSING 1;2 FREE TEXT
INPUT TRANSFORM: K:$L(X)>60!($L(X)<1) X
LAST EDITED: DEC 15, 1994
HELP-PROMPT: This is the option which the alert jumps to when the alert is selected for processing
UNEDITABLE
8992.1,1.03 ROUTINE TAG 1;3 FREE TEXT
INPUT TRANSFORM: K:$L(X)>16!($L(X)<1) X
LAST EDITED: DEC 14, 2015
HELP-PROMPT: Enter the tag for the Routine, 1 to 16 characters.
DESCRIPTION:
This is the tag indicated for the routine specified for use when the alert is selected.
UNEDITABLE
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
8992.1,1.04 ROUTINE FOR PROCESSING 1;4 FREE TEXT
INPUT TRANSFORM: K:$L(X)>30!($L(X)<2) X
LAST EDITED: DEC 15, 1994
HELP-PROMPT: This is the routine to be invoked when the alert is selected (if a value exists for TAG, then entry
will be at the indicated TAG within the routine).
UNEDITABLE
8992.1,2 DATA FOR PROCESSING 2;E1,245 FREE TEXT
INPUT TRANSFORM: K:$L(X)>245!($L(X)<1) X
LAST EDITED: DEC 15, 1994
HELP-PROMPT: This is a string of data elements, which may be separated by any desired character, which will be
returned to the application when the alert is selected for processing.
UNEDITABLE
8992.1,3.01 GUID FOR GUI 3;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>38!($L(X)<38) X
LAST EDITED: JUL 03, 2001
HELP-PROMPT: Answer must be a 38 character GUID {.......}
DESCRIPTION: This field contains a Globally Unique IDentifier (GUID) which is used to identify the application
which should be used in a graphical user interface environment (windows) to process the alert.
This application must implement the IVAlert interface. The GUID should be of the form
{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}
where each x is a hexadecimal digit (0 through 9 or A through F).
8992.1,4 LONG INFO TEXT 4;0 WORD-PROCESSING #8992.14
LAST EDITED: MAR 29, 2000
HELP-PROMPT: Enter text for an information only alert that should be displayed as word-processing text instead
of a single line.
DESCRIPTION: This field is used to present a long information only alert. It can be any length since it is
stored as word processing text. It is to be displayed in a screen-man window on dumb terminals
and in a memo box on windowed systems.
8992.1,20 RECIPIENT 20;0 POINTER Multiple #8992.11 (Add New Entry without Asking)
LAST EDITED: MAY 26, 1998
8992.11,.01 RECIPIENT 0;1 POINTER TO NEW PERSON FILE (#200) (Multiply asked)
LAST EDITED: FEB 24, 2022
HELP-PROMPT: The entry was specified as a recipient of the alert.
UNEDITABLE
CROSS-REFERENCE: 8992.11^B
1)= S ^XTV(8992.1,DA(1),20,"B",$E(X,1,30),DA)=""
2)= K ^XTV(8992.1,DA(1),20,"B",$E(X,1,30),DA)
CROSS-REFERENCE: 8992.1^R
1)= S ^XTV(8992.1,"R",$E(X,1,30),DA(1),DA)=""
2)= K ^XTV(8992.1,"R",$E(X,1,30),DA(1),DA)
RECORD INDEXES: PAR (#829) (WHOLE FILE #8992.1)
8992.11,.02 ALERT FIRST DISPLAYED 0;2 DATE
INPUT TRANSFORM: S %DT="ESTXR" D ^%DT S X=Y K:Y<1 X
LAST EDITED: DEC 15, 1994
HELP-PROMPT: This is the date and time that the alert was first displayed to the user (during a menu cycle).
UNEDITABLE
8992.11,.03 FIRST SELECTED ALERT 0;3 DATE
INPUT TRANSFORM: S %DT="ESTXR" D ^%DT S X=Y K:Y<1 X
LAST EDITED: JUL 07, 1994
HELP-PROMPT: This field indicates when the alert was first selected for processing within the VIEW ALERTS
option.
8992.11,.04 PROCESSED ALERT 0;4 DATE
INPUT TRANSFORM: S %DT="ESTXR" D ^%DT S X=Y K:Y<1 X
LAST EDITED: FEB 24, 2022
HELP-PROMPT: This indicates when the processing of the alert was completed, as indicated by the kill flag not
being cleared on return.
UNEDITABLE
RECORD INDEXES: PAR (#829) (WHOLE FILE #8992.1)
8992.11,.05 DELETED ON 0;5 DATE
INPUT TRANSFORM: S %DT="ESTXR" D ^%DT S X=Y K:Y<1 X
LAST EDITED: DEC 15, 1994
HELP-PROMPT: This is the date and time that the alert was deleted for this user.
UNEDITABLE
8992.11,.06 AUTO DELETED 0;6 DATE
INPUT TRANSFORM: S %DT="ESTXR" D ^%DT S X=Y K:Y<1 X
LAST EDITED: DEC 15, 1994
HELP-PROMPT: This is the date and time that the alert was deleted automatically due to the age of the alert.
UNEDITABLE
8992.11,.07 FORWARDED BY 0;7 POINTER TO NEW PERSON FILE (#200)
LAST EDITED: DEC 15, 1994
HELP-PROMPT: This is the user who forwarded the alert to the recipient
UNEDITABLE
8992.11,.08 DATE/TIME FORWARDED 0;8 DATE
INPUT TRANSFORM: S %DT="ESTXR" D ^%DT S X=Y K:Y<1 X
LAST EDITED: DEC 15, 1994
HELP-PROMPT: This is the date and time that the alert was forwarded to the recipient.
UNEDITABLE
8992.11,.09 DELETED BY USER 0;9 POINTER TO NEW PERSON FILE (#200)
LAST EDITED: FEB 19, 1999
HELP-PROMPT: This field is filled in automatically when an alert is deleted for the user, if it was deleted by
a user as opposed to deleted during processing.
DESCRIPTION: The 'USER DELETED BY' field is poplulated if the alert is deleted for the current user by someone
(either the user or another person from IRM or an ADPAC, etc.) with a delete option as opposed to
deletion as a part of the processing of the alert. The field points to the user who selected the
delete option resulting in deletion of the alert prior to its processing.
8992.11,1 RECIPIENT TYPE 1;0 POINTER Multiple #8992.111 (Add New Entry without Asking)
8992.111,.01 RECIPIENT TYPE 0;1 POINTER TO ALERT RECIPIENT TYPE FILE (#8992.2) (Required)
LAST EDITED: OCT 20, 2003
HELP-PROMPT: This is a pointer to a file of different recipient types (i.e., the reason someone was sent the
alert)
DESCRIPTION: This field is used to track how a specific recipient was selected for receiving the alert. The
initial recipients are those to whom the alert was initially directed (INITIAL RECIPIENT).
Other recipients may be the result of forwarding. Recipients of the alert from forwarding are
noted by the type of forwarding involved (FWD BY USER, EMAIL SURROGATE, CHIEF/SUPERVISOR,
BACKUP REVIEWER, or LAST HOPE).
Marked as a specific category are those to whom the alert was directed, but who were not
available to receive an alert due to lack of access (marked with the suffix "-UNDELIVERABLE"
added to the basis for the alert being sent to the user).
Those who have alerts forwarded to their surrogate or receive the alert while acting as a
surrogate for another user are indicated by entries in fields #.02 (SENT TO SURROGATE) and #.03
(ACTING AS SURROGATE), respectively. In addition, those who are acting as surrogates are
identified in the current field by the suffix "-SURROGATE" added to the basis for the alert
being received. Since the recipient may be acting as surrogate for more than one user, the
actual users for which the message was sent on a surrogate basis are indicated in the SURROGATE
FOR sub-file (#8992.113) under the RECIPIENT sub-file.
The values stored for this field are pointers to entries in the ALERT RECIPIENT TYPE file
(#8992.2).
CROSS-REFERENCE: 8992.111^B
1)= S ^XTV(8992.1,DA(2),20,DA(1),1,"B",$E(X,1,30),DA)=""
2)= K ^XTV(8992.1,DA(2),20,DA(1),1,"B",$E(X,1,30),DA)
8992.111,.02 SENT TO SURROGATE 0;2 POINTER TO NEW PERSON FILE (#200)
LAST EDITED: FEB 21, 2003
HELP-PROMPT: This is the individual that was sent the alert in a surrogate capacity instead of the
originally specified recipient.
DESCRIPTION: This field is used to identify the surrogate to whom the alert was sent instead of this
originally specified recipient.
8992.111,.03 ACTING AS SURROGATE 0;3 SET
'Y' FOR YES;
'N' FOR NO;
LAST EDITED: FEB 20, 2003
HELP-PROMPT: Enter Y (YES) if this recipient received the alert acting as surrogate for another user.
DESCRIPTION: This field is used to identify those recipients who were sent the alert because they were
selected as an active surrogate for the originally intended user. In most cases only the Y
(YES) entries will be entered.
8992.111,.04 ALERT DATE/TIME 0;4 DATE
INPUT TRANSFORM: S %DT="ESTXR" D ^%DT S X=Y K:Y<1 X
LAST EDITED: OCT 28, 2004
HELP-PROMPT: This is the date and time the alert was sent/forwarded to the current recipient with this
recipient type
DESCRIPTION: This is the date and time the alert was sent/forwarded to the current recipient with this
recipient type
CROSS-REFERENCE: 8992.1^AUD^MUMPS
1)= N XQALDA1 S XQALDA1=+^XTV(8992.1,DA(2),20,DA(1),0),^XTV(8992.1,"AUD",XQALDA1,X,DA(2))=""
2)= N XQALDA1 S XQALDA1=+^XTV(8992.1,DA(2),20,DA(1),0) K ^XTV(8992.1,"AUD",XQALDA1,X,DA(2))
8992.11,2 FORWARDED DATE/TIME 2;0 DATE Multiple #8992.112
LAST EDITED: FEB 21, 2003
8992.112,.01 FORWARDED DATE/TIME 0;1 DATE (Multiply asked)
INPUT TRANSFORM: S %DT="ESTXR" D ^%DT S X=Y K:Y<1 X
LAST EDITED: FEB 21, 2003
HELP-PROMPT: This is the date/time that the alert was forwarded to the current recipient
DESCRIPTION: This field is used to track the date/time of forwarding of the alert to this recipient. This
is a multiple field to track instances in which multiple copies of the alert may be forwarded
to a single recipient for various reasons. This multiple field will indicate when it was
forwarded and the basis for forwarding of the alert.
CROSS-REFERENCE: 8992.112^B
1)= S ^XTV(8992.1,DA(2),20,DA(1),2,"B",$E(X,1,30),DA)=""
2)= K ^XTV(8992.1,DA(2),20,DA(1),2,"B",$E(X,1,30),DA)
8992.112,.02 FORWARDING CATEGORY 0;2 POINTER TO ALERT RECIPIENT TYPE FILE (#8992.2)
LAST EDITED: OCT 20, 2003
HELP-PROMPT: This field points to a file containing the different reasons for forwarding.
DESCRIPTION: This field is used to track the basis on which the alert is forwarded to the current
recipient. The alert might be forwarded to the recipient by a user directly, or by
programmed forwarding related to alerts not being processed within a specified time to EMAIL
SURROGATE, CHIEF/SUPERVISOR; BACKUP REVIEWER, or LAST RESORT.
Entries for this field are pointers to the values in the ALERT RECIPIENT TYPE file (#8992.2).
8992.112,.03 FORWARDED BY OR FOR 0;3 POINTER TO NEW PERSON FILE (#200)
LAST EDITED: APR 04, 2003
HELP-PROMPT: This is the individual that forwarded the alert, or the alert was forwarded for.
DESCRIPTION: This is a record of the individual who forwarded the alert, or on whose behalf the alert was
forwarded if it was forwarded automatically.
8992.112,1.01 FORWARDING COMMENT 1;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>240!($L(X)<1) X
LAST EDITED: FEB 20, 2003
HELP-PROMPT: Answer must be 1-240 characters in length.
DESCRIPTION:
This is the comment which was sent to the recipient along with the forwarded alert.
8992.11,3 SURROGATE FOR 3;0 POINTER Multiple #8992.113
8992.113,.01 SURROGATE FOR 0;1 POINTER TO NEW PERSON FILE (#200) (Multiply asked)
LAST EDITED: FEB 20, 2003
HELP-PROMPT: Enter the NEW PERSON entry for which the current recipient is acting as surrogate on this
alert.
DESCRIPTION: This field is used to track which user or users the current recipient is receiving the
current alert while acting as surrogate.
CROSS-REFERENCE: 8992.113^B
1)= S ^XTV(8992.1,DA(2),20,DA(1),3,"B",$E(X,1,30),DA)=""
2)= K ^XTV(8992.1,DA(2),20,DA(1),3,"B",$E(X,1,30),DA)
8992.113,.02 DATE/TIME - SURROGATE FOR 0;2 DATE
INPUT TRANSFORM: S %DT="ESTXR" D ^%DT S X=Y K:Y<1 X
LAST EDITED: FEB 20, 2003
HELP-PROMPT: Enter the date/time that this alert was received while acting as a surrogate for the
intended recipient.
DESCRIPTION: This field has the date/time when the alert was sent to the current recipient while acting
as a surrogate for the originally intended recipient.
8992.113,.03 DATE-TIME RETURNED 0;3 DATE
INPUT TRANSFORM: S %DT="ESTXR" D ^%DT S X=Y K:Y<1 X
LAST EDITED: MAR 16, 2005
HELP-PROMPT: This is the date-time that the alert was returned to the originally intended recipient
DESCRIPTION: This field is a record for the date-time that an alert for which this recipient was acting
as a surrogate was returned to the originally intended recipient of the alert.
FILES POINTED TO FIELDS
ALERT RECIPIENT TYPE (#8992.2) RECIPIENT TYPE:RECIPIENT TYPE (#.01)
FORWARDED DATE/TIME:FORWARDING CATEGORY (#.02)
NEW PERSON (#200) GENERATED BY (#.05)
RECIPIENT:RECIPIENT (#.01)
FORWARDED BY (#.07)
DELETED BY USER (#.09)
RECIPIENT TYPE:SENT TO SURROGATE (#.02)
FORWARDED DATE/TIME:FORWARDED BY OR FOR (#.03)
SURROGATE FOR:SURROGATE FOR (#.01)
PATIENT (#2) PATIENT (#.04)
Subfile #8992.11
Record Indexes:
PAR (#829) RECORD REGULAR IR LOOKUP & SORTING WHOLE FILE (#8992.1)
Short Descr: Indexed by Recipient & Processed Alert
Description: Cross-reference on entire file that first sorts on Recipient (pointer to New Person file) and then on Processed
Alert (date field)
Set Logic: S ^XTV(8992.1,"PAR",X(1),X(2),DA(1),DA)=""
Kill Logic: K ^XTV(8992.1,"PAR",X(1),X(2),DA(1),DA)
Whole Kill: K ^XTV(8992.1,"PAR")
X(1): RECIPIENT (8992.11,.01) (Subscr 1) (forwards)
X(2): PROCESSED ALERT (8992.11,.04) (Subscr 2) (forwards)
INPUT TEMPLATE(S):
PRINT TEMPLATE(S):
SORT TEMPLATE(S):
FORM(S)/BLOCK(S):