POST api/DrugDiseaseScreening
Validates that all entered drugs have associated diagnoses.
Identifies drugs that do not have a corresponding diagnosis.
Identifies diagnoses that do not have corresponding drugs.
Additionally identifies patient contraindications to drugs, so those drugs are not accidentally prescribed.
Checks for editorial exclusion using the associated Generic Product Clinical, and then looks up all Gold Standard (GS) indications found for the drug (either by Specific Product Id or Generic Product Clinical Id).
Categorizes results by drug identifier and name, and clearly identifies which drugs are associated to which contraindications.
Provides a single response even if a user submits both the ICD9 and ICD10 for the same diagnosis.
Request Information
URI Parameters
None.
Body Parameters
DrugDiseaseScreeningRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| FilterPreferences | All warnings, drugs, indications, classifications, etc., for each supplied identifier or combination pair of identifiers are filtered out of the response. | FilterPreferencesCombo |
None. |
| DiagnosingCodes | Collection of codes for diseases being diagnosed. | Collection of ConditionIdentifier |
Required |
| DiagnosedCodes | Collection of diagnosis codes for diagnosed diseases. | Collection of ConditionIdentifier |
None. |
| PrescribingDrugs | Collection of identifers for drugs being prescribed. | Collection of ADRDrugIdentifier |
Required |
| PrescribedDrugs | Collection of identfiers for drugs currently prescribed. | Collection of ADRDrugIdentifier |
None. |
| IgnoreDiagnosed | Set this to true to ignore the diagnosed collection of codes when matching drugs. Default is false. | boolean |
None. |
| IgnorePrescribed | Set this to true to ignore the prescribed collection of drugs when matching diagnosis. Default is false. | boolean |
None. |
| DateOfBirth | Used to filter the response based on a calculated age. API converts Date of Birth (DOB) into age and then matches to an age group. | date |
Required |
| Gender | Used to filter based on gender. Default is both. | GenderEnum |
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:
{
"FilterPreferences": {
"PatientCombo": [
{
"Id1": {
"IdType": "IngredientId",
"Id": "1"
},
"Id2": {
"IdType": "IngredientId",
"Id": "2"
}
},
{
"Id1": {
"IdType": "IngredientId",
"Id": "3"
},
"Id2": {
"IdType": "IngredientId",
"Id": "4"
}
}
],
"PhysicianCombo": [
{
"Id1": {
"IdType": "IngredientId",
"Id": "5"
},
"Id2": {
"IdType": "IngredientId",
"Id": "6"
}
},
{
"Id1": {
"IdType": "IngredientId",
"Id": "7"
},
"Id2": {
"IdType": "IngredientId",
"Id": "8"
}
}
],
"Patient": [
{
"IdType": "IngredientId",
"Id": "9"
},
{
"IdType": "IngredientId",
"Id": "10"
}
],
"Physician": [
{
"IdType": "IngredientId",
"Id": "11"
},
{
"IdType": "IngredientId",
"Id": "12"
}
]
},
"DiagnosingCodes": [
{
"IdType": "ICD10",
"Id": "123ABC13"
},
{
"IdType": "ICD10",
"Id": "123ABC14"
}
],
"DiagnosedCodes": [
{
"IdType": "ICD10",
"Id": "123ABC15"
},
{
"IdType": "ICD10",
"Id": "123ABC16"
}
],
"PrescribingDrugs": [
{
"IdType": "NDC11",
"Id": "12345-6789-08"
},
{
"IdType": "NDC11",
"Id": "12345-6789-00"
}
],
"PrescribedDrugs": [
{
"IdType": "NDC11",
"Id": "12345-6789-01"
},
{
"IdType": "NDC11",
"Id": "12345-6789-02"
}
],
"IgnoreDiagnosed": false,
"IgnorePrescribed": false,
"DateOfBirth": "2024-05-18",
"Gender": "Female",
"AccessToken": "T25lX0hhcHB5X0FuZF9TYXRpc2ZpZWRfR1NERF9DdXN0b21lcl9TYW1wbGVfQWNjZXNzVG9rZW4="
}
Response Information
Resource Description
DrugDiseaseScreeningResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| ScreenedDrugs | A collection of drug identifiers screened for the given condition or diagnosis identifiers. | Collection of DrugDiseaseDrugScreeningDetail |
None. |
Response Formats
application/json, text/json
Sample:
{
"ScreenedDrugs": [
{
"ScreenedDrug": {
"RequestSource": "Prescribing",
"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."
},
"Contraindications": [
{
"BoxedWarning": true,
"Condition": {
"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."
}
]
},
"MonographSectionId": 3,
"AgeBands": [
{
"Name": "Sample Name text.",
"Gender": "Female"
},
{
"Name": "Sample Name text.",
"Gender": "Female"
}
],
"Message": "Sample Message text."
},
{
"BoxedWarning": true,
"Condition": {
"ConditionId": {
"IdType": "ICD10",
"Id": "123ABC4"
},
"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."
}
]
},
"MonographSectionId": 5,
"AgeBands": [
{
"Name": "Sample Name text.",
"Gender": "Female"
},
{
"Name": "Sample Name text.",
"Gender": "Female"
}
],
"Message": "Sample Message text."
}
],
"Message": "Sample Message text."
},
{
"ScreenedDrug": {
"RequestSource": "Prescribing",
"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."
},
"Contraindications": [
{
"BoxedWarning": true,
"Condition": {
"ConditionId": {
"IdType": "ICD10",
"Id": "123ABC7"
},
"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."
}
]
},
"MonographSectionId": 8,
"AgeBands": [
{
"Name": "Sample Name text.",
"Gender": "Female"
},
{
"Name": "Sample Name text.",
"Gender": "Female"
}
],
"Message": "Sample Message text."
},
{
"BoxedWarning": true,
"Condition": {
"ConditionId": {
"IdType": "ICD10",
"Id": "123ABC9"
},
"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."
}
]
},
"MonographSectionId": 10,
"AgeBands": [
{
"Name": "Sample Name text.",
"Gender": "Female"
},
{
"Name": "Sample Name text.",
"Gender": "Female"
}
],
"Message": "Sample Message text."
}
],
"Message": "Sample Message text."
}
]
}