# getSubstanceReactionBreakdown

**Identifier:** `eudravigilance_getSubstanceReactionBreakdown`

**Provider:** [EudraVigilance](https://kirha.com/providers/eudravigilance.md)

Suspected adverse reaction case counts for one substance or one commercial product, broken down by MedDRA reaction group (System Organ Class), from EudraVigilance (EMA, EEA). Pair with searchSubstances or searchProducts to resolve the code.

## Run it with the CLI

```bash
kirha tools run eudravigilance_getSubstanceReactionBreakdown \
  --input '{}'
```

`--input` takes a JSON object that matches the input schema. Pass `--input -` to read it from stdin.

## Call it over HTTP

```bash
curl https://api.kirha.com/tools/v1/execute \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: **********' \
  --data '{
  "tool_name": "eudravigilance_getSubstanceReactionBreakdown",
  "input": {}
}'
```

Replace the stars with an API key from https://app.kirha.com/api-keys.

## Input schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "productHighLevelCode": {
      "description": "From searchProducts; reads that product alone.",
      "type": "string"
    },
    "splitByAgeGroup": {
      "description": "Adds the counts per patient age group, beside the totals.",
      "type": "boolean"
    },
    "substanceHighLevelCode": {
      "description": "From searchSubstances; preferred over substanceName.",
      "type": "string"
    },
    "substanceName": {
      "description": "Used when substanceHighLevelCode is not provided.",
      "type": "string"
    }
  },
  "type": "object"
}
```

## Output schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "byAgeGroup": {
      "description": "Each class sums over its groups to the count it carries above.",
      "items": {
        "additionalProperties": false,
        "properties": {
          "ageGroup": {
            "type": "string"
          },
          "cases": {
            "exclusiveMinimum": 0,
            "maximum": 9007199254740991,
            "type": "integer"
          },
          "socName": {
            "type": "string"
          }
        },
        "required": [
          "socName",
          "ageGroup",
          "cases"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "context": {
      "type": "string"
    },
    "extractUrl": {
      "description": "CSV these counts were read from, pinned to the month read",
      "format": "uri",
      "type": "string"
    },
    "extractedAt": {
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
      "type": "string"
    },
    "productHighLevelCode": {
      "type": "string"
    },
    "reactionGroups": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "cases": {
            "maximum": 9007199254740991,
            "minimum": 0,
            "type": "integer"
          },
          "socName": {
            "description": "MedDRA System Organ Class",
            "type": "string"
          }
        },
        "required": [
          "socName",
          "cases"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "scope": {
      "description": "Which vocabulary these figures were read under",
      "enum": [
        "substance",
        "product"
      ],
      "type": "string"
    },
    "sourceUrl": {
      "format": "uri",
      "type": "string"
    },
    "substanceHighLevelCode": {
      "type": "string"
    },
    "substanceName": {
      "type": "string"
    }
  },
  "required": [
    "context",
    "substanceName",
    "scope",
    "extractedAt",
    "sourceUrl",
    "reactionGroups"
  ],
  "type": "object"
}
```

## Related tools

Other EudraVigilance tools that this tool refers to, or that refer to it.

- [`searchSubstances`](https://kirha.com/providers/eudravigilance/searchSubstances.md)
- [`getSubstanceCaseAccrual`](https://kirha.com/providers/eudravigilance/getSubstanceCaseAccrual.md)
- [`searchProducts`](https://kirha.com/providers/eudravigilance/searchProducts.md)

-----

[All EudraVigilance tools](https://kirha.com/providers/eudravigilance.md) · [< Back to tools list](https://kirha.com/tools.md)