6. items

Last updated: Jan 5, 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

Exclusive keywords

If properties, if, concat, switch, pipe, merge, prefer, or items are present at the same nesting level, only the first keyword listed will run. We recommend not listing these keywords together at the same nesting level.

Nesting level

This keyword executes at the following nesting level:

omit
constant
references
use
get
properties or if or concat or switch or pipe or merge or prefer or items
default
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
    {
3
      "AbnormalFlag": null,
4
      "Code": "72109-2",
5
      "Codeset": "LOINC",
6
      "DateTime": "2025-12-04T18:54:42.735439",
7
      "Description": "Alcohol Usage Index",
8
      "Notes": [
9
      ],
10
      "Observer": {
11
        "FirstName": null,
12
        "ID": null,
13
        "IDType": null,
14
        "LastName": null
15
      },
16
      "ReferenceRange": {
17
        "High": null,
18
        "Low": null,
19
        "Text": null
20
      },
21
      "Status": null,
22
      "Units": null,
23
      "Value": "AUDIT-C",
24
      "ValueType": "String"
25
    },
26
    {
27
      "AbnormalFlag": null,
28
      "Code": "75626-2",
29
      "Codeset": "LOINC",
30
      "DateTime": "2025-12-04T18:54:42.735439",
31
      "Description": "Total Score (AUDIT-C)",
32
      "Notes": [
33
      ],
34
      "Observer": {
35
        "FirstName": null,
36
        "ID": null,
37
        "IDType": null,
38
        "LastName": null
39
      },
40
      "ReferenceRange": {
41
        "High": null,
42
        "Low": null,
43
        "Text": null
44
      },
45
      "Status": null,
46
      "Units": null,
47
      "Value": "0",
48
      "ValueType": "Numeric"
49
    },
50
    {
51
      "AbnormalFlag": null,
52
      "Code": "AUDITCQ1",
53
      "Codeset": "NFOBS",
54
      "DateTime": "2025-12-04T18:54:42.735439",
55
      "Description": "How often do you have a drink containing alcohol?",
56
      "Extensions": {
57
        "value-codedentry": {
58
          "coding": {
59
            "code": "LA6270-8",
60
            "display": "Never",
61
            "system": "http://loinc.org"
62
          },
63
          "url": "https://api.redoxengine.com/extensions/value-codedentry"
64
        }
65
      },
66
      "Notes": [
67
        "LA6270-8"
68
      ],
69
      "Observer": {
70
        "FirstName": null,
71
        "ID": null,
72
        "IDType": null,
73
        "LastName": null
74
      },
75
      "ReferenceRange": {
76
        "High": null,
77
        "Low": null,
78
        "Text": null
79
      },
80
      "Status": null,
81
      "Units": null,
82
      "Value": "0",
83
      "ValueType": "Numeric"
84
    },
85
    {
86
      "AbnormalFlag": null,
87
      "Code": "AUDITCQ2",
88
      "Codeset": "NFOBS",
89
      "DateTime": "2025-12-04T18:54:42.735439",
90
      "Description": "How many standard drinks containing alcohol do you have on a typical day?",
91
      "Extensions": {
92
        "value-codedentry": {
93
          "coding": {
94
            "code": "LA15694-5",
95
            "display": "0 to 2",
96
            "system": "http://loinc.org"
97
          },
98
          "url": "https://api.redoxengine.com/extensions/value-codedentry"
99
        }
100
      },
101
      "Notes": [
102
        "LA15694-5"
103
      ],
104
      "Observer": {
105
        "FirstName": null,
106
        "ID": null,
107
        "IDType": null,
108
        "LastName": null
109
      },
110
      "ReferenceRange": {
111
        "High": null,
112
        "Low": null,
113
        "Text": null
114
      },
115
      "Status": null,
116
      "Units": null,
117
      "Value": "0",
118
      "ValueType": "Numeric"
119
    },
120
    {
121
      "AbnormalFlag": null,
122
      "Code": "AUDITCQ3",
123
      "Codeset": "NFOBS",
124
      "DateTime": "2025-12-04T18:54:42.735439",
125
      "Description": "How often do you have six or more drinks on one occasion?",
126
      "Extensions": {
127
        "value-codedentry": {
128
          "coding": {
129
            "code": "LA6270-8",
130
            "display": "Never",
131
            "system": "http://loinc.org"
132
          },
133
          "url": "https://api.redoxengine.com/extensions/value-codedentry"
134
        }
135
      },
136
      "Notes": [
137
        "LA6270-8"
138
      ],
139
      "Observer": {
140
        "FirstName": null,
141
        "ID": null,
142
        "IDType": null,
143
        "LastName": null
144
      },
145
      "ReferenceRange": {
146
        "High": null,
147
        "Low": null,
148
        "Text": null
149
      },
150
      "Status": null,
151
      "Units": null,
152
      "Value": "0",
153
      "ValueType": "Numeric"
154
    }
155
]

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
      - get: Code
18
    then:
19
      omit: true
20
    else: {}

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

Example: Items output in processed payload

json

1
[
2
    {
3
      "AbnormalFlag": null,
4
      "Code": "AUDITCQ1",
5
      "Codeset": "NFOBS",
6
      "DateTime": "2025-12-04T18:54:42.735439",
7
      "Description": "How often do you have a drink containing alcohol?",
8
      "Extensions": {
9
        "value-codedentry": {
10
          "coding": {
11
            "code": "LA6270-8",
12
            "display": "Never",
13
            "system": "http://loinc.org"
14
          },
15
          "url": "https://api.redoxengine.com/extensions/value-codedentry"
16
        }
17
      },
18
      "Notes": [
19
        "LA6270-8"
20
      ],
21
      "Observer": {
22
        "FirstName": null,
23
        "ID": null,
24
        "IDType": null,
25
        "LastName": null
26
      },
27
      "ReferenceRange": {
28
        "High": null,
29
        "Low": null,
30
        "Text": null
31
      },
32
      "Status": null,
33
      "Units": null,
34
      "Value": "0",
35
      "ValueType": "Numeric"
36
    },
37
    {
38
      "AbnormalFlag": null,
39
      "Code": "AUDITCQ2",
40
      "Codeset": "NFOBS",
41
      "DateTime": "2025-12-04T18:54:42.735439",
42
      "Description": "How many standard drinks containing alcohol do you have on a typical day?",
43
      "Extensions": {
44
        "value-codedentry": {
45
          "coding": {
46
            "code": "LA15694-5",
47
            "display": "0 to 2",
48
            "system": "http://loinc.org"
49
          },
50
          "url": "https://api.redoxengine.com/extensions/value-codedentry"
51
        }
52
      },
53
      "Notes": [
54
        "LA15694-5"
55
      ],
56
      "Observer": {
57
        "FirstName": null,
58
        "ID": null,
59
        "IDType": null,
60
        "LastName": null
61
      },
62
      "ReferenceRange": {
63
        "High": null,
64
        "Low": null,
65
        "Text": null
66
      },
67
      "Status": null,
68
      "Units": null,
69
      "Value": "0",
70
      "ValueType": "Numeric"
71
    },
72
    {
73
      "AbnormalFlag": null,
74
      "Code": "AUDITCQ3",
75
      "Codeset": "NFOBS",
76
      "DateTime": "2025-12-04T18:54:42.735439",
77
      "Description": "How often do you have six or more drinks on one occasion?",
78
      "Extensions": {
79
        "value-codedentry": {
80
          "coding": {
81
            "code": "LA6270-8",
82
            "display": "Never",
83
            "system": "http://loinc.org"
84
          },
85
          "url": "https://api.redoxengine.com/extensions/value-codedentry"
86
        }
87
      },
88
      "Notes": [
89
        "LA6270-8"
90
      ],
91
      "Observer": {
92
        "FirstName": null,
93
        "ID": null,
94
        "IDType": null,
95
        "LastName": null
96
      },
97
      "ReferenceRange": {
98
        "High": null,
99
        "Low": null,
100
        "Text": null
101
      },
102
      "Status": null,
103
      "Units": null,
104
      "Value": "0",
105
      "ValueType": "Numeric"
106
    }
107
  ]

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®.