Coverage

The FormTrak Coverage resource allows for the retrieval of Formulary Coverage information that has been configured for promotional use. The coverage information can grouped by the Controller and is accompanied by a winning status and percentage. The plans or controllers can also be filtered by a number of parameters.  Last, the Coverage Statements by Product endpoint allows for the return of multiple promotional statements per product.  Statements are ranked and validated based on rules that can be define per brand.

Coverage for a specific Plan and Product

Competitor Coverage for a specific Plan and Product

Coverage for a specific Controller and Product

Coverage by Product

Competitor Coverage for a specific Controller and Product

Coverage Statements by Product

Coverage for a specific Plan and Product


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


URI Parameters

NameDescription Type Required / Optional
ProductId

The Id of the Product

 integer

Required
PlanId

The Id of the Plan

 integer

Required
ProjectId

The Id of the Project

 integer

Required
LivesTypeId

The Id to override the types of lives to show/use (Default: 4)

 integer

Optional

Resource Description of Response Object

PlanCoveragesResponse
NameDescription Type Required / Optional
PlanCoverages

Collection of PlanCoverage

Optional

Available Response Formats & Sample Data

{
  "PlanCoverages": [
    {
      "PlanId": 1,
      "PlanTypeId": 64,
      "ChannelId": 3,
      "ProductId": 4,
      "MonthId": 5,
      "ControllerId": 6,
      "NoteId": 1,
      "NotesAvailable": 7,
      "Lives": 8,
      "DrugListTierId": 64,
      "FormularyTierId": 10,
      "FormularyUnifiedTierId": 11,
      "UnifiedTierId": 12,
      "PromotionalTierId": 1,
      "IsGeneric": true,
      "PriorAuthorization": true,
      "StepTherapy": true,
      "QuantityLimit": true,
      "SpecialtyPharmacy": true,
      "ConditionalPriorAuthorization": true,
      "DurableMedicalEquipment": true,
      "MedicalBenefit": true,
      "OverTheCounter": true,
      "Variance": true,
      "StateCarveOut": true,
      "FormularyId": 24
    },
    {
      "PlanId": 1,
      "PlanTypeId": 64,
      "ChannelId": 3,
      "ProductId": 4,
      "MonthId": 5,
      "ControllerId": 6,
      "NoteId": 1,
      "NotesAvailable": 7,
      "Lives": 8,
      "DrugListTierId": 64,
      "FormularyTierId": 10,
      "FormularyUnifiedTierId": 11,
      "UnifiedTierId": 12,
      "PromotionalTierId": 1,
      "IsGeneric": true,
      "PriorAuthorization": true,
      "StepTherapy": true,
      "QuantityLimit": true,
      "SpecialtyPharmacy": true,
      "ConditionalPriorAuthorization": true,
      "DurableMedicalEquipment": true,
      "MedicalBenefit": true,
      "OverTheCounter": true,
      "Variance": true,
      "StateCarveOut": true,
      "FormularyId": 24
    }
  ]
}

<PlanCoveragesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.mmitnetwork.com/formulary/coverages">
  <PlanCoverages>
    <PlanCoverage>
      <ChannelId>3</ChannelId>
      <ConditionalPriorAuthorization>true</ConditionalPriorAuthorization>
      <ControllerId>6</ControllerId>
      <DrugListTierId>64</DrugListTierId>
      <DurableMedicalEquipment>true</DurableMedicalEquipment>
      <FormularyId>24</FormularyId>
      <FormularyTierId>10</FormularyTierId>
      <FormularyUnifiedTierId>11</FormularyUnifiedTierId>
      <IsGeneric>true</IsGeneric>
      <Lives>8</Lives>
      <MedicalBenefit>true</MedicalBenefit>
      <MonthId>5</MonthId>
      <NoteId>1</NoteId>
      <NotesAvailable>7</NotesAvailable>
      <OverTheCounter>true</OverTheCounter>
      <PlanId>1</PlanId>
      <PlanTypeId>64</PlanTypeId>
      <PriorAuthorization>true</PriorAuthorization>
      <ProductId>4</ProductId>
      <PromotionalTierId>1</PromotionalTierId>
      <QuantityLimit>true</QuantityLimit>
      <SpecialtyPharmacy>true</SpecialtyPharmacy>
      <StateCarveOut>true</StateCarveOut>
      <StepTherapy>true</StepTherapy>
      <UnifiedTierId>12</UnifiedTierId>
      <Variance>true</Variance>
    </PlanCoverage>
    <PlanCoverage>
      <ChannelId>3</ChannelId>
      <ConditionalPriorAuthorization>true</ConditionalPriorAuthorization>
      <ControllerId>6</ControllerId>
      <DrugListTierId>64</DrugListTierId>
      <DurableMedicalEquipment>true</DurableMedicalEquipment>
      <FormularyId>24</FormularyId>
      <FormularyTierId>10</FormularyTierId>
      <FormularyUnifiedTierId>11</FormularyUnifiedTierId>
      <IsGeneric>true</IsGeneric>
      <Lives>8</Lives>
      <MedicalBenefit>true</MedicalBenefit>
      <MonthId>5</MonthId>
      <NoteId>1</NoteId>
      <NotesAvailable>7</NotesAvailable>
      <OverTheCounter>true</OverTheCounter>
      <PlanId>1</PlanId>
      <PlanTypeId>64</PlanTypeId>
      <PriorAuthorization>true</PriorAuthorization>
      <ProductId>4</ProductId>
      <PromotionalTierId>1</PromotionalTierId>
      <QuantityLimit>true</QuantityLimit>
      <SpecialtyPharmacy>true</SpecialtyPharmacy>
      <StateCarveOut>true</StateCarveOut>
      <StepTherapy>true</StepTherapy>
      <UnifiedTierId>12</UnifiedTierId>
      <Variance>true</Variance>
    </PlanCoverage>
  </PlanCoverages>
</PlanCoveragesResponse>

Build Request


NameDescription Input Value Type Required / Optional
ProductId

The Id of the Product

integer

Required
PlanId

The Id of the Plan

integer

Required
ProjectId

The Id of the Project

integer

Required
LivesTypeId

The Id to override the types of lives to show/use (Default: 4)

integer

Optional




Request URL

GET FormTrak/v1/Projects/ProjectId/Products/ProductId/PlanCoverages?PlanId=PlanId&LivesTypeId=LivesTypeId

Status

Response Details

Competitor Coverage for a specific Plan and Product


Request Url
GET FormTrak/v1/Projects/{ProjectId}/Products/{ProductId}/Competitors/PlanCoverages


URI Parameters

NameDescription Type Required / Optional
ProductId

The Id of the Product to return competitors for

 integer

Required
PlanId

The Id of the Plan

 integer

Required
ProjectId

The FormTrak projectId the product is associated with.

 integer

Required
Options

Enter "CoveredOnly" to return only covered competitors.

 Collection of string

Optional
LivesTypeId

The Id to override the types of lives to show/use (Default: 4)

 integer

Optional

Resource Description of Response Object

CompetitorPlanCoveragesResponse
NameDescription Type Required / Optional
PlanCoverages

Collection of PlanCoverage

Optional
Products

Collection of Product

Optional

Available Response Formats & Sample Data

{
  "PlanCoverages": [
    {
      "PlanId": 1,
      "PlanTypeId": 64,
      "ChannelId": 3,
      "ProductId": 4,
      "MonthId": 5,
      "ControllerId": 6,
      "NoteId": 1,
      "NotesAvailable": 7,
      "Lives": 8,
      "DrugListTierId": 64,
      "FormularyTierId": 10,
      "FormularyUnifiedTierId": 11,
      "UnifiedTierId": 12,
      "PromotionalTierId": 1,
      "IsGeneric": true,
      "PriorAuthorization": true,
      "StepTherapy": true,
      "QuantityLimit": true,
      "SpecialtyPharmacy": true,
      "ConditionalPriorAuthorization": true,
      "DurableMedicalEquipment": true,
      "MedicalBenefit": true,
      "OverTheCounter": true,
      "Variance": true,
      "StateCarveOut": true,
      "FormularyId": 24
    },
    {
      "PlanId": 1,
      "PlanTypeId": 64,
      "ChannelId": 3,
      "ProductId": 4,
      "MonthId": 5,
      "ControllerId": 6,
      "NoteId": 1,
      "NotesAvailable": 7,
      "Lives": 8,
      "DrugListTierId": 64,
      "FormularyTierId": 10,
      "FormularyUnifiedTierId": 11,
      "UnifiedTierId": 12,
      "PromotionalTierId": 1,
      "IsGeneric": true,
      "PriorAuthorization": true,
      "StepTherapy": true,
      "QuantityLimit": true,
      "SpecialtyPharmacy": true,
      "ConditionalPriorAuthorization": true,
      "DurableMedicalEquipment": true,
      "MedicalBenefit": true,
      "OverTheCounter": true,
      "Variance": true,
      "StateCarveOut": true,
      "FormularyId": 24
    }
  ],
  "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"
    }
  ]
}

<CompetitorPlanCoveragesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.mmitnetwork.com/formtrak/coverages">
  <PlanCoverages xmlns:d2p1="http://api.mmitnetwork.com/formulary/coverages">
    <d2p1:PlanCoverage>
      <d2p1:ChannelId>3</d2p1:ChannelId>
      <d2p1:ConditionalPriorAuthorization>true</d2p1:ConditionalPriorAuthorization>
      <d2p1:ControllerId>6</d2p1:ControllerId>
      <d2p1:DrugListTierId>64</d2p1:DrugListTierId>
      <d2p1:DurableMedicalEquipment>true</d2p1:DurableMedicalEquipment>
      <d2p1:FormularyId>24</d2p1:FormularyId>
      <d2p1:FormularyTierId>10</d2p1:FormularyTierId>
      <d2p1:FormularyUnifiedTierId>11</d2p1:FormularyUnifiedTierId>
      <d2p1:IsGeneric>true</d2p1:IsGeneric>
      <d2p1:Lives>8</d2p1:Lives>
      <d2p1:MedicalBenefit>true</d2p1:MedicalBenefit>
      <d2p1:MonthId>5</d2p1:MonthId>
      <d2p1:NoteId>1</d2p1:NoteId>
      <d2p1:NotesAvailable>7</d2p1:NotesAvailable>
      <d2p1:OverTheCounter>true</d2p1:OverTheCounter>
      <d2p1:PlanId>1</d2p1:PlanId>
      <d2p1:PlanTypeId>64</d2p1:PlanTypeId>
      <d2p1:PriorAuthorization>true</d2p1:PriorAuthorization>
      <d2p1:ProductId>4</d2p1:ProductId>
      <d2p1:PromotionalTierId>1</d2p1:PromotionalTierId>
      <d2p1:QuantityLimit>true</d2p1:QuantityLimit>
      <d2p1:SpecialtyPharmacy>true</d2p1:SpecialtyPharmacy>
      <d2p1:StateCarveOut>true</d2p1:StateCarveOut>
      <d2p1:StepTherapy>true</d2p1:StepTherapy>
      <d2p1:UnifiedTierId>12</d2p1:UnifiedTierId>
      <d2p1:Variance>true</d2p1:Variance>
    </d2p1:PlanCoverage>
    <d2p1:PlanCoverage>
      <d2p1:ChannelId>3</d2p1:ChannelId>
      <d2p1:ConditionalPriorAuthorization>true</d2p1:ConditionalPriorAuthorization>
      <d2p1:ControllerId>6</d2p1:ControllerId>
      <d2p1:DrugListTierId>64</d2p1:DrugListTierId>
      <d2p1:DurableMedicalEquipment>true</d2p1:DurableMedicalEquipment>
      <d2p1:FormularyId>24</d2p1:FormularyId>
      <d2p1:FormularyTierId>10</d2p1:FormularyTierId>
      <d2p1:FormularyUnifiedTierId>11</d2p1:FormularyUnifiedTierId>
      <d2p1:IsGeneric>true</d2p1:IsGeneric>
      <d2p1:Lives>8</d2p1:Lives>
      <d2p1:MedicalBenefit>true</d2p1:MedicalBenefit>
      <d2p1:MonthId>5</d2p1:MonthId>
      <d2p1:NoteId>1</d2p1:NoteId>
      <d2p1:NotesAvailable>7</d2p1:NotesAvailable>
      <d2p1:OverTheCounter>true</d2p1:OverTheCounter>
      <d2p1:PlanId>1</d2p1:PlanId>
      <d2p1:PlanTypeId>64</d2p1:PlanTypeId>
      <d2p1:PriorAuthorization>true</d2p1:PriorAuthorization>
      <d2p1:ProductId>4</d2p1:ProductId>
      <d2p1:PromotionalTierId>1</d2p1:PromotionalTierId>
      <d2p1:QuantityLimit>true</d2p1:QuantityLimit>
      <d2p1:SpecialtyPharmacy>true</d2p1:SpecialtyPharmacy>
      <d2p1:StateCarveOut>true</d2p1:StateCarveOut>
      <d2p1:StepTherapy>true</d2p1:StepTherapy>
      <d2p1:UnifiedTierId>12</d2p1:UnifiedTierId>
      <d2p1:Variance>true</d2p1:Variance>
    </d2p1:PlanCoverage>
  </PlanCoverages>
  <Products xmlns:d2p1="http://api.mmitnetwork.com/formulary/products">
    <d2p1:Product>
      <d2p1:DisplayName>sample string 4</d2p1:DisplayName>
      <d2p1:Drug>
        <d2p1:Brand>sample string 5</d2p1:Brand>
        <d2p1:Description>sample string 4</d2p1:Description>
        <d2p1:DrugId>1</d2p1:DrugId>
        <d2p1:DrugTypeId>64</d2p1:DrugTypeId>
        <d2p1:ImportantSafetyInformation>sample string 9</d2p1:ImportantSafetyInformation>
        <d2p1:IsGeneric>true</d2p1:IsGeneric>
        <d2p1:IsOwner>true</d2p1:IsOwner>
        <d2p1:Logo>sample string 8</d2p1:Logo>
        <d2p1:Name>sample string 3</d2p1:Name>
        <d2p1:OverTheCounter>true</d2p1:OverTheCounter>
        <d2p1:Rank>64</d2p1:Rank>
      </d2p1:Drug>
      <d2p1:ProductId>1</d2p1:ProductId>
      <d2p1:TherapeuticClass>sample string 3</d2p1:TherapeuticClass>
      <d2p1:TherapeuticClassId>2</d2p1:TherapeuticClassId>
    </d2p1:Product>
    <d2p1:Product>
      <d2p1:DisplayName>sample string 4</d2p1:DisplayName>
      <d2p1:Drug>
        <d2p1:Brand>sample string 5</d2p1:Brand>
        <d2p1:Description>sample string 4</d2p1:Description>
        <d2p1:DrugId>1</d2p1:DrugId>
        <d2p1:DrugTypeId>64</d2p1:DrugTypeId>
        <d2p1:ImportantSafetyInformation>sample string 9</d2p1:ImportantSafetyInformation>
        <d2p1:IsGeneric>true</d2p1:IsGeneric>
        <d2p1:IsOwner>true</d2p1:IsOwner>
        <d2p1:Logo>sample string 8</d2p1:Logo>
        <d2p1:Name>sample string 3</d2p1:Name>
        <d2p1:OverTheCounter>true</d2p1:OverTheCounter>
        <d2p1:Rank>64</d2p1:Rank>
      </d2p1:Drug>
      <d2p1:ProductId>1</d2p1:ProductId>
      <d2p1:TherapeuticClass>sample string 3</d2p1:TherapeuticClass>
      <d2p1:TherapeuticClassId>2</d2p1:TherapeuticClassId>
    </d2p1:Product>
  </Products>
</CompetitorPlanCoveragesResponse>

Build Request


NameDescription Input Value Type Required / Optional
ProductId

The Id of the Product to return competitors for

integer

Required
PlanId

The Id of the Plan

integer

Required
ProjectId

The FormTrak projectId the product is associated with.

integer

Required
Options

Enter "CoveredOnly" to return only covered competitors.

Collection of string

Optional
LivesTypeId

The Id to override the types of lives to show/use (Default: 4)

integer

Optional




Request URL

GET FormTrak/v1/Projects/ProjectId/Products/ProductId/Competitors/PlanCoverages?PlanId=PlanId&Options=Options&LivesTypeId=LivesTypeId

Status

Response Details

Coverage for a specific Controller and Product


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


URI Parameters

NameDescription Type Required / Optional
ProductId

The Id of the Product

 integer

Required
ControllerId

The Id of the Controller/Parent

 integer

Required
ProjectId

The FormTrak projectId the product is associated with.

 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
Options

Enter "PlanCoverages" to include Plan level coverage in addition to Controller coverage.

 Collection of string

Optional
LivesTypeId

The Id to override the types of lives to show/use (Default: 4)

 integer

Optional

Resource Description of Response Object

ControllerCoveragesResponse
NameDescription Type Required / Optional
ControllerCoverages

Collection of Coverage

Optional
PlanCoverages

Collection of PlanCoverage

Optional
SummaryCoverages

Collection of UnifiedTierCoverage

Optional
Statement

string

Optional

Available Response Formats & Sample Data

{
  "ControllerCoverages": [
    {
      "ProductId": 1,
      "Product": "sample string 2",
      "MonthId": 3,
      "ControllerId": 4,
      "Controller": "sample string 5",
      "DrugListTier": {
        "DrugListTierId": 64,
        "Percentage": 2,
        "Lives": 3,
        "PlanCount": 4
      },
      "UnifiedTier": {
        "UnifiedTierId": 1,
        "Percentage": 2,
        "Lives": 3,
        "PlanCount": 4
      },
      "PromotionalTier": {
        "PromotionalTierId": 1,
        "Percentage": 2,
        "Lives": 3,
        "PlanCount": 4
      },
      "Lives": 6,
      "PlanCount": 7
    },
    {
      "ProductId": 1,
      "Product": "sample string 2",
      "MonthId": 3,
      "ControllerId": 4,
      "Controller": "sample string 5",
      "DrugListTier": {
        "DrugListTierId": 64,
        "Percentage": 2,
        "Lives": 3,
        "PlanCount": 4
      },
      "UnifiedTier": {
        "UnifiedTierId": 1,
        "Percentage": 2,
        "Lives": 3,
        "PlanCount": 4
      },
      "PromotionalTier": {
        "PromotionalTierId": 1,
        "Percentage": 2,
        "Lives": 3,
        "PlanCount": 4
      },
      "Lives": 6,
      "PlanCount": 7
    }
  ],
  "PlanCoverages": [
    {
      "PlanId": 1,
      "PlanTypeId": 64,
      "ChannelId": 3,
      "ProductId": 4,
      "MonthId": 5,
      "ControllerId": 6,
      "NoteId": 1,
      "NotesAvailable": 7,
      "Lives": 8,
      "DrugListTierId": 64,
      "FormularyTierId": 10,
      "FormularyUnifiedTierId": 11,
      "UnifiedTierId": 12,
      "PromotionalTierId": 1,
      "IsGeneric": true,
      "PriorAuthorization": true,
      "StepTherapy": true,
      "QuantityLimit": true,
      "SpecialtyPharmacy": true,
      "ConditionalPriorAuthorization": true,
      "DurableMedicalEquipment": true,
      "MedicalBenefit": true,
      "OverTheCounter": true,
      "Variance": true,
      "StateCarveOut": true,
      "FormularyId": 24
    },
    {
      "PlanId": 1,
      "PlanTypeId": 64,
      "ChannelId": 3,
      "ProductId": 4,
      "MonthId": 5,
      "ControllerId": 6,
      "NoteId": 1,
      "NotesAvailable": 7,
      "Lives": 8,
      "DrugListTierId": 64,
      "FormularyTierId": 10,
      "FormularyUnifiedTierId": 11,
      "UnifiedTierId": 12,
      "PromotionalTierId": 1,
      "IsGeneric": true,
      "PriorAuthorization": true,
      "StepTherapy": true,
      "QuantityLimit": true,
      "SpecialtyPharmacy": true,
      "ConditionalPriorAuthorization": true,
      "DurableMedicalEquipment": true,
      "MedicalBenefit": true,
      "OverTheCounter": true,
      "Variance": true,
      "StateCarveOut": true,
      "FormularyId": 24
    }
  ],
  "SummaryCoverages": [
    {
      "UnifiedTierId": 1,
      "Percentage": 2,
      "Lives": 3,
      "PlanCount": 4
    },
    {
      "UnifiedTierId": 1,
      "Percentage": 2,
      "Lives": 3,
      "PlanCount": 4
    }
  ],
  "Statement": "sample string 1"
}

<ControllerCoveragesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.mmitnetwork.com/formulary/coverages">
  <ControllerCoverages>
    <Coverage>
      <Controller>sample string 5</Controller>
      <ControllerId>4</ControllerId>
      <DrugListTier>
        <DrugListTierId>64</DrugListTierId>
        <Lives>3</Lives>
        <Percentage>2</Percentage>
        <PlanCount>4</PlanCount>
      </DrugListTier>
      <Lives>6</Lives>
      <MonthId>3</MonthId>
      <PlanCount>7</PlanCount>
      <Product>sample string 2</Product>
      <ProductId>1</ProductId>
      <PromotionalTier>
        <Lives>3</Lives>
        <Percentage>2</Percentage>
        <PlanCount>4</PlanCount>
        <PromotionalTierId>1</PromotionalTierId>
      </PromotionalTier>
      <UnifiedTier>
        <Lives>3</Lives>
        <Percentage>2</Percentage>
        <PlanCount>4</PlanCount>
        <UnifiedTierId>1</UnifiedTierId>
      </UnifiedTier>
    </Coverage>
    <Coverage>
      <Controller>sample string 5</Controller>
      <ControllerId>4</ControllerId>
      <DrugListTier>
        <DrugListTierId>64</DrugListTierId>
        <Lives>3</Lives>
        <Percentage>2</Percentage>
        <PlanCount>4</PlanCount>
      </DrugListTier>
      <Lives>6</Lives>
      <MonthId>3</MonthId>
      <PlanCount>7</PlanCount>
      <Product>sample string 2</Product>
      <ProductId>1</ProductId>
      <PromotionalTier>
        <Lives>3</Lives>
        <Percentage>2</Percentage>
        <PlanCount>4</PlanCount>
        <PromotionalTierId>1</PromotionalTierId>
      </PromotionalTier>
      <UnifiedTier>
        <Lives>3</Lives>
        <Percentage>2</Percentage>
        <PlanCount>4</PlanCount>
        <UnifiedTierId>1</UnifiedTierId>
      </UnifiedTier>
    </Coverage>
  </ControllerCoverages>
  <PlanCoverages>
    <PlanCoverage>
      <ChannelId>3</ChannelId>
      <ConditionalPriorAuthorization>true</ConditionalPriorAuthorization>
      <ControllerId>6</ControllerId>
      <DrugListTierId>64</DrugListTierId>
      <DurableMedicalEquipment>true</DurableMedicalEquipment>
      <FormularyId>24</FormularyId>
      <FormularyTierId>10</FormularyTierId>
      <FormularyUnifiedTierId>11</FormularyUnifiedTierId>
      <IsGeneric>true</IsGeneric>
      <Lives>8</Lives>
      <MedicalBenefit>true</MedicalBenefit>
      <MonthId>5</MonthId>
      <NoteId>1</NoteId>
      <NotesAvailable>7</NotesAvailable>
      <OverTheCounter>true</OverTheCounter>
      <PlanId>1</PlanId>
      <PlanTypeId>64</PlanTypeId>
      <PriorAuthorization>true</PriorAuthorization>
      <ProductId>4</ProductId>
      <PromotionalTierId>1</PromotionalTierId>
      <QuantityLimit>true</QuantityLimit>
      <SpecialtyPharmacy>true</SpecialtyPharmacy>
      <StateCarveOut>true</StateCarveOut>
      <StepTherapy>true</StepTherapy>
      <UnifiedTierId>12</UnifiedTierId>
      <Variance>true</Variance>
    </PlanCoverage>
    <PlanCoverage>
      <ChannelId>3</ChannelId>
      <ConditionalPriorAuthorization>true</ConditionalPriorAuthorization>
      <ControllerId>6</ControllerId>
      <DrugListTierId>64</DrugListTierId>
      <DurableMedicalEquipment>true</DurableMedicalEquipment>
      <FormularyId>24</FormularyId>
      <FormularyTierId>10</FormularyTierId>
      <FormularyUnifiedTierId>11</FormularyUnifiedTierId>
      <IsGeneric>true</IsGeneric>
      <Lives>8</Lives>
      <MedicalBenefit>true</MedicalBenefit>
      <MonthId>5</MonthId>
      <NoteId>1</NoteId>
      <NotesAvailable>7</NotesAvailable>
      <OverTheCounter>true</OverTheCounter>
      <PlanId>1</PlanId>
      <PlanTypeId>64</PlanTypeId>
      <PriorAuthorization>true</PriorAuthorization>
      <ProductId>4</ProductId>
      <PromotionalTierId>1</PromotionalTierId>
      <QuantityLimit>true</QuantityLimit>
      <SpecialtyPharmacy>true</SpecialtyPharmacy>
      <StateCarveOut>true</StateCarveOut>
      <StepTherapy>true</StepTherapy>
      <UnifiedTierId>12</UnifiedTierId>
      <Variance>true</Variance>
    </PlanCoverage>
  </PlanCoverages>
  <Statement>sample string 1</Statement>
  <SummaryCoverages>
    <UnifiedTierCoverage>
      <Lives>3</Lives>
      <Percentage>2</Percentage>
      <PlanCount>4</PlanCount>
      <UnifiedTierId>1</UnifiedTierId>
    </UnifiedTierCoverage>
    <UnifiedTierCoverage>
      <Lives>3</Lives>
      <Percentage>2</Percentage>
      <PlanCount>4</PlanCount>
      <UnifiedTierId>1</UnifiedTierId>
    </UnifiedTierCoverage>
  </SummaryCoverages>
</ControllerCoveragesResponse>

Build Request


NameDescription Input Value Type Required / Optional
ProductId

The Id of the Product

integer

Required
ControllerId

The Id of the Controller/Parent

integer

Required
ProjectId

The FormTrak projectId the product is associated with.

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
Options

Enter "PlanCoverages" to include Plan level coverage in addition to Controller coverage.

Collection of string

Optional
LivesTypeId

The Id to override the types of lives to show/use (Default: 4)

integer

Optional




Request URL

GET FormTrak/v1/Projects/ProjectId/Products/ProductId/Coverages?ControllerId=ControllerId&BenefitDesignId=BenefitDesignId&ChannelId=ChannelId&PlanTypeId=PlanTypeId&StateId=StateId&CBSAId=CBSAId&TerritoryId=TerritoryId&Options=Options&LivesTypeId=LivesTypeId

Status

Response Details

Coverage by Product


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


URI Parameters

NameDescription Type Required / Optional
ProductId

The Id of the Product

 integer

Required
ProjectId

The FormTrak projectId the product is associated with.

 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
Options

Enter "PlanCoverages" to include Plan level coverage in addition to Controller coverage. Enter "SummaryCoverages" to include a summary of all statuses in addition to Controller coverage.

 Collection of string

Optional
LivesTypeId

The Id to override the types of lives to show/use (Default: 4)

 integer

Optional
SummaryUseFormTrakControllerExclusions

Set to true to exclude FormTrak excluded controllers (Default: false)

 boolean

Default value is False

Resource Description of Response Object

ControllerCoveragesResponse
NameDescription Type Required / Optional
ControllerCoverages

Collection of Coverage

Optional
PlanCoverages

Collection of PlanCoverage

Optional
SummaryCoverages

Collection of UnifiedTierCoverage

Optional
Statement

string

Optional

Available Response Formats & Sample Data

{
  "ControllerCoverages": [
    {
      "ProductId": 1,
      "Product": "sample string 2",
      "MonthId": 3,
      "ControllerId": 4,
      "Controller": "sample string 5",
      "DrugListTier": {
        "DrugListTierId": 64,
        "Percentage": 2,
        "Lives": 3,
        "PlanCount": 4
      },
      "UnifiedTier": {
        "UnifiedTierId": 1,
        "Percentage": 2,
        "Lives": 3,
        "PlanCount": 4
      },
      "PromotionalTier": {
        "PromotionalTierId": 1,
        "Percentage": 2,
        "Lives": 3,
        "PlanCount": 4
      },
      "Lives": 6,
      "PlanCount": 7
    },
    {
      "ProductId": 1,
      "Product": "sample string 2",
      "MonthId": 3,
      "ControllerId": 4,
      "Controller": "sample string 5",
      "DrugListTier": {
        "DrugListTierId": 64,
        "Percentage": 2,
        "Lives": 3,
        "PlanCount": 4
      },
      "UnifiedTier": {
        "UnifiedTierId": 1,
        "Percentage": 2,
        "Lives": 3,
        "PlanCount": 4
      },
      "PromotionalTier": {
        "PromotionalTierId": 1,
        "Percentage": 2,
        "Lives": 3,
        "PlanCount": 4
      },
      "Lives": 6,
      "PlanCount": 7
    }
  ],
  "PlanCoverages": [
    {
      "PlanId": 1,
      "PlanTypeId": 64,
      "ChannelId": 3,
      "ProductId": 4,
      "MonthId": 5,
      "ControllerId": 6,
      "NoteId": 1,
      "NotesAvailable": 7,
      "Lives": 8,
      "DrugListTierId": 64,
      "FormularyTierId": 10,
      "FormularyUnifiedTierId": 11,
      "UnifiedTierId": 12,
      "PromotionalTierId": 1,
      "IsGeneric": true,
      "PriorAuthorization": true,
      "StepTherapy": true,
      "QuantityLimit": true,
      "SpecialtyPharmacy": true,
      "ConditionalPriorAuthorization": true,
      "DurableMedicalEquipment": true,
      "MedicalBenefit": true,
      "OverTheCounter": true,
      "Variance": true,
      "StateCarveOut": true,
      "FormularyId": 24
    },
    {
      "PlanId": 1,
      "PlanTypeId": 64,
      "ChannelId": 3,
      "ProductId": 4,
      "MonthId": 5,
      "ControllerId": 6,
      "NoteId": 1,
      "NotesAvailable": 7,
      "Lives": 8,
      "DrugListTierId": 64,
      "FormularyTierId": 10,
      "FormularyUnifiedTierId": 11,
      "UnifiedTierId": 12,
      "PromotionalTierId": 1,
      "IsGeneric": true,
      "PriorAuthorization": true,
      "StepTherapy": true,
      "QuantityLimit": true,
      "SpecialtyPharmacy": true,
      "ConditionalPriorAuthorization": true,
      "DurableMedicalEquipment": true,
      "MedicalBenefit": true,
      "OverTheCounter": true,
      "Variance": true,
      "StateCarveOut": true,
      "FormularyId": 24
    }
  ],
  "SummaryCoverages": [
    {
      "UnifiedTierId": 1,
      "Percentage": 2,
      "Lives": 3,
      "PlanCount": 4
    },
    {
      "UnifiedTierId": 1,
      "Percentage": 2,
      "Lives": 3,
      "PlanCount": 4
    }
  ],
  "Statement": "sample string 1"
}

<ControllerCoveragesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.mmitnetwork.com/formulary/coverages">
  <ControllerCoverages>
    <Coverage>
      <Controller>sample string 5</Controller>
      <ControllerId>4</ControllerId>
      <DrugListTier>
        <DrugListTierId>64</DrugListTierId>
        <Lives>3</Lives>
        <Percentage>2</Percentage>
        <PlanCount>4</PlanCount>
      </DrugListTier>
      <Lives>6</Lives>
      <MonthId>3</MonthId>
      <PlanCount>7</PlanCount>
      <Product>sample string 2</Product>
      <ProductId>1</ProductId>
      <PromotionalTier>
        <Lives>3</Lives>
        <Percentage>2</Percentage>
        <PlanCount>4</PlanCount>
        <PromotionalTierId>1</PromotionalTierId>
      </PromotionalTier>
      <UnifiedTier>
        <Lives>3</Lives>
        <Percentage>2</Percentage>
        <PlanCount>4</PlanCount>
        <UnifiedTierId>1</UnifiedTierId>
      </UnifiedTier>
    </Coverage>
    <Coverage>
      <Controller>sample string 5</Controller>
      <ControllerId>4</ControllerId>
      <DrugListTier>
        <DrugListTierId>64</DrugListTierId>
        <Lives>3</Lives>
        <Percentage>2</Percentage>
        <PlanCount>4</PlanCount>
      </DrugListTier>
      <Lives>6</Lives>
      <MonthId>3</MonthId>
      <PlanCount>7</PlanCount>
      <Product>sample string 2</Product>
      <ProductId>1</ProductId>
      <PromotionalTier>
        <Lives>3</Lives>
        <Percentage>2</Percentage>
        <PlanCount>4</PlanCount>
        <PromotionalTierId>1</PromotionalTierId>
      </PromotionalTier>
      <UnifiedTier>
        <Lives>3</Lives>
        <Percentage>2</Percentage>
        <PlanCount>4</PlanCount>
        <UnifiedTierId>1</UnifiedTierId>
      </UnifiedTier>
    </Coverage>
  </ControllerCoverages>
  <PlanCoverages>
    <PlanCoverage>
      <ChannelId>3</ChannelId>
      <ConditionalPriorAuthorization>true</ConditionalPriorAuthorization>
      <ControllerId>6</ControllerId>
      <DrugListTierId>64</DrugListTierId>
      <DurableMedicalEquipment>true</DurableMedicalEquipment>
      <FormularyId>24</FormularyId>
      <FormularyTierId>10</FormularyTierId>
      <FormularyUnifiedTierId>11</FormularyUnifiedTierId>
      <IsGeneric>true</IsGeneric>
      <Lives>8</Lives>
      <MedicalBenefit>true</MedicalBenefit>
      <MonthId>5</MonthId>
      <NoteId>1</NoteId>
      <NotesAvailable>7</NotesAvailable>
      <OverTheCounter>true</OverTheCounter>
      <PlanId>1</PlanId>
      <PlanTypeId>64</PlanTypeId>
      <PriorAuthorization>true</PriorAuthorization>
      <ProductId>4</ProductId>
      <PromotionalTierId>1</PromotionalTierId>
      <QuantityLimit>true</QuantityLimit>
      <SpecialtyPharmacy>true</SpecialtyPharmacy>
      <StateCarveOut>true</StateCarveOut>
      <StepTherapy>true</StepTherapy>
      <UnifiedTierId>12</UnifiedTierId>
      <Variance>true</Variance>
    </PlanCoverage>
    <PlanCoverage>
      <ChannelId>3</ChannelId>
      <ConditionalPriorAuthorization>true</ConditionalPriorAuthorization>
      <ControllerId>6</ControllerId>
      <DrugListTierId>64</DrugListTierId>
      <DurableMedicalEquipment>true</DurableMedicalEquipment>
      <FormularyId>24</FormularyId>
      <FormularyTierId>10</FormularyTierId>
      <FormularyUnifiedTierId>11</FormularyUnifiedTierId>
      <IsGeneric>true</IsGeneric>
      <Lives>8</Lives>
      <MedicalBenefit>true</MedicalBenefit>
      <MonthId>5</MonthId>
      <NoteId>1</NoteId>
      <NotesAvailable>7</NotesAvailable>
      <OverTheCounter>true</OverTheCounter>
      <PlanId>1</PlanId>
      <PlanTypeId>64</PlanTypeId>
      <PriorAuthorization>true</PriorAuthorization>
      <ProductId>4</ProductId>
      <PromotionalTierId>1</PromotionalTierId>
      <QuantityLimit>true</QuantityLimit>
      <SpecialtyPharmacy>true</SpecialtyPharmacy>
      <StateCarveOut>true</StateCarveOut>
      <StepTherapy>true</StepTherapy>
      <UnifiedTierId>12</UnifiedTierId>
      <Variance>true</Variance>
    </PlanCoverage>
  </PlanCoverages>
  <Statement>sample string 1</Statement>
  <SummaryCoverages>
    <UnifiedTierCoverage>
      <Lives>3</Lives>
      <Percentage>2</Percentage>
      <PlanCount>4</PlanCount>
      <UnifiedTierId>1</UnifiedTierId>
    </UnifiedTierCoverage>
    <UnifiedTierCoverage>
      <Lives>3</Lives>
      <Percentage>2</Percentage>
      <PlanCount>4</PlanCount>
      <UnifiedTierId>1</UnifiedTierId>
    </UnifiedTierCoverage>
  </SummaryCoverages>
</ControllerCoveragesResponse>

Build Request


NameDescription Input Value Type Required / Optional
ProductId

The Id of the Product

integer

Required
ProjectId

The FormTrak projectId the product is associated with.

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
Options

Enter "PlanCoverages" to include Plan level coverage in addition to Controller coverage. Enter "SummaryCoverages" to include a summary of all statuses in addition to Controller coverage.

Collection of string

Optional
LivesTypeId

The Id to override the types of lives to show/use (Default: 4)

integer

Optional
SummaryUseFormTrakControllerExclusions

Set to true to exclude FormTrak excluded controllers (Default: false)

boolean

Default value is False




Request URL

GET FormTrak/v1/Projects/ProjectId/Products/ProductId/Coverages?BenefitDesignId=BenefitDesignId&ChannelId=ChannelId&PlanTypeId=PlanTypeId&StateId=StateId&CBSAId=CBSAId&TerritoryId=TerritoryId&Options=Options&LivesTypeId=LivesTypeId&SummaryUseFormTrakControllerExclusions=SummaryUseFormTrakControllerExclusions

Status

Response Details

Competitor Coverage for a specific Controller and Product


Request Url
GET FormTrak/v1/Projects/{ProjectId}/Products/{ProductId}/Competitors/Coverages


URI Parameters

NameDescription Type Required / Optional
ProductId

The Id of the Product

 integer

Required
ControllerId

The Id of the Controller/Parent

 integer

Required
ProjectId

The FormTrak projectId the product is associated with.

 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
Options

Enter "PlanCoverages" to include Plan level coverage in addition to Controller coverage.

 Collection of string

Optional
LivesTypeId

The Id to override the types of lives to show/use (Default: 4)

 integer

Optional

Resource Description of Response Object

CompetitorControllerCoveragesResponse
NameDescription Type Required / Optional
ControllerCoverages

Collection of Coverage

Optional
PlanCoverages

Collection of PlanCoverage

Optional
Products

Collection of Product

Optional

Available Response Formats & Sample Data

{
  "ControllerCoverages": [
    {
      "ProductId": 1,
      "Product": "sample string 2",
      "MonthId": 3,
      "ControllerId": 4,
      "Controller": "sample string 5",
      "DrugListTier": {
        "DrugListTierId": 64,
        "Percentage": 2,
        "Lives": 3,
        "PlanCount": 4
      },
      "UnifiedTier": {
        "UnifiedTierId": 1,
        "Percentage": 2,
        "Lives": 3,
        "PlanCount": 4
      },
      "PromotionalTier": {
        "PromotionalTierId": 1,
        "Percentage": 2,
        "Lives": 3,
        "PlanCount": 4
      },
      "Lives": 6,
      "PlanCount": 7
    },
    {
      "ProductId": 1,
      "Product": "sample string 2",
      "MonthId": 3,
      "ControllerId": 4,
      "Controller": "sample string 5",
      "DrugListTier": {
        "DrugListTierId": 64,
        "Percentage": 2,
        "Lives": 3,
        "PlanCount": 4
      },
      "UnifiedTier": {
        "UnifiedTierId": 1,
        "Percentage": 2,
        "Lives": 3,
        "PlanCount": 4
      },
      "PromotionalTier": {
        "PromotionalTierId": 1,
        "Percentage": 2,
        "Lives": 3,
        "PlanCount": 4
      },
      "Lives": 6,
      "PlanCount": 7
    }
  ],
  "PlanCoverages": [
    {
      "PlanId": 1,
      "PlanTypeId": 64,
      "ChannelId": 3,
      "ProductId": 4,
      "MonthId": 5,
      "ControllerId": 6,
      "NoteId": 1,
      "NotesAvailable": 7,
      "Lives": 8,
      "DrugListTierId": 64,
      "FormularyTierId": 10,
      "FormularyUnifiedTierId": 11,
      "UnifiedTierId": 12,
      "PromotionalTierId": 1,
      "IsGeneric": true,
      "PriorAuthorization": true,
      "StepTherapy": true,
      "QuantityLimit": true,
      "SpecialtyPharmacy": true,
      "ConditionalPriorAuthorization": true,
      "DurableMedicalEquipment": true,
      "MedicalBenefit": true,
      "OverTheCounter": true,
      "Variance": true,
      "StateCarveOut": true,
      "FormularyId": 24
    },
    {
      "PlanId": 1,
      "PlanTypeId": 64,
      "ChannelId": 3,
      "ProductId": 4,
      "MonthId": 5,
      "ControllerId": 6,
      "NoteId": 1,
      "NotesAvailable": 7,
      "Lives": 8,
      "DrugListTierId": 64,
      "FormularyTierId": 10,
      "FormularyUnifiedTierId": 11,
      "UnifiedTierId": 12,
      "PromotionalTierId": 1,
      "IsGeneric": true,
      "PriorAuthorization": true,
      "StepTherapy": true,
      "QuantityLimit": true,
      "SpecialtyPharmacy": true,
      "ConditionalPriorAuthorization": true,
      "DurableMedicalEquipment": true,
      "MedicalBenefit": true,
      "OverTheCounter": true,
      "Variance": true,
      "StateCarveOut": true,
      "FormularyId": 24
    }
  ],
  "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"
    }
  ]
}

<CompetitorControllerCoveragesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.mmitnetwork.com/formtrak/coverages">
  <ControllerCoverages xmlns:d2p1="http://api.mmitnetwork.com/formulary/coverages">
    <d2p1:Coverage>
      <d2p1:Controller>sample string 5</d2p1:Controller>
      <d2p1:ControllerId>4</d2p1:ControllerId>
      <d2p1:DrugListTier>
        <d2p1:DrugListTierId>64</d2p1:DrugListTierId>
        <d2p1:Lives>3</d2p1:Lives>
        <d2p1:Percentage>2</d2p1:Percentage>
        <d2p1:PlanCount>4</d2p1:PlanCount>
      </d2p1:DrugListTier>
      <d2p1:Lives>6</d2p1:Lives>
      <d2p1:MonthId>3</d2p1:MonthId>
      <d2p1:PlanCount>7</d2p1:PlanCount>
      <d2p1:Product>sample string 2</d2p1:Product>
      <d2p1:ProductId>1</d2p1:ProductId>
      <d2p1:PromotionalTier>
        <d2p1:Lives>3</d2p1:Lives>
        <d2p1:Percentage>2</d2p1:Percentage>
        <d2p1:PlanCount>4</d2p1:PlanCount>
        <d2p1:PromotionalTierId>1</d2p1:PromotionalTierId>
      </d2p1:PromotionalTier>
      <d2p1:UnifiedTier>
        <d2p1:Lives>3</d2p1:Lives>
        <d2p1:Percentage>2</d2p1:Percentage>
        <d2p1:PlanCount>4</d2p1:PlanCount>
        <d2p1:UnifiedTierId>1</d2p1:UnifiedTierId>
      </d2p1:UnifiedTier>
    </d2p1:Coverage>
    <d2p1:Coverage>
      <d2p1:Controller>sample string 5</d2p1:Controller>
      <d2p1:ControllerId>4</d2p1:ControllerId>
      <d2p1:DrugListTier>
        <d2p1:DrugListTierId>64</d2p1:DrugListTierId>
        <d2p1:Lives>3</d2p1:Lives>
        <d2p1:Percentage>2</d2p1:Percentage>
        <d2p1:PlanCount>4</d2p1:PlanCount>
      </d2p1:DrugListTier>
      <d2p1:Lives>6</d2p1:Lives>
      <d2p1:MonthId>3</d2p1:MonthId>
      <d2p1:PlanCount>7</d2p1:PlanCount>
      <d2p1:Product>sample string 2</d2p1:Product>
      <d2p1:ProductId>1</d2p1:ProductId>
      <d2p1:PromotionalTier>
        <d2p1:Lives>3</d2p1:Lives>
        <d2p1:Percentage>2</d2p1:Percentage>
        <d2p1:PlanCount>4</d2p1:PlanCount>
        <d2p1:PromotionalTierId>1</d2p1:PromotionalTierId>
      </d2p1:PromotionalTier>
      <d2p1:UnifiedTier>
        <d2p1:Lives>3</d2p1:Lives>
        <d2p1:Percentage>2</d2p1:Percentage>
        <d2p1:PlanCount>4</d2p1:PlanCount>
        <d2p1:UnifiedTierId>1</d2p1:UnifiedTierId>
      </d2p1:UnifiedTier>
    </d2p1:Coverage>
  </ControllerCoverages>
  <PlanCoverages xmlns:d2p1="http://api.mmitnetwork.com/formulary/coverages">
    <d2p1:PlanCoverage>
      <d2p1:ChannelId>3</d2p1:ChannelId>
      <d2p1:ConditionalPriorAuthorization>true</d2p1:ConditionalPriorAuthorization>
      <d2p1:ControllerId>6</d2p1:ControllerId>
      <d2p1:DrugListTierId>64</d2p1:DrugListTierId>
      <d2p1:DurableMedicalEquipment>true</d2p1:DurableMedicalEquipment>
      <d2p1:FormularyId>24</d2p1:FormularyId>
      <d2p1:FormularyTierId>10</d2p1:FormularyTierId>
      <d2p1:FormularyUnifiedTierId>11</d2p1:FormularyUnifiedTierId>
      <d2p1:IsGeneric>true</d2p1:IsGeneric>
      <d2p1:Lives>8</d2p1:Lives>
      <d2p1:MedicalBenefit>true</d2p1:MedicalBenefit>
      <d2p1:MonthId>5</d2p1:MonthId>
      <d2p1:NoteId>1</d2p1:NoteId>
      <d2p1:NotesAvailable>7</d2p1:NotesAvailable>
      <d2p1:OverTheCounter>true</d2p1:OverTheCounter>
      <d2p1:PlanId>1</d2p1:PlanId>
      <d2p1:PlanTypeId>64</d2p1:PlanTypeId>
      <d2p1:PriorAuthorization>true</d2p1:PriorAuthorization>
      <d2p1:ProductId>4</d2p1:ProductId>
      <d2p1:PromotionalTierId>1</d2p1:PromotionalTierId>
      <d2p1:QuantityLimit>true</d2p1:QuantityLimit>
      <d2p1:SpecialtyPharmacy>true</d2p1:SpecialtyPharmacy>
      <d2p1:StateCarveOut>true</d2p1:StateCarveOut>
      <d2p1:StepTherapy>true</d2p1:StepTherapy>
      <d2p1:UnifiedTierId>12</d2p1:UnifiedTierId>
      <d2p1:Variance>true</d2p1:Variance>
    </d2p1:PlanCoverage>
    <d2p1:PlanCoverage>
      <d2p1:ChannelId>3</d2p1:ChannelId>
      <d2p1:ConditionalPriorAuthorization>true</d2p1:ConditionalPriorAuthorization>
      <d2p1:ControllerId>6</d2p1:ControllerId>
      <d2p1:DrugListTierId>64</d2p1:DrugListTierId>
      <d2p1:DurableMedicalEquipment>true</d2p1:DurableMedicalEquipment>
      <d2p1:FormularyId>24</d2p1:FormularyId>
      <d2p1:FormularyTierId>10</d2p1:FormularyTierId>
      <d2p1:FormularyUnifiedTierId>11</d2p1:FormularyUnifiedTierId>
      <d2p1:IsGeneric>true</d2p1:IsGeneric>
      <d2p1:Lives>8</d2p1:Lives>
      <d2p1:MedicalBenefit>true</d2p1:MedicalBenefit>
      <d2p1:MonthId>5</d2p1:MonthId>
      <d2p1:NoteId>1</d2p1:NoteId>
      <d2p1:NotesAvailable>7</d2p1:NotesAvailable>
      <d2p1:OverTheCounter>true</d2p1:OverTheCounter>
      <d2p1:PlanId>1</d2p1:PlanId>
      <d2p1:PlanTypeId>64</d2p1:PlanTypeId>
      <d2p1:PriorAuthorization>true</d2p1:PriorAuthorization>
      <d2p1:ProductId>4</d2p1:ProductId>
      <d2p1:PromotionalTierId>1</d2p1:PromotionalTierId>
      <d2p1:QuantityLimit>true</d2p1:QuantityLimit>
      <d2p1:SpecialtyPharmacy>true</d2p1:SpecialtyPharmacy>
      <d2p1:StateCarveOut>true</d2p1:StateCarveOut>
      <d2p1:StepTherapy>true</d2p1:StepTherapy>
      <d2p1:UnifiedTierId>12</d2p1:UnifiedTierId>
      <d2p1:Variance>true</d2p1:Variance>
    </d2p1:PlanCoverage>
  </PlanCoverages>
  <Products xmlns:d2p1="http://api.mmitnetwork.com/formulary/products">
    <d2p1:Product>
      <d2p1:DisplayName>sample string 4</d2p1:DisplayName>
      <d2p1:Drug>
        <d2p1:Brand>sample string 5</d2p1:Brand>
        <d2p1:Description>sample string 4</d2p1:Description>
        <d2p1:DrugId>1</d2p1:DrugId>
        <d2p1:DrugTypeId>64</d2p1:DrugTypeId>
        <d2p1:ImportantSafetyInformation>sample string 9</d2p1:ImportantSafetyInformation>
        <d2p1:IsGeneric>true</d2p1:IsGeneric>
        <d2p1:IsOwner>true</d2p1:IsOwner>
        <d2p1:Logo>sample string 8</d2p1:Logo>
        <d2p1:Name>sample string 3</d2p1:Name>
        <d2p1:OverTheCounter>true</d2p1:OverTheCounter>
        <d2p1:Rank>64</d2p1:Rank>
      </d2p1:Drug>
      <d2p1:ProductId>1</d2p1:ProductId>
      <d2p1:TherapeuticClass>sample string 3</d2p1:TherapeuticClass>
      <d2p1:TherapeuticClassId>2</d2p1:TherapeuticClassId>
    </d2p1:Product>
    <d2p1:Product>
      <d2p1:DisplayName>sample string 4</d2p1:DisplayName>
      <d2p1:Drug>
        <d2p1:Brand>sample string 5</d2p1:Brand>
        <d2p1:Description>sample string 4</d2p1:Description>
        <d2p1:DrugId>1</d2p1:DrugId>
        <d2p1:DrugTypeId>64</d2p1:DrugTypeId>
        <d2p1:ImportantSafetyInformation>sample string 9</d2p1:ImportantSafetyInformation>
        <d2p1:IsGeneric>true</d2p1:IsGeneric>
        <d2p1:IsOwner>true</d2p1:IsOwner>
        <d2p1:Logo>sample string 8</d2p1:Logo>
        <d2p1:Name>sample string 3</d2p1:Name>
        <d2p1:OverTheCounter>true</d2p1:OverTheCounter>
        <d2p1:Rank>64</d2p1:Rank>
      </d2p1:Drug>
      <d2p1:ProductId>1</d2p1:ProductId>
      <d2p1:TherapeuticClass>sample string 3</d2p1:TherapeuticClass>
      <d2p1:TherapeuticClassId>2</d2p1:TherapeuticClassId>
    </d2p1:Product>
  </Products>
</CompetitorControllerCoveragesResponse>

Build Request


NameDescription Input Value Type Required / Optional
ProductId

The Id of the Product

integer

Required
ControllerId

The Id of the Controller/Parent

integer

Required
ProjectId

The FormTrak projectId the product is associated with.

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
Options

Enter "PlanCoverages" to include Plan level coverage in addition to Controller coverage.

Collection of string

Optional
LivesTypeId

The Id to override the types of lives to show/use (Default: 4)

integer

Optional




Request URL

GET FormTrak/v1/Projects/ProjectId/Products/ProductId/Competitors/Coverages?ControllerId=ControllerId&BenefitDesignId=BenefitDesignId&ChannelId=ChannelId&PlanTypeId=PlanTypeId&StateId=StateId&CBSAId=CBSAId&TerritoryId=TerritoryId&Options=Options&LivesTypeId=LivesTypeId

Status

Response Details

Coverage Statements by Product


Request Url
GET FormTrak/v1/Projects/{ProjectId}/Products/{ProductId}/Coverages/Statements


URI Parameters

NameDescription Type Required / Optional
ProductId

The Id of the Product

 integer

Required
ProjectId

The FormTrak projectId the product is associated with.

 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/use (Default: 4)

 integer

Optional

Resource Description of Response Object

StatementCoveragesResponse
NameDescription Type Required / Optional
Statements

Collection of Statement

Optional

Available Response Formats & Sample Data

{
  "Statements": [
    {
      "Value": "sample string 1",
      "IsValid": true,
      "Rank": 3
    },
    {
      "Value": "sample string 1",
      "IsValid": true,
      "Rank": 3
    }
  ]
}

<StatementCoveragesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.mmitnetwork.com/formulary/coverages">
  <Statements>
    <Statement>
      <IsValid>true</IsValid>
      <Rank>3</Rank>
      <Value>sample string 1</Value>
    </Statement>
    <Statement>
      <IsValid>true</IsValid>
      <Rank>3</Rank>
      <Value>sample string 1</Value>
    </Statement>
  </Statements>
</StatementCoveragesResponse>

Build Request


NameDescription Input Value Type Required / Optional
ProductId

The Id of the Product

integer

Required
ProjectId

The FormTrak projectId the product is associated with.

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/use (Default: 4)

integer

Optional




Request URL

GET FormTrak/v1/Projects/ProjectId/Products/ProductId/Coverages/Statements?BenefitDesignId=BenefitDesignId&ChannelId=ChannelId&PlanTypeId=PlanTypeId&StateId=StateId&CBSAId=CBSAId&TerritoryId=TerritoryId&LivesTypeId=LivesTypeId

Status

Response Details