POST api/ADRAdverseReactionsByDrugClassification
An informational method that provides the ability to identify a drug contained within a given market class that does not exhibit the specified undesirable adverse drug reaction.
Request Information
URI Parameters
None.
Body Parameters
ADRAdverseReactionsByDrugClassificationRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| TherapeuticConceptTreeId | A numeric therapeutic concept tree identifier, that identifies a therapeutic concept drug classification. | integer |
Required |
| AdverseReactionCodes | Collection of adverse reaction codes. Drugs with these adverse reactions will be returned. | Collection of ConditionIdentifier |
Required |
| SeverityFilter | Used to filter the response based on severity of the adverse reaction. Limits the results to severities of equal or greater value to the filter. Indicates how serious the adverse event is and what the anticipated clinician’s action would be. If no severity value is included in the request, then all known adverse drug reaction(s) are returned. | ADRSeverityEnum |
None. |
| IncidenceFilter | Used to filter the adverse reaction results based on incidence. Limits the results to incidences of equal or greater value to the filter. Identifies the reported percentage range of patients who experience the adverse reaction when taking the specified drug. If no incidence value is included in the request, then all known incidence information for the adverse drug reaction(s) is returned. | ADRIncidenceEnum |
None. |
| OnsetFilter | Used to filter the adverse reaction results based on onset. Indicates when the adverse event is anticipated to occur following drug administration. If no onset value is included in the request, then all known onset information for the adverse drug reaction(s) is returned. | ADROnsetEnum |
None. |
| SortBy | Used to sort the return results. The default sort is by Incidence. | ADRSortByEnum |
None. |
| Gender | Used to filter based on gender. Default is both. | GenderEnum |
None. |
| FilterPreferences | All warnings, drugs, indications, classifications, etc., for each supplied identifier are filtered out of the response. | FilterPreferences |
None. |
| AccessToken |
Temporary access token from the GSDD Auth API.
Used to validate your license.
Note: Access tokens are temporary and may be invalidated early for various reasons, including—but not limited to—site maintenance and security updates. If a token is invalidated prematurely, simply request new tokens via the AccessToken method in the GSDD Auth API. This is a rather rare occurrence, but should be planned for and handled by the consuming application. |
string |
Required |
Request Formats
application/json, text/json
Sample:
{
"TherapeuticConceptTreeId": 1,
"AdverseReactionCodes": [
{
"IdType": "ICD10",
"Id": "123ABC2"
},
{
"IdType": "ICD10",
"Id": "123ABC3"
}
],
"SeverityFilter": "Severe",
"IncidenceFilter": "Rare",
"OnsetFilter": "Early",
"SortBy": "Onset",
"Gender": "Female",
"FilterPreferences": {
"Patient": [
{
"IdType": "IngredientId",
"Id": "4"
},
{
"IdType": "IngredientId",
"Id": "5"
}
],
"Physician": [
{
"IdType": "IngredientId",
"Id": "6"
},
{
"IdType": "IngredientId",
"Id": "7"
}
]
},
"AccessToken": "T25lX0hhcHB5X0FuZF9TYXRpc2ZpZWRfR1NERF9DdXN0b21lcl9TYW1wbGVfQWNjZXNzVG9rZW4="
}
Response Information
Resource Description
ADRAdverseReactionsByDrugClassificationResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Drugs | A collection of drugs with adverse reaction information. | Collection of ADRDrugInfo |
None. |
| ExcludedDrugs | A collection of drugs with adverse reaction information that have been excluded. | Collection of ADRConditionDrugDetail |
None. |
| DrugsWithNoData | A collection of drugs that do not have any adverse reaction data. | Collection of ADRDrugInfo |
None. |
Response Formats
application/json, text/json
Sample:
{
"Drugs": [
{
"DrugId": {
"IdType": "NDC11",
"Id": "12345-6789-01"
},
"Name": "Sample Name text.",
"LevelsOfEvidence": [
{
"Recommended": true,
"StrengthOfRecommendation": "EquivocalWeakAgainst",
"Rating": "VeryLow",
"ErrorMessage": "Sample ErrorMessage text."
},
{
"Recommended": true,
"StrengthOfRecommendation": "EquivocalWeakAgainst",
"Rating": "VeryLow",
"ErrorMessage": "Sample ErrorMessage text."
}
],
"Message": "Sample Message text."
},
{
"DrugId": {
"IdType": "NDC11",
"Id": "12345-6789-02"
},
"Name": "Sample Name text.",
"LevelsOfEvidence": [
{
"Recommended": true,
"StrengthOfRecommendation": "EquivocalWeakAgainst",
"Rating": "VeryLow",
"ErrorMessage": "Sample ErrorMessage text."
},
{
"Recommended": true,
"StrengthOfRecommendation": "EquivocalWeakAgainst",
"Rating": "VeryLow",
"ErrorMessage": "Sample ErrorMessage text."
}
],
"Message": "Sample Message text."
}
],
"ExcludedDrugs": [
{
"AdverseReactionInfo": {
"ConditionId": {
"IdType": "ICD10",
"Id": "123ABC3"
},
"Description": "Sample Description text.",
"InfoMessage": "Sample InfoMessage text.",
"LevelsOfEvidence": [
{
"Recommended": true,
"StrengthOfRecommendation": "EquivocalWeakAgainst",
"Rating": "VeryLow",
"ErrorMessage": "Sample ErrorMessage text."
},
{
"Recommended": true,
"StrengthOfRecommendation": "EquivocalWeakAgainst",
"Rating": "VeryLow",
"ErrorMessage": "Sample ErrorMessage text."
}
]
},
"DrugInfo": {
"DrugId": {
"IdType": "NDC11",
"Id": "12345-6789-04"
},
"Name": "Sample Name text.",
"LevelsOfEvidence": [
{
"Recommended": true,
"StrengthOfRecommendation": "EquivocalWeakAgainst",
"Rating": "VeryLow",
"ErrorMessage": "Sample ErrorMessage text."
},
{
"Recommended": true,
"StrengthOfRecommendation": "EquivocalWeakAgainst",
"Rating": "VeryLow",
"ErrorMessage": "Sample ErrorMessage text."
}
],
"Message": "Sample Message text."
},
"MonographSectionId": 5,
"Message": "Sample Message text.",
"Gender": "Female",
"Onset": "Early",
"Severity": "Severe",
"IncidenceFrom": 1.234,
"IncidenceTo": 1.234,
"IncidenceInclusive": true,
"Reported": true
},
{
"AdverseReactionInfo": {
"ConditionId": {
"IdType": "ICD10",
"Id": "123ABC6"
},
"Description": "Sample Description text.",
"InfoMessage": "Sample InfoMessage text.",
"LevelsOfEvidence": [
{
"Recommended": true,
"StrengthOfRecommendation": "EquivocalWeakAgainst",
"Rating": "VeryLow",
"ErrorMessage": "Sample ErrorMessage text."
},
{
"Recommended": true,
"StrengthOfRecommendation": "EquivocalWeakAgainst",
"Rating": "VeryLow",
"ErrorMessage": "Sample ErrorMessage text."
}
]
},
"DrugInfo": {
"DrugId": {
"IdType": "NDC11",
"Id": "12345-6789-07"
},
"Name": "Sample Name text.",
"LevelsOfEvidence": [
{
"Recommended": true,
"StrengthOfRecommendation": "EquivocalWeakAgainst",
"Rating": "VeryLow",
"ErrorMessage": "Sample ErrorMessage text."
},
{
"Recommended": true,
"StrengthOfRecommendation": "EquivocalWeakAgainst",
"Rating": "VeryLow",
"ErrorMessage": "Sample ErrorMessage text."
}
],
"Message": "Sample Message text."
},
"MonographSectionId": 8,
"Message": "Sample Message text.",
"Gender": "Female",
"Onset": "Early",
"Severity": "Severe",
"IncidenceFrom": 1.234,
"IncidenceTo": 1.234,
"IncidenceInclusive": true,
"Reported": true
}
],
"DrugsWithNoData": [
{
"DrugId": {
"IdType": "NDC11",
"Id": "12345-6789-00"
},
"Name": "Sample Name text.",
"LevelsOfEvidence": [
{
"Recommended": true,
"StrengthOfRecommendation": "EquivocalWeakAgainst",
"Rating": "VeryLow",
"ErrorMessage": "Sample ErrorMessage text."
},
{
"Recommended": true,
"StrengthOfRecommendation": "EquivocalWeakAgainst",
"Rating": "VeryLow",
"ErrorMessage": "Sample ErrorMessage text."
}
],
"Message": "Sample Message text."
},
{
"DrugId": {
"IdType": "NDC11",
"Id": "12345-6789-01"
},
"Name": "Sample Name text.",
"LevelsOfEvidence": [
{
"Recommended": true,
"StrengthOfRecommendation": "EquivocalWeakAgainst",
"Rating": "VeryLow",
"ErrorMessage": "Sample ErrorMessage text."
},
{
"Recommended": true,
"StrengthOfRecommendation": "EquivocalWeakAgainst",
"Rating": "VeryLow",
"ErrorMessage": "Sample ErrorMessage text."
}
],
"Message": "Sample Message text."
}
]
}