1. omit

Last updated: Sep 8, 2025
DEVELOPER
IMPLEMENTATION
HEALTH TECH VENDOR

Definition

In a config modifier schema, use omit to omit a specific field or value from a processed payload.

Although it’s the first keyword in order of execution, we recommend using it in the context of a conditional if keyword.

Nesting level

This keyword executes at the following nesting level:

  1. omit
  2. constant
  3. references
  4. use
  5. get
  6. properties or if or concat or switch or pipe or merge
  7. default
  8. plugin

Example

You could specify that a processed payload should omit an observation if its values match the terms you define.

Example: Observations input from initial payload
json
1
"Observations": [
2
{
3
"AbnormalFlag": null,
4
"Code": "93246-7",
5
...
6
"Status": "Final",
7
"Units": null,
8
"Value": "1",
9
"ValueType": "Coded Entry"
10
},
11
{
12
"AbnormalFlag": null,
13
"Code": "93247-5",
14
...
15
"Status": "Final",
16
"Units": null,
17
"Value": "1",
18
"ValueType": "Coded Entry"
19
},
20
{
21
"AbnormalFlag": null,
22
"Code": "NF1570400181",
23
...
24
"Status": "Final",
25
"Units": null,
26
"Value": "High Risk",
27
"ValueType": "String"
28
},
29
{
30
"AbnormalFlag": null,
31
"Code": "93267-3",
32
...
33
"Status": "Final",
34
"Units": null,
35
"Value": "1",
36
"ValueType": "Coded Entry"
37
},
38
{
39
"AbnormalFlag": null,
40
"Code": "93269-9",
41
...
42
"Status": "Final",
43
"Units": null,
44
"Value": "0",
45
"ValueType": "Coded Entry"
46
},
47
{
48
"AbnormalFlag": null,
49
"Code": "NF1570400504",
50
...
51
"Status": "Final",
52
"Units": null,
53
"Value": "Putting my notes here",
54
"ValueType": "String"
55
}
56
],
Example: Observations selector
json
1
$.Observations
Example: Config modifier with omit keyword
yaml
1
items:
2
switch:
3
select:
4
get: Code
5
cases:
6
- terms:
7
- constant: NF1570400504
8
- constant: NF1570400181
9
- constant: 93374-7
10
then:
11
omit: true
12
else:
13
comment: pass observation through

If the observation values match the values defined in the schema, the then action executes (i.e., the observation is omitted from the processed payload). If the values don’t match, the else action executes (i.e., the payload passes through with the observation).

Example: Observations output
json
1
"Observations": [
2
{
3
"AbnormalFlag": null,
4
"Code": "93246-7",
5
...
6
"Status": "Final",
7
"Units": null,
8
"Value": "1",
9
"ValueType": "Coded Entry"
10
},
11
{
12
"AbnormalFlag": null,
13
"Code": "93247-5",
14
...
15
"Status": "Final",
16
"Units": null,
17
"Value": "1",
18
"ValueType": "Coded Entry"
19
},
20
{
21
"AbnormalFlag": null,
22
"Code": "93267-3",
23
...
24
"Status": "Final",
25
"Units": null,
26
"Value": "1",
27
"ValueType": "Coded Entry"
28
},
29
{
30
"AbnormalFlag": null,
31
"Code": "93269-9",
32
...
33
"Status": "Final",
34
"Units": null,
35
"Value": "0",
36
"ValueType": "Coded Entry"
37
}
38
],