Kernel APIs: AHISTORY^XQALBUTL

AHISTORY^XQALBUTL(): Get Alert Tracking File Information

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

Description

The AHISTORY^XQALBUTL API returns information from the ALERT TRACKING (#8992.1) file for alert with the xqaid input parameter as its alert ID. The data is returned descendent from the closed root passed in the root input parameter. Usually, xqaid is known based on alert processing.

Format

  AHISTORY^XQALBUTL(xqaid,root)

Input Parameters

xqaid:

(required) This is the value of the alert identifier. It is passed to the routine or option that is run when the alert is selected. It can also be obtained from a listing of all of the xqaid values for a specified user and/or patient.

root:

(required) This parameter is a closed reference to a local or global root. The information associated with the desired entry in the ALERT TRACKING (#8992.1) file is returned descendent from the specified root.

NOTE: A more user (developer) friendly call would be the ALERTDAT^XQALBUTL API, which returns the data in an array with the field numbers and names as the subscripts and the internal and external (if different) values as the value.

Output

returns:

The data returned reflects the global structure of the ALERT TRACKING (#8992.1) file.

Example

The following example illustrates the use of this API and the format of the data returned.

>S XQAID="NO-ID;20;2990212.11294719"

>D AHISTORY^XQALBUTL(XQAID,"XXXROOT")

>ZW XXXROOT

XXXROOT(0)=NO-ID;20;2990212.11294719^2990212.112947^NO-ID^^20
XXXROOT(1)=TEST MESSAGE (ROUTINE) 20^^^XM
XXXROOT(20,0)=^8992.11^20^1
XXXROOT(20,1,0)=20^2990212.112954^2990212.145609^2990212.145621^2990212.145621
XXXROOT(20,"B",20,1)=

This is in the basic structure of the nodes taken from the global for this entry, which can be seen from a global map view of the ALERT TRACKING (#8992.1) file:

^XTV(8992.1,D0,0)= (#.01) NAME [1F] ^ (#.02) DATE CREATED [2D]^ (#.03) PKG
     ==>ID [3F] ^ (#.04) PATIENT [4P] ^ (#.05)
GENERATED BY [5P] ^ 
     ==>(#.06) GENERATED WHILE QUEUED [6S] ^ (#.07)
STATUS [7S] ^ 
     ==>(#.08) RETENTION DATE [8D] ^ 

^XTV(8992.1,D0,1)= (#1.01) DISPLAY TEXT [1F] ^ (#1.02) OPTION FOR PROCESSING
     ==>[2F] ^ (#1.03) ROUTINE TAG [3F] ^ (#1.04)
ROUTINE FOR
     ==>PROCESSING [4F] ^

^XTV(8992.1,D0,2)= (#2) DATA FOR PROCESSING [E1,245F] ^

^XTV(8992.1,D0,20,0)=^8992.11PA^^ (#20) RECIPIENT

^XTV(8992.1,D0,20,D1,0)= (#.01) RECIPIENT [1P] ^ (#.02) ALERT FIRST DISPLAYED
     ==>[2D] ^ (#.03) FIRST SELECTED ALERT [3D] ^ (#.04)
     ==>PROCESSED ALERT [4D] ^ (#.05) DELETED ON [5D] ^
     ==>(#.06) AUTO DELETED [6D] ^ (#.07) FORWARDED BY [7P]
     ==>^ (#.08) DATE/TIME FORWARDED [8D] ^ (#.09) DELETED
     ==>BY USER [9P] ^

NOTE: A more user (developer) friendly API would be the ALERTDAT^XQALBUTL: API, which returns the data in an array with the field numbers and names as the subscripts and the internal and external (if different) values as the value.