# getDrugReactionDisproportionality

**Identifier:** `openfda_getDrugReactionDisproportionality`

**Provider:** [OpenFDA](https://kirha.com/providers/openfda.md)

FAERS (U.S. FDA) disproportionality signal screen for a drug: reactions ranked by signal strength with ROR, 95% CI, PRR and SDR flag. Use this, not getDrugAdverseEventCounts, when the question is whether a reaction is reported MORE than expected (a signal), not merely how many.

## Run it with the CLI

```bash
kirha tools run openfda_getDrugReactionDisproportionality \
  --input '{
    "drugName": "atorvastatin"
  }'
```

`--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": "openfda_getDrugReactionDisproportionality",
  "input": {
    "drugName": "atorvastatin"
  }
}'
```

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": {
    "checkLabel": {
      "description": "U.S. label only.",
      "type": "boolean"
    },
    "comparePrevious": {
      "description": "Against the preceding window of equal length. Defaults window to 12m.",
      "type": "boolean"
    },
    "drugName": {
      "description": "Brand or generic name, e.g. \"atorvastatin\"",
      "minLength": 1,
      "type": "string"
    },
    "reactions": {
      "description": "MedDRA terms to screen even if rare, e.g. [\"MYOCARDITIS\"]",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "topN": {
      "default": 20,
      "maximum": 100,
      "minimum": 1,
      "type": "integer"
    },
    "window": {
      "anyOf": [
        {
          "properties": {
            "preset": {
              "enum": [
                "3m",
                "6m",
                "12m"
              ],
              "type": "string"
            }
          },
          "required": [
            "preset"
          ],
          "type": "object"
        },
        {
          "properties": {
            "from": {
              "type": "string"
            },
            "to": {
              "type": "string"
            }
          },
          "required": [
            "from"
          ],
          "type": "object"
        }
      ],
      "description": "Omitted screens all-time. Presets count back from the latest FAERS data, not today."
    }
  },
  "required": [
    "drugName"
  ],
  "type": "object"
}
```

## Output schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "background": {
      "type": "string"
    },
    "context": {
      "type": "string"
    },
    "drug": {
      "type": "string"
    },
    "drugTotal": {
      "type": "number"
    },
    "extractedAt": {
      "type": "string"
    },
    "grandTotal": {
      "type": "number"
    },
    "partial": {
      "type": "boolean"
    },
    "previousDrugTotal": {
      "type": [
        "number",
        "null"
      ]
    },
    "previousWindow": {
      "anyOf": [
        {
          "additionalProperties": false,
          "properties": {
            "from": {
              "type": "string"
            },
            "to": {
              "type": "string"
            }
          },
          "required": [
            "from",
            "to"
          ],
          "type": "object"
        },
        {
          "type": "null"
        }
      ]
    },
    "queryUrl": {
      "description": "openFDA query behind the case counts in this table",
      "type": "string"
    },
    "rows": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "a": {
            "type": "number"
          },
          "ctcaeMaxGrade": {
            "type": [
              "number",
              "null"
            ]
          },
          "ctcaeMinGrade": {
            "type": [
              "number",
              "null"
            ]
          },
          "ctcaeSoc": {
            "type": [
              "string",
              "null"
            ]
          },
          "fatalShare": {
            "type": "number"
          },
          "hospitalizationShare": {
            "type": "number"
          },
          "isSdr": {
            "type": "boolean"
          },
          "labelExcerpt": {
            "type": [
              "string",
              "null"
            ]
          },
          "labelSection": {
            "type": [
              "string",
              "null"
            ]
          },
          "labelStatus": {
            "type": [
              "string",
              "null"
            ]
          },
          "lifeThreateningCapable": {
            "type": [
              "boolean",
              "null"
            ]
          },
          "lifeThreateningShare": {
            "type": "number"
          },
          "lowPrecision": {
            "type": "boolean"
          },
          "nonAdr": {
            "type": [
              "string",
              "null"
            ]
          },
          "previousCount": {
            "type": [
              "number",
              "null"
            ]
          },
          "priorityScore": {
            "type": "number"
          },
          "prr": {
            "type": "number"
          },
          "reaction": {
            "type": "string"
          },
          "ror": {
            "type": "number"
          },
          "rorCiHigh": {
            "type": "number"
          },
          "rorCiLow": {
            "type": "number"
          },
          "trend": {
            "type": [
              "string",
              "null"
            ]
          },
          "trendRatio": {
            "type": [
              "number",
              "null"
            ]
          },
          "trendRatioCiHigh": {
            "type": [
              "number",
              "null"
            ]
          },
          "trendRatioCiLow": {
            "type": [
              "number",
              "null"
            ]
          }
        },
        "required": [
          "reaction",
          "a",
          "ror",
          "rorCiLow",
          "rorCiHigh",
          "prr",
          "isSdr",
          "lowPrecision",
          "nonAdr",
          "ctcaeSoc",
          "ctcaeMinGrade",
          "ctcaeMaxGrade",
          "lifeThreateningCapable",
          "fatalShare",
          "lifeThreateningShare",
          "hospitalizationShare",
          "priorityScore",
          "previousCount",
          "trendRatio",
          "trendRatioCiLow",
          "trendRatioCiHigh",
          "trend",
          "labelStatus",
          "labelSection",
          "labelExcerpt"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "smallSample": {
      "type": "boolean"
    },
    "window": {
      "anyOf": [
        {
          "additionalProperties": false,
          "properties": {
            "from": {
              "type": "string"
            },
            "to": {
              "type": "string"
            }
          },
          "required": [
            "from",
            "to"
          ],
          "type": "object"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "context",
    "drug",
    "grandTotal",
    "drugTotal",
    "background",
    "queryUrl",
    "smallSample",
    "extractedAt",
    "window",
    "previousWindow",
    "previousDrugTotal",
    "rows",
    "partial"
  ],
  "type": "object"
}
```

## Related tools

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

- [`getDrugAdverseEventCounts`](https://kirha.com/providers/openfda/getDrugAdverseEventCounts.md)

-----

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