# getSubstanceReactionDisproportionality

**Identifier:** `eudravigilance_getSubstanceReactionDisproportionality`

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

Disproportionality screen (ROR, PRR) over EudraVigilance for one substance or one commercial product, by MedDRA reaction group. EU counterpart of the FAERS screen, computed only against EudraVigilance denominators.

## Run it with the CLI

```bash
kirha tools run eudravigilance_getSubstanceReactionDisproportionality \
  --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_getSubstanceReactionDisproportionality",
  "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"
    },
    "substanceHighLevelCode": {
      "description": "From searchSubstances; preferred over substanceName.",
      "type": "string"
    },
    "substanceName": {
      "description": "Used when substanceHighLevelCode is not provided.",
      "type": "string"
    },
    "windowMonths": {
      "description": "Screen the cases of the last N months instead of the whole register history.",
      "maximum": 24,
      "minimum": 1,
      "type": "integer"
    }
  },
  "type": "object"
}
```

## Output schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "backgroundCaseClassPairs": {
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "backgroundExtractUrl": {
      "description": "CSV of the register-wide counts, same month",
      "format": "uri",
      "type": "string"
    },
    "caseClassPairs": {
      "description": "Denominator: the substance's counts summed over classes",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "context": {
      "type": "string"
    },
    "extractUrl": {
      "description": "CSV of the substance's counts, 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"
    },
    "rows": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "backgroundCases": {
            "description": "The class across all substances",
            "maximum": 9007199254740991,
            "minimum": 0,
            "type": "integer"
          },
          "cases": {
            "maximum": 9007199254740991,
            "minimum": 0,
            "type": "integer"
          },
          "isSdr": {
            "type": "boolean"
          },
          "lowPrecision": {
            "type": "boolean"
          },
          "nonClinical": {
            "description": "Set when the class records something other than a reaction: product-quality, procedure, circumstance",
            "type": [
              "string",
              "null"
            ]
          },
          "prr": {
            "type": "number"
          },
          "ror": {
            "type": "number"
          },
          "rorCiHigh": {
            "type": "number"
          },
          "rorCiLow": {
            "type": "number"
          },
          "socName": {
            "description": "MedDRA System Organ Class",
            "type": "string"
          }
        },
        "required": [
          "socName",
          "cases",
          "backgroundCases",
          "ror",
          "rorCiLow",
          "rorCiHigh",
          "prr",
          "isSdr",
          "lowPrecision",
          "nonClinical"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "scope": {
      "description": "Which vocabulary these figures were read under",
      "enum": [
        "substance",
        "product"
      ],
      "type": "string"
    },
    "smallSample": {
      "type": "boolean"
    },
    "sourceUrl": {
      "format": "uri",
      "type": "string"
    },
    "substanceHighLevelCode": {
      "type": "string"
    },
    "substanceName": {
      "type": "string"
    },
    "window": {
      "description": "Snapshot months the screened cases fall between, null when the whole history was screened",
      "type": [
        "string",
        "null"
      ]
    },
    "windowRefused": {
      "description": "A window was asked for and the source no longer serves its earlier month, so all-time was screened",
      "type": "boolean"
    }
  },
  "required": [
    "context",
    "substanceName",
    "scope",
    "caseClassPairs",
    "backgroundCaseClassPairs",
    "window",
    "windowRefused",
    "smallSample",
    "sourceUrl",
    "extractUrl",
    "backgroundExtractUrl",
    "extractedAt",
    "rows"
  ],
  "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)
- [`getSubstanceReactionDetail`](https://kirha.com/providers/eudravigilance/getSubstanceReactionDetail.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)