FHIR Human Name Input

The Human​Name FHIR object maps to the Person​Name object in Salesforce​.

JSON example

1"humanName": [
2    {
3      "use": "Official",
4      "text": "Charles Green",
5      "family": "Green",
6      "given": "Charles",
7      "prefix": "Mr.",
8      "suffix": "Jr.",
9      "periodStart": "1998-05-26T15:40:30.000Z",
10      "periodEnd": "2021-08-09T15:40:30.000Z",
11      "sourceSystem": "http://sfdc.co",
12      "sourceSystemId": "567890",
13      "sourceSystemModified": "2012-07-26T15:40:30.000Z"
14    }
15  ]

Properties

Name	Type	Description	Required or Optional	Available Version
additional​Information	Custom Field Value[]	Adds additional information to any fields not mapped in this API.	Optional	53.0
family	String	The last name of the patient. This field stores a combination of the patient’s middle and last name.	Optional	53.0
given	String	The first name of the patient.	Optional	53.0
periodEnd	String	The date until when the name is active.	Optional	53.0
periodStart	String	The date from when the name is active.	Optional	53.0
prefix	String	The prefix of the name.	Optional	53.0
sourceSystem	String	The source system from where the humanName is brought into Health Cloud.	Optional	53.0
sourceSystemId	String	The identifier of the humanName record in its source system.	Optional	53.0
sourceSystem​ModifiedDate	String	The date and time when the humanName record was last modified in its source system.	Optional	53.0
suffix	String	The suffix of the name.	Optional	53.0
text	String	The full name of the person.	Optional	53.0
use	String	The usage type of the name.	Optional	53.0