6. if

Last updated: Sep 26, 2025

DEVELOPER

IMPLEMENTATION

HEALTH TECH VENDOR

Definition

In a config modifier schema, use if to define a conditional state to run a given action or not.

Exclusive keywords

If properties, if, concat, switch, pipe, or merge 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.

A conditional allows you to determine how to construct an output value by conditionally executing different keywords, based on the evaluation of a set of values.

You can use one of these sub-keywords to construct a conditional statement:

operator
terms
then
else

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
default
plugin

Sub-keywords

operator

Determines what action to take based on one of the following operators. The config modifier defines what should happen if a value exists and meets the criteria of any of these operators.

Definition of existence

We define existence of a value based on some rules. Specifically, these evaluations are defined as does not exist:

undefined
null
''
[]
NaN

We specifically treat some Falsy (learn about Falsy) values as exists:

false
0
' ' (empty string but padded with a space)

equals

all

some

Specifies that at least one of the defined terms exists.

If at least one of the terms is present, the then action occurs. If none aren’t present, the else action occurs.

Let’s say you have a list of patient contacts that are missing phone number information, which you need for your workflow. You decide to remove contacts that don’t have at least one phone number listed.

Example: Some input

json

1
{
2
 "Patient": {
3
   ...
4
   "Contacts": [
5
        {
6
          "Address": {
7
            "City": "Speedy",
8
            "Country": null,
9
            "County": null,
10
            "State": "CA",
11
            "StreetAddress": "5559 E. Washington St",
12
            "ZIP": "12345"
13
          },
14
          "EmailAddresses": [
15
          ],
16
          "FirstName": "Elizabieth",
17
          "LastName": "Santa",
18
          "MiddleName": null,
19
          "PhoneNumber": {
20
            "Home": "+10000000000",
21
            "Mobile": "+10000000000",
22
            "Office": null
23
          },
24
          "RelationToPatient": "Other",
25
          "Roles": [
26
            "PC"
27
          ]
28
        },
29
        {
30
          "Address": {
31
            "City": "Speedy",
32
            "Country": null,
33
            "County": null,
34
            "State": "CA",
35
            "StreetAddress": "5559 E. Washington St",
36
            "ZIP": "12345"
37
          },
38
          "EmailAddresses": [
39
          ],
40
          "FirstName": "Joshua",
41
          "LastName": "Santa",
42
          "MiddleName": null,
43
          "PhoneNumber": {
44
            "Home": "+15551231234",
45
            "Mobile": "+15551231234",
46
            "Office": null
47
          },
48
          "RelationToPatient": "Spouse",
49
          "Roles": [
50
            "SC"
51
          ]
52
        },
53
        {
54
          "Address": {
55
            "City": null,
56
            "Country": null,
57
            "County": null,
58
            "State": null,
59
            "StreetAddress": null,
60
            "ZIP": null
61
          },
62
          "EmailAddresses": [
63
          ],
64
          "FirstName": null,
65
          "LastName": "Disabled",
66
          "MiddleName": null,
67
          "PhoneNumber": {
68
            "Home": null,
69
            "Mobile": null,
70
            "Office": null
71
          },
72
          "RelationToPatient": null,
73
          "Roles": [
74
            "EMP"
75
          ]
76
        }
77
      ]
78
   }
79
}

To implement this, you need to rebuild the Patient.Contacts array by checking that there’s at least one phone number listed under PhoneNumber for each contact.

Example: Some selector

json

1
$.Patient.Contacts

If there at least one phone number is present, you want to keep the contact, otherwise it should be removed. This is an ideal scenario to use the operator of some that evaluates a set of terms (phone numbers in this case) where at least one of the values must evaluate to true.

Example: Config modifier with some operator

yaml

1
items:
2
  if:
3
    operator: some
4
    terms:
5
      - get: PhoneNumber.Home
6
      - get: PhoneNumber.Mobile
7
      - get: PhoneNumber.Office
8
    then: {}
9
    else:
10
      omit: true

Based on this example config modifier, the output would be:

Example: Some output

json

1
{
2
 "Patient": {
3
   ...
4
   "Contacts": [
5
        {
6
          "Address": {
7
            "City": "Speedy",
8
            "Country": null,
9
            "County": null,
10
            "State": "CA",
11
            "StreetAddress": "5559 E. Washington St",
12
            "ZIP": "12345"
13
          },
14
          "EmailAddresses": [
15
          ],
16
          "FirstName": "Katie",
17
          "LastName": "Santa",
18
          "MiddleName": null,
19
          "PhoneNumber": {
20
            "Home": "+10000000000",
21
            "Mobile": "+10000000000",
22
            "Office": null
23
          },
24
          "RelationToPatient": "Other",
25
          "Roles": [
26
            "PC"
27
          ]
28
        },
29
        {
30
          "Address": {
31
            "City": "Speedy",
32
            "Country": null,
33
            "County": null,
34
            "State": "CA",
35
            "StreetAddress": "5559 E. Washington St",
36
            "ZIP": "12345"
37
          },
38
          "EmailAddresses": [
39
          ],
40
          "FirstName": "John",
41
          "LastName": "Santa",
42
          "MiddleName": null,
43
          "PhoneNumber": {
44
            "Home": "+15551231234",
45
            "Mobile": "+155531231234",
46
            "Office": null
47
          },
48
          "RelationToPatient": "Spouse",
49
          "Roles": [
50
            "SC"
51
          ]
52
        }
53
      ]
54
   }
55
}

none

includes

Specifies that the first value in the defined terms contains the second value.

If the second value is included in the first, the then action occurs. If not—or if the first value isn’t an array or a single string—the else action occurs.

If a string, value matching is case-sensitive. The second value must be a single primitive value.

Array example

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
  ],

Example: Observations selector

json

1
$.Observations

Example: Config modifier with concat and include keywords

yaml

1
items:
2
  if:
3
   operator: includes
4
   terms:
5
      - concat:
6
        - constant: NF1570400504
7
        - constant: NF1570400181
8
        - constant: 93374-7
9
      - get: Code
10
   then:
11
     omit: true
12
   else:
13
     comment: do pass observation through

Based on this example config modifier, the output would be:

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
  ],

String example

This example config modifier checks if the string value at FT1.13.1 includes a substring of a dash (-). If the string does include a dash (-), then it should split and place the first part of the string in PV1.3.1 and the second part of the string after the dash (-) in PV1.3.4.1. If it doesn’t include dash (-), then it’ll map from the initial payload’s Financial[0].Department.Code (from a Financials data model message).

Example: Includes string input

json

1
{
2
 ...,
3
  "FINANCIAL": [
4
    {
5
      "FT1": {
6
        "1": 1,
7
        "10": "1",
8
        "11": {
9
          "1": {
10
            "1": null
11
          }
12
        },
13
        "13": {
14
          "1": "SVHCROSCAR-MONTICELO",
15
          "2": null,
16
          "3": null
17
        },
18
       ...
19
      }
20
    }
21
  ],
22
  ...,
23
  "PV1": {
24
    "19": {
25
      "1": "2000708548"
26
    },
27
    "3": {
28
      "1": null
29
    },
30
    "44": {
31
      "1": null
32
    }
33
  }
34
}

Example: Includes string selector

json

1
$.PV1.3

Example: Config modifier with includes operator for string

yaml

1
references:
2
  departmentCode:
3
    use: processedPayload
4
    get: FINANCIAL[0].FT1.13.1
5
if:
6
  operator: includes
7
  terms:
8
    - use: departmentCode
9
      plugin:
10
        name: text
11
        action: lower-case
12
    - constant: '-'
13
  then:
14
    pipe:
15
      - use: departmentCode
16
        plugin:
17
          name: text
18
          action: split
19
          parameters:
20
            separator: '-'
21
      - properties:
22
          '1':
23
            get: '0'
24
          '4':
25
            properties:
26
              '1':
27
                get: '1'
28
  else:
29
    use: initialPayload
30
    get: Transactions[0].Department.Code

Based on this example config modifier, the output would be:

Example: Output string for includes operator

json

1
{
2
  ...,
3
  "FINANCIAL": [
4
    {
5
      "FT1": {
6
        "1": 1,
7
        "10": "1",
8
        "11": {
9
          "1": {
10
            "1": null
11
          }
12
        },
13
        "13": {
14
          "1": "SVHCROSCAR-MONTICELO",
15
          "2": null,
16
          "3": null
17
        },
18
       ...,
19
    }
20
  ],
21
  "PV1": {
22
    "19": {
23
      "1": "2000708548"
24
    },
25
    "3": {
26
      "1": "SVHCROSCAR",
27
      "4": {
28
        "1": "MONTICELO"
29
      }
30
    },
31
    "44": {
32
      "1": null
33
    }
34
  }
35
}

terms

Defines a sequential array of keywords to execute on. All terms are evaluated in sequence, then the related operator performs the appropriate action. You can review the requirements for terms based on the operator used.

Refer to a selector

Within the context of a terms keyword statement, you can use {} to retrieve a value at the already defined selector instead of repeating the same path. Learn about referring to a selector.

then / else

These keywords are used in conjunction with each other to define which action should happen when:

Execute the then action when the operator resolves to a true state.
Execute the else action when the operator resolves to a false state.

Example

For example, you could define which fields to use to build an object.

Example: Then / else input from initial payload

json

1
{
2
  "Orders": [
3
    {
4
      "ApplicationOrderID": "844",
5
      "ClinicalInfo": [],
6
      "CollectionDateTime": "2025-05-29T14:59:00.000Z",
7
      "Comments": null,
8
      "Diagnoses": [
9
        {
10
          "Code": "Z13.71",
11
          "Codeset": "ICD-10",
12
          "DocumentedDateTime": null,
13
          "Name": "Encounter for nonprocreative screening for genetic disease carrier status",
14
          "Type": "Unknown"
15
        }
16
      ],
17
      ...
18
      "Procedure": {
19
        "Code": "523",
20
        "Codeset": "GDXEAP",
21
        "Description": "GDX NEURO-NDD"
22
      },
23
      ...
24
      "Status": "Update",
25
      "TransactionDateTime": "2025-05-29T14:59:25.000Z"
26
    }
27
  ],
28
}

Example: Then / else selector

json

1
$.Orders[*].Procedure.Code

Example: Config modifier with then / else keywords

yaml

1
if:
2
  operator: equals
3
  terms:
4
    - {}
5
    - constant: '523'
6
  then:
7
    constant: '691'
8
  else:
9
    comment: pass original value

During processing, the request checks if the procedure code equals 523 in the initial payload. If so, the then action executes, meaning that the procedure code is set to 691. If the procedure code doesn’t equal 523, the else action executes, meaning that the original procedure code is passed.

Example: Then / else output

json

1
"Orders": [
2
    {
3
      "ApplicationOrderID": "844",
4
      "ClinicalInfo": [],
5
      "CollectionDateTime": "2025-05-29T14:59:00.000Z",
6
      "Comments": null,
7
      "Diagnoses": [
8
        {
9
          "Code": "Z13.71",
10
          "Codeset": "ICD-10",
11
          "DocumentedDateTime": null,
12
          "Name": "Encounter for nonprocreative screening for genetic disease carrier status",
13
          "Type": "Unknown"
14
        }
15
      ],
16
      ...
17
      "Procedure": {
18
        "Code": "691",                                                        <--- this is the change here
19
        "Codeset": "GDXEAP",
20
        "Description": "GDX NEURO-NDD"
21
      },
22
      ...
23
      "Status": "Update",
24
      "TransactionDateTime": "2025-05-29T14:59:25.000Z"
25
    }
26
  ],

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