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

PATIENT^XQALERT(): Get Alerts for a Patient

Reference Type: Supported, Category: Alerts, ICR#: 10081

Description

The PATIENT^XQALERT API allows you to return an array of all alerts for a particular patient that are either:

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 (#2) file.

NOTE: For information on CPRS conventions for the format of the Package Identifier, see the "Package Identifier versus Alert Identifier" section in the Kernel 8.0 and Kernel Toolkit 7.3 Developer's Guide.

Format

  PATIENT^XQALERT(root,dfn[,startdate][,enddate])

Input Parameters

root:

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

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

(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.
enddate:

(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

root:

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
  root(2)=...

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.