Resources

RecommendedAlternatives

A Product may have recommended drug alternatives that are on the market.


Recommended alternative drugs by formulary
Recommended alternative drugs by controller

Recommended alternative drugs by formulary

Request URL

GET Formulary/v1/Products/{ProductId}/Formularies/{FormularyId}/RecommendedAlternatives

URI Parameters

Name	Description	Type	Required / Optional
ProductId	Id of the Product	integer	Required
FormularyId	Id of the Formulary	integer	Required

Resource Description of Response Object

Collection of Product

Name	Type	Required / Optional
ProductId	integer	Optional
TherapeuticClassId	integer	Optional
TherapeuticClass	string	Optional
Drug	Drug	Optional
DisplayName	string	Optional

[]

<ArrayOfProduct xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.mmitnetwork.com/formulary/products" />

Build Request

Parameters
Headers

Name	Description	Input Value	Type	Required / Optional
ProductId	Id of the Product		integer	Required
FormularyId	Id of the Formulary		integer	Required

Request URL

GET Formulary/v1/Products/ProductId/Formularies/FormularyId/RecommendedAlternatives

Status

Response Details

Data
Headers

Recommended alternative drugs by controller

Request URL

GET Formulary/v1/Products/{ProductId}/Controllers/{ControllerId}/RecommendedAlternatives

URI Parameters

Name	Description	Type	Required / Optional
ProductId	Id of the Product	integer	Required
ControllerId	Id of the Controller	integer	Required
BenefitDesignId	The Id of the BenefitDesign used as a Plan filter the response	integer	Optional
ChannelId	The Id of the Channel used as a Plan filter the response	Collection of integer	Optional
PlanTypeId	The Id of the PlanType used as a Plan filter the response	integer	Optional
StateId	The US State Id where the Plan(s) are covered	string	Optional
CBSAId	The CBSA(Service Area) Id where the Plan is covered	integer	Optional
TerritoryId	The Territory Id where the Plan is covered	integer	Optional
LivesTypeId	The Id to override the types of lives to show (Default: 4)	integer	Optional

Resource Description of Response Object

Collection of ProductsByPlanResponse

Name	Description	Type	Required / Optional
PlanId		integer	Optional
Products		Collection of ProductByPlan	Optional

Available Response Formats & Sample Data

application/json, text/json
application/xml, text/xml

[
  {
    "PlanId": 1,
    "Products": [
      {
        "ProductId": 1,
        "Drug": {
          "DrugId": 1,
          "DrugTypeId": 64,
          "Rank": 64
        }
      },
      {
        "ProductId": 1,
        "Drug": {
          "DrugId": 1,
          "DrugTypeId": 64,
          "Rank": 64
        }
      }
    ]
  },
  {
    "PlanId": 1,
    "Products": [
      {
        "ProductId": 1,
        "Drug": {
          "DrugId": 1,
          "DrugTypeId": 64,
          "Rank": 64
        }
      },
      {
        "ProductId": 1,
        "Drug": {
          "DrugId": 1,
          "DrugTypeId": 64,
          "Rank": 64
        }
      }
    ]
  }
]

<ArrayOfProductsByPlanResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.mmitnetwork.com/formulary/products">
  <ProductsByPlanResponse>
    <PlanId>1</PlanId>
    <Products>
      <ProductByPlan>
        <Drug xmlns:d5p1="http://schemas.datacontract.org/2004/07/MMIT.Api.WebApplication.Models.Formulary.Products">
          <d5p1:DrugId>1</d5p1:DrugId>
          <d5p1:DrugTypeId>64</d5p1:DrugTypeId>
          <d5p1:Rank>64</d5p1:Rank>
        </Drug>
        <ProductId>1</ProductId>
      </ProductByPlan>
      <ProductByPlan>
        <Drug xmlns:d5p1="http://schemas.datacontract.org/2004/07/MMIT.Api.WebApplication.Models.Formulary.Products">
          <d5p1:DrugId>1</d5p1:DrugId>
          <d5p1:DrugTypeId>64</d5p1:DrugTypeId>
          <d5p1:Rank>64</d5p1:Rank>
        </Drug>
        <ProductId>1</ProductId>
      </ProductByPlan>
    </Products>
  </ProductsByPlanResponse>
  <ProductsByPlanResponse>
    <PlanId>1</PlanId>
    <Products>
      <ProductByPlan>
        <Drug xmlns:d5p1="http://schemas.datacontract.org/2004/07/MMIT.Api.WebApplication.Models.Formulary.Products">
          <d5p1:DrugId>1</d5p1:DrugId>
          <d5p1:DrugTypeId>64</d5p1:DrugTypeId>
          <d5p1:Rank>64</d5p1:Rank>
        </Drug>
        <ProductId>1</ProductId>
      </ProductByPlan>
      <ProductByPlan>
        <Drug xmlns:d5p1="http://schemas.datacontract.org/2004/07/MMIT.Api.WebApplication.Models.Formulary.Products">
          <d5p1:DrugId>1</d5p1:DrugId>
          <d5p1:DrugTypeId>64</d5p1:DrugTypeId>
          <d5p1:Rank>64</d5p1:Rank>
        </Drug>
        <ProductId>1</ProductId>
      </ProductByPlan>
    </Products>
  </ProductsByPlanResponse>
</ArrayOfProductsByPlanResponse>

Build Request

Parameters
Headers

Name	Description	Type	Required / Optional
ProductId	Id of the Product	integer	Required
ControllerId	Id of the Controller	integer	Required
BenefitDesignId	The Id of the BenefitDesign used as a Plan filter the response	integer	Optional
ChannelId	The Id of the Channel used as a Plan filter the response	Collection of integer	Optional
PlanTypeId	The Id of the PlanType used as a Plan filter the response	integer	Optional
StateId	The US State Id where the Plan(s) are covered	string	Optional
CBSAId	The CBSA(Service Area) Id where the Plan is covered	integer	Optional
TerritoryId	The Territory Id where the Plan is covered	integer	Optional
LivesTypeId	The Id to override the types of lives to show (Default: 4)	integer	Optional

Request URL

GET Formulary/v1/Products/ProductId/Controllers/ControllerId/RecommendedAlternatives?BenefitDesignId=BenefitDesignId&ChannelId=ChannelId&PlanTypeId=PlanTypeId&StateId=StateId&CBSAId=CBSAId&TerritoryId=TerritoryId&LivesTypeId=LivesTypeId

Status

Response Details

Data
Headers