get

Last updated: Apr 23, 2026
DEVELOPER
IMPLEMENTATION
HEALTH TECH VENDOR

Definition

In a config modifier schema, use get to retrieve a value at a given path.

To retrieve a nested property value, use dot.notation; a prefix . isn’t required. Additionally, we support an array[index] notation (e.g., get: someArray[0].someProperty).

This value can either be simply returned or used as a starting point for other keywords at the same level or nested below.

Copy get path

You can copy the path to target for the get keyword from a JSON payload snapshot within log inspector using the Copy get path option. This copies the path in the schema format so you can paste directly into the config modifier schema. Learn more about copy options.

Note: This shortcut is for targeting specific fields. If you need to operate on all elements of an array, you might need to use an array plugin instead.

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

You can indicate which nested property value to return.

Let’s say you have an MDM message. The TXA.4.1 value—mapped from a FHIR® message and representing activity date/time—is missing and needs to be populated.

Example: Get input from initial payload
json
1
{
2
...
3
"TXA": {
4
"1": 1,
5
"19": "AV",
6
"3": "TX",
7
"6": {
8
"1": "20250828173111"
9
}
10
}
11
}

TXA.6.1, which represents origination date/time, is already being mapped. A simple approach is to get the value directly from TXA.6.1 (from the current payload) to map to TXA.4.1.

First include use to get the HL7v2 output (the current processedPayload), then use get to retrieve and map the value at TXA.6.1 to TXA.4.1.

Example: Get selector
json
1
$.TXA.4.1
Example: Config modifier with get keyword
yaml
1
use: processedPayload
2
get: TXA.6.1

Based on this example config modifier, TXA.4.1 is now populated.

Example: Get output
json
1
{
2
...
3
"TXA": {
4
"1": 1,
5
"19": "AV",
6
"3": "TX",
7
"4": {
8
"1": "20250828173111"
9
},
10
"6": {
11
"1": "20250828173111"
12
}
13
}
14
}

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