Print Page as PDF
Event Monitor APIs - HLEVAPI0 ICR (4226)

Event Monitor APIs - HLEVAPI0    ICR (4226)

Name Value
NUMBER 4226
IA # 4226
DATE CREATED 2003/08/26
CUSTODIAL PACKAGE HEALTH LEVEL SEVEN
CUSTODIAL ISC San Francisco
USAGE Controlled Subscription
TYPE Routine
ROUTINE HLEVAPI0
NAME Event Monitor APIs - HLEVAPI0
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.

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

Monitors are defined in the HL7 Monitor file (#776.)  The STATUS field (#2) in
this file can be used to turn monitors on (when set to ACTIVE) or off (when
set to INACTIVE.)  The $$ONOFFM^HLEVAPI0 API, covered by this integration
agreement, is discussed below.

Application developers wishing to use the Event Monitor system, including
these APIs, must secure permission from the VistA development team.
STATUS Withdrawn
DURATION Till Otherwise Agreed
ID HLEVAPI0
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
ONOFFM 
Monitors are defined in the HL7 Monitor file (#776.)
The STATUS field (#2) in this file can be used to turn monitors on (when set
to ACTIVE) or off (when set to INACTIVE.)  If this field is INACTIVE, no jobs
will be queued for the monitor.  And, any queued jobs will stop immediately
when they start before the execution of the monitor's M code.

The syntax for this API is:

S X=$$ONOFFM^HLEVAPI0(HLEVIENE,STATUS)

The variable HLEVIENE is pre-defined for the application developer creating
calls to $$ONOFFM^HLEVAPI0.  They do not need to create the variable; just
pass it.

There are three allowable values for the second STATUS parameter, as shown in
the following table.

STATUS Value    Results
------------------------------------------------------------------------
A        Sets the STATUS field in the HL7 Monitor file to ACTIVE.  I
Sets the STATUS field in the HL7 Monitor file to INACTIVE.  ""       Returns
the current value of the STATUS field.
VARIABLES TYPE VARIABLES DESCRIPTION
HLEVIENE Input 
The HLEVIENE variable is the internal entry number of
the monitor entry in the HL7 Monitor file (#776.1.)  This variable is
pre-defined for the application developer, and just needs to be passed into
the API as the first parameter.
STATUS Input 
There are three allowable values for the second
STATUS parameter, as shown in the following table.

STATUS Value    Results
------------------------------------------------------------------------
A        Sets the STATUS field in the HL7 Monitor file to ACTIVE.  I
Sets the STATUS field in the HL7 Monitor file to INACTIVE.  ""       Returns
the current value of the STATUS field.

Passing A or I results in the STATUS field being changed to ACTIVE or INACTIVE
respectively.  Passing null returns the current value of the STATUS field
without making any changes to the field.