Resources

Products

The Product resource allows for the retrieval of Product information. One or more products may be returned based on the given filters. Note that a product may be ending (see the EndDate field), and it may also be slated to start in the future (see the EffectiveDate field).


Products Search (using filter criteria)

Products Search (using filter criteria)

Request URL

GET Formulary/v1/Products

URI Parameters

Name	Description	Type	Required / Optional
Name	The name contained within the Products' Name	string	Optional
TherapeuticClassId	The FirstDataBank ETC TherapeuticClassId for which the Products are classified	integer	Optional
MedId	The FirstDataBank Medid for a Product	integer	Optional
RoutedDoseFormMedId	The FirstDataBank RoutedDoseFormMedId for the Products	integer	Optional
IsGeneric	The Products that are classified as Generic	boolean	Optional
OverTheCounter	The Products that are classified as Over The Counter	boolean	Optional
NDC	The NDC of a Product	string	Optional
RxCUI	The RxCUI of one or more Products	integer	Optional
DDID	The Medispan DDID (Drug Descriptior Identifier or Dispensable Drug Identifier)	string	Optional
ProductId	The Id of the Product to be returned	integer	Optional
DrugTypeId	The DrugTypeId of the Product to be returned	byte	Optional
ExcludeObsolete	Exclude obsolete Products	boolean	Optional

Resource Description of Response Object

ProductsResponse

Name	Description	Type	Required / Optional
Products		Collection of Product	Optional

{
  "Products": [
    {
      "ProductId": 1,
      "TherapeuticClassId": 2,
      "TherapeuticClass": "sample string 3",
      "Drug": {
        "DrugId": 1,
        "DrugTypeId": 64,
        "Name": "sample string 3",
        "Description": "sample string 4",
        "Brand": "sample string 5",
        "IsGeneric": true,
        "OverTheCounter": true,
        "IsOwner": true,
        "Logo": "sample string 8",
        "ImportantSafetyInformation": "sample string 9",
        "Rank": 64
      },
      "DisplayName": "sample string 4"
    },
    {
      "ProductId": 1,
      "TherapeuticClassId": 2,
      "TherapeuticClass": "sample string 3",
      "Drug": {
        "DrugId": 1,
        "DrugTypeId": 64,
        "Name": "sample string 3",
        "Description": "sample string 4",
        "Brand": "sample string 5",
        "IsGeneric": true,
        "OverTheCounter": true,
        "IsOwner": true,
        "Logo": "sample string 8",
        "ImportantSafetyInformation": "sample string 9",
        "Rank": 64
      },
      "DisplayName": "sample string 4"
    }
  ]
}

<ProductsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.mmitnetwork.com/formulary/products">
  <Products>
    <Product>
      <DisplayName>sample string 4</DisplayName>
      <Drug>
        <Brand>sample string 5</Brand>
        <Description>sample string 4</Description>
        <DrugId>1</DrugId>
        <DrugTypeId>64</DrugTypeId>
        <ImportantSafetyInformation>sample string 9</ImportantSafetyInformation>
        <IsGeneric>true</IsGeneric>
        <IsOwner>true</IsOwner>
        <Logo>sample string 8</Logo>
        <Name>sample string 3</Name>
        <OverTheCounter>true</OverTheCounter>
        <Rank>64</Rank>
      </Drug>
      <ProductId>1</ProductId>
      <TherapeuticClass>sample string 3</TherapeuticClass>
      <TherapeuticClassId>2</TherapeuticClassId>
    </Product>
    <Product>
      <DisplayName>sample string 4</DisplayName>
      <Drug>
        <Brand>sample string 5</Brand>
        <Description>sample string 4</Description>
        <DrugId>1</DrugId>
        <DrugTypeId>64</DrugTypeId>
        <ImportantSafetyInformation>sample string 9</ImportantSafetyInformation>
        <IsGeneric>true</IsGeneric>
        <IsOwner>true</IsOwner>
        <Logo>sample string 8</Logo>
        <Name>sample string 3</Name>
        <OverTheCounter>true</OverTheCounter>
        <Rank>64</Rank>
      </Drug>
      <ProductId>1</ProductId>
      <TherapeuticClass>sample string 3</TherapeuticClass>
      <TherapeuticClassId>2</TherapeuticClassId>
    </Product>
  </Products>
</ProductsResponse>

Build Request

Parameters
Headers

Name	Description	Type	Required / Optional
Name	The name contained within the Products' Name	string	Optional
TherapeuticClassId	The FirstDataBank ETC TherapeuticClassId for which the Products are classified	integer	Optional
MedId	The FirstDataBank Medid for a Product	integer	Optional
RoutedDoseFormMedId	The FirstDataBank RoutedDoseFormMedId for the Products	integer	Optional
IsGeneric	The Products that are classified as Generic	boolean	Optional
OverTheCounter	The Products that are classified as Over The Counter	boolean	Optional
NDC	The NDC of a Product	string	Optional
RxCUI	The RxCUI of one or more Products	integer	Optional
DDID	The Medispan DDID (Drug Descriptior Identifier or Dispensable Drug Identifier)	string	Optional
ProductId	The Id of the Product to be returned	integer	Optional
DrugTypeId	The DrugTypeId of the Product to be returned	byte	Optional
ExcludeObsolete	Exclude obsolete Products	boolean	Optional

Request URL

GET Formulary/v1/Products?Name=Name&TherapeuticClassId=TherapeuticClassId&MedId=MedId&RoutedDoseFormMedId=RoutedDoseFormMedId&IsGeneric=IsGeneric&OverTheCounter=OverTheCounter&NDC=NDC&RxCUI=RxCUI&DDID=DDID&ProductId=ProductId&DrugTypeId=DrugTypeId&ExcludeObsolete=ExcludeObsolete

Status

Response Details

Data
Headers