Home

DrugQuery

GET api/Clinical/{systemID}/DrugQuery?drugName={drugName}&drugNDC={drugNDC}&bShowActiveOnly={bShowActiveOnly}&bExcludeControlledDrugs={bExcludeControlledDrugs}

Retrieves list of drugs matching the drugname or NDC number.

Request Information

Parameters

NameDescriptionAdditional information
systemID 
The SystemID of the pharmacy system.

Define this parameter in the request URI.
drugName 
Drug name (partials allowed up to 30 characters)

Define this parameter in the request URI.
drugNDC 
Drug NDC Number (11 character max - no dashes)

Define this parameter in the request URI.
bShowActiveOnly 
True - only show active drugs, False - show active and inactive drugs (default is true)

Define this parameter in the request URI.
bExcludeControlledDrugs 
True - exclude class 2C,3C,4C,5C drugs, False - include all drugs (default is true)

Define this parameter in the request URI.
    

Response Codes

    
  • OK (200)
  • BadRequest (400)
  • NotFound (404)
  • InternalServerError (500)
    •     

Response Information

Response body formats

application/json, text/json

Sample: 
[
  {
    "DrugName": "sample string 1",
    "DrugNDC": "sample string 2",
    "DrugID": "sample string 3",
    "DrugStatus": "sample string 4",
    "DrugType": "sample string 5",
    "DrugClass": "sample string 6",
    "PackageSize": "sample string 7",
    "DispensingUnit": "sample string 8"
  },
  {
    "DrugName": "sample string 1",
    "DrugNDC": "sample string 2",
    "DrugID": "sample string 3",
    "DrugStatus": "sample string 4",
    "DrugType": "sample string 5",
    "DrugClass": "sample string 6",
    "PackageSize": "sample string 7",
    "DispensingUnit": "sample string 8"
  },
  {
    "DrugName": "sample string 1",
    "DrugNDC": "sample string 2",
    "DrugID": "sample string 3",
    "DrugStatus": "sample string 4",
    "DrugType": "sample string 5",
    "DrugClass": "sample string 6",
    "PackageSize": "sample string 7",
    "DispensingUnit": "sample string 8"
  }
]

text/javascript

Sample: 
[{"DrugName":"sample string 1","DrugNDC":"sample string 2","DrugID":"sample string 3","DrugStatus":"sample string 4","DrugType":"sample string 5","DrugClass":"sample string 6","PackageSize":"sample string 7","DispensingUnit":"sample string 8"},{"DrugName":"sample string 1","DrugNDC":"sample string 2","DrugID":"sample string 3","DrugStatus":"sample string 4","DrugType":"sample string 5","DrugClass":"sample string 6","PackageSize":"sample string 7","DispensingUnit":"sample string 8"},{"DrugName":"sample string 1","DrugNDC":"sample string 2","DrugID":"sample string 3","DrugStatus":"sample string 4","DrugType":"sample string 5","DrugClass":"sample string 6","PackageSize":"sample string 7","DispensingUnit":"sample string 8"}]

application/xml, text/xml

Sample: 
<ArrayOfDrug xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QCFWebAPI.Models">
  <Drug>
    <DispensingUnit>sample string 8</DispensingUnit>
    <DrugClass>sample string 6</DrugClass>
    <DrugID>sample string 3</DrugID>
    <DrugNDC>sample string 2</DrugNDC>
    <DrugName>sample string 1</DrugName>
    <DrugStatus>sample string 4</DrugStatus>
    <DrugType>sample string 5</DrugType>
    <PackageSize>sample string 7</PackageSize>
  </Drug>
  <Drug>
    <DispensingUnit>sample string 8</DispensingUnit>
    <DrugClass>sample string 6</DrugClass>
    <DrugID>sample string 3</DrugID>
    <DrugNDC>sample string 2</DrugNDC>
    <DrugName>sample string 1</DrugName>
    <DrugStatus>sample string 4</DrugStatus>
    <DrugType>sample string 5</DrugType>
    <PackageSize>sample string 7</PackageSize>
  </Drug>
  <Drug>
    <DispensingUnit>sample string 8</DispensingUnit>
    <DrugClass>sample string 6</DrugClass>
    <DrugID>sample string 3</DrugID>
    <DrugNDC>sample string 2</DrugNDC>
    <DrugName>sample string 1</DrugName>
    <DrugStatus>sample string 4</DrugStatus>
    <DrugType>sample string 5</DrugType>
    <PackageSize>sample string 7</PackageSize>
  </Drug>
</ArrayOfDrug>