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.

Only for engineer or support roles

Any user may view existing data operations (e.g., filters, translation sets, config modifiers) for subscriptions in a given environment. However, you must be assigned to an engineer or a support role to create and manage data operations. Learn about roles.

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
    "version": 2,
8
    "name": "string",
9
    "environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
10
    "organizationId": 122,
11
    "createdAt": "2024-04-25T18:17:16.719Z",
12
    "creatingUserId": 0,
13
    "updatedAt": "2024-04-25T18:17:16.719Z",
14
    "lastUpdatingUserId": 0,
15
    "deletedAt": "2024-04-25T18:17:16.719Z",
16
    "deletingUserId": 0,
17
    "values": [
18
      {
19
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
20
        "value": "5792-7"
21
      }
22
    ],
23
    "promotionAssociations": [
24
      {
25
        "organization": {
26
          "id": 122,
27
          "name": "string"
28
        },
29
        "fromAsset": {
30
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
31
          "environment": {
32
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
33
          },
34
          "type": "configModifier",
35
          "latestVersion": 0
36
        },
37
        "toAsset": {
38
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
39
          "environment": {
40
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
41
          },
42
          "type": "configModifier",
43
          "latestVersion": 0,
44
          "outOfDate": true
45
        },
46
        "createdAt": "2024-04-25T18:17:16.719Z",
47
        "createdBy": {
48
          "id": 0,
49
          "name": "string"
50
        },
51
        "updatedAt": "2024-04-25T18:17:16.719Z",
52
        "updatedBy": {
53
          "id": 0,
54
          "name": "string"
55
        },
56
        "deletedAt": "2024-04-25T18:17:16.719Z",
57
        "deletedBy": {
58
          "id": 0,
59
          "name": "string"
60
        }
61
      }
62
    ]
63
  }
64
}

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 a value set.
- id
  string
  Contains the unique identifier of the asset.
  Format: uuid
- version
  number
  Contains the numeric version of the asset. Version numbers start at 1 and increment in whole numbers whenever the asset is updated.
- name
  string
  Contains the human-readable name of the asset.
- environmentId
  string
  Contains the unique identifier of the Redox environment.
  Format: uuid
- organizationId
  number
  Contains the unique identifier of the Redox organization.
- createdAt
  string
  Displays the date and time that the asset was originally created in ISO 8601 format.
- creatingUserId
  number
  Contains the unique identifier of the user.
- updatedAt
  string
  Displays the date and time that the asset was last updated in ISO 8601 format.
- lastUpdatingUserId
  number
  Contains the unique identifier of the user.
- deletedAt
  nullable, string
  Displays the date and time that the asset was deleted. Returns a null value if the asset hasn't been deleted.
- deletingUserId
  nullable, number
  Contains the unique identifier of the user.
- values
  Array of object
  id
  string
  Contains the unique identifier of the asset.
  Format: uuid
  value
  string
  Contains the actual string value data.
- promotionAssociations
  Array of object
  Contains a list of promotions associated with this asset.
  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.
  fromAsset
  object
  Describes the original asset that was created in staging and promoted to production.
  id
  string
  Contains the unique identifier of the asset.
  Format: uuid
  environment
  object
  Describes the Redox environment that the asset belongs to.
  id
  string
  Contains the unique identifier of the Redox environment.
  Format: uuid
  type
  string
  Possible Values: configModifier, filter, translationSet
  latestVersion
  number
  Displays the most recent version of the original asset in staging. This may vary from the version number in production. A different version number may indicate you need to re-promote the asset to production.
  toAsset
  object
  Describes the promoted asset that can be used or linked to subscriptions in production.
  id
  string
  Contains the unique identifier of the asset.
  Format: uuid
  environment
  object
  Describes the Redox environment that the asset belongs to.
  id
  string
  Contains the unique identifier of the Redox environment.
  Format: uuid
  type
  string
  Possible Values: configModifier, filter, translationSet
  latestVersion
  number
  Displays the most recent version of the promoted asset in production. This may vary from the version number in staging. A different version number may indicate you need to re-promote the staging asset to production.
  outOfDate
  boolean
  Indicates whether the version of the promoted asset in production is different from the version of the original asset in staging.
  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®.