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;
Get value sets
Retrieve a list of existing value sets for a specific environment within a Redox organization. You can only retrieve a list of value sets for one environment per query.
- 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
Lists the value sets for the specified environment.
- valueSetsArray of object
Contains a list of value sets for the specified environment.
- environmentobject
Describes the Redox environment that the asset belongs to.
- idstring
Contains the unique identifier of the Redox environment.
Format: uuid
- organizationobject
Describes the Redox organization that the asset belongs to.
- idnumber
Contains the unique identifier of the Redox organization.
- namenullable, string
Contains the human-readable name of the Redox organization.
- createdAtstring
Displays the date and time that the asset 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 asset was last updated in ISO 8601 format.
- 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 asset was deleted. Returns a
null
value if the asset hasn't been deleted. - deletedBynullable, object
Contains the metadata about the user who deleted the asset.
- idnumber
Contains the unique identifier of the user.
- namenullable, string
Displays the user's full name.
- idstring
Contains the unique identifier of the asset.
Format: uuid - namestring
Contains the human-readable name of the asset.
- valuesArray of object
- idstring
Contains the unique identifier of the asset.
Format: uuid - valuestring
Contains the actual string value data.
- valueSetUsageArray of object
- translationSetIdstring
Contains the unique identifier of the asset.
Format: uuid - translationSetNamestring
Contains the human-readable name of the asset.