Define filters

If you haven't already, check out our high-level overview of how filters work.

When you're ready to define a filter, follow the instructions below.

PHI access

You must have PHI access to define or view filters. Also keep in mind that you can only define filters for data models or FHIR® resources that you receive. If you don't see the data model or resource that you want to define a filter for, then it means that it isn't included with your integration.

  1. Log in to the Redox dashboard.
  2. From the navigation menu, click the Connections page.
  3. All of your connections display on the page. Select the connection that you want to define a filter for.
    Select a connection to view the data flow
    Select a connection to view the data flow
  4. The Data Flow page opens by default for the connection you selected. On this page, find the data model that you want to filter (remember it has to be a data model that you RECEIVE), then click the Settings link.
  5. The Settings page opens. Click the Setup button to define a new filter.
    Open the data model settings
    Open the data model settings
  6. From the Filter mode drop-down, select either Send if or Block all, then select a field that you want to filter and select is in or is not in, then enter the relevant comma-separated values.
    Configure filter fields
    Configure filter fields

    Filters only apply to asynchronous requests of a given data model; they aren't applied to synchronous requests. For example, if you define a filter for the Notes data model, the filter applies to the Notes.New, Notes.Replace, and Notes.Delete requests, but not Notes.Query.

    Learn more about the difference between asynchronous and synchronous requests.

    If you want to define a filter for just one request type, you could do this in some cases by specifying that the Meta.EventType field should contain the value of the request type that you want to filter. If, for example, you want to create a filter so that you’ll receive Notes.New requests but not Notes.Delete, you could set the field to Meta.EventType = New.

    Filters for null values

    It's also possible to filter a specific field by whether it's populated or not. You can do this by treating null as a string value so the filter looks like this: is not in null. You can create this kind of filter so that you don't receive a specific field unless it's populated.

  7. To add a rule for another field, click the plus (+) icon and repeat step 5. To delete a rule, click the minus (-) icon. 
  8. Once you’re finished defining all the necessary rules, click the Save Filter button. Alternatively, you can click the Cancel button to discard the filter.
    Add or delete filter rules
    Add or delete filter rules

    Create filters via API

    You can also create filters via the Redox Platform API. Learn more about the Platform API.