Print Page as PDF
VDEF MESSAGE QUEUING ICR (4253)

VDEF MESSAGE QUEUING    ICR (4253)

Name Value
NUMBER 4253
IA # 4253
DATE CREATED 2004/09/01
CUSTODIAL PACKAGE VISTA DATA EXTRACTION FRAMEWORK
CUSTODIAL ISC San Francisco
USAGE Controlled Subscription
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE VDEFQM
NAME VDEF MESSAGE QUEUING
GENERAL DESCRIPTION
This IA decribes the API used to request that a message
be created and sent by the VDEF system.  It's successful use is dependent on
entries made in the correct VDEF and HL7 files.
STATUS Active
KEYWORDS
  • VDEF
  • MESSAGING
ID VDEFQM
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$QUEUE(event_ID,name_value_pairs,[.text_message])
This entry point places a request for the generation
of an HL7 message into VDEF Request Queue (#579.3).
VARIABLES TYPE VARIABLES DESCRIPTION
event_type Input
A string comprised of an HL7 message type and an HL7
event type separated by a "^".

The value must be defined in the list of known VDEF message type/event type
combinations in file 577.

Example:  "ADT^A28"
name_value_pairs Input
A string comprised of the following format:
SUBTYPE=<text>^IEN=nn where the Subtype text is a code based on the
application's domain and the clinical event and the IEN is the IEN of the
primary file associated with the event.

All Subtype names must be defined for this Message Type/Event Type in the VDEF
EVENT DESCRIPTION file (#577). The name "SUBTYPE" is reserved for the purposes
of uniquely identifying the request sub-type when more than one VDEF Event is
defined for a Message Type/Event Type combination.  For example, the HL7
message type/event ORU^R01 is used by multiple VistA domains to send
unsolicited results.  In these cases, the Subtype is used to differentiate the
sending domain's unique message contents within the structure of the ORU^R01.

Example: "SUBTYPE=VTLS^IEN=12345"
text_message Both
Acceptance or rejection text returned by the VDEF
API.

Example:  "Invalid event type."
$$QUEUE Output

1 if the HL7 request was queued up for processing
0 if it was not queued up for processing
SUBSCRIBING PACKAGE
SUBSCRIBING PACKAGE SUBSCRIBING DETAILS
GEN. MED. REC. - VITALS
ADVERSE REACTION TRACKING
OUTPATIENT PHARMACY
INTEGRATED BILLING
CLINICAL PROCEDURES
ADDED 10/9/2009