Home
How to use Redox
Set up operations
Build a config modifier schema
items

items

Last updated: Feb 24, 2026
DEVELOPER
IMPLEMENTATION
HEALTH TECH VENDOR

Definition

In a config modifier schema, use items to:

  • modify an array size
  • omit existing information
  • add new information

Order of execution

This keyword executes in the following order:

  1. omit
  2. constant
  3. references
  4. use
  5. get
  6. Mutually exclusive keywords at this level:
    • properties
    • if
    • concat
    • switch
    • pipe
    • merge
    • prefer
    • items
  7. default
  8. plugin

Example

Let’s say you want to modify the Observations array in a Flowsheet based on the Code. More specifically, you can remove an observation if it matches one of the specified Codes.

If you need to modify the contents of existing items in an array and change the array size, it’s best to do so with one config modifier rather than separate config modifiers (i.e., don’t create $.Observation[*].Value; add the change in the config modifier below).

Example: Items input from initial payload
json
1
{
2
  "Observations": [
3
  {
4
    "AbnormalFlag": null,
5
    "Code": "GAD2T",
6
    "Codeset": "NFOBS",
7
    "DateTime": "2026-02-23T23:51:16.601239",
8
    "Description": "Generalized Anxiety Disorder - 2 (Screener)",
9
    "Notes": [
10
    ],
11
    "Observer": {
12
      "FirstName": null,
13
      "ID": null,
14
      "IDType": null,
15
      "LastName": null
16
    },
17
    "ReferenceRange": {
18
      "High": null,
19
      "Low": null,
20
      "Text": null
21
    },
22
    "Status": null,
23
    "Units": null,
24
    "Value": "GAD-2 (Screener)",
25
    "ValueType": "String"
26
  },
27
  {
28
    "AbnormalFlag": null,
29
    "Code": "GAD2T-Score",
30
    "Codeset": "NFOBS",
31
    "DateTime": "2026-02-23T23:51:16.601239",
32
    "Description": "Total Score (GAD-2)",
33
    "Notes": [
34
    ],
35
    "Observer": {
36
      "FirstName": null,
37
      "ID": null,
38
      "IDType": null,
39
      "LastName": null
40
    },
41
    "ReferenceRange": {
42
      "High": null,
43
      "Low": null,
44
      "Text": null
45
    },
46
    "Status": null,
47
    "Units": null,
48
    "Value": "1",
49
    "ValueType": "Numeric"
50
  },
51
  {
52
    "AbnormalFlag": null,
53
    "Code": "69725-0",
54
    "Codeset": "LOINC",
55
    "DateTime": "2026-02-23T23:51:16.601239",
56
    "Description": "Feeling nervous, anxious, or on edge",
57
    "Extensions": {
58
      "value-codedentry": {
59
        "coding": {
60
          "code": "LA6569-3",
61
          "display": "Several days",
62
          "system": "http://loinc.org"
63
        },
64
        "url": "https://api.redoxengine.com/extensions/value-codedentry"
65
      }
66
    },
67
    "Notes": [
68
      "LA6569-3"
69
    ],
70
    "Observer": {
71
      "FirstName": null,
72
      "ID": null,
73
      "IDType": null,
74
      "LastName": null
75
    },
76
    "ReferenceRange": {
77
      "High": null,
78
      "Low": null,
79
      "Text": null
80
    },
81
    "Status": null,
82
    "Units": null,
83
    "Value": "1",
84
    "ValueType": "Numeric"
85
  },
86
  {
87
    "AbnormalFlag": null,
88
    "Code": "68509-9",
89
    "Codeset": "LOINC",
90
    "DateTime": "2026-02-23T23:51:16.601239",
91
    "Description": "Not being able to stop or control worrying",
92
    "Extensions": {
93
      "value-codedentry": {
94
        "coding": {
95
          "code": "LA6568-5",
96
          "display": "Not at all",
97
          "system": "http://loinc.org"
98
        },
99
        "url": "https://api.redoxengine.com/extensions/value-codedentry"
100
      }
101
    },
102
    "Notes": [
103
      "LA6568-5"
104
    ],
105
    "Observer": {
106
      "FirstName": null,
107
      "ID": null,
108
      "IDType": null,
109
      "LastName": null
110
    },
111
    "ReferenceRange": {
112
      "High": null,
113
      "Low": null,
114
      "Text": null
115
    },
116
    "Status": null,
117
    "Units": null,
118
    "Value": "0",
119
    "ValueType": "Numeric"
120
  }
121
]
122
}
Example: Items selector
json
1
$.Observations
Example: Config modifier with items keyword
yaml
1
items:
2
  if:
3
    operator: includes
4
    terms:
5
      - concat:
6
          - constant: 69737-5
7
          - constant: 70274-6
8
          - constant: 71354-5
9
          - constant: 99046-5
10
          - constant: 44249-1
11
          - constant: 55757-9
12
          - constant: 44261-6
13
          - constant: 55758-7
14
          - constant: GAD2T-SCORE
15
          - constant: GAD2T-Score
16
          - constant: GAD2T
17
          - constant: 93373-9
18
          - constant: 93374-7
19
          - constant: 72110-0
20
          - constant: 75624-7
21
          - constant: 82666-9
22
          - constant: 82667-7
23
          - constant: 99549-8
24
          - constant: 101698-9
25
          - constant: 101697-1
26
          - constant: 102010-6
27
          - constant: 102017-1
28
          - constant: 106418-7
29
          - constant: 106421-1
30
          - constant: 72110-0
31
          - constant: 72109-2
32
          - constant: 75626-2
33
      - get: Code
34
    then:
35
      omit: true
36
    else: {}

Based on this example config modifier schema, this is the output.

Example: Items output in processed payload
json
1
{
2
  "Observations": [
3
  {
4
    "AbnormalFlag": null,
5
    "Code": "69725-0",
6
    "Codeset": "LOINC",
7
    "DateTime": "2026-02-23T23:51:16.601239",
8
    "Description": "Feeling nervous, anxious, or on edge",
9
    "Extensions": {
10
      "value-codedentry": {
11
        "coding": {
12
          "code": "LA6569-3",
13
          "display": "Several days",
14
          "system": "http://loinc.org"
15
        },
16
        "url": "https://api.redoxengine.com/extensions/value-codedentry"
17
      }
18
    },
19
    "Notes": [
20
      "LA6569-3"
21
    ],
22
    "Observer": {
23
      "FirstName": null,
24
      "ID": null,
25
      "IDType": null,
26
      "LastName": null
27
    },
28
    "ReferenceRange": {
29
      "High": null,
30
      "Low": null,
31
      "Text": null
32
    },
33
    "Status": null,
34
    "Units": null,
35
    "Value": "1",
36
    "ValueType": "Numeric"
37
  },
38
  {
39
    "AbnormalFlag": null,
40
    "Code": "68509-9",
41
    "Codeset": "LOINC",
42
    "DateTime": "2026-02-23T23:51:16.601239",
43
    "Description": "Not being able to stop or control worrying",
44
    "Extensions": {
45
      "value-codedentry": {
46
        "coding": {
47
          "code": "LA6568-5",
48
          "display": "Not at all",
49
          "system": "http://loinc.org"
50
        },
51
        "url": "https://api.redoxengine.com/extensions/value-codedentry"
52
      }
53
    },
54
    "Notes": [
55
      "LA6568-5"
56
    ],
57
    "Observer": {
58
      "FirstName": null,
59
      "ID": null,
60
      "IDType": null,
61
      "LastName": null
62
    },
63
    "ReferenceRange": {
64
      "High": null,
65
      "Low": null,
66
      "Text": null
67
    },
68
    "Status": null,
69
    "Units": null,
70
    "Value": "0",
71
    "ValueType": "Numeric"
72
  }
73
]
74
}