All RPC

Package: Kernel RPC List

Name Tag Routine Availability Description
Name Tag Routine Availability Description
XUS SIGNON SETUP SETUP XUSRB SUBSCRIPTION RPC ICR #1632 - API ICR #4054 Establishes the environment necessary for VistA sign-on.
XUS SEND KEYS SENDKEYS XUSRB RESTRICTED Returns an array of strings that are used in the hashing algorithm. The strings that are returned are picked up from Z^XUSRB.
XUS AV CODE VALIDAV XUSRB RESTRICTED This API checks if a ACCESS/VERIFY code pair is valid. R(5+n)=message text. It returns an array of values R(0)=DUZ if sign-on was OK, zero if not OK. R(1)=(0=OK, 1,2...=Can't sign-on for some reason). R(2)=verify needs changing. R(3)=Message. R(4)=0 R(5)=count of the number of lines of text, zero if none.
XUS INTRO MSG INTRO XUSRB RESTRICTED This RPC returns the INTRO message from the KERNEL SYSTEM PARAMETERS file.
XUS KEY CHECK OWNSKEY XUSRB PUBLIC RPC ICR #6286 - API ICR #3277 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.
XUS CVC CVC XUSRB RESTRICTED RPC ICR #6296 - API ICR #none This RPC is used as part of Kernel to allow the user to change their verify code.
XUS AV HELP AVHELP XUSRB RESTRICTED Returns instructions on entering new access/verify codes.
XUS DIVISION SET DIVSET XUSRB2 RESTRICTED This RPC is used to set the user's selected Division in DUZ(2) during sign-on.
XUS GET USER INFO USERINFO XUSRB2 PUBLIC Returns information about a user after logon.
XUS DIVISION GET DIVGET XUSRB2 RESTRICTED This RPC will return a list of divisions of a user.
XUS GET TOKEN ASH XUSRB4 RESTRICTED
XQAL GUI ALERTS ENTRY XQALGUI This is the RPC that handles the XUAlert component
XUS CCOW VAULT PARAM CCOWPC XUSRB4 RESTRICTED This RPC returns a value for use with the CCOW vault.
XUS GET CCOW TOKEN CCOW XUSRB4 RESTRICTED This RPC gets a token to save in the CCOW context to aid in sign-on.
XUS ALLKEYS ALLKEYS XUSRB PUBLIC RPC ICR #6287 - API ICR #3277 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.
XUPS PERSONQUERY EN1 XUPSQRY PUBLIC
XUS KAAJEE GET USER INFO USERINFO XUSKAAJ AGREEMENT Returns a variety of information needed for the KAAJEE logon.
XUS KAAJEE LOGOUT SIGNOFF XUSKAAJ AGREEMENT This RPC calls the LOUT^XUSCLEAN tag to mark a KAAJEE-signed-on user's entry in the sign-on log as signed off.
XUS SET VISITOR SETVISIT XUSBSE1 SUBSCRIPTION This controlled-subscription RPC is used by the Broker Security Enhancement on an authenticating VistA system to obtain a BSE TOKEN for an authenticated active user. The TOKEN is used to identify and authenticate a visiting user on a remote VistA system, which calls back to the authenticating system to obtain the authenticated user's demographics.
XUS GET VISITOR GETVISIT XUSBSE1 SUBSCRIPTION This controlled-subscription RPC is used by the Broker Security Enhancement to check a user's credentials based on a BSE TOKEN that was passed to identify and authenticate a visiting user. The remote VistA system calls this RPC on the authenticating VistA system to validate if the visiting user is permitted to visit, and if so, obtain the authenticated user's demographics.
XUS KAAJEE GET USER VIA PROXY USERINFO XUSKAAJ1 RESTRICTED Returns a variety of information needed for KAAJEE logon based on the ccow token
XUS KAAJEE GET CCOW TOKEN CCOWIP XUSKAAJ1 RESTRICTED This RPC gets a token to save in the CCOW context to aid in sign-on
XUS PKI GET UPN GETUPN XUSER2 PUBLIC This RPC gets the SUBJECT ALTERNATIVE NAME field from the New Person (#200) file field 501.2. It is used to check that the correct PIV card has been put into the reader.
XUS PKI SET UPN SETUPN XUSER2 RESTRICTED This RPC is used to set the SUBJECT ALTERNATIVE NAME in the New Person #(200) file field 501.2.
XU EPCS EDIT ENTRY XUEPCSED RESTRICTED This remote procedure stores information on editing changes in file 200 related to the electronic prescribing of controlled substances.
XU REBUILD MENU TREE REBUILD XQ84 PUBLIC This API rebuilds the menu trees and display nodes for a single user (DUZ). It returns 0 if unsuccessful, 1 if successful.
XUS IAM ADD USER IAMAU XUESSO3 SUBSCRIPTION RPC ICR #6290 - API ICR #none This restricted RPC is used exclusively by the Identity and Access Management (IAM) Provisioning application to add a user to the VistA NEW PERSON file (#200). The XUSPF200 Security Key is required to add a user without an SSN (file #200 special privileges).
XUS IAM EDIT USER IAMEU XUESSO3 SUBSCRIPTION RPC ICR #6291 - API ICR #none The XUSPF200 Security Key is required to edit a user without an SSN (file #200 special privileges). This restricted RPC is used exclusively by the Identity and Access Management (IAM) Provisioning application to edit an existing user in the VistA NEW PERSON file (#200). The XUSHOWSSN Security Key is required to edit Personally Identifiable Information (PII) such as Social Security Number (SSN) or Date of Birth (DOB).
XUS IAM FIND USER IAMFU XUESSO3 SUBSCRIPTION RPC ICR #6288 - API ICR #none This restricted RPC is used exclusively by the Identity and Access Management (IAM) Provisioning application to find a list of users that satisfy a collection of input criteria. One or more of the input array values must be set by the calling application. The XUSHOWSSN Security Key is required to do lookups using Personally Identifiable Information (PII) such as Social Security Number (SSN) or Date of Birth (DOB).
XUS IAM DISPLAY USER IAMDU XUESSO3 SUBSCRIPTION RPC ICE #6289 - API ICR #none This restricted RPC is used exclusively by the Identity and Access Management (IAM) Provisioning application to display a VistA user. The XUSHOWSSN Security Key is required to display Personally Identifiable Information (PII) such as Social Security Number (SSN) or Date of Birth (DOB).
XUS ESSO VALIDATE ESSO XUESSO4 RESTRICTED RPC ICR #6295 - API ICR #none This API/RPC uses the VA Identity and Access Management (IAM) SAML token definition version 1.2 attributes from a SAML token for user sign-on.
XUS IAM BIND USER IAMBU XUESSO4 SUBSCRIPTION RPC ICR #6294 - API ICR #none This restricted RPC is used exclusively by the Identity and Access Management (IAM) Binding application to set the Security ID (SecID) and Active Directory UPN (ADUPN) in the VistA NEW PERSON file (#200) for Single Sign-On Internal (SSOi).
XUS IAM TERMINATE USER IAMTU XUESSO3 RESTRICTED This restricted RPC is used exclusively by the Identity and Access Management (IAM) Provisioning application to terminate an existing user in the VistA NEW PERSON file (#200).
XUS IAM REACTIVATE USER IAMRU XUESSO3 SUBSCRIPTION RPC ICR #6293 - API ICR #none This restricted RPC is used exclusively by the Identity and Access Management (IAM) Provisioning application to reactivate an existing user in the VistA NEW PERSON file (#200).
XUS BSE TOKEN BSETOKEN XUSBSE1 SUBSCRIPTION It is used exclusively for the Station-number callback type, and will not work with Delphi RPC Broker clients compiled with the Broker Development Kit (BDK). It is intended for non-Delphi clients connecting with the XUS SIGNON SETUP RPC. RPC ICR #6695 - API ICR #none This API/RPC returns a string from the current user authentication that can be used to authenticate the user on a visited system. The application is identified by a security phrase that, when hashed, matches the stored hash of an authorized application in the REMOTE APPLICATION file (#8994.5).
XUS MVI NEW PERSON GET GET XUMVINPU AGREEMENT This restricted RPC is used exclusively by the Master Veteran Index (MVI) to retrieve data (by DUZ, SECID, NPI or SSN) from the VistA NEW PERSON file (#200).
XUS MVI NEW PERSON UPDATE UPDATE XUMVINPU AGREEMENT This restricted RPC is used exclusively by the Master Veteran Index (MVI) to update an entry (by DUZ) in the VistA NEW PERSON file (#200).
XUS MVI NEW PERSON DATA EP XUMVIDTA AGREEMENT This RPC will return calculated data analysis from NEW PERSON file (#200) at VistA for user's selection criteria for active and non active NEW PERSON entries. Active New Person aggregated data for one or all below elements: SECID AUDPN (Email) NT USERNAME
XUS MVI ENRICH NEW PERSON UPDATE XUMVIENU AGREEMENT This restricted RPC is used exclusively by the Master Veteran Index (MVI) to update enriched data in the VistA New Person File (#200).
XUS MVI NEW PERSON BULK GET BULKGET XUMVINPB AGREEMENT This restricted RPC is used exclusively by the Master Veteran Index (MVI) to retrieve data in bulk from the VistA NEW PERSON file (#200).
XULM GET LOCK TABLE LOCKS XULMRPC PUBLIC This RPC is used by the Lock Manager to obtain the lock table on a specific node. The lock table is returned in a global.
XULM KILL PROCESS KILLPROC XULMRPC PUBLIC This RPC is used by the Kernel Lock Manager to terminate a process.
XUS IS USER ACTIVE ACTIVE XUESSO4 PUBLIC This API/RPC is used to check if a user is active, as defined in the routine APIs $$ACTIVE^XUSER.
XUS MVI NEW PERSON RMTE AUDIT AUDIT XURNPAUD AGREEMENT This restricted RPC is used exclusively by the Master Veteran Index (MVI) to return audit data from the AUDIT (#1.1) file at a facility for a specific user's record in the NEW PERSON (#200) file.