Kernel Home Page
Toolkit Home Page
APIs Introduction
List APIs By:
Category
(default)
Routine Name
Tag Name
Reference Type
Tag Names (Entry Pt.)
$$ABS^XLFMTH
Absolute Value
$$ACCESS^XQCHK
User Option Access Test
$$ACOS^XLFMTH
Arc-cosine (Radians)
$$ACOSDEG^XLFMTH
Arc-cosine (Degrees)
$$ACOSH^XLFHYPER
Hyperbolic Arc-cosine
$$ACOT^XLFMTH
Arc-cotangent (Radians)
$$ACOTDEG^XLFMTH
Arc-cotangent (Degrees)
$$ACOTH^XLFHYPER
Hyperbolic Arc-cotangent
$$ACSC^XLFMTH
Arc-cosecant (Radians)
$$ACSCDEG^XLFMTH
Arc-cosecant (Degrees)
$$ACSCH^XLFHYPER
Hyperbolic Arc-cosecant
ACTION^XQALERT
Process an Alert
ACTION^XQH4
Print Help Frame Tree
$$ACTIVE^XUAF4
Inst. Active Facility (True/False)
$$ACTIVE^XUSER
Status Indicator
$$ACTJ^%ZOSV
Number of Active Jobs
$$ADD^XPDMENU
Add Option to Menu
$$ADD^XUSERNEW
Add New User
$$ADDRESS^XLFNSLK
Conversion (Domain Name to IP Addresses)
AHISTORY^XQALBUTL
Get Alert Tracking File Info.
ALERTDAT^XQALBUTL
Get Alert Tracking File Info.
$$ASEC^XLFMTH
Arc-secant (Radians)
$$ASECDEG^XLFMTH
Arc-secant (Degrees)
$$ASECH^XLFHYPER
Hyperbolic Arc-secant
$$ASIN^XLFMTH
Arc-sine (Radians)
$$ASINDEG^XLFMTH
Arc-sine (Degrees)
$$ASINH^XLFHYPER
Hyperbolic Arc-sine
$$ASKSTOP^%ZTLOAD
Stop TaskMan Task
$$ATAN^XLFMTH
Arc-tangent (Radians)
$$ATANDEG^XLFMTH
Arc-tangent (Degrees)
$$ATANH^XLFHYPER
Hyperbolic Arc-tangent
$$ATTRIB^MXMLDOM
Get Attribute Name
AVHLPTXT^XUS2
Get Help Text
$$AVJ^%ZOSV
Number of Available Jobs
$$BASE^XLFUTL
Convert Between Two Bases
$$BLDNAME^XLFNAME
Build Name from Component Parts
BMES^XPDUTL
Output Message with Blank Line
$$BSA^XLFMSMT
Body Surface Area
CALL^%ZISTCP
Make TCP/IP Connection (Remote)
$$CCD^XLFUTL
Append Check Digit
CCODE^XIPUTIL
FIPS Code Data
CDSYS^XUAF4
Coding System Name
$$CHECKAV^XUSRB
Check Access/Verify Codes
$$CHECKAV^XUVERIFY
Check Access/Verify Codes
CHGA^XGF
Screen Change Attributes
$$CHILD^MXMLDOM
Get Child Node
CHILDREN^XUAF4
List of Child Inst. for a Parent
$$CHKDGT^XUSNPI
Validate NPI Format
$$CHKSUM^XUSESIG1
Build Checksum for Global Root
$$CIRN^XUAF4
CIRN-enabled Field Value
$$CJ^XLFSTR
Center Justify String
CLEAN^XGF
Screen/Keyboard Exit and Cleanup
$$CLEANC^XLFNAME
Name Component Std. Routine
CLEAR^XGF
Screen Clear Region
CLOSE^%ZISH
Close Host File
CLOSE^%ZISTCP
Close TCP/IP Connection (Remote)
CLOSE^%ZISUTL
Close Device with Handle
$$CMNT^MXMLDOM
Extract Comment Text (True/False)
CMNT^MXMLDOM
Extract Comment Text (True/False)
$$CMP^XUSESIG1
Compare Checksum to $Name_Value
$$CNV^XLFUTL
Convert Base 10 to Another Base
$$CODE2TXT^XUA4A72
Get HCFA Text
$$COMCP^XPDUTL
Complete Checkpoint
$$COS^XLFMTH
Cosine (Radians)
$$COSDEG^XLFMTH
Cosine (Degrees)
$$COSH^XLFHYPER
Hyperbolic Cosine
$$COT^XLFMTH
Cotangent (Radians)
$$COTDEG^XLFMTH
Cotangent (Degrees)
$$COTH^XLFHYPER
Hyperbolic Cotangent
$$CRC16^XLFCRC
Cyclic Redundancy Code 16
$$CRC32^XLFCRC
Cyclic Redundancy Code 32
$$CREATE^XUSAP
Create Application Proxy User
$$CSC^XLFMTH
Cosecant (Radians)
$$CSCDEG^XLFMTH
Cosecant (Degrees)
$$CSCH^XLFHYPER
Hyperbolic Cosecant
$$CURCP^XPDUTL
Get Current Checkpoint Name/IEN
$$CURRSURO^XQALSURO
Get Current Surrogate for Alerts
CVC^XUSRB
VistALink-Change User's Verify Code
$$DE^XUSESIG1
Decode String
DE^XUSHSHP
Decrypt Data String
$$DEA^XUSER
Get DEA Number
$$DEC^XLFUTL
Convert Another Base to Base 10
$$DECDMS^XLFMTH
Conv. Decimals to Degrees:Minutes:Seconds
$$DECRYP^XUSRB1
Decrypt String
$$DEFDIR^%ZISH
Get Default Host File Directory
$$DEGRAD^XLFMTH
$$DEL^%ZISH
Delete Host File
DEL^XPDKEY
Delete Security Key
DELCOMP^XLFNAME2
Delete Name Components Entry
DELETE^MXMLDOM
Delete Document Instance
DELETE^XPDMENU
Delete Menu Item
DELETE^XQALERT
Clear Obsolete Alerts (Single)
DELETEA^XQALERT
Clear Obsolete Alerts (All)
DELSTAT^XQALBUTL
Get User Info./Status for Recent Alert
$$DEV^XUTMDEVQ
Force Queueing—No Device Selection
DEVICE^XUDHGUI
GUI Device Lookup
DESC^%ZTLOAD
Find Tasks with a Description
DISP^XQORM1
Display Menu Selections From Help Code
DISP^XUTMOPT
Display Option Schedule
DIV4^XUSER
Get User Divisions
DIVGET^XUSRB2
Get Divisions for Current User
DIVSET^XUSRB2
Set Division for Current User
$$DMSDEC^XLFMTH
Conv. Degrees:Minutes:Seconds to Decimal
DOLRO^%ZOSV
Display Local Variables
$$DOW^XLFDT
Day of Week
DQ^%ZTLOAD
Unschedule a Task
DSD^ZISPL
Delete Spool Data File Entry
DSDOC^ZISPL
Delete Spool Document File Entry
$$DT^XLFDT
Current Date (FM Date Format)
$$DTIME^XUP
Reset DTIME for USER
$$DTR^XLFMTH
Convert Degrees to Radians
$$E^XLFMTH
e—Natural Logarithm
$$EC^%ZOSV
Get Error Code
EDIT^XUTMOPT
Edit an Option's Scheduling
$$EN^MXMLDOM
Initial Processing, Build In-memory Image
EN^MXMLPRSE
Event Driven API
EN^XPDIJ
Task Off KIDS Install
EN^XQH
Display Help Frames
EN^XQOR
Navigating Protocols
EN^XQORM
Menu Item Display and Selection
$$EN^XUA4A71
Convert String to Soundex
$$EN^XUSESIG1
Encode ESBLOCK
EN^XUSHSHP
Encrypt Data String
EN^XUTMDEVQ
Run a Task (Directly or Queued)
EN^XUTMTP
Display HL7 Task Info.
EN1^XUPSQRY
Query New Person File
EN1^XQH
Display Help Frames
EN1^XQOR
Navigating Protocols
(Entry/Exit Actions Not Executed)
$$ENCRYP^XUSRB1
Encrypt String
ENDR^%ZISS
Set Up Specific Screen Handling Variables
ENS^%ZISS
Set Up Screen Handling Variables
$$ESBLOCK^XUSESIG1
E-Sig Fields Required for Hash
EXIT^XPDID
Restore Screen, Clean Up Variables, & Disp. Text
$$EXP^XLFMTH
e—Natural Logarithm to the Nth Power
F4^XUAF4
Inst. Data for a Station Number
$$FIPS^XIPUTIL
FIPS Code for ZIP Code
$$FIPSCHK^XIPUTIL
Check for FIPS Code
$$FMADD^XLFDT
VA FileMan Date Add
$$FMDIFF^XLFDT
VA FileMan Date Difference
$$FMNAME^XLFNAME
Conv. HL7 Formatted Name to Name
$$FMTE^XLFDT
Convert FM Date to External Format
$$FMTH^XLFDT
Convert FM Date to $H
$$FMTHL7^XLFDT
Convert FM Date to HL7 Date
FORWARD^XQALFWD
Forward Alerts
FRAME^XGF
Screen Frame
$$FTG^%ZISH
Load Host File into Global
$$GATF^%ZISH
Copy Global to Host File
$$GET^XUA4A72
Get Specialty & Subspecialty for a User
$$GET^XUPARAM
Get Parameters
GETACT^XQALERT
Return Alert Variables
GETENV^%ZOSV
Current System Information
GETIREF^XTID
Get IREF
$$GETMASTR^XTID
Get Master VUID Flag (Term/Concept)
GETPEER^%ZOSV
VistALink-Get IP Address for Current Session
$$GETSTAT^XTID
Get Status Information (Term/Concept)
$$GETSURO^XQALSURO
Get Current Surrogate Info.
$$GETVUID^XTID
Get VUID
GKILL^%ZISS
KILL Graphic Variables
GSET^%ZISS
Set Up Graphic Variables
$$GTF^%ZISH
Copy Global to Host File
$$%H^XLFDT
Convert Seconds to $H
H^XUS
Programmer Halt
$$HADD^XLFDT
$H Add
$$HANDLE^XUSRB4
Return Unique Session ID String
HASH^XUSHSHP
Hash E-Sig Code
$$HDIFF^XLFDT
$H Difference
$$HL7TFM^XLFDT
Convert HL7 Date to FM Date
$$HLNAME^XLFNAME
Conv. Name to HL7 Formatted Name
HLP1^%ZIS
Display Brief Device Help
HLP2^%ZIS
Display Device Help Frames
HOME^%ZIS
Reset Home Device IO Variables
$$HTE^XLFDT
Convert $H to External Format
$$HTFM^XLFDT
Convert $H to FM Date Format
$$ID^XUAF4
Institution Identifier
$$IDX^XUAF4
Inst. IEN (Using Coding System & ID)
$$IEN^XUAF4
IEN for Station Number
$$IEN^XUMF
Inst. IEN (Using IFN, Coding System, & ID)
$$IEN2CODE^XUA4A72
Get VA Code
$$IENS^XUPS
Get IEN Using VPID in File #200
$$INHIBIT^XUSRB
Check if Logons Inhibited
INIT^XPDID
Initialize Device & Draw Box Borders
INITKB^XGF
Keyboard Setup Only
INTRO^XUSRB
VistaLink-Get Introductory Text
$$INVERT^XLFSTR
Invert String
IOXY^XGF
Screen Cursor Placement
ISQED^%ZTLOAD
Return Task Status
$$JOB^%ZTLOAD
Return a Job Number for a Task
$$KCHK^XUSRB
Check If User Holds Security Key
KILL^%ZISS
KILL Screen Handling Variables
KILL^%ZTLOAD
Delete a Task
KILL^XUSCLEAN
Clear All but Kernel Variables
$$KSP^XUPARAM
Return Kernel Site Parameter
$$LAST^XPDUTL
Last Software Patch
$$LEGACY^XUAF4
Inst. Realigned/Legacy (True/False)
$$LENGTH^XLFMSMT
Convert Length
$$LGR^%ZOSV
Last Global Reference
$$LIST^%ZISH
List Directory
$$LJ^XLFSTR
Left Justify String
LKOPT^XPDMENU
Look Up Option IEN
$$LKUP^XPDKEY
Look Up Security Key Value
$$LKUP^XUAF4
Institution Lookup
$$LKUP^XUPARAM
Look Up Parameters
$$LN^XLFMTH
Natural Log (Base e)
$$LOG^XLFMTH
Logarithm (Base 10)
LOGOUT^XUSRB
VistALink-Log Out User From M
LOGRSRC^%ZOSV
LOOKUP^XUAF4
Look Up Inst. Identifier
$$LOOKUP^XUSER
New Person File Lookup
$$LOW^XLFSTR
Convert String to Lowercase
$$MADD^XUAF4
Institution Mailing Address
MAIL^XLFNSLK
Get IP Addresses for a Domain Name
MAIN^XUMFI
HL7 Master File Message Builder
MAIN^XUMFP
Master File Parameters
$$MAX^XLFMTH
Maximum of 2 Numbers
MES^XPDUTL
Output a Message
$$MIN^XLFMTH
Maximum of 2 Numbers
MSG^XQOR
Enable HL7 Messaging
$$MV^%ZISH
Rename Host File
$$NAME^MXMLDOM
Get Element Name
$$NAME^XUAF4
Institution Official Name
$$NAME^XUSER
Get Name of User
NAMECOMP^XLFNAME
Component Parts from Std. Name
$$NAMEFMT^XLFNAME
Formatted Name from Name Components
$$NEWCP^XPDUTL
Create Checkpoint
$$NEWERR^%ZTER
Verify Support of Standard Error Trapping (Obsolete)
NEXT^XQ92
Restricted Times Check
$$NNT^XUAF4
Inst. Station Number, Name, & Type
$$NODEV^XUTMDEVQ
Run a Task (Directly or Queued)
NOTIPURG^XQALBUTL
Purge Alerts Based on Code
$$NOW^XLFDT
Current Date and Time (FM Format)
$$NPI^XUSNPI
Get NPI from Files #200 or #4
$$NS^XUAF4
Inst. Name & Station Number
$$O99^XUAF4
IEN of Merged Station Number
OP^XQCHK
Current Option Check
OPEN^%ZISH
Open Host File
OPEN^%ZISUTL
Open Device with Handle
OPKG^XUHUI
Monitor New Style X-ref. Fields
$$OPTDE^XPDUTL
Disable/Enable an Option
OPTION^%ZTLOAD
Find Tasks for an Option
OPTSTAT^XUTMOPT
Obtain Option Schedule
$$OS^%ZOSV
Get Operating System Info.
OUT^XPDMENU
Edit Option's Out of Order Message
OWNSKEY^XUSRB
Verify Security Keys Assigned to a User
$$PADD^XUAF4
Institution Physical Address
$$PARCP^XPDUTL
Get Checkpoint Parameter
$$PARENT^MXMLDOM
Get Parent Node
PARENT^XUAF4
Parent Institution Lookup
$$PATCH^XPDUTL
Verify Patch Installation
PATIENT^XQALERT
Get Alerts for a Patient
PCLEAR^%ZTLOAD
Clear Persistent Flag for a Task
$$PENDING^XQALBUTL
Pending Alerts for a User
$$PI^XLFMTH
PI
$$PKG^XPDUTL
Parse Software Name From Build Name
$$PKGPAT^XPDIP
Update Patch History
$$PKGPEND^XQALBUTL
Pending Alerts for a User in Specified Software
PKILL^%ZISP
Kill Special Printer Variables
POSTAL^XIPUTIL
ZIP Code Information
POSTALB^XIPUTIL
Active ZIP Codes
PREP^XGF
Screen/Keyboard Setup
$$PRNT^XUAF4
Institution Parent Facility
$$PROD^XUPROD
Production Vs. Test Acct.
$$PRODE^XPDUTL
Disable/Enable a Protocol
$$PROVIDER^XUSER
Providers in New Person File
$$PSET^%ZTLOAD
Set Task as Persistent
PSET^%ZISP
Set Up Special Printer Variables
PTPURG^XQALBUTL
Purge Alerts Based on Patient
$$PWD^%ZISH
Get Current Directory
$$PWR^XLFMTH
X to the Y Power
$$QI^XUSNPI
Get Provider Entities
$$QQ^XUTMDEVQ
Double Queue—Direct Queuing in a Single Call
$$RADDEG^XLFMTH
$$READ^XGF
Read Using Escape Processing
RECIPURG^XQALBUTL
Purge User Alerts
REMVSURO^XQALSURO
Remove Surrogates for Alerts
$$RENAME^XPDKEY
Rename Security Key
RENAME^XPDMENU
Rename Option
$$REPEAT^XLFSTR
Repeat String
$$REPLACE^XLFSTR
Replace Strings
REQ^%ZTLOAD
Requeue a Task
$$REQQ^XUTMDEVQ
Schedule Second Part of a Task
$$RES^XUDHSET
Set Up Resource Device
RESCH^XUTMOPT
Set Up Option Schedule
RESETKB^XGF
Exit XGF Keyboard
RESTORE^XGF
Screen Restore
$$REWIND^%ZIS
Rewind Devices
$$RF^XUAF4
Realigned From Inst. Info.
$$RJ^XLFSTR
Right Justify String
RMDEV^%ZISUTL
Delete Data Given a Handle
$$RT^XUAF4
Realigned To Inst. Info.
$$RTD^XLFMTH
Convert Radians to Degrees
RTN^%ZTLOAD
Find Tasks that Call a Routine
$$RTNUP^XPDUTL
Update Routine Action
$$S^%ZTLOAD
Check for Task Stop Request
SAVDEV^%ZISUTL
Save Data Given a Handle
SAVE^XGF
Screen Save
SAY^XGF
Screen String
SAYU^XGF
Screen String with Attributes
$$SCH^XLFDT
Next Scheduled Runtime