POST api/DoseCheckBySpecificProduct
WARNING: This method is now deprecated and will be removed from the next major GSDD release.
Use DoseCheckInfo or DoseCheckScreening instead.
Informs the user whether dosing information entered for a specific product dosage form (in NCPDP billing units) is below the minimum dose, above the maximum dose, or within a normal range for a given identifier. Retrieves dosing information by specific product dosage form (in NCPDP billing units) indicating if a provided dose is below the minimum dose, above the maximum dose, or within a normal range for a given identifier. Returns the numeric identifier for the associated Gold Standard Professional Drug Monograph’s ‘Max Dosage Limits Section’ for the drug, if licensed.
Informs the user whether dosing information entered for a specific product dosage form (in NCPDP billing units) is below the minimum dose, above the maximum dose, or within a normal range for a given identifier. Retrieves dosing information by specific product dosage form (in NCPDP billing units) indicating if a provided dose is below the minimum dose, above the maximum dose, or within a normal range for a given identifier. Returns the numeric identifier for the associated Gold Standard Professional Drug Monograph’s ‘Max Dosage Limits Section’ for the drug, if licensed.
Request Information
URI Parameters
None.
Body Parameters
DoseCheckBySpecificProductRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| DrugId | The drug identifier. | IVDrugIdentifier |
Required |
| Dosing | Dosing input information. | DoseCheckSpecficProductDose |
Required |
| DateOfBirth | Information-only request = OPTIONAL. Screening request = REQUIRED. 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 |
None. |
| InformationOnly | Identifies whether the request is an Information Only or a Screening call. | 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 |
Request Formats
application/json, text/json
Sample:
{
"DrugId": {
"IdType": "NDC11",
"Id": "12345-6789-01"
},
"Dosing": {
"Quantity": 1.234,
"UnitCode": "ml",
"Frequency": 1.234,
"Interval": 1.234,
"Weight": 1.234,
"WeightUnit": "kg",
"BodySurfaceArea": 1.234,
"PatientExperience": "Experienced",
"GestationalAge": 7
},
"DateOfBirth": "2024-05-18",
"InformationOnly": false,
"AccessToken": "T25lX0hhcHB5X0FuZF9TYXRpc2ZpZWRfR1NERF9DdXN0b21lcl9TYW1wbGVfQWNjZXNzVG9rZW4="
}
Response Information
Resource Description
DoseCheckBySpecificProductResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| AgeGroups | A collection of Dose Check age group information; including ingredient dosing information by age band, if available and based on supplied input filters. | Collection of DoseCheckAgeGroupSpecificProduct |
None. |
| Messages | If applicable, a collection of the Dose Check or No Data Reason messages | Collection of DoseCheckMessage |
None. |
| LifeTimeMaxIngredients | A collection of Dose Check lifetime max dosing information; provided only if a Lifetime Max is applicable. The lifetime maximum ingredient/strength dosing information is for the ingredient or specific product. Lifetime Max refers to maximum total dose of the product that can be given over the course of a patient’s lifetime. Lifetime maximum dosing is only provided for the adult/geriatric population (ages 18+). | Collection of DoseCheckLifetimeMaxIngredient |
None. |
| HepaticImpairmentMayRequireDoseAdjustment | Informational alert that, if ‘true’, indicates that the dose needs to be adjusted. | boolean |
None. |
| RenalImpairmentMayRequireDoseAdjustment | Informational alert that, if ‘true’, indicates that the dose needs to be adjusted. | boolean |
None. |
| MonographSectionId | Numeric section identifier for the “Max Dosage Limits” section from the Professional Monograph, if applicable. | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"AgeGroups": [
{
"SpecificProductDosing": [
{
"DosingType": "Weight",
"PatientExperience": "Experienced",
"Message": {
"Id": 1,
"Message": "Sample Message text.",
"NoDataReason": {
"Id": 2,
"NoDataReason": "Sample NoDataReason text."
}
},
"CalculatedDose": {
"LowCalculated": {
"Formula": "Sample Formula text.",
"CalculatedValue": 1.234
},
"HighCalculated": {
"Formula": "Sample Formula text.",
"CalculatedValue": 1.234
},
"UsualCalculated": {
"Formula": "Sample Formula text.",
"CalculatedValue": 1.234
},
"Unit": "mg",
"Frequency": 1,
"Interval": 2
},
"DosingValues": {
"Low": 1.234,
"High": 1.234,
"Usual": 1.234,
"Unit": "mg",
"Frequency": 4,
"Interval": 5
}
},
{
"DosingType": "Weight",
"PatientExperience": "Experienced",
"Message": {
"Id": 3,
"Message": "Sample Message text.",
"NoDataReason": {
"Id": 4,
"NoDataReason": "Sample NoDataReason text."
}
},
"CalculatedDose": {
"LowCalculated": {
"Formula": "Sample Formula text.",
"CalculatedValue": 1.234
},
"HighCalculated": {
"Formula": "Sample Formula text.",
"CalculatedValue": 1.234
},
"UsualCalculated": {
"Formula": "Sample Formula text.",
"CalculatedValue": 1.234
},
"Unit": "mg",
"Frequency": 1,
"Interval": 2
},
"DosingValues": {
"Low": 1.234,
"High": 1.234,
"Usual": 1.234,
"Unit": "mg",
"Frequency": 4,
"Interval": 5
}
}
],
"Id": 5,
"Demographic": {
"Name": "Sample Name text.",
"MinAge": {
"AgeUnit": "Week",
"Value": 2
},
"MaxAge": {
"AgeUnit": "Week",
"Value": 2
},
"MinGestationalAge": {
"AgeUnit": "Week",
"Value": 2
},
"MaxGestationalAge": {
"AgeUnit": "Week",
"Value": 2
}
},
"Message": {
"Id": 6,
"Message": "Sample Message text.",
"NoDataReason": {
"Id": 7,
"NoDataReason": "Sample NoDataReason text."
}
},
"NoDataReason": {
"Id": 8,
"NoDataReason": "Sample NoDataReason text."
}
},
{
"SpecificProductDosing": [
{
"DosingType": "Weight",
"PatientExperience": "Experienced",
"Message": {
"Id": 9,
"Message": "Sample Message text.",
"NoDataReason": {
"Id": 10,
"NoDataReason": "Sample NoDataReason text."
}
},
"CalculatedDose": {
"LowCalculated": {
"Formula": "Sample Formula text.",
"CalculatedValue": 1.234
},
"HighCalculated": {
"Formula": "Sample Formula text.",
"CalculatedValue": 1.234
},
"UsualCalculated": {
"Formula": "Sample Formula text.",
"CalculatedValue": 1.234
},
"Unit": "mg",
"Frequency": 1,
"Interval": 2
},
"DosingValues": {
"Low": 1.234,
"High": 1.234,
"Usual": 1.234,
"Unit": "mg",
"Frequency": 4,
"Interval": 5
}
},
{
"DosingType": "Weight",
"PatientExperience": "Experienced",
"Message": {
"Id": 11,
"Message": "Sample Message text.",
"NoDataReason": {
"Id": 12,
"NoDataReason": "Sample NoDataReason text."
}
},
"CalculatedDose": {
"LowCalculated": {
"Formula": "Sample Formula text.",
"CalculatedValue": 1.234
},
"HighCalculated": {
"Formula": "Sample Formula text.",
"CalculatedValue": 1.234
},
"UsualCalculated": {
"Formula": "Sample Formula text.",
"CalculatedValue": 1.234
},
"Unit": "mg",
"Frequency": 1,
"Interval": 2
},
"DosingValues": {
"Low": 1.234,
"High": 1.234,
"Usual": 1.234,
"Unit": "mg",
"Frequency": 4,
"Interval": 5
}
}
],
"Id": 13,
"Demographic": {
"Name": "Sample Name text.",
"MinAge": {
"AgeUnit": "Week",
"Value": 2
},
"MaxAge": {
"AgeUnit": "Week",
"Value": 2
},
"MinGestationalAge": {
"AgeUnit": "Week",
"Value": 2
},
"MaxGestationalAge": {
"AgeUnit": "Week",
"Value": 2
}
},
"Message": {
"Id": 14,
"Message": "Sample Message text.",
"NoDataReason": {
"Id": 15,
"NoDataReason": "Sample NoDataReason text."
}
},
"NoDataReason": {
"Id": 16,
"NoDataReason": "Sample NoDataReason text."
}
}
],
"Messages": [
{
"Id": 17,
"Message": "Sample Message text.",
"NoDataReason": {
"Id": 18,
"NoDataReason": "Sample NoDataReason text."
}
},
{
"Id": 19,
"Message": "Sample Message text.",
"NoDataReason": {
"Id": 20,
"NoDataReason": "Sample NoDataReason text."
}
}
],
"LifeTimeMaxIngredients": [
{
"IngredientId": 21,
"IngredientName": "Sample IngredientName text.",
"Message": {
"Id": 22,
"Message": "Sample Message text.",
"NoDataReason": {
"Id": 23,
"NoDataReason": "Sample NoDataReason text."
}
},
"Value": 1.234,
"Unit": "mL"
},
{
"IngredientId": 24,
"IngredientName": "Sample IngredientName text.",
"Message": {
"Id": 25,
"Message": "Sample Message text.",
"NoDataReason": {
"Id": 26,
"NoDataReason": "Sample NoDataReason text."
}
},
"Value": 1.234,
"Unit": "mg"
}
],
"HepaticImpairmentMayRequireDoseAdjustment": true,
"RenalImpairmentMayRequireDoseAdjustment": true,
"MonographSectionId": 27
}