Print Page as PDF
USER ALERTS ICR (4834)

USER ALERTS    ICR (4834)

Name Value
NUMBER 4834
IA # 4834
DATE CREATED 2005/11/03
CUSTODIAL PACKAGE KERNEL
USAGE Controlled Subscription
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE XQALDATA
NAME USER ALERTS
GENERAL DESCRIPTION
This Integration Agreement is to document the calls
GETUSER1^XQALDATA and GETUSER2^XQALDATA.  The Order Entry package uses these
calls to retrieve the alerts that a user needs to see.

Amendments: 10/20/22 Component GETPAT2 was added in XU*8.0*653, as a part of
the CPRS v31b release which included an enhancement to show all the alerts
related to a patient, rather than only those alerts specific to the provider.

10/20/22 Component GETUSER2 was added in XU*8.0*662 as part of the
enhancements for the display of processed alerts in CPRS v32b.

08/18/23 Components DEFALERT and GETPAT3 were added in XU*8*653 and used by
CPRS v31b release, in addition to the GETPAT2 documented on 10/20/22.
STATUS Active
KEYWORDS
  • XQALDATA
  • GETUSER1
  • ALERTS
  • GETUSER2
  • GETPAT2
  • GETPAT3
  • DEFALERT
ID XQALDATA
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
GETUSER1
The GETUSER1 entry point retrieves unprocessed alerts
for a user.
VARIABLES TYPE VARIABLES DESCRIPTION
ROOT Output
Upon return this variable holds the global reference
of the resulting alert data. The output consists of the following:

ROOT=TOTAL COUNT

ROOT(1)=KEY  MSG TXT^ALERT ID

If Alert Forwarded:  ROOT(+1)=KEY  -----Forwarded by: PROVIDER NAME
Generated: DATE/TIME FORWARDED^ALERT ID

If Alert Forwarded contains comment text:  ROOT(+1)=KEY  -----FORWARD
COMMENT^ALERT ID

ROOT(+1)=KEY  MSG TXT^ALERT ID

ROOT(+1)...

KEY = Value is determined in order of occurance as listed below.

G = GUID FOR GUI
L = LONG INFO TEXT
I = INFORMATION ONLY
R = (Everything Else)

MESSAGE TEXT = The text of the message to be presented to the user at the time
when he cycles through the menu system the first time after the alert has been
filed for the user, and when the user selects the VIEW ALERTS option.

ALERT ID = This id may simply be a package namespace, or it may be a namespace
followed by additional data to more accurately identify the type or purpose of
the alert.

PROVIDER NAME = This is the name of the provider who forwarded the alert.

DATE/TIME FORWARDED = This is the date/time that the forward alert action
occurred.


Example Output:
---------------
ROOT=3

ROOT(1)="R  PATIENTLNAME,PATIENTFNAME (P6666): [LOCATION] Order placed:
ACETAMINOPHEN TAB  MM/YY HH:MM^ALERT ID"

ROOT(2)="R  -----Forwarded by: PROVIDERLNAME,PROVIDERFNAME   Generated:
MM/DD/YY HH:MM:SS^ALERT ID"

ROOT(3)="R  -----TESTING ALERT FORWARD ACTION^ALERT ID"
XQAUSER Input
The DUZ of the user for whom to retrieve the alerts.

FRSTDATE Input
This variable is not used.
LASTDATE Input
This variable is not used.
FLAG Input
Add FLAG to filter deferred alerts.
GETUSER2
The GETUSER2 entry point retrieves processed alerts
for a user.
VARIABLES TYPE VARIABLES DESCRIPTION
ROOT Output
Upon return this variable holds the global reference
of the resulting alert data. The output consists of the following:

ROOT=TOTAL COUNT

ROOT(1)="KEY  DISPLAY TEXT^NAME"

ROOT(1,"PROCESSED")="ALERT FIRST DISPLAYED^FIRST SELECTED ALERT^ PROCESSED
ALERT^DELETED ON^RECIPIENT TYPE^PROCESS BY^SURROGATE FOR^ FORWARDED BY OR FOR
FORWARDED DATE/TIME"

ROOT(2)=KEY  DISPLAY TEXT^NAME

ROOT(2,"PROCESSED")...

KEY = Value is determined in order of occurance as listed below.

G = GUID FOR GUI
L = LONG INFO TEXT
I = INFORMATION ONLY
R = (Everything Else)

DISPLAY TEXT = The information that will be displayed on an alert.

NAME = This id may simply be a package namespace, or it may be a namespace
followed by additional data to more accurately identify the type or purpose of
the alert.

PROVIDER NAME = This is the name of the provider who forwarded the alert.

DATE/TIME FORWARDED = This is the date/time that the forward alert action
occurred.


Example Output:
---------------
ROOT=1

ROOT(1)="R  PATIENTLNAME,PATIENTFNAME (P6666): [LOCATION] Order placed:
ACETAMINOPHEN TAB  MM/YY HH:MM^NAME (ie ALERT ID)"

ROOT(1,"PROCESSED")="YYYMMDD.HHMMSS^YYYMMDD.HHMMSS^
YYYMMDD.HHMMSS^YYYMMDD.HHMMSS^INITIAL RECIPIENT^ CPRSPROVIDER,SEVENTEEN^^"
XQAUSER Input
The DUZ of the user for whom to retrieve the
processed alerts.
FRSTDATE Input
The start date in which to begin retrieving alerts.
LASTDATE Input
The end date in which to stop retrieving alerts.
MAXRET Input
The maximum number of alerts to retrieve.
PROONLY Input
This variable is not used.
GETPAT2
The GETPAT2 component returns all the alerts for a
specific patient.
VARIABLES TYPE VARIABLES DESCRIPTION
ROOT Output
This variable contains the name of the local array
used to store the alerts returned.

Example usage: D GETPAT2("ROOT",PATIENT,PAGE,LIMIT)

Returns: ROOT=Total number of alerts in the page.  ROOT(0)=Page^Total number
of pages ROOT(1)="   CPRSPATIENT,EIGH (C0008): Lapsed Unsigned
Order(s)^OR,100022,78;10000000200; 3221009.105002^14534305" ROOT(2)="
CPRSPATIENT,EIGH (C0008): Order requires electronic signature.^OR,100022,12;
10000000200;3221008.052"
PATIENT Input
DFN of the patient for which to retrieve alerts.
PAGE Input
The 'page' of the alerts to retrieve, assuming there
is more than one page available. For example, if the limit is to retrieve 25
alerts at one time, and the patient has 75 alerts, there would be three pages.

LIMIT Input
The limit of the number of alerts to retrieve per
page.
DEFALERT
The DEFALERT component adds the date and time to an
alert.
VARIABLES TYPE VARIABLES DESCRIPTION
ROOT Output
This variable contains an error message if the
attempt to defer the alert fails.
XQAUSER1 Input
The user responsible for the alert.
DEFDATE Input
The date/time the alert is deferred til...user
responsible sets the date...maximum of 14 days from the date/time deferred.
ALERTID Input
The IEN of the alert in file 8992 2nd piece of the
alert date/time multiple. DG,IEN of file;original recipient;date/time of
alert.
GETPAT3
Returns the list of unprocessed alerts by patient.
VARIABLES TYPE VARIABLES DESCRIPTION
ROOT Output
ROOT(0)=The count of entries following in the ROOT
array.  ROOT(#)=Alert details.
PATIENT Input
DFN of the patient for which to retrieve alerts.
XFROM Input
From Date.
XTO Input
To Date.
SUBSCRIBING PACKAGE
SUBSCRIBING PACKAGE SUBSCRIBING DETAILS
ORDER ENTRY/RESULTS REPORTING
Revised 8/22/23: DEFALERT and GETPAT3 were historically
used since the release of CPRS v31b without ICR compliance. Effective with
patch OR*3.0*603 the usage meets the SAC standards.
HEALTH DATA REPOSITORY
Added 4/17/23, effective with informational patch
HDS*1*66.  Vets-Home software needs to display VistA Alerts across all VistA
systems for the remote veterans they are caring for. HDR will provide a
service to pull Alerts as shown in CPRS for a given provider/caregiver. This
service will ensure the integrity of care as it will provide Alert across all
VistA systems.  Patch information: HDR does not deploy software via VistA
patches. HDR services use IRIS SQL objects that live in its own Cache/IRIS
database on the VistA system (HDRDAT database). Even though HDRDAT resides on
the VistA system is has its separate configuration from VistA. Therefore, HDR
does not deploy updates via FORUM, rather, it deploys using HIDU (HDR Inplace
Database Update) process to install objects directly to the HDRDAT.
DATE ACTIVATED 2023/08/22