Home
API reference
Platform API reference
Platform API
Translation sets
Create link

Create link

post/v1/operations/translationsetlinks
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 link

Apply a translation set to a specific location within log processing. There are up to four stages that you can link a translation set to (i.e., REQUEST and RESPOND or SEND and RECEIVE), depending on whether you own either the source, destination, or both. Learn about log processing stages.

To fully link a translation set, you must select the relevant field path where the translation should happen.

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

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

Request parameters and payload

cURL request example

bash
1
curl 'https://api.redoxengine.com/platform/v1/operations/translationsetlinks' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json' \
5
--header 'content-type: application/json' \
6
--data '{
7
  "translationSet": {
8
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
9
  },
10
  "source": {
11
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
12
  },
13
  "destination": {
14
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
15
  },
16
  "dataModel": "PatientAdmin",
17
  "direction": "to-from",
18
  "processingLocation": "source-request",
19
  "paths": [
20
    {
21
      "dataType": "string",
22
      "title": "Custom Path",
23
      "path": "$.Allergies[*].Type.Code"
24
    }
25
  ]
26
}'

Request Body Schema

  • translationSet
    required, object

    Describes the translation set being linked.

    • id
      string

      Contains the unique identifier of the asset.

      Format: uuid
  • source
    required, 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
  • destination
    required, 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
  • dataModel
    required, string

    Specifies the Redox data model that the link applies to or should apply to.

  • direction
    required, 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
    required, 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
    required, 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.

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