Kernel 8.0 APIs Banner [skip navigation]
Office of Information & Technology (OIT) Banner

PATIENT^XQALERT(): Get Alerts for a Patient

Reference Type: Supported, Category: Alerts, Integration Agreement: 10081


This API allows you to return an array of all alerts for a particular patient that are either:

  1. Open

  2. Within a given time range (both open and closed)

The association of an alert with a patient is based on the conventions used by the CPRS software application for the Package Identifier (original value of XQAID input variable when creating the alert), where the second comma-piece is a pointer to the PATIENT file (#2).

NOTE: For information on CPRS conventions for the format of the Package Identifier, please refer to the "Package Identifier versus Alert Identifier" topic in the Kernel Programmer Manual.



Input Parameters


(required) Fully resolved global or local reference in which to return a list of matching alerts.


(required) Internal entry number (DFN in the PATIENT file [#2]) of the patient for whom alerts are returned.


(optional) Starting date to check for alerts. If you pass this parameter, all alerts are returned, open or closed, from the startdate until the enddate (if no enddate is specified, all alerts beyond the startdate are returned). If you omit this parameter (and enddate), only currently open alerts are returned.


(optional) Ending date to check for alerts. If you omit this parameter, but pass a startdate, all alerts are returned beyond the startdate.

Output Parameters


All alerts matching the request are returned in the input parameter you specified in root, in the following format:

  root=number of matching alerts 

  root(1)= "I   "_messagetext_"^"_alertid


where the first three characters are either:

"I ": if the alert is informational

" ": if the alert runs a routine

and where alertid (Alert Identifier) contains three semicolon-delimited pieces:

  1. The original software application identifier (value of XQAID).

  2. The DUZ of the alert creator.

  3. The VA FileMan date and time the alert was created.


VA (Internet) / VA(Intranet) / OI / PD / Site Map / Terms of Use / VA Privacy Policy / Accessibility

Reviewed/Updated: August 26, 2011

If you have questions, need more information, or are having accessibility problems with this website, please contact us by E-Mail: Webmasters, Phone: 510-768-6800, or FAX: 510-768-6850.