• Kernel Home Page
• Toolkit Home Page
• APIs Introduction

List APIs By:

• Category (default)
• Routine Name
• Tag Name
• Reference Type

Category List

• Address Hygiene
• Alerts
• Common Services
• Data Standardization
• Device Handler
• DNS
• Electronic Signature
• Error Processing
• Field Monitoring
• Help Processor
• Host Files
• Institution File
• KIDS
• Menu Manager
• Miscellaneous
• Name Standardization
• National Provider Identifier
• OS Interface
• Security Keys
• Signon/Security
• Spooling
• TaskMan
• Unwinder
• User
• XGF Function Library
• XLF Function Library
• CRC
• Dates
• Hyperbolic Trig.
• Math
• Measurements
• String
• Utilities
• XML

Address Hygiene

		CCODE^XIPUTIL FIPS Code Data
		$$FIPS^XIPUTIL FIPS Code for ZIP Code
		$$FIPSCHK^XIPUTIL Check for FIPS Code
		POSTAL^XIPUTIL ZIP Code Information
		POSTALB^XIPUTIL Active ZIP Codes

Alerts

		AHISTORY^XQALBUTL Get Alert Tracking File Info.
		ALERTDAT^XQALBUTL Get Alert Tracking File Info.
		DELSTAT^XQALBUTL Get User Info./Status for Recent Alert
		NOTIPURG^XQALBUTL Purge Alerts Based on Code
		$$PENDING^XQALBUTL Pending Alerts for a User
		$$PKGPEND^XQALBUTL Pending Alerts for a User (Spec. Software)
		PTPURG^XQALBUTL Purge Alerts Based on Patient
		RECIPURG^XQALBUTL Purge User Alerts
		USERDATA^XQALBUTL Get User Info. for an Alert
		USERLIST^XQALBUTL Get Recipient Info. for an Alert
		ACTION^XQALERT Process an Alert
		DELETE^XQALERT Clear Obsolete Alerts (Single)
		DELETEA^XQALERT Clear Obsolete Alerts (All)
		GETACT^XQALERT Return Alert Variables
		PATIENT^XQALERT Get Alerts for a Patient
		SETUP^XQALERT Send Alerts
		$$SETUP1^XQALERT Send Alerts
		USER^XQALERT Get Alerts for a User
		FORWARD^XQALFWD Forward Alerts
		$$CURRSURO^XQALSURO Get Current Surrogate for Alerts
		$$GETSURO^XQALSURO Get Current Surrogate Info.
		REMVSURO^XQALSURO Remove Surrogates for Alerts
		SETSURO1^XQALSURO Establish a Surrogate for Alerts

Common Services

		$$IENS^XUPS Get IEN Using VPID in File #200
		$$VPID^XUPS Get VPID Using IEN in File #200
		EN1^XUPSQRY Query New Person File

Data Standardization

		GETIREF^XTID Get IREF
		$$GETMASTR^XTID Get Master VUID Flag (Term/Concept)
		$$GETSTAT^XTID Get Status Information (Term/Concept)
		$$GETVUID^XTID Get VUID
		$$SCREEN^XTID Get Screening Condition (Term/Concept)
		$$SETMASTR^XTID Set Master VUID Flag (Term/Concept)
		$$SETSTAT^XTID Set Status Information (Term)
		$$SETVUID^XTID Set VUID

Device Handler

		DEVICE^XUDHGUI GUI Device Lookup
		$$RES^XUDHSET Set Up Resource Device
		^%ZIS Standard Device Call
		HLP1^%ZIS Display Brief Device Help
		HLP2^%ZIS Display Device Help Frames
		HOME^%ZIS Reset Home Device IO Variables
		$$REWIND^%ZIS Rewind Devices
		^%ZISC Close Device
		PKILL^%ZISP Kill Special Printer Variables
		PSET^%ZISP Set Up Special Printer Variables
		ENDR^%ZISS Set Up Specific Screen Handling Variables
		ENS^%ZISS Set Up Screen Handling Variables
		GKILL^%ZISS KILL Graphic Variables
		GSET^%ZISS Set Up Graphic Variables
		KILL^%ZISS KILL Screen Handling Variables
		CALL^%ZISTCP Make TCP/IP Connection (Remote)
		CLOSE^%ZISTCP Close TCP/IP Connection (Remote)
		CLOSE^%ZISUTL Close Device with Handle
		OPEN^%ZISUTL Open Device with Handle
		RMDEV^%ZISUTL Delete Data Given a Handle
		SAVDEV^%ZISUTL Save Data Given a Handle
		USE^%ZISUTL Use Device Given a Handle

DNS

		$$ADDRESS^XLFNSLK Conversion (Domain Name to IP Addresses)
		MAIL^XLFNSLK Get IP Addresses for a Domain Name

Electronic Signature

		^XUSESIG Set Up E-Sig Code
		SIG^XUSESIG Verify E-Sig Code
		$$CHKSUM^XUSESIG1 Build Checksum for Global Root
		$$CMP^XUSESIG1 Compare Checksum to $Name_Value
		$$DE^XUSESIG1 Decode String
		$$EN^XUSESIG1 Encode ESBLOCK
		$$ESBLOCK^XUSESIG1 E-Sig Fields Required for Hash
		DE^XUSHSHP Decrypt Data String
		EN^XUSHSHP Encrypt Data String
		HASH^XUSHSHP Hash E-Sig Code

Error Processing

		$$EC^%ZOSV Get Error Code
		^%ZTER Kernel Std. Error Recording Routine
		$$NEWERR^%ZTER Verify Support of Standard Error Trapping (Obsolete)
		UNWIND^%ZTER Quit Back to Calling Routine

Field Monitoring

OPKG^XUHUI Monitor New Style X-ref. Fields

Help Processor

		EN^XQH Display Help Frames (Clear Screen)
		EN1^XQH Display Help Frames
		ACTION^XQH4 Print Help Frame Tree

Host Files

		CLOSE^%ZISH Close Host File
		$$DEFDIR^%ZISH Get Default Host File Directory
		$$DEL^%ZISH Delete Host File
		$$FTG^%ZISH Load Host File into Global
		$$GATF^%ZISH Copy Global to Host File
		$$GTF^%ZISH Copy Global to Host File
		$$LIST^%ZISH List Directory
		$$MV^%ZISH Rename Host File
		OPEN^%ZISH Open Host File
		$$PWD^%ZISH Get Current Directory
		$$STATUS^%ZISH Return End-of-File Status

Institution File

		$$ACTIVE^XUAF4 Inst. Active Facility (True/False)
		CDSYS^XUAF4 Coding System Name
		CHILDREN^XUAF4 List of Child Inst. for a Parent
		$$CIRN^XUAF4 Inst. CIRN-enabled Field Value
		F4^XUAF4 Inst. Data for a Station Number
		$$ID^XUAF4 Institution Identifier
		$$IDX^XUAF4 Inst. IEN (Using Coding System & ID)
		$$IEN^XUAF4 IEN for Station Number
		$$LEGACY^XUAF4 Inst. Realigned/Legacy (True/False)
		$$LKUP^XUAF4 Institution Lookup
		LOOKUP^XUAF4 Look Up Institution Identifier
		$$MADD^XUAF4 Institution Mailing Address
		$$NAME^XUAF4 Institution Official Name
		$$NNT^XUAF4 Inst. Station Number, Name, & Type
		$$NS^XUAF4 Inst. Name & Station Number
		$$O99^XUAF4 IEN of Merged Station Number
		$$PADD^XUAF4 Institution Physical Address
		PARENT^XUAF4 Parent Institution Lookup
		$$PRNT^XUAF4 Institution Parent Facility
		$$RF^XUAF4 Realigned From Inst. Info.
		$$RT^XUAF4 Realigned To Inst. Info.
		SIBLING^XUAF4 Sibling Institution Lookup
		$$STA^XUAF4 Station Number for IEN
		$$TF^XUAF4 Treating Facility (True/False)
		$$WHAT^XUAF4 Inst. Single Field Info.
		$$IEN^XUMF Inst. IEN (Using IFN, Coding System, & ID)
		MAIN^XUMFI HL7 Master File Message Builder
		MAIN^XUMFP Master File Parameters

KIDS

		EXIT^XPDID Restore Screen, Clean Up Variables, & Disp. Text
		INIT^XPDID Initialize Device & Draw Box Borders
		TITLE^XPDID Display Title Text
		UPDATE^XPDID Update Install Progress Bar
		EN^XPDIJ Task Off KIDS Install
		$$PKGPAT^XPDIP Update Patch History
		BMES^XPDUTL Output Message with Blank Line
		$$COMCP^XPDUTL Complete Checkpoint
		$$CURCP^XPDUTL Get Current Checkpoint Name/IEN
		$$LAST^XPDUTL Last Software Patch
		MES^XPDUTL Output a Message
		$$NEWCP^XPDUTL Create Checkpoint
		$$OPTDE^XPDUTL Disable/Enable an Option
		$$PARCP^XPDUTL Get Checkpoint Parameter
		$$PATCH^XPDUTL Verify Patch Installation
		$$PKG^XPDUTL Parse Software Name From Build Name
		$$PRODE^XPDUTL Disable/Enable a Protocol
		$$RTNUP^XPDUTL Update Routine Action
		$$UPCP^XPDUTL Update Checkpoint
		$$VER^XPDUTL Parse Version from Build Name
		$$VERCP^XPDUTL Verify Checkpoint
		$$VERSION^XPDUTL Package File Current Version

Menu Manager

		$$ADD^XPDMENU Add Option to Menu
		DELETE^XPDMENU Delete Menu Item
		LKOPT^XPDMENU Look Up Option IEN
		OUT^XPDMENU Edit Option's Out of Order Message
		RENAME^XPDMENU Rename Option
		NEXT^XQ92 Restricted Times Check
		$$ACCESS^XQCHK User Option Access Test
		OP^XQCHK Current Option Check

Miscellaneous

		^XQDATE Convert $H to VA FileMan Format (Obsolete)
		$$EN^XUA4A71 Convert String to Soundex
		^XUWORKDY Workday Calculation (Obsolete)

Name Standardization

		$$BLDNAME^XLFNAME Build Name from Component Parts
		$$CLEANC^XLFNAME Name Component Std. Routine
		$$FMNAME^XLFNAME Conv. HL7 Formatted Name to Name
		$$HLNAME^XLFNAME Conv. Name to HL7 Formatted Name
		NAMECOMP^XLFNAME Component Parts from Std. Name
		$$NAMEFMT^XLFNAME Formatted Name from Name Components
		STDNAME^XLFNAME Name Standardization Routine
		DELCOMP^XLFNAME2 Delete Name Components Entry
		UPDCOMP^XLFNAME2 Update Name Components Entry

National Provider Identifier

		$$CHKDGT^XUSNPI Validate NPI Format
		$$NPI^XUSNPI Get NPI from Files #200 or #4
		$$QI^XUSNPI Get Provider Entities
		$$TAXIND^XUSTAX Get Taxonomy Code from File #200
		$$TAXORG^XUSTAX Get Taxonomy Code from File #4

OS Interface

		^%ZOSF Operating System-dependent Logic Global
		$$ACTJ^%ZOSV Number of Active Jobs
		$$AVJ^%ZOSV Number of Available Jobs
		DOLRO^%ZOSV Display Local Variables
		GETENV^%ZOSV Current System Info.
		$$LGR^%ZOSV Last Global Reference
		LOGRSRC^%ZOSV
		$$OS^%ZOSV Get Operating System Info.
		SETENV^%ZOSV Set VMS Process Name (Caché/OpenVMS)
		SETNM^%ZOSV Set VMS Process Name: Parameter Passing (Caché/OpenVMS)
		T0^%ZOSV Start RT Measure (Obsolete)
		T1^%ZOSV Stop RT Measure (Obsolete)
		$$VERSION^%ZOSV Get OS Version Number or Name

Security Keys

		DEL^XPDKEY Delete Security Key
		$$LKUP^XPDKEY Look Up Security Key Value
		$$RENAME^XPDKEY Rename Security Key
		OWNSKEY^XUSRB Verify Security Keys Assigned to a User

Signon/Security

		$$GET^XUPARAM Get Parameters
		$$KSP^XUPARAM Return Kernel Site Parameter
		$$LKUP^XUPARAM Look Up Parameters
		SET^XUPARAM Set Parameters
		$$PROD^XUPROD Production Vs. Test Acct.
		H^XUS Programmer Halt
		SET^XUS1A Output Message During Signon
		AVHLPTXT^XUS2 Get Help Text
		$$CREATE^XUSAP Create Application Proxy User
		KILL^XUSCLEAN Clear All but Kernel Variables
		$$ADD^XUSERNEW Add New User
		$$CHECKAV^XUSRB Check Access/Verify Codes
		CVC^XUSRB VistALink-Change User's Verify Code
		$$INHIBIT^XUSRB Check if Logons Inhibited
		INTRO^XUSRB VistaLink-Get Introductory Text
		LOGOUT^XUSRB VistALink-Log Out User From M
		SETUP^XUSRB VistALink-Set Up User's Partition in M
		VALIDAV^XUSRB VistALink-Validate User Credentials
		$$DECRYP^XUSRB1 Decrypt String
		$$ENCRYP^XUSRB1 Encrypt String
		$$HANDLE^XUSRB4 Return Unique Session ID String
		^XUVERIFY Verify Access and Verify Codes
		$$CHECKAV^XUVERIFY Check Access/Verify Codes
		WITNESS^XUVERIFY
		GETPEER^%ZOSV VistALink-Get IP Address for Current Session

Spooling

		DSD^ZISPL Delete Spool Data File Entry
		DSDOC^ZISPL Delete Spool Document File Entry

TaskMan

		$$DEV^XUTMDEVQ Force Queueing—No Device Selection
		EN^XUTMDEVQ Run a Task (Directly or Queued)
		$$NODEV^XUTMDEVQ Run a Task (Directly or Queued)
		$$QQ^XUTMDEVQ Double Queue—Direct Queuing in a Single Call
		$$REQQ^XUTMDEVQ Schedule Second Part of a Task
		DISP^XUTMOPT Display Option Schedule
		EDIT^XUTMOPT Edit an Option's Scheduling
		OPTSTAT^XUTMOPT Obtain Option Schedule
		RESCH^XUTMOPT Set Up Option Schedule
		EN^XUTMTP Display HL7 Task Info.
		^%ZTLOAD Queue a Task
		$$ASKSTOP^%ZTLOAD Stop TaskMan Task
		DESC^%ZTLOAD Find Tasks with a Description
		DQ^%ZTLOAD Unschedule a Task
		ISQED^%ZTLOAD Return Task Status
		$$JOB^%ZTLOAD Return a Job Number for a Task
		KILL^%ZTLOAD Delete a Task
		OPTION^%ZTLOAD Find Tasks for an Option
		PCLEAR^%ZTLOAD Clear Persistent Flag for a Task
		$$PSET^%ZTLOAD Set Task as Persistent
		REQ^%ZTLOAD Requeue a Task
		RTN^%ZTLOAD Find Tasks that Call a Routine
		$$S^%ZTLOAD Check for Task Stop Request
		STAT^%ZTLOAD Task Status
		$$TM^%ZTLOAD Check if TaskMan is Running
		ZTSAVE^%ZTLOAD Build ZTSAVE Array

Unwinder

		EN^XQOR Navigating Protocols
		EN1^XQOR Navigating Protocols (Entry/Exit Actions Not Executed)
		MSG^XQOR Enable HL7 Messaging
		EN^XQORM Menu Item Display and Selection
		XREF^XQORM Force Menu Recompile
		DISP^XQORM1 Disp. Menu Selections From Help Code

User

		$$CODE2TXT^XUA4A72 Get HCFA Text
		$$GET^XUA4A72 Get Specialty & Subspecialty for a User
		$$IEN2CODE^XUA4A72 Get VA Code
		$$DTIME^XUP Reset DTIME for USER
		$$ACTIVE^XUSER Status Indicator
		$$DEA^XUSER Get DEA Number
		DIV4^XUSER Get User Divisions
		$$LOOKUP^XUSER New Person File Lookup
		$$NAME^XUSER Get Name of User
		$$PROVIDER^XUSER Providers in New Person File
		$$KCHK^XUSRB Check If User Holds Security Key
		DIVGET^XUSRB2 Get Divisions for Current User
		DIVSET^XUSRB2 Set Division for Current User
		USERINFO^XUSRB2 Get Demographics for Current User

XGF Function Library

		CHGA^XGF Screen Change Attributes
		CLEAN^XGF Screen/Keyboard Exit and Cleanup
		CLEAR^XGF Screen Clear Region
		FRAME^XGF Screen Frame
		INITKB^XGF Keyboard Setup Only
		IOXY^XGF Screen Cursor Placement
		PREP^XGF Screen/Keyboard Setup
		$$READ^XGF Read Using Escape Processing
		RESETKB^XGF Exit XGF Keyboard
		RESTORE^XGF Screen Restore
		SAVE^XGF Screen Save
		SAY^XGF Screen String
		SAYU^XGF Screen String with Attributes
		SETA^XGF Screen Video Attributes
		WIN^XGF Screen Text Window

XLF Function Library

CRC Functions

		$$CRC16^XLFCRC Cyclic Redundancy Code 16
		$$CRC32^XLFCRC Cyclic Redundancy Code 32

Date Functions

		$$%H^XLFDT Convert Seconds to $H
		$$DOW^XLFDT Day of Week
		$$DT^XLFDT Current Date (FM Format)
		$$FMADD^XLFDT VA FileMan Date Add
		$$FMDIFF^XLFDT VA FileMan Date Difference
		$$FMTE^XLFDT Convert FM Date to External Format
		$$FMTH^XLFDT Convert VA FileMan Date to $H
		$$FMTHL7^XLFDT Convert FM Date to HL7 Date
		$$HADD^XLFDT $H Add
		$$HDIFF^XLFDT $H Difference
		$$HL7TFM^XLFDT Convert HL7 Date to FM Date
		$$HTE^XLFDT Convert $H to External Format
		$$HTFM^XLFDT Convert $H to FM Date Format
		$$NOW^XLFDT Current Date & Time (FM Format)
		$$SCH^XLFDT Next Scheduled Runtime
		$$SEC^XLFDT Convert $H/FM date to Seconds
		$$TZ^XLFDT Time Zone Offset (GMT)
		$$WITHIN^XLFDT Checks Dates/Times Within Schedule

Hyperbolic Trigonometric Functions

		$$ACOSH^XLFHYPER Hyperbolic Arc-cosine
		$$ACOTH^XLFHYPER Hyperbolic Arc-cotangent
		$$ACSCH^XLFHYPER Hyperbolic Arc-cosecant
		$$ASECH^XLFHYPER Hyperbolic Arc-secant
		$$ASINH^XLFHYPER Hyperbolic Arc-sine
		$$ATANH^XLFHYPER Hyperbolic Arc-tangent
		$$COSH^XLFHYPER Hyperbolic Cosine
		$$COTH^XLFHYPER Hyperbolic Cotangent
		$$CSCH^XLFHYPER Hyperbolic Cosecant
		$$SECH^XLFHYPER Hyperbolic Secant
		$$SINH^XLFHYPER Hyperbolic Sine
		$$TANH^XLFHYPER Hyperbolic Tangent

Math Functions

		$$ABS^XLFMTH Absolute Value
		$$ACOS^XLFMTH Arc-cosine (Radians)
		$$ACOSDEG^XLFMTH Arc-cosine (Degrees)
		$$ACOT^XLFMTH Arc-cotangent (Radians)
		$$ACOTDEG^XLFMTH Arc-cotangent (Degrees)
		$$ACSC^XLFMTH Arc-cosecant (Radians)
		$$ACSCDEG^XLFMTH Arc-cosecant (Degrees)
		$$ASEC^XLFMTH Arc-secant (Radians)
		$$ASECDEG^XLFMTH Arc-secant (Degrees)
		$$ASIN^XLFMTH Arc-sine (Radians)
		$$ASINDEG^XLFMTH Arc-sine (Degrees)
		$$ATAN^XLFMTH Arc-tangent (Radians)
		$$ATANDEG^XLFMTH Arc-tangent (Degrees)
		$$COS^XLFMTH Cosine (Radians)
		$$COSDEG^XLFMTH Cosine (Degrees)
		$$COT^XLFMTH Cotangent (Radians)
		$$COTDEG^XLFMTH Cotangent (Degrees)
		$$CSC^XLFMTH Cosecant (Radians)
		$$CSCDEG^XLFMTH Cosecant (Degrees)
		$$DECDMS^XLFMTH Conv. Decimals to Degrees:Minutes:Seconds
		$$DEGRAD^XLFMTH
		$$DMSDEC^XLFMTH Conv. Degrees:Minutes:Seconds to Decimal
		$$DTR^XLFMTH Convert Degrees to Radians
		$$E^XLFMTH e—Natural Logarithm
		$$EXP^XLFMTH e—Natural Logarithm to the Nth Power
		$$LN^XLFMTH Natural Log (Base e)
		$$LOG^XLFMTH Logarithm (Base 10)
		$$MAX^XLFMTH Maximum of 2 Numbers
		$$MIN^XLFMTH Minimum of 2 Numbers
		$$PI^XLFMTH PI
		$$PWR^XLFMTH X to the Y Power
		$$RADDEG^XLFMTH
		$$RTD^XLFMTH Convert Radians to Degrees
		$$SD^XLFMTH Standard Deviation
		$$SEC^XLFMTH Secant (Radians)
		$$SECDEG^XLFMTH Secant (Degrees)
		$$SIN^XLFMTH Sine (Radians)
		$$SINDEG^XLFMTH Sine (Degrees)
		$$SQRT^XLFMTH Square Root
		$$TAN^XLFMTH Tangent (Radians)
		$$TANDEG^XLFMTH Tangent (Degrees)

Measurement Functions

		$$BSA^XLFMSMT Body Surface Area
		$$LENGTH^XLFMSMT Convert Length
		$$TEMP^XLFMSMT Convert Temperature
		$$VOLUME^XLFMSMT Convert Volume
		$$WEIGHT^XLFMSMT Convert Weight

String Functions

		$$CJ^XLFSTR Center Justify String
		$$INVERT^XLFSTR Invert String
		$$LJ^XLFSTR Left Justify String
		$$LOW^XLFSTR Convert String to Lowercase
		$$REPEAT^XLFSTR Repeat String
		$$REPLACE^XLFSTR Replace Strings
		$$RJ^XLFSTR Right Justify String
		$$SENTENCE^XLFSTR Convert String to Sentence Case
		$$STRIP^XLFSTR Strip a String
		$$TITLE^XLFSTR Convert String to Title Case
		$$TRIM^XLFSTR Trim String
		$$UP^XLFSTR Convert String to Uppercase

Utility Functions

		$$BASE^XLFUTL Convert Between Two Bases
		$$CCD^XLFUTL Append Check Digit
		$$CNV^XLFUTL Convert Base 10 to Another Base
		$$DEC^XLFUTL Convert Another Base to Base 10
		$$VCD^XLFUTL Verify Integrity

XML

		$$ATTRIB^MXMLDOM Get Attribute Name
		$$CHILD^MXMLDOM Get Child Node
		$$CMNT^MXMLDOM Extract Comment Text (True/False)
		CMNT^MXMLDOM Extract Comment Text (True/False)
		DELETE^MXMLDOM Delete Document Instance
		$$EN^MXMLDOM Initial Processing, Build In-memory Image
		$$NAME^MXMLDOM Get Element Name
		$$PARENT^MXMLDOM Get Parent Node
		$$SIBLING^MXMLDOM Get Sibling Node
		$$TEXT^MXMLDOM Get Text (True/False)
		TEXT^MXMLDOM Get Text (True/False)
		$$VALUE^MXMLDOM Get Attribute Value
		EN^MXMLPRSE Event Driven API
		$$SYMENC^MXMLUTL Encoded Strings in Messages
		$$XMLHDR^MXMLUTL Message Headers