Kernel Toolkit APIs: $$RPLCVALS^XTIDTRM

$$RPLCVALS^XTIDTRM(): Get Field Values of Final Replacement Term (Term/Concept)

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

Description

The $$RPLCVALS^XTIDTRM extrinsic function retrieves one or more fields of data from an entry's final replacement term. The REPLACED BY VHA STANDARD TERM (#99.97) field is recursively traversed until the final replacement term is reached. The requested fields of the final replacement term are returned. It effectively bundles $$RPLCMNT^XTIDTRM and GETS^DIQ into a single call.

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

  $$RPLCVALS^XTIDTRM(file,ien,fields,flags,outarr)

Input Parameters

file:	(required) File number.
ien:	(required) Internal Entry Number (IEN).
fields:	(required) Fields for which you wish to get values. REF: For detailed description, see the definition of the FIELD parameter in the GETS^DIQ API.
flags:	(required) Flags that control output format. REF: For detailed description, see the definition of the FLAGS parameter in the VA FileMan GETS^DIQ API.

Input/Output

outarr:

Input/Output:

I: (required) Array to put trail of replacement terms into (closed root).
O: The output array is in FDA format.

REF: For example output, see the VA FileMan GETS^DIQ API.

Example

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

>S X=$$RPLCVALS^XTIDTRM(file,ien,fields,flags,outarr)

NOTES:

NULL is returned on error. This typically occurs when the input entry does not exist.
If an error occurs when extracting the requested fields from the final replacement term then a reference to the final replacement term is still returned and outarr is KILLed.
If the input entry is not replaced by another term then a reference to the input term is returned and outarr() contains the field values for the input entry.