$average

$average(array) -> number

Compact type signature<a<n>:n>

Browse categories

Numeric And MathArrays And Sequences

Source: JSONata

Documentation

Returns the arithmetic mean of the numeric values in args.

If args is undefined or empty, the function returns undefined. Pass a numeric array or numeric sequence here; the runtime does not add extra coercion beyond the registered numeric signature.

Examples

Average allowed amount

Input

This example uses the claims-lines example input. The expression projects allowedAmount values and calculates their average. CSV is not shown here because those values would be treated as strings.

Example input

JSON

[
  {
    "claimId": "clm-2001",
    "lineNumber": 1,
    "serviceCode": "PROC-010",
    "serviceDisplay": "office visit",
    "units": 1,
    "unitPrice": 125,
    "allowedAmount": 110,
    "modifiers": [
      "MOD-A"
    ]
  },
  {
    "claimId": "clm-2001",
    "lineNumber": 2,
    "serviceCode": "PROC-020",
    "serviceDisplay": "imaging study",
    "units": "1",
    "unitPrice": 350,
    "allowedAmount": 300,
    "modifiers": [
      "MOD-B",
      "MOD-C"
    ]
  },
  {
    "claimId": "clm-2001",
    "lineNumber": 3,
    "serviceCode": "PROC-030",
    "serviceDisplay": "lab panel",
    "units": 2,
    "unitPrice": 40,
    "allowedAmount": 70,
    "modifiers": []
  },
  {
    "claimId": "clm-2002",
    "lineNumber": 1,
    "serviceCode": "PROC-010",
    "serviceDisplay": "office visit",
    "units": 1,
    "unitPrice": 125,
    "allowedAmount": 115,
    "modifiers": [
      "MOD-A"
    ]
  },
  {
    "claimId": "clm-2002",
    "lineNumber": 2,
    "serviceCode": "PROC-040",
    "serviceDisplay": "counseling",
    "units": 3,
    "unitPrice": 60,
    "allowedAmount": 150,
    "modifiers": [
      "MOD-D"
    ]
  }
]

Expression

$average(allowedAmount)

Result

149