Home
API reference
Platform API reference
Platform API
Translation sets
Create translation set

Create translation set

post/v1/operations/translationsets
Page View

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;

Create translation set

Create a translation set for a specific environment within a Redox organization. You can map up to 1,000 values in one translation set.

You can create a value set via API or the Redox dashboard (create a translation set in the dashboard).

This endpoint allows you to create one translation set at a time.

Request parameters and payload

cURL request example

bash
1
curl 'https://api.redoxengine.com/platform/v1/operations/translationsets' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json' \
5
--header 'content-type: application/json' \
6
--data '{
7
  "environment": {
8
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
9
  },
10
  "organization": {
11
    "id": 122
12
  },
13
  "name": "string",
14
  "fromValueSetId": "76844187-ad05-41ea-a530-4e46b8701250",
15
  "toValueSetId": "462a3a3c-7aa0-4f81-bdb7-9daf9a8a7f2b",
16
  "translations": [
17
    {
18
      "toValueId": "3f954e50-cf5a-47c2-bf36-b9b4c78e515f",
19
      "fromValueId": "d27ff859-f1ef-4d7d-be2b-6ac0f43abb0c"
20
    }
21
  ]
22
}'

Request Body Schema

  • environment
    required, object

    Contains metadata about the Redox environment that you're operating in or on behalf of.

    • id
      required, string

      Contains the unique identifier of the Redox environment.

      Format: uuid
  • organization
    required, object

    Contains metadata about the Redox organization that you're operating in or on behalf of.

    • id
      required, number

      Contains the unique identifier of the Redox organization.

  • name
    required, string

    Contains the human-readable name of the asset.

  • fromValueSetId
    required, string

    Identifies the value set you to translate FROM.

    Format: uuid
  • toValueSetId
    required, string

    Identifies the value set you want to translate TO.

    Format: uuid
  • translations
    required, Array of object

    Contains the list of mapped value pairs by their respective unique identifiers.

    • toValueId
      string

      Specifies the unique identifier of a value in the TO value set.

      Format: uuid
    • fromValueId
      string

      Specifies the unique identifier of a value in the FROM value set.

      Format: uuid

Response fields and example

Example payload generated from schema
1
{
2
  "meta": {
3
    "version": "1.0.0"
4
  },
5
  "payload": {
6
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
7
  }
8
}
  • 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

    Contains the id of the created or modified asset.

    • id
      string

      Contains the unique identifier of the asset.

      Format: uuid