Define and manage filters

Filters can be useful for async traffic that you receive. You can apply filters to either data models or FHIR® notifications. Learn about filters.

1. Log in to the 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.
4. The Subscriptions page opens by default for the connection you selected. On this page, find the data model or FHIR® notification that you want to filter. Remember, it has to be one that you RECEIVE. Click the Settings link.
5. The Settings page opens. Click the Define filter button.

   

   Why can’t I see filters?

   There are a couple of reasons you may not be able to view a filter.

   1. You can only have filters for data models or FHIR® notifications that you RECEIVE. If you don’t see filter options for a subscription, it’s probably not for incoming traffic.
   2. You may not have a particular data model or notification included in your subscription. If you don’t see the data model or notification you expected, check with your Technical Account Manager.

6. Follow the next set of instructions based on the type of filter you want to create.

It may be useful to block traffic for a particular subscription during the implementation phase.

1. From the Filter mode drop-down, select the Block all option.
2. Click the Save Filter button.

   
3. Your new filter is saved and all traffic for the selected subscription will be restricted until the filter is removed.

   Filter details in logs

   The filtered status and details will appear in related logs. Learn about filter statuses and outcomes.

These are the most common type of filters, which allow you to moderate the async traffic that you receive from one of your connections.

1. From the Filter mode drop-down, select the Send if option.
2. A set of three fields appears. Click the Select Field Path drop-down to view a list of fields.
3. Select the field you want to filter.
4. A modal opens for testing the field path and value. You can change your selection by clicking the Field Path drop-down again to view a list of fields.

   

   Advanced editing for FHIR filters

   For FHIR® filters, you can click the Switch to Template Mode link to enter advanced editing mode.

   In this mode, the Field Path becomes editable so you can directly edit the field path or enter one that doesn't appear in the drop-down list. We don't recommend advanced editing for FHIR® beginners.

   

   You can also click the JSON Path Expressions link to open help text definitions.

5. Once you have the correct path, use the validation tools to test your choice. Or, if you don’t want to test, you can skip and proceed to the next step.
   1. Find a log payload for the subscription you want to filter. Learn more about searching for logs.

      
   2. Copy and paste the log payload into the Test Message section.

      
   3. On the right side of the modal, under Field Values, the value that displays is the one found at the field path you selected. For a FHIR® filter, you have the option to toggle between Field Values and Output Paths to test that you have both correct. The value tells you what value would be filtered, and the path tells you the location in the FHIR® payload.

      
6. Keep in mind that Redox doesn’t validate the filter like this. But it does give you an idea of whether you selected the right field path by using an existing log payload.
7. Click the Select Path button on the bottom right of the modal.
8. The modal closes. In the next drop-down, select is in or is not in. Remember that is in means the field path value must equal something in the defined value set. On the other hand, is not in means that the field path value must not equal any of the defined value set.
9. Enter the relevant comma-separated values.

   

   Filters for data model event types

   Remember that filters only apply to async event types. So as an example, if you define a filter for the Notes data model, the filter applies to the Notes.New, Notes.Replace, and Notes.Delete event types. But it doesn't apply to Notes.Query. Learn more about the difference between async and sync event types.

   On the flip side, if you only want to receive one event type, you can define a filter for the $.Meta.EventType field. Then select is in and enter the event type name as the value to filter. For example, if you only want to receive Notes.New event types, set the field to $.Meta.EventType = New. With this filter, you won't receive Notes.Replace, and Notes.Delete event types.

10. To add a rule for another field, click the plus (+) icon. Populate the fields for the new rule.
11. Once you’ve finished defining all the necessary rules, click the Save Filter button. Alternatively, you can click the Cancel button to discard the filter.

    

    Filter details in logs

    The filtered status and details will appear in related logs. Learn about filter statuses and outcomes.

Follow these instructions to review all the filters in your environment at once.

1. Log in to the Redox dashboard.
2. From the side nav menu, click the Operations drop-down.
3. The Operations options expand. Click the Filters option.

   
4. All existing filters in the environment display.

There are two ways you can edit a filter.

1. Follow the instructions to view existing filters.
2. From the list of existing filters, click on the filter with links you want to review or manage.
3. The Settings page opens. Under the Links section, an existing link will display or you can add a link.

   Only one link allowed

   You can only have one link per filter. To add a new link, you have to delete the existing link.

   1. To view an existing link in context, click the link to open related logs.
   2. To delete an existing link, click the Delete icon to the right of the subscription. A modal opens to confirm that you want to proceed. Click the Delete button to continue or the Cancel button to discard the changes.
   3. To add a new link, select a connection from the Connection drop-down.
      1. Next, click the Select subscription link.
      2. A modal opens with the available subscriptions for the selected connection. Use the Search field or the Connection drop-down to narrow down the available options. If needed, use the page options at the bottom of the modal to navigate through the pages. Then select the radio button of the subscription you want to link the config modifier to.
      3. Click the Select Subscription button.

After testing in staging, you can promote a filter to production. Learn about promoting assets.

1. Log in to the Redox dashboard.
2. From the Environments drop-down, select the Staging environment.

   
3. From the side nav menu, click the Operations drop-down.
4. The Operations options expand. Click the Filters option.

   
5. All existing filters in the environment display. Click on the filter you want to promote.
6. The Settings page opens. Click the Promote button.
7. A modal appears to let you know you’re exiting the staging environment and proceeding to the production environment. Click the Proceed button. Otherwise, click the Cancel button to discard the promotion.

   
8. The Settings page in the production environment opens.
   1. To make any changes to the filter, click the Go to Staging button.

      
   2. A modal appears to confirm that you want to switch environments. Click the Proceed button to continue.
   3. The filter settings page opens in the staging environment. From there, click the Edit button, then follow the instructions to edit a filter.
   4. Once changes are successfully made, re-promote the filter to keep the assets in sync across environments.
9. Next, add link(s) to subscriptions to apply the filter in your production environment.

You can restore a version of a filter that’s not currently in use. This may be helpful when troubleshooting to see where an error may have been introduced or to resolve an error by using a version that worked previously.

1. Follow the instructions for viewing existing filters.
2. From the list of existing filters, click on the filter you want to update.
3. The Settings page opens. Click the Restore button.

   
4. A modal appears to restore a version. From the drop-down, select a version to restore.

   Restore notes

   Restoring means activating a version that’s not in use. That means you can go backwards or forwards a version. However, you can’t restore a version that’s already in use.

5. The diff view shows what’s different between the current and selected version. Review the differences. When finished, click the Restore button.

   Versions after editing

   If you edit an asset after restoring a previously used version, a new version is created.

   For example, let’s say you were on version 3 and you restore version 2. Then you make and save edits to version 2. This creates version 4 of the asset. At that point, you can still restore to version 3 at any time.

   
6. For promoted assets, restoring a version only applies to the current environment. If you restore a version in staging, you may need to re-promote the asset if you want to apply it to production as well.