Event Monitor APIs - HLEVAPI1 ICR (4227)

Name

Value

NUMBER

4227

IA #

4227

DATE CREATED

2003/08/26

CUSTODIAL PACKAGE

HEALTH LEVEL SEVEN

CUSTODIAL ISC

San Francisco

USAGE

Controlled Subscription

TYPE

Routine

ROUTINE

HLEVAPI1

NAME

Event Monitor APIs - HLEVAPI1

GENERAL DESCRIPTION

Integration agreements 4225, 4226 and 4227 cover the
supported APIs for the VistA HL7 Event Monitor system.  Integration agreement
4225 covers the HLEVAPI routine APIs, and agreement 4227 covers the HLEVAPI1
routine APIs.  This agreement covers the HLEVAPI0 routine's APPSTAT^HLEVAPI0
API.

Please read the GENERAL DESCRIPTION of integration agreement# 4225 before
continuing.

-------------------------------------------------------------------------

The APIs covered in the COMPONENT sections below are:

- APPSTAT^HLEVAPI1       - MSGTEXT^HLEVAPI1       - RUNDIARY^HLEVAPI1

Application developers wishing to use the Event Monitor system, including
these APIs, must secure permission from the VistA development team.

STATUS

Withdrawn

HLEVAPI1

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

APPSTAT

The STATUS-APPLICATION field (#5) in the HL7 Monitor
Job file (#776) can hold up to 10 characters of free-text data.  This field is
under the control of the application developer.  Data is placed in this field
using the APPSTAT^HLEVAPI0 API.

The STATUS-APPLICATION field in no way affects software processes.  It's only
use is for display by various Event Monitor display options.

The syntax for the APPSTAT^HLEVAPI1 API is:

D APPSTAT^HLEVAPI1(STATUS)

Where the STATUS parameter may be any value up to 10 characters (that doesn
not contain an up-arrow.)

VARIABLES	TYPE	VARIABLES DESCRIPTION
STATUS	Input	The STATUS parameter may be any free-text data, excluding the up-arrow, up to 10 characters in length.

MSGTEXT

The MSGTEXT^HLEVAPI1 API populates the MESSAGE TEXT
word processing field in the HL7 Monitor Job file (#776.)  The syntax for this
API is:

D MSGTEXT^HLEVAPI1(GBL)

Where GBL is a closed global reference to the location of the word-processing
text to be appended to the MESSAGE TEXT field.

Examples of valid closed global references are included in the following
example calls to this API:

D MSGTEXT^HLEVAPI1("^TMP(1532135)")
D MSGTEXT^HLEVAPI1($NA(^TMP($J,"TXT")))
D MSGTEXT^HLEVAPI1(TEXT)

If two calls to MSGTEXT^HLEVAPI1 are made, the second call appends it's text
to the text created by the first call.

The RUNDIARY^HLEVAPI1 API, also covered by this agreement operates identically
to this API, except it populates the RUN DIARY word processing field in the HL
Monitor Job file.

VARIABLES	TYPE	VARIABLES DESCRIPTION
GBL	Input	The value of GBL must be a closed global reference to the location of the word-processing text to be appended to the MESSAGE TEXT field.

RUNDIARY

The RUNDIARY^HLEVAPI1 API populates the RUN DIARY
word processing field in the HL7 Monitor Job file (#776.)  The syntax for this
API is:

D RUNDIARY^HLEVAPI1(GBL)

Where GBL is a closed global reference to the location of the word-processing
text to be appended to the RUN DIARY field.

Examples of valid closed global references are included in the following
example calls to this API:

D RUNDIARY^HLEVAPI1("^TMP(1532135)")
D RUNDIARY^HLEVAPI1($NA(^TMP($J,"TXT")))
D RUNDIARY^HLEVAPI1(TEXT)

If two calls to RUNDIARY^HLEVAPI1 are made, the second call appends it's text
to the text created by the first call.

The MSGTEXT^HLEVAPI1 API, also covered by this agreement operates identically
to this API, except it populates the MESSAGE TEXT word processing field in the
HL Monitor Job file.

VARIABLES	TYPE	VARIABLES DESCRIPTION
GBL	Input	The value of GBL must be a closed global reference to the location of the word-processing text to be appended to the RUN DIARY field.