Print Page as PDF
HLO VDEF API ICR (5290)

HLO VDEF API    ICR (5290)

Name Value
NUMBER 5290
IA # 5290
DATE CREATED 2008/11/20
CUSTODIAL PACKAGE HEALTH LEVEL SEVEN
USAGE Private
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE HLOAPI6
NAME HLO VDEF API
GENERAL DESCRIPTION 

The routine HLOAPI6 is provided as an API to allow VDEF to verify that
HLO is installed, running and has all the required parameters for a
specific HL7 message type and HL7 event type.  These parameters must
be defined prior to use by VDEF users before VDEF can use HLO.
STATUS Active
KEYWORDS
  • HLO
  • VDEF
DURATION Till Otherwise Agreed
ID HLOAPI6
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION
VDEFPCK(LINK,APP,TYPE,EVENT) 
Inputs :
The input parameters are all required if used.
1 LINK : Name of HL7 logical link.
2 APP  : Name of HLO application.
3 TYPE : HL7 Message Type.
4 EVENT: HL7 Event type.

Outputs: Returns
With input parameters:
1         VDEF Event 'xxxxx' parameters exists HLO Engine.
0         HLO running but parameters for VDEF Event 'xxxx'don't
exist.
-1         HLO installed but not running on target system.
-2         HLO not installed on target system.

If input parameters are null:
1         HLO installed and running.
-1         HLO installed but not running on target system.
-2         HLO not installed on target system.

Variables used:
PARM1   - IEN of link in HL7 Logical Link file (#870)
PARM2   - IEN of application in HLO APPLICATION registry file (#779.2)
PARM3   - IEN of message type in MESSAGE TYPE ACTION subfile (#779.21)
RESULT  - Return value.
SUBSCRIBING PACKAGE VISTA DATA EXTRACTION FRAMEWORK
DATE ACTIVATED 2009/07/01