GET/organization/searchSingleBest
Endpoint
/organization/searchSingleBest
Description
/organization/searchSingleBest: returns a single result (golden record) for organization search parameters given in query string
The organization/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 |
---|---|
Name | organization 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 |
PlanStatus | True or False |
Carrier | insurance plan or network |
LicenseStatus | True or False |
LicenseSource | Licensing Registry |
Example Requests and Responses
Example Request
https://api.convergent-pd.com/organization/searchSingleBest?name=clinic%20llc
https://api.convergent-pd.com/organization/searchSingleBest?name=clinic%20llc
{
"id": "kiuOd3gBMPBQXTJ6csZ6",
"data": {
"OtherIdentifier": [
{
"OtherIdentifierType": [
"05"
],
"OtherIdentifierNumber": [
"4567890"
],
"OtherIdentifierState": [
"MD"
]
}
],
"NPPESEntityType": [
"ORGANIZATION"
],
"IsOrganizationSubpart": [
"N"
],
"LastUpdateDate": [
"03/16/2012"
],
"FullAddress": [
"7050 MAIN STREET RD SUITE 1 COLUMBIA MD 210469999 US"
],
"Name": [
"A CLINIC LLC"
],
"NPI": [
"99999999"
],
"OtherOrgType": [
"3"
],
"ProviderEnumerationDate": [
"10/23/2007"
],
"Address": [
{
"Zip": [
"21046"
],
"AddressLine2": [
"SUITE 1"
],
"AddressLine1": [
"7050 MAIN STREET RD"
],
"FaxPhoneNumber": [
"4431234567"
],
"Country": [
"US"
],
"AddressPhone": [
"4431234567"
],
"City": [
"COLUMBIA"
],
"AddressType": [
"MAILING"
],
"AddressState": [
"MD"
]
},
{
"Zip": [
"21046"
],
"AddressLine2": [
"SUITE 1"
],
"AddressLine1": [
"7050 MAIN STREET RD"
],
"FaxPhoneNumber": [
"4431234567"
],
"Country": [
"US"
],
"AddressPhone": [
"4431234567"
],
"City": [
"COLUMBIA"
],
"AddressType": [
"PRACTICE"
],
"AddressState": [
"MD"
]
}
],
"AuthorizedName": [
{
"Credential": [
"LCSW-C"
],
"TitlePosition": [
"PARTNER"
],
"FirstName": [
"JANE"
],
"NameType": [
"AUTHORIZED"
],
"Prefix": [
"MS."
],
"LastName": [
"DOE"
],
"MiddleName": [
"ANNE"
]
}
],
"Taxonomy": [
{
"TaxonomyCode": [
"1041C0700X"
],
"TaxonomyDescription": [
"SOCIAL WORKER CLINICAL"
],
"TaxonomySwitch": [
"TRUE"
],
"TaxonomyGroup": [
"193400000X SINGLE SPECIALTY GROUP"
]
}
],
"EmployerIdentificationNumber": [
"99999999"
],
"Status": [
"ACTIVE - PAY (FEDERAL AND STATE)"
],
"EnrollmentEndDate": [
"12/31/9999"
],
"EnrollmentStartDate": [
"05/01/2007"
],
"OrganizationType": [
"GROUP PRACTICE"
]
}
}
Use Case
To get only a specific organization result using organization demographics for a unique organization.
Updated over 3 years ago