All ICR List

Package: Kernel 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
1 DBIA1 Other KERNEL 1989/07/27 APPROVED Active Private 2000/01/01
2 DBIA2 Other KERNEL 1989/07/27 APPROVED Active Private
3 DBIA3 Other KERNEL 1989/07/27 APPROVED Active Private
Using the following variables: DT= Date DTIME = Read
timeout DUZ = User and paramaters in the DUZ array
4 DBIA4-A File KERNEL 1989/07/27 Retired Private
5 DBIA5-A File KERNEL 1989/07/27 Retired Private 19
7 DBIA7 File KERNEL 1989/07/27 APPROVED Active Private
Uses variables DX and DY to call %ZOSF and global %ZOSF
to get system specific variables.
10 DBIA10 File KERNEL 1990/03/12 APPROVED Active Private 40.5
USE OF THE HOLIDAY FILE, ^HOLIDAY
26 DBIA26 File KERNEL 1989/05/08 APPROVED Active Private
40 DBIA40 File KERNEL 1989/02/10 Retired Private 16
File 16 (old Person File) exported with version 3 of
Patient Funds.
42 DBIA42 File KERNEL 1990/06/06 APPROVED Active Private 4
LAYGO to the Institution File is allowed through an
option in the MCCR module.
58 DBIA58 File KERNEL 1990/11/27 APPROVED Active Private 200
66 DBIA66 File KERNEL 1990/11/25 Retired Private 16
Part of file 16 is exported with IFCAP THIS AGREEMENT
SHOULD END BY LATE 1992.
79 DBIA79 Other KERNEL 1991/02/05 Retired Private
Permission has been granted for Health Summary to
export the routines:
XQOR as GMTSXQ01
XQOR1 as GMTSXQ02
XQOR2 as GMTSXQ03
XQOR3 as GMTSXQ04
XQOR4 as GMTSXQ05
XQORM as GMTSXQ06
XQORM1 as GMTSXQ07
XQORM2 as GMTSXQ08
XQORM3 as GMTSXQ09
XQORM4 as GMTSXQ10
XQORM5 as GMTSXQ11
XQORMX as GMTSXQ12
XQORO as GMTSXQ13
GMTSPOST, the Health Summary post-init, will rename GMTSXQ* as the
corresponding XQOR* routines if and only if the version of XQOR found in the
account is less than 6.52.
82 DBIA82 Routine KERNEL 1991/05/15 Retired Private
To facilitate selection and collection of multiple
items, a call is made to EN^XQORM with XQORM as a required variable in
addition to the variables supported from ^XQOR (see supported references).
XQORM
98 DBIA98-A Other KERNEL 1991/03/20 APPROVED Active Private
Version 5.1 of the laboratory package has a temporary
agreement for the following:
1) To save system $Z variables in local variables for storage in our error
trap.
When Kernel release their error trapping system, Lab will convert to the
Kernel supported methodology.
100 DBIA100 File KERNEL 1991/09/25 APPROVED Active Private 200
The agreement consists of the following:
1) The Credentials Tracking module will incorperate fields in the NEW
PERSON file within the field number range of 747-747.999. Data node for these
fields will be in the QAR namespace (ex. QAR1, QAR17, etc). Sub-data
dictionary numbers will be within the 200.0747-200.074799999 range. The right
is reserved to use the QAR and AQAR prefix for any cross-reference indicies.
2) The Credentials Tracking module will export a "clean" partial data
dictionay for file 200. This partial will include only the 747 number spaced
fields and the .01 name field.
The partial was created in an environment that contained only the 747
numberspaced fields and a partial of the .01 name field. The .01 name field
contains only the basic field definition, "B" cross- reference (only), and the
input transform. All other fields and information were deleted.
119 DBIA119 File KERNEL 1991/10/31 APPROVED Active Private
Routine PRCFQ uses the following extrinsic function to
determine whether Taskman is runnig:
TM() ;extrinsic function--is taskman running?
N ZTH,ZTR S ZTH=$H,ZTR=$S(^%ZTSCH("RUN"))#2:^("RUN"),1:"")
Q ZTH-ZTR*86400+$P(ZTH,",",2)-$P(ZTR,",",2)<500
Till otherwise agreed, or release of Kernel 8
122 DBIA122 File KERNEL 1991/10/06 Retired Private 200
Fields in the NEW PERSON File for OE/RR
100.11 PRIMARY OE/RR MENU 100.12 PRIMARY ORDER MENU 100.13 PRIMARY ORDER
DISPLAY FORMAT 100.14 PRIMARY WARD 100.15 PRIMARY PATIENT LIST 100.16 SELECT
PATIENT DEFAULT 100.17 PRIMARY CLINIC 100.18 DEFAULT CLINIC START DATE 100.19
DEFAUTL CLINIC STOP DATE 100.21 SUMMARY DEFAULT 100.22 PATIENT LIST ORDER
100.23 PATIENT LIST PROCESS 100.24 PRIMARY PROFILE MENU 100.25 PRIMARY
PROVIDER 100.26 PRIMARY SPECIALTY 100.27 NEW ORDERS DEFAULT
128 DBIA128-A File KERNEL 1991/11/20 APPROVED Active Private 200
New Bill and Edit Bill options have been modified to
prompt the user "Edit Debtor Address" after he/she has entered/edited the
bill. This prompt as well as the Edit AR Debtor Address option allow edits to
the NEW PERSON and INSTITUTION file.
The fields edited include:
for NEW PERSON file ^VA(200,
1) .111 - Street Address 1
2) .112 - Street Address 2
3) .113 - Street Address 3
4) .114 - City
5) .115 - State
6) .116 - Zip Code
7) .131 - Phone
The edits would also be transposed in the PERSON file (^DIC(16)).
Please keep in mind that "all users" with access to the Billing menu will be
able to edit the debtor address fields (option 2).
144 DBIA144 File KERNEL 1992/02/18 APPROVED Active Private 19.1
A patch (pre-release of Inpatient Meds V4) containing new keys will add the
new keys to File #19.1, field .01 name. Then based on the present version, it
will preload key holders for the new keys into the 'Holder' multiple (19.12)
For Inpatient Medications V4 only.
167 DBIA167 File KERNEL 1992/06/15 APPROVED Active Private 19
1. Agreement to point to the Option File from the Request Services File
(123.5). This will be used to establish security for service updating
based on the option entered. Two special options are distributed with
the Consult/Request Package which are specific to the Packages
users for Pharmacy and Medicine. The GMRC initialization process sets
up the option/service relationships for IRM in the Request Services
File (123.5).
2. Agreement to use the XQY and XQY0 variables to determine which option
the user used to get to the "Select Action: " logic for a given
service.
169 DBIA169-A Routine KERNEL 1992/06/17 Retired Private
The Consult/Request Tracking package populates the
Protocol File (101) with protocol items representing responses to prompts.
These responses are selectable via calls to the Menu Utility, XQORM, routines.
For example, "Select Action: ", "Place of Consultation: ", and "Urgency: "
prompts all use the XQORM routines to handle the users response. Variable,
XQORM("NO^^"), has been added for those responses that it is inappropriate to
"^^" jump.
Variables set to call XQORM
XQORM=variable pointer to Protocol File (101) entry. The Protocol File
entries specified are all Protocol Menu Type entries.(e.g., GMRCPLACEM -
INPATIENT is the Protocol Name of a distributed Protocol Menu used at "Place
of Consultation: " prompts.)
XQORM("NO^^")="" When defined, this variable tells XQORM not to allow "^^"
jumping at the prompt.
XQORM(0)=This controls the display and prompting of the menu. XQORM(0) may
contain a number, and/or letters A,D, and F. If there is a number, it must
always be at the beginning of the string. The parameters do the following:
#: maximum number of selections allowed. If there is no number, as many
selections as menu items are allowed.
A: The user will be prompted to make a selection.
D: The menu will be displayed.
F: Selection will NOT be saved in ^DISV.
For example, XQORM(0)="2A" will allow the user to make a maximum of two
selections. The menu will not be displayed (unless a ? is typed), and the
selections will be saved in ^DISV.
XQORM("A")=Text here will be used as the select prompt.
XQORM("B")=Text here will be used as the default menu selection.
XQORM("?")=MUMPS code that replaces the standard help.
XQORM("S")=(Not used by Consult/Request Tracking) MUMPS code that will
screen the items on the menu.
XQORM
170 DBIA170 File KERNEL 1992/06/17 APPROVED Active Private 200
Agreement is made to allow the AMIE package to make
references to ^VA(200,DA(1),2,DA) directly. Generally lookup into ^VA(200 is
blessed. Any changes to security/access information is NOT blessed. Such
items of concern are: NAME, FILEMANAGER ACCESS, ACCESS CODES, VERIFY CODES,
PRIMARY & SECONDARY MENUS, SECURITY KEYS, and FILE ACCESS list.
177 DBIA177 Other KERNEL 1992/06/18 APPROVED Active Private
Progress Notes has permission to place the XUSESIG
option on one of its menus during export.
178 DBIA178 Other KERNEL 1992/06/18 APPROVED Active Private
OR/RR has permission to place the XUSESIG option on one
of its menus during export.
200 DBIA200 File KERNEL 1992/12/14 APPROVED Active Private 200
The ADP USER file 497.2 may have its top level .01
field DINUMed to the NEW PERSON file 200. The ADP USER file is limited to
distribution to the ISCs.
224 DBIA224 File KERNEL 1993/04/21 APPROVED Active Private 200
Outpatient Pharmacy is given permission by Kernel to
make calls to the following:
GLOBAL MAP DATA DICTINARY #200 -- NEW PERSON FILE 2/25/93 STORED
IN ^VA(200, SITE: ISC BIRMINGHAM (VERSION 6.5)
----------------------------------------------------------------------
^VA(200,D0,PS)= (#53.1) AUTHORIZED TO WRITE MED ORDERS [1S] ^ (#53.2)
==>DEA# [2F] ^ (#53.3) VA# [3F] ^ (#53.4) INACTIVE DATE [4D] ^
==>(#53.5) PROVIDER CLASS [5P] ^ (#53.6) PROVIDER TYPE [6S] ^
==>(#53.7) REQUIRES COSIGNER [7S] ^ (#53.8) USUAL COSIGNER
==>[8P] ^ (#53.9) REMARKS/COMMENTS [9F] ^
^VA(200,D0,PS1,0)=^200.541P^^ (#54.1) LICENSING STATE ^VA(200,D0,PS1,D1,0)=
(#.01) LICENSING STATE [1P] ^ ^VA(200,D0,PS2,0)=^200.55P^^ (#54.2) STATE
ISSUING DEA NUMBER ^VA(200,D0,PS2,D1,0)= (#.01) STATE ISSUING DEA NUMBER [1P]
^
^VA(200,D0,TPB)= (#53.91) NON-VA PRESCRIBER [1S] ^ (#53.92) EXCLUSIONARY
==>CHECK PERFORMED [2S] ^ (#53.93) DATE EXCLUSIONARY LIST
==>CHECKED [3D] ^ (#53.94) ON EXCLUSIONARY LIST [4S] ^ (#53.95)
==>TAX ID [5F] ^ (#53.96) EXCLUSIONARY CHECKED BY [6P:200] ^
230 DBIA230 Other KERNEL 1993/05/18 APPROVED Active Private
MailMan V7 has permission to make the following calls to Kernel:
1. The modules affected by this agreement are in the namespace:
o Device Handler (ZIS* & %ZIS*, not ZISL* & %ZISL*)
2. REQ^%ZTLOAD is called in the following manner to ensure a back-up task
exists if this one should fail:
I $L(ION) S ZTIO(1)="D",ZTIO=ION D REQ^%ZTLOAD
The result of this call leaves the task in the IO queue for the device it is
running on (and no other, even if the device is a member of a hunt group).
3. The Kernel Site Parameters file contains fields that are used by modules
in Kernel other than MailMan. The MailMan development team will maintain the
file and will reserve fields and field numbers in the range of 3000 to 3999
for the use of this module. No alpha subscripts will be used by non-MailMan
kernel packages without agreement from the MailMan development team except for
those already in use and noted below. The exception to the above are nodes
beginning with the Kernel namespace (ZI) which is reserved for this kernel
packages and cross references beginning with any letter, but having the above
namespace immediately follow that letter (EG. AZI5).
Any changes to this file require the notification of the MailMan development
team. A method for ensuring that the distribution of the file by MailMan will
then be negotiated.
The fields that are currently in use and are not *'ed for removal within 18
months are: (#=multiple)
Field Number # Description node;piece
31.1 Max spool lines SPL;1 31.2 Max
spool documents SPL;2 31.3 Max spool doc life
SPL;3
4. By agreement files 3.51, Spool Document [in ^XMB(3.51,] and file 3.519,
Spool Data [in ^XMBS(3.519,] can continue to exist in the MailMan namespaced
globals.
231 DBIA231 Other KERNEL 1993/05/18 APPROVED Active Private
MailMan V7 has permission to make the following calls
from Kernel Task Manager V7:
1. The Kernel modules that this document refers to are:
o Task Management (ZTM* and %ZTM*)
2. REQ^%ZTLOAD is called in the following manner to ensure a back-up task
exists if this one should fail:
I $L(ION) S ZTIO(1)="D",ZTIO=ION D REQ^%ZTLOAD
The result of this call leaves the task in the IO queue for the device it is
running on (and no other, even if the device is a member of a hunt group).
3. The routine XMS5 tries to confirm that tasks exist by looking at:
$D(^%ZTSK(task,0)) ==> if the node exists the task exists
$D(^%ZTSCH("TASK",task)) ==> If the node exists, the task is running
"12345AG"[%ZTSCH("TASK",.1) $D(^%ZTSCH("IO",device,$h,task)) ==> The task is
scheduled
4. MailMan 7 looks at ^%ZTSK(task,"C",0) for a count of the times the task has
run. The next version will not use this any more.
232 DBIA232 File KERNEL 1993/05/18 APPROVED Active Private 200
The Inpatient Medications package requests a DBA
exemption to allow the .01 field of the INPATIENT USER PARAMETERS file (53.45)
to point to the NEW PERSON file (200). This file contains fields that are used
by Inpatient Medications to store data used in the order entry process, and
has been DINUMED to the NEW PERSON file as recommended in the peer review, to
allow these fields to be more easily moved to 200 if necessary in a future
release.
234 DBIA234 Other KERNEL 1993/05/18 APPROVED Active Private
Mailman is given permission to make the following calls
to Kernel:
1. CHK^XM is an entry point set aside only for calls external from MailMan.
It is used by KERNEL routines to notify users of new messages for a user
during logon or as invoked from MenuMan. XMDUZ is used if supplied, otherwise
DUZ is a pointer to the user's Mailbox. The symbol table of the caller is
changed as the code currently stands. Y is output as a count of new messages.
% and D are also used and not killed by MailMan. The Kernel security routine
will continue to use this entry point, which also is necessary to make sure
that ^TMP("XMY",$J) is cleaned out on login and ensures that when job numbers
are reused after reboot, there is not data in ^TMP("XMY",$J) to include
recipients from old mail sessions in currently generated bulletins that come
from outside of MailMan. An example is the 'Dropping into Programmer Mode
bulletin'.
2. ^XM may be called in order to offer MailMan as a service directly to
users on logon.
3. The XMUSER and XMMGR menus may be used in high level menu structures.
4. Kernel modules to which this document refers are (even if they are at
some point separated from the Kernel and become independent modules of their
own) are System security (XU* and XT*).
5. Kernel security and user related modules currently can call NEW^XM to set
up an new user's or reactivated user's mail box. The entry point uses the
variables I, Y and K destructively. If it is called for a user who is being
reactivated, that user will not receive responses to messages he is a
recipient of and were created before his reinstatement, unless he is
explicitly forwarded them, or he 'owns' the original message in one of his
mail boxes.
6. XMPC is called by the Kernel routine comparer. All the proper set-up has
been done and MailMan will coordinate any changes in this area with the
programmer responsible for Kernel Utilities.
7. Kernel directly references the 5th piece of the Mail Basket multiple of
the Mail Box file (3.7) to get the number of messages in a mail basket.
8. Kernel directly references the 6th piece of the zero node of the Mail Box
file (3.7) to get the number of new messages in a mail box
9. There are some data fields in the Mail Box file (3.7) that are not used
in MailMan. They are used by sign-on security and should be maintained by
sign-on security routines also.
field # Description node;piece
20 Last Sign-on Date/Time .1;1
21 Last Terminal Type Used .2;1
22 Already Signed On To Devices 100 (multiple)
10. The Kernel Site Parameters file contains fields that are used by modules
in Kernel other than MailMan. The MailMan development team will maintain the
file and will reserve fields and field numbers in the range of 1000 to 1999
for the use of this kernel module. No alpha subscripts will be used by
non-MailMan kernel packages without agreement from the MailMan development
team except for those already in use and noted below. The exception to the
above are nodes beginning with the namespaces (XU amd XT) which are reserved
for non-MailMan kernel packages and cross references beginning with any
letter, but having the above namespaces immediately follow that letter (EG.
AXT5).
Any changes to this file require the notification of the MailMan development
team. A method for ensuring that the distribution of the file by MailMan will
then be negotiated.
Field Number # Description node;piece
11 Auto-generate access codes 3;1
12 User char Template 3;2
202 Default number of attempts XUS;2
203 Default lock-out time XUS;3
204 Default Multiple sign-ons XUS;4
205 Ask device at sign-on XUS;5
209 Default type-ahead XUS;9
211 Bypass Device lock-out XUS;10
212.1 Device to audit 4.33 (subfile)
240 INTRO text INTRO
241 DBIA241-A File KERNEL 1993/06/15 APPROVED Active Private 4
251 DBIA251-A File KERNEL 1993/07/20 APPROVED Active Private 3.5
Clinical Monitoring System and Kernel have entered into
an agreement for access to the following data: The "B" cross-reference of the
device file. (To check that a free- text pointer value is still valid.)
264 DBIA264 Other KERNEL 1993/08/10 APPROVED Active Private
VA FileMan has permission to export the Package file
and to update entries in the Package file for exporting and importing
packages.
267 DBIA267 Other KERNEL 1993/08/25 APPROVED Active Private
The PDX team is granted permission to add the following
protocols to the protocol file ^ORD(101. We also request permission to use
all generic protocols as listed in the List Managers development guide. The
protocol names are:
1 VAQ ADD PATIENT Add Patient
2 VAQ ADD/EDIT REQUEST Add/Edit Request
3 VAQ CHANGE PATIENT Change Patient
4 VAQ COPY REQUEST Copy Request
5 VAQ CREATE REATE REQUEST Create Request
6 VAQ DIS ALL SEGMENT Display all
7 VAQ DIS SELECTED SEG Display Selected
8 VAQ DIS1 (MENU) List Request Options
9 VAQ DISPLAY PDX Display PDX
10 VAQ DISPLAY SELECT Select Entry
11 VAQ DUPLICATE Select Entry
12 VAQ LOAD DATA Load Data (all)
13 VAQ LOAD EDIT Load/Edit
14 VAQ LOAD FIELD Load Field(s)
15 VAQ NEW PATIENT New Patient
16 VAQ PDX1 (MENU) CUSTOM ENTRIES FOR PDX1
17 VAQ PDX11 (MENU) MENU FOR DISPLAY SEGMENT
18 VAQ PDX12 (MENU) MENU OPTIONS FOR PDX DISPLAY
19 VAQ PDX2 (MENU) CUSTOM ENTRIES FOR PDX2
20 VAQ PDX3 (MENU) custom entries for PDX3
21 VAQ PDX4 (MENU) VAQ PDX4 MANUAANUAL PROCESS
22 VAQ PDX5 (MENU) VAQ LED STATUS MENU
23 VAQ PDX6 (MENU) VAQ LED DIFFERENCES MENU
24 VAQ PDX7 (MENU) VAQ LED ADD PT MENU
25 VAQ PDX8 (MENU) VAQ LED POSSIABLE MATCH MENU
26 VAQ PDX9 (MENU) OPTIONS MENU FOR PDX REQUEST
27 VAQ PROCESS MANUAL Procecess Manual
28 VAQ PROCESS REJECT Reject W/Comment
29 VAQ PROCESS RELEASE Release W/Comment
30 VAQ TRANSMIT REQUEST Transmit Request
275 DBIA275-A File KERNEL 1993/09/09 Retired Private 101
Purpose:
Request an integration agreement between the Discharge Summary Team and the
OE/RR Team at the Salt Lake ISC for Discharge Summary version 1.0: 1. to
access protocol descriptions by direct reference to the ^ORD(101, and 2.
permission to call ^XQORM as described below.
Description: To allow the user to get a detailed description of the actions
that are executable from each of our menu-type protocols, we need to be able
to $ORDER through the subscript ^ORD(101,DO,10,D1,0) to get sub-fields #1
(ITEM) and # 3 (SEQUENCE) of the 101.01 multiple for each ITEM. Then get
field #1 (ITEM TEXT) and #3.5 (DESCRIPTION) for each PROTOCOL encountered in
the ITEM MULTIPLE for a given menu. To allow the user to retrieve Discharge
Summaries into the review screen based on Signature Status and Search Category
(e.g., by PATIENT, PROVIDER, or TREATING SPECIALTY), we need to be able to
execute a DIC call on file 101 to retrieve the zero node of a record and to
reference field # 24 (SCREEN) in order to set up the local variables to be
used to execute the ^XQORM call.
289 DBIA289-A Other KERNEL 1993/10/12 APPROVED Active Private
Manage Security Keys [GMRD KEY -------1 Allocation of
Security Keys MANAGEMENT] [XUKEYALL]
|---------------------------------2 De-allocation of Security Keys
| [XUKEYDEALL]
|---------------------------------3 Delegate keys [XQKEYDEL]
|---------------------------------4 Remove delegated keys
| [XQKEYRDEL]
------------------------------------------------------------------------
|---------------------------------5 List users holding a certain
key [XQSHOKEY]
Discharge Summary will export the above menu until a corresponding delegatable
menu is provided in Kernel. Discharge Summary will indicate in its manuals
(User, Technical, and Security), references to the appropriate Kernel
chapters, and indicate that keys cannot be allocated (for end user use) until
they are delegated to the person doing the allocating. And IRM must delegate
individual keys before a delegated key can be delegated or allocated.
DURATION: Till otherwise agreed--UNTIL KERNEL CHANGES MENU
290 DBIA290-A File KERNEL 1993/10/12 APPROVED Active Controlled Subscription 3.5
=============================================================
Field 33, Unauthorized Claim Printer, in file 161.4 (Fee Basis Site Parameters
file) references the device (%ZIS(1) and terminal type (%ZIS(2) files in the
Input transform (extrinsic function), Executable help (routine call) and
Screen. Fee routine is FBUCDD1.
The Screen is: S DIC("S")= "S
Z=$G(^%ZIS(1,+Y,""SUBTYPE"")),Z=$G(^%ZIS(2,Z,0)) I $E($P(Z,U),1)=""P""K Z"
Global references in the routine calls are:
%ZIS(1,"B" %ZIS(1,ien,0 (XHELP only)
%ZIS(1,ien,"SUBTYPE" %ZIS(1,ien,1 (XHELP only)
%ZIS(2,ien,0
where $E(0 node,1)="P" is checked
295 DBIA295 Other KERNEL 1993/10/21 APPROVED Active Private
Integration Agreement Request between Toolkit (all
versions) and Kernel (all versions).
Toolkit and Kernel agree that both packages shall distribute all routines and
data for M operating system interfaces (e.g. ZOSF, ZOSV*, ZTBK). These two
packages also agree that both shall distribute the function library as
designated by the routine namespace XLF.
Toolkit and Kernel also agree that the menus, XUPROG, XTMENU, and XUCM MAIN,
can be attached to the Kernel menu EVE.
305 DBIA305 File KERNEL 1993/10/27 APPROVED Active Private 4.281
MailMan should be allowed the use of the %ZISL file as
follows:
MailMan uses the 4.281 file whose global root is ^%ZISL(4.281, to facilitate
InterUCI transfers. This file is part of the MailMan file set. MailMan may
distribute and use this file.
323 DBIA323-A File KERNEL 1993/12/16 APPROVED Active Private 3.2
To support bar code label printing and downloading/uploading, the
Controlled Substances package has found it necessary to develop hardware
specific parameters for the TERMINAL TYPE and DEVICE file. Centralized
procurements of Hewlett Packard and Kyocera laser printers and Intermec
trakkers have steered this package toward the use of these hardware types. As
testing has proceeded, the need to accurately communicate complex strings for
insertion into the TERMINAL TYPE file has proved difficult. An l
misinterpreted as a 1, a 0 mininterpreted as a O, or an inadvertant space or
lack thereof all can render a device inoperable.
It is therefore agreed that IRM utility routines (PSDTER*) be exported
which would allow ^DIC look-ups to the TERMINAL TYPE and DEVICE files, ^DIR
verification of the selections, and ^DIE stuffs to the necessary fields
identified as follows:
GLOBAL MAP DATA DICTIONARY #3.2 -- TERMINAL TYPE FILE STORED IN ^%ZIS(2,
(VERSION 7.1)
--------------------------------------------------------------------------
^%ZIS(2,D0,0)= (#.01) NAME [1F] ^ ^%ZIS(2,D0,1)= (#1) RIGHT MARGIN [1N] ^ (#2)
FORM FEED [2F] ^ (#3) PAGE
==>LENGTH [3N] ^ ^%ZIS(2,D0,1)= (#4) BACK SPACE [4F] ^
^%ZIS(2,D0,2)= (#6) OPEN EXECUTE [E1,245K] ^ ^%ZIS(2,D0,9)= (#99) DESCRIPTION
[1F] ^ ^%ZIS(2,D0,10)= (#110) OPEN PRINTER PORT [E1,245K] ^ ^%ZIS(2,D0,11)=
(#111) CLOSE PRINTER PORT [E1,245K] ^ ^%ZIS(2,D0,BAR0)= (#61) BAR CODE OFF
[E1,245F] ^ ^%ZIS(2,D0,BAR1)= (#60) BAR CODE ON [E1,245F] ^
331 DBIA331 Other KERNEL 1994/01/12 APPROVED Active Private
An enhancement patch will be issued to add the most
recent lab results to the Action Profile. If the pharmacy supervisor wants the
lab data printed, he/she selects the new option to select the drug, specimen
type, and number of days back to search for lab test results. An option will
be added to the pharmacy supervisor's menu. Since only one option and menu
item need to be added to the OPTION (#19) file, we would like to add them by
using DIC calls. We would prefer not to send inits only to add the option.
Checks are made in the routine to assure that the site is running version 6.0,
the option is installed only once, there are no other options with the same
name, and the supervisor's menu exist. The user may run the routine many times
and only install the option and menu item once.
332 DBIA332 File KERNEL 1994/01/14 APPROVED Active Private 200
The Radiology/Nuclear Medicine package is granted this
DBIA to use field 53.4 of the New Person File(#200).
334 DBIA334 File KERNEL 1994/01/14 APPROVED Active Private 200
Outpatient Pharmacy is granted permission to enter/edit the following fields.
File: New Person (#200)
Field # Node;Piece Field Name
.111 .11;1 STREET ADDRESS 1
.112 .11;2 STREET ADDRESS 2
.113 .11;3 STREET ADDRESS 3
.114 .11;4 CITY
.115 .11;5 STATE
.116 .11;6 ZIP CODE
.131 .13;1 PHONE
.132 .13;2 OFFICE PHONE
.133 .13;3 PHONE #3
.134 .13;4 PHONE #4
.141 .14;1 ROOM
342 DBIA342 File KERNEL 1994/01/24 APPROVED Active Private 200
The Problem List Application is granted permission for
the addition of the following fields to the NEW PERSON FILE (^VA(200,)). Also
granted is permission to read and write to these fields as appropriate. These
fields are used to tailor the Problem List Application for individual use.
125 PRIMARY VIEW
125.01 PROBLEM LIST SEARCH FILTER
125.02 PROBLEM LIST DISPLAY CODES
125.03 PROBLEM VOCABULARY
125.1 PROBLEM SELECTION LIST
343 DBIA343 Routine KERNEL 1994/01/25 APPROVED Active Private
It is agreed that MailMan can call XQSRV for servers.
MailMan sends XQSRV: XMZ, XMXX, XMFROM, XMCHAN, XMSEN, XMREC & XMB("TYPE").
XQSRV
344 DBIA344-A File KERNEL 1994/01/31 Retired Private 101
The following DBIA is granted between the Unwinder and
OE/RR.
Read Access to File 101: The XQOR routines navigate the Protocol file (101).
To provide this navigation, XQOR needs read access to File 101.
351 DBIA351-A File KERNEL 1994/02/28 Retired Private 19
Read Access to File 19: When an Option that is a
protocol (O) or protocol menu (Q) is encountered by menu manager, control is
turned over to XQOR. XQOR needs to have read access to File 19 to be able to
provide the navigation of these protocols. This agreement would replace DBIA
#5, which was between OE/RR and Menu Driver.
372 DBIA372 File KERNEL 1994/03/09 APPROVED Active Private 4
Integrated Billing requests permission to add entries
to the INSTITUTION (#4) when creating bills. The user is
required to hold the IB SUPERVISOR security key to add entries into file
#4.
432 DBIA432 File KERNEL 1994/04/05 APPROVED Active Controlled Subscription 49
478 DBIA478 File KERNEL 1994/06/13 Retired Private 3.1
Read access to the .01 field of the title file for
provider identificaiton for DSS
491 DBIA491 File KERNEL 1994/06/13 APPROVED Active Controlled Subscription 7
Read access to the .01 field of the provider class file
for provider identification.
505 DBIA5-B File KERNEL 1989/07/27 Active Private 19.1
This ICR had been retired, but was reactivated due to a
review of patch OR*3*397, where SQA found ORUPREF1 had some pre-existing code
(probably going back to the original package release) that reads from file
19.1. The reads are to:
1. ^DIC(19.1,"B",X,D0) ? B cross-reference
2. ^DIC(19.1,D0,1,D1,0) ? Description
506 DBIA5-C File KERNEL 1989/07/27 Retired Private 3
507 DBIA4-B File KERNEL 1989/07/27 APPROVED Active Private
560 DBIA97-B File KERNEL 1991/08/26 APPROVED Active Private 49
The DSS developers have agreed that the IMS developers
may export file 730 (NATIONAL SERVICE) with data and field 730 (NATIONAL
SERVICE) in file 49 (SERVICE/SECTION) with no data.
561 DBIA98-B File KERNEL 1991/03/20 APPROVED Active Private
Version 5.1 of the laboratory package has a temporary
agreement for the following:
2) To reference the global %ZTSK directly to display the error trap data.
(Rick has been notified of our usage of the %ZTSK global)
When Kernel release their error trapping system, Lab will convert to the
Kernel supported methodology.
601 DBIA128-B File KERNEL 1991/11/20 APPROVED Active Private 4
New Bill and Edit Bill options have been modified to
prompt the user "Edit Debtor Address" after he/she has entered/edited the
bill. This prompt as well as the Edit AR Debtor Address option allow edits to
the NEW PERSON and INSTITUTION file.
for the INSTITUTION file ^DIC(4,
1) 4,1.01 - Street Address 1
2) 4,1.02 - Street Address 2
3) 4,1.03 - City
4) 4,.02 - State
5) 4,1.04 - Zip Code
6) 4.03,.03 - Phone
Please keep in mind that "all users" with access to the Billing menu will be
able to edit the debtor address fields (option 2).
632 DBIA169-B Routine KERNEL 1992/06/17 Retired Private
DISP^XQORM1 If the standard menu help has been
replaced by defining XQORM(??),DISP^XQORM1 may be called by the help code to
display the selections on the menu. Remember DISP^XQORM1 may only be called
by the code used in XQORM(??) and X must be "?" when it is called.
XQORM1
633 DBIA170-B File KERNEL 1992/06/17 APPROVED Active Private 3
In the AMIE package a direct reference is made to the
USER file ^DIC(3,X,2,X1) to determine if a user has the division in question.
When this code is run in a Kernel 7 account it will not work properly.
712 DBIA241-C File KERNEL 2003/06/10 Retired Private 5
713 DBIA241-D File KERNEL 1993/06/15 APPROVED Active Private 200
714 DBIA241-E Routine KERNEL 1993/06/15 APPROVED Active Private WPSEFM
738 DBIA244-L File KERNEL 1993/06/15 APPROVED Active Controlled Subscription 40.5
^HOLIDAY Check if date is a
holiday
742 DBIA251-B File KERNEL 1993/07/20 APPROVED Active Private 19
Read/write access to the following fields in the OPTION
file (#19). (To save/restore these values upon an installation.) 200 QUEUED
TO RUN AT WHAT TIME 201 DEVICE FOR QUEUED JOB OUTPUT 202 RESCHEDULING
FREQUENCY 203 QUEUED TO RUN ON VOLUME SET
812 DBIA290-B File KERNEL 1993/10/12 APPROVED Active Private 3.2
=============================================================
Unauthorized Claim Printer, field 33 in file 161.4 (Fee Basis Site Parameters
file) references the device (%ZIS(1) and terminal type (%ZIS(2) files in the
Input transform (extrinsic function), Executable help (routine call) and
Screen. Fee routine is FBUCDD1.
The Screen is: S DIC("S")= "S
Z=$G(^%ZIS(1,+Y,""SUBTYPE"")),Z=$G(^%ZIS(2,Z,0)) I $E($P(Z,U),1)=""P""K Z"
This IA grants the subscribing packages direct global read of
%ZIS(1,"B" %ZIS(1,IEN,0 %ZIS(1,IEN,1 %ZIS(1,IEN,90 %ZIS(1,IEN,91 %ZIS(1,IEN,95
%ZIS(1,IEN,SUBTYPE %ZIS(1,IEN,TIME %ZIS(1,IEN,TYPE %ZIS(2,IEN,0
835 DBIA323-B File KERNEL 1993/12/16 APPROVED Active Private 3.5
To support bar code label printing and downloading/uploading, the
Controlled Substances package has found it necessary to develop hardware
specific parameters for the TERMINAL TYPE and DEVICE file. Centralized
procurements of Hewlett Packard and Kyocera laser printers and Intermec
trakkers have steered this package toward the use of these hardware types. As
testing has proceeded, the need to accurately communicate complex strings for
insertion into the TERMINAL TYPE file has proved difficult. An l
misinterpreted as a 1, a 0 mininterpreted as a O, or an inadvertant space or
lack thereof all can render a device inoperable.
It is therefore agreed that IRM utility routines (PSDTER*) be exported
which would allow ^DIC look-ups to the TERMINAL TYPE and DEVICE files, ^DIR
verification of the selections, and ^DIE stuffs to the necessary fields
identified as follows:
GLOBAL MAP DATA DICTIONARY #3.5 -- DEVICE FILE STORED IN ^%ZIS(1, (VERSION
7.1)
--------------------------------------------------------------------------
^%ZIS(1,D0,0)= (#.01) NAME [1F] ^ (#1) $I [2F] ^ (#4) ASK DEVICE [3S] ^
==>(#5) ASK PARAMETERS [4S] ^
==> ^ (#1.95) SIGN-ON/SYSTEM DEVICE [11S] ^ ^%ZIS(1,D0,1)= (#.02)
LOCATION OF TERMINAL [1F] ^ ^%ZIS(1,D0,91)= (#9) MARGIN WIDTH [1N] ^ (#10)
FORM FEED [2F] ^ (#11) PAGE
==>LENGTH [3N] ^ (#12) BACK SPACE [4F] ^ ^%ZIS(1,D0,SUBTYPE)=
(#3) SUBTYPE [1P] ^ ^%ZIS(1,D0,TYPE)= (#2) TYPE [1S] ^ ^%ZIS(1,D0,VMS)= (#61)
LAT SERVER NODE [1F] ^ (#62) LAT SERVER PORT [2F] ^
==>(#63) VMS DEVICE TYPE [3S] ^ (#64) LAT PORT SPEED [4S] ^
858 DBIA351-B File KERNEL 1994/02/28 Retired Private
Use of ^XUTL: The XQOR routines use ^XUTL("XQORM") and
^XUTL("XQORW") to store compiled protocol menus. An agreement to allow use of
these global nodes would partially replace DBIA #4 (which erroneously
identifies the node used as ^XUTL("ORUM")). The portion of DBIA #4 which
allows OE/RR to use ^XUTL("OR",$J,package namespace) would need to remain as
is.
860 DBIA351-D Routine KERNEL 1994/02/28 Retired Private
Call to ABT^XQ12: The Unwinder calls ABT^XQ12. I
believe this is part of the response time monitoring. The local variable,
XQXFLG, is also checked when making this call. Agreement is made to call
ABT^XQ12 and check the XQXFLG variable or this needs to be placed on the list
of supported references.
XQ12
872 File 101 File KERNEL 1994/04/28 APPROVED Active Controlled Subscription 101
This file may be referenced by packages to maintain
protocols within their namespace. This file may also be pointed to.
930 DBIA930 File KERNEL 1994/09/20 APPROVED Active Private 9.4
The Laboratory package requests agreement from the VA FileMan package to edit
the Package file (9.4) during the init process for Laboratory Version 5.2.
There are two sets of inits distributed with Lab V 5.2. The LR inits are the
primary inits for the release. The LA inits are for the Automated Instruments
part of the release. The LA inits are only run when the site is installing
this version in a virgin account. There are directions in the installation
guide telling the site NOT to run the inits if they overlaying version 5.2
over version 5.1. The Package file entry for Automated Instruments needs to
be updated to version 5.2, but because the inits are not run, the Package file
will not get updated.
We request permission to use ^DIE and ^DICN to update the following fields in
the AUTOMATED LAB INSTRUMENTS entry in the PACKAGE file.
VERSION (field #22, add a multiple entry)
VERSION (field #.01, sub field of #22)
DATE DISTRIBUTED (field #1, sub field of #22)
DATE INSTALLED AT THIS SITE (field #2, sub field of #22)
CURRENT VERSION (field #13)
This is a one-time request for this release of Laboratory Version 5.2.
932 DBIA932 File KERNEL 1994/08/04 APPROVED Active Private 3.2
Permission to define a field in one of our files as a
pointer to the Terminal File.
933 DBIA933 Routine KERNEL 1994/08/04 APPROVED Active Private %ZISS1
936 XUSESIG Routine KERNEL 1994/08/11 APPROVED Active Controlled Subscription
This routine, when called from the top, allows the user
to setup a personal electronic signature code. It is used within application
code to allow the user immediate 'on-the-fly' access to setup the electronic
signature, rather than force the user to leave the application and enter a
different option to do the same.
XUSESIG
973 DBIA973 File KERNEL 1994/09/23 APPROVED Active Private 200
Used to screen out inactive providers.
Below is a listing of files and fields that will be referencing the inactive
provider field in 200, indirectly. Routine DGPMDD references the data. The
fields contain an extrensic function for screening,
$$SCREEN^DGPMDD(ien,da,date) and a call to HELP^DGPMDD(da,date) for executable
help.
=====================================================================
File 405 - Patient Movement
*Field .08 - PRIMARY CARE PHYSICIAN
*Field .19 - ATTENDING PHYSICIAN
File 2 - Patient
Field .104 - PROVIDER
Field .1041 - ATTENDING PHYSICIAN
File 41.1 - Scheduled Admission
Field 5 - PROVIDER
File 45 - PTF (Subfile 45.02, 50)
Field 24 - PROVIDER
File 45.7 - FACILITY TREATING SPECIALTY (Subfile 45.701, 10)
Field .01 - PROVIDERS
976 DBIA976 File KERNEL 1994/08/29 APPROVED Active Private 200
This integration agreement permits LetterMan to
distribute and add/edit data in the fields in the range of 8983 to 8984 in the
NEW PERSON FILE #200.
The following is a standard data dictionary listing of the fields:
200,8983.11 DISPLAY HELP AT ENTRY TO LM LM;1 SET
'y' FOR YES;
'n' FOR NO;
LAST EDITED: JAN 26, 1990
HELP-PROMPT: Enter yes to display the help text before
entering the editor.
DESCRIPTION: If set to yes, a help text will be displayed
before entering the editor. This is used
primarily for new users.
200,8983.12 ASK TERMINAL TYPE AT LM ENTRY LM;2 SET
'y' FOR YES;
'n' FOR NO;
HELP-PROMPT: Enter yes to ask the terminal type upon entry
to the editor.
DESCRIPTION: If set to yes, the terminal type will be asked
upon entry to the editor.
200,8983.13 DEFAULT TERMINAL TYPE FOR LM LM;3 POINTER TO TERMINAL TYPE FILE
(
#3.2)
LAST EDITED: JAN 26, 1990
DESCRIPTION: This field stores the default terminal type
for
a user.
200,8983.14 DISPLAY LM COMMANDS LM;4 SET
'y' FOR YES;
'n' FOR NO;
LAST EDITED: JAN 26, 1990
HELP-PROMPT: Enter yes to display the list of commands when
entering the command mode.
DESCRIPTION: If set to yes, the list of commands will be
displayed at the bottom of the screen when
entering the command mode.
200,8983.15 BRIGHT CHARS AT EXIT FROM LM LM;5 SET
'y' FOR YES;
'n' FOR NO;
LAST EDITED: JAN 26, 1990
HELP-PROMPT: Enter yes to leave the terminal in high
intensity after exiting LetterMan.
DESCRIPTION: If set to yes, the terminal will be left in
high intensity after exiting.
200,8983.16 DATE LAST ACCESSED LM WP LM;6 DATE
INPUT TRANSFORM: S %DT="ETR" D ^%DT S X=Y K:Y<1 X
LAST EDITED: JAN 28, 1990
DESCRIPTION: The date and time a user last accessed the
LetterMan word processor document editor.
200,8983.17 TOTAL MINUTES USING LM WP LM;7 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>999999999)!(X<0)!(X?.E1"."1N.N) X
LAST EDITED: JAN 28, 1990
HELP-PROMPT: Enter the total minutes spent using the
LetterMan Word Processor (Editor), from 0 to
999999999.
DESCRIPTION: The total minutes a user has used the
LetterMan
word processor document editor.
200,8983.18 KEYSTROKES FROM LM WP LM;8 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>999999999)!(X<0)!(X?.E1"."1N.N) X
LAST EDITED: JAN 28, 1990
HELP-PROMPT: Enter the total number of keystrokes a user
has
typed from the word processor document editor,
from 0 to 999999999.
DESCRIPTION: This field stores the total number of
keystrokes a user has typed from the word
processor document editor.
200,8983.5 SPELLING EXCEPTION DICTIONARY LM1;0 Multiple #200.0089831
DESCRIPTION: This field stores the exception spelling
dictionary for the user.
200.0089831,.01 WORD 0;1 FREE TEXT (Multiply asked)
INPUT TRANSFORM: K:$L(X)>30!($L(X)<1) X I $D(X),X'?.L,X'["-"
K
X
LAST EDITED: JAN 26, 1990
HELP-PROMPT: Enter the WORD which should be checked by
the
spelling checker, from 1 to 30 lower case
characters including '-'.
DESCRIPTION: This field stores words which will be
checked
when spell checking a document.
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: 200.0089831^B
1)= S
^VA(200,DA(1),"LM1","B",$E(X,1,30),DA)=
""
2)= K ^VA(200,DA(1),"LM1","B",$E(X,1,30),DA)
200.0089831,1 ITS A WORD ? 0;2 SET
'y' FOR YES;
LAST EDITED: MAY 4, 1992
CROSS-REFERENCE: 200.0089831^AW^MUMPS
1)= S
^VA(200,DA(1),"LM1","AW",$P(^VA(200,DA(
1),"LM1",DA,0),"^"),DA)=""
2)= K
^VA(200,DA(1),"LM1","AW",$P(^VA(200,DA(
1),"LM1",DA,0),"^"),DA)
This cross reference is used to identify the
entry in the exception dictionary as a
word.
200.0089831,2 ITS NOT A WORD ? 0;3 SET
'y' FOR YES;
LAST EDITED: MAY 4, 1992
CROSS-REFERENCE: 200.0089831^AN^MUMPS
1)= S
^VA(200,DA(1),"LM1","AN",$P(^VA(200,DA(
1),"LM1",DA,0),"^"),DA)=""
2)= K
^VA(200,DA(1),"LM1","AN",$P(^VA(200,DA(
1),"LM1",DA,0),"^"),DA)
This cross reference is used to identify the
entry in the exception dictionary as a
non-word.
200,8983.51 DEFINED FORMATS FOR LM LM2;0 Multiple #200.0089832
DESCRIPTION: This field is used to store predefined format
lines which a user can select from during
editing.
200.0089832,.01 NUMBER 0;1 NUMBER (Multiply asked)
INPUT TRANSFORM: K:+X'=X!(X>9999999)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: JAN 26, 1990
HELP-PROMPT: Enter the number of the predefined format
line, from 1 to 9999999.
DESCRIPTION: This is the reference number to the
predefined format line.
CROSS-REFERENCE: 200.0089832^B
1)= S
^VA(200,DA(1),"LM2","B",$E(X,1,30),DA)=
""
2)= K ^VA(200,DA(1),"LM2","B",$E(X,1,30),DA)
200.0089832,1 DEFAULT 0;2 SET
'y' FOR YES;
'n' FOR NO;
LAST EDITED: JAN 26, 1990
HELP-PROMPT: Enter yes to use this format line when you
enter the screen editor.
DESCRIPTION: If set to yes, this format line will be used
as the default format line when using the
screen editor. If a document already has a
format line defined, then the document
format
will be used.
CROSS-REFERENCE: 200.0089832^AC
1)= S
^VA(200,DA(1),"LM2","AC",$E(X,1,30),DA)
=""
2)= K
^VA(200,DA(1),"LM2","AC",$E(X,1,30),DA)
200.0089832,2 FORMAT LINE 0;3 FREE TEXT
INPUT TRANSFORM: K:$L(X)>79!($L(X)<1) X I $D(X) S
%=X,X="WPSEF
ORM" X ^%ZOSF("TEST") K X I $T S X=% D
CHECK^
WPSEFORM
LAST EDITED: MAR 23, 1992
HELP-PROMPT: The format line should contain dots '.'
representing spaces or 'T' representing tab
or indent markers followed by a '<'
indicating the end of the right margin.
DESCRIPTION: This field stores the predefined format
lines
of the user.
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
200,8983.52 DEFINED PHRASES FOR LM LM3;0 Multiple #200.0089833
DESCRIPTION: This field stores predefined phrases which can
be inserted into the document during editing.
200.0089833,.01 KEYWORD 0;1 FREE TEXT (Multiply asked)
INPUT TRANSFORM: K:$L(X)>50!($L(X)<1) X
LAST EDITED: JAN 26, 1990
HELP-PROMPT: Enter the keyword used to select this
phrase,
from 1 to 50 characters.
DESCRIPTION: The predefined phrase 'keyword' used to
select the phrase.
CROSS-REFERENCE: 200.0089833^B
1)= S
^VA(200,DA(1),"LM3","B",$E(X,1,30),DA)=
""
2)= K ^VA(200,DA(1),"LM3","B",$E(X,1,30),DA)
200.0089833,1 PHRASE 1;0 WORD-PROCESSING #200.00898331 (NO
WRAP)
DESCRIPTION: The phrase to be inserted into the document.
200,8983.6 LM LIMIT WP FIELDS TO EDIT LM4;0 Multiple #200.0089834
DESCRIPTION: This field is used by the user to limit which
word processing fields should be edited by
LetterMan.
200.0089834,.01 LM LIMIT WP FIELDS TO EDIT 0;1 FREE TEXT (Multiply asked)
Limited Word-Processing Fields to Edit
INPUT TRANSFORM: K:X[""""!($A(X)=45) X I $D(X)
K:$L(X)>150!($L
(X)<4) X I $D(X) S %=X,X="WPSEFM" X
^%ZOSF("T
EST") K X I $T S X=% D SCREEN^WPSEFM
LAST EDITED: DEC 12, 1990
HELP-PROMPT: Answer must be 4-150 characters in length.
EXECUTABLE HELP: S X="WPSEHELP" X ^%ZOSF("TEST") I $T D
FMHELP
^WPSEHELP
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: 200.0089834^B
1)= S
^VA(200,DA(1),"LM4","B",$E(X,1,30),DA)=
""
2)= K ^VA(200,DA(1),"LM4","B",$E(X,1,30),DA)
977 DBIA977 File KERNEL 1994/08/29 Pending Private 19
This integration agreement permits IFCAP to remove
entries from the OPTION file (#19) until the release and availability of KIDS.
978 DBIA978 File KERNEL 1994/08/30 APPROVED Active Private 3.2
This integration agreement allows IFCAP to lookup data
in the TERMINAL TYPE File #3.5. The lookups are direct global references
(^%ZIS(2,IOST(0),node)).
The agreement is established since the routine %ZISS does not return the
values for the fields above. In a future version of %ZISS, the fields 60 and
61 could be included since the bar code fields can be turned on/off by writing
the value of the field (i.e. W ^%ZIS(2,IOST(0),"BAR1")).
The routine %ZISS could also return the field values for opening and closing
the printer port providing the field value returned is in its executable form
(i.e. X ^%ZIS(2,IOST(0),10)).
979 DBIA979 File KERNEL 1994/08/30 APPROVED Active Private 3.5
This integration agreement allows LetterMan to lookup
terminal type attributes from the TERMINAL TYPE File #3.5 using direct global
references. One option in LetterMan will automatically set up the terminal
type to be used with LetterMan.
In the next version of LetterMan, it will migrate to using the %ZISS routine
to return the attributes. There are approximately 15 attributes used by
LetterMan. Half of the attributes will be converted from executable code to
writeable attributes (as returned by %ZISS).
1013 DOLRO LINE TAG IN ROUTINE %ZOSV Routine KERNEL 1994/10/05 APPROVED Active Private
In the FileMan MUMPS OS file, we use code that does
routine DOLRO^%ZOSV to save the local symbol table. This entry point is not
documented.
%ZOSV
1014 SET PIECE OF %ZOSF GLOBAL File KERNEL 1994/10/05 APPROVED Active Private
FileMan sets the second piece of ^%ZOSF("OS") equal to
the record number selected from the FileMan MUMPS OS file during DINIT. This
second piece acts like a pointer to the MUMPS OS file.
1039 DBIA1039 File KERNEL 1994/10/24 APPROVED Active Private 4
The PCE Patient/IHS Subset (PXPT) package requests
permission to directly access the Institution file. This direct access is
needed to setup the IHS Location file (9999999.06), which is DINUMed to the
Institution File. The Location file is distributed by the PXPT package to
support the Visit file and Problem List files which are jointly shared files
between the VA and IHS.
The direct access is referencing the internal entry number, without actually
looking at any fields in the Institution file.
1049 PNs use of Security Key file (19.1) File KERNEL 1994/11/04 APPROVED Active Private 19.1
Progress Notes is adding field #.05 SECURITY KEY to the
GENERIC PROGRESS NOTE TITLE file (121.2).
This field will point to the SECURITY KEY file (19.1)
This is being done to implement functionality requested in E3R 4858 and will
be exported in patch GMRP*2.5*29.
Many services use the Progress Notes package. Sites will now have the option
to restrict entering of new Progress Notes to users that hold the key
associated with a particular title. This is accomplished using DIC("S") when
creating a new progress note. If a TITLE does not have a security key
associated with it, no restriction will apply.
This will be particularly useful for sites wanting to control access to the
CWAD titles; Crisis Note, Clinical Warning, and Advance Directive.
Any existing security key may be used to lock any title. It is entirely at
the sites' discretion. This will not in any way impact the display or
printing of any notes.
The SECURITY KEY field (#.05) entry in GENERIC PROGRESS NOTE TITLE file
(121.2) may be edited at any time. This can be accomplished by using the
'GMRPN TITLE MGMT MENU' option.
The next version of Progress Notes will utilize the TIU (Text Integration
Utility) which will inlude the ASU (Authorization/Subcription Utility). The
use of the SECURITY FIELD will no longer be necessary at this time.
1063 DBIA1063-A File KERNEL 1994/11/16 Retired Private 19
The Outpatient routines PSODISP and PSORESK need to make sure that the
Drug Acct. background job, PSA IV ALL LOCATIONS is scheduled to run before
updating ^XTMP("PSA". This agreement supports the look-up to the OPTION file
for a Kernel version 7.1 environment.
1064 DBIA1063-B File KERNEL 1994/11/16 APPROVED Active Controlled Subscription 19.2
The Drug Acct. background job, PSA IV ALL LOCATIONS is
scheduled to run before updating ^XTMP("PSA".
1087 DBIA1087 File KERNEL 1994/12/13 APPROVED Active Private 200
Agreement for the Notifications component of OE/RR 2.5
to directly access the global ^VA(200. This includes Read/Delete access to
the global.
1092 Use of Spooler by Health Summary Routine KERNEL 1994/12/20 APPROVED Active Controlled Subscription
The API for PDX to request Health Summary data
functions by Spooling Health Summary output into a SPOOL DOCUMENT and
transfering the resulting data from ^XMBS(3.519, into an array (usually ^TMP)
named by the calling application. This was necessary, given the current
design of Health Summary, and the absence of HFS space on the 486 systems. To
be portable, the most practical means of generating ASCII output to a MUMPS
global was to use the Spooler.
To that end, Health Summary requests permission to make direct reference to
the SPOOL DOCUMENT (^XMB(3.51,) and SPOOL DATA (^XMBS(3.519,) files to
evaluate the status of the Spool Document, and to transfer the resulting text
to the target array respectively. We also call the entry points DSD^ZISPL and
DSDOC^ZISPL to delete the SPOOL DATA and SPOOL DOCUMENT records once the
transfer is successfully completed until otherwise specified.
ZISPL
1113 1113 File KERNEL 1995/01/10 APPROVED Active Private 9.4
Kernel Toolkit needs this agreement with Kernel to
reference ^DIC(9.4
1124 References to Package File (9.4) File KERNEL 1995/02/01 APPROVED Active Private 9.4
^XTSUMBLD, %INDEX, and the XINDEX routines need to look
at the Package file to find out what files are part of the package. For
example,
>>>>>XTSUMBLD+14 (FIELD: PREFIX)
S X=$P(^DIC(9.4,+$P(Y(0),U,2),0),U,2) D NAME(X) G EXIT:'$D(XTRNAME)
>>>>>XINDX10+11 (FIELD: FILE) F J=0:0 S J=$O(^DIC(9.4,DA,4,J)) Q:J'>0 I
$D(^(J,0)) SINDFN=+^(0),INDRN="|dd" _INDFN,(INDF,INDL)=0 D INSERT
>>>>>XINDX11+22 (FIELD: PREFIX) NAMSP S
INDXN=$P(^DIC(9.4,DA,0),"^",2),C9=0,INDXN(C9)="," F A=0:0 S A=$O(^DIC(9.
4,DA,"EX",A)) Q:A'>0 I $D(^(A,0))#2 S C9=C9+1,INDXN(C9)=$P(^(0),"^")
>>>>>ZINDX10+4 (FIELD: FILE)
F J=0:0 S J=$O(^DIC(9.4,DA,4,J)) Q:J'>0 I $D(^(J,0)) S INDFN=+^(0),INDRN="
|dd" _INDFN,(INDF,INDL)=0 D INSERT
>>>>>ZINDX11+5 (FIELD: PREFIX) NAMSP S
INDXN=$P(^DIC(9.4,DA,0),"^",2),C9=0,INDXN(C9)="," F A=0:0 S A=$O(^DIC(9.
4,DA,"EX",A)) Q:A'>0 I $D(^(A,0))#2 S C9=C9+1,INDXN(C9)=$P(^(0),"^")
1125 Index and BUILD file File KERNEL 1995/02/01 APPROVED Active Private 9.6
Index reads the file list, option list, Function list,
routine list to get the components of a build. The references are in XINDX10,
XINDX11, XINDX51.
1129 DBIA1129-A File KERNEL 1995/02/06 APPROVED Active Private
Reference to ^ZZSLOT. Toolkit requests read access to
this node to maintain the number of active slots in it's performance database.
.S XUCMSLOT=+$G(^ZZSLOT(XUCMND,"ACTIVE"))
1130 DBIA1129-B Routine KERNEL 1995/02/06 APPROVED Active Private
References to ^%ZOSV*
%ZOSV2
1139 Add HFS device for OE/RR File KERNEL 1997/10/12 APPROVED Active Controlled Subscription 3.5
1153 PACKAGE FILE REFERENCES CLEANUP File KERNEL 1995/02/24 APPROVED Active Controlled Subscription 9.4
Loop through the "C" cross-reference on the PACKAGE
file and delete any extra entries with the subscribing package namespace.
Where necessary, the name of a package may be changed to make it unique.
1157 XPDMENU Routine KERNEL 1995/03/08 APPROVED Active Supported
Extrinsic functions and API calls that can be used to
manage Options in the Options file. The LKOPT function is used to lookup all
options. The ADD and DELETE functions are used to add/delete menu items. The
OUT, RENAME, LOCK, and RLOCK are APIs used to populate certain fields for a
given option.
XPDMENU 2018/05/16
1185 DELETE OPTION QUEUING INFORMATION File KERNEL 1995/03/30 APPROVED Active Private 19
We have been tasked with turning off the ODS software.
As part of that, we would like to unschedule the nightly background job. The
following code will be used in a one time clean-up routine:
S DGVER=$$VERSION^XPDUTL("XU")
S DIC="^DIC(19,",DIC(0)="QMZ",X="A1B2 BACKGROUND JOB" D ^DIC S (DGIEN,DA)=+Y
I DA'>0 G ENQ ; background job not in option file
I DGVER<8 S DR="200///@;201///@;202///@;203///@",DIE=DIC D ^DIE
I DGVER'<8 S DIK="^DIC(19.2," F DA=0:0 S DA=$O(^DIC(19.2,"B",DGIEN,DA)) Q:'DA
D ^DIK
DGYMODS
1186 OPTION SCHEDULING FILE ACCESS File KERNEL 1995/03/30 APPROVED Active Private 19.2
If a site is running KERNEL 8 or higher, we'd like to
delete all entries in the SCHEDULED OPTIONS file for the ODS BACKGROUND JOB.
Code is as follows:
S DGVER=$$VERSION^XPDUTL("XU")
S DIC="^DIC(19,",DIC(0)="QMZ",X="A1B2 BACKGROUND JOB" D ^DIC S
(DGIEN,DA)=+Y
I DA'>0 G ENQ ; background job not in option file
I DGVER<8 S DR="200///@;201///@;202///@;203///@",DIE=DIC D ^DIE
I DGVER'<8 S DIK="^DIC(19.2," F DA=0:0 S DA=$O(^DIC(19.2,"B",DGIEN,DA)) Q:'DA
D ^DIK
1234 DBIA1234 File KERNEL 1995/05/25 APPROVED Active Controlled Subscription 3.1
1262 DBIA1262 File KERNEL 1995/08/09 Pending Supported 200
The PAID 4.0 development team is requesting permission
to add a new field to the NEW PERSON file and a new cross-reference to the NEW
PERSON SSN field.
The new field will be PAID EMPLOYEE (#450) and will be a pointer to the PAID
EMPLOYEE (#450) file. This field will be uneditable.
The new MUMPS cross-reference will be the AJ cross-reference on the SSN (#9)
field. This cross-reference will set or kill the NEW PERSON pointer in the
PAID EMPLOYEE file and the PAID EMPLOYEE pointer in the NEW PERSON file
whenever the SSN value is changed or deleted.
1279 DBIA1279 Other KERNEL 1995/06/05 APPROVED Active Private
Integrated Billing plans to release the enhancement
patch IB*2*28 within 4-6 weeks. We need to update the zeroth node of an entry
in the ITEM (#10) multiple in one of our menu protocol (file #101) entries.
The easiest way we have found to effect that change is to delete the item from
the menu protocol, and have the onits re-add the item, with the new zero node
in the multiple, back into the menu protocol.
We are formally requesting permission to delete the item which points to the
protocol IBCNS QUIT from the menu protocol IBCNSC INSURANCE CO in the
post-init of patch IB*2*28. The item would immediately be re-added by
invoking the onit right after the deletion.
1282 OPTION FILE ENTRY/EXIT FIELDS File KERNEL 1995/06/26 APPROVED Active Private 19
This integration agreement allows the Generic Code
Sheet package version 2.0 to update the OPTION file's (#19) ENTRY and EXIT
ACTION fields (#20 and #15) in the routine GECXPOST. The routine GECXPOST is
distributed with patch GEC*2*2.
The routine GECXPOST will change the ENTRY ACTION field from calling an
unsupported Generic Code Sheet entry point to a supported entry point (as
defined in integration agreement #1089). It will also change the EXIT ACTION
field from null to 'K GECSSYS' where GECSSYS is a supported Generic Code Sheet
variable.
The options defined as '<NMSP> GECS*' will have the ENTRY and EXIT ACTION
changed. <NMSP> is defined as the namespace as follows:
ABSV BLD CHAP DENT DG ESP
FB FH GMRC LBRC LR MC
NURS PLAY PRCC PRSP PRSP PS
RA RMPR SR SOWK VOLU YS
1332 Rad/Nuc Med flds in File 200 File KERNEL 1995/08/31 APPROVED Active Private 200
This DBIA documents the fields in File 200 that are
created by the Radiology/Nuclear Medicine package developers, and are used
specifically by the Radiology/Nuclear Medicine package. These fields are to
be distributed in a patch by the Kernel developers. The patch will be
prepared by the Radiology/Nuclear Medicine developers and will contain an
environment check to make sure Version 4.5 of Radiology/Nuclear Medicine is
installed before installing these fields on file 200. These fields will also
be distributed along with Radiology/Nuclear Medicine 4.5.
1340 DBIA1340 File KERNEL 1995/09/14 APPROVED Active Supported 19.1
The Security Key file (#19.1) Name field (.01) can be
pointed to. Standard utilities should be used for look-up.
1366 DBIA1366 File KERNEL 1995/09/26 APPROVED Active Private 200
Version 1.6 of the HL7 package includes support for
sending security codes (access and signature) in an HL7 message. As a result
the HL7 package needs to directly access the new person file to validate the
security codes.
1367 XPDKEY Routine KERNEL 1995/09/26 APPROVED Active Supported
APIs and extrinsic functions that can be used to
control the Security Key File.
XPDKEY 2008/03/12
1373 DBIA1373 File KERNEL 1995/10/12 APPROVED Active Controlled Subscription 101
Version 1.6 of the HL7 package uses the Protocol file
(#101) to store event related information concerning HL7 messages being
exchanged by applications. As a result, it was necessary to add values to the
Type field (#4) and to add a number of messaging specific fields and cross
references to the file.
The following Input Template was added to the Protocol file (#101):
'HL MESSAGING PROTOCOL EDIT'
This template allow for editing of the fields described in this Integration
Agreement.
1376 NEW PERSON File KERNEL 1995/11/07 APPROVED Active Private 200
Nursing can access the New Person file as described in
this DBIA.
1379 OPTION FILE File KERNEL 1995/11/07 Retired Private 19
This integration agreement is only for Nursing V3.0,
Vitals/Measurements 3.0 and Intake/Output 3.0.
Permission to access the "B" xref on the option file.
Persmission to set the OUT OF ORDER field in file 19 using ^DIE.
1449 CHANGE PACKAGE FILE ENTRY Other KERNEL 1995/12/07 APPROVED Active Private
The Allergy Tracking System package is changing its
name to Adverse Reaction Tracking when the next version (4.0) is released. The
Expert Panel feels this is a more accurate name for what the package does.
When Version 4.0 is installed, the environmental check routine will do a
look-up (using a DBS call) on the 'C' cross-reference of the PACKAGE file
(#9.4) to find the appropriate entry and change the .01 field value to
'ADVERSE REACTION TRACKING'. The package's namespace is GMRA.
Also, the PACKAGE file entry contains the old name and version number as data
in the SHORT DESCRIPTION (#2) and DESCRIPTION (#3) fields. Leaving that data
in the File 9.4 entry would confuse IRM support personnel. We request
permission to edit these two fields, via FileMan, in the environment check
routine at the time of installation.
1454 XPDMENU TO GET OPTION IEN Routine KERNEL 1996/01/11 Withdrawn Private
This IA will allow the registration package to call
LKOPT^XPDMENU to acquire the IEN of a menu option when passed the option name.
XPDMENU
1455 XUTMOPT used to reschedule task Routine KERNEL 1996/01/11 Withdrawn Private
This IA will allow the registration package to
reschedule a task if it is not already scheduled in the future.
XUTMOPT
1456 DIC(19.2 usage File KERNEL 1996/01/11 Withdrawn Private 19.2
Allows use of the "B" cross-reference of the OPTION
SCHEDULING file (#19.2) to loop though queued times for a given option. Also
allows access of the QUEUED TO RUN AT WHAT TIME (#2) field which is the 2nd
piece of the 0 node of the file.
1472 XUTMOPT Option scheduling interface Routine KERNEL 1996/01/23 APPROVED Active Supported
This routine holds several supported calls for access
to the option scheduling file.
XUTMOPT
1479 Delete PACKAGE file entry Other KERNEL 1996/03/01 APPROVED Active Private
The Allergy package is changing its name to ADVERSE
REACTION TRACKING with version 4. The package's namespace is GMRA. Some sites
have two entries in their PACKAGE file that have GMRA as the namespace. They
are ALLERGY TRACKING SYSTEM and GEN. MED. REC. - ALLERGIES. The former is
version 2.2 and the latter is version 3. Both are previous versions of the
ADVERSE REACTION TRACKING package. The GEN. MED. REC. - ALLERGIES entry will
be changed to ADVERSE REACTION TRACKING in the PACKAGE file (DBIA #1449).
This DBIA allows the version 4 environment check routine to delete any other
PACKAGE file entries that have the GMRA namespace.
When the unwanted entry has a lower internal entry number in the PACKAGE file
it confuses the $$VERSION^XPDUTL utility which looks at the namespace
cross-reference.
For example: W $$VERSION^XPDUTL("GMRA") can return the value 2.2 when it
should return 4.
1513 DBIA1513 Routine KERNEL 1996/03/11 Pending Controlled Subscription
This is a new supported reference in the routine
XUVERIFY.
XUVERIFY
1518 DEFAULT INSTITUTION File KERNEL 1996/03/22 Withdrawn Controlled Subscription 8989.3
Record Tracking needs to find the institution
associated with a borrower when the borrower is an entry in the NEW PERSON
file. We plan to first look at the division multiple of the NEW PERSON file.
If there are no entries in that multiple, we would like to use the DEFAULT
INSTITUTION field (#217) of the KERNEL SITE PARAMETERS file (#8989.3). This
same logic is used in routines such as XUP and XUS1.
1519 XUTMDEVQ Routine KERNEL 1996/03/29 APPROVED Active Supported
These APIs allow you to run jobs directly or queue
them, whether printing to a device or not, and enable varying degrees of user
interaction. See the TaskMan: Developer Tools section of the Kernel
Developer's Guide for further information.
EN^XUTMDEVQ: Use this to allow the user to decide whether to run the job
directly or queue it. The user may select the device and the start time.
If a task is long-running, and has an output device, it will tie up the output
device for the whole time. That's not desirable. We've created a way for you
to split the job into two tasks: gather and print. The user may select the
device and the start time.
$$QQ^XUTMDEVQ(): Double Queue- This API creates the Gather and Print tasks.
The gather task is scheduled to run, while the print task is not scheduled.
The gather task collects data and stores it, perhaps in ^XTMP. When the
gather task is finished, the gather task can schedule the print task.
$$REQQ^XUTMDEVQ(): Schedule the Print task that was created by $$QQ^XUTMDEVQ.
The print task prints the data that was stored by the gather task. This API
should be invoked at the end of the Gather task to print the results.
$$DEV^XUTMDEVQ(): Use this to force the user to queue a job. The user may
select the device and start time.
$$NODEV^XUTMDEVQ(): Use this to force the user to queue a job which doesn't
need any device. The user may select the start time.
XUTMDEVQ 2012/06/20
1542 BUILD File Read File KERNEL 1996/06/18 Withdrawn Private 9.6
For PCMM (SD*5.3*41), as part of the installation
environment checker, SCMCENV, we check for the existence of the following
global using $DATA:
^XPD(9.6,"B",SCPATCH)
This is NAME cross-reference of the BUILD File (#9.6)
Due to the concurrent development of PCMM and the RPC BROKER software, it was
necessary to check for the existence of the specific BUILD NAME. If the BUILD
file check fails, we use $$VERSION^XPDUTL as a check for the existence of the
appropriate RPC BROKER version. If both checks fail, we abort the install of
PCMM.
1548 DBIA1548-A File KERNEL 1996/06/19 Retired Private 3.1
IA combined with IA 1234.
1555 PCMM Needs DBIA For .01 Field Pointing to File #200 File KERNEL 1996/06/26 APPROVED Active Private 200
The SCHEDULING USER PREFERENCE File (#403.35) has a .01
field (SCHEDULING USER) that points to and is DINUMed to the NEW PERSON File
(#200). .01 fields are specifically excluded from the normal permission for
fields to point to File #200.
1557 E-SIG API'S Routine KERNEL 1996/07/03 APPROVED Active Supported
This is the list of supported references to the E-SIG
facility.
XUSESIG1 2008/03/24
1621 %ZTER (ERROR RECORDING) Routine KERNEL 1996/10/04 APPROVED Active Supported
This IA is to document the supported calls into the
%ZTER routine in support of standard error trapping.
%ZTER 2009/08/12
1625 PERSON CLASS API'S Routine KERNEL 1996/11/07 APPROVED Active Supported
Based on a multiple in the NEW PERSON file (#200) which
contains entries that reflect the assignement of HCFA taxonomy to providers,
these APIs provide data for a given NEW PERSON file entry on HCFA code,
profession, specialty, and subspecialty.
XUA4A72
1630 XUS AV CODE Remote Procedure KERNEL 1999/06/29 Active Private
Broker Signon RPC'S. This DBIA covers the following
RPC's
XUS AV CODE
XUS VA HELP
XUS CVC
XUS SIGNON SETUP That are all private to Broker.
XUS AV CODE
1631 XUS INTRO MSG Remote Procedure KERNEL 1999/06/29 APPROVED Active Controlled Subscription
RPC to return the INTRO TEXT from the KSP file.
XUS INTRO MSG
1632 XUS SIGNON SETUP Remote Procedure KERNEL 1999/06/29 APPROVED Active Supported XUS SIGNON SETUP
1633 XUS SEND KEYS Remote Procedure KERNEL 1999/06/29 APPROVED Active Private
This is a two part RPC for a Broker Signon component.
XUS DIVISION GET
XUS DIVISION SET
The rpc XUS DIVISION GET gets a list of the institutions that this user may
signon as belonging to.
The rpc XUS DIVISION SET sets the Kernel variable DUZ(2) to the selected
Division/institution.
XUS SEND KEYS
1867 DBIA1867 File KERNEL 1996/12/05 APPROVED Active Private 200
This IA adds two fields to file 200 -- COMMERCIAL PHONE
(# .135) and SUPPLY EMPLOYEE (# 400). These fields should be sent out any
time file 200 is sent out as a full DD. No data should go with these fields.
Any data at the sites in those fields should remain.
1885 IFCAP Vendor Display Format $P(.VA(200,,400),U,2) File KERNEL 1996/12/19 Pending Supported 200
This field stores the user's desired format for displaying a list of vendors.
Terminal users have requested a minimum number of lines per vendor so that
vendors won't scroll of the top of the screen. The Horizontal (2 line) format
and a Vertical 4-6 line format are illustrated below. Entry of VS or HS will
make that choice automatically throughout this session, i.e. until you log in
again. Entry of VA or HA will mean you won't be prompted for a choice again.
Normal Usage
Select VENDOR NAME: ??
Choose from:
1 AOBC SEE WHAT SHOWS UP FOR LONG NAME How should Vendor
Addresses be displayed? : (HR/VR/HS/VS/HA/VA): VR// ?
'Session' means until you log in again. 'Always' means never seeing this
again.
Select one of the following:
HR Horizontal (minimum # of lines) -- Reask every selection
VR Vertical (Postal Format) -- Reask ''
HS Horizontal -- every time this Session
VS Vertical -- ''
HA Always Horizontal -- never Ask again
VA Always Vertical -- ''
Field can also be set explicitly via the
Enter/Edit Vendor Display Format option
200,402 Vendor Display Format 400;2 SET
VENDOR DISPLAY FORMAT
'HR' FOR Horizontal (minimum # of lines) -
Reask every list;
'VR' FOR Vertical (Postal Format) - '';
'HS' FOR Horizontal -- rest of Session;
5 CENTRAL BUSINESS SERVICES
AND SUPP EDI VENDOR 202 491- 0231 NO.
5
FMS VENDOR CODE:NAME: 37844821002: SPECIAL
FACTORS: VENDOR MUST BE CALLED PRIOR TO
MAILING
PO ORDERING ADDRESS: 4000 RESERVOIR ROAD
WASHINGTON, DC 20008
6 **MILAN >> INACTIVE No
substitute defined
7 SAM'S 512-876-4433
NO.
7 FMS VENDOR CODE:NAME: MISC1234501: SPECIAL
FACTORS: ORDERING ADDRESS: 4 HIGH ST
AUSTIN, TX 75434
8 GENERIC GENERAL STORE
301-427-3700 NO. 8 FMS VENDOR CODE:NAME:
123456798: SPECIAL FACTORS: ORDERING ADDRESS:
111 MAIN STREET
SILVER SPRING, MD 20910
Horizontal Format Example:
4 DAN'S DOG FOOD SUPPLY `14
123-4567
Order From: 1234 STATE STREET; ; ; ; ZW
DQ, MD 20708
5 CENTRAL BUSINESS SERVICES
AND SUPP `5 202 491-0231
FMS #-NAME: 37844821002-
Note: VENDOR MUST BE CALLED PRIOR
TO MAILING PO
EDI Fax: 301 427-3700 Order From:
4000 RESERVOIR ROAD; SUITE 200; ;
WASHINGTON, DC 20008
6 **MILAN >> INACTIVE No
substitute defined
7 SAM'S `7 512-876-4433
FMS
#-NAME: MISC1234501-
Order From: 4 HIGH ST; CHECK THIS OUT;
;
; AUSTIN, TX 75434
DESCRIPTION
This field stores the user's desired format
for
displaying a list of vendors. Terminal users
have requested a minimum number of lines per
vendor so that vendors won't scroll of the top
of the screen. The Horizontal (2 line) format
and a Vertical 4-6 line format are illustrated
below. Entry of VS or HS will make that
choice
automatically throughout this session, i.e.
until you log in again. Entry of VA or HA
will
mean you won't be prompted for a choice again.
SCREEN: S DIC("S")="I Y'=""B""!(DUZ(0)=""@"")"
EXPLANATION: Programmers have an additional option.
SOURCE OF DATA: User decision
DATA DESTINATION: PRCH69
1956 DBIA1956 File KERNEL 1997/03/06 APPROVED Active Private 49
Supported DBIA #10093 provides FileMan read access to
all fields of the SERVICE/SECTION file (#49). The DSS Surgery Extract uses a
direct global read on the NATIONAL SERVICE field (730) for the purpose of
determining the service to which the attending surgeon is assigned.
The technical description follows: ATTENDING'S SERVICE is a pointer to the
NATIONAL SERVICE file (#730). Derived from the SERVICE/SECTION field (29) in
the NEW PERSON file (#200) for the ATTENDING SURGEON field (13) in the SURGERY
EXTRACT file (#727.811) which is a pointer to the SERVICE/SECTION file (#49).
The pointer value identifies the NATIONAL SERVICE field (730) in the
SERVICE/SECTION file (#49) which points to the NATIONAL SERVICE file (#730).
Therefore, DSS Extracts references the following data from the SERVICE/SECTION
file (#49).
2013 DBIA2013 File KERNEL 1997/04/16 APPROVED Active Private 101
HL7 1.6 needs permission to export new field, ROUTING
LOGIC, with Protocol File (101) as part of the CIRN patch HL*1.6*14.
2058 PACKAGE FILE LOOKUP File KERNEL 1997/07/07 APPROVED Active Controlled Subscription 9.4
With the addition of the new Parameter Tools
functionality, Lab has need to retrieve the package file internal entry number
and the namespace. Lab would like permission to retrieve the IEN of the
package file by referencing the B and C indexes. Additionally, a direct
access of the PREFIX field is requested.
2066 DBIA2066 Other KERNEL 1997/07/21 Pending Private
This constitutes an agreement whereby the DHCP
Engineering Package (also known as AEMS/MERS) is allowed to use Field #62
(named 'RESERVED') of the Terminal Type File (#3.2) to allow sites to
customize the way they print bar coded equipment and location labels.
The bar code printing routines (ENLBL4 and ENLBL7) within the Engineering
Package contain program segments that send formatting instructions and print
requests to the user-selected bar code printer. The Engineering Package
assumes that the bar code printer is an Intermec 86xx compatible device and
that the site wants standard formatting.
Engineering needs:
1) a mechanism for interfacing to bar code printers that are not
Intermec 86xx compatible, and
2) a mechanism to allow sites to tailor the formats of their bar
coded equipment and location labels to meet local needs, if they
so desire.
This private integration agreement gives the Engineering Package permission to
reference Field #62 of the Terminal Type File (#3.2) entry that is pointed to
by the Device File (#3.5) entry of the selected bar code printer. The syntax
of the reference will be:
S X=$$GET1^DIQ(3.2,ENBCIOST(0),62)
where ENBCIOST(0) is the internal entry number of the bar code printer within
the Terminal Type File.
If $P(X,":") is equal to "ENG" then the Engineering Package will know that
pieces 2 through 5 (using ":" as a delimiter) will be executable statements,
as follows:
$P(X,":",2) will specify equipment formatting,
$P(X,":",3) will specify equipment data,
$P(X,":",4) will specify location formatting, and
$P(X,":",5) will specify location data.
An example of what a representative entry may look like is:
ENG:D EQFOR^ENZLBL:D EQDAT^ENZLBL:D LOCFOR^ENZLBL:D LOCDAT^ENZLBL
In this example:
program segment EQFOR^ENZLBL would be executed instead of FORMAT1^ENLBL7
" " EQDAT^ENZLBL " " " " " NXPRT1^ENLBL7
" " LOCFOR^ENZLBL " " " " " FORMAT1^ENLBL7
" " LOCDAT^ENZLBL " " " " " LOCPRT^ENLBL4
If any of pieces 2 through 5 in a RESERVED field that begins with 'ENG:' is
null, then the corresponding code in routine ENLBL4 or ENLBL7 will be
executed.
Local variables in the ENBC* namespace will be passed to each of the
executable statements, as follows:
ENBCIO will be the IO variable of the bar code printer
ENBCIOSL " " " IOSL " " " " " "
ENBCIOF " " " IOF " " " " " "
ENBCION " " " ION " " " " " "
ENBCIOST " " " IOST " " " " " "
ENBCIOST(0) " " " IOST(0) " " " " " "
Local variable DA will be passed to the executable code that processes
equipment data and to the executable code that processes location data. In the
case of equipment data, DA will be the internal entry number of a record in
the Equipment File (#6914). For location data, DA will be the internal entry
number of a record in the Space File (#6928).
2067 UPDATE PACKAGE FILE VERSION/APPLICATION HISTORY Routine KERNEL 1997/07/22 APPROVED Active Supported
These functions can be used during the Pre or Post
Install routine to update the VERSION multiple and the PATCH APPLICATION
HISTORY multiple in the PACKAGE file.
XPDIP 2018/02/02
2091 DBIA2091 File KERNEL 1997/08/27 APPROVED Active Controlled Subscription 8932.1
2094 CHECK FOR INACTIVE PROVIDER File KERNEL 1997/08/27 APPROVED Active Controlled Subscription 200
This is used to see if a provider has been inactivated
at the time of the patient encounter.
Revision History:
- 2/26/25-Added OE/RR as a subscriber to document historical usage, which
resulted in adding Field 53.1
2118 DBIA2118 Routine KERNEL 1997/09/05 APPROVED Active Supported
This routine is part of the Kernel Device handler. It
is used for making TCP/IP connection between computers. It only deals with IP
address.
%ZISTCP
2119 DBIA2119 Routine KERNEL 1997/09/05 APPROVED Active Supported
Access to some device handler tools.
%ZISUTL
2120 DBIA2120 Routine KERNEL 1997/09/05 APPROVED Active Controlled Subscription
IA between Kernel and RPB Broker.
XUSRB
2121 DBIA2121 Routine KERNEL 1997/09/05 APPROVED Active Private
This is a custom call developed for the RPC Broker.
XUSRB1
2124 DBIA2124 Routine KERNEL 1997/09/05 APPROVED Active Private
Special call to menu system to check access to options
and RPC's.
XQCS
2142 INSTALL File Read File KERNEL 1997/09/10 APPROVED Retired Private 9.7
************************************************************************
The Library package was decommissioned with LBR*2.5*15. This ICR was retired
with the release of the Library patch.
************************************************************************
Because we didn't do a package link for Library Version 2.5 Patch 1, checks
for installation of this patch will not work. Would like to use
$D(^XPD(9.7,"B","LBR*2.5*1")) in our environment check programs until next
version of the Library package comes out.
2143 Option Schedule Look-up File KERNEL 1997/09/10 APPROVED Retired Private 19.2
************************************************************************
The Library package was decommissioned with LBR*2.5*15. This ICR was retired
with the release of the Library patch.
************************************************************************
Sometimes the Library package TaskMans are not restarted when the system is
shut down. This causes a problem with transaction processing back and forth
with FORUM. To help the Librarians with observation of this problem, a
program has been written that displays the option, the frequency and the next
scheduled time. We need to do a DIC lookup into file 19.2 to retrieve this
information because using XUTMOPT displays more information than the general
user needs to see and also page feeds for each option.
2160 DBIA2160 File KERNEL 1997/09/30 APPROVED Active Controlled Subscription
Order Entry uses ^XUTL("OR",$J,xxx where xxx is the
ancillary or support packages' namespace.
2171 DBIA2171 Routine KERNEL 1997/10/07 APPROVED Active Supported
Function API's to access parts of the Institution file.
This DBIA documents some entry point for accessing the Institution file that
were requested by the CIRN developers or implemented by the IFR project.
XUAF4 2020/03/12
2172 DBIA2172 Routine KERNEL 1997/10/08 APPROVED Active Supported
The routine XPDID contains calls to support the Kernel
Installation and Distribution System. All of the calls can only be used in
the context of the KIDS software.
INIT
This tag initializes the screen and draws the borders for the box and
draws the progress bar. It also creates a scrolling region in the box.
INPUT: none
OUTPUT: XPDIDVT=1 if output device supports graphics, =0 if not
TITLE(text)
This tag displays the text as a title at the top of the box.
INPUT: text
OUTPUT: none
EXIT(text)
This tag restore the screen to normal, cleans up all variables, and
displays the text.
INPUT: text
OUTPUT: none
UPDATE(current number of items)
This tag updates the progress bar to show the percentage complete of the
installation.
INPUT: current number of items
XPDIDTOT = total number of items
For example, if you are converting 100 records and want to update the user
every time you have completed 10% of the records you would do the following:
Set XPDIDTOT=100
F%=1:1:100 D CONVERT I'(%#10) D UPDATE^XPDID(%)
XPDID
2197 CPRS needs Install Start Time File KERNEL 1997/10/25 APPROVED Active Controlled Subscription 9.7
Currently, the only way to get the start and completion
date of an install is to get the IEN of the build and reference the fields
directly.
2212 NEW PERSON editing File KERNEL 1997/10/29 APPROVED Active Private 200
With patch XM*7.1*50, MailMan will be dropping phone
and address fields from its MAILBOX file 3.7 and would like to let users edit,
instead, various fields in the NEW PERSON file 200.
The fields are:
31.3 preferred editor .111 street address 1 .112 street address 2 .113
street address 3 .114 city .115 state .116 zip .132 office phone .133
phone #3 .134 phone #4 .136 fax # .137 voice pager .138 digital pager
I intend to let the user edit the fields using a FileMan call. I intend to
retrieve the data by direct global reads. One global access will retrieve the
record with the address fields; the other, the record with the phone numbers.
I will not be retrieving the data for the preferred editor.
2232 Resource Device Routine KERNEL 1997/11/05 APPROVED Active Supported
This IA describes some API's to support Resource
devices.
XUDHSET
2235 DBIA2235 File KERNEL 1997/11/06 APPROVED Active Private 4
This agreement gives permission to execute a $Order
direct global read of the 'LOC' Cross Reference on the Institution file (#4).
In addition, editing of the CURRENT LOCATION field (#720) in the Institution
file, using supported FileMan calls, is also allowed. Edits to this field
affect the 'LOC' Cross Reference by setting or killing it as needed.
2017/08/14
2240 ENCRYPTING -- CLIENT/SERVER Routine KERNEL 1997/11/19 APPROVED Active Supported
Kernel and the RPC Broker provide encryption functions
that can be used to encrypt messages sent between the client and the server.
This function encrypts a string before transport to a Client system, where it
will be decrypted.
XUSRB1
2241 DECRYPTING -- CLIENT/SERVER Routine KERNEL 1997/11/19 APPROVED Active Supported
Kernel and the RPC Broker provide encryption functions
that can be used to encrypt messages sent between the client and the server.
This function decrypts a string that was encrypted on a Client system.
XUSRB1
2243 Tasking KIDS Installation Routine KERNEL 1997/12/03 APPROVED Active Controlled Subscription
The purpose of this DBIA is to document the use of a
KIDS entry point to task off a KIDS Install. This is useful if a large
conversion needs to run in background while users are back on the system. For
example, the first KIDS build can install a new version of software, then task
off a second clean-up/conversion build. This allows users back on the system
because the new version install completes and unlocks options and protocols.
Meanwhile the clean-up runs in background under KIDS and makes use of KIDS
checkpoints, restart upon failure, and message logging that can later be
accessed in the Install File Print.
XPDIJ
2246 DBIA2246 File KERNEL 1998/01/07 APPROVED Active Controlled Subscription 19
Inpatient Medications requests permission to $O through
the OPTION file (#19), "B" cross reference. We also request Write access by
VA FileMan to the OUT OF ORDER MESSAGE field (#2). In version 5.0, this code
is used to disable options during the pre install routine and enable them in
the post install routine. The group of options that deal with Pick Lists are
inactivated during the pre install routine. The options cannot be enabled
until the end of the Pick List conversion, which is hours after the KIDS
install finishes. The last task of the Pick List conversion routine is to
enable the Pick List options again. This is needed to keep the users from
processing any Pick Lists until the conversion is completely finished. Making
the edit to the OUT OF ORDER MESSAGE FIELD seems to be the only way to
accomplish this job.
2247 DBIA-2247 File KERNEL 1997/12/09 APPROVED Active Controlled Subscription 3.2
Outpatient Pharmacy package request permission to look
at TERMINAL TYPE file 3.2.
2250 DBIA2250 File KERNEL 1997/12/09 APPROVED Active Private 49
Outpatient Pharmacy requests permission to access data
in the SERVICE/SECTION (#49) file.
One use will be to loop through the file to retrieve internal entry numbers to
be used for a call to Integrated Billing to find the correct entry necessary
to process Co-pay prescriptions in Pharmacy.
Another will be to access the names of the file entries in order to provide
complete demographic information for an outpatient site through the Pharmacy
Reengineering APIs.
2011/01/21
2251 DBIA-2251 File KERNEL 2003/08/25 APPROVED Active Controlled Subscription 4
Outpatient Pharmacy package request permission to look
at INSTITUTION file 4 to get the Institution name and/or station number.
2252 DBIA2252 File KERNEL 1997/12/16 APPROVED Active Private 7
This request is so that the Laboratory Package to be
able to read from the ^DIC(7, global. The purpose of this would be to take
the second piece of the zero node, ^DIC(7,D0,0)= (#.01) NAME [1F] ^ (#1)
ABBREV. TITLE [2F] ^ to append onto the Pathologist's Name on the various
Pathology reports.
This should be a temporary request and can be revisited when the Anatomic
Pathology reports incorporate electronic signature.
2320 DBIA2320 Routine KERNEL 1998/02/09 APPROVED Active Supported
The %ZISH calls described in the KERNEL SYSTEM Manual.
This is a set of calls to work with Host files of the underlaying system.
%ZISH
2343 DBIA2343 Routine KERNEL 1998/03/10 APPROVED Active Supported
The routine XUSER has supported entry points to lookup
a user, check to determine if a user is active, DEA# details, DETOX#,
authorized to write Controlled Substances, etc.
Amended - Added 1/30/2023 The API's are designed to be backward compatible, so
that calls to APIs that formerly returned DEA information stored in the DEA#
field (#53.2), DEA EXPIRATION DATE field (#747.44), and the SCHEDULE fields
(#55.1-55.6) will now receive the same information from new fields in the DEA
NUMBERS file (#8991.9). Pharmacy code changes that use the new APIs and new
input parameters are in the Pharmacy Operational Updates Release 3 patches
PSO*7*545, PSJ*5*372, and OR*3*499.
XUSER 2023/02/08
2359 DBIA2359 Other KERNEL 1998/04/07 Pending Supported
In order to provide internal workstation identification
by way of the Kernal/Broker session, read access of the session variable
IO("CLNMN") is required for the purpose of controlling remote processes.
2362 DBIA2362-A File KERNEL 1998/04/21 APPROVED Active Private 19.081
Surgery request read access for all fields within the AUDIT LOG FOR
OPTIONS File (#19.081), to produce a sorted audit report using the
Surgery sort template, [SR BLOOD PRODUCT VERIFICATION].
The Surgery sort template, [SR BLOOD PRODUCT VERIFICATION]
is coded to print the Audit Log for the Surgery option
[SR BLOOD PRODUCT VERIFICATION] only.
^XUSEC(19,D0,0)= (#.01) OPTION [1P] ^ (#1) USER [2P] ^ (#2) DEVICE [3F] ^
==>(#3) JOB [4N] ^ (#4) DATE/TIME OF EXIT FROM OPTION [5D] ^
==>(#5) CPU [6F] ^ ^XUSEC(19,D0,1)= (#6) MESSAGE NUMBER [1N] ^
(#7) SENDER [2F] ^ ^XUSEC(19,D0,2)= (#8) SUBJECT [E1,65F] ^ ^XUSEC(19,D0,3)=
(#9) ACTION [E1,245F] ^
----------------------------------------------------------------------
Example of Sort Template SR BLOOD PRODUCT VERIFICATION;
NAME: SR BLOOD PRODUCT VERIFICATION Replace READ ACCESS: @// WRITE ACCESS:
@// SORT BY: ]DATE/TIME// * Previous selection: DATE/TIME from Jan 1,1998
START WITH DATE/TIME: FIRST//
WITHIN DATE/TIME, SORT BY: OPTION["SR BLOOD PRODUCT VERIFICATION";L1
Replace
WITHIN OPTION["SR BLOOD PRODUCT VERIFICATION", SORT BY: STORE IN 'SORT'
TEMPLATE: FIRST PRINT FIELD:
2363 DBIA2362-B Other KERNEL 1998/04/21 APPROVED Active Private
The Surgery package requests permission to use the KERNEL print template,
[XUOPTLOGP]. It will be called from the Surgery option, [SR BLOOD PRODUCT
VERIFY AUDIT], to print the Audit Log for the Surgery option [SR BLOOD
PRODUCT VERIFICATION].
2430 USE OF XUTL('XQORM', Other KERNEL 1998/05/21 APPROVED Active Controlled Subscription
Setting data into XUTL("XQORM" allows the protocol
unwinder to display the data as if it were a protocol. This has been used for
quite some time, but was never formally requested/documented.
2433 XPDGREF Other KERNEL 1998/06/10 APPROVED Active Supported
Developers can put information in the KIDS Transport
Global, ^XTMP. The transport global will be available during the Environment
Check, Pre-Install, and Post-Install routines. The developer can access the
information by using the variable XPDGREF to read or set the transport global.
example: to set the transport global
S @XPDGREF@("My subscript",1)="Information I need"
to read the transport global
S X=@XPDGREF@("My subscript",1)
Developers can create a routine that will always set information into the
transport global whenever a package is transported. The field,
PRE-TRANSPORTATION ROUTINE, will be run during the transport process. The
variable XPDGREF will be available to set information into the transport
global.
2469 LAB ACCESSING FIELD LAB LABEL PRINTER IN DEVICE FILE File KERNEL 1998/07/07 APPROVED Active Private 3.5
Lab requests permission to access the LAB LABEL PRINTER
field (#101) in the Kernel DEVICE (#3.5) file. Field is used to determine if
user has a Lab label printer associated with the user's home device in the
DEVICE (#3.5) file. If an association exists then this device is used as the
default prompt for label printer instead of the standard LABLABEL device.
Code to access this field is as follows:
I $G(IOS) D ; Check if label device assigned to this user's HOME Device
. S X=$$GET1^DIQ(3.5,IOS_",",101,"E")
. I $L(X) S %ZIS("B")=X
2489 FILE CORRECTIONS File KERNEL 1998/08/05 Withdrawn Private 9.4
More than one Library Package entry exists from the testing and
installation of Version 2.5 and Patches 1-4. We would like permission
to update the site's Package File #4 with one active and accurate
Library entry under the name LIBRARY and namespace LBR. It will
contain a '2.5' VERSION multiple with all the patch installations. If
the '2.5V1' VERSION multiple is present (this was created from the 2.5
version installation), we would like to create a '2.5' VERSION
multiple as a copy of the '2.5V1' multiple. If the Package File entry
for Library v.1.2 is present, we would like to rename it as
LIBRARY(OLD) under the renamed namespace LBRZ. This would eliminate
the need for DBIA #2142 "INSTALL File Read". If any other entries are
located, except the LBRN and LBRT entries (apart of 2.5 installation),
we would like to delete them. We would also like to update the
CURRENT VERSION field with the latest version 2.5. This will prevent
any future NOIS logs related to this.
In order to complete this update, we would like to modify the Package
File entry that Patch LBR*2.5*7 linked to in the load. This
modification would use FILE^DIE to update the NAME and PREFIX to
LIBRARY and LBR, respectively. Then to continue with the update, we
would like to use FIND^DIC to locate all Package File entries having a
PREFIX beginning with "LBR". From each of these Package file entries,
we would like to use FIND^DIC to locate the '2.5V1' VERSION multiple
entry. We would then like to use the IEN from the '2.5V1' VERSION
multiple entry and GETS^DIQ to retrieve the DATE DISTRIBUTED (1), DATE
INSTALLED AT THIS SITE (2), INSTALLED BY (3), and DESCRIPTION OF
ENHANCEMENTS (41) fields to create a '2.5' VERSION multiple.
To rename the v.1.2 package file entry, we would like to use FILE^DIE
to change the NAME and PREFIX fields to LIBRARY(OLD) and LBRZ,
respectively. To remove all unimportant Library Package file entries,
we would like to use ^DIK.
In order to update the CURRENT VERSION field, we would like to use
GET1^DIQ to retrieve the present CURRENT VERSION field value and
FILE^DIE to change it to "2.5".
2490 PATCH INSTALLATION CHECK AND UPDATE File KERNEL 1998/08/05 Withdrawn Private 9.7
In order to complete all corrections to the Package File #9.4
referenced in DBIA #2489, we would like to have permission to check
and update any Library Package Patch installations stored in the
Install File #9.7. To locate the Library v.2.5 patches, we would like
to use FIND^DIC and extract the entries' corresponding data in their
STATUS(.02), PACKAGE FILE LINK(1), INSTALLED BY(9), and INSTALL
COMPLETE TIME(17) fields. For each Library patch install entry, we
would also like to use GET1^DIQ to extract the internal value for the
pointer in the PACKAGE FILE LINK field. In order to update this field
with the pointer to the correct Library Package File entry, we would
like to use FILE^DIE. Error checking for each check and update will
be performed.
2495 DBIA2495 File KERNEL 1998/08/11 APPROVED Active Private 7
Pharmacy Benefits Management needs to extract the name
and abbrev from the Provider Class File #7. The provider pointer (#200) will
be obtained from various pharmacy files. The new person provider class field
#53.5 will be then be used to extract the name and abbrev from the Provider
Class File.
2500 DBIA 2500 Routine KERNEL 1998/08/12 APPROVED Active Private
Requesting approval to use DOLRO^%ZOSV.
This entry is in every Kernel %ZOSV and only requires the variable X as input
as to where the user wants to store a list of the variables in the partition.
This functionality is desired and it is located within the Kernel for each
platform that Kernel runs on.
Its use is requested so that seperate hardcoded routines for each platform do
not have to be written to achieve the same functionality.
This request is made in behalf of the Pharmacy Benefits Program (PSU) and
McKinley Enterprises | WesTech Computer Group (BTW) who is coding PBM under
contract with EDS through the VA - EDS Partnership.
%ZOSV
2508 2508 File KERNEL 1998/08/20 APPROVED Active Private 4
The lab requests a DBIA to perform a direct read on the
following:
S:$D(^DIC(4,"D",SITE)) ISITE=$O(^DIC(4,"D",SITE,0)) I
+ISITE>0,$G(^DIC(4,ISITE,0))'="" S SITE=$P(^DIC(4,SITE,0),U,1)
2509 DBIA2509 File KERNEL 1998/08/24 APPROVED Active Private 19
Surgery requests permission to $O through the OPTION
file (#19) "B" cross reference to identify options in the SR namespace.
Surgery further requests READ access by VA FileMan to the ENTRY ACTION field
(#20) and WRITE access to the XQUIT EXECUTABLE field (#22). The purpose of
this request is to allow Surgery to issue a patch that will identify the
Surgery options that may potentially set the XQUIT variable and to update
these options with code to process the XQUIT.
2533 DBIA2533 Routine KERNEL 1998/09/08 APPROVED Active Controlled Subscription
DSS has permission to use the Kernel function
DIV4^XUSER according to the following:
XUSER New file 200 API for DSS.
The call is S X=$$DIV4^XUSER(.ZZ[,duz])
Input: The first parameter is a local variable that
is passed by reference.
The second is an optional IEN to the New Person file.
If not passed it defaults to the current DUZ.
Output: Returns a 1 if the user has a Division entry
in the New Person file, else returns 0.
If it returns a 1 then the first parameter is an array
of IEN's for file 4 that have been assigned to the user.
XUSER
2539 DELETE OPTIONS File KERNEL 1998/09/21 APPROVED Active Private 19
This integration agreement is only for Registration.
Permission to loop through the "B" xref on the option file to delete all
'DG172' namespaced options created by the DG*5.3*172 patch.
2541 DBIA2541 Routine KERNEL 1998/09/21 APPROVED Active Supported
This DBIA documents the supported calls to XUPARAM to
get some KERNEL SYSTEM parameters fields.
XUPARAM
2542 DBIA2542 Routine KERNEL 1998/09/21 APPROVED Active Supported
These are calls to set or get simple parameters from a
file that the site can edit. The file is KERNEL PARAMETERS (#8989.2)
XUPARAM
2581 SERVER ACTION edit during install File KERNEL 1998/09/24 APPROVED Active Controlled Subscription 19
This integration agreement is for setting the SERVER
ACTION field (#221) of the OPTION file (#19) while a patch to the server logic
is being installed. The SERVER ACTION field will be reset in a post-init to
its original value.
2589 NEW PERSON editing File KERNEL 2001/08/31 APPROVED Active Private 200
With patch RG*1*21, Master Patient Index/Patient Demographics exports
a new option, Add/Edit Point of Contact [RG UPDATE POINT OF CONTACT].
This option allows a facility to update the administrative, IRM and
HL7 points of contact name and phone number. This information is sent
to the MPI/PD Data Management staff so that they can update the website.
The point of contact names reside in the CIRN SITE PARAMETER (#991.8)
file and point to the NEW PERSON (#200) file. The option edits the
OFFICE PHONE (#.132) field in the NEW PERSON (#200) file, via a FileMan
^DIE call for the identified point of contact.
2596 Audit File Reference to Protocol File File KERNEL 1998/10/27 APPROVED Active Controlled Subscription 101
CIRN made a request to the FileMan Development Team to add to the Audit File
a field that would keep track of what menu Protocol was used to change the
data being audited.
2605 DBIA2605 File KERNEL 1998/10/13 APPROVED Active Controlled Subscription 9.4
^DIC(9.4,"C", cross reference - The software
facilitating this DBIA, orders through the "C" cross reference which is a
cross reference of the PREFIX field (#1) of the PACKAGE file (#9.4). If the
PREFIX is "YS", the code then checks the SHORT DESCRIPTION field (#2) of the
PACKAGE file (#9.4). If this field does NOT equal "Version 5.01 of Mental
Health", the code either (1) deletes the entry from the package file or (2)
renames the PREFIX from YS to YS_integer (beginning with 1, incremented by 1,
i.e. YS1, YS2, YS3, etc.) depending on the number of Mental Health entries
that are not version 5.01. User response to the 'Delete old PACKAGE file
entries?' question determines which action will be performed by the code.
2622 DBIA2622 Routine KERNEL 1998/10/20 APPROVED Active Supported
Use of the XLFUTL APIs.
XLFUTL
2625 PACKAGE POINTER UPDATES File KERNEL 1998/10/22 Withdrawn Private 19
In order to complete all corrections to the Package File #9.4
referenced in DBIA #2489, we would like to have permission to check
and update any Library Package Options stored in the Option File #19.
To locate the Library v.2.5 patches, we would like to use FIND^DIC and
extract the entries' corresponding data in their PACKAGE(12) field.
If the entry is not pointing to the correct Library Package File
entry, we would like to update this field with the correct pointer
using FILE^DIE. Error checking for each check and update will be
performed.
2626 PACKAGE FILE LINK UPDATES File KERNEL 1998/10/22 Withdrawn Private 9.6
In order to complete all corrections to the Package File #9.4
referenced in DBIA #2489, we would like to have permission to check
and update any Library Package KIDS builds stored in the Build File
#9.6. To locate the Library v.2.5 patches, we would like to use
FIND^DIC and extract the entries' corresponding data in their PACKAGE
FILE LINK(1) field. If the entry is not pointing to the correct
Library Package File entry, we would like to update this field with
the correct pointer using FILE^DIE. Error checking for each check and
update will be performed.
2641 KIDS VARIABLES Other KERNEL 1998/11/09 APPROVED Active Supported
Variable(s) available pre, during, and post KIDS
installation.
Variable: XPDPKG = Package file entry ien for build that is currently
being processed.
2656 DBIA2656 File KERNEL 1998/12/03 APPROVED Active Private 9.4
I would like to kill the "AMRG" cross reference (x-ref)
for the 'Toolkit' entry in the Package File. The entry that created this
x-ref was manually killed by XT*7.3*33 Post-Init routine, but the x-ref was
inadvertently left. This would be a once time occurance to clean-up the
'Toolkit' entry in the Package File. The "AMRG" cross reference is a whole
file x-ref made on the "File Affected" (Field .01) for the "Affects Record
Merge Sub-File" (Field 20) in the Package File (#9.4).
2689 OE/RR references to ALERT file File KERNEL 2003/03/05 APPROVED Active Controlled Subscription 8992
OE/RR utilizes the alerting functionality extensively.
While supported calls are often used, there are also direct references to the
ALERT file (#8992) as described in this DBIA.
2709 New Person file File KERNEL 1999/04/26 APPROVED Active Private 200
The Laboratory package is cleaning up a reference to
the Person file (#16). We need read access only to the A16 cross reference of
the New Person file (#200). This access is only for use with patch
LR*5.2*237.
2715 READ NEW PERSON (#200) FILE NAME & SSN FIELDS File KERNEL 1999/01/19 Withdrawn Private 200
Registration requires direct global read access to the
Name (#.01) and SSN (#9) fields in the New Person (#200) for Privacy Act
compliance. Routine DGSEC will be modified to obtain the user's name and SSN
from the New Person file.
2718 Check TaskMan State File KERNEL 1999/01/20 APPROVED Active Private
FileMan KIDS Enviromental Check routines:
DIENVWRN (Warn the installer, but allow the install to continue)
and
DIENVSTP (Stop the install)
need to check TaskMan's enviroment to see if TaskMan is in a STOPed state or
is in the "WAIT" state. There is a supported call to: $$TM^%ZTLOAD which
returns whether or not TaskMan is running, but not if TaskMan is in a "WAIT"
state. The following code is used in routines DIENVWRN and DIENVSTP to check
for these conditions:
TMCHK ; Check to see if TaskMan is still running
S X=$$TM^%ZTLOAD
I X,'$D(^%ZTSCH("WAIT")) D
FileMan would like a temporary intergration agreement, with the Kernel, until
such time as $$TM^%ZTLOAD can return all three conditions Running, Waiting,
and Stopped.
2719 Logons Inhibited File KERNEL 1999/01/20 APPROVED Active Private
FileMan KIDS Enviromental Check routines:
DIENVWRN (Warn the installer, but allow the install to continue)
and
DIENVSTP (Stop the install)
need to check if Logons have been Inhibited and the following code is being
used:
LINH ; Check to see if Logons are Inhibited
D GETENV^%ZOSV ; $P(Y,"^",2) = Installing Volume
S X=+$G(^%ZIS(14.5,"LOGON",$P(Y,"^",2)))
I 'X D Q ; Bail Out of Install
FileMan would like a temporary intergration agreement, with the Kernel, until
such time a single call can be developed that will return whether or not
Logons have been Inhibited.
2762 minus 9 nodes File KERNEL 1999/03/01 APPROVED Active Controlled Subscription 2
MPI needs to check for the -9 node on the Patient file.
If the -9 node exists for a given entry, the MPI needs to not use this patient
entry.
NOTE: Duplicate Merge is responsible for setting the -9 node in the Patient
(#2) file. The Patient (#2) file is part of the Registration package.
However because Duplicate Merge is responsible for setting this node, it was
decided Kernel should be the Custodial Package as recommended by the DBA.
2763 Read %ZTSK Global File KERNEL 1999/03/01 APPROVED Active Private
Because Fileman supports both a non-VistA Kernel
environment and a VistA Kernel environment, a test is necessary to determine
which environment is present. A test that is used to determin if Queueing is
Allowed, therefore a VistA Kernel environment, is by checking whether or not
the %ZTSK global is present.
2777 MODIFY ONCOLOGY PACKAGE ENTRIES File KERNEL 1999/03/19 APPROVED Active Private 9.4
The ONCOLOGY package has two PACKAGE file entries. The
correct entry contains in incorrect PREFIX value which causes the KIDS
"Required Build" feature to function incorrectly. The incorrect entry
contains PATCH APPLICATION HISTORY data which belongs in the correct entry.
We would like to 1) modify the PREFIX values of both PACKAGE entries, 2) move
the PATCH APPLICATION HISTORY data from the incorrect entry to the correct
entry and 3) delete the PATCH APPLICATION HISTORY data from the incorrect
entry. These modifications will be achieved via standard FileMan calls.
2788 XQALBUTL Routine KERNEL 1999/03/25 APPROVED Active Supported
This DBIA lists and defines supported references within
the routine XQALBUTL.
AHISTORY(XQAID,ROOT) - Returns info on alert XQAID in ROOT in global format
$$PENDING(XQAID,XQAUSER) - Indicates whether alert XQAID is pending for user
XQAUSER (1=YES, 0=NO).
$$PKGPEND(XQAUSER,XQAPKG) - Returns 1 if the user indicated by XQAUSER has any
pending alerts in which the first ';'-piece of XQAID contain the package
identifier indicated by XQAPKG.
ALERTDAT(XQAID,ROOT) - Returns info on alert XQAID in ROOT by field and values
(if ROOT is not specified, returned in local variable XQALERTD)
USERLIST(XQAID,ROOT) - Returns list of users who received alert XQAID in array
under ROOT (if ROOT is not specified, returned in local variable XQAUSRS)
USERDATA(XQAID,XQAUSER,ROOT) - Returns info on user XQAUSER for alert XQAID in
ROOT by field and values (if ROOT is not specified, returned in local variable
XQALUSER).
XQALBUTL
2790 XQALSURO Routine KERNEL 1999/03/25 APPROVED Active Supported
This DBIA describes supported references in the routine
XQALSURO which may be used to obtain information on, set, or remove a
surrogate for alerts for a user.
XQALSURO
2818 OE/RR References to Alert Tracking File File KERNEL 1999/05/17 APPROVED Active Private 8992.1
OE/RR utilizes the alert tracking file to obtain
information from existing alerts to process new alerts.
The routine ORB3REG directly accesses the XTV(8992.1 (Alert Tracking) global
to obtain information from existing alerts.
2008/10/22
2823 DBIA2823 File KERNEL 1999/05/19 APPROVED Active Private 8932.1
IB is using a pointer to the Person Class file
(#8932.1) to define types of providers.
2824 DBIA2824 File KERNEL 1999/05/24 APPROVED Active Private 200
Nursing requires direct global read access to the following fields in the New
Person (#200) file which contain the telephone data used in the nursing End of
Shift Report:
.131 PHONE (HOME)
.132 OFFICE PHONE
.133 PHONE #3
.134 PHONE #4
.135 COMMERCIAL PHONE
.136 FAX NUMBER
.137 VOICE PAGER
.138 DIGITAL PAGER
2846 DBA2846 Routine KERNEL 1999/06/14 APPROVED Active Private
Broker uses $$BAT^XUPARAM in two situations to retrieve
the value of the Broker Activity Timeout, which is stored in the Kernel System
Parameters file: 1)to set the timeout on READs waiting for client requests.
2) to pass the tiemout value back to the client in order to determine the
frequency of polling from client to server.
XUPARAM
2857 XUS GET USER INFO Remote Procedure KERNEL 1999/06/29 Active Controlled Subscription
This rpc is used by BROKER to maintain a User object in
the Delphi environment.
XUS GET USER INFO
2882 DBIA2882 Routine KERNEL 1999/08/04 APPROVED Active Controlled Subscription
XUSRB contains some API's that can be used by other
application to check user access.
XUSRB
2899 DBIA2899 File KERNEL 1999/08/26 Pending Private 19
The PCMM package would like to do the following in
conjunction with a KIDs install:
o Look-up a PCMM Kernel menu option - Use ^DIC
o Rename option - Use FILE^DIE
2939 OE/RR direct views of DIC(49 File KERNEL 1999/10/28 APPROVED Active Private 49
This DBIA documents direct global references made by
OE/RR to the SERVICE/SECTION file (#49). These references are mainly used by
CPRS GUI to retrieve and display a list of selectable entries from file 49.
2963 Direct access to %ZIS(1 File KERNEL 1999/11/10 APPROVED Active Controlled Subscription 3.5
This DBIA documents direct access to fields in the
DEVICE file (#3.5).
2964 Direct access to %ZIS(2 File KERNEL 1999/11/10 APPROVED Active Controlled Subscription 3.2
This DBIA documents direct access to the TERMINAL TYPE
file (#3.2).
3009 XQALFWD Routine KERNEL 1999/12/08 APPROVED Active Supported
This entry point can be used to forward alerts (in most
cases, for the current user only). It is a silent (no screen input or output)
entry point, and so can be used for windowed applications.
Example ; get open alerts for current user K A6AALRT D USER^XQALERT("A6AALRT")
;
I +A6AALRT D ; if any current alerts... .; loop through A6AALRT array, parse
alert id for each open alert .K A6AALRT1 S A6ASUB="",A6AI=0 .F S
A6ASUB=$O(A6AALRT(A6ASUB)) Q:'$L(A6ASUB) D ..S
A6AI=A6AI+1,A6AALRT1(A6AI)=$P(A6ASUB,"^",2)
.;
.;forward open alerts of current user to MAS CLERKS mailgroup .K A6AUSER S
A6AUSER="G.MAS CLERKS" .D FORWARD^XQALFWD(.A6AALRT1,A6AUSER,"A","Forwarded
Alert") Q
XQALFWD
3010 XQALBUTL Routine KERNEL 1999/12/08 APPROVED Active Supported XQALBUTL
3041 ACCESS TO FILE 20 NAME COMPONENTS File KERNEL 2000/02/16 APPROVED Active Controlled Subscription 20
All fields can be accessed/edited using FileMan tools.
Each entry in the NAME COMPONENTS file (#20) corresponds to a single source
name field in another file. The following three fields in the NAME COMPONENTS
file contain information about the source name field. These three fields
comprise the Primary Key for the NAME COMPONENTS file.
.01 File Number of file that contains source name field
.02 Field Number of the field that contains the source name field
.03 IENS (Internal Entry Number string) of the record that contains the
name to which this entry corresponds.
The name field in the source file should have cross-references that keep its
value in synchronization with the corresponding entry in the NAME COMPONENTS
file. For an example of this, see the .01 field of the NEW PERSON file.
The following fields are normally available for editing by end-users.
Field # Name
1 FAMILY (LAST) NAME
2 GIVEN (FIRST) NAME
3 MIDDLE NAME
4 PREFIX (ex., MR, MS)
5 SUFFIX (ex., JR, III, ESQ)
6 DEGREE (ex., PHD)
(The DEGREE and PREFIX field are not part of the source name field (#.01) of
the NEW PERSON file.) Kernel APIs that return the name components are
available.
When any of the following fields in the NAME COMPONENTS file are edited via
FileMan tools:
Field # Name
.01 FILE
.02 FIELD
.03 IENS
1 FAMILY (LAST) NAME
2 GIVEN (FIRST) NAME
3 MIDDLE NAME
5 SUFFIX
7 SOURCE NAME FORMAT FLAGS
the "ANAME" MUMPS cross-reference automatically updates the corresponding
source name field in the source file to reflect the changes. To prevent this
cross-reference from firing, you can NEW the variable XUNOTRIG and SET it to 1
before editing the any of the above fields.
3056 DNS lookup Routine KERNEL 2000/03/01 APPROVED Active Supported
Call a DNS to resolve Domain names.
XLFNSLK
3057 SET~XUS1A Routine KERNEL 2000/03/06 APPROVED Active Supported
The is a API for use by code called from the XU USER
SIGN-ON protocol to pass text back to the user.
XUS1A
3065 Name Standardization APIs Routine KERNEL 2000/03/15 APPROVED Active Supported
Supported Name Standardization APIs.
XLFNAME
3066 NAME COMPONENTS UPDATE Routine KERNEL 2000/03/15 APPROVED Active Controlled Subscription
Controlled Subscription Name Standardization APIs.
XLFNAME2
3069 DBIA3069 File KERNEL 2000/03/22 Pending Private 200
PCMM requires direct read access to the Name (.01) and
SSN (#9) fields in the New Person (#200) for Programmer Management Advisory
board.
3103 RESOURCE FILE MANAGEMENT File KERNEL 2000/05/04 APPROVED Active Private 3.54
To prevent multiple jobs from running simultaneously
through a resource device, the device must be monitored. Also, if a job that
is utilizing a resource device fails, the device must be cleared manually.
This IA will allow the CMOP package to manage the PSX resource device and
prevent potentially harmful results from data merging.
3105 TASK FILE LOOKUP File KERNEL 2000/05/04 APPROVED Active Private
The CMOP package requests the ability to perform a
check against a lock being held on ^%ZTSCH("TASK",ZTSK) to enable a background
reset of the resource device PSX.
3106 Problem List direct views of DIC(49 File KERNEL 2000/05/04 APPROVED Active Private 49
This DBIA documents direct global references made by
Problem List to the SERVICE/SECTION file (#49). These references are used by
Problem List to retrieve the service abbreviation from file 49. This data is
then provided to Health Summary for display.
3156 XLFCRC Routine KERNEL 2000/08/04 APPROVED Active Supported
This routine has two API's, CRC32 and CRC16.
SET CRC=$$CRC32^XLFCRC(string)
A check-sum can also be calculated over multiple strings.
SET (I,C)=0
FOR SET I=$ORDER(X(I)) QUIT:'I DO
. SET C=$$CRC16^XLFCRC(X(I),C)
or
SET I=0,C=4294967295
FOR SET I=$ORDER(X(I)) QUIT:'I DO
. SET C=$$CRC32^XLFCRC(X(I),C)
as long as the save method is used all the time.
These have been approved for inclusion in a future ANSI M[UMPS] language
standard as part of the library.
XLFCRC 2007/11/06
3172 Special Printer Variables Routine KERNEL 2000/08/28 APPROVED Active Supported
Entry points for special printer variables.
%ZISP
3173 XGF Function Library Routine KERNEL 2000/08/28 APPROVED Active Supported
This XGF Function Library supports terminals that are
ANSI-compatible and at least VT100-compatible. As a result, this software does
not support QUME QVT102/QVT102A terminals.
Programmer Tools > D ^XGFDEMO: Demo Program To run an interactive
demonstration showing the capabilities provided by the XGF Function Library,
you can run the XGF demo program. From the programmer prompt, type the
following: >D ^XGFDEMO <RET>
Functional Division of XGF Function Library Cursor/Text Output: IOXY^XGF,
SAY^XGF, SAYU^XGF. Keyboard Reader: $$READ^XGF. Setup/Cleanup: CLEAN^XGF,
INITKB^XGF, PREP^XGF, RESETKB^XGF. Text Window: CLEAR^XGF, FRAME^XGF,
RESTORE^XGF, SAVE^XGF, WIN^XGF. Video Attribute: CHGA^XGF, SETA^XGF.
XGF
3175 Measurement Functions Routine KERNEL 2000/08/28 Withdrawn Supported
This routine contains entry points to allow conversion
between U.S. (English) and Metric units.
XLFMSMT
3178 Convert String to Soundex Routine KERNEL 2000/08/29 APPROVED Active Supported
Use this function to convert a string into a numeric
representation of the string, using soundex methods. Soundex represents the
phonetic properties of a string; its chief feature is that it assigns similar
strings the same soundex representation.
XUA4A71
3213 XQALSURO Routine KERNEL 2000/09/27 APPROVED Active Supported
This integration agreement adds two additional
SUPPORTED entry points or APIs to XQALSURO.
SETSURO1 should be used in the future instead of SETSURO to establish a
surrogate for alerts. SETSURO1 returns a value of 1 if the surrogate was
created successfully, otherwise, it returns a text string explaining why the
surrogate was not created. SETSURO simply added the specified surrogate, but
did not test for cyclic relationships (such that the user eventually would
become the surrogate). SETSURO1 does these tests and therefore has the
possibility of failure.
GETSURO is an API which can be used to obtain information about the current
surrogate, including start and end date/times if they are specified.
SUROLIST is an API which can be used to obtain a list of the current and
future surrogate periods for a selected user.
SUROFOR is an API which can be used to obtain a list of any current users that
the selected user is acting as a surrogate for.
XQALSURO 2009/07/29
3226 XUTMUTL Routine KERNEL 2003/05/19 Retired Supported
This routine has some supported API's for access to
Taskman data.
XUTMUTL
3230 DBIA 3230 Imaging Device file entry Other KERNEL 2000/10/24 APPROVED Active Private
This request is to allow the VistA Imaging package to
add a HFS device to the DEVICE file and a Terminal Type entry; this is done
during the installation of the Imaging application. The entry for the Device
file will be named IMAGING WORKSTATION and the Terminal Type file entry will
be named P-IMAGING. This device is used by the GUI portions of VistA Imaging
to generate DHCP reports into a global array format.
The following is the code used to create this device:
EN ;Create an entry in the Device file for an Imaging workstation.
;
TERM N A,DA,DD,DO,DIC,DIE,ENTRY,X,Y
W !,"I will setup the 'P-IMAGING' entry in the Terminal Type file."
I $D(^%ZIS(2,"B","P-IMAGING")) D G DEV
. W !,"An entry already exists for 'P-IMAGING' in the Terminal Type
file
."
;Set the entry
S DIC="^%ZIS(2,"
S X="P-IMAGING",DIC(0)="O" K DD,D0 D FILE^DICN
S ENTRY=+Y G:'ENTRY ERRDEV
S DR=".02///0;1///80;2///"_"#"_";4///"_"$C(8)"_";7///"_"D
CLOSE^MAGGTU5; 3///64"
S DA=ENTRY,DIE="^%ZIS(2," D ^DIE
;.02/SELECTABLE AT SIGNON;1/RIGHT MARGIN;2/FORM FEED;4/BACK SPACE
;7/CLOSE EXECUTE;3/PAGE LENGTH DEV N
A,DA,DD,DO,DIC,DIE,ENTRY,X,Y,MAGOS
W !,"I will setup an 'Imaging Workstation' entry in the Device file."
I $D(^%ZIS(1,"B","IMAGING WORKSTATION")) D Q
. W !,"An entry already exists for 'IMAGING WORKSTATION' in the Device
f ile."
S DIC="^%ZIS(1,"
S X="IMAGING WORKSTATION",DIC(0)="O" K DD,D0 D FILE^DICN
S ENTRY=+Y G:'ENTRY ERRDEV
I ^%ZOSF("OS")["DSM" D
. S MAGOS="DSM"
. S DA=ENTRY,DR=".02///"_"BROKER"_";3///"_"P-IMAGING"_";1///"_"WS.DAT"
. S DR=DR_";4///0;5///0;19///"_"(NEWVERSION,DELETE)"_";2///"_"HFS"
. S DIE="^%ZIS(1,"
I ^%ZOSF("OS")["OpenM" D
. S MAGOS="OPENM"
. S DA=ENTRY,DR=".02///"_"BROKER"_";3///"_"P-IMAGING"_";1///"_"WS.DAT"
. S DR=DR_";4///0;5///0;19///"_"""NWS"""_";2///"_"HFS"
. S DIE="^%ZIS(1,"
I ^%ZOSF("OS")["MSM" D
. S MAGOS="MSM"
. S DA=ENTRY,DR=".02///"_"BROKER"_";3///"_"P-IMAGING"_";1///"_"WS.DAT"
. S DR=DR_";4///0;5///0;19///"_"(""WS.DAT"":""M"")"_";2///"_"HFS"
. S DIE="^%ZIS(1,"
I $D(MAGOS) D ^DIE
;.02/LOCATION OF TERMINAL;3/SUBTYPE;1/$I;4=ASK DEVICE;5/ASK PARAMETERS
;19/OPEN PARAMETERS;2/TYPE
Q ERRDEV ;
W !,"Could not setup the IMAGING WORKSTATION entry in the Device
file."
W !,"Could not setup the P-IMAGING entry in the Terminal Type file."
MSG W !,"Please review the Installation Manual to create this entry."
Q
3232 FILE COMMENTS File KERNEL 2000/10/27 Withdrawn Private 9.7
The Vista Imaging application supports the acquisition
and storage of clinical images received from diverse, foreign devices and
databases. It is our experience that the flexibility necessary to support a
broad range of products requires timely updates. This trend results in a loss
of homogeneity in the software distribution as sites are not always able keep
their systems current. It is an FDA requirement that we track our product so
that we can anticipate local issues and provide comprehensive support. It is
for this reason that the Imaging usage report, which triggers monthly reports
that update a local Vista Imaging development database, requires a more
granular build reference.
3262 DEVICE FILE File KERNEL 2000/12/04 Withdrawn Private 3.5
The GEN. MED. REC. - VITALS package (aka Vitals)
requests permission to read File 3.5 values to handle printing from within the
GUI environment.
3264 PROCESSING RTN FIELDS File KERNEL 2000/11/29 APPROVED Active Private 101
One time IA for the pre-init for patches LA*5.2*58 and
LR*5.2*266: The letter "Q" will need to be entered in the Processing RTN field
(#771) and the Response Processing RTN field (#772) of the Protocol file
(#101) for the LA7D CARELIFE RESULTS and the LA7D CARELIFE SERVER entries.
Leaving this field blank will, in some instances, cause an error. FileMan
utilities will be used to set these fields.
3265 TERMINAL TYPE FILE File KERNEL 2000/12/04 Withdrawn Private 3.2
The GEN. MED. REC. - VITALS package (aka Vitals)
requests permission to read File 3.2 values to handle printing from within the
GUI environment.
3272 DBIA3272 File KERNEL 2000/12/20 APPROVED Active Private 200
The Integrated Billing package requests a DBA exemption
to allow the .01 field of the IB BILLING PROVIDER ID file (355.9) to point to
the NEW PERSON file (200). This field is actually a variable pointer field
and the NEW PERSON file would be one of the files included in that variable
pointer file set. This will allow IB to access VA provider data without
duplicate entry for determining the correct provider id to use for claims.
3277 XUSRB Routine KERNEL 2000/12/29 APPROVED Active Supported
This IA records supported API's in the XUSRB routine.
This routine is used by Broker for GUI sign-on.
XUSRB
3281 Kernel Installation & Distribution System build status. File KERNEL 2001/01/03 APPROVED Active Controlled Subscription 9.7
The status of a Kernel Installation & Distribution
System (KIDS) build needs to be determined so a single distribution build
Alpha, can queue build Beta, another single distribution.
Before build Alpha queues build Beta, build Beta must be loaded from a
distribution.
3287 DBIA3287 File KERNEL 2001/01/04 APPROVED Active Private 8989.3
The IA is requested for a one-time-use for a set of
extract routines to read the value of the field. This version of the extract
routines will retire after successfully gathered data for qualified patients
at the sites.
3334 DBIA 3334 Imaging download of XUSRB1 Other KERNEL 2005/03/10 Retired Private
Kernel developers allow Imaging to dowload the XUSRB1,
XUMF333, and XULFDT routines onto satellite DICOM gateways. The routines are
not renamed nor modified on the gateways. Imaging is using supported APIs
from these routines. The Imaging DICOM workstations do not have KERNEL
installed, it has Micronetic M and a limited translation table to the hospital
datasets.
This IA will also request the following be provided on any future patches to
these routines. This will inform Imaging users on the procedures to follow
for downloading the Imaging routines on the gateways.
If you are running Vista Imaging, use the menu option to copy the routines
to the Imaging DICOM gateways as follows: "On the Vista server (hospital
database), use menu option 'Copy Routines to DICOM Gateway' located under the
'Imaging System Manager' Menu. Then on all Text and Image gateways use the
'System Maintenance' menu to select 'Gateway Configuration and DICOM Master
File' and then select 'Download Current Radiology and MAS Routines'. This will
cause the up-to-date versions of all radiology and MAS routines to be copied
to the gateway systems."
3354 Master File Server - IFR project Routine KERNEL 2001/04/12 Withdrawn Controlled Subscription
There are 2 API's used by the Master File Server
implemented by the Institution File Redesign (IFR) project -- XU*8.0*126.
MAIN^XUMFP sets up required parameters, and MAIN^XUMFI builds and sends the
HL7 message.
XUMFP XUMFI
3356 Kernel Variable XQY0 Other KERNEL 2001/04/13 APPROVED Active Controlled Subscription
Registration requests permission to reference the
variable XQY0 to obtain the current menu option. DG FIELD MONITOR logic will
be designed to run reguardless of the XQY0 being defined or set to "null".
The DG FIELD MONITOR protocol provides an event point to monitor field editing
in the DG* application files. Cross references and subscribers are added when
applications need to monitor activity on a field. XQY0 contains the current
menu option in the option name^menu text format when the cross references and
event point are executed. This information is made available to the
subscribing applications.
Variable: XQY0 = First node(zero subscript) of the current option.
Patient Name Standardization uses the XQY0 variable to identify the option
name. It will populate the NOTES ABOUT NAME (#11) field in the NAME
COMPONENTS (#20) file with the User's name, DUZ, and option name when an entry
is added or updated in the Name Components file.
3435 CONTROL CODES SUBFILE File KERNEL 2003/03/05 APPROVED Active Controlled Subscription 3.2
The purpose of this agreement is to allow direct MUMPS
read access to the CONTROL CODES subfile (#3.2055) of the TERMINAL TYPE file
(#3.2). Any subscribing package must coordinate the ABBREVIATION and FULL
NAME information with the KERNEL developers when subscribing to this
agreement. Also, the agreed upon control codes should be added to this
agreement for documentation.
Inpatient Medications is using the control codes to create generic print
routines for barcode printing. Inpatient Medications will use the following
control codes, as will Registration and Bar Code Medication Administration
(BCMA).:
ET - End Text
ETF - End Text Field
EB - End Barcode
EBF - End Barcode Field
EL - End Label
FE - Format End
FI - Format Initialization
FI1 - Format Initialization 1
FI2 - Format Initialization 2
SB - Start Barcode
SBF - Start Barcode Field
SL - Start Label
ST - Start Text
STF - Start Text Field
SM - Start Med Route
SMF - Start Med Route field
EM - End Med Route
EMF - End Med Route field
Outpatient Pharmacy is using the control codes to create a generic print
routine for laser labels. Outpatient Pharmacy will use the following control
codes:
ACI = ADDRESS CHANGE INITIALIZATION
ALI = ALLERGY SECTION INITIALIZATION
AWI = ALLERGY WARNING INITIALIZATION
BLB = BOTTLE LABEL BODY INITIALIZATION
BLBC = BOTTLE LABEL BARCODE
BLF = BOTTLE LABEL FOOTER INITIALIZATION
BLH = BOTTLE LABEL HEADER INITIALIZATION
CDII = CRITICAL DRUG INTERACTION INITIALIZATION
CNI = COPAY NARRATIVE INITIALIZATION
EBLBC = END OF BOTTLE LABEL BARCODE
EBT = END OF BARCODE TEXT
F10 = TEN POINT FONT - NO BOLD
F10B = TEN POINT FONT, BOLDED
F12 = TWELVE POINT FONT - NO BOLD
F12B = 12 POINT FONT BOLDED
F6 = SIX POINT FONT - NO BOLD
F8 = EIGHT POINT FONT - NO BOLD
F9 = NINE POINT FONT - NO BOLD
FDU = FONT DISABLE UNDERLINE
FWU = FONT WITH UNDERLINE
LL = LASER LABEL
LLI = LASER LABEL INIT
MLI = MAILING LABEL INITIALIZATION
NR = NORMAL ROTATION
PFDI = PHARMACY FILL DOCUMENT INITIALIZATION
PFDQ = PHARMACY FILL DOCUMENT QUANTITY
PFDT = PHARMACY FILL DOCUMENT TRAILER
PFDW = PHARMACY FILL DOCUMENT WARNING
PFI = PATIENT FILL INITIALIZATION
PII = PATIENT INSTRUCTION INITIALIZATION
PMII = PMI SECTION INITIALIZATION
RMI = RETURN MAIL INITIALIZATION
RNI = REFILL NARRATIVE INITIALIZATION
RPI = REFILL PRINT INITIALIZATION
RT = ROTATE TEXT
SBT = START OF BARCODE TEXT
SPI = SUSPENSE PRINT INITIALIZATION
ST = START OF TEXT
WLI = WARNING LABEL INITIALIZATION
2021/08/17
3442 ZIS GLOBAL File KERNEL 2003/02/27 APPROVED Active Controlled Subscription 3.2
This DBIA describes access needed by packages to
various parts of the global/file ^%ZIS(2
3453 Enter/Edit OFFICE OF INFORMATION SRV CNTR Entry File KERNEL 2001/09/13 APPROVED Active Private 4
CIRN MPI/PD has an agreement to use a FileMan FILE^DICN call to
edit the following fields in the INSTITUTION (#4) file.
NAME (#.01), STATE (#.02), STATUS (#11), FACILITY TYPE (#13),
STATION NUMBER (#99) and OFFICAL VA NAME (#100).
This is done in pre-install routine, PRE^RGP22, to create the
OFFICE OF INFORMATION SRV CNTR entry in the INSTITUTION file if
it is not present. This functionality is in support of GCPR.
The entry created has the following values.
NAME: OFFICE OF INFORMATION SRV CNTR
STATE: OHIO
3520 %ZTSCH(TASK Global File KERNEL 2002/02/12 APPROVED Active Controlled Subscription
CLINICAL INFO RESOURCE NETWORK - Master Patient Index/Patient
Demographics (MPI/PD) will make our RGMTRUN utility routine
class I at all VA facilities. We will create a remote query tool
on the Master Patient Index (MPI) to query a site for the currently
running task information.
The following code in RGMTRUN examines the currently running tasks in
the SCHEDULE file. For each task found, it examines the ROUTINE field.
If the ROUTINE field contains "HL" (Health Level Seven), then for
that task, EN^XUTMTP(TASK) is called to display the task information.
S TASK=0 F S TASK=$O(^%ZTSCH("TASK",TASK)) Q:'TASK Q:QFLG D
.S ROU=$P(^%ZTSCH("TASK",TASK),"^",2)
.I ROU["HL" D EN^XUTMTP(TASK)
This IA is for direct global read of the ^%ZTSCH("TASK",TASK)
node of the SCHEDULE file and for direct global read, $P(^%ZTSCH(
"TASK",TASK),"^",2) for pieces 2 and 4, ROUTINE and OPTION NAME.
3521 XUTMTP Routine Routine KERNEL 2002/02/12 APPROVED Active Controlled Subscription
CLINICAL INFO RESOURCE NETWORK - Master Patient Index/Patient
Demographics (MPI/PD) will make our RGMTRUN utility routine
class I at all VA facilities. We will create a remote query tool
on the Master Patient Index (MPI) to query a site for the currently
running task information.
The following code in RGMTRUN examines the currently running tasks in
the SCHEDULE file. For each task found, it examines the ROUTINE field.
If the ROUTINE field contains "HL" (Health Level Seven), then for
that task, EN^XUTMTP(TASK) is called to display the task information.
S TASK=0 F S TASK=$O(^%ZTSCH("TASK",TASK)) Q:'TASK Q:QFLG D
.S ROU=$P(^%ZTSCH("TASK",TASK),"^",2)
.I ROU["HL" D EN^XUTMTP(TASK)
This IA allows MPI/PD to call the EN entry point in routine XUTMTP.
XUTMTP
3522 $$OS EXTRINSIC FUNCTION IN ROUTINE %ZOSV Routine KERNEL 2002/02/12 APPROVED Active Supported
The $$OS^%ZOSV() extrinsic function is only available
under Cache'/OpenM systems. This function returns the underlying operating
system such as VMS, UNIX or NT.
%ZOSV
3539 Digital Signature Storage Routine KERNEL 2002/04/22 APPROVED Active Controlled Subscription
This IA is for a set of API's to facilitate the use of
PKI Digital Signatures in VistA applications.
XUSSPKI
3544 IMAGING - NEW PERSON FILE File KERNEL 2002/03/12 APPROVED Active Controlled Subscription 200
Kernel gives Imaging permission to read the Radiology
Classification in the New Person file.
2002/03/12
3555 Enter/edit Austin Entry File KERNEL 2002/04/09 APPROVED Active Private 4
The HL7 package has an agreement to use a FileMan
FILE^DICN call to edit the following fields in the INSTITUTION (#4) file.
NAME (#.01), STATE (#.02), STATUS (#11), FACILITY TYPE (#13), STATION NUMBER
(#99) and OFFICAL VA NAME (#100).
This is done in pre-install routine, PRE^HLP92, to create the AUSTIN entry in
the INSTITUTION file if it is not present. This functionality is in support
of the Federal Heath Information Exchange (FHIE).
The entry created will have the following values. NAME: AUSTIN STATE: TEXAS
STATUS: National FACILITY TYPE: DPC STATION NUMBER: 200 OFFICAL VA NAME:
AUSTIN GLOBAL REFERENCE:
^DIC(4,D0,0)
.01 NAME 0;1 Write w/Fileman
.02 STATE 0;2 Write w/Fileman
11 STATUS 0;11 Write w/Fileman GLOBAL REFERENCE:
^DIC(4,D0,3)
13 FACILITY TYPE 3;1 Write w/Fileman GLOBAL REFERENCE:
^DIC(4,D0,99)
99 STATION NUMBER 99;1 Write w/Fileman
100 OFFICIAL VA NAME 99;3 Write w/Fileman
3587 SPOOLED HEALTH SUMMARY DOCUMENT File KERNEL 2002/05/23 APPROVED Active Controlled Subscription 3.51
Health Summary uses Mailman to track spooled documents
for transmission.
3588 HEALTH SUMMARY SPOOLED DATA File KERNEL 2002/05/23 APPROVED Active Private 3.519
3589 Tasking An Event From a New Style Xref Routine KERNEL 2002/05/24 APPROVED Active Supported
This support API allows other packages to task an
Option(s) or Protocol(s) from a New Style cross-reference.
For more details on usage please see:
http://vista.url/kernel/apis/OPKG^XUHUI.htm
XUHUI
3599 OPTION SCHEDULING (#19.2) file File KERNEL 2002/06/18 APPROVED Active Controlled Subscription 19.2
The Master Patient Index (MPI) will read (with FileMan) the following
fields from the OPTION SCHEDULING (#19.2) file. The data is used by
the MPI Data Quality Management team on the Austin MPI. The report
shows the status of various tasks that routinely run.
Example:
MPI STATUS REPORT
(generated Jun 15, 2002@18:52)
Scheduled Background Job Last Completed Run Next Scheduled Run
------------------------ ------------------ ------------------
MPI Stat Report JUN 14, 2002@08:21 JUN 16, 2002@02:00
Audit Data Purge JUN 14, 2002@22:00 JUN 15, 2002@22:00
Invalid Site Monitor JUN 14, 2002@22:00 JUN 15, 2002@22:00
Dup SSN Compile JUN 15, 2002@18:45 NOT SCHEDULED
3617 DBIA3617 File KERNEL 2002/07/10 APPROVED Active Controlled Subscription 101
Clinical Reminders Package requests to access the B
index on the protocol file (#101) directly.
Existing Reminder Package options with LIST MANAGER interfaces use XQORM to
allow selection from a list by entering the list item number.
e.g.
XQORM S XQORM("#")=$O(^ORD(101,"B",PROTOCOL_NAME,0))_U_"1:"_VALMCNT
S XQORM("A")="Select Item: "
Q
3618 POSTAL CODE AND COUNTY CODE APIS Routine KERNEL 2002/07/11 APPROVED Active Supported
Allow access to look-up Postal Code and County Code
data based on supported API references.
XIPUTIL 2007/01/25
3627 'D' X-REF File KERNEL 2002/07/26 APPROVED Active Controlled Subscription 4
MPI/PD has permission to execute a $ORDER direct global read
of the 'D' Cross Reference on the INSTITUTION (#4) file. This
is done specifically to identify existing anomalies with the HL
links used for MPI/PD messaging (e.g., multiple "D" cross
references in the file for a station number).
3639 DBIA3639 File KERNEL 2002/08/07 APPROVED Active Private 4
MDE will pull the data from this file to support the
population of the new CoreFLS system. This IA is short-term and will be
retired after the data has been extracted from all sites.
3640 DBIA3640 File KERNEL 2002/08/07 APPROVED Active Private 20
MDE will pull the data from this file to support the
population of the new CoreFLS system. This IA is short-term and will be
retired after the data has been extracted from all sites.
3641 DBIA3641 File KERNEL 2002/08/07 APPROVED Active Private 200
MDE will pull the data from this file to support the
population of the new CoreFLS system. This IA is short-term and will be
retired after the data has been extracted from all sites.
3732 REMOVE OPTION FROM FILE #19.2 File KERNEL 2002/08/20 APPROVED Active Controlled Subscription 19.2
Permission to lookup and delete entries in 19.2 with VA
FileMan APIs for entries in the custody of the application doing the lookup.
3749 KERNEL SITE PARAMETERS File KERNEL 2002/09/06 APPROVED Active Private 8989.3
MailMan requests read access to KERNEL SITE PARAMETERS
file (#8989.3)
3766 DBIA3766 Other KERNEL 2002/09/23 APPROVED Active Private
This is a temporary IA to clean up the "AD" x-ref of
the OPTION (#19) file so IB can delete some old options.
In this IA, IB will KILL the "AD" cross reference of the whole OPTION (#19)
file. Then IB will loop through every entry in the OPTION (#19) file and
re-build the multiple cross reference using ENALL^DIK.
This will be performed during a pre-install to ensure the "AD" cross reference
is clean prior to the patch being installed to delete old options.
3771 XUDHGUI Routine KERNEL 2002/10/01 APPROVED Active Supported
VISTA Graphical User Interface (GUI)-based applications
can use this API to look up devices. This API retrieves the first 20 devices
that meet the specifications passed. This API was made available with Kernel
Patch XU*8.0*220.
See the Web for more info: http://vista.DNS/kernel/apis/index.shtml
XUDHGUI 2009/01/22
3781 AUTOMATIC ADDITION OF CONTROL CODES Routine KERNEL 2002/10/09 Withdrawn Private
3795 XUMF Routine KERNEL 2002/10/22 APPROVED Active Supported
Master File Server API
XUMF
3858 Reference EMAIL ADDRESS field in the New Person file File KERNEL 2002/12/09 APPROVED Active Private 200
3878 Resource device filing in server option File KERNEL 2003/01/20 APPROVED Active Private 19
When a KIDS distribution installs a server type option
that has an attached resource device (SERVER DEVICE field #227), the internal
entry number (ien) of the device on the origin system and not the resolved ien
of the corresponding device on the destination system files. Thus the
installed server type option is usually now pointing to the wrong device or a
non-existent device. As KIDS does not have a mechanism for finding the
appropriate device entry and resolving the pointer value, it is requested that
for patch PRC*5.1*63 (NATIONAL ITEM FILE - PHASE 1) IFCAP be permitted by VA
FileMan database server calls to lookup the appropriate entry and file its ien
into the server type option PRCHITEM_UPDATE during execution of the post-init
routine PRC5163P.
The proposed code from module EN^PRC5163P is:
;Linking resource device to server option
N PRCERR,PRCD,PRCDA,PRCDA2
K PRCERR
S PRCDA=$$FIND1^DIC(3.5,"","X","PRCHITEM","B","I $P(^(""TYPE""),U)=
""RES""","PRCERR")
I PRCDA'>0!$D(PRCERR) D G EX
. N PRCT S PRCT(1)="Lookup of resource device PRCHITEM failed."
. S PRCT(2)=" You will have to manually link resource device PRCHITEM
to server"
. S PRCT(3)=" option PRCHITEM_UPDATE."
. D MES^XPDUTL(.PRCT)
K PRCERR
S PRCDA2=$$FIND1^DIC(19,"","X","PRCHITEM_UPDATE","B","","PRCERR")
I PRCDA2'>0!$D(PRCERR) D G EX
. N PRCT S PRCT(1)="Lookup of server option PRCHITEM_UPDATE failed."
. S PRCT(2)=" Please contact NVS as there were patch installation
problems."
. D MES^XPDUTL(.PRCT)
K PRCD,PRCERR
S PRCD(19,PRCDA2_",",227)=PRCDA
D FILE^DIE("K","PRCD","PRCERR")
I $D(PRCERR) D G EX
. N PRCT S PRCT(1)="Automated linkage of resource device PRCHITEM to
server option"
. S PRCT(2)=" PRCHITEM_UPDATE failed. You will have to manually link
it."
. D MES^XPDUTL(.PRCT)
N PRCT S PRCT(1)="Resource device PRCHITEM was successfully linked to
server"
S PRCT(2)=" option PRCHITEM_UPDATE."
D MES^XPDUTL(.PRCT)
EX ;
Q
3882 DBIA3882 Other KERNEL 2003/01/22 APPROVED Active Private
The Controlled Substance V3.0 Narcotics Monitoring Menu
[PSD NM MENU] will include Kernel's Option Access by User [XUOPTWHO] option.
The Narcotics Monitoring enhancement is distributed in the PSD*3.0*41 KIDS
build which transports the [XUOPTWHO] option as an 'Attach to Menu'.
3883 Use of DOLRO~ZOSV by VistA HL7 Application Developers Routine KERNEL 2003/01/28 APPROVED Active Controlled Subscription
Patch HL*1.6*93 allows application developers to modify
four routing- related fields in the MSH segment of HL7 messages. There are
two ways these changes can be made:
(1) Calling GENERATE^HLMA or DIRECT^HLMA with the string literal value to
be used for the routing-related fields, or
(2) Call GENERATE^HLMA or DIRECT^HLMA and specify M code to evaluate the
environment and make changes to specified (and a limited number of)
local variables.
Even though the M code called by the new HL*1.6*93 software can only make a
limited number of changes to local variables, evaluation of the total local
variable environment is extremely important.
The DOLRO^%ZOSV API has been built into the current HL7 software to make it
easier for application developers to perform the necessary evaluation and
actions.
%ZOSV
3884 BUILD CONTROL CODES File KERNEL 2003/03/04 APPROVED Active Controlled Subscription 3.2
Outpatient Pharmacy V. 7.0 utilizes the CONTROL CODES
field (#55) of the TERMINAL TYPE file (#3.2) in order to provide a generic
print routine that will handle laser labels.
There are 30+ control codes to be built in order to properly format the
output. Since standard PCL 5 escape sequences are being used 90% of them will
be the same for every printer. In order to assist sites with building the
control codes, this agreement will allow Outpatient Pharmacy V. 7.0 to provide
a routine to automatically build the control codes.
PSOLLU2
4011 File 8994 File KERNEL 2006/01/19 APPROVED Active Controlled Subscription 8994
Permission to add or delete entries via FM APIs.
4012 File 9.8 File KERNEL 2003/03/18 Withdrawn Private 9.8
4038 OR reference to file 1 File KERNEL 2003/03/26 Withdrawn Private 1
4054 DBIA4054 Routine KERNEL 2003/04/01 APPROVED Active Controlled Subscription XUSRB
4055 DBIA4055 Routine KERNEL 2003/04/01 APPROVED Active Controlled Subscription XUSRB2
4056 DBIA4056 Routine KERNEL 2003/04/01 APPROVED Active Controlled Subscription
VistaLink requests use of the following API:
GETPEER^%ZOSV
The VistaLink security module uses this to retrieve an IP address value for
the current session, which is required as input (in the XWBTIP variable) into
another call, SETUP^XUSRB.
%ZOSV
4057 DBIA4057 Routine KERNEL 2003/04/01 APPROVED Active Controlled Subscription XUS2
4058 DBIA4058 File KERNEL 2003/04/01 APPROVED Active Controlled Subscription 200
4060 DBIA4060 Routine KERNEL 2003/05/29 APPROVED Active Private
VistaLink wishes to use the Kernel entry point
$$AUTOXWB^XUS1B to support Kernel auto-signon.
XUS1B
4061 DBIA4061 Routine KERNEL 2003/06/04 APPROVED Active Private
VistaLink wishes to use two calls, NOW^XUSRB and
$$POST^XUSRB, to complete Kernel auto-signon for users that pass the initial
auto-signon check ($$AUTOXWB^XUS1B).
XUSRB
4077 OR Call to XQORM1 Routine KERNEL 2003/04/02 Withdrawn Private XQORM1
4086 MODIFY OPTION SCHEDULING FILE FIELDS File KERNEL 2003/05/05 APPROVED Active Controlled Subscription 19.2
Add VistALink option XOBV LISTENER STARTUP to the
OPTIONS SCHEDULING file (#19.2) during the post-installation phase of the
VistALink package. Also, perform a lookup on the "B" cross reference of the
new entry, and as part of the post-installation display this record's zero
node.
Revision History:
- 2/28/25, effective with DVBA*2.7*253, added new OTHER PARAMETERS (#10)
multiple, and the VARIABLE NAME (#.01) and VALUE (#1) fields, where field
content can be added, modified or removed when the package owns the namespaced
entry being modified.
4087 DBIA4087 File KERNEL 2003/05/05 APPROVED Active Private 14.7
Perform a "B" cross reference lookup on the BOX-VOLUME
PAIR field of the TASKMAN SITE PARAMETERS file (#14.7) to obtain the
BOX-VOLUME pair for the current system. This will be used to lookup the
correct entry in the VISTALINK SITE PARAMETERS file (#18.01) prior to starting
a VistALink Listener configuration on a Cache-NT system.
4088 DBIA4088 File KERNEL 2003/05/15 APPROVED Active Private 8989.3
Perform a lookup on the "B" cross reference of the
VOLUME SET sub-field (#.01) within the VOLUME SET multiple (#8989.304) of the
KERNEL SITE PARAMETERS file (#8989.3) to obtain the volume set. This will be
used as an input variable (XUVOL) to the call $$INHIBIT^XUSRB() to determine
if a new process can be started.
4089 DBIA4089 Other KERNEL 2003/05/05 APPROVED Active Private
During the installation of the VistALink package, add
the Foundations Management submenu to the Operations Management menu under the
Systems Manager (EVE) menu.
4100 XQALERT1 Routine KERNEL 2003/05/19 APPROVED Active Controlled Subscription XQALERT1
4122 SET AUDIT ON NEW PERSON FILE #200 FIELDS File KERNEL 2010/12/13 APPROVED Active Private 200
The LAB SERVICE package (LSRP project) has a
requirement that specific fields are to be set to be audited on patch
installation for the NEW PERSON file (#200). We are requesting a one-time use
ICR that allows us to set this access on specific fields in file 200 using the
supported API for this purpose (TURNON^DIAUTL). This would be done in our
post installation routine for patch LR*5.2*393 The fields are:
Top level:
.01 NAME
.132 OFFICE PHONE
.137 VOICE PAGER
.138 DIGITAL PAGER
4 SEX
5 DOB
7 DISUSER
9 SSN
9.2 TERMINATION DATE
41.99 NPI
9000 VPID
51 KEYS (subfile #200.051)
.01 KEY
2010/12/15
4129 INVOKE DUZ~XUP Routine KERNEL 2003/06/30 APPROVED Active Controlled Subscription
Noted by Custodian on 11/3/23 that it has been
mentioned in the past that this API needs to be improved. That is, Kernel
needs to find a better solution to allow VistA Kernel direct-authentication of
the actual user logged in to VistA. Setting the DUZ variable should be done
only by Kernel after verification of valid and secure credentials. If we
continue allowing applications to "arbitrarily search" for an IEN in the NEW
PERSON (#200) file, and then call DUZ^XUP to set the DUZ variable, it may
cause additional problems.
XUP 2010/12/16
4132 DG FIELD MONITOR Other KERNEL 2003/06/17 APPROVED Active Private
Automatically adding the following entries to the
following files.
File #3.5
NAME: DG FIELD MONITOR $I: DG FIELD MONITOR
LOCATION OF TERMINAL: DG field editing protocol
RESOURCE SLOTS: 9 SUBTYPE: P-OTHER
TYPE: RESOURCES
File #3.54
NAME: DG FIELD MONITOR AVAILABLE SLOTS: 9
4142 Entry Action Setting in Option File KERNEL 2003/07/16 APPROVED Active Private 19
As part of the Legacy Software Shut Down process,
IFCAP, Engineering (AEMS/MERS) and Equipment/Turn-In Request options that
change the database will be disabled. Only read access to the database will
be allowed once the site comes up on CoreFLS. Although putting a string in the
OUT OF ORDER MESSAGE field (#2) can put the option offline, it seems
preferable to also inactivate the option by putting "S XQUIT=1" in the ENTRY
ACTION field (#20). There currently is not a supported Kernel API
specifically for editing the ENTRY ACTION field. Management has previously
instructed our team not to edit the application routines in order to
inactivate the option.
Specifically this request is to permit PRCL namespaced code to file "S
XQUIT=1" in the ENTRY ACTION field of selected options of these three legacy
packages using supported FileMan (FM) database server APIs. Before filing the
new value, the existing value will be extracted via a FM supported API and
stored in the LEGACY SOFTWARE SHUT DOWN file (#449.1) so that it is available
if needed. In the remote possibility the the site temporarily needs to resume
business activity in the legacy systems, it is also requested that the
software be permitted to restore the original value for each entry again using
supported FM APIs. [Note: The software is also filing of an Out of Order
Message using the supported OUT^XPDMENU() API.]
4143 Scheduled Option Removal File KERNEL 2003/07/03 APPROVED Active Private 19.2
The Legacy Software Shut Down project will be
converting the IFCAP, Engineering (AEMS/MERS) and Equipment/Turn-In Request
packages to Read-Only as part of the site's coming on line with CoreFLS.
Scheduled options, especially those which may alter the database, must be
removed from the OPTION SCHEDULING file (#19.2). This request is to permit
PRCL namespaced code to remove any entries in the namespaces of these legacy
packages from file 19.2.
Specifically it is requested that the Legacy Sofware Shut Down software be
permitted to extract via supported FileMan database server APIs, the current
value of most fields of the entry to be removed so that they can be stored in
the LEGACY SOFTWARE SHUT DOWN file (#449.1) in case the values are needed
later. The TASK ID field (#12) and the computed TASK DEFIND field (#99.1),
however, will not be backed up. The request further asks for permission to
remove the entry from file 19.2 via a ^DIK call. Finally, in the highly
unlikely event that the site must temporarily resume using these packages,
instead of CoreFLS, for business activities, it is requested that the software
be permitted to create a new entry in file 19.2 to reschedule each of the
affected options. This again would be accomplished through supported FileMan
APIs. TaskManager, not this software, would establish the value for the TASK
ID field.
4144 Dequeueing Legacy Software Tasks File KERNEL 2003/07/03 APPROVED Active Private 14.4
The Legacy Software Shut Down patch will be converting
the IFCAP, Engineering (AEMS/MERS) and Equipment/Turn-In Request packages to
Read-Only when the site comes up on CoreFLS. Queued tasks for these packages,
especially those that may alter the database, must be dequeued. Specifically,
this request asks that PRCL namespaced software be permitted to $Order()
through the ^%ZTSK global and to identify tasks to be dequeued through
examination by direct global read of the Routine Name field (#2) [node 0,
piece 2], comparing the routine's prefix to the namespaces of the above
packages. (For dequeueing, the status of the task must also be verified as
"Active: Pending" using the supported Kernel API STAT^%ZTLOAD.) Where the task
is to be dequeued via supported Kernel API DQ^%ZTLOAD, it is requested that
the software be permitted to file via a supported FileMan database server API
a value of one year from the run date into the Remember Untill field (#59.8)
so that the task is still available, in the highly unlikely case that the site
needs to temporarily resume business processing using these legacy packages
instead of CoreFLS and wishes to requeue the task. Finally, for reporting
tasks dequeued as part of the shut down, it is requested that the software be
permitted to extract via a supported FileMan database server API, the values
for the Entry Point field (#.01), Routine Name field (#2) and the Task
Description field (#41), so they can be displayed in addition to the task
number.
4145 Kernel Part 3 - Modifying File Access Permissions File KERNEL 2003/07/03 APPROVED Active Private 200.032
The Legacy Software Shut Down patch will convert the
IFCAP, Engineering (AEMS/MERS), and Equipment/Turn-In Request packages to
Read-Only. Users must not be able to edit via FileMan, files of the above
packages. Although some restriction can be accomplished by the IRM removing
Write and Delete/Purge permissions to application namespaced globals, some
Engineering files still store data in the ^DIC global, whose protection can
not be changed by this patch. In addition, as a temporary workaround for
Prosthetics during the initial deployment of CoreFLS at VAMC Bay Pines, the
protection of the IFCAP ^PRC global can not be modified so access to files
stored in this global has to be controlled via VA FileMan or Kernel Part 3
setups. This request concerns sites that have implemented the Kernel Part 3
access controls.
Specifically, this request asks that PRCL namespaced code be permitted to
$Order() through the AFOF cross reference in the NEW PERSON file (#200) in
order to identify individuals with access to the files of interest and the
internal number of the accessible file multiple entry. It is further
requested that the software be permitted to extract via a supported FileMan
API, the current access values in case they are needed later. They will be
stored in the LEGACY SOFTWARE SHUT DOWN file (#449.1). It is requested that
the software be permitted to file via a supported FileMan API, '0' (NO) for
DATA DICTIONARY ACCESS, DELETE ACCESS, LAYGO ACCESS, and WRITE ACCESS to the
files of these packages. Finally, in the highly unlikely situation that users
need to temporarily resume using these legacy packages, rather than CoreFLS
for their business activities, it is requested that the software be permitted
to file via a supported FileMan API, the original values back into the
ACCESSIBLE FILE multiple of the NEW PERSON entries that were modified during
the shut down.
4184 KIDS Install Start/Complete Times File KERNEL 2004/10/22 APPROVED Active Private 9.7
4208 MY TEST Other KERNEL 2010/12/13 Pending Private
4232 XUSERP Routine KERNEL 2003/09/22 APPROVED Active Controlled Subscription
When the user file is edited a call should be made to
CALL^XUSERP(...) so that other applications or system can be updated.
XUSERP
4274 VDEF EVENTS AND EXTRACTION LISTS Other KERNEL 2004/08/23 Retired Supported
The following VDEF events are under the custody of
KERNEL:
PMU^B01
PMU^B02
The following VDEF extraction lists are under the custody of KERNEL:
STF-0-NP
STF-2-NP-PN
STF-2-NP-SS
STF-3-NP
PRA-0-NP
PRA-3-NP-S-RNMC
PRA-6-NP-SW
PRA-6-NP-DEA
PRA-6-NP-VA
ORG-0-NP-S-PC
ORG-6-NP-S-PC-1
ORG-6-NP-S-PC-2
ORG-7-NP-S-PC-1
ORG-7-NP-S-PC-2
ORG-8-NP-S-PC-1
ORG-8-NP-S-PC-2
4297 ELECTRONIC SIGNATURE-RELATED DATA IN THE NEW PERSON FILE File KERNEL 2003/12/23 APPROVED Active Controlled Subscription 200
Electronic Signature is a collection of Java APIs to
validate, retrieve, and save electronic signature codes and related data on
the M server, as well as APIs to encrypt and decrypt strings similar to the
APIs provided by the existing VA Kernel 8.0 electronic signature APIs.
The Java APIs provide HSD&D developers that are rehosting their applications
to a new Java environment a standardized method for migrating their electronic
signature functionality. It is hoped that this will reduce duplication of
effort, promote more efficient use of limited development resources, and
satisfy the VistA user's business needs.
This IA permits Electronic Signature to access electronic signature-related
data in the NEW PERSON file (#200) as listed in the GLOBAL REFERENCE section
of this Integration Agreement. All fields are accessed via VA FileMan calls,
such as $$GET1^DIQ and FILE^DIE, rather than direct global reads.
4324 DBIA4324 File KERNEL 2003/12/31 APPROVED Active Private 200
During Phase II patch installation of MyHealtheVet the
following user is created, these fields can also be reset to existing values
by IRM staff in the event of problems. Fields are filled, via supported
FileMan calls, for MHV project in File 200 (New Person). Access and Verify
codes are "pre-hashed" for security and consistency across all VAMC's to allow
National Patient access via a secure eVault Server.
User: MYHEALTHEVET,SECURE SERVER
4329 DBIA4329 File KERNEL 2004/01/22 APPROVED Active Controlled Subscription 200 2009/09/22
4330 DBIA4330 File KERNEL 2004/01/22 APPROVED Active Private 49
4334 XU USER TERMINATE Other KERNEL 2004/01/30 APPROVED Active Supported
Other pachages can attach to this protocol option and
they will be called when a USER is Terminated. The call will be just after the
users Access and Verify codes have been removed. DUZ will be the person that
is running the terminate option. XUIFN will point to the NEW PERSON file
entry that is being terminated. Returns selected file 200 data to XUSR(field
name) array for New Person components.
It is called in XUSTERM from XUSERP.
Packages may attach or de-attach their options using KIDS.
4342 Visitor Routine KERNEL 2004/02/17 APPROVED Active Controlled Subscription
The routine XUESSO1 has entry points used to create a
Visitor record in the New Person File. Use of this routine is restricted.
XUESSO1 2017/09/29
4389 Imaging - Install file #9.7 File KERNEL 2004/04/13 APPROVED Active Private 9.7
4390 Imaging - PACKAGe file (#9.4) File KERNEL 2004/04/13 APPROVED Active Private 9.4
4409 XUP Routine KERNEL 2004/04/23 APPROVED Active Supported
Supported APIs or extrinsic function in routine XUP.
XUP
4437 SUBSCRIBER cleanup: PROTOCOL (101) file Other KERNEL 2004/06/10 Withdrawn Private
Radiology/Nuclear Medicine has found the need in
developing RA*5.0*47 to remove the 'MAGD SEND ORM' protocol from the
SUBSCRIBER (775) multiple on the PROTOCOL (101) file. The event driver
protocols impacted are: RA REG RA REG 2.3 RA CANCEL RA CANCEL 2.3 RA EXAMINED
RA EXAMINED 2.3
These event driver protocols generate v2.1 & v2.3 ORM Health Level Seven (HL7)
messages. Imaging, through the use of 'MAGD SEND ORM', received ORM messages
in this manner.
Imaging now needs to receive v2.4 HL7 messages. In an effort to prevent
needless use of disk space, I'd like to eliminate the creation of these
non-v2.4 HL7 Imaging related ORM messages.
A direct global read of the whole file cross-reference "AB" on the SUBSCRIBER
4440 DBIA4440 Routine KERNEL 2004/06/17 APPROVED Active Supported
This API is used to tell if the current account is the
main production or a clone or test account.
XUPROD
4467 XUSCNT Routine KERNEL 2004/07/26 APPROVED Active Controlled Subscription
The routine XUSCNT is just for GT.M system to keep
track of the number of active jobs. It is called from ZU for normal users.
ZTMS calls it for taskman jobs. Broker calls it as will other applications
that get started outside of Kernel. Mailman HL7
XUSCNT
4497 DENTAL EDIT/DELETE OF OPTIONS File KERNEL 2004/08/17 APPROVED Active Controlled Subscription 19
Dental Package would like an agreement with the owner
of the OPTION file (#19) to Fileman edit and delete of entries in these files,
due to the plan to retire the old Dental Activity System (DAS) in FY2005. As
such the first step of this phase out is to place many DENT* options by
placing thme OUT OF ORDER. There will be more than one dental patch to
accomplish this. Phase I involves disabling most of the old edit type options
but leaving some of the reporting options available. There may or may not be
a second patch to disable the remaining old Dental options. Definitely, when
DENT 2.0 is released, all of the old DAS options and functionality will be
removed. In DENT 2.0, we will include the Dental Options in the KIDS build
definition with a status of DELETE AT SITE.
Dental is planning on a patch that would queue up Taskman job to run late in
the evening on Oct 31, 2004. That tasked job will place options out of order.
The patch will do nothing except scheduled that Taskman job to run at the
designated time. This is why we cannot export the OPTIONs with the OUT OF
ORDER field set. The local VAMCs are allowed to run those options up until
Oct 31.
Dental is requesting: 1. Fileman read to do a lookup on file 19 given an
option name using either $$FIND1^DIC or FIND^DIC or LIST^DIC
2. Fileman write access to the OPTION file for fields:
2 OUT OF ORDER MESSAGE (F), [0;3]
209 SCHEDULING RECOMMENDED (S), [200.9;1]
S DENT(19,IENS,2) = some appropriate text
S DENT(19,IENS,209)="@"
D FILE^DIE
4511 XUSERP Routine KERNEL 2006/01/26 APPROVED Active Private XUSERP
4532 NPI UTILITIES Routine KERNEL 2006/03/22 APPROVED Active Controlled Subscription
An API to facilitate retrieval of the National Provider
Identifier (NPI) information and related utilities.
XUSNPI 2018/03/14
4539 DBIA4539 Routine KERNEL 2006/02/28 APPROVED Active Private
checks whether user is active and a proxy user
XUSAP
4558 LIBRARY FUNCTIONS Routine KERNEL 2004/11/03 APPROVED Active Supported XLFDT3
4568 XLFNAME7 Routine KERNEL 2004/12/14 APPROVED Active Private
Name standardization and name processing APIs.
XLFNAME7
4570 CVALID XLFNAME8 Routine KERNEL 2004/12/16 APPROVED Active Private
The API validates name components.
XLFNAME8
4572 E-SIG LOOKUP File KERNEL 2005/01/03 APPROVED Active Controlled Subscription 200
This INTEGRATION AGREEMENT describes the ability to
read the hash of the user's electronic signature from file #200.
4573 READ AND WRITE OF TMP(XM-MESS Other KERNEL 2004/12/07 APPROVED Active Controlled Subscription
4574 XUPS APIs Routine KERNEL 2006/04/18 APPROVED Active Supported
Two APIs are contained in routine XUPS to identify the
VPID (VA Person ID) for a selected user or identify the DUZ for an entry in
the New Person (#200) file from a VPID.
XUPS 2007/05/26
4575 XUPSQRY API Routine KERNEL 2006/04/18 APPROVED Active Controlled Subscription
This API provides the functionality to query the New
Person (#200) file. The calling application may query the New Person (#200)
file by using either the VPID of the requested entry or part or all of a last
name. Other optional parameters may be passed to the call as additional
filters.
XUPSQRY
4589 DBIA4589-A Other KERNEL 2005/02/03 APPROVED Active Controlled Subscription
The Health Revenue Center (HRC) will be using a special
telnet feature in CAPRI-Remote to view patient data across all Vista Systems.
They need access to the menu options listed in this IA in order to review
various records for any given patient.
4596 Envoke ASKDUZ - Routine XUP Routine KERNEL 2005/01/26 APPROVED Active Private
Envoke ASKDUZ^XUP in routine DII if DUZ is undefined.
XUP
4632 DBIA4632 File KERNEL 2005/03/31 APPROVED Active Private 8992.1
Registration utilizes the alert tracking file to
obtain/update information from existing alerts. Information updated will be
added to the DATA FOR PROCESSING (#2) Field.
4674 ACCESS TO AK.PROVIDER CROSS REFERENCE File KERNEL 2005/06/02 APPROVED Active Private 200
This integration agreement allows access to the
AK.PROVIDER cross reference in the New Person file.
4677 Application Proxy Routine KERNEL 2005/06/08 APPROVED Active Controlled Subscription
To support the J2EE middle tier the concept of a
APPLICATION PROXY user was created. This is a user name that an application
sets that has an user class of Application Proxy. It will not have Access or
Verify codes, no Primary Menu. It will have one or more Secondary Menu items.
The RPC's that the menu items point to must have the APP PROXY ALLOWED field
set to Yes.
APPLICATION PROXY names used by Class I software must be approved by the DBA.
XUSAP 2009/03/16
4685 PROTOCOL File KERNEL 2005/06/20 APPROVED Active Supported 101
Direct access to the Protocol file (#101) to mark
protocols out of order and remove the out of order message.
4691 DELETE AFFECTS RECORD MERGE File KERNEL 2005/06/17 APPROVED Active Private 9.4
Remove all entries in the AFFECTS RECORD MERGE field in
the Package file for Prosthetics.
4755 ADD B-OPTIONS TO MENU OF B-OPTION File KERNEL 2005/09/09 Withdrawn Private 19
Kernel's KIDS package currently supports adding an
option from another package to the MENU multiple of either a MENU type option,
or an EXTENDED ACTION type option as part of a packages KIDS installation.
However it doesn't support adding an option to the MENU multiple of a BROKER
type option.
Request is to use FileMan call UPDATE^DIE to add BROKER type options to the
MENU multiple of an existing BROKER type option.
4756 DBIA4756 Routine KERNEL 2005/10/06 APPROVED Active Controlled Subscription
This agreement allows the VistaLink package to use
routine XUS1 to perform user validation during the VistaLink reauthentication
process, which includes support for the login capabilities of FatKAAT and
KAAJEE.
XUS1
4757 DBIA4757 Routine KERNEL 2005/10/06 APPROVED Active Controlled Subscription
This agreement allows the VistaLink package to use
routine XUS1A to perform user validation during the VistaLink reauthentication
process, which includes support for the login capabilities of FatKAAT and
KAAJEE.
XUS1A
4758 DBIA4758 Routine KERNEL 2005/10/06 APPROVED Active Controlled Subscription
This agreement allows the VistaLink package to use
routine XUSHSH to encrypt Kernel access and verify codes to their hashed
versions during the VistaLink reauthentication process, to support the login
capabilities of FatKAAT and KAAJEE.
XUSHSH
4759 DBIA4759 Routine KERNEL 2005/10/06 APPROVED Active Controlled Subscription
This agreement allows the VistaLink package to use
routine XUSRB4 to perform validation checks on the Kernel CCOW user sign-on
token during the VistaLink reauthentication process. This is used for the
purpose of integrating with the Single Sign-On/User Context (SSO/UC) project
(part of Infrastructure & Security Services).
XUSRB4
4760 DBIA4760 Routine KERNEL 2005/10/06 APPROVED Active Controlled Subscription
This agreement allows the VistaLink package to use
routine XUSTZ to perform Kernel IP address locking during the VistaLink
reauthentication process, which includes support for the login capabilities of
FatKAAT and KAAJEE.
For more information on IP address locking, please see patch XU*8*265,
Subject: 3 Strikes and You Are Out.
XUSTZ
4761 DBIA4761 Routine KERNEL 2005/10/06 APPROVED Active Controlled Subscription
This agreement allows the VistaLink package to use
routine XUSTZIP to perform checks on Kernel IP/device locking during the
VistaLink reauthentication process, which includes support for the login
capabilities of FatKAAT and KAAJEE.
For related information on IP address locking, see integration agreement
#4760.
XUSTZIP
4762 DBIA4762 Routine KERNEL 2005/10/06 APPROVED Active Controlled Subscription
This agreement allows the VistaLink package to use
routine XUS to check initial sign-on parameters and environment/volume set
information in the KERNEL SYSTEM PARAMETERS file (#8989.3) during the
VistaLink reauthentication process, which includes support for the login
capabilities of FatKAAT and KAAJEE.
XUS
4764 DBIA4764 Routine KERNEL 2005/10/06 APPROVED Active Controlled Subscription
This agreement allows the VistaLink package to use
routine XUS3 to check, clear, and set the failed access count in the FAILED
SIGNON ATTEMPTS file (#3.084). This will track the count of sign-on attempts
from an IP address or domain. It is used during the VistaLink
reauthentication process, which includes support for the login capabilities of
FatKAAT and KAAJEE.
See patch XU*8*265 for more information on the FAILED SIGNON ATTEMPTS file
(#3.084).
XUS3
4765 DBIA4765 Routine KERNEL 2005/10/06 APPROVED Active Private
This agreement allows the VistaLink package to use
routine XUSAP to implement the Kernel Connector Proxy/Application Proxy APIs.
These APIs are used in both VistaLink initial authentication and
reauthentication processes. These methods have been approved by the Single
Sign-On/User Context (SSO/UC) project (part of Infrastructure & Security
Services).
See Kernel supported reference #4677 for more information.
XUSAP
4770 unique handle into XTMP global. Routine KERNEL 2005/08/08 APPROVED Active Supported
Create and return a unique handle (subscript) for the
^XTMP global and create the required zero node.
XUSRB4
4832 COMMON FILES Other KERNEL 2006/01/05 APPROVED Active Controlled Subscription
Packages may place their common files under
Program Files\VistA\Common Files\
4834 USER ALERTS Routine KERNEL 2005/11/03 APPROVED Active Controlled Subscription
This Integration Agreement is to document the calls
GETUSER1^XQALDATA and GETUSER2^XQALDATA. The Order Entry package uses these
calls to retrieve the alerts that a user needs to see.
Amendments: 10/20/22 Component GETPAT2 was added in XU*8.0*653, as a part of
the CPRS v31b release which included an enhancement to show all the alerts
related to a patient, rather than only those alerts specific to the provider.
10/20/22 Component GETUSER2 was added in XU*8.0*662 as part of the
enhancements for the display of processed alerts in CPRS v32b.
08/18/23 Components DEFALERT and GETPAT3 were added in XU*8*653 and used by
CPRS v31b release, in addition to the GETPAT2 documented on 10/20/22.
XQALDATA 2023/08/22
4851 KAAJEE Other KERNEL 2006/04/21 APPROVED Active Supported
KAAJEE addresses the Authentication and Authorization (AA) needs of
HealtheVet-VistA Web-based applications in the J2EE environment.
Most major J2EE application servers (e.g., BEA WebLogic V. 8.1 [SP4 or higher]
and Oracle's 9iAS) allow enterprises to override the default source of AA and
replace it with custom, enterprise-specific sources for AA. In order to
rapidly develop an AA solution for HealtheVet-VistA web-based applications
without creating a new enterprise user store, KAAJEE takes full advantage of
this feature of creating a custom solution. This enables KAAJEE to provide a
solution that has a similar look-and-feel of what VistA users are currently
accustomed to.
KAAJEE authenticates against a VistA M Server first with Access and Verify
codes via VistALink's AV connection spec (i.e.,
KaajeeVistaLinkConnectionSpec). After the user has been properly authenticated
against a VistA M Server, KAAJEE dynamically creates a temporary username and
password and populates this into a Structured Query Language (SQL) database
via custom Security Service Provider Interfaces (SSPIs). This username and
password is needed for the second level/phase/pass authentication for the J2EE
container.
Currently, Kernel maintains the primary HealtheVet-VistA user store (i.e., NEW
PERSON file [#200]), and provides both Authentication and Authorization (AA)
services for all HealtheVet-VistA applications. By leveraging Kernel, KAAJEE
aims to authenticate and authorize J2EE Web users to their applications using
Kernel's AA capabilities.
4855 NPI field for #200 File KERNEL 2006/05/09 APPROVED Active Private 200
Set ^DD for NPI fields in files #200 and #4:
; Set un-editable for STATUS field (#.02) in EFFECTIVE DATE/TIME subfile
(#200.042) I $P(^DD(200.042,.02,0),"^",2)'["I" D . S
$P(^DD(200.042,.02,0),"^",2)=$P(^DD(200.042,.02,0),"^",2)_"I" ; Set
un-editable for STATUS field (#.02) in EFFECTIVE DATE/TIEM subfile (#4.042) I
$P(^DD(4.042,.02,0),"^",2)'["I" D . S
$P(^DD(4.042,.02,0),"^",2)=$P(^DD(4.042,.02,0),"^",2)_"I" ; Set DEL-LAYGO for
NPI field (#41.99) in INSTITUTION file (#4) S
^DD(4,41.99,"DEL",11,0)="D:'$D(XUMF) EN^DDIOL(""Entries must be inactivated
via the Master File Server(MFS)."","""",""!?5,$C(7)"") I $D(XUMF
4868 DBIA4868 File KERNEL 2006/07/31 APPROVED Active Private 200
Subscribers have permission to $O through the "AUSER"
index of the NEW PERSON file (#200) to get a list of available provider names.
4894 FATKAAT TEST ENTRY Other KERNEL 2006/08/25 APPROVED Active Supported
Integration agreement to list the components in FATKAAT
that will be exposed for integration.
4897 MAG access top-level and BUILD COMPONENTS data File KERNEL 2006/09/05 APPROVED Active Controlled Subscription 9.6
Imaging is reading the ALPHA/BETA TESTING field #20 to
utilize a Version Control function that will not allow versions of Imaging
client software to connect to the DataBase if they are no longer supported.
- If the Server Version (that will not support Client X) is in Alpha/Beta
status, Client X will be shown a warning message. - If the Server Version
(that will not support Client X) is Released, Client X will be forced to
abort.
Update June 23rd 2022:
----------------------
This Integration Agreement (IA) has been updated to access the BUILD
COMPONENTS sub-file for routine components. The VistA Imaging (VI) application
will use the $$FIND1^DIC to lookup the VI build.
VI will use the GETS^DIQ VA FileMan utility to return data specific to the
routine BUILD COMPONENTS (#9.67).
2022/07/06
4911 TAXONOMY UTILITIES Routine KERNEL 2006/09/29 APPROVED Active Controlled Subscription
APIs to facilitate retrieval of Taxonomy Code
information from VistA NEW PERSON file (#200) and the INSTITUTION file (#4).
XUSTAX
4948 Person Service enumeration File KERNEL 2007/04/23 APPROVED Withdrawn Private 200
XU*8.0*331 is being deployed in conjunction with the ongoing transition
to HealtheVet VistA. Interdependencies include current and future
HealtheVet applications and services.
Health Systems Design & Development Common Services Person Service
has been tasked with standing up an Administrative Data Repository
(ADR) that will store identification data. Each person will be
enumerated with a unique identifier called a VPID (VA Person ID). The
first person data to be enumerated - prior to migrating the data to
the ADR will be entries in the NEW PERSON file (#200).
4958 DIRECT FILE READ OF FILE 4 File KERNEL Retired Private 4
The CBO Extract needs to extract the National Provider
Identifier (NPI) from the INSTITUTION file (#4) for the organizational
providers found in the extract under the data stream fields named DEFAULT
FACILITY and FACILITY WHERE CARE RENDERED. This is a read-only action and
does not modify any data in any fields in the file.
2007/03/04
4959 DIRECT READ OF FILE 200 File KERNEL 2007/02/18 Retired Private 200
The CBO Extract needs to extract the National Provider
Identifier (NPI) from the NEW PERSON file (#200) for the individual providers
found in the extract under the data stream field named PROVIDER. This is a
read-only action and does not modify any data in any fields in the file.
2007/03/04
4967 DBIA4967 File KERNEL 2007/02/15 Withdrawn Controlled Subscription 200
The ECME package needs to pull contact information for
specific users so that information regarding the ePharmacy interface may be
reported to the appropriate individual.
4978 Add option to XUKERNEL File KERNEL 2007/05/01 Pending Private 19
This agreement allows the subscribing package access to
the specified fields in the Option (#19) file.
4979 Default Directory for HFS File KERNEL 2007/05/01 Pending Private 8989.3
This IA allows the subscriber(s) to reference the
Default Directory for HFS (#320) field in the Kernel Systems Parameter
(#8989.3) file.
4981 Access to XUMFXHL7 parsing routine Routine KERNEL 2007/05/01 Pending Private
This agreement allows the subscribing package access to
routine XUMFXHL7 used to parse HL7 segments.
XUMFXHL7
4983 Kernel Hash file (#9.69) File KERNEL 2007/05/01 Pending Private 9.69
4984 Person Class (#8932.1) File KERNEL 2007/05/01 Under Revision Private 8932.1
This agreement provides access to the specified fields
in the Person Class (#8932.1) file.
2015/06/17
4985 XUSEREVN Routine KERNEL 2007/05/02 Pending Private
XUSEREVN creates PMU/B04, B05 and B06 HL7 messages
based on the event that has occurred in the New Person (#200) file record.
XUSEREVN
4988 EDIT LOCK IN PCMM OPTIONS. File KERNEL 2007/05/08 Pending Private 19
The EWL/PCMM enhancement team requests permission to
remove and/or delete locks on the following PCMM Options. This requires that
access to the OPTION file (#19), field #3 (LOCK). In addition, the team
request permission to replace the SCMC PCMM EWL MENU option with the standard
scheduling SD WAIT LIST MENU option on the SCMC PCMM MAIN MENU option. These
changes will be executed with standard VA Fileman calls (DIE,DICN and DIK).
The routine will be a post init on patch SD*5.3*498 and will be deleted
following the completion of the installation.
The following OPTIONS will have the locks removed.
SCMC EXTENDED REPORT
SCMC FLAGGED
SCMC INACTIVATED REPORT
SC PCMM DIRECT PC FTEE
SCMC PRACTITIONER FLAGGED
SCMC PC STAFF AUTO INACTIVATE
SCMC PCMM MAIN MENU
The following OPTIONS will have the lock SC PCMM SETUP.
SCMC PCMM NIGHTLY TASK
SCMC RETRANSMIT
SCMC PCMM ERR CODE REPORT
SCMC PCMM TRANS ERROR REPORT
SCMC EXTEND A PATIENT
The following OPTION will have the lock SCMC PCMM RETRANSMIT.
SCMC PCMM TRANS ERROR PROC
The following OPTION will be deleted from the SCMC PCMM MAIN MENU.
SCMC PCMM EWL MENU
The following OPTION will be added the SCMC PCMM MAIN MENU.
SD WAIT LIST MENU
5027 DBIA5027 File KERNEL 2007/08/07 APPROVED Active Private 200
The Scheduling Replacement Project (SRP) requires a
DBIA with Kernel for the NEW PERSON file (#200).
When a site switches over to the new Replacement Scheduling Application (RSA)
from legacy Scheduling, system users in file #200 who are active and have a
VPID will be loaded into the Oracle Internet Directory associated with the
RSAdb. This load is accomplished by means of an RSA utility that uses a flat
text file containing the Name and VPID for each user. SRP must produce the
text file via a routine that loops through the entire NEW PERSON file (#200)
global to obtain the IEN for each record.
Note: Data needed from the NEW PERSON record is obtained via supported
functions $$ACTIVE^XUSER, $$VPID^XUPS, and $$NAME^XUSER.
2007/09/24
5032 REMOTE APPLICATION REGISTRATION File KERNEL 2007/09/24 APPROVED Active Controlled Subscription 8994.5
This Integration Control Registration was created to
add an entry in the file 8994.5.
The entry in this file will allow the RPC Broker code in the host VistA system
to validate authentication requests for remote user access, and is done in
accordance with instructions on the use of the Broker Security Enhancement as
provided by the VistA Kernel team.
The file entry contains the name of the application, the application code
(encrypted), method of authentication, and authentication server IP, port, and
entry point.
Revision History:
- 3/5/25: VISS team notes that this ICR will be replaced by a future solution
currently defined in patch XU*8*759 REMOTE APPLICATION ENHANCEMENT. BSE
bypasses and not enhances VistA Kernel Security, as VistA is site-centric,
where sites control security of users and their applications. BSE bypasses
many of the components of VistA Kernel Security and site-level security.
2007/10/24
5070 Utility to return AUTHORIZE RELEASE OF NPI field Routine KERNEL 2008/01/16 APPROVED Active Controlled Subscription
An API that returns the value of the field AUTHORIZE
RELEASE OF NPI (#41.97) from an entry in the NEW PERSON file (#200).
XUSNPI 2008/01/29
5077 Radiology write with FM privilege to the NEW PERSON file File KERNEL 2008/01/18 APPROVED Active Private 200
VistA Radiology requests the privilege to write to the
NEW PERSON file using approved FileMan utilities. Radiology requests this
privilege because the package specific Application Proxy User (APU)
'RADIOLOGY, OUTSIDE SERVICE' requires two additional data attributes in order
to normalize radiology workflow.
VistA Radiology requests that we be able to use FileMan to write to the
following fields in the NEW PERSON file:
* RAD/NUC MED CLASSIFICATION (#72) sub-file: 200.072 * PERSON CLASS (#8932.1)
sub-file: 200.05 * Effective Date (case sensitive) sub-file: 200.05, field: 2
RAD/NUC MED CLASSIFICATION is required to move a radiology exam through to the
COMPLETE status.
PERSON CLASS is required to credit workload. Without a PERSON CLASS attribute
a PERSON CLASS exception for this patient care encounter event.
Effective Date is the date that this Person Class became effective for this
individual.
Please note that the lifespan of this Integration Agreement is to be short.
Once the patch is released, and the grace period for mandatory patch
installations period has passed, it is my intention that this IA be purged.
2008/01/18
5139 XUSER Routine KERNEL 2008/02/19 Pending Private XUSER
5144 DIC(45.7, File KERNEL 2008/02/19 Pending Private 45.7
5151 Exit Action for XUMF MFS EVENTS Other KERNEL 2008/02/25 APPROVED Active Private
This agreement permits Kernel to export an Exit Action
for the XUMF MFS EVENTS (MFS event driver) Protocol that invokes the following
Health Data & Informatics (HDI) API:
EXIT ACTION: I $T(MFSEXIT^HDISVAP)'="" D MFSEXIT^HDISVAP
HDI has requested to be invoked in the Exit Action of the XUMF MFS EVENTS
protocol to update the implementation status for standardization of a file in
a domain. This action was previously invoked in the Master File Parameters
Post-Processing Logic field by the applications. We are requesting it be
added to the Exit Action to make sure we are invoked last.
2008/05/01
5153 DBIA-5153 - County Code File KERNEL 2011/01/21 Withdrawn Private
5168 DBIA-5168 - Postal Code File KERNEL 2011/01/21 Withdrawn Private
5182 ECME WRITE ACCESS TO NEW PERSON FILE File KERNEL 2008/04/17 APPROVED Active Private 200
ECME (BPS) Requests write access to the New Person
(#200) file for the following fields via Fileman Input Template:
OFFICE PHONE (#.132)
EMAIL ADDRESS (#.151)
TITLE (#8)
5198 XUS DIVISION GET Remote Procedure KERNEL 2008/05/13 APPROVED Active Private
This DBIA authorizes Imaging to access the remote
procedure call XUS DIVISION GET.
XUS DIVISION GET 2008/05/20
5199 XUS DIVISION SET Remote Procedure KERNEL 2008/05/13 APPROVED Active Private
This DBIA authorizes Imaging to access the remote
procedure call XUS DIVISION SET.
XUS DIVISION SET 2008/05/20
5254 FILE 4 ACCESS File KERNEL 2008/08/25 Pending Private
5255 PRIVATE ICR FOR CISS TO ACCESS KAAJEE Other KERNEL 2008/08/27 APPROVED Active Private
1. Logins are only to be performed by the CISS framework code. This
IA and supporting IAs are granted to CISS only, not to the application
portlets/plug-ins running in CISS.
2. To run user checks and establish user identity for a specific M/VistA
system, CISS should do the following:
a. Instantiate a KaajeeVistaLinkConnectionSpec instance, using
user-entered access/verify code and division, and also obtaining the
end-user's IP address, e.g., request.getRemoteAddr().
b. Obtain a VistALink connection to the desired M/VistA system from the
appropriate VistaLink connection factory object, using the
KaajeeVistaLinkConnectionSpec instance.
c. Using the connection, run the RPC "XUS KAAJEE GET USER INFO" in the
RPC context "XUS SIGNON" to, if successful, get a DUZ back.
This also creates the sign-on log entry on the M/VistA system; the DA
of that entry is also returned. If an exception is thrown, the user
is not authorized to run RPCs on the target VistA system. The exception
will contain the reason for denial.
d. If the end-user is authorized to run RPCs by the preceding step,
use the same connection and immediately run the RPC "XUS KAAJEE LOGOUT"
under the RPC context "XUS SIGNON", passing the DA of the sign-on log
entry created. Running the RPC marks the sign-on log entry as closed.
e. Close the connection.
f. To run application RPCs for the end user, obtain a new connection
from the same VistALink connection factory, but using
VistaLinkDuzConnectionSpec (or, when supported,
VistaLinkVpidConnectionSpec.)
3. For the duration of the user session, the DUZ may be used with
DuzConnectionSpec to run RPCs.
4. Whether or not CISS caches a user's DUZ, for any new CISS user
sessions requiring access to a VistA system, all steps 2a-2f should be
performed again, as the user's authorization to log onto the VistA system
may have been revoked or otherwise may have changed since the previous
session.
2008/09/12
5256 XUS KAAJEE GET USER INFO Remote Procedure KERNEL 2008/08/28 APPROVED Active Private
This is a private ICR/IA for CISS and is in support of ICR/IA # 5255.
Also, this RPC adds a new entry in Kernel's SIGN-ON LOG (File #3.081).
XUS KAAJEE GET USER INFO 2008/09/12
5257 XUS KAAJEE LOGOUT Remote Procedure KERNEL 2008/08/28 APPROVED Active Private
This is a private ICR/IA for CISS and is in support of ICR/IA # 5255.
XUS KAAJEE LOGOUT 2008/09/12
5283 FBCS File #200 Read only File KERNEL 2008/10/23 Withdrawn Controlled Subscription 200
5288 ZOSVKR Routine KERNEL 2008/11/10 APPROVED Active Private
The pharmacy re-engineering team needs a way to record
the time it takes to make a call for an order check. Order checks usually take
less than a second or two (possibly more if an RDI call is necessary). The
Kernel API $$STATS^%ZOSVKR breaks down the time frame into hundredths of a
second. This information is vital for Pharmacy Re-Engineering.
%ZOSVKR 2011/04/22
5406 Proxy User in File 200 File KERNEL 2009/03/17 APPROVED Active Private 200
The Veteran On-Line Application (VOA) project will make it easier
for veterans to register for medical benefits from VHA via the web.
National Enrollment Service (ESR), through Person Service Identity
Management (PSIM), uses a Remote Procedure to add a patient record
at the designated Preferred VistA Facility after the proper vetting
process.
The Remote Procedure is invoked on the Master Patient Index Austin
by PSIM via a proxy user in the NEW PERSON (#200) file. This proxy
user is assigned the PSIM GUI VistALink Access [MPI PSIM GUI
INTERFACE] secondary menu option. The user NAME and SECONDARY MENU
OPTION fields are created using the $$CREATE^XUSAP(proxyname,fmac,
options) API in IA# 4677. The other fields populated are listed below.
Because testing takes place on multiple "MPI" environments before
final installation on the national Austin Master Patient Index, the
PSUSER,APPLICATION PROXY user will be created in a post-init routine.
This ensures that the fields required for the RPC to work successfully
are created.
2009/04/20
5470 XUMF MFS EVENTS Other KERNEL 2009/07/16 APPROVED Active Controlled Subscription
This is the event invoked by the Master File Server
(MFS) mechanism. Actions from any application area that are dependent on this
event may be added to this event upon approval of the DBIC.
MFS provides an event point that protocols of domain developers may subscribe.
The following data is provided by MFS that documents changes to records of the
files related to the domain updated:
UPDATE
^TMP("XUMF EVENT",$J,IFN,"NEW",IEN) -- this is a new record ^TMP("XUMF
EVENT",$J,IFN,"AFTER",IEN) -- updated record (internal format) ^TMP("XUMF
EVENT",$J,IFN,"BEFORE",IEN) -- before image (internal format)
STATUS
^TMP("XUMF EVENT",$J,IFN,"STATUS",IEN) = Term Status Before ^ Effective
Date/Time Before ^ Term Status After ^ Effective Date/Time After
REPLACED BY VHA STANDARD TERM (#99.97)
^TMP("XUMF EVENT",$J,IFN,"BEFORE",IEN,"REPLACED BY")=internal value ^TMP("XUMF
EVENT",$J,IFN,"BEFORE",IEN,"INHERITS FROM")=$$RPLCMNT^XTIDTRM ^TMP("XUMF
EVENT",$J,IFN,"AFTER",IEN,"REPLACED BY")=internal value ^TMP("XUMF
EVENT",$J,IFN,"AFTER",IEN,"INHERITS FROM")=$$RPLCMNT^XTIDTRM
ERROR
^TMP("XUMF EVENT",$J,"ERROR") = Error message ^TMP("XUMF EVENT",$J,"ERROR",1)
= IFN ^ IEN
Note:
A record updated with same values (overwrite existing values with identical
values) does not create a TMP record.
New Record
^TMP("XUMF EVENT",$J,"NEW",IFN,IEN) is set equal to NULL The BEFORE and AFTER
nodes are not set.
Update
The pre-update state of the record is merged into ^TMP("XUMF
EVENT",$J,"BEFORE",IFN,IEN)
The post-update state of the record is merged into ^TMP("XUMF
EVENT",$J,"AFTER",IFN,IEN)
The NEW node is not set.
Examples:
GMRV VITAL TYPE (#120.51)
NAME: WEIGHT ABBREVIATION: WT
RATE: YES RATE HELP: GMRV-WEIGHT RATE HELP
PCE ABBREVIATION: WT
RATE INPUT TRANSFORM: I '("UNAVAILABLEPASSREFUSED"...
Internal
^GMRD(120.51,9,0)=WEIGHT^WT^^1^^GMRV-WEIGHT RATE HELP^WT ^GMRD(120.51,9,1)=I
'("UNAVAILABLEPASSREFUSED"...
NEW RECORD
^TMP("XUMF EVENT",$J,120.51,"NEW",9)=
UPDATED RECORD
NAME: WEIGHT ABBREVIATION: WT
RATE: YES RATE HELP: GMRV-WEIGHT RATE HELP
PCE ABBREVIATION: WT
RATE INPUT TRANSFORM: I '("UNAVAILABLEPASSREFUSED"... EFFECTIVE DATE/TIME:
JUN 07, 2007@12:01:23
STATUS: ACTIVE
VUID: 4500639 MASTER ENTRY FOR VUID: YES
^TMP("XUMF EVENT",$J,120.51,"AFTER ,9,0)=WEIGHT^WT^^1^^GMRV-WEIGHT RATE
HELP^WT^ ^TMP("XUMF EVENT",$J,120.51,"AFTER ,9,1)=I
'("UNAVAILABLEPASSREFUSED"... ^TMP("XUMF EVENT",$J,120.51,"AFTER
,9,"TERMSTATUS",0)=^120.5199DA^1^1 ^TMP("XUMF EVENT",$J,120.51,"AFTER E
,9,"TERMSTATUS",1,0)=3070607.120123^1 ^TMP("XUMF EVENT",$J,120.51,"AFTER
,9,"TERMSTATUS","B",3070607.120123,1)= ^TMP("XUMF EVENT",$J,120.51,"AFTER
,9,"VUID")=4500639^1 ^TMP("XUMF EVENT",$J,120.51,"BEFORE
,9,0)=WEIGHT^WT^^1^^GMRV-WEIGHT RATE HELP^WT ^TMP("XUMF
EVENT",$J,120.51,"BEFORE ,9,1)=I '("UNAVAILABLEPASSREFUSED"...
2011/10/31
5501 XUS SET VISITOR Remote Procedure KERNEL 2009/09/28 APPROVED Active Private
VistA Imaging is requesting permission to use a Kernel
API, SETVISIT^XUSBSE1, to obtain the BSE token.
XUS SET VISITOR 2010/06/16
5502 IMAGING BSE File KERNEL 2009/09/28 APPROVED Active Private 8994.5
Imaging is requesting permission to add four entries
into file 8994.5 to be used by our Imaging applications. The entries will
contain the name of the application, the application code (encrypted,) method
of authentication, and authentication server IP, port, and entry point.
2010/06/16
5506 HDIS TEXT FILE DEPLOYMENT MFS INTERFACE Routine KERNEL 2009/11/10 Pending Supported
The text file deployment tool will replace the normal
VistA HL7 message processing (on development and test systems only) with a new
front end to feed MFS with HL7 message segments read from a text file.
XUMF1H
5509 HDIS TEXT FILE DEPLOYMENT MD5 CHECKSUM QUERY Routine KERNEL 2009/12/03 Pending Supported
The text file deployment tool will call EN^XUMF5I to
calculate the checksum for a STS deployment.
XUMF5I
5510 HDIS TEXT FILE DEPLOYMENT - ENTER PASSWORD Routine KERNEL 2009/12/09 Pending Supported
HDIS Text File Deployment Tool needs to enter a
password for an ftp session.
XUS
5522 ECAR File KERNEL 2010/02/23 Pending Private 200
5523 kjlh File KERNEL 2010/02/23 Pending Private 200
5524 CHANGE PACKAGE NAME AND DESCRIPTIONS File KERNEL 2010/02/23 Pending Controlled Subscription 9.4
ICB (DSIV namespace) and FBCS (DSIF namespace) changed
their package names during the Class I process. The installation of the full
build at existing ICB and FBCS sites (the Class III sites) did not update the
package name. The VA Business office for these products would like the
package name and description fields to more accurately reflect the Class I
information.
A pre-install for patch 1 for both of these applications will do a look-up on
the 'C' cross-reference of the PACKAGE file (#9.4) to find the appropriate
entry and change the following fields using Fileman:
^DIC(9.4,D0,0)
.01 NAME 0;1 Fileman write
2 SHORT DESCRIPTION 0;3 Fileman write
^DIC(9.4,D0,1,D1,0)
.01 DESCRIPTION WP field Fileman write
5532 XUS GET VISITOR Remote Procedure KERNEL 2010/06/04 APPROVED Active Private
VistA Imaging is requesting permission to use a Kernel
API, GETVISIT^XUSBSE1 to verify if a BSE token is still valid.
XUS GET VISITOR 2010/06/16
5533 ACCESS TO READ FILE #200 ANPI INDEX Other KERNEL 2010/06/11 Pending Controlled Subscription
Permission to access the file #200 ANPI index to find
records with NPIs.
5567 XPDPROT Routine KERNEL 2010/09/01 APPROVED Active Supported
A set of calls and extrinsic functions that can be used
to manage protocols in the PROTOCOL file during a KIDS install.
XPDPROT 2010/11/11
5587 IMAGING ADD NEW FIELD TO ACTIONS FILE File KERNEL 2010/12/09 Pending Private 2005.86
IMAGING is requesting permission to add one new field
into file 2005.86 IMAGE ACTIONS FILE - DIVISION The IMAGE ACTIONS file
(#2005.86) will be made division aware. A new multiple filed will be added
that referenced divisions are pointed to INSTITUTION FILE (#4). The "B" cross
reference of the IMAGING SITE PARAMETERS file (#2006.1) will be used to
collect possible divisions for the field value.
5612 RE-INDEX 'AD' CROSS-REFERENCE ON SECONDARY MENU OPTIONS File KERNEL 2011/03/02 APPROVED Active Private 200
The Laboratory System Re-engineering Project (LSRP)
Rollback Tool Kit (RTK) has a onetime request to re-index the 'AD'
cross-reference on the SECONDARY MENU OPTIONS field (#203) in the NEW PERSON
file (#200). The re-indexing will take place in the post-init for patch
LR*5.2*393 in routine LR393. The code is as follows:
REINDEX ; -- index 'AD' xref on NEW PERSON file
D MES^XPDUTL("Re-indexing 'AD' Cross Reference on SECONDARY MENU
OPTIONS (#203) field")
D MES^XPDUTL("in the NEW PERSON (#200) file...")
N LRDUZ
S LRDUZ=0
F S LRDUZ=$O(^VA(200,LRDUZ)) Q:'LRDUZ D
. N DIK,DA
. Q:'$O(^VA(200,LRDUZ,203,0))
. S DA(1)=LRDUZ,DIK="^VA(200,"_DA(1)_",203,",DIK(1)=".01^AD" D
ENALL^DIK
D MES^XPDUTL("Done re-indexing.")
Q
2011/03/07
5614 READ/WRITE ACCESS W/FILEMAN TO LOCK FIELD (#3) File KERNEL 2011/03/02 APPROVED Active Controlled Subscription 19
Additional package(s) have been added to this ICR as
subscribers. The listed packages may use standard FileMan APIs such as
$$GET1^DIQ to read the current value of the NAME and LOCK fields. It may
also be used to delete the current value of the LOCK field from an existing
option during a patch install since KIDS does not provide that capability.
The ICR supports the back-out/rollback process.
1) The following FileMan API is used to query for the NAME field (#.01) and
the LOCK field (#3) in the OPTION file (#19):
D LIST^DIC(19,"","@;.01I;.01;3I;3","PQ","","","","",LRSCR,"",,"LRMSG")
where LRSCR="I ($E(^(0),1,2)=""LA""!($E(^(0),1,2)=""LR""))"
2) The following FileMan API is used to update the LOCK field (#3) in the
OPTION file (#19):
S LRFDA(19,LROPT_",",3)=LRVALI
D FILE^DIE("","LRFDA","LRMSG")
where LROPT is the OPTION file (#19) IEN
LRVALI is the Name of the Key
2011/03/07
5615 READ ACCESS W/FILEMAN TO OPTION SCHEDULING FILE (#19.2) File KERNEL 2011/03/07 APPROVED Active Private 19.2
The Laboratory System Re-engineering project (LSRP)
Rollback Tool Kit (RTK) uses FileMan API(s) to query information in the OPTION
SCHEDULING file (#19.2) for the Preservation step in the RTK.
1) The following FileMan API is used to query for the NAME (#.01), QUEUED TO
RUN AT WHAT TIME (#2), DEVICE FOR QUEUED JOB OUTPUT (#3), QUEUED TO RUN ON
VOLUME SET (#5), RESCHEDULING FREQUENCY (#6), SPECIAL QUEUEING (#9), USER TO
RUN TASK (#11) and TASK PARAMETERS (#15) fields in the OPTION SCHEDULING file
(#19.2):
D LIST^DIC(19.2,"",LRFLDS,"PQ","","","","",LRSCR,"",LRQRY,"LRMSG")
where LRFLDS="@;.01;2;3;5;6;9;11;15"
LRSCR="N LRX S LRX=$G(^DIC(19,+^(0),0)) I ($E(LRX,1,2)=""LA""!
($E(LRX,1,2)=""LR"")),$E(LRX,1,3)'=""LRJ"",$E(LRX,1,4)
'=""LA7J"""
2) The following FileMan API is used to query the OTHER PARAMETERS (#10)
subfile (#19.21) field in the OPTION SCHEDULING file (#19.2):
D GETS^DIQ(19.2,LRIEN_",","10*","E","LROTHER","LRMSG")
where LRIEN is the OPTION SCHEDULING file (#19.2) IEN
3) The following FileMan API(s) are used to look-up and display an entry in
the OPTION SCHEDULING file (#19.2):
S DA=+$$FIND1^DIC(19.2,"","XQ",LROPTI,"B","","LRERR")
I 'DA Q
S DIC="^DIC(19.2,"
S DIQ(0)=""
D EN^DIQ
where LROPTI is the OPTION file (#19) IEN
2011/03/08
5688 USE XTMP GLOBAL DURING KIDS INSTALL PROCESS File KERNEL 2011/06/22 APPROVED Active Private
The AMIE package has a requirement to version control
new CAPRI TEMPLATE DEFINITIONS (#396.18) file entries when installing a patch.
Each test patch install has a different version control number appended to
the exported entries (e.g. ~###T1 for patch ### test version 1) versus the
released patch (e.g. ~### for released patch ###). Currently the developers
code this in the Pre/Post Init Routine and update it for each test version
that is done. After the final test version is signed off by test sites the
Pre/Post Init Routine is appropriately updated to remove the "T#" text.
Using KERNEL data that is already available within the KIDS installation
process, the AMIE developers will be able to provide appropriate version
control of CAPRI TEMPLATE DEFINITION file entries without editing the Pre/Post
Init Routine for each new test and the final released patch version.
When patch XU*8*559 is released it will define two supported variables for
this purpose: XPDNM("TST")=test number and XPDNM("SEQ")=sequence number.
Until this patch is released the AMIE team request the ability to utilize the
following global created in the KERNEL KIDS process which is present during
the pre and post install process:
^XTMP("XPDI",XPDA,"BLD",XPDBLD,6)=test number^sequence number.
AMIE Pre/Post Init Routines will check if the above mentioned ^XTMP global
exists and if it does use the test number or sequence number for its version
control requirement. Please note that once the patch is installed the Pre/Post
Init Routine is deleted from the system.
This ICR needs to be in place until patch XU*8*559 has been nationally
released and installed at all Medical Centers.
2011/06/28
5718 OP ACCESS WINDOWS NETWORK PRINTER NAME IN THE DEVICE FILE File KERNEL 2011/08/24 APPROVED Active Private 3.5
Outpatient Pharmacy requests permission to access the
WINDOWS NETWORK PRINTER NAME field (#75) in the Kernel DEVICE (#3.5) file.
This field is used to identify the printer location in the Windows network.
Outpatient Pharmacy will pass the printer location to a Java application so it
can print documentation in a .pdf format related to a specific prescription.
2011/08/24
5725 TERMINAL TYPE File KERNEL 2011/09/15 APPROVED Active Private 3.2
The Mental Health package requests permission to read
some fields in the TERMINAL TYPE (#3.2) file.
2012/03/05
5726 LSRP ADD X-REF TO NEW PERSON FILE File KERNEL 2011/09/16 APPROVED Active Private 200
The Lab System Re-Engineering Project (LSRP) has
permission to define 2 New Style Cross references on the New Person File
(#200) with patch LR*5.2*393. These cross references are added to the New
Person file as part of the KIDS Post-Installation process of the LR*5.2*393
distribution. These Cross References are installed using the CREIXN^DDMOD
Fileman API.
Kernel development grants this "one-time" ICR allowing LSRPs' addition of
"ALSRP" and "AKLSRP" cross-references to the New Person file (#200) by the
LR*5.2*393 patch.
New Style Cross references "ALSRP" and "AKLSRP" are described as follows:
"ALSRP"
-------
"ALSRP" checks for changes to specific fields in the New Person File (#200).
When data in a relative field is changed, "ALSRP" SET logic invokes OPKG^XUHUI
(allowed via ICR #3589) referencing the "LA7J MFN NEW PERSON MOD PRTCL" entry
in the Protocol file (#101).
"ALSRP" is defined for the following New Person fields:
NAME (#.01)
OFFICE PHONE (#.132)
VOICE PAGER (#.137)
DIGITAL PAGER (#.138)
SEX (#4)
DOB (#5)
SSN (#9)
NPI (#41.99)
Data Dictionary Description:
ALSRP RECORD MUMPS ACTION
Short Descr: LSRP monitoring of New Person Field changes
Description: This M New Style Cross reference will monitor changes to
New Person fields that are relevant to the Lab System
Re-Engineering Project.
User contact and other information on the Cerner Pathnet
system must be synchronized with changes made (for Lab
users) on VistA. This cross- reference will invoke code
that sends a Master File Notification to Cerner when a
change to pertinent data is made.
Only users holding either the LRJ CERNER PRA or LRJ CERNER
STF security keys will be sent via MFN to Cerner.
Set Logic: D OPKG^XUHUI("101","LA7J MFN NEW PERSON MOD PRTCL","","ALSRP")
Kill Logic: Q
Whole Kill: Q
X(1): NAME (200,.01) (forwards)
X(2): OFFICE PHONE (200,.132) (forwards)
X(3): VOICE PAGER (200,.137) (forwards)
X(4): DIGITAL PAGER (200,.138) (forwards)
X(5): SEX (200,4) (forwards)
X(6): DOB (200,5) (forwards)
X(7): SSN (200,9) (forwards)
X(8): NPI (200,41.99) (forwards)
"AKLSRP"
--------
"AKLSRP" checks changes to the set of New Persons holding specific Security
Keys and is defined on the New Person file KEYS subfile (#200.051), KEY field
(#.01). When KEY allocations and de-allocations occur, "AKLSRP" SET and KILL
logic invoke OPKG^XUHUI (see ICR #3589) referencing the "LA7J MFN NEW PERSON
KEY MOD PRTCL" entry in the Protocol file (#101).
Data Dictionary Description:
Subfile #200.051
AKLSRP FIELD MUMPS ACTION WHOLE FILE (#200)
Short Descr:
This cross reference creates LSRP MFNs when a lab key is added.
Description: The AKLSRP New Style Cross reference will invoke a protocol
that checks when a key is added or deleted. If the
affected key is LRJ CERNER PRA or LRJ CERNER STF, then an
MFN will be sent to Cerner Pathnet, as necessary.
Set Logic:
D OPKG^XUHUI("101","LA7J MFN NEW PERSON KEY MOD PRTCL","","AKLSRP")
Kill Logic:
D OPKG^XUHUI("101","LA7J MFN NEW PERSON KEY MOD PRTCL","K","AKLSRP")
X(1): KEY (200.051,.01) (forwards)
2011/10/27
5776 LISTEN~%ZISTCPS Routine KERNEL 2012/03/05 APPROVED Active Controlled Subscription %ZISTCPS 2012/04/30
5790 LSRP Proxy User in File 200 File KERNEL 2012/04/24 Pending Private 200
The Lab System Re-engineering Project (LSRP) has a
requirement that the DIVISION and DEFAULT fields of the NEW PERSON file (#200)
be defined for the LSRP proxy user LRLAB,AUTOACCEPT at multi-divisional
facilities.
5816 XUS PKI GET UPN Remote Procedure KERNEL 2012/06/25 APPROVED Active Controlled Subscription
Allows retrieval of the SUBJECT ALTERNATIVE NAME field
(#501.2) in the NEW PERSON file (#200).
XUS PKI GET UPN XUSER2 2012/09/10
5823 XUS PKI SET UPN Remote Procedure KERNEL 2012/07/11 APPROVED Active Controlled Subscription
Allows updating of the SUBJECT ALTERNATIVE NAME field
(#501.2) in the NEW PERSON file (#200).
XUS PKI SET UPN 2012/09/10
5824 XU EPCS EDIT Remote Procedure KERNEL 2012/07/11 APPROVED Active Controlled Subscription
Creates an entry in the XUEPCS DATA file (#8991.6) that
serves as an audit log of changes made to data in fields in the NEW PERSON
file (#200) that are used in the electronic Prescribing of Controlled
Substances (e-PCS) functionality.
XU EPCS EDIT 2012/09/10
5832 LOCK MANAGER APIs Routine KERNEL 2012/08/14 APPROVED Active Supported XULMU 2012/09/10
5844 XLFIPV (IP UTILITIES) Routine KERNEL 2012/09/11 APPROVED Active Supported
Use of the VistA XLFIPV IPv4 and IPv6 Utility
Application Programming Interfaces (APIs).
These APIs support the dual-stack protocol implementation as an IPv4-to-IPv6
transition technology per Internet Engineering Task Force (IETF) Request For
Comments (RFC) #4213.
They support input of IPv4 or IPv6 addresses either in standard form, or in a
hybrid form using IPV4-Mapped IPv6 addresses. In hybrid dual-stack
implementations the first 96-bits are written in the standard IPv6 format, and
the remaining 32 bits written in the dot-decimal notation of IPv4.
IP address output of the APIs will be in standardized IPv4 dot-decimal
notation or in expanded IPv6 notation, where the address is represented by 8
groups of 16-bit values, each represented as 4 hexadecimal digits and
separated by colons. The hexadecimal digits will be capitalized to facilitate
storage of IP addresses in a consistent form to simplify searches and reports.
The exception will be the IPv6 null address returned when the input is in an
invalid format, which is commonly represented as "::0".
XLFIPV 2014/01/14
5848 HL7 PKG ACCESS TO TASKMAN SITE PARAMETERS FILE File KERNEL 2012/10/02 APPROVED Active Private 14.7
Configuration files of the HL7 package need to point to
the TASKMAN SITE PARAMETERS file (#14.7) to allow sites to configure HLO
processes to run on specific nodes. The node is read from the BOX-VOLUME PAIR
field (#.01) and used as an input parameter to Taskman.
2013/01/17
5899 IFCAP File KERNEL 2013/02/05 APPROVED Active Private 200
Removal of PRCFA SUPERVISOR key from file #200 (NEW
PERSON) for terminated employees. Currently the key has a KEEP AT TERMINATE
set to YES and the key is changing (via patch PRC*5.1*168) KEEP AT TERMINATE
to NO. This will satisfy fiscal audits that show the key falsely assigned to
terminated employees.
This one-time key removal for terminated employees will be done by a post
install routine PRC168P that will flip the KEEP AT TERMINATE setting for PRCFA
SUPERVISOR key to NO and remove key from any terminated employee in file #200.
2013/04/12
5900 IFCAP File KERNEL 2013/02/06 APPROVED Active Private 19.1
Modification of PRCFA SUPERVISOR key field KEEP AT
TERMINATE from 'YES' to 'NO'. Currently the key has KEEP AT TERMINATE set to
YES and the key is changing (via patch PRC*5.1*168) KEEP AT TERMINATE to NO.
This will satisfy fiscal audits that show the key still assigned to terminated
employees.
This one-time field update of KEEP AT TERMINATE will be done by a post install
routine PRC168P that will flip the KEEP AT TERMINATE setting for the PRCFA
SUPERVISOR key to NO and remove the key from any terminated employee in file
#200.
2013/04/12
5902 New Person Telephone and e-Mail Address File KERNEL 2013/03/08 Withdrawn Private 200
IFCAP needs to extract contact information including
telephone numbers and e-mail address from user's record in the New Person file
(#200) for display and transmission via HL7 messages to external system.
6008 DBIA6008 READ ACCESS TO FILE 200 File KERNEL 2013/08/08 Withdrawn Private 200
Retrieves all authorized DSS Unit IENs from NEW PERSON
file using "EC" cross reference. ^VA(200,D0,"EC",DSS Unit IEN)
6043 READ DUPLICATE RECORD FILE File KERNEL 2014/04/15 APPROVED Active Private 15
PCMMR would like to reference fields in the following
file directly:
DUPLICATE RECORD (#15) FILE
IEN, .01 RECORD1, .02 RECORD2, .03 STATUS, .04 MERGE DIRECTION, .05 MERGE
STATUS
When PCMMR receives an ADT-A24 HL7 message from MPI indicating a merge of
identities that is a "local merge" on a single station, PCMMR needs to query
the Duplicate Record file to determine whether VistA has completed the
resolution of duplicate patients. If and only if the local VistA staff
performing the Local Merges chooses to accept and process this local data
merge, PCMMR will complete the data merge in its own enterprise database,
enabling it to continue data synchronization with the VistA site. If VistA
chooses to deny the merge request, or merge the patient data in the opposite
direction, PCMMR can use the status in this file to adjust its behavior
accordingly.
The code queries field .05 MERGE STATUS to find the status of the merge
process for each pair of duplicate records. If it finds value 3 - IN PROCESS,
it starts polling VistA. It will poll VistA at increasing time interval until
we exceed the maximum polling limit (currently 5 days from start of polling).
If during polling it finds a value of 2 - MERGED, in a duplicate pair, the
code processes the patient's data for the site and sends an application ack
(acknowledgement) to MVI.
The file is accessed using a PCMMR restricted RPC "SCMC LISTER", which employs
a Fileman DBS API to retrieve data from File 15. It is deployed as part of
patch SD*5.3*603.
2014/07/09
6055 MBAA USE OF API IN XUMF Routine KERNEL 2014/04/24 Pending Private
6081 Proxy User for HCPS Routine KERNEL 2014/08/05 APPROVED Active Private 200
The Consult/Request Tracking (GMRC) package can
establish the Application Proxy HCPS,APPLICATION PROXY user. This user will
be used to establish an user environment when processing HL7 messages between
Healthcare Claims Processing System (HCPS) and VistA. The user will not have
Access or Verify codes and will have a User Class of APPLICATION PROXY.
The GMRC application can use the API $$CREATE^XUSAP(proxyname, fmacc, options)
in patch GMRC*3*75 to create the user.
INPUT: proxyname = HCPS,APPLICATION PROXY
fmacc = FileMan Access Code
options = should be blank, user doesn't need any options
This ICR is for 1 year. At the end of a year it should be re-evaluated to see
if a non-anonymous solution exists in VistA.
XUSAP 2015/08/21
6121 REMOVE SCHEDULED OPTIONS FROM #19.2 File KERNEL 2014/10/03 Active Private 19.2
Scheduling (PCMM, PCMM WEB, PAIT, ACRP, and EWL)
requests permission to lookup and delete entries in the Option Scheduling
(19.2) File for the Options - SCMC PCMM NIGHTLY TASK, SCMC PCMM HL7 NIGHTLY
TASK, SD-PAIT TASKED TRANSMISSION, SCDX AMCAR NIGHTLY XMIT, SD WAIT LIST TRANS
TO AAC. Task SCMC PCMM NIGHTLY TASK will no longer be required to run on
VistA; it will be performed by the new PCMM Web application. SCMC PCMM HL7
NIGHTLY TASK, SD-PAIT TASKED TRANSMISSION, SCDX AMCAR NIGHTLY XMIT, SD WAIT
LIST TRANS TO AAC have been replaced by the Corporate Data Warehouse (CDW).
This will be done by a post-install routine using the ^DIK Fileman API in
patch SD*5.3*603, SD*5.3*624, SD*5.3*638, SD*5.3*639, AND SD*5.3*640. (PCMM,
PCMM WEB, PAIT, ACRP, and EWL functionality falls under the Scheduling
namespace.)
AMIE and CAPRI Options - DVBA C PURGE 2507 and DVBA REGIONAL PURGING PROGRAM
will also use this agreement to be deleted from the Option Scheduling File.
This will be done by a post-install routine using the ^DIK Fileman API in
patch DVBA*2.7*195.
This ICR is only valid for SD*5.3*603, SD*5.3*624, SD*5.3*638, SD*5.3*639,
SD*5.3*640 and DVBA*2.7*195.
2015/01/29
6126 IB READ/WRITE ACCESS W/FILEMAN TO LOCK FIELD (#3) File KERNEL 2014/11/07 APPROVED Active Private 19
IB requires the ability to delete a LOCK from an
OPTION. This cannot be accomplished using KIDS. Permission is required to
accomplish this task using pre- or post-install routines in KIDS.
2014/12/03
6147 VPS READ OF 3.5 File KERNEL 2015/01/26 APPROVED Active Controlled Subscription 3.5
This IA provides for the Fileman read of the NAME,
LOCATION OF TERMINAL, MARGIN WIDTH, PAGE LENGTH, and PRINT SERVER NAME OR
ADDRESS fields in the DEVICE file #3.5.
2015/03/03
6157 XLFSHAN Routine KERNEL 2015/02/05 APPROVED Active Supported
This DBIA describes supported references in the routine
XLFSHAN which provides Kernel APIs for Secure Hash Algorithm (SHA) hashing of
input of various formats.
Federal Information Processing Standards Publication 180-4 (FIPS PUB 180-4)
specifies secure hash algorithms for computing a condensed representation of
electronic data (message). The hash algorithms specified in this Standard are
called secure because, for a given algorithm, it is computationally infeasible
1) to find a message that corresponds to a given message digest, or 2) to find
two different messages that produce the same message digest. Any change to a
message will, with a very high probability, result in a different message
digest.
XLFSHAN 2017/12/19
6169 READ/WRITE ACCESS TO NEW PERSON FILE File KERNEL 2015/03/03 APPROVED Active Private 200
This is a onetime agreement via patch SD*5.3*603.
Post install processing looks for users that have a secondary menu option of
SCMC PCMM GUI WORKSTATION (legacy PCMM broker menu) and changes it to SCMC
PCMMR WEB USER MENU (PCMM Web broker menu).
Scheduling (PCMM Web) requests read access to the NEW PERSON (#200) file to
$ORDER through the records, $ORDER through SECONDARY MENU OPTIONS (#200.03)
multiple, then FileMan API ($$GET1^DIQ) to interrogate the value of the
SECONDARY MENU OPTIONS (.01) field. If it resolves to SCMC PCMM GUI
WORKSTATION, then we request write access to change the value to SCMC PCMMR
WEB USER MENU using FileMan API FILE^DIE.
2015/03/27
6170 READ ACCESS TO NEW PERSON DIVISION MULTIPLE File KERNEL 2015/03/03 Withdrawn Private 200
Scheduling (PCMM Web) requests direct global read
access to the NEW PERSON (#200) file, DIVISION (#16) multiple to $ORDER
through a person's assigned Divisions.
6178 READ ACCESS TO NEW PERSON FILE B CROSS REFERENCE File KERNEL 2015/03/10 Withdrawn Private 200
Scheduling (PCMM) requests read access to the B cross
reference of the NEW PERSON (#200) file. The code in question will $ORDER
through the cross reference looking for a name match to a passed parameter.
6189 XUSHSH Hashing and Encryption APIs Routine KERNEL 2015/04/02 APPROVED Active Supported
This DBIA describes supported references in the routine
XUSHSH which provides Kernel APIs for hashing, encoding/decoding, or
encryption/decryption of input of various formats.
XUSHSH 2015/08/18
6212 ZTMGRSET Routine KERNEL 2015/08/12 APPROVED Active Private
VA FileMan request use of MOVE^ZTMGRSET to rename the following routines:
DIDT renamed to %DT
DIDTC renamed to %DTC
DIRCR renamed to %RCR
This is needed during the install of any new version of VA FileMan.
It will be called in the post install routine.
ZTMGRSET 2015/09/24
6230 VACAA BULK-LOAD NON-VA PROVIDER INFORMATION Routine KERNEL 2015/09/28 APPROVED Active Private
Bulk-load non-VA entities and providers to be
identified in VistA when documenting patient care.
On August 7, 2014, the President signed into law PL 113-146, the Veterans
Access, Choice, and Accountability Act of 2014 (VACAA). The law offers an
additional authority for VHA to expand current capacity and ensure that
Veterans have timely access to high-quality care. The law creates a new
paradigm for providing health care, set forth in the Veterans Choice program
provisions within Title I Section 101 of VACAA. VA is utilizing a Contractor
to provide health care and third party administrative (TPA) services set forth
through VACAA Section 101. As a result of this law, VA must upload a list of
non-VA medical care providers into the VistA system in order to maintain an
accurate and updated list of non-VA providers in the Choice program.
This interface is available under a private Integration Agreement for support
of VACAA only, and should not be used under any other circumstances.
XUESSO4 2016/08/29
6286 XUS KEY CHECK Remote Procedure KERNEL 2015/12/09 APPROVED Active Supported
This RPC will check if the user (DUZ) holds a security
key or an array of keys. If a single security KEY is sent the result is
returned in R(0). If an array is sent down then the return array has the same
order as the calling array.
Input parameter: KEY - If key is a single value it holds one key to check. If
key is an array then the result is an array that matches the key list with
values that match the status of the key check for each key. The return is a 1
if the user has the key and 0 if not.
Input parameter: IEN - (Optional) If provided, this is the IEN of the user in
the NEW PERSON file (#200) to check if they hold the key(s) listed in KEY. If
not provided, this parameter defaults to the DUZ (IEN) of the current user.
XUS KEY CHECK 2016/09/12
6287 XUS ALLKEYS Remote Procedure KERNEL 2015/12/09 APPROVED Active Supported
This RPC will return all the KEYS that a user holds. If
the FLAG is set to some value the list of KEYS will be screened to only be
those for J2EE use. The RPC was designed for FATKAAT and KAAJEE (VistALink
clients) but may be used by other applications.
Input parameter: IEN - This is the IEN or DUZ of the user in question. If not
passed in, the RPC will use the current user DUZ (IEN).
XUS ALLKEYS 2017/10/03
6288 XUS IAM FIND USER Remote Procedure KERNEL 2015/12/09 APPROVED Active Controlled Subscription XUS IAM FIND USER 2016/08/22
6289 XUS IAM DISPLAY USER Remote Procedure KERNEL 2015/12/09 APPROVED Active Controlled Subscription XUS IAM DISPLAY USER 2016/08/22
6290 XUS IAM ADD USER Remote Procedure KERNEL 2015/12/09 APPROVED Active Controlled Subscription XUS IAM ADD USER 2016/08/22
6291 XUS IAM EDIT USER Remote Procedure KERNEL 2015/12/09 APPROVED Active Controlled Subscription XUS IAM EDIT USER 2016/08/22
6292 XUS IAM TERMINATE USER Remote Procedure KERNEL 2015/12/09 APPROVED Active Controlled Subscription XUS IAM TERMINATE USER 2016/09/12
6293 XUS IAM REACTIVATE USER Remote Procedure KERNEL 2015/12/09 APPROVED Active Controlled Subscription XUS IAM REACTIVATE USER 2016/09/12
6294 XUS IAM BIND USER Remote Procedure KERNEL 2015/12/09 APPROVED Active Controlled Subscription XUS IAM BIND USER 2016/08/22
6295 XUS ESSO VALIDATE Remote Procedure KERNEL 2015/12/09 APPROVED Active Private XUS ESSO VALIDATE 2016/08/22
6296 XUS CVC Remote Procedure KERNEL 2015/12/09 APPROVED Active Private XUS CVC 2017/09/01
6342 Kernel-Storage API Routine KERNEL 2016/01/06 APPROVED Active Private
This API documents the callable APIs in the Kernel
routine %ZOSVKSD used for OS specific calls on behalf of VistA Capacity
Planning software. The purpose of this routine is to gather storage metrics.
%ZOSVKSD 2016/01/13
6343 Kernel Global Size APIs Routine KERNEL 2016/01/06 APPROVED Active Private
This API documents the callable APIs in the Kernel
routine %ZOSVKSE used for OS specific calls on behalf of VistA Capacity
Planning software. The purpose of this routine is to gather storage metrics
related to VistA globals.
%ZOSVKSE 2016/01/13
6363 REMOVE SCHEDULED OPTION FROM #19.2 File KERNEL 2016/02/19 Pending Private 19.2
In Prosthetics package, the Patient Notification Letter
project was terminated, but there were options/routines already sent out via
patch RMPR*3.0*125. One of the options 'RMPR DVN NIGHTLY JOB' was directed to
be set as a nightly job in Taskman.
We have been directed to remove this option from the option file as well as
four remaining routines (RMPRDVN, RMPRDVN1, RMPRDVN2 & RMPRDVN3) be deleted.
Since the option is being removed and may have been tasked at various sites,
we want to insure that this task is removed from Taskman in a pre-install run
prior to deleting the option during the install. The pre-install routine
(RMPRTDEL) will be deleted immediately after execution as part of the build.
This ICR is only valid for RMPR*3.0*180.
6400 HMP ACCESS TO FILE 101 File KERNEL 2016/04/07 APPROVED Retired Private 101
**NOTE: This ICR is for the Enterprise Health
Management Platform (HMP) only!
HMP Post Install Init Routine HMP0311P does a direct read of the B cross
reference to see if the HMP DGPF ASSIGN FLAG, DGPF ASSIGN FLAG exists in the
Protocol file. If the DGPF ASSIGN FLAG protocol exists, the routine edits the
protocol using FileMan to make the protocol an extended action protocol and to
add HMP DGPF ASSIGN FLAG protocol as an Item.
HMP Post Install Init routine HMP0311Q does a FileMan read of the Protocol
File to lookup to check for the HMP ADT-A04 CLIENT, VAFC ADT-A04 SERVER, HMP
ADT-A08 CLIENT and VAFC ADT-A08 SERVER protocols exist in the Protocol file.
If the protocols exist, the routine uses FileMan to subscribe the HMP protocol
to the VAFC protocol. HMP ADT-A04 Client is subscribed to VAFC ADT-A04 Server
protocol and HMP ADT-A08 Client is subscribed to the VAFC ADT-A08 Server
protocol.
**********************************************************************
This ICR was retired as of 10/27/17 when HMP was shut down. HMP*2.0*12
released on 10/17/17 is an informational patch outlining the steps for the
sites to shut down the application. If HMP is reactivated in the future, the
HMP project team should review the access provided by this ICR with the
custodial application before the ICR is reactivated. See VistA Document
Library (VDL) for list of retired HMP ICRs.
*********************************************************************
2016/04/12
6444 ADD THREE FIELDS TO INSTITUTION FILE#4 File KERNEL 2016/08/05 APPROVED Active Private 4
The VA FileMan team would like to add three (3) new
fields to the INSTITUTION file (#4). The new fields will be used to support
the determination of GMT and TimeZone offset based on a given Institution
Entry.
Descriptions:
-------------
4,800 LOCATION TIMEZONE 8;1 POINTER TO WORLD TIMEZONES FILE (#1.71)
LAST EDITED: AUG 10, 2016
HELP-PROMPT: Enter the timezone or '?' to list timezones
DESCRIPTION: This is the timeZone of this specific location.
4,801 COUNTRY 8;2 POINTER TO COUNTRY CODE FILE (#779.004 )
LAST EDITED: AUG 15, 2016
HELP-PROMPT: Enter the country, or '?' to list countries
DESCRIPTION: Country of this location.
4,802 TIMEZONE EXCEPTION 8;3 SET '0' FOR SST Only;
LAST EDITED: AUG 09, 2016
HELP-PROMPT: Enter 0 if this is for Standard Time only.
DESCRIPTION: This location does not follow the TimeZone and country
timeframe changes therefore only follows STANDARD time. Example: Some
locations in the USA do not follow the change to DAYLIGHT SAVINGS but remain
STANDARD all year long. Those locations would need this exception defined.
Puerto Rico's TimeZone is Atlantic which is also used by Canada, Dominican
Republic, and Bermuda. Canada and Bermuda change timeframes and Puerto Rico
and Dominican Republic do not. A location in Puerto Rico or Dominican
Republic would need to have the exception field set to SST only.
----------
The three fields will be sent out to the sites via the VA FILEMAN patch
DI*22.2*2. We will only send the three fields (partial), not the entire
Institution DD in KIDS. These fields will be maintained via the FORUM process.
2016/08/17
6491 PERSON CLASS file (#8932.1) maint. File KERNEL 2016/09/15 Pending Private 8932.1
As part of the VHA standardization of VistA files the
PERSON CLASS file (#8932.1) will be passed to the Standards & Terminology
Services Team (STS) for maintenance of data. This will happen with the
release of patch XU*8.0*671. This is for file data maintenance only. The
PERSON CLASS file (#8932.1) will remain within the KERNEL names/number space.
Lexicon Utility has all privileges as though it were the custodial package.
6529 INSTALL FILE ACCESS File KERNEL 2016/10/17 APPROVED Active Controlled Subscription 9.7
Above PAR and Advanced Prosthetics Acquisition Tool
request permission to read from the INSTALL FILE (#9.7) to display information
about the last install within the Administrator function.
2023/07/11
6593 READ ACCESS FOR SERVICE/SECTION FILE File KERNEL 2016/10/28 Pending Controlled Subscription 49
Above PAR and Advanced Prosthetics Acquisition Tool
request read access to the SERVICE/SECTION FILE #49 for use in retrieving the
Service Name and Mail Symbol when displaying a detailed purchase card order
and when providing a list of services.
Above PAR Ad-Hoc Reporting includes the SERVICE/SECTION FILE #49. Ad-Hoc
functionality provides the ability to select fields from the file for display
on user-defined reports. Ad-Hoc offers only FileMan read access and only if
the user has permission to view the file.
6599 PROTOCOL FILE ACCESS File KERNEL 2016/11/04 Withdrawn Private 101
The Advanced Prosthetics Acquisition Tool (APAT) requests access to find
the IEN associated with the HL7 server protocol in order to set up HL7
environment variables.
^ORD(101,D0,0)
.01 NAME 0;1 Fileman r
6682 Decode/Encode JSON Routine KERNEL 2016/12/13 APPROVED Active Supported
This is a utility for decoding and encoding JSON.
XLFJSON 2017/07/06
6695 XUS BSE TOKEN Remote Procedure KERNEL 2016/12/21 APPROVED Active Controlled Subscription
Provide Broker Security Enhancement (BSE) login string
for Station-number authentication into a remote (visited) VistA system using
credentials from a home (authenticating) VistA system.
XUS BSE TOKEN 2017/05/25
6723 DBIA 6723 File KERNEL 2017/01/23 APPROVED Active Private 4
Event Capture requests permission to delete and rebuild
the "LOC" cross-reference in the INSTITUTION file (#4).
Due to an issue resulting from changing the name of an entry in the
INSTITUTION file, the "LOC" cross-reference may no longer show the correct
facility name in the "LOC" cross-reference.
As a result, a direct kill of the cross-reference, using K ^DIC(4,"LOC") is
needed to completely delete the table as the KILL logic of the cross-reference
will not correctly remove incorrectly named entries.
After manually killing the cross-reference, a call to ENALL^DIK will be made
to rebuild the cross-reference using the most up-to-date facility names.
This request is for a one-time deletion and rebuild of the cross-reference in
the post-install process of patch EC*2.0*134.
2017/08/14
6747 PRCA READ/WRITE ACCESS W/FILEMAN TO LOCK FIELD (#3) File KERNEL 2017/03/15 APPROVED Active Private 19
PRCA requires the ability to delete a LOCK from an
OPTION for patch PRCA*4.5*318. This cannot be accomplished using KIDS.
Permission is required to accomplish this task using pre- or post-install
routines in KIDS.
2017/03/27
6765 DELETION OF DIC(S) VALUE FROM OPTION File KERNEL 2017/05/22 Pending Private 19
During installation by KIDS distribution of a patch
which updates an option's definition to delete a DIC(S) value, although the
value of other fields are overlaid with the incoming values, the existing
DIC(S) value is not nulled out when the incoming value is null. The
post-install routine must include logic like invoking FILE^DIE() to remove the
value from the Option (#19) file entry.
6766 ESSO VALIDATE FOR FILEMAN INTEGRATED WEB SERVICE Routine KERNEL 2017/05/22 Pending Supported
This API allows ESSO^XUESSO4 to be called from the
DIFSMAIN routine.
6775 HMP CHECK OF %ZTSCH GLOBAL File KERNEL 2017/06/26 Withdrawn Private
The Enterprise Health MGMT Platform (HMP) needs to make
a check to see if a task exists in the %ZTSCH global and if the task exist, if
it is still active. HMP does this by checking to see if a lock can be obtained
for the task in %ZTSCH, if the lock can be obtained then the job is not active
and the HMP EXTRACT RESOURCE slot that is in use by that task can be cleared.
6813 XUS GET TOKEN Remote Procedure KERNEL 2017/08/23 APPROVED Active Controlled Subscription
This RPC returns a handle to a token that can be used
instead of an Access/Verify code authentication to sign on a new process by a
user that is currently authenticated and active.
XUS GET TOKEN 2017/08/30
6825 CHANGE NAME OF OPTION IBCNR RELEASE OF INFORMATION File KERNEL 2017/10/18 APPROVED Active Private 19
eBusiness product owners wish to change the name of the
existing option IBCNR RELEASE OF INFORMATION to IBCNR ROI SENSITIVE DRUG MGMT
as part of patch IB*2.0*617. Permission is required to Accomplish this name
change using a pre-install routine. This agreement is one time only and
expires with the installation of IB*2.0*617.
2018/03/06
6826 SCHEDULE AN OPTION SILENTLY SET 'USER TO RUN TASK' FIELD File KERNEL 2017/10/18 APPROVED Active Private 19.2
The VistA Radiology/Nuclear Medicine (RIS) application
requests permission to schedule a RIS option with the 'USER TO RUN TASK' field
(#11) in the OPTION SCHEDULING (#19.2) file.
The Kernel option 'RESCH^XUTMOPT()' or 'Set Up Option Schedule' option does
not define an input parameter for the 'USER TO RUN TASK' field.
The RIS must guarantee that the user identified discontinuing orders in the
RAD/NUC MED ORDERS (#75.1) file is the same user recorded as discontinuing
that same order in the Computerized Patient Record System (CPRS) ORDER (#100)
file.
RAIPS135 2017/12/11
6869 ALERT CRITICAL TEXT LOOKUP AND EDIT File KERNEL 2018/01/24 APPROVED Active Controlled Subscription 8992.3
Kernel Alerts do not have any APIs that enable a package to edit its own
Alert Critical text. Therefore, for the purpose of adding/editing alert
critical text, permission is granted to:
1. Look up alert critical text using VA FileMan APIs, such as ^DIC or
$$FIND1^DIC.
2. Add/edit data in the ALERT CRITICAL TEXT (#8992.3) file using VA
FileMan APIs such as ^DIE, UPDATE^DIE or FILE^DIE.
NOTICE: Adding an entry with Critical Text will report any Alert
containing that text as critical. Careful analysis is necessary to
confirm changes will not cause malfunction of any VistA alerts. When
creating a new entry in the ALERT CRITICAL TEXT (#8992.3) file, it is
recommended the associated package be indicated in the CREATING PACKAGE
(#.03) field. Inquiries regarding the critical alert text can be
directed to the development team for the respective VistA application,
if a package development team exists for the application. Finally, the
description included in the ALERT CRITICAL TEXT (#8992.3) file
PACKAGE-ID (#.02) field VA FileMan Data Dictionary should be observed
to determine if it must be defined. That field's description indicates
that data in this field can further screen alerts from being reported
as critical. Its use should be understood when adding entries to the
ALERT CRITICAL TEXT (#8992.3) file.
2018/02/27
6880 XUS MVI NEW PERSON GET Remote Procedure KERNEL 2018/02/26 APPROVED Active Private
The Master Veteran Index (MVI) team requests permission
to use the following KERNEL Remote Procedure Call (RPC) [XUS MVI NEW PERSON
GET], which will search for and return an existing entry, if it exists, from
the NEW PERSON File (#200) to the MVI system. Use of this RPC will provide MVI
with an immediate path to move forward to view the Identity Access Management
(IAM) data in VistA to support 2 Factor Authentication (2FA) until future
technologies become available in the production VistA environments.
XUS MVI NEW PERSON GET 2018/03/28
6881 XUS MVI NEW PERSON UPDATE Remote Procedure KERNEL 2018/02/26 APPROVED Active Private
The Master Veteran Index (MVI) team requests permission
to use the following KERNEL Remote Procedure Call (RPC) [XUS MVI NEW PERSON
UPDATE], which will update select fields to correct issues for an existing
entry in the NEW PERSON File (#200) from the MVI system. Use of this RPC will
provide MVI with an immediate path to move forward to manage the Identity
Access Management (IAM) data in VistA to support 2 Factor Authentication (2FA)
until future technologies become available in the production VistA
environments.
XUS MVI NEW PERSON UPDATE 2018/03/28
6886 GMRC UPDATE TO THE PROTOCOL FILE File KERNEL 2018/03/05 Withdrawn Private 101
GMRC requests a one time update to the PROTOCOL FILE
(#101) to edit the GMRC EVSEND OR Protocol to add the GMRC CONSULTS TO HCP
Protocol as an Item.
6888 NPIUSED Routine KERNEL 2018/03/13 APPROVED Active Controlled Subscription XUSNPI1 2018/03/14
6889 NEW PERSON PHARMACY FIELDS File KERNEL 2018/03/14 APPROVED Active Private 200
In support of the Veterans Access, Choice, and
Accountability Act of 2014 (VACAA) and to address Patient Safety concerns for
non-VA providers whose affiliation is not currently available to CPRS,
Outpatient Pharmacy requests permission to populate via VA FileMan APIs the
following fields which are not currently populated by the $$VACAA^XUESSO4()
API that created the entries.
If the NEW PERSON (#200) file entries need to be backed out, the Non-VA
Provider Inactivate [PSO NON-VA PROVIDER INACTIVATE] option may be used. This
option will populate the DISUSER (#7) field with "YES". The INACTIVE DATE
(#53.4) and TERMINATION DATE (#9.2) fields will be populated with the previous
day's date so that the providers will be immediately inactive. The REMARKS
(#53.9) field will contain a comment that the entry was inactivated by this
option.
2018/04/23
6914 Lab References to Alert Tracking File File KERNEL 2018/05/09 APPROVED Active Private 8992.1
Lab will search the Alert Tracking file to determine if
an alert was sent for a Lab case after it was verified by a pathologist.
2018/05/14
6916 APAT READ/WRITE ACCESS TO NEW PERSON FILE File KERNEL 2018/05/15 APPROVED Active Private 200
This is a one-time request for the initial release of
DSSO 2.0.
The Advanced Prosthetics Acquisition Tool (APAT) must migrate from namespace
DSIVA to namespace DSSO. Because of this, the Primary and Secondary menu
options have been renamed.
The post-installation routine will search for users that have PRIMARY MENU
OPTION set to DSIVA APAT and will change the PRIMARY MENU OPTION to DSSO APAT.
Also, if a user has DSIVA APAT in the SECONDARY MENU OPTIONS multiple, then
DSSO APAT will be added to that multiple.
APAT requests permission to use FileMan API FIND^DIC with index AP to identify
those users with PRIMARY MENU OPTION set to DSIVA APAT. FileMan API FILE^DIE
will be used to change the PRIMARY MENU OPTION to DSSO APAT.
APAT requests permission to use FileMan API FIND^DIC with index AD to identify
those users with DSIVA APAT in the SECONDARY MENU OPTIONS multiple. FileMan
API FILE^DIE will be used to add DSSO APAT to the SECONDARY MENU OPTIONS
multiple.
In a future build, FileMan API FIND^DIC using index AD will be used to
identify all users with secondary menu option DSIVA APAT, and this secondary
menu option will be deleted from the SECONDARY MENU OPTIONS multiple of each
identified user using FileMan API FILE^DIE.
If back-out is needed, APAT requests permission to change the PRIMARY MENU
OPTION to DSIVA APAT if a user's PRIMARY MENU OPTION is DSSO APAT. This will
be accomplished in a similar manner using FileMan APIs FIND^DIC and FILE^DIE.
2018/05/31
6919 OPTION FILE ACCESS File KERNEL 2018/05/30 APPROVED Active Private 19
This is a one-time request for the initial release of
DSSO 2.0.
The Advanced Prosthetics Acquisition Tool (APAT) must migrate from namespace
DSIVA to namespace DSSO. Because of this, the post-installation routine must
verify the existence of both options "DSIVA APAT" and "DSSO APAT" in the
OPTION FILE (#19) when adding option "DSSO APAT" to users who currently have
the "DSIVA APAT" option as a PRIMARY MENU OPTION or SECONDARY MENU OPTIONS in
the NEW PERSON FILE (#200). To accomplish this, direct global reads through
the "B" cross-reference using $ORDER are used for each Option NAME.
2018/05/31
6937 VACAA NON-VA PROVIDER BULK LOAD Routine KERNEL 2018/06/29 Pending Private
Bulk-load non-VA entities and providers to be
identified in VistA when documenting patient care.
On August 7, 2014, the President signed into law PL 113-146, the Veterans
Access, Choice, and Accountability Act of 2014 (VACAA). The law offers an
additional authority for VHA to expand current capacity and ensure that
Veterans have timely access to high-quality care. The law creates a new
paradigm for providing health care, set forth in the Veterans Choice program
provisions within Title I Section 101 of VACAA. VA is utilizing a Contractor
to provide health care and third party administrative (TPA) services set forth
through VACAA Section 101. As a result of this law, VA must upload a list of
non-VA medical care providers into the VistA system in order to maintain an
accurate and updated list of non-VA providers in the Choice program.
XUSNPI
6945 LOOKUP USING B CROSS REFERENCE File KERNEL 2018/07/27 Pending Private 200
The Virtual Patient Record (VPR) application needs to
be able to return the Internal Entry Number (IEN) of a user to the consuming
applications (such as Joint Legacy Viewer). VPR has the user name, but not the
IEN. This ICR will grant them access to do a lookup on the 'B' cross
reference of the NEW PERSON (#200) file.
6956 Security Key Description File KERNEL 2018/08/15 Pending Private 19.1
The ORDER ENTRY/RESULTS REPORTING package requests read
access to the Description field of the Security Key file.
6961 XU EPCS ADD DEA Remote Procedure KERNEL 2018/09/12 Pending Controlled Subscription
This RPC is designed to work with the EPCS GUI
application for editing provider DEA information for pharmacy. It will accept
inputs of a IEN for the NEW PERSON FILE #200 and a "^" delimited line of text
to be recorded.
XU EPCS ADD DEA
6962 XU EPCS DEADOJ Remote Procedure KERNEL 2018/09/12 Pending Controlled Subscription
This RPC call, accepts a DEA Number as input. It calls
the DOJ/DEA Web Service to get the most recent information for the provider
which is returned to the calling program in a single string with "^" delimited
data. The values in the string are:
1 - PROVIDER NAME
2 - ADDRESS 1
3 - ADDRESS 2
4 - ADDRESS 3
5 - CITY
6 - STATE
7 - STATE POINTER
8 - ZIP CODE
9 - ACTIVITY CODE
10 - TYPE
11 - DEA NUMBER
12 - EXPIRATION DATE
13 - PROCESSED DATE
14 - DETOX NUMBER
15 - SCHDEULE II NARCOTIC
16 - SCHEDULE II NON-NARCOTIC
17 - SCHEDULE III NARCOTIC
18 - SCHEDULE III NON-NARCOTIC
19 - SCHEDULE IV
20 - SCHEDULE V
XU EPCS DEADOJ
6963 XU EPCS REMOVE DEA Remote Procedure KERNEL 2018/09/12 Pending Controlled Subscription
Functionality to remove a DEA multiple from file #200, Field 53.21
INPUT: NPIEN - NEW PERSON FILE #200 INTERNAL ENTRY NUMBER
DEATXT - PROPERLY FORMATTED DEA NUMBER
OUTPUT: RET - 1 for SUCCESS, 0 for UNSUCCESSFUL
XU EPCS REMOVE DEA
6964 XU EPCS DEA DUP CHECK Remote Procedure KERNEL 2018/09/12 Pending Controlled Subscription
This RPC will accept a DEA in text format, and an institutional suffix if
available. It will perform checking to determine if the DEA is being used by
another user.
XU EPCS DEA DUP CHECK
6966 XU EPCS MBM Remote Procedure KERNEL 2018/09/19 Pending Controlled Subscription
This RPC is provided to ePCS GUI to check if the site
is setup for Meds by Mail service.
XU EPCS MBM
6969 XUEPCSME Routine KERNEL 2018/09/19 Pending Controlled Subscription
The XUEPCSME routine provides functionality to retrieve
information from the DOJ/DEA web service and use a ListMan screen to enable
the Pharmacy to edit the information and link it to a provider in the NEW
PERSON FILE #200 and save the information to the DEA NUMBERS FILE #8991.9.
XUEPCSME
6970 XUEPCSUT Routine KERNEL 2018/09/19 Pending Controlled Subscription
An algorithm to validate that the DEA number is
formatted correctly.
XUEPCSUT
6971 XUEPCSED Routine KERNEL 2018/09/19 Pending Controlled Subscription
Returns a value in the RET variable indicating the
Meds-by-Mail System setting.
XUEPCSED
6977 XUS MVI NEW PERSON DATA Remote Procedure KERNEL 2018/10/10 APPROVED Active Private
The Master Veteran Index (MVI) team requests permission
to use the following KERNEL Remote Procedure Call (RPC) [XUS MVI NEW PERSON
DATA], which will allow the MVI system to retrieve the following '^' delimited
aggregated data for Active and/or Non-Active NEW PERSON file (#200) entries
from a 'specific' or 'all' active VistA site(s) if requested:
- Number of ALL Record types found
- Number of Non-Active Records
- Number of Active Records
- Number of Active Records containing a SECID
- Number of Active Records containing an Email
- Number of Active Records containing an Network Username
- Number of Visitor Records
XUS MVI NEW PERSON DATA 2018/10/11
6983 TEXT XU REM Routine KERNEL 2018/10/24 Pending Private
This is just for test.
7000 NEW DEA MULTIPLE File KERNEL 2018/12/04 APPROVED Active Private 200
Outpatient Pharmacy is granted permission to
enter/edit/delete the following fields.
Field # Node;Piece Field Name
53.21 PS4 NEW DEA #'S Multiple #200.5321 200.5321,.01
0;1 DEA NUMBER 200.5321,.02 0;2 INDIVIDUAL DEA
SUFFIX 200.5321,.03 0;3 DEA POINTER
2022/01/25
7001 DEA BUSINESS ACTIVITY CODES File KERNEL 2018/12/04 APPROVED Active Private 8991.8
Outpatient Pharmacy is granted permission to enter/edit the following
fields.
Field # Node;Piece Field Name
.01 0;1 FULL BUSINESS ACTIVITY CODE
.02 0;2 BUSINESS ACTIVITY
.03 0;3 BUSINESS ACTIVITY SUB-CODE
1 1;1 BUSINESS ACTIVITY DESCRIPTION
2022/01/25
7002 DEA NUMBERS FILE File KERNEL 2018/12/04 APPROVED Active Private 8991.9
Outpatient Pharmacy is granted permission to enter/edit/delete the
following fields.
Field # Node;Piece Field Name
.01 0;1 DEA NUMBER
.02 0;2 BUSINESS ACTIVITY CODE
.03 0;3 DETOX NUMBER
.04 0;4 EXPIRATION DATE
.06 0;6 USE FOR INPATIENT ORDERS?
.07 0;7 TYPE
1.1 1;1 NAME (PROVIDER OR INSTITUTION)
1.2 1;2 STREET ADDRESS 1
1.3 1;3 STREET ADDRESS 2
1.4 1;4 STREET ADDRESS 3
1.5 1;5 CITY
1.6 1;6 STATE
1.7 1;7 ZIP CODE
2.1 2;1 SCHEDULE II NARCOTIC?
2.2 2;2 SCHEDULE II NON-NARCOTIC?
2.3 2;3 SCHEDULE III NARCOTIC?
2.4 2;4 SCHEDULE III NON-NARCOTIC?
2.5 2;5 SCHEDULE IV?
2.6 2;6 SCHEDULE V?
10.1 10;1 LAST UPDATED BY
10.2 10;2 LAST UPDATED DATE/TIME
10.3 10;3 LAST DOJ UPDATE DATE/TIME
2022/01/24
7015 XUEPCS DATA FILE File KERNEL 2019/02/01 Pending Private 8991.6
Outpatient Pharmacy is granted permission to enter the
following fields.
Field # Node;Piece Field Name
.01 0;1 NAME
.02 0;2 EDITED BY
.03 0;3 FIELD EDITED
.04 0;4 ORIGINAL DATA
.05 0;5 EDITED DATA
.06 0;6 DATE/TIME EDITED
7016 XUEPCS PSDRPH AUDIT FILE File KERNEL 2019/02/01 APPROVED Active Private 8991.7
Outpatient Pharmacy is granted permission to enter the
following fields.
Field # Node;Piece Field Name
.01 0;1 NAME
.02 0;2 EDITED BY
.03 0;3 ALLOCATION STATUS
.04 0;4 DATE/TIME EDITED
Revision History -
10/16/24 The WebVRAM and Outpatient Pharmacy development teams are working
together on the release of the RPC and the WebVRAM GUI changes to invoke the
RPC. The Pharmacy patch is PSO*7*732 and the WEBG patch is WEBG*3*21. The ICR
that authorizes Pharmacy's reference to file 8991.7 is #7016. This RPC
performs the same function as the Allocate/De-Allocate of PSDRPH Key (Audited)
[PSO EPCS PSDRPH KEY]. WebVRAM's subscription is valid only as long as ICR
7492 is active.
2024/10/16
7054 WRITE ACCESS TO SUB-FILE 200.051 File KERNEL 2019/04/08 APPROVED Active Controlled Subscription 200.051
Outpatient Pharmacy is given permission by Kernel for
write access with Fileman to the KEY field (#.01) of the KEYS SUB-FILE
(#200.051).
2025/06/03
7062 XUS MVI ENRICH NEW PERSON Remote Procedure KERNEL 2019/05/01 APPROVED Active Private
In support of the Provider Profile Management System
(PPMS) / Provider Integration Engine (PIE) for Mission Act, the Master Veteran
Index (MVI) team requests permission to exclusively use the following
restricted KERNEL Remote Procedure Call (RPC) [XUS MVI ENRICH NEW PERSON],
which will allow MVI to either add a new National Provider type entry to the
NEW PERSON File (#200) or update select fields with enriched data for an
existing user entry, identified by their Nation Provider Identifier (NPI)
value, in the NEW PERSON File (#200) and associated DEA NUMBERS File (#8991.9)
from the MVI system. See the RPC for a complete list of fields to be updated.
XUS MVI ENRICH NEW PERSON 2019/05/14
7063 OE/RR Reference to Alert Tracking File (8992.1) File KERNEL 2019/05/06 APPROVED Active Private 8992.1
OE/RR utilizes the Alert Tracking File (#8992.1) to
obtain alert information for OR and TIU alerts for a specified date range
included with patch OR*3.0*500 Alert Enhancements.
Revision History:
Added 7/26/24: Effective with OR*3*561, the following 2 global references were
added:
^XTV(8992.1,D0,20,D1,3)
3 SURROGATE FOR 3;0 Direct Global Read & w/Fileman
^XTV(8992.1,D0,20,'B')
.01 RECIPIENT 0;1 Direct Global Read & w/Fileman
2019/05/06
7078 RA TAKE AWAY ALL ACCESS TO A (RIS) FILE Routine KERNEL 2019/05/16 APPROVED Active Private
VistA Radiology requests the privilege to use the
XUFILE1 routine to take away all access from all users to the RAD/NUC MED
REASON [#75.2] file. This is a one-time request and will be included in the
routine: RAIPS160.
RAIPS160 will be a post-install routine released as a component of RA*5.0*160.
XUFILE1 2019/05/31
7085 XUS MVI NEW PERSON BULK GET Remote Procedure KERNEL 2019/06/26 APPROVED Active Private
In support of the Electronic Health Record
Modernization (EHRM), the Master Veteran Index (MVI) team requests permission
to exclusively use the following restricted KERNEL Remote Procedure Call (RPC)
[XUS MVI NEW PERSON BULK GET], to allow retrieval of 'Active' NEW PERSON file
(#200) data in bulk (large chunks) transfers from each VistA site to the MVI.
When all 'Active' NEW PERSON file (#200) data has been retrieved for a site,
MVI will export the results to a flat text file where it will then be imported
by the Person Service Identity Management (PSIM) system so that it can be
further evaluated.
XUS MVI NEW PERSON BULK GET 2019/08/02
7100 XU REBUILD MENU TREE Remote Procedure KERNEL 2019/09/13 APPROVED Active Private
The WebVRAM package needs access to the XU REBUILD MENU
TREE RPC. This RPC will be used to rebuild the menu tree for the WebVRAM
visitor added to a VistA facility.
"Kernel understands this ICR was created to track which application is using
the Kernel resource. The WebVRAM team has been working with IAM and the
Kernel team for future official alternatives."
XU REBUILD MENU TREE 2019/09/20
7102 XUS GET CCOW TOKEN Remote Procedure KERNEL 2019/09/16 APPROVED Active Private
The WebVRAM package needs to access the XUS GET CCOW
TOKEN RPC to get a CCOW token.
"Kernel understands this ICR was created to track which application is using
the Kernel resource. The WebVRAM team has been working with IAM and the
Kernel team for future official alternatives."
XUS GET CCOW TOKEN 2019/09/20
7103 XUS CCOW VAULT PARAM Remote Procedure KERNEL 2019/09/16 APPROVED Active Private
The WebVRAM package need to access the XUS CCOW VAULT
PARAM RPC to get the CCOW vault parameters.
"Kernel understands this ICR was created to track which application is using
the Kernel resource. The WebVRAM team has been working with IAM and the
Kernel team for future official alternatives."
XUS CCOW VAULT PARAM 2019/09/20
7122 XUJFST1 Routine KERNEL 2019/12/20 Active Controlled Subscription
This Integration Control Registration describes
Controlled Subscription use of Application Program Interfaces to access data
in Kernel files.
XUJFST1
7138 DIRECT READ OF ERROR LOG FILE File KERNEL 2020/03/10 APPROVED Active Private 3.075
This ICR provides the ability to directly read the
ERROR LOG file and its sub-files.
2020/03/19
7139 DIRECT READ OF ERROR TRAP SUMMARY FILE File KERNEL 2020/03/10 APPROVED Active Private 3.077
This ICR provides the ability to directly read from the
ERROR TRAP SUMMARY file.
2020/03/19
7143 ADUPN File KERNEL 2020/03/19 APPROVED Active Private 200
The CPRS (ORDER ENTRY/RESULTS REPORTING) team requests
read access to the ADUPN field in the New Person (#200) file. The ADUPN field
(which stores the users' va.gov email address) will be used in the query to
identify the user initiating the query.
2020/03/20
7177 PENDING NEW PERSON FIELD UPDATES File KERNEL 2020/06/01 APPROVED Active Private 8933.1
The CLINICAL INFO RESOURCE NETWORK (CIRN) package has a
monitoring process in routine RGMTMONT that examines/displays the number of
messages received, messages processed, messages needing transmission, messages
transmitted and the current state of the CIRN links, as well as showing the
number of incoming and outgoing filers running. CIRN will augment this monitor
processing to also include information on the pending NEW PERSON (#200) field
updates by looping through and counting the number of pending entries stored
in the "ACXMIT" X-REF in the NEW PERSON FIELD MONITOR (#8933.1) file that need
to be transmitted at the time the monitoring process is executed.
NOTE: "ACXMIT" X-REF entries in file #8933.1 are deleted upon
successful transmission of the NEW PERSON (#200) field
updates to the Person Service Identity Management (PSIM)
system.
As another aspect of the 'Monitoring' process, CIRN has incorporated a process
to count the number of outdated and no longer needed NEW PERSON FIELD MONITOR
(#8933.1) records that will be purged from the file. This process requires
access to the "B" X-REF on the NEW PERSON FIELD MONITOR (#8933.1) file and the
USER (#.02) field, which allows CIRN to ensure there are no pending
transmissions ("ACXMIT" X-REF check) for that User prior to including in the
'Purge' count.
Therefore CIRN requests 'Direct Global Read & w/Fileman' for the entire NEW
PERSON FIELD MONITOR (#8933.1) file to aid in this monitoring process.
2020/06/17
7183 NEW PERSON FIELD MONITOR PURGE File KERNEL 2020/06/25 APPROVED Active Private 8989.3
The CLINICAL INFO RESOURCE NETWORK (CIRN) package has a
monitoring process on the NEW PERSON FIELD MONITOR (#8933.1) file to ensure
that NEW PERSON (#200) updates are being transmitted to the Person Service
Identity Management (PSIM) system as part of the Enterprise User Identity
functionality. As part of this monitoring process, CIRN will need to retrieve
the NEW PERSON FIELD MONITOR PURGE (#875) value from the KERNEL SYSTEM
PARAMETERS (#8989.3) file to determine if the NEW PERSON FIELD MONITOR
(#8933.1) record has exceeded the timeframe so that it can be purged/deleted
from the file. This will ensure that the NEW PERSON FIELD MONITOR (#8933.1)
file is maintained at an acceptable size level.
2020/09/17
7184 RPA NEW PERSON USER ADD File KERNEL 2020/07/10 Pending Private 200
IB Revenue Operations requires the creation of VistA
user accounts nationally for bot software access to selected IB options for
automating certain repetitive tasks. These accounts will be created in the NEW
PERSON file (#200) by Integrated Billing patch IB*2*680 using Supported VA
FileMan database server APIs.
7209 AMPL USER IDENTIFICATION File KERNEL 2020/10/26 Pending Private 200
The Advanced Medication Platform (AMPL) application
requests access the internal entry number of all entries of the NEW PERSON
File (#200) to use in supported API calls.
7244 XUS MVI NEW PERSON RMTE AUDIT Remote Procedure KERNEL 2021/04/08 APPROVED Active Private
In support of the ongoing work of implementing
Enterprise User Identity, the Master Veteran Index (MVI) team requests
permission to exclusively use the following restricted KERNEL Remote Procedure
Call (RPC) [XUS MVI NEW PERSON RMTE AUDIT] to allow retrieval of the audit
history for a specific user's record in the NEW PERSON (#200) file at the
specified facility for viewing. This retrieved audit information will be used
to assist in troubleshooting issues with a user's account and for determining
how/when and ultimately why the record was changed if needed. This restricted
RPC is to be used exclusively by the Master Veteran Index (MVI) to
review/display the requested audit history of a user's record in the NEW
PERSON (#200) file at a specific facility.
TAG: AUDIT ROUTINE: XURNPAUD
Parameters:
PARAM("SourceSystemID") [Required] - Facility Station Number
PARAM("SourceID") [Required] - Individual's DUZ
PARAM("BegDate") [Optional] - Earliest date of Audit records
to return
PARAM("EndDate") [Optional] - Last date of Audit records to
return
XUS MVI NEW PERSON RMTE AUDIT 2021/04/09
7250 CPRS GUI (OR) SIGN-ON LOG LOOKUP File KERNEL 2021/05/03 Pending Private 3.081
The CPRS GUI requests the ability to do a lookup on the
SIGN-ON LOG for a current user's SIGN-ON LOG IEN and Field #3 (SIGNOFF TIME).
To lookup the current SIGN-ON LOG for the user's active CPRS session using the
following screen based on the user's UCI, Job#, & IP Address:
S SCR="I $P(^(0),U,8)=UCI,$P(^(0),U,3)=$J,$P(^(0),U,11)=$G(IO(""IP""))" with
$$FIND1^DIC("3.081","","Q",DUZ,"CUR",SCR,"ERR").
To lookup the SIGNOFF TIME (Field #3) for a given session:
$$GET1^DIQ("3.081",<IEN>,3,"I")
7310 Proxy user for Scheduling/Telehealth Routine KERNEL 2021/10/20 Pending Controlled Subscription 200
The Scheduling/Telehealth Product Line can establish a
proxy user "VSE,ACHERON". The user will be used by Telehealth Schedulers. The
user will not have access or verify code.
XUSAP
7361 MHV VistA Service account using SSOi SAML token Other KERNEL 2022/11/02 APPROVED Active Private
This ICR is to document the agreement for MHV to use a
VistA Service account (NPE - Non Person Entity) using SSOi SAML token until
MHV can transition to the SSOe implementation in VistA.
Background MHV needs to migrate from VIA to VDIF, due to VIA being
decommissioned in fall 2022.
The VistA Infrastructure Shared Services (VISS) team, MHV package, and VistA
Office Review Board have established steps to accomplish the migration:
1) Migrate MHV from VIA to VDIF: The goal is to safely tranition from VIA to
VDIF in a timely manner. To accomplish ths, MHV will temporarily use a VistA
Service account (NPE) using a SSOi SAML token.
2) VISS Implement VisA SSOe: The VISS team will enhance the SSOe
implementation in VistA to support secure patient login.
3)MHV Activates the SSOe: MHV Team will switch from the temporary VistA
service account to the SSOe implementation in VistA.
4) VISS Deactivates the temporary VistA service account.
2022/12/01
7397 CPRS UPDATE MENU TEXT File KERNEL 2022/12/20 APPROVED Active Private 19
The Computerized Patient Record System (CPRS)
application needs to be able to update the server version number information
during patch post installation. There are times when CPRS prefers to not
export the entire menu option but rather to only update the version number.
The purpose of this ICR is to grant CPRS the ability to use FileMan to update
that version number.
2022/12/20
7420 EPCS BROKER MENU UPDATE File KERNEL 2023/04/07 APPROVED Active Private 200
This is a onetime agreement via patch PSO*7.0*545.
This is for PSO*7*545 only, and will expire when it is released.
Post install processing looks for users that have a secondary menu option
of XU EPCS EDIT DATA (legacy ePCS GUI broker menu) and changes it to
PSO EPCS GUI CONTEXT (ePCS GUI 2.0 broker menu).
Outpatient Pharmacy requests read access to the NEW PERSON (#200) file to
search for the option XU EPCS EDIT DATA in the SECONDARY MENU OPTIONS
(#200.03) multiple using $$LKOPT^XPDMENU. If the secondary menu XU EPCS
EDIT DATA is found in the user's secondary menus, a call is made to
$$ACCESS^XQCHK to determine the user's status. If the user is active,
then we request write access to change the XU EPCS EDIT DATA secondary
menu to PSO EPCS GUI CONTEXT using FileMan API FILE^DIE.
2023/04/18
7423 Add NPE user to NEW PERSON (#200) file File KERNEL 2023/04/13 APPROVED Active Private 200
This ICR allows VDIF to create new non-person entity
(NPE) entries in the NEW PERSON file.
2023/04/24
7430 LIFETIME OF A VERIFY CODE File KERNEL 2023/07/25 APPROVED Active Private 8989.3
The WebVRAM team would like FileMan read access to the
LIFETIME OF VERIFY CODE (#214) field of the KERNEL SITE PARAMETERS (#8989.3)
file to be used in conjunction with the DATE VERIFY CODE LAST CHANGED (#11.2)
field of the NEW PERSON (#200) file to determine the correct date for when a
WebVRAM user's VERIFY CODE is set to expire at their home VistA account.
A new RPC will be released in WEBG*3.0*14 to implement this functionality.
2023/08/10
7474 NPI AND EFFECTIVE DATE/TIME File KERNEL 2024/06/03 APPROVED Active Controlled Subscription 200
The IAM group agrees to conditional approval of this
ICR request. The condition is that WebVRAM commits in the future to further
integration with IAM APIs to perform create and update of the remote sites NEW
PERSON (#200) file record.
Approval granted pending use of IAM APIs in the future: WebVRAM is requesting
an ICR to modify the contents of VistA file #200.042 and field #41.99 from
file #200 with FileMan.
WebVRAM is a TELEHEALTH application that assists its users with accessing
VistA areas outside of the main VistA area the user is associated with.
WebVRAM copies user profile information from the user's Home VistA area to the
Remote VistA area they are attempting to access. A WebVRAM user may only use
the application to access VistA areas they have been assigned to by their
business unit.
The WebVRAM product team was approached by the Pharmacists group in Tennessee
about the need to use the PDMP Query in CPRS to maintain reporting compliance
for controlled substances. In order to use the PDMP Query in CPRS the
pharmacist / provider is required to have a combination of a valid NPI, NPI
effective date, and person class. WebVRAM currently has the ability to
update the person class at the remote VistA area and would need to update
field #41.99 from file #200 and file #200.042 to provide the effective date
for the NPI. WebVRAM would use the DDR FILER RPC to modify the file contents.
2024/07/11
7486 XUS ESSO VALIDATE JWT Remote Procedure KERNEL 2024/08/12 Pending Private
This API/RPC uses either VA Identity and Access
Management (IAM) or Microsoft EntraID JSON Web Token (JWT) payload attributes
to authenticate a user. The type of JSON Web Token (JWT) must be a
"transparent" token, meaning it must contain a readable header, payload, and
signature. This API/RPC will validate the contents and signature of the JSON
Web Token (JWT). In addition, the issuer within the JWT payload must match an
issuer in the TOKEN VALIDATION DATA (#8981) file on the VistA system which
contains valid Identity Providers (IdPs) that are authorized to issue JSON Web
Tokens (JWTs).
XUS ESSO VALIDATE JWT
7487 INVOKE DUZ-XUP Non-HL7 Routine KERNEL 2024/08/19 APPROVED Active Private
Temporary solution for Scheduling application, as there
exists a gap in the RPC Broker and VistALink that cannot meet Scheduling
needs. A POAM has been created to track this risk.
RISK: The risk being that Kernel is not part of the validation of user
credentials when changing the identity of the user when invoking DUZ-XUP.
GAP: The gap is the need for Scheduling to share a single connection session,
initially owned by an approved IAM Service account (non-person, Remote
Application), with different Scheduling users (persons), by being able to
change both the user and the Broker context.
XUP 2025/03/19
7511 IAM AUTHORIZED REMOTE APPLICATION INTERFACE Remote Procedure KERNEL 2025/01/16 Pending Private
This ICR supports control and security for remote
applications accessing VistA systems, ensuring that they are approved and
authorized by the VistA Review Board and managed by Identity and Access
Management (IAM) Service.
7550 XUVSM APIs Routine KERNEL 2025/04/28 APPROVED Active Private
The purpose of this Routine is to provide read-only
APIs returning KERNEL operational states.
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.
XUVSM 2025/04/29
7552 Error Trap Summary File KERNEL 2025/04/28 APPROVED Active Private 3.077
The purpose of this ICR is to provide error trap
summary information to the VistA System Monitor. This data will be stored
centrally and be available via Dashboards and by specific request to those
monitoring and managing VistA sites.
Functionality within the VistA System Monitor consuming this data will be
released in patch KMP*4.0*5.
2025/04/29
7573 USER Starting Task File KERNEL 2025/07/21 Active Private 14.4
7574 Kernel - Add Digital Signature Validation APIs Routine KERNEL 2025/07/23 Active Supported
These Kernel APIs validate XML digital signatures.
XUDSIGVALIDATE
10038 HOLIDAY FILE File KERNEL 1994/10/28 APPROVED Active Supported 40.5
10044 XUS Routine KERNEL APPROVED Active Supported XUS
10045 XUSHSHP Routine KERNEL APPROVED Active Supported XUSHSHP
10046 XUWORKDY Routine KERNEL 2018/04/05 APPROVED Active Supported
Several extrinsic functions for workdays. To use any
of the XUWORKDY extrinsic functions, you must make sure that the HOLIDAY file
(#40.5) is populated with each year's holidays. This file is distributed
without data. Only enter holidays that fall on weekdays.
XUWORKDY
10047 USER FILE File KERNEL APPROVED Active Supported 3
10048 PACKAGE FILE File KERNEL 1994/10/24 APPROVED Active Supported 9.4
10049 PERSON FILE File KERNEL Retired Supported 16
10050 XUSESIG Routine KERNEL APPROVED Active Supported XUSESIG
10051 XUVERIFY Routine KERNEL 2003/07/29 APPROVED Active Supported
Utilities to check access and verify codes.
XUVERIFY
10052 XUSCLEAN Routine KERNEL 2011/02/08 APPROVED Active Supported XUSCLEAN
10053 XUSERNEW Routine KERNEL APPROVED Active Supported XUSERNEW
10056 STATE FILE File KERNEL APPROVED Active Supported 5
10060 NEW PERSON FILE File KERNEL 2020/11/09 APPROVED Active Supported 200
Allows Read access to the NEW PERSON file (#200).
Access is only given to those fields by Kernel. The following range of fields
are owned by other packages and can only be accessed by that package:
Fields 12-12.9 for HL7 Nodes/X-ref 12
Fields 41.97-42 for NPI Nodes/X-ref 'NPI*'
Fields 53-59.9 for Pharmacy Nodes/X-ref 'PS*', 'TPB'
Fields 70-79.9 for Radiology Nodes/X-ref 'RA*'
Fields 100-101.9 for Order Entry Nodes/X-ref 'ORD*', 101
Fields 125-125.9 for Problem List Nodes/X-ref 125
Fields 400-450.9 for IFCAP Nodes/X-ref 400, 450
Fields 500-500.9 for Mailman Nodes/X-ref 'XM*', 'AXM*', 500
Fields 654-654.9 for Social Work Nodes/X-ref 'SW*', 654
Fields 720-725 for DSSM Nodes/X-ref 'EC*', 'AEC*'
Fields 740-749.9 for QA Nodes/X-ref 'QA*'
Fields 910-910.9.9 for Police Nodes/X-ref 'ESP'
10063 %ZTLOAD Routine KERNEL 1998/04/20 APPROVED Active Supported
This routine provides several API's into a task.
%ZTLOAD 2009/07/08
10074 XQH Routine KERNEL APPROVED Active Supported XQH
10075 OPTION FILE File KERNEL 2011/03/01 APPROVED Active Supported 19 2011/03/01
10076 XUSEC GLOBAL File KERNEL 1994/12/08 APPROVED Active Supported 200
10077 XQ92 Routine KERNEL APPROVED Active Supported XQ92
10078 XQCHK Routine KERNEL 1999/02/03 APPROVED Active Supported XQCHK
10079 XQDATE Routine KERNEL APPROVED Active Supported XQDATE
10080 XQH4 Routine KERNEL APPROVED Active Supported XQH4
10081 XQALERT Routine KERNEL 1999/12/08 APPROVED Active Supported XQALERT
10086 %ZIS Routine KERNEL APPROVED Active Supported %ZIS
10087 %ZIS9 Routine KERNEL Retired Supported %ZIS9
10088 %ZISS Routine KERNEL APPROVED Active Supported %ZISS
10089 %ZISC Routine KERNEL APPROVED Active Supported %ZISC
10090 INSTITUTION FILE File KERNEL 1994/10/24 APPROVED Active Supported 4
10093 SERVICE/SECTION FILE File KERNEL APPROVED Active Supported 49
10096 Z OPERATING SYSTEM FILE File KERNEL APPROVED Active Supported
All nodes exported by Kernel are useable.
10097 %ZOSV Routine KERNEL 1999/06/29 APPROVED Active Supported
This routine is OS specific, and provides a interface
to OS functions.
%ZOSV
10101 XQOR Routine KERNEL 1994/03/07 APPROVED Active Supported XQOR
10102 XQORM1 Routine KERNEL 1994/03/07 APPROVED Active Supported XQORM1
10103 XLFDT Routine KERNEL 2000/11/27 APPROVED Active Supported
Several date/time API's.
XLFDT
10104 XLFSTR Routine KERNEL 2001/07/30 APPROVED Active Supported XLFSTR
10105 XLFMTH Routine KERNEL APPROVED Active Supported XLFMTH
10114 DEVICE FILE File KERNEL 2020/08/04 Under Revision Supported 3.5
10140 XQORM Routine KERNEL 1994/03/07 APPROVED Active Supported XQORM
10141 XPDUTL Routine KERNEL 1994/04/11 APPROVED Active Supported
The routine XPDUTL contains multiple calls to support
the Kernel Installation and Distribution System. All of the calls can only be
used in the context of the KIDS software, during the installation of software,
unless noted differently in the describitions that follow.
The following calls can be used anywhere during the install process:
$$VERSION(X) ;X=package name or package namespace
;Returns the current Version number
** This call can be used outside of KIDs **
$$VER(X) ;X=Build name from Build file or Install file
;Returns version number
$$PKG(X) ;X=Build name from Build file or Install file
;Returns package name
$$PATCH(X) ;X=Patch from Install file, (aaaa*nn.nn*nnn)
;Return 1 if patch X was installed, 0 if not installed
** This call can be used outside of KIDs **
$$LAST(X,Y,Z) ;X=Package name or namespace, Y=Version (optional, current if
not supplied), Z=1 released patch (optional, last released patch)
;Returns Last Patch and Date applied to a package
;PATCH will include Seq # if a released patch is last
;PATCH #^DATE, ("nnn^yyymmdd" or "nnn Seq #nn^yyymmdd")
;-1 will be returned if either Package or Version do not exist
; or No patches have been applied
** This call can be used outside of KIDs **
$$INSTALDT(X,.Y) ;X=Name from Install file, variable passed by reference
;Returns all installs for X in Install file
;Return array in Y, Y=number of records in array
;Y(internal date/time) = TEST # ^ SEQ #
** This call can be used outside of KIDs **
The following function can only be used in the Environment Check Routine
$$RTNUP(X,Y) ;X=routine name, Y= 1-delete, 2-skip
;changes the install action of a routine to delete or skip
;Returns 1 if successfull, 0 for failure
The following calls can be used during the Pre-Install or Post-Install
routines: $$PRODE(XPDN,XPD) ;XPDN=protocol name, XPD=1-enable, 0-disable
;enable/disable protocols
;Returns 1 if successfull, 0 for failure
$$OPTDE(XPDN,XPD) ;XPDN=option name, XPD=1-enable, 0-disable
;enable/disable options
;Returns 1 if successfull, 0 for failure
MES(X) ;X=message or an array passed by reference
;write message to Install file
BMES(X) ;X=message or an array passed by reference
;add blank line before writing message to Install file
$$NEWCP(XPD,XPDC,XPDP) ;XPD=check point name, XPDC=call back, XPDP=parameters
;create new check point
;Returns ien of check point, 0 for error
$$UPCP(XPD,XPDP) ;XPD=check point name or ien, XPDP=parameters
;update check point
;Returns ien of check point, 0 for error
$$COMCP(XPD) ;XPD=check point name or ien
;complete check point
;Returns date/time of completion, 0 for error
$$VERCP(XPD) ;XPD=check point name or ien
;verify check point, returns 1=completed, 0=not
;Returns 1 for completed, 0 for not completed, -1 for doesn't exist
$$PARCP(XPD,XPDF) ;XPD=check point name or ien, XPDF="PRE" if you want a
;Pre-Install check point while your in the Post-Install routine
;Returns parameters of check point
$$CURCP(XPDF) ;XPDF flag - 0=externel, 1=internal
;Returns current check point
XPDUTL 2013/05/23
10156 OPTION FILE File KERNEL 2006/05/31 APPROVED Active Supported 19
Exporting, deleting, updating Options by Namespace via
KIDS is permitted. Linking menu options from other packages requires IAs
between the packages whose options are being "linked".