Kernel APIs: NAMECOMP^XLFNAME

NAMECOMP^XLFNAME(): Component Parts from Standard Name

Reference Type: Supported, Category: Name Standardization, ICR#: 3065

Description

The NAMECOMP^XLFNAME API takes a name in standard format and returns in an array the component parts of that name.

Format

  NAMECOMP^XLFNAME(.name)

Input Parameters

.name:

(required) This parameter is the name in standard format to be parsed. NAMECOMP^XLFNAME returns the component parts of the name in nodes descendent from NAME. (See "Output Parameters.")

Output Parameters

.name:

The component parts of the name are returned in the NAME array passed in.

NAME("FAMILY) = Family (last) Name
NAME("GIVEN") = Given (first) Name
NAME("MIDDLE") = Middle Name
NAME("SUFFIX") = Suffix(es)

Example

In this example, the MYNAME variable is set to the standard name. The NAMECOMP^XLFNAME call is made to return in the MYNAME array the component parts of that name:

>S MYNAME="XUUSER-XUUSER,FORTY ONE S MD"
>D NAMECOMP^XLFNAME(.MYNAME)

>ZW MYNAME
MYNAME=XUUSER-XUUSER,FORTY ONE S MD
MYNAME("FAMILY")=XUUSER-XUUSER
MYNAME("GIVEN")=FORTY ONE
MYNAME("MIDDLE")=S
MYNAME("SUFFIX")=MD