GET api/FirstDatabankMedKnowledge/DoseScreen

DoseScreen. Provides dosage checking based on a patient’s profile.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
DOB

string

None.

WeightInKg

decimal number

None.

BSA

decimal number

None.

CCL

decimal number

None.

Medications

Collection of ICcxInputDrugOrder

None.

ConditionIds

Collection of string

None.

AllergyIds

Collection of string

None.

Body Parameters

None.

Request Formats

application/json

Sample:
/DoseScreen?profile={
  "DOB": "1998/02/10",
  "WeightInKg": 80.0,
  "BSA": 1.96,
  "CCL": null,
  "Medications": [
    {
      "DrugId": "FDB.DISPDRUG+152894",
      "Prospective": true,
      "ClinicalRouteId": 212,
      "DoseAmount": 40.0,
      "PreviouslyAdministeredAmount": null,
      "DoseAmountUnitId": 367,
      "FrequencyId": 8,
      "DoseTypeId": 2,
      "Duration": null,
      "DurationUnitId": null
    },
    {
      "DrugId": "FDB.DISPGEN+8996",
      "Prospective": true,
      "ClinicalRouteId": 212,
      "DoseAmount": 500.0,
      "PreviouslyAdministeredAmount": null,
      "DoseAmountUnitId": 367,
      "FrequencyId": 9,
      "DoseTypeId": 2,
      "Duration": 30,
      "DurationUnitId": 133
    },
    {
      "DrugId": "FDB.DISPDRUG+197034",
      "Prospective": true,
      "ClinicalRouteId": 212,
      "DoseAmount": 40.0,
      "PreviouslyAdministeredAmount": null,
      "DoseAmountUnitId": 367,
      "FrequencyId": 1,
      "DoseTypeId": 2,
      "Duration": null,
      "DurationUnitId": null
    }
  ],
  "ConditionIds": [
    "FDB.MEDCON+01-861",
    "FDB.MEDCON+07-604",
    "FDB.MEDCON+01-274"
  ],
  "AllergyIds": [
    "FDB.DRUGNAME+3138",
    "FDB.INGREDIENT+3107",
    "FDB.ALGNGRP+478"
  ]
}

Response Information

Resource Description

ICcxDoseScreenCollection
NameDescriptionTypeAdditional information
Doses

Collection of ICcxDoseScreen

None.

NotProcessed

Collection of string

None.

GcnSeqNoNotProcessed

Collection of integer

None.

MedIdNotProcessed

Collection of integer

None.

NdcNotProcessed

Collection of string

None.

OrdMedIdNotProcessed

Collection of integer

None.

DtoVersion

string

None.

Response Formats

application/json, text/json, text/javascript

Sample:
{
  "Doses": [
    {
      "Order": null,
      "Drug": {
        "MedId": 152894,
        "GCNSeqNo": null,
        "NDC": null,
        "Description": "furosemide 40 mg tablet",
        "DrugName": "furosemide"
      },
      "TypedDoseScreens": [
        {
          "DoseTypeCode": 1,
          "DoseType": "Loading",
          "DoseDescriprion": null,
          "DoseScreens": [
            {
              "Messages": [
                "Screening supports the ordered drug. However, the combination of patient and order information does not result in a match."
              ],
              "SingleDose": {
                "ScreenMessage": "",
                "CcxStatus": "Unable To Check. Invalid Order",
                "StatusId": 0
              },
              "Dose": {
                "ScreenMessage": "",
                "CcxStatus": "Unable To Check. Invalid Order",
                "StatusId": 0
              },
              "Frequency": {
                "ScreenMessage": "",
                "CcxStatus": "Unable To Check. Invalid Order",
                "StatusId": 0
              },
              "Duration": {
                "ScreenMessage": "",
                "CcxStatus": "Unable To Check. Invalid Order",
                "StatusId": 0
              },
              "MaxLifeTime": {
                "ScreenMessage": "",
                "CcxStatus": "Unable To Check. Invalid Order",
                "StatusId": 0
              }
            }
          ]
        },
        {
          "DoseTypeCode": 2,
          "DoseType": "Maintenance",
          "DoseDescriprion": null,
          "DoseScreens": [
            {
              "Messages": [
                "Renal function is important in this drug's elimination. Dosing adjustment should be considered in patients with estimated Creatinine Clearance Level at or below 20 milliliters/minute.",
                "Hepatic function is important in this drug's metabolism. Dosing adjustment should be considered in patients with hepatic impairment."
              ],
              "SingleDose": {
                "ScreenMessage": "",
                "CcxStatus": "Within Clinical",
                "StatusId": 11
              },
              "Dose": {
                "ScreenMessage": "",
                "CcxStatus": "Within Clinical",
                "StatusId": 11
              },
              "Frequency": {
                "ScreenMessage": "",
                "CcxStatus": "Within Clinical",
                "StatusId": 11
              },
              "Duration": {
                "ScreenMessage": "The database contains duration information, but no duration information was supplied by the user.",
                "CcxStatus": "Unable To Check. No Data Provided",
                "StatusId": 6
              },
              "MaxLifeTime": {
                "ScreenMessage": "",
                "CcxStatus": "Within Clinical",
                "StatusId": 11
              }
            }
          ]
        },
        {
          "DoseTypeCode": 7,
          "DoseType": "Single Dose",
          "DoseDescriprion": null,
          "DoseScreens": [
            {
              "Messages": [
                "Renal function is important in this drug's elimination. Dosing adjustment should be considered in patients with estimated Creatinine Clearance Level at or below 20 milliliters/minute.",
                "Hepatic function is important in this drug's metabolism. Dosing adjustment should be considered in patients with hepatic impairment."
              ],
              "SingleDose": {
                "ScreenMessage": "",
                "CcxStatus": "Within Clinical",
                "StatusId": 11
              },
              "Dose": {
                "ScreenMessage": "",
                "CcxStatus": "Within Clinical",
                "StatusId": 11
              },
              "Frequency": {
                "ScreenMessage": "",
                "CcxStatus": "Within Clinical",
                "StatusId": 11
              },
              "Duration": {
                "ScreenMessage": "The database contains duration information, but no duration information was supplied by the user.",
                "CcxStatus": "Unable To Check. No Data Provided",
                "StatusId": 6
              },
              "MaxLifeTime": {
                "ScreenMessage": "",
                "CcxStatus": "Within Clinical",
                "StatusId": 11
              }
            }
          ]
        }
      ],
      "DtoVersion": "1.2"
    },
    {
      "Order": null,
      "Drug": {
        "MedId": null,
        "GCNSeqNo": 8996,
        "NDC": null,
        "Description": "AMOXICILLIN 500 mg ORAL capsule",
        "DrugName": "amoxicillin"
      },
      "TypedDoseScreens": [
        {
          "DoseTypeCode": 2,
          "DoseType": "Maintenance",
          "DoseDescriprion": null,
          "DoseScreens": [
            {
              "Messages": [
                "Renal function is important in this drug's elimination. Dosing adjustment should be considered in patients with estimated Creatinine Clearance Level at or below 50 milliliters/minute."
              ],
              "SingleDose": {
                "ScreenMessage": "",
                "CcxStatus": "Within Clinical",
                "StatusId": 11
              },
              "Dose": {
                "ScreenMessage": "",
                "CcxStatus": "Within Clinical",
                "StatusId": 11
              },
              "Frequency": {
                "ScreenMessage": "",
                "CcxStatus": "Within Clinical",
                "StatusId": 11
              },
              "Duration": {
                "ScreenMessage": "Duration of 30 days exceeds the maximum duration of 14 days.",
                "CcxStatus": "Exceeds Max",
                "StatusId": 3
              },
              "MaxLifeTime": {
                "ScreenMessage": "",
                "CcxStatus": "Within Clinical",
                "StatusId": 11
              }
            }
          ]
        }
      ],
      "DtoVersion": "1.2"
    },
    {
      "Order": null,
      "Drug": {
        "MedId": 197034,
        "GCNSeqNo": null,
        "NDC": null,
        "Description": "codeine sulfate 15 mg tablet",
        "DrugName": "codeine sulfate"
      },
      "TypedDoseScreens": [
        {
          "DoseTypeCode": 2,
          "DoseType": "Maintenance",
          "DoseDescriprion": null,
          "DoseScreens": [
            {
              "Messages": [
                "Renal function is important in this drug's elimination. Dosing adjustment should be considered in patients with estimated Creatinine Clearance Level at or below 50 milliliters/minute.",
                "Hepatic function is important in this drug's metabolism. Dosing adjustment should be considered in patients with hepatic impairment."
              ],
              "SingleDose": {
                "ScreenMessage": "",
                "CcxStatus": "Within Clinical",
                "StatusId": 11
              },
              "Dose": {
                "ScreenMessage": "Total dose of 480 milligrams/day exceeds the maximum daily dose of 360 milligrams/day.",
                "CcxStatus": "Exceeds Max",
                "StatusId": 3
              },
              "Frequency": {
                "ScreenMessage": "Frequency of 12 administrations per day exceeds the frequency range of 1 to 6 administrations per day.",
                "CcxStatus": "Exceeds High",
                "StatusId": 4
              },
              "Duration": {
                "ScreenMessage": "The database contains duration information, but no duration information was supplied by the user.",
                "CcxStatus": "Unable To Check. No Data Provided",
                "StatusId": 6
              },
              "MaxLifeTime": {
                "ScreenMessage": "",
                "CcxStatus": "Within Clinical",
                "StatusId": 11
              }
            }
          ]
        }
      ],
      "DtoVersion": "1.2"
    }
  ],
  "NotProcessed": [],
  "GcnSeqNoNotProcessed": [],
  "MedIdNotProcessed": [],
  "NdcNotProcessed": [],
  "OrdMedIdNotProcessed": [],
  "DtoVersion": "1.2"
}