NameDescriptionTypeAdditional information
LabelStatus Indicates whether to include on-label or off-label indications for the drug in the response. Default is both. LabelStatusEnum

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.

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