Products

The ProductSettings resource allows for the retrieval of Product information with it's settings. 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)

Product Settings Search (using filter criteria)


Products Search (using filter criteria)


Request Url
GET FormTrak/v1/Projects/{ProjectId}/Products


URI Parameters

NameDescription Type Required / Optional
ProjectId

The Id of the Project

integer

Required

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


Resource Description of Response Object

ProductsResponse
NameDescription Type Required / Optional
Products

Collection of Product

Optional


Available Response Formats & Sample Data

{
  "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


NameDescription Input Value Type Required / Optional
ProjectId

The Id of the Project

integer

Required

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





Request URL

GET FormTrak/v1/Projects/ProjectId/Products?Name=Name&TherapeuticClassId=TherapeuticClassId&MedId=MedId&RoutedDoseFormMedId=RoutedDoseFormMedId&IsGeneric=IsGeneric&OverTheCounter=OverTheCounter&NDC=NDC&RxCUI=RxCUI&DDID=DDID&ProductId=ProductId

Status

Response Details

            
            

Product Settings Search (using filter criteria)


Request Url
GET FormTrak/v1/Projects/{ProjectId}/ProductSettings


URI Parameters

NameDescription Type Required / Optional
ProjectId

The Id of the Project

integer

Required

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


Resource Description of Response Object

ProductSettingsResponse
NameDescription Type Required / Optional
Products

Collection of ProductSettings

Optional


Available Response Formats & Sample Data

{
  "Products": [
    {
      "ProductId": 1,
      "Settings": [
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        }
      ]
    },
    {
      "ProductId": 1,
      "Settings": [
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        }
      ]
    }
  ]
}
<ProductSettingsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MMIT.Api.WebApplication.Models.Formulary.Products">
  <Products xmlns:d2p1="http://api.mmitnetwork.com/formulary/products">
    <d2p1:ProductSettings>
      <d2p1:ProductId>1</d2p1:ProductId>
      <d2p1:Settings>
        <d2p1:ProductSettingModel>
          <d2p1:Name>sample string 1</d2p1:Name>
          <d2p1:Value>sample string 2</d2p1:Value>
        </d2p1:ProductSettingModel>
        <d2p1:ProductSettingModel>
          <d2p1:Name>sample string 1</d2p1:Name>
          <d2p1:Value>sample string 2</d2p1:Value>
        </d2p1:ProductSettingModel>
      </d2p1:Settings>
    </d2p1:ProductSettings>
    <d2p1:ProductSettings>
      <d2p1:ProductId>1</d2p1:ProductId>
      <d2p1:Settings>
        <d2p1:ProductSettingModel>
          <d2p1:Name>sample string 1</d2p1:Name>
          <d2p1:Value>sample string 2</d2p1:Value>
        </d2p1:ProductSettingModel>
        <d2p1:ProductSettingModel>
          <d2p1:Name>sample string 1</d2p1:Name>
          <d2p1:Value>sample string 2</d2p1:Value>
        </d2p1:ProductSettingModel>
      </d2p1:Settings>
    </d2p1:ProductSettings>
  </Products>
</ProductSettingsResponse>

Build Request


NameDescription Input Value Type Required / Optional
ProjectId

The Id of the Project

integer

Required

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





Request URL

GET FormTrak/v1/Projects/ProjectId/ProductSettings?Name=Name&TherapeuticClassId=TherapeuticClassId&MedId=MedId&RoutedDoseFormMedId=RoutedDoseFormMedId&IsGeneric=IsGeneric&OverTheCounter=OverTheCounter&NDC=NDC&RxCUI=RxCUI&DDID=DDID&ProductId=ProductId

Status

Response Details