GET /provider/searchSingleBest
Endpoint
/provider/searchSingleBest
Description
/provider/searchSingleBest: returns a single result (golden record) for provider search parameters given in query string
The provider/searchSingleBest endpoint is very similar to the search endpoint, however it uses stricter searching rules and only returns the single best result instead of an array of results. The parameters are the same as the search endpoint.
Additional optional search parameters can be appended to the query request. When optional search parameters are used, the golden record match to the primary search parameter will still be returned, even if the optional parameter does not result in a match. Optional search parameters are indicated using a dash after the search parameter in the query request.
Search Parameters
| Parameter | Description |
|---|---|
| NPI | National Provider Identifier |
| Name | full name including first and last |
| FirstName | first name |
| LastName | last name |
| Address | full address including street, city, state, and zip |
| StreetAddress | street address |
| City | city |
| State | state |
| Zip | zip code |
| Phone | 10-digit phone number |
| email address | |
| TaxonomyCode | provider specialty code |
| TaxonomyDescription | description of provider specialty |
| TaxonomyLicense | The license number associated with a provider's specialty |
| OtherIdentifierType | State Medicaid agency, for example |
| OtherIdentifierNumber | Provider Medicaid ID, for example |
| Carrier | insurance plan or network |
| LicenseStatus | True or False |
| LicenseSource | Provider Licensing Registry |
Example Requests and Responses
Example Request
Provider searches can be sent using any of the parameters associated with a provider.
In this example, the request is sent using the provider's full name and state:
GET <https://api.convergent-pd.com/provider/searchSingleBest?FirstName=John&LastName=Doei&State=MD>
https://api.convergent-pd.com/provider/searchSingleBest?FirstName=John&LastName=Doe&State=MD
{
"id": "1r6KinUBea3iGBKrEjHn",
"data": {
"NPI": [
"1780719179"
],
"NPPESEntityType": [
"Individual"
],
"FullName": [
"John Queue Doe"
],
"FullAddress": [
"900 S Caton Ave Fulton MD 21229",
"900 S CATON AVE BALTIMORE MD 21229"
],
"Name": [
{
"FirstName": [
"John"
],
"MiddleName": [
"QuUeue"
],
"LastName": [
"Doe"
],
"NameType": [
"Primary"
]
}
],
"State": [
"MD",
"MD"
],
"Phone": [
"2156948693",
"4109555107"
],
"Address": [
{
"AddressLine1": [
"900 S Caton Ave"
],
"City": [
"Fulton"
],
"AddressState": [
"MD"
],
"Zip": [
"21229"
],
"County": [
"Baltimore City"
],
"AddressType": [
"Public"
]
},
{
"AddressLine1": [
"900 S CATON AVE"
],
"City": [
"BALTIMORE"
],
"AddressState": [
"MD"
],
"Zip": [
"21229"
],
"AddressType": [
"Practice"
]
}
],
"ProviderEnumerationDate": [
"02/23/2007"
],
"Taxonomy": [
{
"TaxonomyDescription": [
"Emergency Medicine"
]
},
{
"TaxonomyDescription": [
"Emergency Medical Services"
]
},
{
"TaxonomyExpirationDate": [
"09/30/2022"
],
"TaxonomyLicenseDate": [
"4/30/2009"
],
"TaxonomyLicense": [
"D0069106"
]
}
],
"LastUpdateDate": [
"07/08/2007"
],
"Gender": [
"M"
],
"IsSoleProprietor": [
"Y"
],
"IdentityDataSource": "nppes",
"SystemCreationDate": "11/02/2020",
"SourceFilename": "phys_roster/phys_roster_4.json",
"DEALookup": [
"F55555555"
],
"DEADrugSchedules": [
"55N55555"
],
"StateCSNumber": [
"M67787"
],
"DEAExpirationDate": [
"20210630"
],
"DEADateofOriginalRegistration": [
"20090612"
],
"ContactId": [
"0030G00002bkAy3QAE"
],
"DEAInput": [
"Fake DEA for ULP"
],
"AccountId": [
"0010G00002KDDYAQA5"
],
"Organization": [
"SAINT AGNES Healthcare"
],
"AccountType": [
"Payor"
],
"ParentAccount": [
"CRISP ULP PROD"
],
"PersonId": [
"a0E0G000017bE3tUAE"
],
"SourceCode": [
"SAH"
],
"AssigningAuthorityCode": [
"SAH"
],
"Email": [
"[email protected]"
],
"Status": [
"A"
],
"BoardCertified": [
"Y"
],
"AcceptMedicaid": [
"Y"
],
"Discipline": [
"N"
]
}
}
Example Response
The response format is nearly the same as the search endpoint, with the one difference being that a single object is returned instead of an array of objects. Thus the root of the document is an object not an array.
Optional Search Parameter
Using an optional search parameter can be helpful in ensuring a potential match is returned.
In the example below, adding the state as an optional search parameter returned the provider.
https://api.convergent-pd.com/api/searchSingleBest?Firstname=Stephanie&Lastname=Brunner&State-=WA
{
"id": "uPEOencBapCiA6FteCAo",
"data": {
"Taxonomy": [
{
"TaxonomyLicense": [
"MD00042898"
]
},
{
"TaxonomyLicense": [
"MD00042898"
],
"TaxonomyCode": [
"208000000X"
],
"TaxonomyDescription": [
"PEDIATRICS"
],
"TaxonomyState": [
"WA"
],
"TaxonomySwitch": [
"TRUE"
]
}
],
"Gender": [
"F"
],
"NPPESEntityType": [
"INDIVIDUAL"
],
"LastUpdateDate": [
"07/08/2007"
],
"FullAddress": [
"22620 SE 4TH ST STE 200 SAMMAMISH WA 980747375"
],
"Name": [
{
"Credential": [
"MD"
],
"FirstName": [
"STEPHANIE"
],
"NameType": [
"PRIMARY"
],
"LastName": [
"BRUNNER"
],
"MiddleName": [
"L"
]
}
],
"State": [
"WA"
],
"NPI": [
"1063584647"
],
"ProviderEnumerationDate": [
"11/15/2006"
],
"FullName": [
"STEPHANIE L BRUNNER"
],
"Address": [
{
"Zip": [
"980747375"
],
"AddressLine1": [
"22620 SE 4TH ST STE 200"
],
"City": [
"SAMMAMISH"
],
"AddressState": [
"WA"
]
},
{
"Zip": [
"980077666"
],
"AddressLine2": [
"SUITE #255"
],
"AddressLine1": [
"14711 NE 29TH PL"
],
"Country": [
"US"
],
"City": [
"BELLEVUE"
],
"AddressType": [
"MAILING"
],
"AddressState": [
"WA"
]
},
{}
],
"IsSoleProprietor": [
"N"
],
"Phone": [
"4258365407"
],
"DEADateOfOriginalRegistration": [
"01/19/2001"
],
"DEABusinessActivityCode": [
"C"
],
"DEALookup": [
"BB7108625"
],
"DEADrugSchedules": [
"22N33N45"
],
"DEAExpirationDate": [
"07/31/2021"
]
}
}
In this second example, searching only on the provider name found multiple matches, so a single best result was not returned.
https://api.convergent-pd.com/api/searchSingleBest?Firstname=Stephanie&Lastname=Brunner
Search returned more than one result.
Use Case
To get only a specific provider result using provider demographics for a unique provider.
Updated 3 months ago