Description
Join prefix, given, optional nonempty family, and suffix in that order as parts and a space-separated display.
Clinical record metadata can describe names, values, missing reasons, versions, and source relationships. Formatting or checking presence preserves supplied structure without authenticating a person or validating clinical content.
Join prefix, given, optional nonempty family, and suffix in that order as parts and a space-separated display.
When to use this tool
Use FHIR Human Name Prefix Suffix Components when you need one bounded metadata-formatting or consistency component.
How to use the tool and how it works
- Enter prefix, given, family, suffix. Keep parallel arrays aligned. Use the units and conventions below.
- Run the tool. Correct any format, range, or cross-field input error before interpreting the output.
- Read parts, display. Use the output convention below.
Require nonempty entries in prefix, given, and suffix arrays. Join prefix, given, optional nonempty family, and suffix in that order as parts and a space-separated display.1
| Input field | Meaning and units | Accepted input |
|---|---|---|
| prefix | Prefix | Required. Array of text; maximum UTF-16 length 8192; maximum items 256. |
| given | Given | Required. Array of text; maximum UTF-16 length 8192; maximum items 256. |
| family | Family | Required. Text; maximum UTF-16 length 8192. |
| suffix | Suffix | Required. Array of text; maximum UTF-16 length 8192; maximum items 256. |
| Output field | Interpretation | Returned shape |
|---|---|---|
| parts | Parts | Required. Array of text; maximum UTF-16 length 8192; maximum items 256. |
| display | Display | Required. Text; maximum UTF-16 length 8192. |
{
"input": {
"prefix": [
"Dr"
],
"given": [
"Alex",
"J."
],
"family": "Smith",
"suffix": [
"Jr"
]
},
"output": {
"parts": [
"Dr",
"Alex",
"J.",
"Smith",
"Jr"
],
"display": "Dr Alex J. Smith Jr"
}
}Limitations and assumptions
- Empty arrays and absent family text are allowed; display order is the chosen formatter convention and does not infer cultural preference, identity, or complete FHIR validity.
- 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
Review the complete record, privacy requirements, implementation profile, and verified source context.
References
Similar or alternative tools
- HL7 Person Name Family Given Component Token
Return the first as family, second as given, and all remaining as additional.
- Terminology Code System Token
Return a JSON-array key with version or null when unknown.