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:
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.
(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.
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
and where alertid (Alert Identifier) contains three semicolon-delimited pieces:
August 26, 2011