Upsert Provider

Resource

/connect/health/providers

Available version

52.0 and later

Authentication

Authorization: Bearer token

The Lightning Platform REST API supports OAuth 2.0 (an open protocol to allow secure API authorization). See Authorize Apps with OAuth in Salesforce Help for more details.

Note

HTTP methods

PATCH

Supported Objects

You can create either a practitioner or a facility. A facility is always associated with an account. A practitioner can be associated with a contact or a person account.

• You can edit up to 25 provider records at a time.
• Use the API name of the field (such as RecordType), not the label (such as "Record Type").
• Strings with trailing spaces are not supported.

Sample Input: Update an Existing Practitioner Field and Insert New Practitioner Fields

Here's what your JSON request body might look like when you change the last name on a practitioner's person account, and also specify that the practitioner is a doctor in a solo practice.

{
   "providers":[      
      {
         "type":"practitioner",
         "account":{
            "id":{
               "value":"001B000001MVfilIAD",
               "referenceField":"Id"
            },
            "fields":{
               "LastName":"Stewart1"
            }
         }
         "healthcareProvider":{
            "fields":{
               "ProviderType":"Medical Doctor",
               "ProviderClass":"Solo Practitioner"
            }
         }
      }
   ]
}

Sample Input: Update an Existing Facility and Practitioner Field for a Provider and Insert New Fields

Here's what it might look like when you change the last name of a practitioner and also specify that the practitioner is a doctor in a solo practice. (A solo practice is treated as a facility with a single practitioner attached to it.)

{
   "providers":[
      {
         "type":"facility",
         "account":{
            "id":{
               "value":"001B000001MVfhEIAT",
               "referenceField":"Id"
            },
            "fields":{
               "Name":"Public Hospital 1"
            }
         },
         "healthcareProvider":{            
            "fields":{
               "ProviderType":"Medical Doctor",
               "ProviderClass":"Solo Practitioner"
            }
         }
      },
      {
         "type":"practitioner",
         "contact":{
            "id":{
               "value":"003B000000IqubiIAB",
               "referenceField":"Id"
            },
            "fields":{
               "LastName":"King1"
            }
         },
         "healthcareProvider":{
            "fields":{
               "ProviderType":"Medical Doctor",
               "ProviderClass":"Solo Practitioner"
            }
         }
      }
   ]
}

Response Codes