VistA, VHA OI - Health Systems Design & Development (HSD&D) Logo: Return to Home Page
[skip navigation]

List APIs By:

Tag Names (Entry Pt.)

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