| Name | Description | Type | Additional information |
|---|---|---|---|
| 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 ADRDrugIdentifier |
Required |
| PrescribedDrugs | Use the PrescribedDrugs collection to pass in the identifiers of drugs that are considered active on the patient's medical history. | Collection of ADRDrugIdentifier |
None. |
| DateOfBirth | The GSDD API converts the DateOfBirth value into an age and then matches to an age group. In GSDD, childbearing age (CBA) is defined as female gender with an age range of 13-50 years. If the DateOfBirth value indicates that the age is not within the childbearing age range, then the method returns the following message: “Input age is not a Child Bearing Age.” If no value is entered, the method returns all possible results for all pregnancy and lactation categories. | date |
None. |
| FilterBy | Provides option to filter search results by pregnancy and lactation categories. If no value is included in the request, then the method returns information for all pregnancy and lactation categories. | PregnancyAndLactationEnum |
None. |
| Trimester | The numeric pregnancy trimester number. If no value is included in the request, then the method returns information for all pregnancy trimesters. | TrimesterEnum |
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 |
PregnancyAndLactationScreeningAlertRequest
Provides the clinician with alerts on medication that represents a patient’s prescribed and/or prescribing therapy for those females of childbearing age who may be pregnant and/or lactating, based on supplied drug identifiers and optional filters. (NOTE: In GSDD, childbearing age (CBA) is defined as female gender with an age range of 13-50 years.)