NameDescriptionTypeAdditional information
ControlledSubstanceMaxOccurrences Numeric value indicating the maximum number of Federal DEA controlled substances allowed in a patient’s regimen before returning a duplicate controlled substances event. Although the API accepts Package, Product, Marketed Product, Specific Product, and Generic Product Clinical identifiers for Prescribed or Prescribing colections, only Packages and Products return duplicate controlled substance warnings, since Gold Standard hierarchy concepts do not contain Federal DEA classification values. integer

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, indications, classifications, etc., for each supplied identifier or combination pair of identifiers are filtered out of the response. FilterPreferencesCombo

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