Name | Description | Type | Additional information |
---|---|---|---|
LanguageCode | The language code for the warning label. | string |
Required |
MaxLines | Specify the maximum number of lines a warning label can occupy. The API limits the warning label text to the maximum lines value. The default is: 5 | integer |
None. |
CharsPerLine | Specify the the maximum character per line. The API auto-adjusts the warning label text to break before the maximum characters-per-line value. The default is: 24 | 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, 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 |
DrugToWarningLabelRequest
Represents a drug to warning label request.