Get translation set

get/v1/operations/translationsets/{translationSetId}

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;

Get translation set

Retrieve a specific translation set based on its unique ID. This could be helpful if you want to view the translation set before linking, updating, or deleting it.

Request parameters

cURL request example

bash

1
curl 'https://api.redoxengine.com/platform/v1/operations/translationsets/{translationSetId}' \
2
--request GET \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json'

Path Parameters

translationSetId
required, string
Contains the unique identifier for the translation set.

Response fields and example

Example payload generated from schema

1
{
2
  "meta": {
3
    "version": "1.0.0"
4
  },
5
  "payload": {
6
    "translationSet": {
7
      "createdAt": "2024-04-25T18:17:16.719Z",
8
      "createdBy": {
9
        "id": 0,
10
        "name": "string"
11
      },
12
      "updatedAt": "2024-04-25T18:17:16.719Z",
13
      "updatedBy": {
14
        "id": 0,
15
        "name": "string"
16
      },
17
      "deletedAt": "2024-04-25T18:17:16.719Z",
18
      "deletedBy": {
19
        "id": 0,
20
        "name": "string"
21
      },
22
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
23
      "name": "string",
24
      "environment": {
25
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
26
      },
27
      "toValueSet": {
28
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
29
        "name": "string"
30
      },
31
      "fromValueSet": {
32
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
33
        "name": "string"
34
      },
35
      "translations": [
36
        {
37
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
38
          "fromValue": {
39
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
40
            "value": "5792-7"
41
          },
42
          "toValue": {
43
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
44
            "value": "5792-7"
45
          }
46
        }
47
      ],
48
      "isCaseSensitive": true,
49
      "usage": [
50
        {
51
          "linkId": "009f739c-6620-43b0-978e-b245e723c57a",
52
          "dataModel": "PatientAdmin",
53
          "destination": {
54
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
55
          },
56
          "direction": "to-from",
57
          "organization": {
58
            "id": 122,
59
            "name": "string"
60
          },
61
          "connectingOrganization": {
62
            "id": 122
63
          },
64
          "paths": [
65
            {
66
              "dataType": "string",
67
              "title": "Custom Path",
68
              "path": "$.Allergies[*].Type.Code"
69
            }
70
          ],
71
          "processingLocation": "source-request",
72
          "source": {
73
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
74
          },
75
          "version": "1.0.0",
76
          "createdAt": "2024-04-25T18:17:16.719Z",
77
          "createdBy": {
78
            "id": 0,
79
            "name": "string"
80
          },
81
          "updatedAt": "2024-04-25T18:17:16.719Z",
82
          "updatedBy": {
83
            "id": 0,
84
            "name": "string"
85
          },
86
          "deletedAt": "2024-04-25T18:17:16.719Z",
87
          "deletedBy": {
88
            "id": 0,
89
            "name": "string"
90
          }
91
        }
92
      ]
93
    }
94
  }
95
}

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 details about the requested translation set.
- translationSet
  object
  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.
  id
  string
  Contains the unique identifier of the asset.
  Format: uuid
  name
  string
  Contains the human-readable name of the asset.
  environment
  object
  Describes the Redox environment that the asset belongs to.
  id
  string
  Contains the unique identifier of the Redox environment.
  Format: uuid
  toValueSet
  object
  Contains details about a value set.
  id
  string
  Contains the unique identifier of the asset.
  Format: uuid
  name
  string
  Contains the human-readable name of the asset.
  fromValueSet
  object
  Contains details about a value set.
  id
  string
  Contains the unique identifier of the asset.
  Format: uuid
  name
  string
  Contains the human-readable name of the asset.
  translations
  Array of object
  Contains the values which will be mapped FROM and TO.
  id
  string
  Contains the unique identifier for the translation.
  Format: uuid
  fromValue
  object
  Details about the value being mapped FROM.
  id
  string
  Contains the unique identifier of the asset.
  Format: uuid
  value
  string
  Contains the actual string value data.
  toValue
  object
  Details about the value being mapped TO.
  id
  string
  Contains the unique identifier of the asset.
  Format: uuid
  value
  string
  Contains the actual string value data.
  isCaseSensitive
  boolean
  Indicates if the translation set is case sensitive or not.
  usage
  Array of object
  Contains details about where the translation set is being used.
  linkId
  string
  Contains the unique identifier of the link for a specified asset.
  Format: uuid
  dataModel
  string
  Specifies the Redox data model that the link applies to or should apply to.
  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
  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
  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.
  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.
  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
  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
  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®.