Update filter (beta)

put/v1/operations/filters/{filterId}

Page View

Filter endpoints allow you to review and manage filters for async messages. A filter can contain multiple rules, but you can only create one filter per subscription. Learn about filters.

You can retrieve, create, update, or delete filters.

Beta users may also use the endpoints for reviewing and managing filter links.

Update filter (beta)

Closed beta feature

This is a closed beta feature for a limited pilot group. We're not currently accepting additional participants, but we'll let you know when it's available to everyone.

Update an existing filter in the specified environment. When you update a filter, it automatically applies to traffic where it's linked.

Only for engineer or support roles

All environment users may view data operations like filters. You must be assigned to an engineer or support role to create or edit filters. Learn about roles.

If you choose to filter fields with PHI, users assigned to an observer role may unintentionally access confidential data. Keep that in mind when assigning user roles, since access to viewing log payloads and viewing filters are managed by different permissions.

Request parameters and payload

cURL request example

bash

1
curl 'https://api.redoxengine.com/platform/v1/operations/filters/{filterId}' \
2
--request PUT \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json' \
5
--header 'Content-Type: application/json' \
6
--data '{
7
  "name": "string",
8
  "action": "send",
9
  "rules": [
10
    {
11
      "path": "$.Patient.Demographics.FirstName",
12
      "values": [
13
        "string"
14
      ],
15
      "allowList": true
16
    }
17
  ]
18
}'

Path Parameters

filterId
required, string
Displays the unique identifier of the filter.

Request Body Schema

name
string
Contains the human-readable name of the asset.
action
string
Defines what action should be performed when the filter is applied to a message.
Possible Values: block-all, send
rules
Array of object
Contains a list of rules that determine when the filter is applied to a message. A filter is only applied if ALL rules are met.
- path
  string
  Specifies the path to the field(s) that should be evaluated when the filter is applied. This should be a jsonpath value.
- values
  Array of string
  Contains an array of string values that are matched against the path value when the rule is evaluated.
- allowList
  boolean
  Indicates whether the rule is an allow-list (matches when the value at the specified path is in the values array) or a deny-list (matches when the value at the specified path is NOT in the values array). Defaults to true (allow-list).

Response fields and example

Example payload generated from schema

1
{
2
  "meta": {
3
    "version": "1.0.0"
4
  },
5
  "payload": {
6
    "filter": {
7
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
8
      "name": "string",
9
      "rules": [
10
        {
11
          "path": "$.Patient.Demographics.FirstName",
12
          "values": [
13
            "string"
14
          ],
15
          "allowList": true
16
        }
17
      ],
18
      "usage": [
19
        {
20
          "linkId": "009f739c-6620-43b0-978e-b245e723c57a",
21
          "organization": {
22
            "id": 122,
23
            "name": "string"
24
          },
25
          "connectingOrganization": {
26
            "id": 122,
27
            "name": "string"
28
          },
29
          "subscription": {
30
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
31
            "dataModel": "PatientAdmin",
32
            "source": {
33
              "name": "string",
34
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
35
            },
36
            "destination": {
37
              "name": "string",
38
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
39
            }
40
          },
41
          "filterId": "aff0ee0f-f371-4b82-82c6-dc3b96f05c91",
42
          "version": "1.0.0",
43
          "eventType": "string",
44
          "createdAt": "2024-04-25T18:17:16.719Z",
45
          "createdBy": {
46
            "id": 0,
47
            "name": "string"
48
          },
49
          "updatedAt": "2024-04-25T18:17:16.719Z",
50
          "updatedBy": {
51
            "id": 0,
52
            "name": "string"
53
          },
54
          "deletedAt": "2024-04-25T18:17:16.719Z",
55
          "deletedBy": {
56
            "id": 0,
57
            "name": "string"
58
          }
59
        }
60
      ],
61
      "action": "send",
62
      "pathType": "jsonpath",
63
      "version": "1.0.0",
64
      "filterVersion": 2,
65
      "createdAt": "2024-04-25T18:17:16.719Z",
66
      "createdBy": {
67
        "id": 0,
68
        "name": "string"
69
      },
70
      "updatedAt": "2024-04-25T18:17:16.719Z",
71
      "updatedBy": {
72
        "id": 0,
73
        "name": "string"
74
      },
75
      "deletedAt": "2024-04-25T18:17:16.719Z",
76
      "deletedBy": {
77
        "id": 0,
78
        "name": "string"
79
      },
80
      "environment": {
81
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
82
      },
83
      "organization": {
84
        "id": 122,
85
        "name": "string"
86
      }
87
    }
88
  }
89
}

meta
object
- version
  string
  Lists the major and minor version number for the format of the returned payload. The payload format or shape may change between minor versions, like including additional or extended fields in later versions. We include the version data in each response so that you have the option to handle the signaled differences.
payload
object
- filter
  object
  Contains a filter and its related details.
  id
  string
  Contains the unique identifier of the asset.
  Format: uuid
  name
  string
  Contains the human-readable name of the asset.
  rules
  Array of object
  Contains a list of rules that determine when the filter is applied to a message. A filter is only applied if ALL rules are met.
  path
  string
  Specifies the path to the field(s) that should be evaluated when the filter is applied. This should be a jsonpath value.
  values
  Array of string
  Contains an array of string values that are matched against the path value when the rule is evaluated.
  allowList
  boolean
  Indicates whether the rule is an allow-list (matches when the value at the specified path is in the values array) or a deny-list (matches when the value at the specified path is NOT in the values array). Defaults to true (allow-list).
  usage
  Array of object
  Contains details about where the filter is being used.
  linkId
  string
  Contains the unique identifier of the link for a specified asset.
  Format: uuid
  organization
  object
  Describes the Redox organization that the asset belongs to.
  id
  number
  Contains the unique identifier of the Redox organization.
  name
  nullable, string
  Contains the human-readable name of the Redox organization.
  connectingOrganization
  object
  Specifies the organization the asset is connected to when the subscription relates to a partner organization.
  id
  number
  Contains the unique identifier of the Redox organization.
  name
  nullable, string
  Contains the human-readable name of the Redox organization.
  subscription
  object
  id
  string
  Contains the unique identifier of the subscription.
  Format: uuid
  dataModel
  string
  Specifies the Redox data model that the link applies to or should apply to.
  source
  object
  Specifies the source of the subscription that an asset is or should be linked to.
  id
  required, string
  Contains the unique identifier of the source.
  Format: uuid
  name
  nullable, string
  Specifies the name of the source.
  destination
  object
  Specifies the destination of the subscription that an asset is or should be linked to.
  id
  required, string
  Contains the unique identifier of the destination.
  Format: uuid
  name
  nullable, string
  Specifies the name of the destination.
  filterId
  string
  Contains the unique identifier of the asset being linked.
  Format: uuid
  version
  string
  Contains the API schema version used for this asset.
  eventType
  nullable, string
  Specifies the specific event type for a data model that the link applies to or should apply to.
  createdAt
  string
  Displays the date and time that the asset was originally created in ISO 8601 format.
  createdBy
  object
  Contains the metadata about the user who created the asset.
  id
  number
  Contains the unique identifier of the user.
  name
  nullable, string
  Displays the user's full name.
  updatedAt
  string
  Displays the date and time that the asset was last updated in ISO 8601 format.
  updatedBy
  object
  Contains the metadata about the user who last updated the asset.
  id
  number
  Contains the unique identifier of the user.
  name
  nullable, string
  Displays the user's full name.
  deletedAt
  nullable, string
  Displays the date and time that the asset was deleted. Returns a null value if the asset hasn't been deleted.
  deletedBy
  nullable, object
  Contains the metadata about the user who deleted the asset.
  id
  number
  Contains the unique identifier of the user.
  name
  nullable, string
  Displays the user's full name.
  action
  string
  Defines what action should be performed when the filter is applied to a message.
  Possible Values: block-all, send
  pathType
  string
  Specifies the format of the field paths defined for this filter's rules. Both FHIR and data model filters use the jsonpath path type.
  Value: jsonpath
  version
  string
  Contains the API schema version used for this asset.
  filterVersion
  number
  Contains the numeric version of the asset. Version numbers start at 1 and increment in whole numbers whenever the asset is updated.
  createdAt
  string
  Displays the date and time that the asset was originally created in ISO 8601 format.
  createdBy
  object
  Contains the metadata about the user who created the asset.
  id
  number
  Contains the unique identifier of the user.
  name
  nullable, string
  Displays the user's full name.
  updatedAt
  string
  Displays the date and time that the asset was last updated in ISO 8601 format.
  updatedBy
  object
  Contains the metadata about the user who last updated the asset.
  id
  number
  Contains the unique identifier of the user.
  name
  nullable, string
  Displays the user's full name.
  deletedAt
  nullable, string
  Displays the date and time that the asset was deleted. Returns a null value if the asset hasn't been deleted.
  deletedBy
  nullable, object
  Contains the metadata about the user who deleted the asset.
  id
  number
  Contains the unique identifier of the user.
  name
  nullable, string
  Displays the user's full name.
  environment
  object
  Describes the Redox environment that the asset belongs to.
  id
  string
  Contains the unique identifier of the Redox environment.
  Format: uuid
  organization
  object
  Describes the Redox organization that the asset belongs to.
  id
  number
  Contains the unique identifier of the Redox organization.
  name
  nullable, string
  Contains the human-readable name of the Redox organization.

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.