Home
API reference
Platform API reference
Platform API
Translation sets
Update value set

Update value set

patch/v1/operations/valuesets/{valueSetId}
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;

Update value set

Update a value set by either adding new values or changing or deleting existing values. It may be helpful to use the Get value set endpoint first to review current values before updating.

Whether adding, updating, or deleting values, the values array in the request body should include all current values with their respective id and value. Then:

  • To add values, add entries for new values with only their value property specified. Any entries without an id property will be added as new values.
  • To update existing values, include the current value with its id as-is, then change the value string.
  • To delete values, exclude the current value from the values array altogether.

This endpoint allows you to update one value set at a time.

Request parameters and payload

cURL request example

bash
1
curl 'https://api.redoxengine.com/platform/v1/operations/valuesets/{valueSetId}' \
2
--request PATCH \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json' \
5
--header 'Content-Type: application/json' \
6
--data '{
7
  "name": "string",
8
  "values": [
9
    {
10
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
11
      "value": "5792-7"
12
    }
13
  ]
14
}'

Path Parameters

  • valueSetId
    required, string

    Contains the unique identifier of the value set.

Request Body Schema

  • name
    string

    Contains the human-readable name of the asset.

  • values
    Array of object
    • id
      string

      Contains the unique identifier of the asset.

      Format: uuid
    • value
      string

      Contains the actual string value data.

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