Print Page as PDF
$$PARAM EXTRINSIC FUNCTION IN ROUTINE HLCS2 ICR (3552)

$$PARAM EXTRINSIC FUNCTION IN ROUTINE HLCS2    ICR (3552)

Name Value
NUMBER 3552
IA # 3552
DATE CREATED 2002/04/04
CUSTODIAL PACKAGE HEALTH LEVEL SEVEN
CUSTODIAL ISC San Francisco
USAGE Controlled Subscription
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE HLCS2
NAME $$PARAM EXTRINSIC FUNCTION IN ROUTINE HLCS2
GENERAL DESCRIPTION
The $$PARAM^HLCS2 API is used extensively by the Health
Level 7 (HL7) package.  This API returns a string of text, delimited by the
up-arrow, holding critical environment information.  This API is being made
available to the VistA community on a controlled subscription basis.
STATUS Active
DURATION Till Otherwise Agreed
ID HLCS2
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$PARAM
The following example API call demonstrates syntax,
and also shows a sample of the output of this call.

>W $$PARAM^HLCS2
81^BALTIMORE.MED.VA.GOV^P^512^MARYLAND HCS^512^3030^HL7 MSG^^^^

When $$PARAM^HLCS2 is called, a string is returned containing key HL7
environment values.  The values in the string are delimited by the up-arrow
('^').  The pieces of data returned, and the source for the data, is listed
below.

Piece   Type-Data  Data                 Source
--------------------------------------------------------------------
1     Numeric    Domain file pointer  DOMAIN field (#.02) in the
HL COMMUNICATION PARAMETERS
file (#869.3).
2     Text       Domain name          NAME field (#.01) in the
DOMAIN file entry. (See
piece #1.)
3     Text       Set of codes         DEFAULT PROCESSING ID field
(#.03) in the HL
COMMUNICATION PARAMETERS
file (#869.3).
4     Numeric    Institution pointer  INSTITUTION field (#.04) in
the HL COMMUNICATION
PARAMETERS file (#869.3).
5     Text       Institution name     NAME field (#.01) in the
INSTITUTION file (#4).
(See piece 4.)
6     Text       Station number       STATION field (#99) in the
INSTITUTION file (#4).
(See piece 4.)
7     Numeric    Mail Group pointer   MAIL GROUP field (#.05) in
the HL COMMUNICATION
PARAMETERS file (#869.3).
8     Text       Mail Group name      NAME field (#.01) in the
MAIL GROUP file (#3.8).
(See piece 7.)
9     Numeric                         PURGE COMPLETED MESSAGES
field (#41) in the HL
COMMUNICATION PARAMETERS
file (#869.3).
10     Numeric                         PURGE AWAITING ACK MESSAGES
field (#42) in the HL
COMMUNICATION PARAMETERS
file (#869.3).
11     Numeric                         PURGE ALL MESSAGES field
(#43) in the HL COMMUNICATION
PARAMETERS file (#869.3).
12     Numeric                         DEFAULT RETENTION field (#51)
in the HL COMMUNICATION
PARAMETERS file (#869.3).
VARIABLES TYPE
$$PARAM Output
SUBSCRIBING PACKAGE
DBA Comments
9/7/12-mm:  Added AMIE as a subscriber for DVBA*2.7*181, CAPRI
Virtual VA, Voc. Rehab Enhancements & Defect Fixes.

CAPRI is implementing a web services client interface with the Master Veteran
Index that uses HL7v3 messaging.  $$PARAM^HLCS2 will be used to retrieve the
Default Processing ID.
MAIL MESSAGE 34312043
DATE/TIME EDITED
DATE/TIME EDITED ACTION AT THE REQUEST OF WITH CONCURRENCE OF
2012/09/07 10:34 SUBSCRIBER ADDED MCGINNIS,RON MOORE,JIM
Generated from JAN 24, 2019@ IA Listing Descriptions