Compare subscriptions

get/v1/subscriptions/compare

MCP ToolRead

Page View

Subscription endpoints allow you to review, compare, and manage subscriptions and their related links to assets (i.e., filters, config modifiers, translation sets).

You must be a member of the environment and be assigned to an engineer role to manage subscriptions. Learn about roles.

Compare subscriptions

Closed beta feature

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

Compare the linked assets of the selected staging and production environments. Each asset is reported with its status, content, and links. Both subscriptions must belong to your organization.

Request parameters

cURL request example

bash

1
curl 'https://api.redoxengine.com/platform/v1/subscriptions/compare' \
2
--request GET \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json'

Query Parameters

from
required, number
Identifies the subscription to compare from (typically the staging subscription).
to
required, number
Identifies the subscription to compare to (typically the production subscription).

Response fields and example

Example payload generated from schema

1
{
2
  "meta": {
3
    "version": "1.0.0"
4
  },
5
  "payload": {
6
    "comparison": {
7
      "from": {
8
        "subscription": {
9
          "id": 0,
10
          "name": "string",
11
          "dataModel": "PatientAdmin",
12
          "environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
13
          "environmentFlag": "Staging"
14
        },
15
        "source": {
16
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
17
          "name": "string"
18
        },
19
        "destination": {
20
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
21
          "name": "string"
22
        }
23
      },
24
      "to": {
25
        "subscription": {
26
          "id": 0,
27
          "name": "string",
28
          "dataModel": "PatientAdmin",
29
          "environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
30
          "environmentFlag": "Staging"
31
        },
32
        "source": {
33
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
34
          "name": "string"
35
        },
36
        "destination": {
37
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
38
          "name": "string"
39
        }
40
      },
41
      "assets": {
42
        "filters": [
43
          {
44
            "kind": "filter",
45
            "status": "in-sync",
46
            "from": {
47
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
48
              "name": "string",
49
              "version": 2,
50
              "createdAt": "2019-08-24T14:15:22Z",
51
              "createdBy": {
52
                "id": 0,
53
                "name": "string",
54
                "email": "string"
55
              },
56
              "updatedAt": "2019-08-24T14:15:22Z",
57
              "updatedBy": {
58
                "id": 0,
59
                "name": "string",
60
                "email": "string"
61
              },
62
              "content": {
63
                "name": "string",
64
                "action": "send",
65
                "rules": [
66
                  {
67
                    "path": "$.Patient.Demographics.FirstName",
68
                    "values": [
69
                      "string"
70
                    ],
71
                    "allowList": true
72
                  }
73
                ],
74
                "pathType": "jsonpath",
75
                "expectedDataModel": "string"
76
              },
77
              "usage": []
78
            },
79
            "to": {
80
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
81
              "name": "string",
82
              "version": 2,
83
              "createdAt": "2019-08-24T14:15:22Z",
84
              "createdBy": {
85
                "id": 0,
86
                "name": "string",
87
                "email": "string"
88
              },
89
              "updatedAt": "2019-08-24T14:15:22Z",
90
              "updatedBy": {
91
                "id": 0,
92
                "name": "string",
93
                "email": "string"
94
              },
95
              "content": {
96
                "name": "string",
97
                "action": "send",
98
                "rules": [
99
                  {
100
                    "path": "$.Patient.Demographics.FirstName",
101
                    "values": [
102
                      "string"
103
                    ],
104
                    "allowList": true
105
                  }
106
                ],
107
                "pathType": "jsonpath",
108
                "expectedDataModel": "string"
109
              },
110
              "usage": []
111
            }
112
          }
113
        ],
114
        "configModifiers": [
115
          {
116
            "kind": "configModifier",
117
            "status": "in-sync",
118
            "from": {
119
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
120
              "name": "string",
121
              "version": 2,
122
              "createdAt": "2019-08-24T14:15:22Z",
123
              "createdBy": {
124
                "id": 0,
125
                "name": "string",
126
                "email": "string"
127
              },
128
              "updatedAt": "2019-08-24T14:15:22Z",
129
              "updatedBy": {
130
                "id": 0,
131
                "name": "string",
132
                "email": "string"
133
              },
134
              "content": {
135
                "name": "string",
136
                "selector": "string",
137
                "flavor": "put",
138
                "schema": {}
139
              },
140
              "usage": []
141
            },
142
            "to": {
143
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
144
              "name": "string",
145
              "version": 2,
146
              "createdAt": "2019-08-24T14:15:22Z",
147
              "createdBy": {
148
                "id": 0,
149
                "name": "string",
150
                "email": "string"
151
              },
152
              "updatedAt": "2019-08-24T14:15:22Z",
153
              "updatedBy": {
154
                "id": 0,
155
                "name": "string",
156
                "email": "string"
157
              },
158
              "content": {
159
                "name": "string",
160
                "selector": "string",
161
                "flavor": "put",
162
                "schema": {}
163
              },
164
              "usage": []
165
            }
166
          }
167
        ],
168
        "translationSets": [
169
          {
170
            "kind": "translationSet",
171
            "status": "in-sync",
172
            "from": {
173
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
174
              "name": "string",
175
              "version": 2,
176
              "createdAt": "2019-08-24T14:15:22Z",
177
              "createdBy": {
178
                "id": 0,
179
                "name": "string",
180
                "email": "string"
181
              },
182
              "updatedAt": "2019-08-24T14:15:22Z",
183
              "updatedBy": {
184
                "id": 0,
185
                "name": "string",
186
                "email": "string"
187
              },
188
              "content": {
189
                "name": "string",
190
                "fromValueSetName": "string",
191
                "toValueSetName": "string",
192
                "isCaseSensitive": true,
193
                "translations": [
194
                  {
195
                    "fromValue": "string",
196
                    "toValue": "string"
197
                  }
198
                ]
199
              },
200
              "usage": [
201
                {
202
                  "linkId": "009f739c-6620-43b0-978e-b245e723c57a",
203
                  "subscription": {
204
                    "dataModel": "PatientAdmin",
205
                    "source": {
206
                      "name": "string",
207
                      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
208
                    },
209
                    "destination": {
210
                      "name": "string",
211
                      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
212
                    }
213
                  },
214
                  "expectedDataModel": "PatientAdmin",
215
                  "direction": "to-from",
216
                  "processingLocation": "source-request",
217
                  "paths": [
218
                    {
219
                      "dataType": "string",
220
                      "title": "Custom Path",
221
                      "path": "$.Allergies[*].Type.Code"
222
                    }
223
                  ],
224
                  "organization": {
225
                    "id": 122,
226
                    "name": "string"
227
                  },
228
                  "connectingOrganization": {
229
                    "id": 122
230
                  },
231
                  "version": "1.0.0",
232
                  "createdAt": "2024-04-25T18:17:16.719Z",
233
                  "createdBy": {
234
                    "id": 0,
235
                    "name": "string"
236
                  },
237
                  "updatedAt": "2024-04-25T18:17:16.719Z",
238
                  "updatedBy": {
239
                    "id": 0,
240
                    "name": "string"
241
                  },
242
                  "deletedAt": "2024-04-25T18:17:16.719Z",
243
                  "deletedBy": {
244
                    "id": 0,
245
                    "name": "string"
246
                  }
247
                }
248
              ]
249
            },
250
            "to": {
251
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
252
              "name": "string",
253
              "version": 2,
254
              "createdAt": "2019-08-24T14:15:22Z",
255
              "createdBy": {
256
                "id": 0,
257
                "name": "string",
258
                "email": "string"
259
              },
260
              "updatedAt": "2019-08-24T14:15:22Z",
261
              "updatedBy": {
262
                "id": 0,
263
                "name": "string",
264
                "email": "string"
265
              },
266
              "content": {
267
                "name": "string",
268
                "fromValueSetName": "string",
269
                "toValueSetName": "string",
270
                "isCaseSensitive": true,
271
                "translations": [
272
                  {
273
                    "fromValue": "string",
274
                    "toValue": "string"
275
                  }
276
                ]
277
              },
278
              "usage": [
279
                {
280
                  "linkId": "009f739c-6620-43b0-978e-b245e723c57a",
281
                  "subscription": {
282
                    "dataModel": "PatientAdmin",
283
                    "source": {
284
                      "name": "string",
285
                      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
286
                    },
287
                    "destination": {
288
                      "name": "string",
289
                      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
290
                    }
291
                  },
292
                  "expectedDataModel": "PatientAdmin",
293
                  "direction": "to-from",
294
                  "processingLocation": "source-request",
295
                  "paths": [
296
                    {
297
                      "dataType": "string",
298
                      "title": "Custom Path",
299
                      "path": "$.Allergies[*].Type.Code"
300
                    }
301
                  ],
302
                  "organization": {
303
                    "id": 122,
304
                    "name": "string"
305
                  },
306
                  "connectingOrganization": {
307
                    "id": 122
308
                  },
309
                  "version": "1.0.0",
310
                  "createdAt": "2024-04-25T18:17:16.719Z",
311
                  "createdBy": {
312
                    "id": 0,
313
                    "name": "string"
314
                  },
315
                  "updatedAt": "2024-04-25T18:17:16.719Z",
316
                  "updatedBy": {
317
                    "id": 0,
318
                    "name": "string"
319
                  },
320
                  "deletedAt": "2024-04-25T18:17:16.719Z",
321
                  "deletedBy": {
322
                    "id": 0,
323
                    "name": "string"
324
                  }
325
                }
326
              ]
327
            }
328
          }
329
        ]
330
      }
331
    }
332
  }
333
}

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
- comparison
  object
  from
  object
  Describes one of the two subscriptions being compared.
  subscription
  object
  id
  number
  Displays the unique identifier of the subscription.
  name
  nullable, string
  Displays the human-readable name of the subscription.
  dataModel
  string
  Specifies the Redox data model that the link applies to or should apply to.
  environmentId
  string
  Contains the unique identifier of the Redox environment.
  Format: uuid
  environmentFlag
  string
  Indicates whether the environment is used for development, staging, or production.
  Possible Values: Production, Staging, Development
  source
  object
  id
  string
  Contains the unique identifier of the source.
  Format: uuid
  name
  string
  Displays the name of the source.
  destination
  object
  id
  string
  Contains the unique identifier of the destination.
  Format: uuid
  name
  string
  Displays the name of the destination.
  to
  object
  Describes one of the two subscriptions being compared.
  subscription
  object
  id
  number
  Displays the unique identifier of the subscription.
  name
  nullable, string
  Displays the human-readable name of the subscription.
  dataModel
  string
  Specifies the Redox data model that the link applies to or should apply to.
  environmentId
  string
  Contains the unique identifier of the Redox environment.
  Format: uuid
  environmentFlag
  string
  Indicates whether the environment is used for development, staging, or production.
  Possible Values: Production, Staging, Development
  source
  object
  id
  string
  Contains the unique identifier of the source.
  Format: uuid
  name
  string
  Displays the name of the source.
  destination
  object
  id
  string
  Contains the unique identifier of the destination.
  Format: uuid
  name
  string
  Displays the name of the destination.
  assets
  object
  Contains the compared assets grouped by type.
  filters
  Array of object
  kind
  string
  Value: filter
  status
  string
  Indicates how an asset differs between the two subscriptions. in-sync: the asset has been promoted and the two sides match. different: the asset has been promoted but the two sides differ, in content or in link settings. from-only: the asset exists only on the from side and has never been promoted to the to environment. to-only: the asset exists only on the to side. promoted-not-linked: the asset has been promoted to the to environment, and to describes that promoted asset, but it is not linked to the to subscription.
  Possible Values: in-sync, different, from-only, to-only, promoted-not-linked
  from
  nullable, object
  Describes the asset on one side of the comparison. Set to null when the asset is absent on that side.
  id
  string
  Contains the unique identifier of the asset.
  Format: uuid
  name
  string
  Contains the human-readable name of the asset.
  version
  number
  Contains the numeric version of the asset. Version numbers start at 1 and increment in whole numbers whenever the asset is updated.
  createdAt
  nullable, string
  Format: date-time
  createdBy
  nullable, object
  Contains metadata about the user.
  id
  number
  Contains the unique identifier of the user.
  name
  nullable, string
  Displays the user's full name.
  email
  nullable, string
  Displays the user's email address.
  updatedAt
  nullable, string
  Format: date-time
  updatedBy
  nullable, object
  Contains metadata about the user.
  id
  number
  Contains the unique identifier of the user.
  name
  nullable, string
  Displays the user's full name.
  email
  nullable, string
  Displays the user's email address.
  content
  object
  Contains the fields of the filter that define it, independent of any link.
  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).
  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
  expectedDataModel
  nullable, string
  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.
  to
  nullable, object
  Describes the asset on one side of the comparison. Set to null when the asset is absent on that side.
  id
  string
  Contains the unique identifier of the asset.
  Format: uuid
  name
  string
  Contains the human-readable name of the asset.
  version
  number
  Contains the numeric version of the asset. Version numbers start at 1 and increment in whole numbers whenever the asset is updated.
  createdAt
  nullable, string
  Format: date-time
  createdBy
  nullable, object
  Contains metadata about the user.
  id
  number
  Contains the unique identifier of the user.
  name
  nullable, string
  Displays the user's full name.
  email
  nullable, string
  Displays the user's email address.
  updatedAt
  nullable, string
  Format: date-time
  updatedBy
  nullable, object
  Contains metadata about the user.
  id
  number
  Contains the unique identifier of the user.
  name
  nullable, string
  Displays the user's full name.
  email
  nullable, string
  Displays the user's email address.
  content
  object
  Contains the fields of the filter that define it, independent of any link.
  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).
  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
  expectedDataModel
  nullable, string
  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.
  configModifiers
  Array of object
  kind
  string
  Value: configModifier
  status
  string
  Indicates how an asset differs between the two subscriptions. in-sync: the asset has been promoted and the two sides match. different: the asset has been promoted but the two sides differ, in content or in link settings. from-only: the asset exists only on the from side and has never been promoted to the to environment. to-only: the asset exists only on the to side. promoted-not-linked: the asset has been promoted to the to environment, and to describes that promoted asset, but it is not linked to the to subscription.
  Possible Values: in-sync, different, from-only, to-only, promoted-not-linked
  from
  nullable, object
  Describes the asset on one side of the comparison. Set to null when the asset is absent on that side.
  id
  string
  Contains the unique identifier of the asset.
  Format: uuid
  name
  string
  Contains the human-readable name of the asset.
  version
  number
  Contains the numeric version of the asset. Version numbers start at 1 and increment in whole numbers whenever the asset is updated.
  createdAt
  nullable, string
  Format: date-time
  createdBy
  nullable, object
  Contains metadata about the user.
  id
  number
  Contains the unique identifier of the user.
  name
  nullable, string
  Displays the user's full name.
  email
  nullable, string
  Displays the user's email address.
  updatedAt
  nullable, string
  Format: date-time
  updatedBy
  nullable, object
  Contains metadata about the user.
  id
  number
  Contains the unique identifier of the user.
  name
  nullable, string
  Displays the user's full name.
  email
  nullable, string
  Displays the user's email address.
  content
  object
  Contains the fields of the config modifier that define it, independent of any link.
  name
  string
  Contains the human-readable name of the asset.
  selector
  nullable, string
  Indicates the location(s) within the payload that this config modifier operates on.
  flavor
  string
  Possible Values: put, delete
  schema
  nullable, object
  Indicates how to build the value at the location the selector specifies.
  usage
  Array of object
  Lists the config modifier's subscription links.
  ownedBy
  string
  Indicates whether the source or destination system owns the link. Only the owner can view the specific details or update a link.
  Possible Values: source, destination
  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.
  processingLocation
  string
  Identifies where a link will be applied during log processing. There are up to four stages that an asset can be linked to, depending on whether you own either the source, the destination, or both.
  Possible Values: source-request, destination-request, source-response, destination-response
  subscription
  object
  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.
  eventTypes
  Array of string
  Specifies the event types of the given Redox data model that the link applies to. If null, the config modifier is linked to all event types of the data model.
  processingOrder
  object
  Contains the details for the processing order of the config modifiers linked to a given subscription.
  order
  nullable, number
  Specifies the order that the config modifiers should run at the given processing location.
  total
  number
  Displays the total number of config modifier links for the given subscription and processing location.
  to
  nullable, object
  Describes the asset on one side of the comparison. Set to null when the asset is absent on that side.
  id
  string
  Contains the unique identifier of the asset.
  Format: uuid
  name
  string
  Contains the human-readable name of the asset.
  version
  number
  Contains the numeric version of the asset. Version numbers start at 1 and increment in whole numbers whenever the asset is updated.
  createdAt
  nullable, string
  Format: date-time
  createdBy
  nullable, object
  Contains metadata about the user.
  id
  number
  Contains the unique identifier of the user.
  name
  nullable, string
  Displays the user's full name.
  email
  nullable, string
  Displays the user's email address.
  updatedAt
  nullable, string
  Format: date-time
  updatedBy
  nullable, object
  Contains metadata about the user.
  id
  number
  Contains the unique identifier of the user.
  name
  nullable, string
  Displays the user's full name.
  email
  nullable, string
  Displays the user's email address.
  content
  object
  Contains the fields of the config modifier that define it, independent of any link.
  name
  string
  Contains the human-readable name of the asset.
  selector
  nullable, string
  Indicates the location(s) within the payload that this config modifier operates on.
  flavor
  string
  Possible Values: put, delete
  schema
  nullable, object
  Indicates how to build the value at the location the selector specifies.
  usage
  Array of object
  Lists the config modifier's subscription links.
  ownedBy
  string
  Indicates whether the source or destination system owns the link. Only the owner can view the specific details or update a link.
  Possible Values: source, destination
  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.
  processingLocation
  string
  Identifies where a link will be applied during log processing. There are up to four stages that an asset can be linked to, depending on whether you own either the source, the destination, or both.
  Possible Values: source-request, destination-request, source-response, destination-response
  subscription
  object
  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.
  eventTypes
  Array of string
  Specifies the event types of the given Redox data model that the link applies to. If null, the config modifier is linked to all event types of the data model.
  processingOrder
  object
  Contains the details for the processing order of the config modifiers linked to a given subscription.
  order
  nullable, number
  Specifies the order that the config modifiers should run at the given processing location.
  total
  number
  Displays the total number of config modifier links for the given subscription and processing location.
  translationSets
  Array of object
  kind
  string
  Value: translationSet
  status
  string
  Indicates how an asset differs between the two subscriptions. in-sync: the asset has been promoted and the two sides match. different: the asset has been promoted but the two sides differ, in content or in link settings. from-only: the asset exists only on the from side and has never been promoted to the to environment. to-only: the asset exists only on the to side. promoted-not-linked: the asset has been promoted to the to environment, and to describes that promoted asset, but it is not linked to the to subscription.
  Possible Values: in-sync, different, from-only, to-only, promoted-not-linked
  from
  nullable, object
  Describes the asset on one side of the comparison. Set to null when the asset is absent on that side.
  id
  string
  Contains the unique identifier of the asset.
  Format: uuid
  name
  string
  Contains the human-readable name of the asset.
  version
  number
  Contains the numeric version of the asset. Version numbers start at 1 and increment in whole numbers whenever the asset is updated.
  createdAt
  nullable, string
  Format: date-time
  createdBy
  nullable, object
  Contains metadata about the user.
  id
  number
  Contains the unique identifier of the user.
  name
  nullable, string
  Displays the user's full name.
  email
  nullable, string
  Displays the user's email address.
  updatedAt
  nullable, string
  Format: date-time
  updatedBy
  nullable, object
  Contains metadata about the user.
  id
  number
  Contains the unique identifier of the user.
  name
  nullable, string
  Displays the user's full name.
  email
  nullable, string
  Displays the user's email address.
  content
  object
  Contains the fields of the translation set that define it, including every translation.
  name
  string
  Contains the human-readable name of the asset.
  fromValueSetName
  string
  toValueSetName
  string
  isCaseSensitive
  boolean
  translations
  Array of object
  fromValue
  string
  toValue
  string
  usage
  Array of object
  Lists the translation set's subscription links.
  linkId
  string
  Contains the unique identifier of the link for a specified asset.
  Format: uuid
  subscription
  object
  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.
  expectedDataModel
  string
  Specifies the Redox data model that the link applies to or should apply to.
  direction
  string
  Indicates the direction in which the translation set is or should be linked. This can be either from-to (translates a "from" value into a "to" value), or to-from (tranlates a "to" value into a "from" value).
  Possible Values: from-to, to-from
  processingLocation
  string
  Identifies where a link will be applied during log processing. There are up to four stages that an asset can be linked to, depending on whether you own either the source, the destination, or both.
  Possible Values: source-request, destination-request, source-response, destination-response
  paths
  Array of object
  Lists the field paths linked to a translation set. These paths must be unique on the path property.
  dataType
  string
  Describes the format of the data found at the path location.
  title
  string
  Specifies a human-readable title for the field path.
  path
  string
  Specifies the path in a message to the location of the data to be translated. The path must always start with a $ to be considered valid.
  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 at the other side of the subscription that an asset is or should be linked to.
  id
  required, number
  Contains the unique identifier of the Redox organization.
  version
  string
  Specifies the version of the translation set link. Right now this will always be '1.0.0'.
  Value: 1.0.0
  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.
  to
  nullable, object
  Describes the asset on one side of the comparison. Set to null when the asset is absent on that side.
  id
  string
  Contains the unique identifier of the asset.
  Format: uuid
  name
  string
  Contains the human-readable name of the asset.
  version
  number
  Contains the numeric version of the asset. Version numbers start at 1 and increment in whole numbers whenever the asset is updated.
  createdAt
  nullable, string
  Format: date-time
  createdBy
  nullable, object
  Contains metadata about the user.
  id
  number
  Contains the unique identifier of the user.
  name
  nullable, string
  Displays the user's full name.
  email
  nullable, string
  Displays the user's email address.
  updatedAt
  nullable, string
  Format: date-time
  updatedBy
  nullable, object
  Contains metadata about the user.
  id
  number
  Contains the unique identifier of the user.
  name
  nullable, string
  Displays the user's full name.
  email
  nullable, string
  Displays the user's email address.
  content
  object
  Contains the fields of the translation set that define it, including every translation.
  name
  string
  Contains the human-readable name of the asset.
  fromValueSetName
  string
  toValueSetName
  string
  isCaseSensitive
  boolean
  translations
  Array of object
  fromValue
  string
  toValue
  string
  usage
  Array of object
  Lists the translation set's subscription links.
  linkId
  string
  Contains the unique identifier of the link for a specified asset.
  Format: uuid
  subscription
  object
  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.
  expectedDataModel
  string
  Specifies the Redox data model that the link applies to or should apply to.
  direction
  string
  Indicates the direction in which the translation set is or should be linked. This can be either from-to (translates a "from" value into a "to" value), or to-from (tranlates a "to" value into a "from" value).
  Possible Values: from-to, to-from
  processingLocation
  string
  Identifies where a link will be applied during log processing. There are up to four stages that an asset can be linked to, depending on whether you own either the source, the destination, or both.
  Possible Values: source-request, destination-request, source-response, destination-response
  paths
  Array of object
  Lists the field paths linked to a translation set. These paths must be unique on the path property.
  dataType
  string
  Describes the format of the data found at the path location.
  title
  string
  Specifies a human-readable title for the field path.
  path
  string
  Specifies the path in a message to the location of the data to be translated. The path must always start with a $ to be considered valid.
  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 at the other side of the subscription that an asset is or should be linked to.
  id
  required, number
  Contains the unique identifier of the Redox organization.
  version
  string
  Specifies the version of the translation set link. Right now this will always be '1.0.0'.
  Value: 1.0.0
  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.

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®.