All ICR List

Package: Health Level Seven ICR List

IA # Name Type Custodial Package Date Created DBIC Approval Status Status Usage File # General Description Remote Procedure Routine Date Activated
IA # Name Type Custodial Package Date Created DBIC Approval Status Status Usage File # General Description Remote Procedure Routine Date Activated
940 DBIA940 File HEALTH LEVEL SEVEN 1994/08/19 APPROVED Active Private 772
The IVM package requests permission to use the HL7
TRANSMISSION (#772) file to find the mailman message number associated with an
outgoing HL7 transmission. The purpose of this reference is to use that
number to determine if the message is Awaiting Transmission.
941 DBIA941 File HEALTH LEVEL SEVEN 1994/08/19 APPROVED Active Private 771.3
The IVM package requests permission to store the
pointer to an entry in the HL7 SEGMENT NAME (#771.3) file in an IVM file.
Both the pointer and segment name will be stored, in the INCOMING SEGMENT
(#.01) and SEGMENT NAME (#.02) fields of the QUERY TRANSMISSION DATE/TIME
(#.05) multiple of the IVM PATIENT (#301.5) file, respectively. The pointer
to the segment name will be determined using a DIC look-up call. The segment
name will be extracted from an HL7 message segment.
942 DBIA942 Other HEALTH LEVEL SEVEN 1994/08/19 APPROVED Active Private
The IVM requests permission to perform the following
actions during the initialization process of IVM v2.0:
1. Add the following two new segments to the HL7 SEGMENT NAME
(#771.3) file:
A. ABBREVIATED NAME: ZIR
FULL NAME: VA Specific Income Information VERSION: 2.1
B. ABBREVIATED NAME: ZIO
FULL NAME: VA Spec. Patient Information VERSION: 2.1
2. Update the 'IVM' entry in the HL7 DHCP APPLICATION PARAMETER
(#771) file with:
A. New entries in the HL7 MESSAGE (#6) multiple
B. New entries in the HL7 SEGMENT (#5) multiple
1169 DBIA1169-A File HEALTH LEVEL SEVEN 1995/03/21 APPROVED Active Controlled Subscription 771.5
Check for existance of version 2.2 in 771.5. If
missing add via Fileman
1170 DBIA1169-B File HEALTH LEVEL SEVEN 1997/07/29 APPROVED Active Controlled Subscription 771.2
Checks and adds "ADR" message type if it does not exist
in HL7 MESSAGE TYPE file (#771.2).
This DBIA is being revised for version 1.6 of HL7.
Applications wishing to export interfaces may have the need to update specific
HL7 reference files with entries relevant to the current HL7 standard or
VA-specific 'Z' segments.
Applications may read/update the following files using KIDS or documented VA
Fileman calls following written notification and approval of an appropriate
official in Technical Integration.
771.2 HL7 MESSAGE TYPE 771.1 HL7 FIELD 771.3 HL7 SEGMENT 771.5 HL7 VERSION
779.001 HL7 EVENT TYPE CODE
1339 DBIA1339 File HEALTH LEVEL SEVEN 1995/09/13 APPROVED Active Private 772
This DBIA documents a Radiology/Nuclear Medicine
package reference to the HL7 package file #772. This is only applicable when
Health Level Seven Version 1.5 is the version currently installed at a site.
1495 DBIA1495-A File HEALTH LEVEL SEVEN 1996/02/22 APPROVED Active Controlled Subscription 869.2
Controlled Substances Version 3.0 needs write access to
the HL LOWER LEVEL PROTOCOL PARAMETER file to allow a post-init to populate
necessary parameters for an interface to narcotic dispensing equipment
systems.
1496 DBIA1495-B File HEALTH LEVEL SEVEN 1996/02/22 APPROVED Active Controlled Subscription 870
Write access permitted to the HL LOGICAL LINK file to
allow installation to populate necessary fields to support interfaces.
1565 DBIA1565 File HEALTH LEVEL SEVEN 1996/07/19 APPROVED Active Private 779.001
As part of the installation process, the Ambulatory Care
Reporting Project is granted permission to create the following
entry in the HL7 EVENT TYPE CODE file (#779.001)
CODE (#.01): Z00
DESCRIPTION (#2): Ambulatory Care transmission to/from NPCDB
VERSION (#100): 2.2
1566 DBIA1566 File HEALTH LEVEL SEVEN 1996/07/19 APPROVED Active Private 869.2
As part of the installation process, the Ambulatory Care
Reporting Project is granted permission to create the following
entry in the HL LOWER LEVEL PROTOCOL PARAMETER file (#869.2)
NAME (#.01): AMB-CARE
LLP TYPE (#.02): MAILMAN
MAIL GROUP (#100): SCDX AMBCARE TO NPCDB
1567 DBIA1567 File HEALTH LEVEL SEVEN 1996/07/19 Retired Private 870
As part of the installation process, the Ambulatory Care
Reporting Project is granted permission to create the
following entry in the HL LOGICAL LINK file (#870)
NAME (#.01): AMB-CARE
LLP PARAMETERS (#2): AMB-CARE
1937 DBIA1937 - EC HL7 INTERFACE File HEALTH LEVEL SEVEN 1997/02/18 APPROVED Active Private 771
The Event Capture HL7 internal interface will reference
the following data from the HL7 APPLICATION PARAMETER FILE (#771). In File
771, the Event Capture HL7 internal interface will reference the current mail
group from field (#4).
1939 DBIA1938 - EC HL7 INTERFACE File HEALTH LEVEL SEVEN 1997/02/19 APPROVED Active Private 772
The Event Capture HL7 internal interface will reference
the following data from the HL7 MESSAGE TEXT FILE (#772). In File 772, the
Event Capture HL7 internal interface will reference information related to the
MSH and MSA segments from the MESSAGE TEXT field (#200).
2062 DBIA2062 File HEALTH LEVEL SEVEN 1997/07/11 Pending Private 771.2
This agreement is to add the 2.3 version to each
message.
2063 DBIA2063 File HEALTH LEVEL SEVEN 1997/07/11 Pending Private 870
This agreement is for FileMan read access to the HL
LOGICAL LINK (#870) file, field LLP PARAMETER (#2).
2161 HLFNC2 Routine HEALTH LEVEL SEVEN 1997/10/29 APPROVED Active Supported HLFNC2
2162 HL7 MESSAGE TYPE File HEALTH LEVEL SEVEN 1997/10/29 Pending Supported 771.2
The creation of new entries must be cleared through the
HL7 development team. New entries may be added with a call to FILE^DICN and a
call to IX1^DIK during the package post-installation.
2164 HL7 MESSAGE ADMINISTRATION Routine HEALTH LEVEL SEVEN 1997/10/30 APPROVED Active Supported
API to generate a HL7 message.
HLMA
2165 HL7 MESSAGE ADMINISTRATION Routine HEALTH LEVEL SEVEN 1997/10/30 APPROVED Active Supported
API to generate a HL7 acknowledgement message.
HLMA1
2168 HL7 DATA TYPE File HEALTH LEVEL SEVEN 1997/10/30 Pending Private 771.4
The Baxter Sure-Med Pharmacy Interface requests an
agreement with the HL7 module to reference the HL7 Data Type file (#771.4).
2270 Subscription Management Routine HEALTH LEVEL SEVEN 1998/01/23 APPROVED Active Supported
The following API's support creation, references, and
updates to HL7 subscriptions using the SUBSCRIPTION CONTROL FILE (774).
In addition, Vista applications may set up a pointer to file 774 if needed. An
example of this can be found in the Patient file. See the CIRN documentation
for details on how this is used.
HLSUB
2271 DERIVE LOGICAL LINK FROM INSTITUTION Routine HEALTH LEVEL SEVEN 1998/01/23 APPROVED Active Supported
A new API has been created to return an array of
Logical links when only
an institution entry is known. This can be either a single institution or
a VISN. A new field has been added to the HL LOGICAL LINK file (870)
pointing to the INSTITUTION FILE.
HLUTIL3
2342 DBIA2342 File HEALTH LEVEL SEVEN 1998/05/27 APPROVED Active Controlled Subscription 771
The Surgery package is granted permission to do a
direct global read of the ACTIVE/INACTIVE field (#2) in the HL7 APPLICATION
PARAMETER file (#771). Reading this field will allow the Surgery package to
determine if the HL7 application associated with the Surgery HL7 interface is
active or not. If the HL7 application is not active, the call to the Surgery
HL7 interface will quit, thus avoiding needless processing.
2434 DBIA2434 Routine HEALTH LEVEL SEVEN 1998/06/16 APPROVED Active Supported
Patch HL*1.6*36 introduces 3 new entry points in
routine HLUTIL. These entry points support two new features, "Don't Purge" and
"Reprocessing" messages, which were originally requested by the CIRN project.
Patch HL*1.6*19 added a 4th API and restricted the use of all APIs to TCP/IP
connections.
HLUTIL
2488 IA2488 File HEALTH LEVEL SEVEN 1998/08/04 APPROVED Active Private 772
The Lab requests a DBIA from HL7 for the following reference:
^HL(772,176674,"P") = 4^2980419.101639^EventProtocol not found^13
Using the code: S LRSTATUS=+$G(^HL(772,LRMID,"P"))
I plan to use this during the acknowledgement process of NCH messages from
Austin.
REFERENCE FORUM MESSAGE: 27535419
2506 DBIA2506 File HEALTH LEVEL SEVEN 1998/08/20 Withdrawn Private 772
The lab package request a direct read on the "IN"
subscript of file 772 as follows: S
LRMN=$P($G(^HL(772,LRMID,"IN",1,0)),HLFS,10)
This will only be needed `till the next extract update.
2507 DBIA2507 File HEALTH LEVEL SEVEN 1998/08/20 APPROVED Active Controlled Subscription 771.6
Lab requests permission to read file 771.6 as follows:
I $G(LRSTATUS) S LRTXT(LRX)="Message: "_LRX_$P(^HL(771.6,+LRSTATUS,0),U)
This call will be converted in the next version of the extract.
2525 POINTER TO FILE 870 File HEALTH LEVEL SEVEN 1998/09/02 Retired Private 870
CIRN would like to store in the CIRN SITE PARAMETER
file (#991.8) a pointer to the HL LOGICAL LINK file (#870) for the MPI logical
link.
In the CIRN SITE PARAMETER file (#991.8), the MPI LINK field (#36) points to
File #870. The Master Patient Index (MPI) is used to send messages to the MPI
in Austin.
IA retired. See IA 3335 for current documentation.
2773 DBIA2773 File HEALTH LEVEL SEVEN 1999/03/09 APPROVED Active Private 774
CIRN Option RG SUBSCRIPT STAT INQ uses a Read with
FileMan to file ^HLS(774 (SUBSCRIPTION CONTROL) to do a lookup on a patient.
This allows users to identify which sites are currently receiving CIRN patient
information. It is display only.
2887 Application Parameter Inquire Routine HEALTH LEVEL SEVEN 2003/09/30 APPROVED Active Supported
This public API returns the Mail Group and the
"active/inactive" flag for an HL7 Application.
HLCS2
2900 DBIA2900 File HEALTH LEVEL SEVEN 1999/08/26 APPROVED Active Private 771
A one time update to set the site number in HL7's table
for the Application entry in file 771.
3036 HL7 APPLICATION PARAMETER LOOKUP File HEALTH LEVEL SEVEN 2000/02/15 APPROVED Active Private 771
This IA will allow MPI/PD to lookup an entry in the HL7
APPLICATION PARAMETER (#771) file using DBS FileMan calls.
The IA is needed because of the release of two seperate but related patches.
DG*5.3*261 exports the ADT/HL7 EVENT REASON (#391.72) file which has a field
named HL7 APPLICATION PARAMETER (#.02). This field is a pointer to the HL7
APPLICATION PARAMETER (#771) file. Our data in ADT/HL7 EVENT REASON file is
initially exported with the HL7 APPLICATION PARAMETER blank. The HL7
APPLICATION PARAMETER required for this field is being exported in RG*1.0*4.
RG*1.0*4 adds the HL7 APPLICATION PARAMETER, and a post-install process adds
that data to the ADT/HL7 EVENT REASON file. Our IA will permit our
post-install process to lookup the new application with silent FileMan calls
and subsequently add that data to the ADT/HL7 EVENT REASON file.
3068 DBIA3068 Other HEALTH LEVEL SEVEN 2000/03/22 APPROVED Active Private
The Primary Care Management Module (PCMM) in Scheduling
requests permission to update the 'PCMM' entry in the HL7 APPLICATION
PARAMETER (#771) file. The following action will be performed during the post
initialization process of patch SD*5.3*210:
1. The Name (#.01) field of this entry will be changed from
'PCMM' to 'PCMM-210'.
3098 HL7 APIs Routine HEALTH LEVEL SEVEN 2000/04/24 APPROVED Active Supported
APIs for HL7 package. These APIs are available after
patch HL*1.6*64.
HLUTIL
3099 HL7 APIs Routine HEALTH LEVEL SEVEN 2000/04/24 APPROVED Active Supported
HL7 APIs for the routine HLCSUTL. These are available
after patch HL*1.6*64.
HLCSUTL
3123 DBA3123 File HEALTH LEVEL SEVEN 2000/06/08 APPROVED Active Private 774
Ability to delete subscription record (file 774) with
FileMan when deleting the pointer to that record in the MPI node of the
Patient file (#2). This is necessary for duplicate record merge.
3244 Invalid MPI/PD exception messages sent to FORUM File HEALTH LEVEL SEVEN 2000/11/06 APPROVED Active Controlled Subscription 773
Exception messages are being sent to the MPI/PD team
under the wrong circumstances. Non-MPI/PD applications trigger exception
messages under inappropriate conditions because of issues in the execution of
the VistA Health Level Seven (HL7) software. This IA will eliminate the
possibility of non-MPI/PD applications generating exception messages.
3273 DBIA3273 File HEALTH LEVEL SEVEN 2000/12/20 APPROVED Active Controlled Subscription 773
This is a request for the MPI/PD package to have
Fileman Read access to several fields for the purpose of improving the
information provided in the exception messages,generated while processing HL7
messages, that are sent to the MPI/PD team via Mailman.
The exception message currently includes the message id of the message where
the exception was encountered. We would like to add to the exception message
some information about the HL7 message,including the Logical Link, Message
Type,and Event Type.
For that purpose we request Fileman read access to the following fields:
HL7 Message Administration file (#773):
Logical Link (#7)
Message Type (#15)
Event Type (#16)
3283 DBIA3283 File HEALTH LEVEL SEVEN 2001/01/18 APPROVED Active Private 870
The Registration package requests permission to perform
a Read with FileMan of file 870 in order to get the name of links subscribed
to by a record.
3335 Gather Logical Link Domain File HEALTH LEVEL SEVEN 2001/03/06 APPROVED Active Controlled Subscription 870
3421 IFR MFS and HL7 AC x-ref Routine HEALTH LEVEL SEVEN 2001/07/20 Withdrawn Private
The IFR project performs a clean up of the INSTITUTION
file #4. It first queries FORUM using the HL7 package direct connect. If for
some reason the connection drops, HL7 may not clean up HLMA("AC","O",link,mid)
which causes problems with subsequent direct connects to the same link.
The HL7 team is working on a patch. In the mean time I'd like to check for
this bad x-ref before I try to connect. This would allow IFR to proceed with
patch XU*8*206 (the check would be implemented in XU*8*209.)
XUMF4
3454 Enter/Edit NODE Entry in HL LOGICAL LINK (#870) File HEALTH LEVEL SEVEN 2001/09/13 APPROVED Active Private 870
MPI/PD build RG*1.0*22 exports (via KIDS) the following HL LOGICAL LINK.
NODE: NODE
INSTITUTION: OFFICE OF INFORMATION SRV CNTR
LLP TYPE: TCP AUTOSTART: Enabled
DOMAIN: MAIL.CIO.DNS QUEUE SIZE: 10
EXCEED RE-TRANSMIT ACTION: restart TCP/IP ADDRESS: 127.0.0.1
TCP/IP PORT: XXXX TCP/IP SERVICE TYPE: CLIENT (SENDER)
Post-install routine PST^RGP22, determines if the account is the
production or test account. (IA #3335 and #2525 allow the read
access necessary to do this.)
If the account is the test account, we do not want the 'NODE' node
to be actively used. Therefore, the DOMAIN (#.03) and TCP/IP ADDRESS
(#400.01) fields are omitted in the post-install.
CIRN MPI/PD has an agreement to use a FileMan DIE call to edit/eliminate
the DOMAIN (#.03) and TCP/IP ADDRESS (#400.01) fields in the HL LOGICAL
LINK (#870) file for entry 'NODE'. This functionality is in support
of GCPR.
3464 HL(772 Diagnostic Utility File HEALTH LEVEL SEVEN 2001/10/03 APPROVED Active Controlled Subscription 772
This IA supports a diagnostic utility used for problem resolution
with messaging issues associated with HL7 data transmissions for
MPI/PD. The tool will be available for diagnostic purposes as
needed by the development team or NVS.
The utility compiles data from the HL7 MESSAGE TEXT (#772) file
for a selected date range. Each HL7 message in the date range
is examined. If the RELATED EVENT PROTOCOL (#10) field contains
the MPI/PD protocols (e.g., ""VAF"", ""RG"", or ""MPI"") data is
stored in the ^XTMP("RGMT","HL" array. A cross-reference is built
on patient ICN and DFN for faster data retrieval for the associated
reports. Direct global reads are necessary for efficiency and speed
for the data compilation process.
A number of diagnostic reports are generated from the compiled data
including the following.
HL7 Activity by Patient for a Single Protocol for Date Range
HL7 Activity by Patient for All MPI/PD Protocols for Date Range
HL7 Message Status Summary Report (total number of messages
for each date in range, transmission type, and status)
Detailed HL7 Message Status Report
3471 HLCSAC Routine HEALTH LEVEL SEVEN 2001/10/19 APPROVED Active Private HLCSAC
3484 HL7 Capacity Management Phase I API Routine HEALTH LEVEL SEVEN 2001/11/26 APPROVED Active Supported
Returns Health Level 7 (HL7) activity totals for a
parameter-supplied time range. Additional control over the HL7 activity
included in the totals is available using passed parameters. (See HL*1.6*103
for additional information.)
HLUCM
3488 HL7 Capacity Management Phase II API Routine HEALTH LEVEL SEVEN 2001/12/03 APPROVED Active Supported
Returns Health Level 7 (HL7) activity totals for a
parameter-supplied time range. Additional control over the Hl7 activity
included in the totals is available using passed parameters. (See HL*1.6*103
for additional information.)
COMPARISON OF $$CM & $$CM2:
---------------------------
Patch HL*1.6*79 holds phase I software, and is associated with DBIA# 3484.
Phase I software is almost identical to phase II software, except in the
number of "messages" returned by the two APIs. The call point for
DBIA# 3484 - phase I software - is $$CM^HLUCM. The call point for this DBIA -
phase II software - is $$CM2^HLUCM.
$$CM^HLUCM returns the number of discrete message occurring during a
parameter-defined period of time. $$CM2^HLUCM returns the number of "message
units" during the same period of time. All other totals returned by both
parameters are identical.
A message is an individual message, such as an application acknowledgement. A
message unit is made up of all related messages.
The difference between a message (phase I, $$CM^HLUCM) and a message unit
(phase II, $$CM2^HLUCM) can be illustrated using the following sequence of
events.
* Baltimore sends a message to Washington. * Washington sends back a commit
acknowledgement to Baltimore. * Washington sends an application
acknowledgement to Washington. * Baltimore sends back to Washington a commit
acknowledgement
for the just sent application acknowledgement.
In the above example, $$CM^HLUCM would report a count of 4 messages.
$$CM2^HLUCM would report a count of 1 message, or "message unit." (Since all 4
messages are "related", they are combined into one reported "message.")
HLUCM
3550 HLCS(870,'C' File HEALTH LEVEL SEVEN 2002/08/22 APPROVED Active Private 870
This general purpose integration agreement exists for
packages needing to access the "C" cross-reference in the HL Logical Link file
(#870).
All packages that desire to be subscribers to this integration agreement must
submit the details for their use of the "C" cross-reference to the VistA HL7
package developers for approval. The cross-reference access details will be
included in the individual subscriber section of this agreement.
3552 $$PARAM EXTRINSIC FUNCTION IN ROUTINE HLCS2 Routine HEALTH LEVEL SEVEN 2002/04/04 APPROVED Active Controlled Subscription
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.
HLCS2
3573 Get Institution from file 870 File HEALTH LEVEL SEVEN 2002/05/09 Retired Controlled Subscription 870
MPIF application needs to be able to get the
institutions for the logical links returned in GET^HLSUB(sub,0,"",.array)
The following is the actual code that will be used to get the institutions:
.S INST=$$GET1^DIQ(870,+$P(ARRAY("LINKS",SUBNUM),"^",6)_",",.02,"E")
IA retired. See IA 3335 for current documentation.
3574 HL7 LINK MANAGER Routine HEALTH LEVEL SEVEN 2002/05/13 APPROVED Active Controlled Subscription
This routine manages various activities of the HL7 Link
Manager.
HLCSLM
3734 HLCS(870,IEN,0) - NODE field (#.01) File HEALTH LEVEL SEVEN 2002/08/27 APPROVED Active Private 870
This integration agreement covers direct global reads
of the NODE field (#.01) of the HL Logical Link file (#870.) The NODE field
is the first piece of the ^HLCS(870,IEN,0) node of an entry in this file.
3988 Dynamic Routing Header Help Code Routine HEALTH LEVEL SEVEN 2003/03/06 APPROVED Active Supported
The Dynamic Routing patch HL*1.6*93 gives application
developers writing calls to the VistA HL7 package's DIRECT^HLMA and
GENERATE^HLMA APIs the ability to directly control the routing-related fields.
These fields are the SENDING APPLICATION (MSH-3), SENDING FACILITY (MSH-4),
RECEIVING APPLICATION (MSH-5), and the RECEIVING FACILITY (MSH-6).
Refer to chapter 12 of the VistA HL7 Site Manager and Developer manual for
complete information about the use of the DIRECT^HLMA and the GENERATE^HLMA
APIs.
The Dynamic Routing patch HL*1.6*93 expands the data that can be passed into
these APIs to include HLP("SUBSCRIBER") and HLP("SUBSCRIBER",n) local array
entries. When passing HLP("SUBSCRIBER") or HLP("SUBSCRIBER",n) local array
data, an M API created by the application developer can be called to evaluate
the environment and, if appropriate, change the local variables used to create
the routing-related fields in the MSH segment.
A new API, M^HLCSHDR4, has been created to assist application developers in
the early stages of using M code to control the routing-related fields in the
MSH segment.
When the HLP("SUBSCRIBER") or HLP("SUBSCRIBER",n) local array data references
M^HLCSHDR4, this is how M^HLCSHDR4 is executed, and the actions taken:
Step Action and Comments
-------------------------------------------------------------------------
#1 DIRECT^HLMA or GENERATE^HLMA is called, with HLP("SUBSCRIBER") or
HLP("SUBSCRIBER",n) local array defined with a reference to
M^HLCSHDR4.
#2 Execution of DIRECT^HLMA or GENERATE^HLMA code proceeds, coming to
the code that creates the MSH segment.
#3 The HLP("SUBSCRIBER") and HLP("SUBSCRIBER",n) data is evaluated, and
the call to M^HLCSHDR4 is found.
#4 M^HLCSHDR4 is called, and the following actions occur:
- The local variables that will be used in the creation of the
routing-related fields in the MSH segment are displayed,
accompanied with explanation of each variable, it's significance,
and from what source the variable was created.
- Application developer can interactively enter new values for the
routing-related fields.
- If new values are entered, the application developer is informed
on-screen the actions taken by M^HLCSHDR4 based on the newly
entered value for the routing-related field(s). (I.e., the
local variable(s) used in the creation of the routing-related
fields is reset to the new value entered by the developer.)
#5 The MSH segment is built using the routing-related
local variables, (some of which might have been interactively
changed by the developer when answering the M^HLCSHDR4 queries.)
#6 Execution of DIRECT^HLMA or GENERATE^HLMA code proceeds, the MSH
segment and the complete message is created, and all processing of
the message completes.
Because of the display of explanatory information by M^HLCSHDR4, and because
the developer is informed of the actions being taken in resetting the
routing-related variables, this API is a valuable training tool.
Application developers calling M code via HLP("SUBSCRIBER") or
HLP("SUBSCRIBER",n) are encouraged to use the M^HLCSHDR4 API during the
initial phases of their development. After learning how to use M code to
control the routing-related fields in the MSH segment, developers must remove
the educational M^HLCSHDR4 reference, substituting their own M code API.
HLCSHDR4
4069 HL7 MESSAGE TEXT FILE (#772) File HEALTH LEVEL SEVEN 2003/04/01 APPROVED Active Controlled Subscription 772
This integration agreement will be used for all
references to all structures in the HL7 Message Text File (#772) file. Each
reference by package is included in the SUBSCRIBING DETAILS for each
subscribing package.
As new requests to this file are received and accepted by the VistA HL7
development staff, this integration agreement will be updated.
2007/01/24
4117 HL7 Capacity Management $$CM2F API Routine HEALTH LEVEL SEVEN 2003/06/05 APPROVED Active Controlled Subscription
Returns Health Level 7 (HL7) activity totals for a
parameter-supplied time range. Additional control over the HL7 activity
included in the totals is available using passed parameters.
Patch HL*1.6*103 fully documents the $$CM2F^HLUCM API covered by this
integration agreement. In addition, the patch documentation discusses the
$$CM^HLUCM (DBIA# 3484) and $$CM2^HLUCM (DBIA# 3489) APIs.
COMPARISON OF $$CM, $$CM2 & $$CM2F:
-----------------------------------
$$CM^HLUCM and $$CM2^HLUCM are almost identical to each other. Both have
identical parameters and both return data in the same format. The only
difference is that $$CM^HLUCM returns the number of messages during the
user-supplied time range, and $$CM2^HLUCM returns the number of "message
units" within a time range.
Messages are individually transmitted messages. The initially transmitted
message is considered a "message" by $$CM^HLUCM, and the return
acknowledgement is considers a separate and unique "message." If a message is
transmitted, and an acknowledgement message returned, $$CM^HLUCM returns a
total of two messages.
Message "units" are collections of functionally related messages. In the
above example, $$CM^HLUCM counts two messages, but since the message and it's
acknowledgement are functionally related, $$CM2^HLUCM returns a count of one
"unit."
$$CM2F^HLUCM counts message units in an identical manner to $$CM2. The only
difference between these two APIs is the $$CM2F^HLUCM counts only message
units involving remote sites. $$CM2^HLUCM (and $$CM^HLUCM, for that matter)
counts both locally and remotely sent message units.
HLUCM
4225 Event Monitor APIs - HLEVAPI Routine HEALTH LEVEL SEVEN 2003/08/26 Withdrawn Controlled Subscription
Enhancement patch HL*1.6*106 contains the VistA HL7
Event Monitor system. The Event Monitor system facilitates the process of
monitoring the VistA HL7 environment for conditions and events, as well as
notification of the VistA HL7 support and development personnel.
The Event Monitor system includes new files and options, as well as the eight
application program interfaces (APIs) documented in this integration
agreement.
The Event Monitor system is built around:
- Monitors
- Master Job
The Monitor is built around an entry in the HL7 Monitor file (#776.1) that
"points" to an M code API. The monitor also includes a field that specifies
how many minutes should elapse between every "run" of the monitor.
The Master Job runs every few hours perpetually. It checks every monitor
entered in the HL7 Monitor file to determine whether the monitor should be
run. If it is time for a monitor "run", the master job queues a background
job for the specific monitor.
The primary task of the master job is to start individual monitor jobs, and to
record the result of it's evaluation of every monitor; whether it was started
or not, and the reason for the action taken.
The APIs created by patch HL*1.6*106 and included in integration agreements
4225, 4226 and 4227 are:
- $$START^HLEVAPI - CHECKIN^HLEVAPI - CHECKOUT^HLEVAPI
- MAILIT^HLEVAPI - ABORT^HLEVAIP - VARIABLE^HLEVAPI
- ONOFF^HLEVAPI0 - APPSTAT^HLEVAPI1 - MSGTEXT^HLEVAPI
- RUNDIARY^HLEVAPI1
Application developers wishing to use the Event Monitor system, including
these APIs, must secure permission from the VistA HL7 development team.
--------------------------------------------------------------------------
Please peruse the APIs documented in this integration agreement in the
following order:
- START^HLEVAPI - CHECKIN^HLEVAPI - CHECKOUT^HLEVAPI
- VARIABLE^HLEVAPI
The above APIs form a conceptual unit.
The MAILIT^HLEVAPI and the ABORT^HLEVAPI APIs may be reviewed in any order,
but they should be reviewed after the four APIs listed above.
HLEVAPI
4226 Event Monitor APIs - HLEVAPI0 Routine HEALTH LEVEL SEVEN 2003/08/26 Withdrawn Controlled Subscription
Integration agreements 4225, 4226 and 4227 cover the
supported APIs for the VistA HL7 Event Monitor system. Integration agreement
4225 covers the HLEVAPI routine APIs, and agreement 4227 covers the HLEVAPI1
routine APIs. This agreement covers the HLEVAPI0 routine's APPSTAT^HLEVAPI0
API.
Please read the GENERAL DESCRIPTION of integration agreement# 4225 before
continuing.
-------------------------------------------------------------------------
Monitors are defined in the HL7 Monitor file (#776.) The STATUS field (#2) in
this file can be used to turn monitors on (when set to ACTIVE) or off (when
set to INACTIVE.) The $$ONOFFM^HLEVAPI0 API, covered by this integration
agreement, is discussed below.
Application developers wishing to use the Event Monitor system, including
these APIs, must secure permission from the VistA development team.
HLEVAPI0
4227 Event Monitor APIs - HLEVAPI1 Routine HEALTH LEVEL SEVEN 2003/08/26 Withdrawn Controlled Subscription
Integration agreements 4225, 4226 and 4227 cover the
supported APIs for the VistA HL7 Event Monitor system. Integration agreement
4225 covers the HLEVAPI routine APIs, and agreement 4227 covers the HLEVAPI1
routine APIs. This agreement covers the HLEVAPI0 routine's APPSTAT^HLEVAPI0
API.
Please read the GENERAL DESCRIPTION of integration agreement# 4225 before
continuing.
-------------------------------------------------------------------------
The APIs covered in the COMPONENT sections below are:
- APPSTAT^HLEVAPI1 - MSGTEXT^HLEVAPI1 - RUNDIARY^HLEVAPI1
Application developers wishing to use the Event Monitor system, including
these APIs, must secure permission from the VistA development team.
HLEVAPI1
4241 DBIA4241 File HEALTH LEVEL SEVEN 2004/08/18 APPROVED Active Controlled Subscription 870
The BPS 1.0 Master Build, performs Fileman references and modifications to
the HL7 LOGICAL LINK File (#870) to retrieve and/or modify the IP address,
port number, Domain and startup node information for the logical links that
are installed by the BPS software. This information is needed when installing
the above patch and subsequently when the BPS applications validate the status
of the links.
4262 MESSAGE BODY DELETION Routine HEALTH LEVEL SEVEN 2003/09/29 APPROVED Active Supported
This integration covers the use of the DELBODY^HLUOPT2
API. This API deletes all segments of a VistA HL7 message except the MSH
segment. See patch HL*1.6*98 for additional explanation and information.
HLUOPT2
4269 VDEF VDEF EXTRACTION LISTS Other HEALTH LEVEL SEVEN 2004/08/23 Retired Supported
The following VDEF extraction lists are under the
custody of HEALTH LEVEL SEVEN:
MSH-0
EVN-0
4271 HL7 MESSAGE TYPE ACCESS File HEALTH LEVEL SEVEN 2004/08/31 APPROVED Active Private 771.2
This IA allows the VDEF package to point-to and lookup
entries in file #771.2. This access is used to verify that VDEF Extract
Descriptions are based on existing HL7 Message Types.
4316 VDEF access to Institution and Mail Group data File HEALTH LEVEL SEVEN 2004/08/24 APPROVED Active Private 869.3
This IA exposes Institution and Mail Group (File 869.3,
fields .04 and .05) to VDEF that builds the MSH segment for VDEF-built HL7
messages.
4321 HL7 EVENT TYPE ACCESS File HEALTH LEVEL SEVEN 2004/08/31 APPROVED Active Private 779.001
This IA allows the VDEF package to point-to and lookup
entries in file #779.001. This access is used to verify that VDEF Extract
Descriptions are based on existing HL7 Event Types.
4322 TASKMAN NUMBER ASSOCIATED WITH LOGICAL LINK -- RETRIEVAL File HEALTH LEVEL SEVEN 2004/08/31 APPROVED Active Private 870
This integration agreement allows the VDEF package to
retrieve the TaskMan number that is invoking a Logical Link in order to report
information about the link to the user.
4378 SD-PAIT HL LOGICAL LINK STATUS File HEALTH LEVEL SEVEN 2004/04/29 APPROVED Active Private 870
SD*5.3*333 allows for generating HL7 batches to be sent
to local VistA Interface Engines as the first step of that transmission. There
are possibilities of communication problems that would be reflected in the
status of fields in the SD-PAIT entry of the HL LOGICAL LINK - file # 870.
Fld # Fld name
4 STATE
5 IN QUEUE FRONT POINTER
6 IN QUEUE BACK POINTER
7 OUT QUEUE FRONT POINTER
8 OUT QUEUE BACK POINTER
400.01 TCP/IP ADDRESS
SD-PAIT internal entry number would be determined by accessing "B" crss
reference (IA # 3335).
4421 HLO $$RUNNING Routine HEALTH LEVEL SEVEN 2005/11/14 Pending Private
This is a private agreement that is being provided to
Pharmacy Benefit Mangement as a special consideration due to their partnering
with HLO to test and release HLO in conjunction with Pharmacy Benefit
Managment Phase III.
HLOUSR
4431 HL7 UTILITY TO VIEW MESSAGES BY PROTOCOL File HEALTH LEVEL SEVEN 2004/06/10 Withdrawn Private 773
This agreement will permit the direct read of
^HLMA(EIN, and ^HL(772 to extract message text for display on a CRT. Input is
based on the user selecting the Interface Protocol from ^ORD(101 (see IA
4429), which derives the Message Type and Event Type. The routine will search
for HL7 messages based on the Message and Event Type. The user is also
prompted for filters on Segments and text string within the segment. These
Segments are found in ^HL(772,EIN. The system will also report the EIN of any
^HLMA record that is encountered that does not have a ^HLMA(EIN,0) node or an
^HLMA(EIN,'MSH',1,0).
CSLUTPR1
4481 HLFNC3 Routine HEALTH LEVEL SEVEN 2006/02/14 APPROVED Active Private
BHS segments are not stored in the ^TMP("HLS",$J)
global when batch HL7 messages are generated. They are added by the VistA HL7
engine when the messages are sent. As the result, the application has no
access to the content of these segments.
This IA allows the subscribing package to generate the BHS segment in those
cases when access to the content of the segment is required (e.g. if the
segment should be written to a host file).
HLFNC3
4493 HL7 ERROR MESSAGE FILE File HEALTH LEVEL SEVEN 2006/02/14 APPROVED Active Private 771.7
The $$MSGSTAT^HLUTIL function returns only a code (IEN)
of the HL7 error in the 4th component. This IA allows the subscribing package
to get the corresponding error message.
4564 4564 File HEALTH LEVEL SEVEN 2005/01/08 APPROVED Active Controlled Subscription 772
This IA allows the subscribing package to search the
"C" crossreference of file HL7 MESSAGE TEXT, #772 and then get the status of
the message using VA FILEMAN.
4647 STOP/RESTART HL7 Routine HEALTH LEVEL SEVEN 2005/03/31 APPROVED Active Private
This is a IA for KIDS new auto patch utility to start
and stop HL7 background processes. In the code KIDS will make reference to
CLEAR^HLCS2, LLP^HLCS2, STARTF^HLCS2, and STRT^HLCS2. Some patches require
that HL7 processes to be stopped.
Only patches that have installation instructions to stop and re-start the HL7
processes will be set up to automatically execute (non-interactively) the
equivalent of the current options
- Stop All Messaging Background Processes [HL STOP ALL] menu option. and -
Restart/Start All Links and Filers [HL TASK RESTART]' menu option.
The new functionality provided in patch HL*1.6*126 is not included in the
automation process.
HLCS2
4669 HL7 MESSAGE ID ACCESS File HEALTH LEVEL SEVEN 2005/05/16 APPROVED Active Private 773
This IA allows the subscribing package to search the
"B" index of the HL7 MESSAGE ADMINISTRATION (#773) file and get the message ID
of the message using VA FileMan.
4716 HLO BUILD MESSAGE APIS Routine HEALTH LEVEL SEVEN 2005/08/19 APPROVED Active Supported
These APIs are used to build HLO messages.
HLOAPI 2012/12/26
4717 HLO SEND MESSAGE APIS Routine HEALTH LEVEL SEVEN 2005/08/19 APPROVED Active Supported
These APIs provide the ability to address a message
that has already been built and put it on an out-going queue for transmission.
HLOAPI1
4718 HLO PARSING APIS Routine HEALTH LEVEL SEVEN 2005/08/19 APPROVED Active Supported
These APIs are to be used by applications that receive
HL7 messages via HLO. They provide the means of stepping through batches of
messages, the message segments, and fetching data values from within segments.
HLOPRS
4722 HLO APPLICATION ACKNOWLEDGEMENT APIS Routine HEALTH LEVEL SEVEN 2005/08/19 APPROVED Active Supported
These APIs are used by applications to return
application acknowledgments to messages received via HLO.
HLOAPI2
4723 HLO APPLICATION ACKNOWLEDGEMENT APIS (CONTINUED) Routine HEALTH LEVEL SEVEN 2005/08/19 APPROVED Active Supported
These APIs are part of the set of tools that an
application uses to return an application acknowledgement to a message that
was received via HLO. See integration agreement # 4722 for the related APIs.
HLOAPI3
4724 HLO MISCELANEOUS APIS Routine HEALTH LEVEL SEVEN 2005/08/19 APPROVED Active Supported
These are APIs provided by HLO that don't fit into any
of the other categories.
HLOAPI3
4725 HLO SUBSCRIPTION REGISTRY APIS Routine HEALTH LEVEL SEVEN 2005/08/19 APPROVED Active Supported
These APIs allow applications to create and manage
entries in the HLO Subscription Registry. Each entry is basically a list of
recipients that can be used and reused to address HL7 messages. Its similar
to a mailing list. See also IA# 4726.
HLOASUB
4726 HLO SUBSCRIPTION REGISTRY APIS (CONTINUED) Routine HEALTH LEVEL SEVEN 2005/08/19 APPROVED Active Supported
This continues the APIs for HLO subscription lists.
See IA# 4725.
HLOASUB1
4727 HLO CONVERSION APIS Routine HEALTH LEVEL SEVEN 2005/08/19 APPROVED Active Supported
These utilities provide help to applications that were
developed before HLO convert to HLO. See also IA# 4728 and IA#4731.
HLOCNRT
4728 HLO CONVERSION APIS (2) Routine HEALTH LEVEL SEVEN 2005/08/19 APPROVED Active Supported
These utilities provide help to applications that were
developed before HLO convert to HLO. See also IA# 4727 and IA#4731.
HLOCVU
4730 HLO QUEUE MANAGEMENT APIS Routine HEALTH LEVEL SEVEN 2005/08/19 APPROVED Active Supported
These APIs are for applications to use in KIDS
distributions of messaging applications. They allow the application to turn
on and off individual queues during the instalation of a patch.
HLOQUE
4731 HLO CONVERSOIN APIS (3) Routine HEALTH LEVEL SEVEN 2005/08/19 APPROVED Active Supported
These utilities provide help to applications that were
developed before HLO convert to HLO. See also IA# 4727 and IA#4728.
HLOMSG
4738 OBTAINING FILE 772 POINTER VALUEFROM FILE 773 File HEALTH LEVEL SEVEN 2005/07/20 APPROVED Active Private 773
The PFSS project needs to store the pointer to the File
#772 (HL7 Message Text) record that contains the body of the HL7 message
triggered by an entry in File #375 (PFSS Account). This pointer will be used
for troubleshooting and ad hoc auditing.
In order to obtain the pointer value from the Message Id returned by the HL7
GENERATE^HLMA() API, a lookup is done on the "C" cross-reference of File #773.
The "C" cross-reference is built on Field #2, the Message Id. Using the IEN
obtained, the .01 value of the File #773 entry is retrieved. That value is
the desired pointer to the File #772 entry containing the Message Text.
4739 POINTING TO FILE 772 File HEALTH LEVEL SEVEN 2005/07/21 APPROVED Active Private 772
4742 HL7 MESSAGE PARSING APIs (PRE-HLO) Routine HEALTH LEVEL SEVEN 2005/08/29 APPROVED Active Controlled Subscription
These API's are to be used by applications that were
developed with the HL7 messaging engine that preceded the newer HL7 Optimized
messaging engine that was released in patch HL*1.6*126.
The API's provide support for applications in parsing messages. HL7 escape
sequences are decoded.
HLPRS
4744 HL7 MESSAGE PARSING APIs (PRE-HLO) (continued) Routine HEALTH LEVEL SEVEN 2005/08/29 APPROVED Active Controlled Subscription
This integration agreement completes the description of
the HL7 message parsing APIs that begins with DBIA #4742.
HLOPRS
4802 HL7 LOGICAL LINK UPDATE File HEALTH LEVEL SEVEN 2006/03/31 APPROVED Active Controlled Subscription 870
This DBIA is used to authorize the Order Entry Package
to directly set the fields of a HL7 Logical Link in file 870. The need for
this arrises from the finding that KIDS does not update these fields when a
Logical Link is sent as a component.
4804 PSU SEND File HEALTH LEVEL SEVEN 2005/10/05 APPROVED Active Private 870
Pharmacy Benefit Management is permitted to distribute
via KIDS the PSU SEND entry in the HL Logical Link file (#870). To do so, it
may:
1) Use the "B" cross-reference to find the "PSU SEND" entry's ien.
2) Read existing entries in the file, all fields.
3) Create a new entry whose .01 field is "PSU SEND", on condition that it
does not already exist.
4) Overwrite an existing entry whose .01 field is "PSU SEND".
5) The record must be updated or created via Fileman.
4805 HLO APPLICATION REGISTRY File HEALTH LEVEL SEVEN 2005/10/05 APPROVED Active Supported 779.2
Permission is given for any application to create new
entries in the HLO Application Registry file and distribute those entries via
KIDS, under these conditions:
1) The .01 field must be namespaced by the application. It is the
application's responsibility to insure that their entry is uniquely named.
2) The entry must be distributed via KIDS by selecting HLO APPLICATION
REGISTRY from the Build Components screen of the Edit a Build option.
3) Select the entry you want to distribute and select an action: SEND TO SITE
or DELETE AT SITE.
2005/10/05
4852 HLO DATA TYPE PARSERS Routine HEALTH LEVEL SEVEN 2006/06/05 APPROVED Active Supported
This provides specialized APIs for parsing HL7 data
types from a segment. It applies only to HL7 messages received via the HLO
software that was released in patch HL*1.6*126.
HLOPRS2
4853 HLO BUILDING MESSAGES WITH DATA TYPES Routine HEALTH LEVEL SEVEN 2006/06/05 APPROVED Active Supported
This provides specialized APIs for buiding messages
with HL7 data types. It applies only to HL7 messages received via the HLO
software that was released in patch HL*1.6*126.
HLOAPI4 2015/01/22
4861 DBIA4861 File HEALTH LEVEL SEVEN 2006/05/31 APPROVED Active Private 771
A one time update to set the site number in HL7's table
for the Application entry in file 771 during post install.
4915 Access to HL Logical Link (#870) file File HEALTH LEVEL SEVEN 2006/10/11 APPROVED Active Private 870
4916 HL7 Message Administration (#773) file access File HEALTH LEVEL SEVEN 2006/10/11 APPROVED Active Private 773
4917 HL MESSAGE TEXT (#772) file access File HEALTH LEVEL SEVEN 2006/10/11 APPROVED Active Private 772
4918 HL7 Application Parameter (#771) file access File HEALTH LEVEL SEVEN 2006/10/11 APPROVED Active Private 771
4919 Communication Server Parameter (#869.3) file access File HEALTH LEVEL SEVEN 2006/10/11 APPROVED Active Private 869.3
4966 DETERMINE MESSAGE ID AND DATE/TIME File HEALTH LEVEL SEVEN 2017/05/26 APPROVED Active Controlled Subscription 773
This integration agreement will be used for references
to the HL7 MESSAGE ADMINISTRATION (#773) file. Each reference by package is
included in the SUBSCRIBING DETAILS for each subscribing package.
As new requests to this file are received and approved, this integration
agreement will be updated.
2007/02/01
5066 LOOKUP IP ADDRESS FOR PACKAGE IN 870 File HEALTH LEVEL SEVEN 2008/01/08 Pending Private 870
The Enrollment Application System package (EAS) would
like to lookup an entry in file #870 using a direct read on the "B cross
reference and read data from the entry using Fileman. Here is the code being
used (in routine EAS1071A):
IPLIVE() ;Get IP address for production system
;
;Search for DENTVHLAAC logical link
S IENS=$$FIND1^DIC(870,"","X","DENTVHLAAC","","","ERR")
;If not found return null IP address
I 'IENS Q ""
;Otherwise return TCP/IP ADDRESS
Q $$GET1^DIQ(870,IENS_",",400.01)
LL16(LLNAME,TCPADDR,TCPPORT,SHUTDOWN) ;Update Logical Link Port and Address
;
N FILE,DATA,RETURN,DEFINED,ERROR,DA,DGENDA
S FILE=870
S IEN870=$O(^HLCS(870,"B",LLNAME,0))
I 'IEN870 D Q RETURN
. S ERROR="IEN OF RECORD TO BE UPDATED NOT FOUND"
. S RETURN=-1_"^"_ERROR
;
S DATA(400.01)=TCPADDR ;TCP/IP ADDRESS
S DATA(400.02)=TCPPORT ;TCP/IP PORT
S DATA(4.5)=1 ;AUTOSTART
S DATA(14)=SHUTDOWN ;SHUTDOWN LLP
;
S RETURN=$$UPD^DGENDBS(FILE,IEN870,.DATA,.ERROR)
S:ERROR'=""!(+RETURN=0) RETURN=-1_"^"_ERROR
;
Q RETURN
This is in support of the ESR v3.0 rollout in patch EAS*1*71.
5206 HLO MESSAGES (#778) file access File HEALTH LEVEL SEVEN 2008/06/03 APPROVED Active Private 778
Master Patient Index Austin is providing a PSIM messaging rate
monitor for the MPI development team on the MPI Austin production
account. We are looping on ^HLB(, the HLO MESSAGES (#778) file,
and getting the following 4 pieces of information:
.04 DIRECTION (RS), [0;4]
.07 APPLICATION ACKNOWLEDGMENT BY (F), [0;7]
.16 TRANSMISSION DATE/TIME (D), [0;16]
.2 COMPLETION STATUS (S), [0;20]
We are also looking at the "B" cross-reference to get the IEN
for ACK messages.
2008/07/25
5251 Use of Routine MPIHLO2 Routine HEALTH LEVEL SEVEN 2008/08/05 APPROVED Active Private
Master Patient Index (Austin) is requesting permission from the
HL7 developers to establish a private, temporary IA to use routine
MPIHLO2. This HL7 routine was provided by the HL7 developers, to
be installed as MPIHLO2 on the Master Patient Index (Austin).
The routine will be directly removing entries from an existing
sequence queue (^HLB("QUEUE","SEQUEUNCE","MPI LKMV") global and
placing them on an existing out queue (^HLB("QUEUE","OUT") with
the use of the OUTQUE^HLOQUE API (for more details see the routine
below). The code also resets the ^HLC status global as well.
The need for this request came from the System-of-System (SoS)
group to help address the critical backlog of messages on the
MPI HLO MPI LKMV sequence queue to PSIM. The ESR project is
scheduled to go live on 8/15/08. In order to accomplish this,
it would require that the MPI HLO queues not have a backlog of
messages. However the current backlog of messages on the MPI
will not be finished at the current rate with the current
software until 9/20/08.
The use of routine MPIHLO2 is a temporary measure that will take
all of the ADD events that are currently stacked up on one outbound
queue (Adds/Links/Moves queue) to PSIM and move them directly to the
outbound queue which will allow them to be processed simultaneously
in PSIM rather than one at a time. The implementation will guarantee
that the two databases (MPI and ADR) will stay synchronized by
shutting down the EVENT sequence queue (Add/Link/Move) until all of
the ADD events are sent and successfully processed by PSIM. Then
and only then will we resume normal processing.
This routine will only be used a few times (at most for only a few
months). After that we plan to retire it for a more permanent
solution to address the MPI to PSIM synchronization throughput issue.
NOTE: Although routine MPIHLO2 was provided/reviewed by the HL7
developers, testing and SQA is the sole responsibility of the
Master Patient Index development team.
MPIHLO2 2009/03/16
5285 DBIA5285 Routine HEALTH LEVEL SEVEN 2008/11/03 Withdrawn Private
PROVIDES A TOOL TO CONVERT MESSAGES GENERATED FOR HL7
TO MESSAGES THAT CAN BE SENT BY HLO. ALSO PROVIDES THE ABILITY TO OVERIDE
PARAMETERS DEFINED IN THE EVENT AND SUBSCRIBER PROTOCOLS.
HLOCNRT1
5290 HLO VDEF API Routine HEALTH LEVEL SEVEN 2008/11/20 APPROVED Active Private
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.
HLOAPI6 2009/07/01
5449 KERNEL BSE LOOKUP IN HL LOGICAL LINK FILE File HEALTH LEVEL SEVEN 2009/05/12 APPROVED Active Private 870
Kernel Broker Security Enhancement (BSE) requests the
ability to do a lookup within the HL LOGICAL LINK file (#870) using
FileManager and the command
D FIND^DIC(870,,".03;.08","X",L,,"C",,,"XUSBSE") where L=station#
2012/04/16
5530 READ ACCESS TO COUNTRY CODE FILE File HEALTH LEVEL SEVEN 2010/05/12 APPROVED Active Controlled Subscription 779.004
LAB SERVICE will use the CODE (#.01) and DESCRIPTION
(#2) fields in Fileman sort and print templates.
2010/11/02
5548 CALCULATE MESSAGE SIZE Routine HEALTH LEVEL SEVEN 2010/07/28 APPROVED Active Private
IFCAP requests private usage of an HL7 API to determine
message size.
HLCSUTL 2010/08/17
5603 YS MHAT LOOKUP File HEALTH LEVEL SEVEN 2011/02/12 APPROVED Active Private 870
The Mental Health package requests permission to do a
FileMan lookup on the HL LOGICAL LINK (#870) file for the YS MHAT entry. We
wish to then do a EN^DIQ call to display the field values for that record. We
do not wish to edit any of the values.
Here is our code:
CKHL7 ;check hl7 status
N DIC,DA
W @IOF,!?15,"*** HL7 Check ***",!
S X="YS MHAT",DIC=870 D ^DIC
I +Y'>0 W !,"YS MHAT ERROR" Q ;-->out
S DA=+Y D EN^DIQ
2011/02/14
5632 HL7 APPLICATION PARAMETER LOOKUP .01 File HEALTH LEVEL SEVEN 2008/01/08 APPROVED Active Private 771
ALLOWS RADIOLOGY TO READ THE .01 FILED OF THE HL7
APPLICATION PARAMETER FILE
5658 DETERMINE LOGICAL LINK BASED ON DNS DOMAIN STRING File HEALTH LEVEL SEVEN 2011/05/03 Pending Private 870
The VistA Health Level Seven application grants
permission to the VistA Radiology/Nuclear Medicine application to reference a
cross reference tied to a specific NODE (#.01) record filed in the HL LOGICAL
LINK (#870) file.
cross reference: ^HLCS(870,"AD",<LLP TYPE>,<DNS DOMAIN>,<NODE>)=""
LLP TYPE will always be "TCP". DNS DOMAIN is derived from the third component
of the Sending Facility (MSH-4) field of the MSH segment.
There is one NODE record for each unique DNS DOMAIN value.
5694 Create & Maintain Links in HL LOGICAL LINK file (#870) File HEALTH LEVEL SEVEN 2011/07/13 APPROVED Active Private 870
The LSRP software creates and configures 3 new outbound
links to the Cerner PathNet LIMS system.
LA7JAPHX - Used for Anatomic Pathology History
LA7JMFN - Used for Master File Notifications
LA7JPNET - Used for Admissions, Discharge & Transfers
During this initialization process and as part of the ongoing LSRP
maintenance, the software will perform FileMan B cross reference lookups and
allows for editing fields in the HL7 LOGICAL LINK File (#870).
The initial configuration of these links is addressed via FileMan calls during
the post installation process. All subsequent updates to any field in #870
are handled via the use of the [HL7 LOGICAL LINK] ScreenMan form and calls to
^DDS which is supported by ICR #10031.
LSRP is requesting permission to update the following list of fields during
the post installation process via FileMan and all fields in #870 via the use
of the existing [HL7 LOGICAL LINK] form.
GLOBAL REFERENCE:
^HLCS(870,
.01 NODE
.02 INSTITUTION
.08 DNS DOMAIN
1 DESCRIPTION
2 LLP TYPE
4.5 AUTOSTART
21 QUEUE SIZE
400.01 TCP/IP ADDRESS
400.02 TCP/IP PORT
400.08 TCP/IP PORT (OPTIMIZED)
"B" X-REF
2011/08/03
5695 OPEN LINK Routine HEALTH LEVEL SEVEN 2011/07/13 APPROVED Active Private
LSRP requests private usage of an HL7 API to determine
if a link can be opened.
HLOUSR1 2011/08/03
5698 HL7 Sending Facility/Logical Link relationship File HEALTH LEVEL SEVEN 2011/07/26 APPROVED Active Private 870
The VistA Radiology/Nuclear Medicine application uses
HL7 messages to communicate with the teleradiologists associated with the
National Teleradiology Program. The interface between these two applications
requires the software on the NTP side to query the VistA radiology database
when an order is received by NTP for a new patient.
The first iteration of the NTP query/Radiology response software utilized v2.3
HL7 messages and the destination of those responses was defined by the data
stored in the following two fields: TCP/IP ADDRESS (#400.01) and the TCP/IP
PORT (OPTIMIZED) (#400.08). These two fields reside within the HL LOGICAL LINK
(#870) file.
RA*5.0*107 is the second iteration of the NTP query/Radiology response
interface. This iteration will upgrade the HL7 version of the message from
V2.3 to V2.4 and the query will identify the DNS Domain (MSH-4.2) where the
responses are to be broadcast.
DNS Domain information is passed as a component of the Sending Facility
(MSH-4) field associated with the query.
The DNS Domain is then used to 'look up' the logical link record required to
complete the HL7 information transfer.
2011/08/01
5732 HLEMEU APIs Routine HEALTH LEVEL SEVEN 2011/10/17 APPROVED Active Controlled Subscription
The use of the HL7 API MSGIEN^HLEMU(message id) is
allowed per the description documented with this Integration Control
Registration.
HLEMU 2011/10/27
5733 HLOMSG1 APIs Routine HEALTH LEVEL SEVEN 2011/10/17 APPROVED Active Controlled Subscription
The use of the HL7 API FINDMSG^HLOMSG1(message id,list)
is allowed per the description documented with this Integration Control
Registration.
HLOMSG1 2011/10/27
5741 Message Status Data Retrieval from 773 File HEALTH LEVEL SEVEN 2011/10/31 APPROVED Active Private 773
The HL7 MESSAGE ADMINISTRATION file (#773) defines and maintains unique
message IDs. It conains information related to the respective message such as
Statuses and date/times.
LSRP has permission to retrieve message status information from the HL7 1.6
data structures.
2011/12/07
5742 Message Status Data Retrieval from 778 File HEALTH LEVEL SEVEN 2011/10/31 APPROVED Active Private 778
The HLO MESSAGES file (#778) records each message sent or received via HLO.
It conains information related to the respective message such as Statuses and
date/times.
LSRP has permission to retrieve message status information from the HLO data
structures.
2011/12/07
5768 COUNTRY CODE FILE File HEALTH LEVEL SEVEN 2012/02/16 APPROVED Active Supported 779.004
The HL Package grants read-only public access via
FileMan to the Country Code file (#779.004). This applies to all fields
defined in the file.
Please Note:
Per VHA Directive 2005-044, this file has been "locked down" by Data
Standardization (DS). The file definition (i.e. data dictionary) shall not be
modified. All additions, changes and deletions to entries in the file shall
be done by Enterprise Reference Terminology (ERT) using the Master File Server
(MFS), provided by Common Services (CS). Creating and/or editing locally
defined fields in the file are not permitted. Use of locally defined fields
that were created prior to the VHA Directive's 2005-044 effective date shall
not be supported.
This file is a table of country codes that are used by the Messaging System
when building message header segments.
This file should not be modified locally.
2012/04/16
5818 HLO IFCAP API Routine HEALTH LEVEL SEVEN 2012/07/18 APPROVED Active Private
The IFCAP package requests private usage of an HLO API
(PORT2^HLOTLNK) to obtain the TCP/IP PORT (OPTIMIZED) field for a record in
the HL LOGICAL LINK (#870) file.
The port obtained from the HL Logical Link record will be used to set the
PARMS("PORT") input parameter prior to calling the supported HLO API
$$SENDONE^HLOAPI1(.MSG,.PARMS,.WHOTO,.ERROR).
HLOTLNK 2012/07/23
5885 MOVESEG~HLOAPI Routine HEALTH LEVEL SEVEN 2012/11/30 Withdrawn Supported
These APIs are useful for building HL7 messages.
HLOAPI
5886 BUILDHDR~HLOPBLD1 Routine HEALTH LEVEL SEVEN 2012/11/30 APPROVED Active Supported
This API is used to build an MSH or BHS segment for an
HL7 message.
HLOPBLD1 2012/12/26
5893 RETRIEVE LINK DATA FOR PSIM File HEALTH LEVEL SEVEN 2013/01/17 APPROVED Active Private 870
The MPI will provide a new RPC for PSIM/TK to call to
retrieve HL7 Logical Link file (#870) data, specifically the DNS DOMAIN
(#.08), TCP/IP address (#400.01) and TCP/IP Port (#400.02) for a specified
VistA instance or for all VistAs. Name: MPI HL7 LOGICAL LINK DATA Pass in
"ALL" or Station Number Returned: Station Number^DNS Name^TCP/IP
Address^TCP/IP Port for each entry required. If there isn't a link for that
station number, return error message.
No write to the records, only retrieving data using FileMan API, $$GET1^DIQ,
from entries of file #870 in the MPI account:
GLOBAL REFERENCE:
^HLCS(870,
.02 INSTITUTION
.08 DNS DOMAIN
400.01 TCP/IP ADDRESS
400.02 TCP/IP PORT
"C" X-REF
2013/01/22
6103 HLO MESSAGE BODY (#777) direct global read File HEALTH LEVEL SEVEN 2014/09/08 APPROVED Active Private 777
The VistA Health Level Seven application will grant
VistA Imaging the privilege to read the HLO MESSAGE BODY (#777) global
directly.
2015/01/12
6122 HLB OUT POINTER X-REF File HEALTH LEVEL SEVEN 2014/11/03 APPROVED Active Controlled Subscription 778
VA POINT OF SERVICE (KIOSKS) is providing patient
appointment status using HL7 messaging, and needs to use the
^HLB("QUEUE","OUT",LINKPORT,QUEUE) global reference to lock and unlock an
active VPS message queue.
2015/03/20
6123 DOWORK HLOCLNT Routine HEALTH LEVEL SEVEN 2014/11/03 Withdrawn Controlled Subscription HLOCLNT
6124 CLOSE HLOT Routine HEALTH LEVEL SEVEN 2014/11/05 Withdrawn Controlled Subscription HLOT
6176 HLCS 870 B CROSS REFERENCE File HEALTH LEVEL SEVEN 2015/03/06 APPROVED Active Controlled Subscription 870
VA POINT OF SERVICE (KIOSKS) uses the
^HLCS(870,"B",LINK,0) and ^HLCS(870,IEN,400) cross references to obtain the
internal entry number of the VPS HL Logical Link and the ports for message
transmission.
2015/03/20
6177 HLO DEQUE Routine HEALTH LEVEL SEVEN 2015/03/06 Withdrawn Controlled Subscription HLOQUE
6349 Modify HL7 Version File File HEALTH LEVEL SEVEN 2016/02/02 APPROVED Active Private 771.5
Check for existence of version 2.6 in the HL7 VERSION
(771.5) File. If it is missing add via call to FILE^DICN during the package
pre-installation routine. The following entries will be added:
.01 VERSION 2.6
2 STANDARD HEALTH LEVEL SEVEN
This ICR is temporary and only applicable to IB*2.0*547. The changes will be
overwritten by HL*1.6*164. It will be retired when the patch has been
nationally released and the compliance window and warranty periods have
elapsed.
2016/03/02
6350 Modify HL7 Message Type File File HEALTH LEVEL SEVEN 2016/02/02 APPROVED Active Private 771.2
Check for existence of Message Type EHC in the HL7
MESSAGE TYPE (771.2) File. If it is missing add via call to FILE^DICN during
the package pre-installation routine. The following entries will be added:
.01 ABBREVIATED NAME EHC
2 FULL NAME Health Care Invoice
3 VERSION 2.6
This ICR is temporary and only applicable to IB*2.0*547. The changes will be
overwritten by HL*1.6*164. It will be retired when the patch has been
nationally released and the compliance window and warranty periods have
elapsed.
2016/03/02
6351 Modify the HL7 Event Type Code File File HEALTH LEVEL SEVEN 2016/02/02 APPROVED Active Private 779.001
Check for existence of Event Type Code E12 in the HL7
EVENT TYPE CODE ( 779.001) File. If it is missing add via call to FILE^DICN
during the package pre-installation routine. The following entries will be
added:
.01 CODE E12
2 DESCRIPTION Request Additional Information
100 VERSION 2.6
This ICR is temporary and only applicable to IB*2.0*547. The changes will be
overwritten by HL*1.6*164. It will be retired when the patch has been
nationally released and the compliance window and warranty periods have
elapsed.
2016/03/02
6352 Modify the HL7 Message Structure Code File File HEALTH LEVEL SEVEN 2016/02/02 APPROVED Active Private 779.005
Check for existence of Message Structure Code EHC_E12
in the HL7 MESSAGE STRUCTURE CODE (779.005) File. If it is missing add via
call to FILE^DICN during the package pre-installation routine. The following
entries will be added:
.01 CODE EHC_E12
2 DESCRIPTION E12
3 VERSION 2.6
This ICR is temporary and only applicable to IB*2.0*547. The changes will be
overwritten by HL*1.6*164. It will be retired when the patch has been
nationally released and the compliance window and warranty periods have
elapsed.
2016/03/02
6409 Access to HLCS(870) File HEALTH LEVEL SEVEN 2016/05/20 APPROVED Active Controlled Subscription 870
Update all the logical links that use Vista Interface
Engine (VIE) to transmit HL7 messages to be replaced by VA Enterprise
Messaging Infrastructure (VA eMI).
The process to replace VIE to eMI will be to update the DNS DOMAIN field in
file 870, HL LOGICAL LINK, for existing logical links.
Revision History:
1/13/25: Added field 400.08, TCP/IP PORT (OPTIMIZED) for use by IB*2*769
patch - IB COPAY ACCUMULATION CONTINUE
2016/06/02
6429 PSO use of TCP/IP, Domain, and TCP/IP Port File HEALTH LEVEL SEVEN 2016/07/18 Retired Private 870
The Outpatient Pharmacy package is in need of modifying
the DNS DOMAIN, TCP/IP ADDRESS, and TCP/IP PORT of the HL LOGICAL LINK file
(#870). Outpatient Pharmacy will also be looking at the 'B' index for the IEN
of the new logical link named PSORRXSEND.
This ICR is a one-time agreement for PSO*7.0*454.
6598 HL7 APPLICATION PARAMETER FILE ACCESS File HEALTH LEVEL SEVEN 2016/11/04 Withdrawn Private 771
The Advanced Prosthetics Acquisition Tool (APAT) requests read access to
the HL7 APPLICATION PARAMETER file. Reading this field will allow APAT to
determine if the HL7 application associated with the HL7 interface
is active or not. If the HL7 application is not active, the call to
the HL7 interface will quit, thus avoiding needless processing.
6798 UPDATE STATUS OF HL7 MESSAGE Routine HEALTH LEVEL SEVEN 2017/07/24 Pending Private
This ICR will update the status of the entry in the
Message Text File and log an event for errors.
HLTF0
6799 GENERATE OUTGOING HL7 MESSAGE Routine HEALTH LEVEL SEVEN 2017/07/24 Pending Private
This ICR allows the creation of an outgoing HL7 message
and returns a value if there is an error while creating the message.
HLTP
6800 HL7 DE-ESCAPE DELIMITERS Routine HEALTH LEVEL SEVEN 2017/07/24 Pending Private
This ICR will allow the conversion of HL7 escape
characters to original characters including field separator, component
separator, repetition separator, escape characters, and subcomponent
separator.
HLTPCK2A
6832 GET NUMBER OF FILERS Routine HEALTH LEVEL SEVEN 2017/11/13 Pending Private
GET NUMBER OF FILERS will return the number of filers
that are currently running.
HLCSUTL2
6865 HLOASUB1 Routine HEALTH LEVEL SEVEN 2018/01/19 Pending Private 779.2
Radiology needs access to clean up radiology entries
from file HLO APPLICATION REGISTRY as KIDS does not have delete logic in place
for the 'Delete at Site' action on this file. A ticket [I18129151FY18] has
been submitted for this issue.
HLO Application Registry File access is needed for patch RA*5.0*144.
HLOASUB1
6877 Read access to HL7 Message Text file for capacity planning. File HEALTH LEVEL SEVEN 2018/02/22 APPROVED Active Private 772
The purpose of this IA is to allow packages to read the
HL7 Message Text (#772) file directly. KMP routines will aggregate message
metrics for analysis and capacity planning.
2018/03/08
6878 Read access to FILE 773 for capacity planning. File HEALTH LEVEL SEVEN 2018/02/22 APPROVED Active Private 773
The purpose of this IA is to allow packages to read the
HL7 Message Administration (#773) file directly. KMP routines will aggregate
message metrics for analysis and capacity planning.
2018/03/08
6882 Read access to HLO Message Body file for capacity planning File HEALTH LEVEL SEVEN 2018/02/26 APPROVED Active Private 777
The purpose of this IA is to allow subscribing packages
to read the HLO Message Body (#777) file directly. KMP routines will
aggregate message metrics for analysis and capacity planning.
2018/03/09
6883 Read access to HLO Messages file for capacity planning File HEALTH LEVEL SEVEN 2018/02/26 APPROVED Active Private 778
The purpose of this IA is to allow subscribing packages
to read the HLO Messages (#778) file directly. KMP routines will aggregate
message metrics for analysis and capacity planning.
2018/03/09
6884 GMRC UPDATE TO THE APPLICATION PARAMETERS FILE File HEALTH LEVEL SEVEN 2018/03/05 Withdrawn Private 771
GMRC is requesting a one time update to set the site
number in the HL7's table for the Application Parameter entry in the HL7
APPLICATION PARAMETER FILE (#771) during the post install of patch
GMRC*3.0*99.
GMRCPOST99
6885 GMRC UPDATE TO THE HL LOGICAL LINK FILE File HEALTH LEVEL SEVEN 2018/03/05 Pending Private 870
GMRC requests a one time update as part of the patch
GMRC*3.0*99 post install to make an update to the HL LOGICAL LINK FILE (#870)
to add the INSTITUTION (#.02), DNS DOMAIN (#.08), AUTO START (#4.5), TCP/IP
ADDRESS (#400.01), TCP/IP PORT (#400.02) to the GMRCHCP Link entry.
6909 HL LOWER LEVEL PROTOCOL TYPE File HEALTH LEVEL SEVEN 2018/04/18 Pending Private 869.1
This IA allows WATCHDOG to verify the HL LOWER LEVEL
PROTOCOL TYPE prior to submitting the Protocol to taskman. The IA will access
the BACKGROUND ROUTINE and ENVIRONMENT CHECK ROUTINE in order to verify the
processing routine and run the environment check routine prior to submitted
the task.
6925 HLO SUBSCRIPTION REGISTRY (#779.4) READ NAME (#.01) FIELD File HEALTH LEVEL SEVEN 2018/06/14 APPROVED Active Controlled Subscription 779.4
With the release of MAG*3.0*208 the VistA Imaging
application requests the permission to read the name of the HLO SUBSCRIPTION
REGISTRY record.
2018/06/14
7551 HLVSM APIs Routine HEALTH LEVEL SEVEN 2025/04/28 APPROVED Active Private
The purpose of this routine is to provide read-only
APIs returning HL7 operational status.
The VistA System Monitor (VSM) will use this data to display this operational
state data in a real-time VistA Operations Dashboard. VSM functionality
consuming these APIs will initially be deployed via patch KMP*4.0*5.
HLVSM 2025/04/29
7572 INCOMING FILER TASK NUMBERS File HEALTH LEVEL SEVEN 2025/07/21 Active Private 869.3
10106 HLFNC Routine HEALTH LEVEL SEVEN APPROVED Active Supported HLFNC
10107 HLFNC1 Routine HEALTH LEVEL SEVEN APPROVED Active Supported HLFNC1
10108 HLTF Routine HEALTH LEVEL SEVEN 2001/10/05 APPROVED Active Supported HLTF
10109 HLTRANS Routine HEALTH LEVEL SEVEN APPROVED Active Supported HLTRANS
10110 HL7 NON-DHCP APPLICATION PARAMETER File HEALTH LEVEL SEVEN APPROVED Active Supported 770
File 770 may be accessed only during package post
initialization. The creation of new entries must be cleared through the HL7
development team. New entries may be added with a call to FILE^DICN and a
call to IX1^DIK.
10136 HL7 APPLICATION PARAMETER File HEALTH LEVEL SEVEN 2025/03/19 APPROVED Active Supported 771
The creation of new entries must be cleared through
Technical Integration by sending review materials to icrs@va.gov. New entries
may be exported using KIDS.
2025/03/19
10137 HL7 SEGMENT NAME FILE File HEALTH LEVEL SEVEN APPROVED Active Supported 771.3
File 771.3 may be accessed only during package post
initialization. The creation of new entries must be cleared through the HL7
development team. New entries may be added with a call to FILE^DICN and a
call to IX1^DIK.
10138 HL7 TRANSMISSION FILE File HEALTH LEVEL SEVEN APPROVED Active Supported 772
Files 770, 771, and 771.3 may be accessed only during
package post initialization. The creation of new entries must be cleared
through the HL7 development team. New entries may be added with a call to
FILE^DICN and a call to IX1^DIK.