Newer Version Available
Advanced Provider Search
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
-
1/connect/life-sciences/commercial/advanced-provider-search - Resource Example
-
1https://yourInstance.salesforce.com/services/data/v66.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
-
1{ 2 "account": [ 3 { 4 "field": "Name", 5 "value": "Robert" 6 }, 7 { 8 "field": "AccountNumber", 9 "value": "123456" 10 } 11 ], 12 "healthcareProvider": [ 13 { 14 "field": "Specialties", 15 "value": "Robert" 16 }, 17 { 18 "field": "PhoneticName", 19 "value": "Robrt" 20 } 21 ], 22 "contactPointAddress": [ 23 { 24 "field": "IsPrimary", 25 "value": "false" 26 }, 27 { 28 "field": "CountryCode", 29"value": "US" 30 } 31 ], 32 "businessLicense": [ 33 { 34 "field": "ComplianceScope", 35 "value": "Address" 36 }, 37 { 38 "field": "LicenseNumber", 39 "value": "123456" 40 } 41 ] 42}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 - Response body for POST
- Provider Search Output