Indications

The Indications resource allows for the retrieval of MMIT indication information. This includes all supported indications as well as products available per indication.

Indications (by IndicationId or IndicationName)

Products (by IndicationId)

Indications (by ProductId)

Indications (by IndicationId or IndicationName)


Request URL
GET Formulary/v1/Indications


URI Parameters

NameDescription Type Required / Optional
IndicationId

IndicationId used to get Indication whose Id matches this number

 integer

Optional
IndicationName

IndicationName used to get Indications whose name contains this string

 string

Optional

Resource Description of Response Object

IndicationsResponse
NameDescription Type Required / Optional
Indications

Collection of Indication

Optional

Available Response Formats & Sample Data

{
  "Indications": [
    {
      "IndicationId": 1,
      "Name": "sample string 2",
      "ClientDisplayName": "sample string 3"
    },
    {
      "IndicationId": 1,
      "Name": "sample string 2",
      "ClientDisplayName": "sample string 3"
    }
  ]
}

<IndicationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.mmitnetwork.com/formulary/indications">
  <Indications>
    <Indication>
      <ClientDisplayName>sample string 3</ClientDisplayName>
      <IndicationId>1</IndicationId>
      <Name>sample string 2</Name>
    </Indication>
    <Indication>
      <ClientDisplayName>sample string 3</ClientDisplayName>
      <IndicationId>1</IndicationId>
      <Name>sample string 2</Name>
    </Indication>
  </Indications>
</IndicationsResponse>

Build Request


NameDescription Input Value Type Required / Optional
IndicationId

IndicationId used to get Indication whose Id matches this number

integer

Optional
IndicationName

IndicationName used to get Indications whose name contains this string

string

Optional




Request URL

GET Formulary/v1/Indications?IndicationId=IndicationId&IndicationName=IndicationName

Status

Response Details

Products (by IndicationId)


Request URL
GET Formulary/v1/IndicationProducts


URI Parameters

NameDescription Type Required / Optional
IndicationId

IndicationId used to retrieve associated products for current month

 integer

Required

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
IndicationId

IndicationId used to retrieve associated products for current month

integer

Required




Request URL

GET Formulary/v1/IndicationProducts?IndicationId=IndicationId

Status

Response Details

Indications (by ProductId)


Request URL
GET Formulary/v1/Indications


URI Parameters

NameDescription Type Required / Optional
ProductId

ProductId used to get the active indications for which that product is configured

 integer

Required

Resource Description of Response Object

IndicationsResponse
NameDescription Type Required / Optional
Indications

Collection of Indication

Optional

Available Response Formats & Sample Data

{
  "Indications": [
    {
      "IndicationId": 1,
      "Name": "sample string 2",
      "ClientDisplayName": "sample string 3"
    },
    {
      "IndicationId": 1,
      "Name": "sample string 2",
      "ClientDisplayName": "sample string 3"
    }
  ]
}

<IndicationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.mmitnetwork.com/formulary/indications">
  <Indications>
    <Indication>
      <ClientDisplayName>sample string 3</ClientDisplayName>
      <IndicationId>1</IndicationId>
      <Name>sample string 2</Name>
    </Indication>
    <Indication>
      <ClientDisplayName>sample string 3</ClientDisplayName>
      <IndicationId>1</IndicationId>
      <Name>sample string 2</Name>
    </Indication>
  </Indications>
</IndicationsResponse>

Build Request


NameDescription Input Value Type Required / Optional
ProductId

ProductId used to get the active indications for which that product is configured

integer

Required




Request URL

GET Formulary/v1/Indications?ProductId=ProductId

Status

Response Details