The Master Data Model for Veteran Care

Developer Documentation » VDM » Alert_Tracking-8992_1

Alert Tracking (8992.1)

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.

Global: ^XTV(8992.1,

Domain: Non-Clinical

Properties

Label/Field Name Field # Description Datatype Attributes Range
Name
  name
.01   STRING INDEXED
REQUIRED
 
Date Created
  date_created
.02   DATE-TIME INDEXED  
Pkg Id
  pkg_id
.03   STRING INDEXED  
Patient
  patient
.04   POINTER INDEXED Patient-2
Generated By
  generated_by
.05   POINTER   New_Person-200
Generated While Queued
  generated_while_queued
.06   BOOLEAN   true: 1
Status
  status
.07   ENUMERATION   COMPLETELY READ: C
UNREAD-REMOVED BY DATE: U
PARTIALLY READ - REMOVED: P
Retention Date
  retention_date
.08 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.
DATE-TIME    
Display Text
  display_text
1.01   STRING    
Option For Processing
  option_for_processing
1.02   STRING    
Routine Tag
  routine_tag
1.03   STRING    
Routine For Processing
  routine_for_processing
1.04   STRING    
Data For Processing
  data_for_processing
2   STRING    
Guid For Gui
  guid_for_gui
3.01 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).
STRING    
Long Info Text
  long_info_text
4   STRING    
Recipient
  recipient
20   OBJECT   Recipient-8992_11

↑ Return to top

Sub-Files

Recipient (8992.11)

ID
Recipient-8992_11

Properties

Label/Field Name Field # Description Datatype Attributes Range
Recipient
  recipient
.01   POINTER INDEXED
REQUIRED
New_Person-200
Alert First Displayed
  alert_first_displayed
.02   DATE-TIME    
First Selected Alert
  first_selected_alert
.03   DATE-TIME    
Processed Alert
  processed_alert
.04   DATE-TIME    
Deleted On
  deleted_on
.05   DATE-TIME    
Auto Deleted
  auto_deleted
.06   DATE-TIME    
Forwarded By
  forwarded_by
.07   POINTER   New_Person-200
Date/time Forwarded
  date_time_forwarded
.08   DATE-TIME    
Deleted By User
  deleted_by_user
.09 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.
POINTER   New_Person-200
Recipient Type
  recipient_type
1   OBJECT   Recipient_Type-8992_111
Forwarded Date/time
  forwarded_date_time
2   OBJECT   Forwarded_Date_time-8992_112
Surrogate For
  surrogate_for
3   OBJECT   Surrogate_For-8992_113

↑ Return to top

Recipient Type (8992.111)

ID
Recipient_Type-8992_111

Properties

Label/Field Name Field # Description Datatype Attributes Range
Recipient Type
  recipient_type
.01 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).
POINTER INDEXED
REQUIRED
Alert_Recipient_Type-8992_2
Sent To Surrogate
  sent_to_surrogate
.02 This field is used to identify the surrogate to whom the alert
was sent instead of this originally specified recipient.
POINTER   New_Person-200
Acting As Surrogate
  acting_as_surrogate
.03 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.
BOOLEAN   false: N
true: Y
Alert Date/time
  alert_date_time
.04 This is the date and time the alert was sent/forwarded to the
current recipient with this recipient type
DATE-TIME    

↑ Return to top

Forwarded Date/time (8992.112)

ID
Forwarded_Date_time-8992_112

Properties

Label/Field Name Field # Description Datatype Attributes Range
Forwarded Date/time
  forwarded_date_time
.01 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.
DATE-TIME INDEXED
REQUIRED
 
Forwarding Category
  forwarding_category
.02 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).
POINTER   Alert_Recipient_Type-8992_2
Forwarded By Or For
  forwarded_by_or_for
.03 This is a record of the individual who forwarded the alert, or on whose
behalf the alert was forwarded if it was forwarded automatically.
POINTER   New_Person-200
Forwarding Comment
  forwarding_comment
1.01 This is the comment which was sent to the recipient along with the
forwarded alert.
STRING    

↑ Return to top

Surrogate For (8992.113)

ID
Surrogate_For-8992_113

Properties

Label/Field Name Field # Description Datatype Attributes Range
Surrogate For
  surrogate_for
.01 This field is used to track which user or users the current recipient is
receiving the current alert while acting as surrogate.
POINTER INDEXED
REQUIRED
New_Person-200
Date/time - Surrogate For
  date_time__surrogate_for
.02 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.
DATE-TIME    
Date-time Returned
  datetime_returned
.03 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.
DATE-TIME    

↑ Return to top


Document generated on August 31st 2017, 2:55:41 pm