Search for Locations based on Focus Areas
Overiew
Description: Filter and search for locations based on the elements of our Focus Areas product: locations' clinical areas (including the treatments they offer).
Endpoint: /v1/custom/locations
Status: Live
Methods: GET
Example use-case: Develop more customized searches for the care need - for example: as opposed to searching for any Imaging Center, filter to just those that offer Ultrasounds.
Diving In
Searching for locations based on Clinical Areas broadly follows the general functionality of the /locations/ endpoint as described in earlier pages of our documentation. The key difference is that if you have access to Focus Areas data within your custom /locations/ endpoint, you will be able to leverage the parameters below to filter locations accordingly.
A note on applying multiple search criteria simultaneously:
In general, adding multiple search criteria within a parameter that accepts multiple inputs (like entering multiple treatment_ids in the treatment_ids
parameter) produces an OR search (returning all locations that match ANY of the entered criteria)
However, multiple criteria across parameters (e.g. a clinical area criteria and a treatment criteria) produces an AND search, returning only locations that meet both parameters' criteria.
For example:
treatment = Neck X-ray
clinical_area = MRI
Returns locations that offer Neck X-rays AND MRIs.
Search Parameters
You can also use the following parameters for location searches based on clinical areas of focus and treatments offered.
Parameter | Description |
---|---|
clinical_area | String input that is fuzzy matched to the most relevant clinical_area .display field. Only a single clinical area will be selected.Returns all location with this clinical area. |
clinical_area_ids | Comma-separated list of desired clinical area ids. Returns all locations with a clinical area exactly matching any of the entered IDs. (Note: Use the /clinical_areas/ reference endpoint (docs) to identify relevant IDs) |
treatment | String input that is fuzzy matched to the most relevant treatments .display field. Only a single condition will be selected.Returns all locations with this treatment. |
treatment_ids | Comma-separated list of desired condition ids. Returns all locations with a treatments .uuid field exactly matching any of the entered IDs.(Note: Use the /treatments/ reference endpoint (docs) to identify relevant IDs) |
Example Response - Locations
We would be returned a set of providers with knee-related treatments
{
"parameters": {
"page": 1,
"page_size": 25,
"total_count": 80,
"sort_by": "distance",
"distance": 10.0,
"geo": {
"latitude": 40.7351327,
"longitude": -73.9903544
},
"address": "33 Irving Pl, New York, NY 10003, USA",
"treatment": {
"uuid": "e3079513-bf55-41cc-87c6-f7ff5f923085",
"display": "Neck X-ray"
}
},
"data": [
{
"uuid": "17115cf7-d480-4a7a-b2e6-3f078ea5d28b",
"version_id": "989b49c9-7d99-4fdf-9e40-a6dd8e27275b",
"name": "New York Diagnostic Radiology",
"address": "475 6th Ave, New York, NY 10011, US",
"address_details": {
"zip": "10011",
"city": "New York",
"state": "NY",
"street": "475 6th Ave",
"address_line_1": "475 6th Ave",
"address_line_2": null
},
"latitude": 40.7455322,
"longitude": -73.9941974,
"google_maps_link": "",
"phone_numbers": [],
"confidence": 5,
"location_types": [
"Imaging Center"
],
"organizations": [],
"insurances": [],
"npis": [
],
"aha_id": null,
"parent_aha_id": null,
"distance": 0.75,
"clinical_areas": [
{
"uuid": "4c03ddb4-f6c0-4574-a51e-508f83c43d69",
"display": "CT",
"treatments": [
{
"uuid": "ebd1465a-c301-44d6-9c0b-0aff812f386d",
"display": "Abdomen CT"
},
{
"uuid": "06a014b5-5e57-4614-8d52-2402422072f5",
"display": "Abdomen & Pelvis CT"
},
{
"uuid": "2675591d-49bd-425a-941f-897dab02f8e1",
"display": "Chest CT"
}
]
},
{
"uuid": "e9198ea2-60de-404c-85d4-83876fda0383",
"display": "DEXA",
"treatments": [
{
"uuid": "50dc8bf3-6daa-4231-8967-2a3fddf957e7",
"display": "Bone Density Study (DXA)"
}
]
},
{
"uuid": "c72b036b-99eb-447c-be68-867f43231d0b",
"display": "Mammography",
"treatments": [
{
"uuid": "1c44f69b-abd5-4a8f-9ec6-e089f1ec7e07",
"display": "Mammogram"
}
]
}
]
}
]
}
Updated 5 months ago