POST api/IVCompatibilityByDrug

Returns IV compatibility information based on the supplied drug identifier(s) and input filters.
  • Compatibility: returns compatible, incompatible, uncertain, and/or no data.
  • Administration Methods: returns compatible, incompatible, or uncertain for the following three administration methods:
    • Admixture
    • Syringe
    • Y-Site
  • Additional Information: optionally return any compatible/incompatible/uncertain detail and case study information as it is available from Trissel’s™ (including chemical stability, method, storage conditions, container, duration, and notations).
Also returns the numeric identifier for the associated Gold Standard Professional Drug Monograph’s ‘Intravenous Administration’ section for the drug, if applicable.


Request Information

URI Parameters

None.

Body Parameters

IVCompatibilityByDrugRequest
NameDescriptionTypeAdditional information
CompatibilityFilter2 Used to filter the results based on a second compatibility information option. IVCompatibilityFilterEnum

None.

AdministrationFilter Used to filter the results based on IV administration method. If no administration value is included in the request, then the method returns information for all IV administration methods. IVAdministrationFilterEnum

None.

DrugIdentifiers A collection of package, product, or Gold Standard concept input parameters for the for the requested IV compatibility information. Collection of IVDrugIdentifier

Required

IncludeAdditionalInfo Used to indicate if any detailed compatibility information should be included in the results. Trissel’s™ provides two levels of data: high-level compatible/incompatible/uncertain, or detailed stability and case study data for the compatibility result (including chemical stability, method, storage conditions, container, duration, and notations). If you want just high-level result, set to ‘false’. If want to know the ‘why’ of the result, set to ‘true’. boolean

None.

CompatibilityFilter Used to filter the results based on compatibility information. If no compatibility value is included in the request, then the method returns information for all compatibility information. IVCompatibilityFilterEnum

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:
{
  "CompatibilityFilter2": "Incompatible",
  "AdministrationFilter": "Syringe",
  "DrugIdentifiers": [
    {
      "IdType": "NDC11",
      "Id": "12345-6789-01"
    },
    {
      "IdType": "NDC11",
      "Id": "12345-6789-02"
    }
  ],
  "IncludeAdditionalInfo": true,
  "CompatibilityFilter": "Incompatible",
  "AccessToken": "T25lX0hhcHB5X0FuZF9TYXRpc2ZpZWRfR1NERF9DdXN0b21lcl9TYW1wbGVfQWNjZXNzVG9rZW4="
}

Response Information

Resource Description

IVCompatibilityByDrugResponse
NameDescriptionTypeAdditional information
DrugCombinations A collection IV compatibility result detail for the compared drugs, based on supplied drug identifier(s) and input filters. Collection of IVCompatibilityDrugComboAdminDetail

None.

Response Formats

application/json, text/json

Sample:
{
  "DrugCombinations": [
    {
      "Administration": "Syringe",
      "Compatibility": "Incompatible",
      "Drug1": {
        "DrugId": {
          "IdType": "NDC11",
          "Id": "12345-6789-01"
        },
        "Name": "Sample Name text.",
        "Manufacturer": "Sample Manufacturer text.",
        "MonographSectionId": 2
      },
      "Drug2": {
        "DrugId": {
          "IdType": "NDC11",
          "Id": "12345-6789-03"
        },
        "Name": "Sample Name text.",
        "Manufacturer": "Sample Manufacturer text.",
        "MonographSectionId": 4
      },
      "Cases": [
        {
          "VehicleDescription1": "Sample VehicleDescription1 text.",
          "Concentration1": 1.234,
          "ConcentrationUnits1": "Sample ConcentrationUnits1 text.",
          "VehicleDescription2": "Sample VehicleDescription2 text.",
          "Concentration2": 1.234,
          "ConcentrationUnits2": "Sample ConcentrationUnits2 text.",
          "Compatibility": "Incompatible",
          "ChemicalStability": "Sample ChemicalStability text.",
          "Container": "Sample Container text.",
          "Methods": "Sample Methods text.",
          "Notations": "Sample Notations text.",
          "PhysicalCompatibility": "Sample PhysicalCompatibility text.",
          "StorageConditions": "Sample StorageConditions text.",
          "StudyPeriod": "Sample StudyPeriod text.",
          "CompatibilityReference": {
            "Author": "Sample Author text.",
            "Title": "Sample Title text.",
            "Journal": "Sample Journal text.",
            "Year": "Sample Year text.",
            "Volume": "Sample Volume text.",
            "Pages": "Sample Pages text."
          },
          "Message": "Sample Message text."
        },
        {
          "VehicleDescription1": "Sample VehicleDescription1 text.",
          "Concentration1": 1.234,
          "ConcentrationUnits1": "Sample ConcentrationUnits1 text.",
          "VehicleDescription2": "Sample VehicleDescription2 text.",
          "Concentration2": 1.234,
          "ConcentrationUnits2": "Sample ConcentrationUnits2 text.",
          "Compatibility": "Incompatible",
          "ChemicalStability": "Sample ChemicalStability text.",
          "Container": "Sample Container text.",
          "Methods": "Sample Methods text.",
          "Notations": "Sample Notations text.",
          "PhysicalCompatibility": "Sample PhysicalCompatibility text.",
          "StorageConditions": "Sample StorageConditions text.",
          "StudyPeriod": "Sample StudyPeriod text.",
          "CompatibilityReference": {
            "Author": "Sample Author text.",
            "Title": "Sample Title text.",
            "Journal": "Sample Journal text.",
            "Year": "Sample Year text.",
            "Volume": "Sample Volume text.",
            "Pages": "Sample Pages text."
          },
          "Message": "Sample Message text."
        }
      ],
      "Message": "Sample Message text."
    },
    {
      "Administration": "Syringe",
      "Compatibility": "Incompatible",
      "Drug1": {
        "DrugId": {
          "IdType": "NDC11",
          "Id": "12345-6789-05"
        },
        "Name": "Sample Name text.",
        "Manufacturer": "Sample Manufacturer text.",
        "MonographSectionId": 6
      },
      "Drug2": {
        "DrugId": {
          "IdType": "NDC11",
          "Id": "12345-6789-07"
        },
        "Name": "Sample Name text.",
        "Manufacturer": "Sample Manufacturer text.",
        "MonographSectionId": 8
      },
      "Cases": [
        {
          "VehicleDescription1": "Sample VehicleDescription1 text.",
          "Concentration1": 1.234,
          "ConcentrationUnits1": "Sample ConcentrationUnits1 text.",
          "VehicleDescription2": "Sample VehicleDescription2 text.",
          "Concentration2": 1.234,
          "ConcentrationUnits2": "Sample ConcentrationUnits2 text.",
          "Compatibility": "Incompatible",
          "ChemicalStability": "Sample ChemicalStability text.",
          "Container": "Sample Container text.",
          "Methods": "Sample Methods text.",
          "Notations": "Sample Notations text.",
          "PhysicalCompatibility": "Sample PhysicalCompatibility text.",
          "StorageConditions": "Sample StorageConditions text.",
          "StudyPeriod": "Sample StudyPeriod text.",
          "CompatibilityReference": {
            "Author": "Sample Author text.",
            "Title": "Sample Title text.",
            "Journal": "Sample Journal text.",
            "Year": "Sample Year text.",
            "Volume": "Sample Volume text.",
            "Pages": "Sample Pages text."
          },
          "Message": "Sample Message text."
        },
        {
          "VehicleDescription1": "Sample VehicleDescription1 text.",
          "Concentration1": 1.234,
          "ConcentrationUnits1": "Sample ConcentrationUnits1 text.",
          "VehicleDescription2": "Sample VehicleDescription2 text.",
          "Concentration2": 1.234,
          "ConcentrationUnits2": "Sample ConcentrationUnits2 text.",
          "Compatibility": "Incompatible",
          "ChemicalStability": "Sample ChemicalStability text.",
          "Container": "Sample Container text.",
          "Methods": "Sample Methods text.",
          "Notations": "Sample Notations text.",
          "PhysicalCompatibility": "Sample PhysicalCompatibility text.",
          "StorageConditions": "Sample StorageConditions text.",
          "StudyPeriod": "Sample StudyPeriod text.",
          "CompatibilityReference": {
            "Author": "Sample Author text.",
            "Title": "Sample Title text.",
            "Journal": "Sample Journal text.",
            "Year": "Sample Year text.",
            "Volume": "Sample Volume text.",
            "Pages": "Sample Pages text."
          },
          "Message": "Sample Message text."
        }
      ],
      "Message": "Sample Message text."
    }
  ]
}