Toolkit 7.3 APIs Banner [skip navigation]
Office of Information & Technology (OIT) Banner

$$SETVUID^XTID(): Set VUID (Term/Concept)

Reference Type: Supported, Category: Toolkit—VHA Unique ID (VUID), Integration Agreement: 4631

Description

This extrinsic function populates (sets) the VHA Unique ID (VUID) for a given term/concept reference.

It also automatically sets the MASTER ENTRY FOR VUID field to distinguish references that might be duplicates. If this is the first reference assigned the VUID, it sets the MASTER ENTRY FOR VUID equal to 1. If another entry already has the given VUID, it sets the MASTER ENTRY FOR VUID equal to 0.

Format

  $$SETVUID^XTID(file[,field],iref,vuid)

Input Parameters

file:

(required) VistA file/subfile number where term/concept is defined.

field:

(optional) Field number in the "file" input parameter where term/concept is defined:

  • Not Defined—If not defined, this field defaults to the .01 field number, and it represents the terms defined in the file entered in the "file" input parameter.

  • Defined:

    • Entered as .01, it represents the terms defined in the file entered in the "file" input parameter.

    • Otherwise, the field number entered must be a SET OF CODES data type field in the file entered in the "file" input parameter.
iref:

(required) Internal reference for term/concept:

  • File Entries—This will be an IENS. For example:

    iref = "5,"

  • SET OF CODES—This will be the internal value of the code. For example:

    iref = 3 or
    iref = "f" or
    iref = "M"
vuid:

(required) The VHA Unique ID (VUID) to assign the given term/concept reference.

Output

returns:

Returns results of operation as follows:

  • Successful—1

  • Unsuccessful—0^<error message>

Example 1

For terms defined in fields that are SET OF CODES:

>S file=2,field=.02,iref="M",vuid=123456

>W $$SETVUID^XTID(file,field,iref,vuid)
1

Example 2

For terms defined in a single file:

>S file=16000009,field=.01,iref="3,",vuid=123457

>W $$SETVUID^XTID(file,field,iref,vuid)
1

 


VA (Internet) / VA(Intranet) / OI / PD / Site Map / Terms of Use / VA Privacy Policy / Accessibility

Reviewed/Updated: August 26, 2011

If you have questions, need more information, or are having accessibility problems with this website, please contact us by E-Mail: Webmasters, Phone: 510-768-6800, or FAX: 510-768-6850.