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

$$RPLCLST^XTIDTRM(): Get List of Replacement Terms, w/Optional Status Date and History (Term/Concept)

Reference Type: Supported, Category: Toolkit—Data Standardization, ICR#: 5078

Description

The $$RPLCLST^XTIDTRM extrinsic function traverses the REPLACED BY VHA STANDARD TERM (#99.97) field forwards and backwards to find all terms that are replacement terms for the input entry and all terms for which the input entry is a replacement. This is recursively done so that each potential branch of replacement terms forwards and backwards is traversed.

REF: For an overview of the Data Standardization API set, read Data Standardization APIs.

For a chart mapping the Data Standardization API set in context, read Replacement Relationships.

Format

  $$RPLCLST^XTIDTRM(file,ien,drctn,statdate,stathst,outarr)

Input Parameters

file:

(required) File number.
ien:

(required) Entry number.
drctn: (optional) Flags denoting which directions to follow the trail of replacement terms. Possible flag values are:
  • F (default)—Follow the trail forwards.

  • B—Follow the trail backwards.

  • *—Follow the trail in both directions (same as FB/BF).
statdate: (optional) VA FileMan date/time in which to return term's status. Defaults to current date/time.
stathst: (optional) Flag denoting if a term's full status history should be included in the output:
  • 0 (default)—No

  • 1—Yes

Input/Output

outarr: I: (required) Array to put trail of replacement terms into (closed root)
O: The output array contains the list terms to which the input entry is somehow related.
  • OutArr(1..n) = Term ^ StatusCode (based on input StatDate)

  • OutArr(1..n,StatusDateTime) = StatusCode on this date/time

    This node is only returned if StatHst is set to 1 (Yes)

  • OutArr("INDEX",Term) = 1..n

Where:

  • Term is in the format IEN;FileNumber.

  • StatusCode:

    • 1—Active.

    • 0—Inactive.

  • StatusDateTime is in VA FileMan format.

Example

>S X=$$RPLCLST^XTIDTRM(File,IEN,Drctn,StatDate,StatHst,OutArr)

The $$RPLCLST^XTIDTRM extrinsic function sets X=IEN_";"_FileNumber of the entry that ultimately replaces the input entry:

NOTE: