Kernel Toolkit APIs: $$RPLCMNT^XTIDTRM

$$RPLCMNT^XTIDTRM(): Get Final Replacement Term (Term/Concept)

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

Description

The $$RPLCMNT^XTIDTRM extrinsic function recursively traverses the REPLACED BY VHA STANDARD TERM (#99.97) field until the final replacement term is reached.

NOTE: 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

  $$RPLCMNT^XTIDTRM(file,ien)

Input Parameters

file:	(required) File number.
ien:	(required) Internal Entry Number (IEN).

Output

none.

Example

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

>S X=$$RPLCMNT^XTIDTRM(file,ien)

NOTE:

NULL is returned on error. This typically occurs when the input entry does not exist.
If the input entry is not replaced by another term then a reference to the input term is returned.