Translation set endpoints allow you to review and manage value sets, translation sets, and related translation set links.
A value set is a list of values (e.g., LOINC, SNOMED, or a custom code set) that should be translated during the process of data exchange.
A translation set contains two value sets: one for incoming values and one for outgoing values between systems. A translation set also defines how those values should map to each other. Learn about translation sets.
A translation set link defines where the translation set should be applied in log processing for a specific subscription.
Anyone in a Redox organization can view translation sets and related value sets or links, but you must be assigned to an engineer or support role to update or delete them.
You can:
- retrieve a list of value sets by environment or organization;
- retrieve a list of translation sets by environment or organization;
- create, update, or delete value sets;
- create, update, or delete translation sets or links;
- create, update, or delete a value in a value set; or
- create or delete a translation in a translation set;
Update link
Update an existing link for a translation set within a Redox organization. You must use the correct ID to update the settings.
This endpoint overwrites any existing settings of a translation set link with the details in the request body.
You can update one translation set link at a time.
cURL request example
Path Parameters
- configModifierLinkIdrequired, string
Contains the unique identifier of the config modifier link.
Request Body Schema
- eventTypesrequired, Array of string
Specifies the event types of the given Redox data model that the link will apply to. If the link shouldn't be restricted to certain event types, you must explicitly set this field to
null
. Ifnull
, the config modifier is linked to all event types of the data model.
Contains the fields that you can populate when creating a new or updating an existing config modifier link.
- metaobject
- versionstring
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.
- payloadobject
- configModifierLinkobject
Contains a config modifier link and its related details.
- idstring
Displays the unique identifier of the link for a given config modifier.
Format: uuid - configModifierIdstring
Contains the unique identifier of the config modifier that the link applies to a given subscription.
- configModifierVersionnumber
Indicates the iteration, or version number, of the config modifier. Version numbers start at 1 and increment every time a config modifier is updated.
Format: uuid - ownedBystring
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
- processingLocationstring
Identifies where the link is applied during log processing.
Possible Values:source-request
,source-response
,destination-request
,destination-response
- dataModelstring
Identifies the Redox data model that the link applies to.
- eventTypesArray of string
Indicates which event type(s) of the data model the config modifier is linked to. If not restricted to certain event types, you must explicitly set this field to
null
; this means the config modifier is linked to all event types. - sourceobject
Specifies the source of the subscription that the config modifier is linked to.
- idstring
Contains the unique identifier of the source.
- namenullable, string
Displays the human-readable name of the source.
- destinationobject
Specifies the destination of the subscription that the config modifier is linked to.
- idstring
Contains the unique identifier of the destination.
- namenullable, string
Displays the human-readable name of the destination.
- organizationobject
Contains metadata about the Redox organization.
- idnumber
Contains the unique identifier of the Redox organization.
- namenullable, string
Contains the human-readable name of the Redox organization.
- connectingOrganizationobject
Specifies the organization the asset is connected to when the subscription relates to a partner organization.
- idnumber
Contains the unique identifier of the Redox organization.
- namenullable, string
Contains the human-readable name of the Redox organization.
- environmentobject
Contains metadata about the environment within the associated Redox organization.
- idstring
Contains the unique identifier of the Redox environment.
Format: uuid
- createdAtstring
Displays the date and time that the link was originally created in ISO 8601 format.
- createdByobject
Contains the metadata about the user who created the asset.
- idnumber
Contains the unique identifier of the user.
- namenullable, string
Displays the user's full name.
- updatedAtstring
Displays the date and time that the link was last updated.
- updatedByobject
Contains the metadata about the user who last updated the asset.
- idnumber
Contains the unique identifier of the user.
- namenullable, string
Displays the user's full name.
- deletedAtnullable, string
Displays the date and time that the link was deleted. Returns a
null
value if the link hasn't been deleted. - deletedBynullable, object
Contains metadata about the user who performed the delete. Returns a
null
value if the config modifier hasn't been deleted.- idnumber
Contains the unique identifier of the user.
- namenullable, string
Displays the user's full name.