Print Page as PDF
ORDER HL7 MESSAGE ESCAPE API ICR (4922)

ORDER HL7 MESSAGE ESCAPE API    ICR (4922)

Name Value
NUMBER 4922
IA # 4922
DATE CREATED 2006/10/23
CUSTODIAL PACKAGE ORDER ENTRY/RESULTS REPORTING
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE ORHLESC
NAME ORDER HL7 MESSAGE ESCAPE API
GENERAL DESCRIPTION
This DBIA describes the API that OE/RR has created to
escape and unescape HL7 messages that are sent back and forth between CPRS and
it's ancillary packages.
STATUS Active
KEYWORDS
  • HL7
  • ESCAPE
  • ORHLESC
ID ORHLESC
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
ESC
This entry point removes characters defined in DELIM
from the string STRING and replaces them with an escape sequence.

If DELIM is not passed to $$ESC, it will default to the standard HL7 encoding
characters "~|\&^".

~  Component separator converted to \S\
|  Repetition separator converted to \R\
\  Escape character converted to \E\
&  Sub-Component converted to \T\
^  Field separator converted to  \F\
VARIABLES TYPE
STRING Input
DELIM Input
$$ESC Output
UNESC
This entry point replaces the escape sequences in
STRING with the proper escaped charater from DELIM.  See entry point ESC of
ORHLESC for details on defaults for DELIM and mapping of escaped characters to
escape sequenses.
VARIABLES TYPE
STRING Input
DELIM Input
$$UNESC Output