FHIR Human Name

The output representation of a PersonName record created to represent a humanName value.

Property NameTypeDescriptionFilter Group and VersionAvailable Version
additional​InformationCustom Field Value[]The data stored in any custom fields as specified in the input request.Small, 53.053.0
familyStringThe family name of the patient. This field stores a combination of the person’s middle and last names.Small, 53.053.0
givenStringThe first name of the person.Small, 53.053.0
messageStringA message with any errors that can encounter while processing the request.Small, 53.053.0
periodEndStringThe date until when the name is active.Small, 53.053.0
periodStartStringThe date from when the name is active.Small, 53.053.0
prefixStringThe prefix attached to the person’s name.Small, 53.053.0
salesforceIdStringThe Salesforce ID of the PersonName record created to store the humanName value.Small, 53.053.0
sourceSystemStringThe source system from where the PersonName record was brought into Salesforce.Small, 53.053.0
sourceSystemIdStringThe identifier of the person name record in its source system.Small, 53.053.0
sourceSystem​ModifiedDateStringThe date and time when the person name record was last modified in its source system.Small, 53.053.0
suffixStringThe suffix attached to the person’s name.Small, 53.053.0
textStringThe full name of the person.Small, 53.053.0
useStringThe type of use the name is meant for. For example, temp, official, or alias.Small, 53.053.0