Salesforce Docs Portal

FHIR Address Input

Input representation for the Address FHIR object.

The Address FHIR object maps to the ContactPointAddress object in Salesforce.

JSON example

{
   "address": [ {
      "use": "temp",
      "type": "postal",
      "city": "San Francisco",
      "state": "California",
      "country": "U.S",
      "postalCode": "12345",
      "line": "Salesforce",
      "periodStart": "1999-11-09T15:40:30.000Z",
      "periodEnd": "20202-01-02T15: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
city String The city of the address. Optional 53.0
country String The country of the address. Optional 53.0
line String The street of the address. Optional 53.0
periodEnd String The date until when the address is active. Optional 53.0
periodStart String The date from when the address is active. Optional 53.0
postalCode String The postal code for the address. Optional 53.0
state String The state or province of the address. Optional 53.0
type String The type of address. For example, postal and physical. Optional 53.0
use String The usage type of the address. Optional 53.0