Facilitate three distinct types of account searches: Healthcare Provider (HCP),
Healthcare Organization (HCO), and license-based searches. For HCP and HCO searches, the API
processes fields from the account, healthcare provider, and contact point address
entities.The license-based searches use fields from the business license entity.
Resource
/connect/life-sciences/commercial/advanced-provider-search
Resource Example
Replace {yourInstance} with the My Domain name of your Salesforce org.
https://{yourInstance}.salesforce.com/services/data/v68.0/connect/life-sciences/commercial/advanced-provider-search?externalSearch=true
Available Version
65.0
HTTP Methods
POST
Query Parameters for POST
| Parameter Name | Type | Description | Required or Optional |
|---|---|---|---|
| externalSearch | Boolean | Indicates whether to perform the search on an external system (true) or not (false. By default, this value is set to false and an internal search is performed. This is a URL parameter, not part of the input representation. | Optional |
Request Body for POST
{
"account": [
{
"field": "Name",
"value": "Robert"
},
{
"field": "AccountNumber",
"value": "123456"
}
],
"healthcareProvider": [
{
"field": "Specialties",
"value": "Robert"
},
{
"field": "PhoneticName",
"value": "Robrt"
}
],
"contactPointAddress": [
{
"field": "IsPrimary",
"value": "false"
},
{
"field": "CountryCode",
"value": "US"
}
],
"businessLicense": [
{
"field": "ComplianceScope",
"value": "Address"
},
{
"field": "LicenseNumber",
"value": "123456"
}
]
}
| Property Name | Type | Description | Required or Optional |
|---|---|---|---|
| account | List<String> | List of account fields and their corresponding search values. At least one field from either account or healthcare provider must be populated. | Optional |
| businessLicense | List<String> | List of business license fields and their corresponding search values. | Optional |
| contactPointAddress | List<String> | List of contact point address fields and their corresponding search values. | Optional |
| healthcareProvider | List<String> | List of healthcare provider fields and their corresponding search values. At least one field from either account or healthcare provider must be populated. | Optional |