Description
Return the first as family, second as given, and all remaining as additional.
Clinical exchange formats use exact delimiters, character grammars, and scoped identifiers. A local token check addresses one syntax condition and can succeed without validating a complete message or its clinical meaning.
Return the first as family, second as given, and all remaining as additional.
When to use this tool
Use HL7 Person Name Family Given Component Token when you need one bounded spelling, delimiter, or identifier component.
How to use the tool and how it works
- Enter encoded, separator. Use the units and conventions below.
- Run the tool. Correct any format, range, or cross-field input error before interpreting the output.
- Read family, given, additional. Use the output convention below.
Require a one-UTF-16-unit separator and at least two split components. Return the first as family, second as given, and all remaining as additional.1
| Input field | Meaning and units | Accepted input |
|---|---|---|
| encoded | Encoded | Required. Text; maximum UTF-16 length 8192. |
| separator | Separator | Required. Text; maximum UTF-16 length 8192. |
| Output field | Interpretation | Returned shape |
|---|---|---|
| family | Family | Required. Text; maximum UTF-16 length 8192. |
| given | Given | Required. Text; maximum UTF-16 length 8192. |
| additional | Additional | Required. Array of text; maximum UTF-16 length 8192; maximum items 256. |
{
"input": {
"encoded": "Smith^Alex^J",
"separator": "^"
},
"output": {
"family": "Smith",
"given": "Alex",
"additional": [
"J"
]
}
}Limitations and assumptions
- Empty components are retained and HL7 escaping and nested name structure are not decoded; no identity, cultural name order, or complete person-name validity is inferred.
- Inputs must satisfy both the field types and the cross-field conditions above. Invalid input causes an error; a successful false flag or documented placeholder is a different result.
Alternative or Complementary methods
Use the relevant full standard, implementation profile, and validated parser when interoperable or clinical record validity matters.
References
Similar or alternative tools
- FHIR Human Name Prefix Suffix Components
Join prefix, given, optional nonempty family, and suffix in that order as parts and a space-separated display.
- HL7 Segment Field Number Offset
Return fieldNumber for ordinary split arrays; for MSH return fieldNumber-1 except separator MSH-1, represented by splitIndex -1 and separatorField true.