GET api/DrugCompendia/GetEntireCompendium/{accessKey}

Retrieves the entire published Drugs and Biologics compendia. Please note this is a large dataset so please limit your calls to this endpoint

Request Information

URI Parameters

Name	Description	Type	Additional information
accessKey		string	Required

Body Parameters

None.

Response Information

Resource Description

CompendiumRequest

Name	Type	Additional information
IsValid	boolean	None.
Message	string	None.
CompendiumRecords	Collection of CompendiumRecord	None.

Response Formats

application/json, text/json

Sample:

{
  "IsValid": true,
  "Message": "sample string 2",
  "CompendiumRecords": [
    {
      "MasterID": 1,
      "DrugCompendiumId": 2,
      "PublishDate": "2024-11-23T17:33:31.4266909-05:00",
      "VersionNumber": "sample string 3",
      "Disease": "sample string 4",
      "DiseaseId": 5,
      "Agent": {
        "AgentID": 1,
        "AgentDesc": "sample string 2",
        "FDAIndication": "sample string 3",
        "Pharmclass": "sample string 4"
      },
      "Brands": [
        {
          "BrandID": 1,
          "BrandDesc": "sample string 2",
          "FDAURL": "sample string 3"
        },
        {
          "BrandID": 1,
          "BrandDesc": "sample string 2",
          "FDAURL": "sample string 3"
        }
      ],
      "ICD10Codes": [
        {
          "ICD10ID": 1,
          "Code": "sample string 2",
          "Description": "sample string 3"
        },
        {
          "ICD10ID": 1,
          "Code": "sample string 2",
          "Description": "sample string 3"
        }
      ],
      "PharmClass": "sample string 6",
      "Histology": "sample string 7",
      "Route": "sample string 8",
      "RecommendedUse": "sample string 9",
      "Categories": [
        {
          "CategoryType": "sample string 1",
          "Comment": "sample string 2"
        },
        {
          "CategoryType": "sample string 1",
          "Comment": "sample string 2"
        }
      ],
      "OrderTemplates": [
        {
          "OrderTemplateID": "sample string 1",
          "OrderTemplateDesc": "sample string 2",
          "CourseTitle": "sample string 3",
          "OTSAcronym": "sample string 4",
          "Regimen": "sample string 5"
        },
        {
          "OrderTemplateID": "sample string 1",
          "OrderTemplateDesc": "sample string 2",
          "CourseTitle": "sample string 3",
          "OTSAcronym": "sample string 4",
          "Regimen": "sample string 5"
        }
      ],
      "BillingCodes": [
        {
          "Code": "sample string 1"
        },
        {
          "Code": "sample string 1"
        }
      ]
    },
    {
      "MasterID": 1,
      "DrugCompendiumId": 2,
      "PublishDate": "2024-11-23T17:33:31.4266909-05:00",
      "VersionNumber": "sample string 3",
      "Disease": "sample string 4",
      "DiseaseId": 5,
      "Agent": {
        "AgentID": 1,
        "AgentDesc": "sample string 2",
        "FDAIndication": "sample string 3",
        "Pharmclass": "sample string 4"
      },
      "Brands": [
        {
          "BrandID": 1,
          "BrandDesc": "sample string 2",
          "FDAURL": "sample string 3"
        },
        {
          "BrandID": 1,
          "BrandDesc": "sample string 2",
          "FDAURL": "sample string 3"
        }
      ],
      "ICD10Codes": [
        {
          "ICD10ID": 1,
          "Code": "sample string 2",
          "Description": "sample string 3"
        },
        {
          "ICD10ID": 1,
          "Code": "sample string 2",
          "Description": "sample string 3"
        }
      ],
      "PharmClass": "sample string 6",
      "Histology": "sample string 7",
      "Route": "sample string 8",
      "RecommendedUse": "sample string 9",
      "Categories": [
        {
          "CategoryType": "sample string 1",
          "Comment": "sample string 2"
        },
        {
          "CategoryType": "sample string 1",
          "Comment": "sample string 2"
        }
      ],
      "OrderTemplates": [
        {
          "OrderTemplateID": "sample string 1",
          "OrderTemplateDesc": "sample string 2",
          "CourseTitle": "sample string 3",
          "OTSAcronym": "sample string 4",
          "Regimen": "sample string 5"
        },
        {
          "OrderTemplateID": "sample string 1",
          "OrderTemplateDesc": "sample string 2",
          "CourseTitle": "sample string 3",
          "OTSAcronym": "sample string 4",
          "Regimen": "sample string 5"
        }
      ],
      "BillingCodes": [
        {
          "Code": "sample string 1"
        },
        {
          "Code": "sample string 1"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<CompendiumRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="CompendiumRequest">
  <CompendiumRecords>
    <CompendiumRecord>
      <Agent>
        <AgentDesc>sample string 2</AgentDesc>
        <AgentID>1</AgentID>
        <FDAIndication>sample string 3</FDAIndication>
        <Pharmclass>sample string 4</Pharmclass>
      </Agent>
      <BillingCodes>
        <BillingCode>
          <Code>sample string 1</Code>
        </BillingCode>
        <BillingCode>
          <Code>sample string 1</Code>
        </BillingCode>
      </BillingCodes>
      <Brands>
        <Brand>
          <BrandDesc>sample string 2</BrandDesc>
          <BrandID>1</BrandID>
          <FDAURL>sample string 3</FDAURL>
        </Brand>
        <Brand>
          <BrandDesc>sample string 2</BrandDesc>
          <BrandID>1</BrandID>
          <FDAURL>sample string 3</FDAURL>
        </Brand>
      </Brands>
      <Categories>
        <Category>
          <CategoryType>sample string 1</CategoryType>
          <Comment>sample string 2</Comment>
        </Category>
        <Category>
          <CategoryType>sample string 1</CategoryType>
          <Comment>sample string 2</Comment>
        </Category>
      </Categories>
      <Disease>sample string 4</Disease>
      <DiseaseId>5</DiseaseId>
      <DrugCompendiumId>2</DrugCompendiumId>
      <Histology>sample string 7</Histology>
      <ICD10Codes>
        <ICD10Code>
          <Code>sample string 2</Code>
          <Description>sample string 3</Description>
          <ICD10ID>1</ICD10ID>
        </ICD10Code>
        <ICD10Code>
          <Code>sample string 2</Code>
          <Description>sample string 3</Description>
          <ICD10ID>1</ICD10ID>
        </ICD10Code>
      </ICD10Codes>
      <MasterID>1</MasterID>
      <OrderTemplates>
        <OrderTemplate>
          <CourseTitle>sample string 3</CourseTitle>
          <OTSAcronym>sample string 4</OTSAcronym>
          <OrderTemplateDesc>sample string 2</OrderTemplateDesc>
          <OrderTemplateID>sample string 1</OrderTemplateID>
          <Regimen>sample string 5</Regimen>
        </OrderTemplate>
        <OrderTemplate>
          <CourseTitle>sample string 3</CourseTitle>
          <OTSAcronym>sample string 4</OTSAcronym>
          <OrderTemplateDesc>sample string 2</OrderTemplateDesc>
          <OrderTemplateID>sample string 1</OrderTemplateID>
          <Regimen>sample string 5</Regimen>
        </OrderTemplate>
      </OrderTemplates>
      <PharmClass>sample string 6</PharmClass>
      <PublishDate>2024-11-23T17:33:31.4266909-05:00</PublishDate>
      <RecommendedUse>sample string 9</RecommendedUse>
      <Route>sample string 8</Route>
      <VersionNumber>sample string 3</VersionNumber>
    </CompendiumRecord>
    <CompendiumRecord>
      <Agent>
        <AgentDesc>sample string 2</AgentDesc>
        <AgentID>1</AgentID>
        <FDAIndication>sample string 3</FDAIndication>
        <Pharmclass>sample string 4</Pharmclass>
      </Agent>
      <BillingCodes>
        <BillingCode>
          <Code>sample string 1</Code>
        </BillingCode>
        <BillingCode>
          <Code>sample string 1</Code>
        </BillingCode>
      </BillingCodes>
      <Brands>
        <Brand>
          <BrandDesc>sample string 2</BrandDesc>
          <BrandID>1</BrandID>
          <FDAURL>sample string 3</FDAURL>
        </Brand>
        <Brand>
          <BrandDesc>sample string 2</BrandDesc>
          <BrandID>1</BrandID>
          <FDAURL>sample string 3</FDAURL>
        </Brand>
      </Brands>
      <Categories>
        <Category>
          <CategoryType>sample string 1</CategoryType>
          <Comment>sample string 2</Comment>
        </Category>
        <Category>
          <CategoryType>sample string 1</CategoryType>
          <Comment>sample string 2</Comment>
        </Category>
      </Categories>
      <Disease>sample string 4</Disease>
      <DiseaseId>5</DiseaseId>
      <DrugCompendiumId>2</DrugCompendiumId>
      <Histology>sample string 7</Histology>
      <ICD10Codes>
        <ICD10Code>
          <Code>sample string 2</Code>
          <Description>sample string 3</Description>
          <ICD10ID>1</ICD10ID>
        </ICD10Code>
        <ICD10Code>
          <Code>sample string 2</Code>
          <Description>sample string 3</Description>
          <ICD10ID>1</ICD10ID>
        </ICD10Code>
      </ICD10Codes>
      <MasterID>1</MasterID>
      <OrderTemplates>
        <OrderTemplate>
          <CourseTitle>sample string 3</CourseTitle>
          <OTSAcronym>sample string 4</OTSAcronym>
          <OrderTemplateDesc>sample string 2</OrderTemplateDesc>
          <OrderTemplateID>sample string 1</OrderTemplateID>
          <Regimen>sample string 5</Regimen>
        </OrderTemplate>
        <OrderTemplate>
          <CourseTitle>sample string 3</CourseTitle>
          <OTSAcronym>sample string 4</OTSAcronym>
          <OrderTemplateDesc>sample string 2</OrderTemplateDesc>
          <OrderTemplateID>sample string 1</OrderTemplateID>
          <Regimen>sample string 5</Regimen>
        </OrderTemplate>
      </OrderTemplates>
      <PharmClass>sample string 6</PharmClass>
      <PublishDate>2024-11-23T17:33:31.4266909-05:00</PublishDate>
      <RecommendedUse>sample string 9</RecommendedUse>
      <Route>sample string 8</Route>
      <VersionNumber>sample string 3</VersionNumber>
    </CompendiumRecord>
  </CompendiumRecords>
  <IsValid>true</IsValid>
  <Message>sample string 2</Message>
</CompendiumRequest>