GET/provider/search
Endpoint
/provider/search
Description
/provider/search: returns all matches to provider search parameters given in query string
Search Parameters
Parameter | Description |
---|---|
NPI | The provider's National Provider Identifier |
Name | full name including first and last |
FirstName | The provider's first name |
LastName | The provider's last name |
Address | The provider's full address including street, city, state, and zip |
AddressType | Enables you to narrow a search on any address parameter to either the provider's mailing or practice address |
StreetAddress | The provider's street address |
City | The provider's city |
State | The provider's state |
Zip | The provider's zip code |
Phone | The provider's 10-digit phone number |
The provider's email address | |
Organization | Legal name of the group that the individual clinician works with |
TaxonomyCode | The provider's specialty code, depending on the TaxonomySystem |
TaxonomySystem | Identifes the source system for a given specialty code and description. (e.g. CMS, SNOMED, HL7, etc.) |
TaxonomyDescription | Description of provider specialty |
TaxonomyLicense | A provider's unique ID to practice medicine in the state in which they are licensed |
TaxonomyState | The state a provider is licensed to practice |
ProviderType | The role an individual provider performs |
Carrier | The name of a carrier the provider is in-network with |
PlanName | The name of the plan or plans associated with the carrier the provider is in-network with |
PlanType | The type of insurance plan |
AcceptingPatients | Set to true for providers who are accepting new patients and false for providers who are not. |
HospitalAffiliation | Legal business name of the hospital where individual clinician provides service |
OtherIdentifier | A nested set of fields used to display identifiers defined by the OtherIdentifierType and OtherIdentifierIssuer |
OtherIdentifierType | OtherIdentifiers are defined by the following OtherIdentifierTypes: 01 - OTHER 03 - Medicare ID 04 - OASAS ID 05 - Medicaid Number 09 - MA Number 10 - CAQH # 11 - Veradigm 12 - Epic 13 - CMS Contract ID 14 - Compensation Grid ID |
Pagination: Optional
Page (defaults to 0)
Size (defaults to 25)
Example Request and Response
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:
GEThttps://api.convergent-pd.com/provider/search?FirstName=John&LastName=Doe&State=MD
https://api.convergent-pd.com/provider/search?FirstName=John&LastName=Doe&State=MD
{
"id": "Ot2iWXkBm52O8PH1DbBy",
"data":
{
"FullAddress":
[
"131 W 35TH ST FL 7 NEW YORK NY 100012111",
"1 GUSTAVE L LEVY PL NEW YORK NY 100296504",
"1111 AMSTERDAM AVE NEW YORK NY 100251716",
"1110 PENNSYLVANIA AVE SUITE 14 BROOKLYN NY 112079061",
"1041 3RD AVE SUITE 200 NEW YORK NY 100658114",
"2329 NOSTRAND AVE FL 6 BROOKLYN NY 112103936",
"8718 BAY PKWY FL 1-2 BROOKLYN NY 112145272 US",
"8718 BAY PARKWAY FLOOR 1-2 BROOKLYN NY 112140000"
],
"Address":
[
{
"Zip":
[
"112140000"
],
"AddressLine2":
[
"FLOOR 1-2"
],
"AddressLine1":
[
"8718 BAY PARKWAY"
],
"City":
[
"BROOKLYN"
],
"AddressType":
[
"PRACTICE"
],
"AddressState":
[
"NY"
]
},
{
"Zip":
[
"112145272"
],
"AddressLine1":
[
"8718 BAY PKWY FL 1-2"
],
"FaxPhoneNumber":
[
"7182661426"
],
"Country":
[
"US"
],
"AddressPhone":
[
"7182660900"
],
"City":
[
"BROOKLYN"
],
"AddressType":
[
"MAILING"
],
"AddressState":
[
"NY"
]
},
{
"Zip":
[
"112145272"
],
"AddressLine1":
[
"8718 BAY PKWY FL 1-2"
],
"Country":
[
"US"
],
"AddressPhone":
[
"7182660900"
],
"City":
[
"BROOKLYN"
],
"AddressType":
[
"PRACTICE"
],
"AddressState":
[
"NY"
]
},
{
"Zip":
[
"112103936"
],
"AddressLine2":
[
"FL 6"
],
"AddressLine1":
[
"2329 NOSTRAND AVE"
],
"AddressPhone":
[
"7188590046"
],
"City":
[
"BROOKLYN"
],
"AddressType":
[
"PRACTICE"
],
"AddressState":
[
"NY"
]
},
{
"Zip":
[
"100658114"
],
"AddressLine2":
[
"SUITE 200"
],
"AddressLine1":
[
"1041 3RD AVE"
],
"AddressPhone":
[
"7182660900"
],
"City":
[
"NEW YORK"
],
"AddressType":
[
"PRACTICE"
],
"AddressState":
[
"NY"
]
},
{
"Zip":
[
"112079061"
],
"AddressLine2":
[
"SUITE 14"
],
"AddressLine1":
[
"1110 PENNSYLVANIA AVE"
],
"AddressPhone":
[
"7182570900"
],
"City":
[
"BROOKLYN"
],
"AddressType":
[
"PRACTICE"
],
"AddressState":
[
"NY"
]
},
{
"Zip":
[
"100251716"
],
"AddressLine1":
[
"1111 AMSTERDAM AVE"
],
"AddressPhone":
[
"7182660900"
],
"City":
[
"NEW YORK"
],
"AddressType":
[
"PRACTICE"
],
"AddressState":
[
"NY"
]
},
{
"Zip":
[
"100296504"
],
"AddressLine1":
[
"1 GUSTAVE L LEVY PL"
],
"AddressPhone":
[
"2127317822"
],
"City":
[
"NEW YORK"
],
"AddressType":
[
"PRACTICE"
],
"AddressState":
[
"NY"
]
},
{
"Zip":
[
"100012111"
],
"AddressLine2":
[
"FL 7"
],
"AddressLine1":
[
"131 W 35TH ST"
],
"AddressPhone":
[
"2124758066"
],
"City":
[
"NEW YORK"
],
"AddressType":
[
"PRACTICE"
],
"AddressState":
[
"NY"
]
}
],
"HospitalAffiliation":
[
{
"HospitalName":
[
"MOUNT SINAI ST LUKE'S ROOSEVELT HOSPITAL"
],
"MedicareCCN":
[
"330046"
]
},
{
"HospitalName":
[
"MOUNT SINAI BETH ISRAEL"
],
"MedicareCCN":
[
"330169"
]
}
],
"Gender":
[
"M"
],
"Name":
[
{
"Credential":
[
"M.D."
],
"FirstName":
[
"NAVEED"
],
"NameType":
[
"PRIMARY"
],
"Prefix":
[
"DR."
],
"LastName":
[
"RAJPER"
],
"MiddleName":
[
"ALI"
]
}
],
"State":
[
"NY"
],
"Taxonomy":
[
{
"TaxonomyDescription":
[
"INTERVENTIONAL CARDIOLOGY"
],
"TaxonomySwitch":
[
"Y"
]
},
{
"TaxonomyLicense":
[
"282463"
],
"TaxonomyCode":
[
"207RI0011X"
],
"TaxonomySystem":
[
"https://nucc.org/images/stories/csv/nucc_taxonomy_201.csv"
],
"TaxonomyDescription":
[
"INTERNAL MEDICINE INTERVENTIONAL CARDIOLOGY"
],
"TaxonomyState":
[
"NY"
],
"TaxonomySwitch":
[
"TRUE"
]
},
{
"TaxonomyLicense":
[
"282463-1"
]
}
],
"NPI":
[
"1114226354"
],
"Phone":
[
"7182660900"
],
"GradYear":
[
"2006"
],
"MedSchool":
[
"OTHER"
],
"FullName":
[
"NAVEED ALI RAJPER"
],
"NPPESEntityType":
[
"INDIVIDUAL"
]
}
}
Example Response
The response is a JSON object containing the total number of results and a results array with 0, 1, or many results. The maximum number of results can be controlled with the Size parameter. Each result contains some metadata and a golden record object with the id and data (field values) of the result. The term golden record refers to the fact that the data returned for each result does not represent any one individual source record; rather it is a composite record combining the best available data from across multiple sources.
If there are no matches then the total number of results is 0 and the results array is empty.
{
"goldenRecord": {
"id": "FVMcz4ABFzVTNDCeN85U",
"data": {
"FullAddress": [
"1 GUSTAVE L LEVY PL NEW YORK NY 10029-6504"
],
"Organization": [
"ICAHN SCHOOL OF MEDICINE AT MOUNT SINAI"
],
"Address": [
{
"Zip": [
"10029-6504"
],
"AddressLine1": [
"1 GUSTAVE L LEVY PL"
],
"AddressPhone": [
"(212) 731-7822"
],
"City": [
"NEW YORK"
],
"AddressType": [
"PRACTICE"
],
"AddressState": [
"NY"
],
"SSACountyCode": [
"33420"
],
"CountyFIPs": [
"36061"
],
"RDI": [
"COMMERCIAL"
],
"County": [
"NEW YORK"
],
"Location": [
"40.79055,-73.95383"
]
}
],
"Taxonomy": [
{
"TaxonomyCode": [
"06"
],
"TaxonomySystem": [
"https://data.cms.gov/provider-characteristics/medicare-provider-supplier-enrollment/medicare-provider-and-supplier-taxonomy-crosswalk"
],
"TaxonomyDescription": [
"CARDIOVASCULAR DISEASE (CARDIOLOGY)"
]
},
{
"TaxonomyCode": [
"008"
],
"TaxonomySystem": [
"https://www.cms.gov/files/document/medicareadvantageandsection1876costplannetworkadequacyguidance6-17-2020.pdf"
],
"TaxonomyDescription": [
"CARDIOLOGY"
]
},
{
"TaxonomyDescription": [
"CARDIOVASCULAR DISEASE (CARDIOLOGY)"
],
"TaxonomySwitch": [
"TRUE"
]
}
],
"HospitalAffiliation": [
{
"HospitalName": [
"MOUNT SINAI ST LUKE'S ROOSEVELT HOSPITAL"
],
"MedicareCCN": [
"330046"
]
}
],
"NPI": [
"1871913830"
],
"Gender": [
"M"
],
"Name": [
{
"FirstName": [
"PAUL"
],
"NameType": [
"PRIMARY"
],
"LastName": [
"LEIS"
]
}
],
"NPPESEntityType": [
"INDIVIDUAL"
],
"OtherIdentifier": [
{
"OtherIdentifierType": [
"5"
],
"OtherIdentifierNumber": [
"04796241"
],
"OtherIdentifierIssuer": [
"NEW YORK STATE DEPARTMENT OF HEALTH"
],
"OtherIdentifierState": [
"NY"
]
}
],
"Insurances": [
{
"ContractStartDate": [
"03/23/2017"
],
"PlanState": [
"NY"
],
"ContractEndDate": [
"05/01/2024"
],
"PlanType": [
"FFS"
],
"Carrier": [
"NEW YORK MEDICAID"
],
"PlanStatus": [
"TRUE"
]
}
],
"ProviderType": [
"PHYSICIAN"
],
"DEALookup": [
"FL5555555"
],
"DEADrugSchedules": [
"22555555"
],
"DEAExpirationDate": [
"03/31/2023"
],
"DEABusinessActivityCode": [
"C"
],
"DEABusinessActivitySubcode": [
"0"
]
}
},
"score": 11.768958,
"explanation": null,
"explanationId": null
}
Use Case
To get a list of all possible matches for the searched provider demographics.
Updated 10 months ago