The Identifier FHIR object maps to the Identifier object in Salesforce.
Root XML tag
<FhirIdentifierInput>
JSON example
{
"identifier": [ {
"assigner": {
"referenceResource": "Organization",
"referenceId": "XYZId"
},
"type": {
"text": "Passport number",
"coding": [ {
"display": "Passport number",
"code": "PPN",
"isActive": true,
"use": "Identifier"
} ]
},
"value": "ABCD5678",
"use": "Official",
"periodStart": "1998-05-26T15:40:30.000Z",
"periodEnd": "2021-08-09T15:40:30.000Z",
"sourceSystem": "http://sfdc.co",
"sourceSystemId": "567890",
"sourceSystemModified": "2012-07-26T15:40:30.000Z"
} ]
}
Properties
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| additional​Information | Custom Field Value Input[] | Adds additional information to any fields not mapped in this API. | Optional | 53.0 |
| assigner | FHIR Reference Input | The authorized body that issued the identifier, stored as a reference to the Account object. | Optional | 53.0 |
| periodEnd | String | The date and time until when the Identifier is active, recorded in DateTime format. | Optional | 53.0 |
| periodStart | String | The date and time from when the Identifier is active, recorded in DateTime format. | Optional | 53.0 |
| sourceSystem | String | The source system from which the identifier record was brought into Salesforce. | Optional | 53.0 |
| sourceSystemId | String | The identifier of the identifier record in its source system. | Optional | 53.0 |
| sourceSystemModifiedDate | String | The date and time when the identifier record was last modified in its source system. | Optional | 53.0 |
| type | FHIR Codeable Concept Input | The system-defined code that represents the type of ID the identifier record is. | Optional | 53.0 |
| use | String | The usage type of the Identifier record. | Optional | 53.0 |
| value | String | The value associated with an Identifier record. | Optional | 53.0 |