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.
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.
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
.
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.
You can also create filters via the Redox Platform API. Learn more about the Platform API.