$$BLDNAME^XLFNAME(): Build Name from Component Parts

Reference Type: Supported, Category: Name Standardization, Integration Agreement: 3065

Description

This extrinsic function takes the component parts of a name and returns the name, truncated if necessary, in the following format:

Family_name,Given_name<space>Middle_name<space>Suffix(es)

Format

  $$BLDNAME^XLFNAME(.name[,max])

Input Parameters

Output

  Family_name,Given_name<space>Middle_name<space>
				Suffix(es)

Details

If the MAX input parameter is used, and the resulting name is longer than MAX, the following pruning algorithm is performed to shorten the name:

1. Truncate Middle Name from the right-most position until only the initial character is left;
   
   
2. Drop suffix;
   
   
3. Truncate Given Name from the right-most position until only the initial character is left;
   
   
4. Truncate Family Name from the right-most position;
   
   
5. Truncate the name from the right.
   
   

Example 1

Suppose the MYNAME array contains the following elements:

MYNAME("FAMILY")="KRNUSER"
MYNAME("GIVEN")="SIXTY"
MYNAME("MIDDLE")="K."
MYNAME("SUFFIX")="JR"

Calls to $$BLDNAME^XLFNAME will return the name as follows:

>S X=$$BLDNAME^XLFNAME(.MYNAME)

>W X
KRNUSER,SIXTY K JR

"Pruning" the name to 12 characters total:

>S X =$$BLDNAME^XLFNAME(.MYNAME,12)

>W X
KRNUSER,SI K

Example 2

If an entry in the NAME COMPONENTS file (#20) stores the components of a name stored in the NAME field (#.01) of record number 32 in the NEW PERSON file (#200), and the data in the corresponding record in the NAME COMPONENT file (#20) is:

FILE=200
FIELD=.01
IENS="32,"
GIVEN NAME="SIXTY"
MIDDLE NAME="K."
FAMILY NAME="KRNUSER"
SUFFIX="JR"

you can set:

MYNAME("FILE")=200
MYNAME("FIELD")=.01
MYNAME("IENS")="32,"

and call $$BLDNAME^XLFNAME as in Example 1:

>S X=$$BLDNAME^XLFNAME(.MYNAME)

>W X
KRNUSER,SIXTY K JR

"Pruning" the name to 12 characters total:

>S X=$$BLDNAME^XLFNAME(.MYNAME,12)

>W X
KRNUSER,SI K