GET api/DrugCompendia/GetCompendiumByAgentIDAndDiseaseID/{accessKey}/{agentId}/{diseaseId}
Retrieves compendia by agentId and diseaseId
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| accessKey | string |
Required |
|
| agentId | integer |
Required |
|
| diseaseId | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
CompendiumRequest| Name | Description | 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,
"PublishDate": "2024-04-19T05:41:09.9918238-04:00",
"VersionNumber": "sample string 2",
"Disease": "sample string 3",
"DiseaseId": 4,
"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 5",
"Histology": "sample string 6",
"Route": "sample string 7",
"RecommendedUse": "sample string 8",
"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",
"OTSAcronym": "sample string 3"
},
{
"OrderTemplateID": "sample string 1",
"OrderTemplateDesc": "sample string 2",
"OTSAcronym": "sample string 3"
}
],
"BillingCodes": [
{
"Code": "sample string 1"
},
{
"Code": "sample string 1"
}
]
},
{
"MasterID": 1,
"PublishDate": "2024-04-19T05:41:09.9918238-04:00",
"VersionNumber": "sample string 2",
"Disease": "sample string 3",
"DiseaseId": 4,
"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 5",
"Histology": "sample string 6",
"Route": "sample string 7",
"RecommendedUse": "sample string 8",
"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",
"OTSAcronym": "sample string 3"
},
{
"OrderTemplateID": "sample string 1",
"OrderTemplateDesc": "sample string 2",
"OTSAcronym": "sample string 3"
}
],
"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 3</Disease>
<DiseaseId>4</DiseaseId>
<Histology>sample string 6</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>
<OTSAcronym>sample string 3</OTSAcronym>
<OrderTemplateDesc>sample string 2</OrderTemplateDesc>
<OrderTemplateID>sample string 1</OrderTemplateID>
</OrderTemplate>
<OrderTemplate>
<OTSAcronym>sample string 3</OTSAcronym>
<OrderTemplateDesc>sample string 2</OrderTemplateDesc>
<OrderTemplateID>sample string 1</OrderTemplateID>
</OrderTemplate>
</OrderTemplates>
<PharmClass>sample string 5</PharmClass>
<PublishDate>2024-04-19T05:41:09.9918238-04:00</PublishDate>
<RecommendedUse>sample string 8</RecommendedUse>
<Route>sample string 7</Route>
<VersionNumber>sample string 2</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 3</Disease>
<DiseaseId>4</DiseaseId>
<Histology>sample string 6</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>
<OTSAcronym>sample string 3</OTSAcronym>
<OrderTemplateDesc>sample string 2</OrderTemplateDesc>
<OrderTemplateID>sample string 1</OrderTemplateID>
</OrderTemplate>
<OrderTemplate>
<OTSAcronym>sample string 3</OTSAcronym>
<OrderTemplateDesc>sample string 2</OrderTemplateDesc>
<OrderTemplateID>sample string 1</OrderTemplateID>
</OrderTemplate>
</OrderTemplates>
<PharmClass>sample string 5</PharmClass>
<PublishDate>2024-04-19T05:41:09.9918238-04:00</PublishDate>
<RecommendedUse>sample string 8</RecommendedUse>
<Route>sample string 7</Route>
<VersionNumber>sample string 2</VersionNumber>
</CompendiumRecord>
</CompendiumRecords>
<IsValid>true</IsValid>
<Message>sample string 2</Message>
</CompendiumRequest>