Name | Description | Type | Additional information |
---|---|---|---|
Strength | Information-only request = N/A. Screening request = REQUIRED. A numeric value that represents the amount of the active ingredient. Used to verify that the dosing information is acceptable. The value should be equal to the amount of active ingredient being administered or prescribed. | decimal number |
None. |
UnitCode | Information-only request = N/A. Screening request = REQUIRED. The Gold Standard unit of measurement for the Strength parameter value. The UnitCode must match the units used in the commercially supplied product. If the UnitCode does not correctly match the Strength or is not the correct UnitCode for a particular ingredient, dosage range screening will not occur. | string |
None. |
Frequency | Information-only request = N/A. Screening request = REQUIRED. This number represents how many times in a given interval the Strength is administered or is being prescribed. Dosage frequency (when the unit strength is per-dose.) Default Value = ‘1’ | decimal number |
None. |
Interval | Information-only request = N/A. Screening request = REQUIRED. The number of days between doses. Associated with the Frequency parameter value. Default Value = ‘1’ | decimal number |
None. |
Weight | A numeric value that represents the patient’s weight. Used to calculate the min/max/usual dosing. Required for Screening calls if the drug has a weight based dosing component as defined in the product labeling. Optional for non weight-based Information Only and Screening calls. | decimal number |
None. |
WeightUnit | Used to calculate the min/max/usual dosing. Enter one of the valid enumeration values to narrow search results. Required for Screening calls if the drug has a weight-based dosing component as defined in the product labeling. Optional for non weight-based Information Only and Screening calls. | WeightUnitEnum |
None. |
BodySurfaceArea | Also known as BSA. Used to calculate the min/max/usual dosing. Required for Screening calls if drug has a BSA-based dosing component as defined in the product labeling. Optional for non BSA-based Information Only and Screening calls. Used to calculate minimum/maximum and usual dosage based on the BSA. If BSA is entered – API calculates dosing based on the BSA and returns the dose and the BSA dosing formula. If BSA is required and not entered – returns an error message stating that a supported BSA is required. | decimal number |
None. |
PatientExperience | Returns dosing data for the applicable patient opioid experience. Enter one of the valid enumeration values to narrow search results. Used only for opioids; indicates a patient’s tolerance. If value is entered – API only returns data for the patient opioid experience entered. Information Only call - If value is not entered – API returns both Naïve and Experienced data. Screening call - If value is not entered – API defaults to ‘Naïve’ and returns only naïve data. | PatientExperienceEnum |
None. |
GestationalAge | Represents the number of weeks premature. Returns the dosing data for the applicable gestational age. Requires DateOfBirth parameter value to be provided. The API performs dose checking for the range as identified by Gestational Age, and returns the appropriate message (above/below/within range). Only used as criteria if the age entered is less than or equal to 179 days. If specified age is greater than 6 months (greater than or equal to 179 days), then Gestational Age is not considered. If a value is entered – API returns data only for that gestational age, if available in the product labeling. If a value is not entered – API returns dosage information for the DateOfBirth value provided. If gestational age is not specified in request, the API assumes full term (40 weeks). | integer |
None. |
DoseCheckIngredientDose
Represents dose check ingredient dose information.