Embold Health is the gold standard in physician performance ratings and has created a ratings engine that is best-in-class, independent, and objective. This API exposes these scores along with relevant demographics data in order to power provider finder solutions as well as our own Provider Guide application.
\nFrom within the postman application after the collection has been imported:
\nclient_id and client_secret in bodyaccess_tokenaccess_token to 'CURRENT VALUE' of bearer_token variableNote: These tokens last 1 hour at which time a user will need to follow the above instructions again
\nIn the same variables tab, set a network_slug value (provided by Embold Health). The base_url value is set to the staging API url by default, but can be updated depending on the use case.
After the bearer_token variable is set, navigate to any request and ensure the Authorization (tab) is set to Inherit auth from parent. Follow specific documentation and instructions on using the given endpoint.
Staging API ID
\n","type":"text"},{"key":"client_id","value":"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee","description":"Provided by Embold Health
\n","type":"text"},{"key":"client_secret","value":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","description":"Provided by Embold Health
\n","type":"text"},{"key":"","value":"","type":"text","disabled":true},{"key":"","value":"","type":"text","disabled":true}]},"url":"https://login.microsoftonline.com/282b8276-1b90-4ea6-8f48-cfee19de5292/oauth2/token","description":"This is an example of getting an access_token from Microsoft to be used for authentication with the Embold Health API. This token will expire after 1 hour at which point another token will need to be generated. In order to properly integrate with an application, there are many options for generating bearer tokens with Microsoft that are outside of the scope of this documentation.
This endpoint returns a paginated response of provider objects. It supports common pagination parameters such as limit and offset . It returns values outside of the results such as count, next, and previous. It also provides additional, optional filter_count data for certain filterable fields such as specialty_counts, available_languages, and available_credentials.
Along with the pagination support, we also offer the ability to pass location data via search parameters. These query parameters include:
\nlocation (lat/lon coordinates)radius (by unit or geo hash precision (1-12))bounding_box (in the format of top_right_lat, top_right_lon__bottom_left_lat, bottom_left_lon (e.g 40.73,-71.12__40.01,-74.1)In addition to the above support, this endpoint allows for filtering and sorting on any field that exists in the datasource to which our api is connected. In addition, filtering and sorting can be extended using the following pre/post fixes to query parameters:
\nAny query param key can have the following postfix to be used for filtering:
\n__exact (returns providers with only exact field matches for value)
__contains (returns providers with field that contains value)
__startswith (returns providers with field that starts with value)
__endswith (returns providers with field that ends with value)
__lt (returns providers with field that is less than value)
__lte (returns providers with field that is less than or equal to value)
__gt (returns providers with field that is greater than value)
__gte (returns providers with field that is greater than or equal to value)
__in (returns providers that match each comma delimited value provided)
__exclude (returns providers with field that does not match the value)
Examples:
\n/?specialty_id=2/?score_overall_quality=95/?score_overall_qualtiy__lt=95/?score_overall_qualtiy__lte=95/?score_overall_qualtiy__gt=95/?score_overall_qualtiy__gte=95/?npi__in=100123456,100234567/?first_name__exact=Kimberly/?last_name__startswith=Edordering, we are able to sort on specific values as well as any field that exists in the datasource in which our api is connected. The ordering parameter accepts one or many values (using a comma delimited list of values)best_match <- a culmination of curated bucketing, score, and distancequalitydistancefirst_namelast_namespecialty- to signal ordering desc/?ordering=first_name/?ordering=-first_nameThe examples shown in this documentation show responses with a complete list of available fields. Depending on a client's scope and need, the response object could have fewer fields. This is configured by client and must be communicated and agreed upon by the client and Embold Health.
\n","auth":{"type":"bearer","bearer":{"token":""},"isInherited":true,"source":{"_postman_id":"1532a60d-9ecc-487c-bec5-435699e0b571","id":"1532a60d-9ecc-487c-bec5-435699e0b571","name":"Embold Health API","type":"collection"}},"urlObject":{"path":["providers",""],"host":["https://fusion.staging.emboldhealth.com/api/pg"],"query":[{"disabled":true,"description":{"content":"Integer: Number of results to return per page.
\n","type":"text/plain"},"key":"limit","value":"Integer: The initial index from which to return the results.
\n","type":"text/plain"},"key":"offset","value":"String: Location coordinates in the latitude,longitude format. Ex:30.268504,-97.743178
\n","type":"text/plain"},"key":"location","value":"String: Only return results in this radius or geo hash precision \nSupports the following units for radius: mi, yi, ft, in, km, m, cm, mm, nmi\nEx: 25mi\nIf no units are given, supports a geo hash precision of 1-12
\n","type":"text/plain"},"key":"radius","value":"String: Return results in this box. Must be in the following format: \ntop_right_lat,top_right_lon__bottom_left_lat,bottom_left_lon\n(e.g 40.73,-71.12__40.01,-74.1)
\n","type":"text/plain"},"key":"bounding_box","value":"String: Query multi-match param
\n","type":"text/plain"},"key":"q","value":"String: First and last name of a provider
\n","type":"text/plain"},"key":"entity_name","value":"String: Ex: 'Female', 'Male'
\n","type":"text/plain"},"key":"gender","value":"String: A provider's specialty\nExample: 'Cardiology'
\n","type":"text/plain"},"key":"specialty","value":"Integer: The unique identifier associated with a specialty
\n","type":"text/plain"},"key":"specialty_id","value":"Integer: The unique identifier associated with a subspecialty
\n","type":"text/plain"},"key":"subspecialty_id","value":"Integer: The unique identifier associated with a service
\n","type":"text/plain"},"key":"service_id","value":"String: The order in which search results will return. \nOptions include:
\nComma delimited list of valid NPI integers: Specify one or many NPIs to query. NPIs should be comma delimited\nEx: 1123456789,1123456788
\n","type":"text/plain"},"key":"npi__in","value":"Comma delimited list of languages
\n","type":"text/plain"},"key":"languages","value":"Integer (70-100): score_overall_quality is a 70-100 confidence score derived in our modeling processes\nThis field has an optional __gt (greater than) filter
Integer (70-100): score_overall_quality is a 70-100 confidence score derived in our modeling processes\nThis field has an optional __gte (greater than or equal to) filter
Integer (70-100): score_overall_quality is a 70-100 confidence score derived in our modeling processes\nThis field has an optional __lt (less than) filter
Integer (70-100): score_overall_quality is a 70-100 confidence score derived in our modeling processes\nThis field has an optional __lt (less than) filter
(Required) String: A network slug string associated with a client. Only a valid network_slug will return results
\n","type":"text/plain"},"key":"network_slug","value":""}],"variable":[]}},"response":[{"id":"0555d1dc-a71a-44b6-8f9f-15f4789316b4","name":"Provider Search Schema","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer <This endpoint returns a single provider based on a NPI supplied in the url path. The provider object returned is identical to the individual results objects returned in Provider Search (see above). The difference being that only a network_slug query parameter is necessary and no pagination meta data is needed.
^See query param description for more details on network_slug
(Required) String: A network slug string associated with a client. Only a valid network_slug will return results
\n","type":"text/plain"},"key":"network_slug","value":""},{"disabled":true,"description":{"content":"String: Location coordinates in the latitude,longitude format. Ex:30.268504,-97.743178
\n","type":"text/plain"},"key":"location","value":"This autocomplete endpoint returns 4 subset lists of results (Specialties, Subspecialties, Search Terms, and Providers). In order to be more accurate and restrictive in the results, we strongly encourage using the type query parameter with the value of provider, place, or specialty. As such, this endpoint is used for provider, place, and specialty autocomplete. For the purposes of this documentation, we will treat these three use cases as separate endpoints and describe them only for the specific type that is relevant to the folder that the endpoint is a part of. All examples in this folder will already have the query parameter of type set to 'provider'
As described above, this endpoint can be used to return a list of provider autocomplete results. It accepts the following query parameters:
\nq: (Required) Query multi-match param
location: (Required) Location coordinates in the latitude,longitude format.
radius: (Required) String: Only return results in this radius or geo hash precision.
Supports the following units for radius: mi, yi, ft, in, km, m, cm, mm, nmi
\nIf no units are given, supports a geo hash precision of 1-12
\n*Note: All radius values translate to a geo hash precision, and it is recommended to use the precision value
\nnetwork_slug: (Required)
type: 'provider' - ^see above for more information
The providers subset of this endpoint's response has a limit of 25 results. See examples for response schema and example values.
\n","auth":{"type":"bearer","bearer":{"token":""},"isInherited":true,"source":{"_postman_id":"1532a60d-9ecc-487c-bec5-435699e0b571","id":"1532a60d-9ecc-487c-bec5-435699e0b571","name":"Embold Health API","type":"collection"}},"urlObject":{"path":["autocomplete",""],"host":["https://fusion.staging.emboldhealth.com/api/pg"],"query":[{"description":{"content":"(Required) String: Query multi-match param
\n","type":"text/plain"},"key":"q","value":"(Required) String: Location coordinates in the latitude,longitude format. Ex:30.268504,-97.743178
\n","type":"text/plain"},"key":"location","value":"(Required) String: Only return results in this radius or geo hash precision \nSupports the following units for radius: mi, yi, ft, in, km, m, cm, mm, nmi\nEx: 25mi\nIf no units are given, supports a geo hash precision of 1-12
\n","type":"text/plain"},"key":"radius","value":"(Required) String: A network slug string associated with a client. Only valid a valid network_slug will return results
\n","type":"text/plain"},"key":"network_slug","value":""},{"description":{"content":"String: Type of results to return. Choices are 'provider' and 'specialty'. If neither are provided, the search will return results for both types.
\n","type":"text/plain"},"key":"type","value":"provider"}],"variable":[]}},"response":[{"id":"a063966b-ea5d-4627-be90-ec596af86219","name":"Provider Autocomplete Schema","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer <This endpoint returns a paginated response of place objects. It supports common pagination parameters such as limit and offset . It returns values outside of the results such as count, next, and previous.
Along with the pagination support, we also offer the ability to pass location data via search parameters. These query parameters include:
\nlocation (lat/lon coordinates)radius (by unit or geo hash precision (1-12))bounding_box (in the format of top_right_lat, top_right_lon__bottom_left_lat, bottom_left_lon (e.g 40.73,-71.12__40.01,-74.1)In addition to the above support, this endpoint allows for filtering and sorting on any field that exists in the datasource to which our api is connected.
\n/?state=TN/?city=Nashville/?hospital_grade=A/?name__exact=Vanderbilt Childrens Hospitalordering, we are able to sort on specific values as well as any field that exists in the datasource in which our api is connected. The ordering parameter accepts one or many values (using a comma delimited list of values)distance- In order to use this value, the query parameter of location is requirednamehospital_grade- to signal ordering desc/?ordering=name/?ordering=-nameInteger: Number of results to return per page.
\n","type":"text/plain"},"key":"limit","value":"Integer: The initial index from which to return the results.
\n","type":"text/plain"},"key":"offset","value":"String: The order in which search results will return. \nOptions include:
\nString: Query multi-match param
\n","type":"text/plain"},"key":"q","value":"String: Location coordinates in the latitude,longitude format. Ex:30.268504,-97.743178
\n","type":"text/plain"},"key":"location","value":"String: Return results in this box. Must be in the following format: \ntop_right_lat,top_right_lon__bottom_left_lat,bottom_left_lon\n(e.g 40.73,-71.12__40.01,-74.1)
\n","type":"text/plain"},"key":"bounding_box","value":"String: Only return results in this radius or geo hash precision \nSupports the following units for radius: mi, yi, ft, in, km, m, cm, mm, nmi\nEx: 25mi\nIf no units are given, supports a geo hash precision of 1-12
\n","type":"text/plain"},"key":"radius","value":"(Required) String: A network slug string associated with a client. Only a valid network_slug will return results
\n","type":"text/plain"},"key":"network_slug","value":""},{"disabled":true,"description":{"content":"Integer: Return places that have the provided npi.
\n","type":"text/plain"},"key":"npi","value":"Comma delimited list of valid NPI integers: Specify one or many NPIs to query. NPIs should be comma delimited\nEx: 1123456789,1123456788
\n","type":"text/plain"},"key":"npi__in","value":"String: Name of place.
\n","type":"text/plain"},"key":"name","value":"String: Pipe delemited list of specailization abbreviations (must be in all caps). Ex: LAB|HOSP\nOptions:
\nString: Letter representation for the type of place.\nOptions:
\nString: Hospital Safety Grade\nOptions:
\n