Print Page as PDF
VDEF MESSAGE-BUILDING UTILITIES ICR (4248)

VDEF MESSAGE-BUILDING UTILITIES    ICR (4248)

Name Value
NUMBER 4248
IA # 4248
DATE CREATED 2004/08/24
CUSTODIAL PACKAGE VISTA DATA EXTRACTION FRAMEWORK
CUSTODIAL ISC San Francisco
USAGE Controlled Subscription
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE VDEFEL
NAME VDEF MESSAGE-BUILDING UTILITIES
GENERAL DESCRIPTION
In the VDEF process, domain-specific routines build
messages that are sent to the HL7 system for distribution.  This IA contains
utilities that perform common functions often needed by these message building
routines.
STATUS Active
KEYWORDS
  • VDEF
  • MESSAGE BUILDING
  • HL7
DURATION Till Otherwise Agreed
ID VDEFEL
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
SETDLMS
Sets HL7 delimiters into individual variables based
either on elements of HL() array or default HL7 delimiter values.
VARIABLES TYPE VARIABLES DESCRIPTION
HL() Input
The HL() is optional.  It is passed through the
symbol table if it exists.  HL() is set by INIT^HLFNC2().

If the HL() array is not present, default values are output.
SEPC Output
Component separator.  Default = ~.
SEPS Output
Subcomponent separator.  Default = &.
SEPR Output
Repetition separator.  Default = |.
SEPE Output
Escape character.  Default = \.
SEPF Output
Field separator.  Default = ^.
$$XCN200(DUZ,source)
Given an IEN from the NEW PERSON file (#200) function
returns an XCN data type.

Optionally, a source of the data can be passed to the API to identify in the
HL7 segment where the person information comes from.

Prerequisite: HL7 delimiters set into variables as done by SETDLMS^VDEFEL must
be present.
VARIABLES TYPE VARIABLES DESCRIPTION
DUZ Input
DUZ = IEN of a New Person file entry is required.
$$XCN200 Output
Function returns a XCN HL7 data type based on the
indicated New Person file entry.

Example: 520637377~CREAVEN~DON~~~~~VistA200
source Input
Optional.  The string passed will be added to the HL7
data to identify where the data originates.  Default value of 'VistA200' is
used if nothing is passed in this parameter.
$$TS(date_time)
Given a date/time value, function returns an HL7 TS
data type.

Examples:

1.      W $$TS^VDEFEL($H)
20040820182643-0400

2.      W $$TS^VDEFEL("3140820.154420")
20140820154420-0400

3.      W $$TS^VDEFEL("AUG 23, 2004@100923")
20040823100923-0400
VARIABLES TYPE VARIABLES DESCRIPTION
date_time Input
A date/time value in either $H, FileMan internal, or
an external format understood by FileMan's date/time utilities.
$$TS Output
Function returns a TS data type, including time zone.
No time zone is returned if no time is included in input.
SUBSCRIBING PACKAGE
SUBSCRIBING PACKAGE SUBSCRIBING DETAILS
GEN. MED. REC. - VITALS
ADVERSE REACTION TRACKING
OUTPATIENT PHARMACY
INTEGRATED BILLING
Added in support of PFSS development
REGISTRATION
Added in support of PFSS development
ENROLLMENT APPLICATION SYSTEM
CLINICAL PROCEDURES
ADDED 10/7/2009