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

SIBLING^XUAF4(): Sibling Institution Lookup

Reference Type: Supported, Category: Institution File, ICR#: 2171

Description

The SIBLING^XUAF4 API returns a list of all institutions that make up a given Veterans Integrated Service Network (VISN), parent institution entered in the child input parameter.

Format

  SIBLING^XUAF4(array,child[,type])

Input Parameters

array:

(required) $NAME reference to store the list of all institutions of a parent (VISN) institution for the child input parameter institution.
child:

(required) Child institution lookup value, any of the following:

  • Internal Entry Number (IEN); has the grave accent (`) in front of it.

  • Station Number

  • Station Name
type:

(optional) Type of institution from the INSTITUTION ASSOCIATION TYPES (#4.05) file (default is VISN).

Output

returns:

Returns the array populated with the list of all institutions of the parent (VISN) institution.

  Variable array
  ("P",PIEN,"C",CIEN)=STATION_NAME^STATION_NUMBER

NOTE: With the business rule that institutions can only have one parent per type, if you specify the type input parameter, you get an array that only has one PIEN in it. If the type parameter is left blank, it finds all parents for the institution and lists then in the array. Also, the input site (i.e., child input parameter) is included in the list.