POST api/DrugToAllergy
Evaluates all drugs passed into either the Prescribed or Prescribing collections against the allergen marker(s) passed into the allergy identifiers collection.
Also provides ‘Alert Optimizer’ filtering options to reduce alert fatigue by suppressing alerts and/or excluding drug results based on individual clinician's preferences or by customizing results specific to a patient.
Request Information
URI Parameters
None.
Body Parameters
DrugToAllergyRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| AllergyIdentifiers | A collection of drug, ingredient, and/or allergy classification identifiers the patient may have an allergic reaction to. | Collection of AllergyIdentifier |
Required |
| CheckUnderDevelopment | The CheckUnderDevelopment parameter is used to check the input drug identifiers for monographs with interaction content still under development. This parameter is optional. It accepts a Boolean value (true/false) to turn on or off (default value is “false”). | boolean |
None. |
| PrescribingDrugs | Use the PrescribingDrugs collection to pass in the identifiers of drugs currently being dispensed. (i.e. Products being assigned to this patient during this dispensing/checking event.) | Collection of ClinicalDrugIdentifier |
Required |
| PrescribedDrugs | Use the PrescribedDrugs collection to pass in the identifiers of drugs that are considered active on the patient's medical history. If the IgnorePrescribed flag is false, then the PrescribedDrugs collection is required. | Collection of ClinicalDrugIdentifier |
None. |
| IgnorePrescribed | The IgnorePrescribed flag is used to disregard (or not to disregard) the PrescribedDrugs collection. If the Boolean value is set to ‘true’ the Clinical method only checks the PrescribingDrugs collection against the PrescribedDrugs collection, but does not check within the PrescribedDrugs collection itself. The IgnorePrescribed flag is optional. It accepts a Boolean value (true/false) to turn on or off (default is set to “false”). | boolean |
None. |
| FilterPreferences | All warnings, drugs, 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:
{
"AllergyIdentifiers": [
{
"IdType": "AllergyClassId",
"Id": "1"
},
{
"IdType": "AllergyClassId",
"Id": "2"
}
],
"CheckUnderDevelopment": true,
"PrescribingDrugs": [
{
"IdType": "NDC11",
"Id": "12345-6789-03"
},
{
"IdType": "NDC11",
"Id": "12345-6789-04"
}
],
"PrescribedDrugs": [
{
"IdType": "NDC11",
"Id": "12345-6789-05"
},
{
"IdType": "NDC11",
"Id": "12345-6789-06"
}
],
"IgnorePrescribed": false,
"FilterPreferences": {
"Patient": [
{
"IdType": "IngredientId",
"Id": "7"
},
{
"IdType": "IngredientId",
"Id": "8"
}
],
"Physician": [
{
"IdType": "IngredientId",
"Id": "9"
},
{
"IdType": "IngredientId",
"Id": "10"
}
]
},
"AccessToken": "T25lX0hhcHB5X0FuZF9TYXRpc2ZpZWRfR1NERF9DdXN0b21lcl9TYW1wbGVfQWNjZXNzVG9rZW4="
}
Response Information
Resource Description
DrugToAllergyResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| AllergyInteractions | A collection of drug identifiers that where screened for possible Drug to Allergy interactions. | Collection of AllergyInteractions |
None. |
| UnderDevelopment | When the CheckUnderDevelopment input parameter is set to 'true' in the request, this element returns collection of drug identifiers passed into the request with monograph interaction content still under development. | Collection of InteractionsUnderDevelopment |
None. |
| DrugsNotChecked | Any drug identifier passed into the request that is not found in the Gold Standard Drug Database is shown in the DrugsNotChecked collection. This allows all other drugs to be checked normally, while still alerting the user that an identifier passed into the request was not found. | Collection of ClinicalDrugIdentifier |
None. |
Response Formats
application/json, text/json
Sample:
{
"AllergyInteractions": [
{
"AllergyClassInteractions": [
{
"AllergyId": {
"IdType": "AllergyClassId",
"Id": "1"
},
"AllergyClassId": 2,
"AllergyClassName": "Sample AllergyClassName text.",
"Allergies": [
{
"InteractingAllergyClassId": 3,
"InteractingAllergyClassName": "Sample InteractingAllergyClassName text.",
"PrescribedIngredients": [
{
"Id": 4,
"Name": "Sample Name text."
},
{
"Id": 5,
"Name": "Sample Name text."
}
]
},
{
"InteractingAllergyClassId": 6,
"InteractingAllergyClassName": "Sample InteractingAllergyClassName text.",
"PrescribedIngredients": [
{
"Id": 7,
"Name": "Sample Name text."
},
{
"Id": 8,
"Name": "Sample Name text."
}
]
}
]
},
{
"AllergyId": {
"IdType": "AllergyClassId",
"Id": "9"
},
"AllergyClassId": 10,
"AllergyClassName": "Sample AllergyClassName text.",
"Allergies": [
{
"InteractingAllergyClassId": 11,
"InteractingAllergyClassName": "Sample InteractingAllergyClassName text.",
"PrescribedIngredients": [
{
"Id": 12,
"Name": "Sample Name text."
},
{
"Id": 13,
"Name": "Sample Name text."
}
]
},
{
"InteractingAllergyClassId": 14,
"InteractingAllergyClassName": "Sample InteractingAllergyClassName text.",
"PrescribedIngredients": [
{
"Id": 15,
"Name": "Sample Name text."
},
{
"Id": 16,
"Name": "Sample Name text."
}
]
}
]
}
],
"CrossSensitiveAllergyInteractions": [
{
"AllergyId": {
"IdType": "AllergyClassId",
"Id": "17"
},
"Name": "Sample Name text.",
"Allergies": [
{
"InteractingAllergyClassId": 18,
"InteractingAllergyClassName": "Sample InteractingAllergyClassName text.",
"PrescribedAllergyClasses": [
{
"InteractingAllergyClassId": 19,
"InteractingAllergyClassName": "Sample InteractingAllergyClassName text.",
"PrescribedIngredients": [
{
"Id": 20,
"Name": "Sample Name text."
},
{
"Id": 21,
"Name": "Sample Name text."
}
]
},
{
"InteractingAllergyClassId": 22,
"InteractingAllergyClassName": "Sample InteractingAllergyClassName text.",
"PrescribedIngredients": [
{
"Id": 23,
"Name": "Sample Name text."
},
{
"Id": 24,
"Name": "Sample Name text."
}
]
}
],
"PrescribedIngredients": [
{
"Id": 25,
"Name": "Sample Name text."
},
{
"Id": 26,
"Name": "Sample Name text."
}
]
},
{
"InteractingAllergyClassId": 27,
"InteractingAllergyClassName": "Sample InteractingAllergyClassName text.",
"PrescribedAllergyClasses": [
{
"InteractingAllergyClassId": 28,
"InteractingAllergyClassName": "Sample InteractingAllergyClassName text.",
"PrescribedIngredients": [
{
"Id": 29,
"Name": "Sample Name text."
},
{
"Id": 30,
"Name": "Sample Name text."
}
]
},
{
"InteractingAllergyClassId": 31,
"InteractingAllergyClassName": "Sample InteractingAllergyClassName text.",
"PrescribedIngredients": [
{
"Id": 32,
"Name": "Sample Name text."
},
{
"Id": 33,
"Name": "Sample Name text."
}
]
}
],
"PrescribedIngredients": [
{
"Id": 34,
"Name": "Sample Name text."
},
{
"Id": 35,
"Name": "Sample Name text."
}
]
}
]
},
{
"AllergyId": {
"IdType": "AllergyClassId",
"Id": "36"
},
"Name": "Sample Name text.",
"Allergies": [
{
"InteractingAllergyClassId": 37,
"InteractingAllergyClassName": "Sample InteractingAllergyClassName text.",
"PrescribedAllergyClasses": [
{
"InteractingAllergyClassId": 38,
"InteractingAllergyClassName": "Sample InteractingAllergyClassName text.",
"PrescribedIngredients": [
{
"Id": 39,
"Name": "Sample Name text."
},
{
"Id": 40,
"Name": "Sample Name text."
}
]
},
{
"InteractingAllergyClassId": 41,
"InteractingAllergyClassName": "Sample InteractingAllergyClassName text.",
"PrescribedIngredients": [
{
"Id": 42,
"Name": "Sample Name text."
},
{
"Id": 43,
"Name": "Sample Name text."
}
]
}
],
"PrescribedIngredients": [
{
"Id": 44,
"Name": "Sample Name text."
},
{
"Id": 45,
"Name": "Sample Name text."
}
]
},
{
"InteractingAllergyClassId": 46,
"InteractingAllergyClassName": "Sample InteractingAllergyClassName text.",
"PrescribedAllergyClasses": [
{
"InteractingAllergyClassId": 47,
"InteractingAllergyClassName": "Sample InteractingAllergyClassName text.",
"PrescribedIngredients": [
{
"Id": 48,
"Name": "Sample Name text."
},
{
"Id": 49,
"Name": "Sample Name text."
}
]
},
{
"InteractingAllergyClassId": 50,
"InteractingAllergyClassName": "Sample InteractingAllergyClassName text.",
"PrescribedIngredients": [
{
"Id": 51,
"Name": "Sample Name text."
},
{
"Id": 52,
"Name": "Sample Name text."
}
]
}
],
"PrescribedIngredients": [
{
"Id": 53,
"Name": "Sample Name text."
},
{
"Id": 54,
"Name": "Sample Name text."
}
]
}
]
}
],
"DirectAllergyInteractions": [
{
"AllergyId": {
"IdType": "AllergyClassId",
"Id": "55"
},
"Name": "Sample Name text."
},
{
"AllergyId": {
"IdType": "AllergyClassId",
"Id": "56"
},
"Name": "Sample Name text."
}
],
"IngredientFamilyAllergyInteractions": [
{
"AllergyId": {
"IdType": "AllergyClassId",
"Id": "57"
},
"IngredientName": "Sample IngredientName text.",
"IngredientFamilyName": "Sample IngredientFamilyName text.",
"PrescribedIngredients": [
{
"Id": 58,
"Name": "Sample Name text."
},
{
"Id": 59,
"Name": "Sample Name text."
}
]
},
{
"AllergyId": {
"IdType": "AllergyClassId",
"Id": "60"
},
"IngredientName": "Sample IngredientName text.",
"IngredientFamilyName": "Sample IngredientFamilyName text.",
"PrescribedIngredients": [
{
"Id": 61,
"Name": "Sample Name text."
},
{
"Id": 62,
"Name": "Sample Name text."
}
]
}
],
"DrugId": {
"IdType": "NDC11",
"Id": "12345-6789-00"
},
"DrugName": "Sample DrugName text.",
"RequestSource": "Prescribing"
},
{
"AllergyClassInteractions": [
{
"AllergyId": {
"IdType": "AllergyClassId",
"Id": "64"
},
"AllergyClassId": 65,
"AllergyClassName": "Sample AllergyClassName text.",
"Allergies": [
{
"InteractingAllergyClassId": 66,
"InteractingAllergyClassName": "Sample InteractingAllergyClassName text.",
"PrescribedIngredients": [
{
"Id": 67,
"Name": "Sample Name text."
},
{
"Id": 68,
"Name": "Sample Name text."
}
]
},
{
"InteractingAllergyClassId": 69,
"InteractingAllergyClassName": "Sample InteractingAllergyClassName text.",
"PrescribedIngredients": [
{
"Id": 70,
"Name": "Sample Name text."
},
{
"Id": 71,
"Name": "Sample Name text."
}
]
}
]
},
{
"AllergyId": {
"IdType": "AllergyClassId",
"Id": "72"
},
"AllergyClassId": 73,
"AllergyClassName": "Sample AllergyClassName text.",
"Allergies": [
{
"InteractingAllergyClassId": 74,
"InteractingAllergyClassName": "Sample InteractingAllergyClassName text.",
"PrescribedIngredients": [
{
"Id": 75,
"Name": "Sample Name text."
},
{
"Id": 76,
"Name": "Sample Name text."
}
]
},
{
"InteractingAllergyClassId": 77,
"InteractingAllergyClassName": "Sample InteractingAllergyClassName text.",
"PrescribedIngredients": [
{
"Id": 78,
"Name": "Sample Name text."
},
{
"Id": 79,
"Name": "Sample Name text."
}
]
}
]
}
],
"CrossSensitiveAllergyInteractions": [
{
"AllergyId": {
"IdType": "AllergyClassId",
"Id": "80"
},
"Name": "Sample Name text.",
"Allergies": [
{
"InteractingAllergyClassId": 81,
"InteractingAllergyClassName": "Sample InteractingAllergyClassName text.",
"PrescribedAllergyClasses": [
{
"InteractingAllergyClassId": 82,
"InteractingAllergyClassName": "Sample InteractingAllergyClassName text.",
"PrescribedIngredients": [
{
"Id": 83,
"Name": "Sample Name text."
},
{
"Id": 84,
"Name": "Sample Name text."
}
]
},
{
"InteractingAllergyClassId": 85,
"InteractingAllergyClassName": "Sample InteractingAllergyClassName text.",
"PrescribedIngredients": [
{
"Id": 86,
"Name": "Sample Name text."
},
{
"Id": 87,
"Name": "Sample Name text."
}
]
}
],
"PrescribedIngredients": [
{
"Id": 88,
"Name": "Sample Name text."
},
{
"Id": 89,
"Name": "Sample Name text."
}
]
},
{
"InteractingAllergyClassId": 90,
"InteractingAllergyClassName": "Sample InteractingAllergyClassName text.",
"PrescribedAllergyClasses": [
{
"InteractingAllergyClassId": 91,
"InteractingAllergyClassName": "Sample InteractingAllergyClassName text.",
"PrescribedIngredients": [
{
"Id": 92,
"Name": "Sample Name text."
},
{
"Id": 93,
"Name": "Sample Name text."
}
]
},
{
"InteractingAllergyClassId": 94,
"InteractingAllergyClassName": "Sample InteractingAllergyClassName text.",
"PrescribedIngredients": [
{
"Id": 95,
"Name": "Sample Name text."
},
{
"Id": 96,
"Name": "Sample Name text."
}
]
}
],
"PrescribedIngredients": [
{
"Id": 97,
"Name": "Sample Name text."
},
{
"Id": 98,
"Name": "Sample Name text."
}
]
}
]
},
{
"AllergyId": {
"IdType": "AllergyClassId",
"Id": "99"
},
"Name": "Sample Name text.",
"Allergies": [
{
"InteractingAllergyClassId": 100,
"InteractingAllergyClassName": "Sample InteractingAllergyClassName text.",
"PrescribedAllergyClasses": [
{
"InteractingAllergyClassId": 101,
"InteractingAllergyClassName": "Sample InteractingAllergyClassName text.",
"PrescribedIngredients": [
{
"Id": 102,
"Name": "Sample Name text."
},
{
"Id": 103,
"Name": "Sample Name text."
}
]
},
{
"InteractingAllergyClassId": 104,
"InteractingAllergyClassName": "Sample InteractingAllergyClassName text.",
"PrescribedIngredients": [
{
"Id": 105,
"Name": "Sample Name text."
},
{
"Id": 106,
"Name": "Sample Name text."
}
]
}
],
"PrescribedIngredients": [
{
"Id": 107,
"Name": "Sample Name text."
},
{
"Id": 108,
"Name": "Sample Name text."
}
]
},
{
"InteractingAllergyClassId": 109,
"InteractingAllergyClassName": "Sample InteractingAllergyClassName text.",
"PrescribedAllergyClasses": [
{
"InteractingAllergyClassId": 110,
"InteractingAllergyClassName": "Sample InteractingAllergyClassName text.",
"PrescribedIngredients": [
{
"Id": 111,
"Name": "Sample Name text."
},
{
"Id": 112,
"Name": "Sample Name text."
}
]
},
{
"InteractingAllergyClassId": 113,
"InteractingAllergyClassName": "Sample InteractingAllergyClassName text.",
"PrescribedIngredients": [
{
"Id": 114,
"Name": "Sample Name text."
},
{
"Id": 115,
"Name": "Sample Name text."
}
]
}
],
"PrescribedIngredients": [
{
"Id": 116,
"Name": "Sample Name text."
},
{
"Id": 117,
"Name": "Sample Name text."
}
]
}
]
}
],
"DirectAllergyInteractions": [
{
"AllergyId": {
"IdType": "AllergyClassId",
"Id": "118"
},
"Name": "Sample Name text."
},
{
"AllergyId": {
"IdType": "AllergyClassId",
"Id": "119"
},
"Name": "Sample Name text."
}
],
"IngredientFamilyAllergyInteractions": [
{
"AllergyId": {
"IdType": "AllergyClassId",
"Id": "120"
},
"IngredientName": "Sample IngredientName text.",
"IngredientFamilyName": "Sample IngredientFamilyName text.",
"PrescribedIngredients": [
{
"Id": 121,
"Name": "Sample Name text."
},
{
"Id": 122,
"Name": "Sample Name text."
}
]
},
{
"AllergyId": {
"IdType": "AllergyClassId",
"Id": "123"
},
"IngredientName": "Sample IngredientName text.",
"IngredientFamilyName": "Sample IngredientFamilyName text.",
"PrescribedIngredients": [
{
"Id": 124,
"Name": "Sample Name text."
},
{
"Id": 125,
"Name": "Sample Name text."
}
]
}
],
"DrugId": {
"IdType": "NDC11",
"Id": "12345-6789-00"
},
"DrugName": "Sample DrugName text.",
"RequestSource": "Prescribing"
}
],
"UnderDevelopment": [
{
"DrugId": {
"IdType": "NDC11",
"Id": "12345-6789-01"
},
"RequestSource": "Prescribing",
"MonographId": 128,
"Message": "Sample Message text."
},
{
"DrugId": {
"IdType": "NDC11",
"Id": "12345-6789-03"
},
"RequestSource": "Prescribing",
"MonographId": 130,
"Message": "Sample Message text."
}
],
"DrugsNotChecked": [
{
"IdType": "NDC11",
"Id": "12345-6789-05"
},
{
"IdType": "NDC11",
"Id": "12345-6789-06"
}
]
}