POST api/ADRMatchDrugsToAdverseReactions
Matches a patient’s complete list of drugs, along with the patient’s adverse drug reactions.
Identifies matches between a given drug and its adverse drug reactions.
Provides outliers (such as 'drugs with no ADR', 'ADRs with no drugs', or 'unidentified ids').
Request Information
URI Parameters
None.
Body Parameters
ADRMatchDrugsToAdverseReactionsRequestName | Description | Type | Additional information |
---|---|---|---|
AdverseReactionCodes | A collection of adverse reaction codes. | Collection of ConditionIdentifier |
Required |
DrugIdentifiers | A collection of drug identifiers. | Collection of ADRDrugIdentifier |
Required |
Gender | Used to filter based on gender. Default is both. | GenderEnum |
None. |
UseCategorizedTerms | When using results from ListGSTermsByCategory as input to this method, set this to 'true' to use categorized terms. Default is 'false'. | boolean |
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:
{ "AdverseReactionCodes": [ { "IdType": "ICD10", "Id": "123ABC1" }, { "IdType": "ICD10", "Id": "123ABC2" } ], "DrugIdentifiers": [ { "IdType": "NDC11", "Id": "12345-6789-03" }, { "IdType": "NDC11", "Id": "12345-6789-04" } ], "Gender": "Female", "UseCategorizedTerms": true, "AccessToken": "T25lX0hhcHB5X0FuZF9TYXRpc2ZpZWRfR1NERF9DdXN0b21lcl9TYW1wbGVfQWNjZXNzVG9rZW4=" }
Response Information
Resource Description
ADRMatchDrugsToAdverseReactionsResponseName | Description | Type | Additional information |
---|---|---|---|
Matches | The collection of drug monograph adverse reaction section matches. | Collection of ADRMonographConditionDrugInfo |
None. |
DrugsNotMatched | The collection of drugs not matched to an input adverse reaction. | Collection of ADRDrugInfo |
None. |
DrugsNotFound | The collection of drugs not found in the GSDD database. | Collection of ADRDrugInfo |
None. |
AdverseReactionsNotMatched | The collection of adverse reactions not matched to an input drug. | Collection of ConditionIdentifierInfo |
None. |
AdverseReactionsNotFound | The collection of adverse reactions not fount in the GSDD database. | Collection of ConditionIdentifierInfo |
None. |
Response Formats
application/json, text/json
Sample:
{ "Matches": [ { "MonographSectionId": 1, "AdverseReactionInfo": { "ConditionId": { "IdType": "ICD10", "Id": "123ABC2" }, "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-03" }, "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." }, "Exclusion": "Sample Exclusion text." }, { "MonographSectionId": 4, "AdverseReactionInfo": { "ConditionId": { "IdType": "ICD10", "Id": "123ABC5" }, "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-06" }, "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." }, "Exclusion": "Sample Exclusion text." } ], "DrugsNotMatched": [ { "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." }, { "DrugId": { "IdType": "NDC11", "Id": "12345-6789-08" }, "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." } ], "DrugsNotFound": [ { "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." } ], "AdverseReactionsNotMatched": [ { "ConditionId": { "IdType": "ICD10", "Id": "123ABC11" }, "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." } ] }, { "ConditionId": { "IdType": "ICD10", "Id": "123ABC12" }, "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." } ] } ], "AdverseReactionsNotFound": [ { "ConditionId": { "IdType": "ICD10", "Id": "123ABC13" }, "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." } ] }, { "ConditionId": { "IdType": "ICD10", "Id": "123ABC14" }, "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." } ] } ] }