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

$$GETSTAT^XTID(): Get Status Information (Term/Concept)

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

Description

This extrinsic function retrieves the status information for a given term/concept reference and a specified date/time.

Format

  $$GETSTAT^XTID(file[,field],iref[,datetime])

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"
datetime:

(optional) VA FileMan date/time. It defaults to  NOW.

Output

returns:

Returns results of operation as follows:

  • Successful—<internal value>^<FileMan effective date/time>^<external value>

    For example:
      0^3050220.115720^INACTIVE
    
      1^3050225.115711^ACTIVE
  • Unsuccessful—^<error message>

    (NOTE: The first piece is empty. This differentiates it from the successful case, where the first piece is either 0 or 1.)

Example 1

For terms defined in fields that are SET OF CODES:

>S file=2,field=.02,iref="M",datetime=$$NOW^XLFDT

>W $$GETSTAT^XTID(file,field,iref,datetime)
1^3050121.154752^ACTIVE

Example 2

For terms defined in a single file:

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

>W $$GETSTAT^XTID(file,field,iref,datetime)
0^3050122.154755^INACTIVE

 


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.