Create Provider Filter

post https://api.ribbonhealth.com/v1/custom/providers/filters

Create new filters to be used when searching for providers in the Search Providers endpoint.
You can create filters for both Ribbon's existing data fields as well as any custom data fields you create.

Example Use Case:

Let's say you add a new field to a bunch of providers that match your use case, for instance c_section_rate. You could make this field searchable so that your search through Search Providers when you pass through a certain parameter that specifies a maximum threshold.

Body Params

The new filter to create

parameter

string

required

The name of filter which will be used when applying to a search

field

string

required

The name of the field that the filter will be applied to

You can specify nested fields by placing a . between each level within the JSON object. For example, educations.education.uuid

value_type

string

required

The data type of the value passed into this filter

filter_type

string

required

The type of comparison that will occur between the value passed into this filter and the field specified in the field parameter

Note that boost filters have several limitations:

A Boost Filter cannot use the following value_types: float
If a Boost Filter's field targets something that is within a list of objects, such as ‘educations.education.name’, we will not reorder the list to bring these items to the front. We will merely boost records where there is an entry in the list that matches the filter, wherever it is.
- There is one exception to this: locations. If you search for a provider and boost fields nested within the locations list, we will reorder the locations to put matching locations first.

Responses

`parameter` name already exists

Language

Credentials

Bearer


xxxxxxxxxx
10
1
curl --request POST \
2
     --url https://api.ribbonhealth.com/v1/custom/providers/filters \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "value_type": "string",
8
  "filter_type": "less_than"
9
}
10
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201The specified filter was successfully created

400The filter you attempted to create was malformed

409A filter with the given parameter name already exists

`parameter` name already exists