You are here:
InsProviderNetworkService:getProvidersByNameOrNPI
Use this service to allow users to search for Providers using a search key.
Method:getProvidersByNameOrNPI
How It Works
-
The service retrieves Provider records where the Firstname, Lastname, or NPI (ProviderIdentifier__c) starts with the
searchKey. -
The resulting list is returned as part of the output JSON in the result node.
User Inputs
Input |
Description |
|---|---|
|
String Used to check against FirstName, LastName, or Provider NPI. |
Input JSON
JSON input is formatted like this:
{
"searchKey": <search string>
}Sample JSON input with data:
{
"searchKey": "John"
}Output JSON
JSON output is formatted like this:
{
"searchKey": <search string>,
"result": [
{
"Name": <Contact.name field value>,
"FirstName": <Contact.FirstName field value>,
"LastName": <Contact.LastName field value>,
"ProviderIdentifier__c": <Contact.ProviderIdentifier__c field value>,
"Id": <Contact record ID>,
"RecordTypeId": <Contact Record Type>
}
],
"error": "OK"
}Sample JSON output with data, with searchKey
Joh. Notice how John and Johann are returned in
the result.
{
"searchKey": "Joh",
"result": [
{
"Name": "John Smith",
"FirstName": "John",
"LastName": "Smith",
"ProviderIdentifier__c": "DE0049",
"Id": "0035w0000396WMzAAM",
"RecordTypeId": "0125w000001FVCuAAO"
},
{
"Name": "Leslie Johann",
"FirstName": "Leslie",
"LastName": "Johann",
"Id": "0035w00003976D2AAI",
"RecordTypeId": "0125w000001FVCuAAO"
},
],
"error": "OK"
}
