NameDescriptionTypeAdditional information
IncludeProfessionalNotes If this is set to 'true' the Professional notes for each possible interaction will be returned in the response. This is 'false' by default. boolean

None.

IncludeConsumerNotes If this is set to 'true' the Consumer notes for each possible interaction will be returned in the response. This is 'false' by default. boolean

None.

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