# getSubstanceReactionDetail

**Identifier:** `eudravigilance_getSubstanceReactionDetail`

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

EudraVigilance reactions for one substance or one commercial product at MedDRA preferred-term level, with their outcome, ICH seriousness, CTCAE severity range, the indication each case reported, the medicines taken alongside, and the official case form for fatal ones. Reads a window of months, and counts each term against the window before it. Use for what was reported and how it ended; use getSubstanceReactionDisproportionality for whether a group is over-reported.

## Run it with the CLI

```bash
kirha tools run eudravigilance_getSubstanceReactionDetail \
  --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_getSubstanceReactionDetail",
  "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": {
    "comparePrevious": {
      "description": "Also count each term over the window of the same length before it, from the same read.",
      "type": "boolean"
    },
    "productHighLevelCode": {
      "description": "From searchProducts; reads that product alone.",
      "type": "string"
    },
    "substanceHighLevelCode": {
      "description": "From searchSubstances; preferred over substanceName.",
      "type": "string"
    },
    "substanceName": {
      "description": "Used when substanceHighLevelCode is not provided.",
      "type": "string"
    },
    "topN": {
      "description": "Reactions returned, most reported first.",
      "maximum": 100,
      "minimum": 1,
      "type": "integer"
    },
    "windowMonths": {
      "description": "Months back from the source's last published month. Omit for the whole history.",
      "maximum": 240,
      "minimum": 1,
      "type": "integer"
    }
  },
  "type": "object"
}
```

## Output schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "cases": {
      "description": "Read, one row per report",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "casesAllTime": {
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "casesWhereInteracting": {
      "description": "Naming it interacting rather than suspected",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "casesWhereSuspect": {
      "description": "Naming it a suspect drug",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "casesWithConcomitants": {
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "citations": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "coReportedMedicines": {
      "description": "Over casesWithConcomitants, one count per case",
      "items": {
        "additionalProperties": false,
        "properties": {
          "cases": {
            "maximum": 9007199254740991,
            "minimum": 0,
            "type": "integer"
          },
          "medicine": {
            "type": "string"
          }
        },
        "required": [
          "medicine",
          "cases"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "context": {
      "type": "string"
    },
    "coverage": {
      "description": "Gateway years read, \"all years\" when the whole history fit; says so when a request was cut",
      "type": "string"
    },
    "designatedMedicalEvents": {
      "description": "EMA Designated Medical Events reported, whatever their rank",
      "items": {
        "additionalProperties": false,
        "properties": {
          "cases": {
            "maximum": 9007199254740991,
            "minimum": 0,
            "type": "integer"
          },
          "ctcaeMaxGrade": {
            "anyOf": [
              {
                "maximum": 9007199254740991,
                "minimum": -9007199254740991,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "ctcaeMinGrade": {
            "anyOf": [
              {
                "maximum": 9007199254740991,
                "minimum": -9007199254740991,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "dominantAgeGroup": {
            "anyOf": [
              {
                "additionalProperties": false,
                "properties": {
                  "cases": {
                    "maximum": 9007199254740991,
                    "minimum": -9007199254740991,
                    "type": "integer"
                  },
                  "group": {
                    "type": "string"
                  },
                  "ofSpecified": {
                    "maximum": 9007199254740991,
                    "minimum": -9007199254740991,
                    "type": "integer"
                  }
                },
                "required": [
                  "group",
                  "cases",
                  "ofSpecified"
                ],
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "description": "Band holding most of the cases that stated one"
          },
          "dominantSex": {
            "anyOf": [
              {
                "additionalProperties": false,
                "properties": {
                  "cases": {
                    "maximum": 9007199254740991,
                    "minimum": -9007199254740991,
                    "type": "integer"
                  },
                  "ofSpecified": {
                    "maximum": 9007199254740991,
                    "minimum": -9007199254740991,
                    "type": "integer"
                  },
                  "sex": {
                    "type": "string"
                  }
                },
                "required": [
                  "sex",
                  "cases",
                  "ofSpecified"
                ],
                "type": "object"
              },
              {
                "type": "null"
              }
            ]
          },
          "fatal": {
            "maximum": 9007199254740991,
            "minimum": 0,
            "type": "integer"
          },
          "lifeThreateningCapable": {
            "type": [
              "boolean",
              "null"
            ]
          },
          "previousCases": {
            "anyOf": [
              {
                "maximum": 9007199254740991,
                "minimum": 0,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "pt": {
            "type": "string"
          },
          "serious": {
            "maximum": 9007199254740991,
            "minimum": 0,
            "type": "integer"
          }
        },
        "required": [
          "pt",
          "cases",
          "fatal",
          "serious",
          "ctcaeMinGrade",
          "ctcaeMaxGrade",
          "lifeThreateningCapable",
          "previousCases",
          "dominantAgeGroup",
          "dominantSex"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "distinctReactions": {
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "extractUrl": {
      "description": "CSV these cases were read from",
      "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"
    },
    "fatalCaseForms": {
      "description": "Official case form as PDF, fatal outcomes, most recent first",
      "items": {
        "additionalProperties": false,
        "properties": {
          "caseNumber": {
            "type": "string"
          },
          "formUrl": {
            "format": "uri",
            "type": "string"
          },
          "receivedOn": {
            "type": "string"
          }
        },
        "required": [
          "caseNumber",
          "receivedOn",
          "formUrl"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "outcomes": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "cases": {
            "maximum": 9007199254740991,
            "minimum": 0,
            "type": "integer"
          },
          "outcome": {
            "type": "string"
          },
          "previousCases": {
            "anyOf": [
              {
                "maximum": 9007199254740991,
                "minimum": 0,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "description": "Same entry over previousWindow"
          }
        },
        "required": [
          "outcome",
          "cases",
          "previousCases"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "parentChildCases": {
      "description": "Parent-child pairs, so exposure before birth",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "previousWindow": {
      "description": "Window previousCases was counted over",
      "type": [
        "string",
        "null"
      ]
    },
    "productHighLevelCode": {
      "type": "string"
    },
    "publishedCases": {
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "reactions": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "cases": {
            "maximum": 9007199254740991,
            "minimum": 0,
            "type": "integer"
          },
          "ctcaeMaxGrade": {
            "anyOf": [
              {
                "maximum": 9007199254740991,
                "minimum": -9007199254740991,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "ctcaeMinGrade": {
            "anyOf": [
              {
                "maximum": 9007199254740991,
                "minimum": -9007199254740991,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "fatal": {
            "description": "Outcome reported fatal",
            "maximum": 9007199254740991,
            "minimum": 0,
            "type": "integer"
          },
          "lifeThreateningCapable": {
            "type": [
              "boolean",
              "null"
            ]
          },
          "previousCases": {
            "anyOf": [
              {
                "maximum": 9007199254740991,
                "minimum": 0,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "description": "Zero means read and absent"
          },
          "pt": {
            "type": "string"
          },
          "serious": {
            "description": "Carried an ICH seriousness criterion",
            "maximum": 9007199254740991,
            "minimum": 0,
            "type": "integer"
          }
        },
        "required": [
          "pt",
          "cases",
          "fatal",
          "serious",
          "ctcaeMinGrade",
          "ctcaeMaxGrade",
          "lifeThreateningCapable",
          "previousCases"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "reactionsReported": {
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "reportTypes": {
      "description": "Spontaneous, from a study, or otherwise",
      "items": {
        "additionalProperties": false,
        "properties": {
          "cases": {
            "maximum": 9007199254740991,
            "minimum": 0,
            "type": "integer"
          },
          "type": {
            "type": "string"
          }
        },
        "required": [
          "type",
          "cases"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "reportedIndications": {
      "description": "What the reporter said it was given for",
      "items": {
        "additionalProperties": false,
        "properties": {
          "cases": {
            "maximum": 9007199254740991,
            "minimum": 0,
            "type": "integer"
          },
          "indication": {
            "type": "string"
          },
          "previousCases": {
            "anyOf": [
              {
                "maximum": 9007199254740991,
                "minimum": 0,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "description": "Same entry over previousWindow"
          }
        },
        "required": [
          "indication",
          "cases",
          "previousCases"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "scope": {
      "description": "Which vocabulary these figures were read under",
      "enum": [
        "substance",
        "product"
      ],
      "type": "string"
    },
    "seriousness": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "cases": {
            "maximum": 9007199254740991,
            "minimum": 0,
            "type": "integer"
          },
          "criterion": {
            "type": "string"
          },
          "previousCases": {
            "anyOf": [
              {
                "maximum": 9007199254740991,
                "minimum": 0,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "description": "Same entry over previousWindow"
          }
        },
        "required": [
          "criterion",
          "cases",
          "previousCases"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "sourceUrl": {
      "format": "uri",
      "type": "string"
    },
    "substanceHighLevelCode": {
      "type": "string"
    },
    "substanceName": {
      "type": "string"
    }
  },
  "required": [
    "context",
    "substanceName",
    "scope",
    "cases",
    "casesAllTime",
    "previousWindow",
    "coverage",
    "reactionsReported",
    "distinctReactions",
    "reactions",
    "designatedMedicalEvents",
    "outcomes",
    "seriousness",
    "reportedIndications",
    "reportTypes",
    "parentChildCases",
    "casesWhereSuspect",
    "casesWhereInteracting",
    "casesWithConcomitants",
    "coReportedMedicines",
    "publishedCases",
    "citations",
    "fatalCaseForms",
    "sourceUrl",
    "extractUrl",
    "extractedAt"
  ],
  "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)
- [`getSubstanceReactionDisproportionality`](https://kirha.com/providers/eudravigilance/getSubstanceReactionDisproportionality.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)