DerivedField

The DerivedField resource allows for the retrieval of Client Configured coverage information for any number of fields and Products.It also allows for the return of all available Client Configured data elements per client in question.The coverage information returned can be grouped by the Controller and is accompanied by a winning status and percentage.The data can also be filtered by a number of parameters including channel, state, CBSA and more.


Derived fields for a client

Derived fields for a Product and Formulary

Derived values for a client

Coverage by Product


Derived fields for a client


Request Url
GET Formulary/v1/DerivedField


URI Parameters

No parameters are required for this Resource URI.


Resource Description of Response Object

DerivedFieldResponse
NameDescription Type Required / Optional
DerivedFields

Collection of DerivedField

Optional


Available Response Formats & Sample Data

{
  "DerivedFields": [
    {
      "DerivedFieldId": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "ApplicableIndicationIds": [
        1,
        2
      ]
    },
    {
      "DerivedFieldId": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "ApplicableIndicationIds": [
        1,
        2
      ]
    }
  ]
}
<DerivedFieldResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.mmitnetwork.com/formulary/derivedfield">
  <DerivedFields>
    <DerivedField>
      <ApplicableIndicationIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </ApplicableIndicationIds>
      <DerivedFieldId>1</DerivedFieldId>
      <Description>sample string 3</Description>
      <Name>sample string 2</Name>
    </DerivedField>
    <DerivedField>
      <ApplicableIndicationIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </ApplicableIndicationIds>
      <DerivedFieldId>1</DerivedFieldId>
      <Description>sample string 3</Description>
      <Name>sample string 2</Name>
    </DerivedField>
  </DerivedFields>
</DerivedFieldResponse>

Build Request


No parameters are required for this Resource URI.





Request URL

GET Formulary/v1/DerivedField

Status

Response Details

            
            

Derived fields for a Product and Formulary


Request Url
GET Formulary/v1/DerivedField


URI Parameters

NameDescription Type Required / Optional
ProductId

The Id of the Product

integer

Required

FormularyId

The Id of the Formulary

integer

Required

DerivedFieldId

The optional Id of the DerivedField

integer

Optional


Resource Description of Response Object

DerivedFieldWithValueResponse
NameDescription Type Required / Optional
DerivedFields

Collection of DerivedFieldWithValue

Optional


Available Response Formats & Sample Data

{
  "DerivedFields": [
    {
      "ProductId": 1,
      "FormularyId": 1,
      "DerivedFieldId": 1,
      "DerivedValueId": 1,
      "MonthId": 1,
      "Value": "sample string 2",
      "Name": "sample string 3",
      "Description": "sample string 4",
      "ApplicableIndicationIds": [
        1,
        2
      ]
    },
    {
      "ProductId": 1,
      "FormularyId": 1,
      "DerivedFieldId": 1,
      "DerivedValueId": 1,
      "MonthId": 1,
      "Value": "sample string 2",
      "Name": "sample string 3",
      "Description": "sample string 4",
      "ApplicableIndicationIds": [
        1,
        2
      ]
    }
  ]
}
<DerivedFieldWithValueResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.mmitnetwork.com/formulary/derivedfield">
  <DerivedFields>
    <DerivedFieldWithValue>
      <ApplicableIndicationIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </ApplicableIndicationIds>
      <DerivedFieldId>1</DerivedFieldId>
      <DerivedValueId>1</DerivedValueId>
      <Description>sample string 4</Description>
      <FormularyId>1</FormularyId>
      <MonthId>1</MonthId>
      <Name>sample string 3</Name>
      <ProductId>1</ProductId>
      <Value>sample string 2</Value>
    </DerivedFieldWithValue>
    <DerivedFieldWithValue>
      <ApplicableIndicationIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </ApplicableIndicationIds>
      <DerivedFieldId>1</DerivedFieldId>
      <DerivedValueId>1</DerivedValueId>
      <Description>sample string 4</Description>
      <FormularyId>1</FormularyId>
      <MonthId>1</MonthId>
      <Name>sample string 3</Name>
      <ProductId>1</ProductId>
      <Value>sample string 2</Value>
    </DerivedFieldWithValue>
  </DerivedFields>
</DerivedFieldWithValueResponse>

Build Request


NameDescription Input Value Type Required / Optional
ProductId

The Id of the Product

integer

Required

FormularyId

The Id of the Formulary

integer

Required

DerivedFieldId

The optional Id of the DerivedField

integer

Optional





Request URL

GET Formulary/v1/DerivedField?ProductId=ProductId&FormularyId=FormularyId&DerivedFieldId=DerivedFieldId

Status

Response Details

            
            

Derived values for a client


Request Url
GET Formulary/v1/DerivedField/{DerivedFieldId}/DerivedValues


URI Parameters

NameDescription Type Required / Optional
DerivedFieldId

The Id of the Derived Field.

integer

Required

DerivedValueId

The Id of the Derived Value.

integer

Optional


Resource Description of Response Object

DerivedValueResponse
NameDescription Type Required / Optional
DerivedValues

Collection of DerivedValue

Optional


Available Response Formats & Sample Data

{
  "DerivedValues": [
    {
      "DerivedFieldId": 1,
      "DerivedValueId": 2,
      "Rank": 3,
      "Color": "sample string 4",
      "Value": "sample string 5"
    },
    {
      "DerivedFieldId": 1,
      "DerivedValueId": 2,
      "Rank": 3,
      "Color": "sample string 4",
      "Value": "sample string 5"
    }
  ]
}
<DerivedValueResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.mmitnetwork.com/formulary/derivedfield">
  <DerivedValues>
    <DerivedValue>
      <Color>sample string 4</Color>
      <DerivedFieldId>1</DerivedFieldId>
      <DerivedValueId>2</DerivedValueId>
      <Rank>3</Rank>
      <Value>sample string 5</Value>
    </DerivedValue>
    <DerivedValue>
      <Color>sample string 4</Color>
      <DerivedFieldId>1</DerivedFieldId>
      <DerivedValueId>2</DerivedValueId>
      <Rank>3</Rank>
      <Value>sample string 5</Value>
    </DerivedValue>
  </DerivedValues>
</DerivedValueResponse>

Build Request


NameDescription Input Value Type Required / Optional
DerivedFieldId

The Id of the Derived Field.

integer

Required

DerivedValueId

The Id of the Derived Value.

integer

Optional





Request URL

GET Formulary/v1/DerivedField/DerivedFieldId/DerivedValues?DerivedValueId=DerivedValueId

Status

Response Details

            
            

Coverage by Product


Request Url
GET Formulary/v1/DerivedField/Coverage


URI Parameters

NameDescription Type Required / Optional
ProductId

The Id of the Product

integer

Required

DerivedFieldId

The Derived Field Id

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 "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 used (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

DerivedFieldCoveragesResponse
NameDescription Type Required / Optional
ControllerCoverages

Collection of DerivedFieldControllerCoverage

Optional

SummaryCoverages

Collection of DerivedFieldSummaryCoverage

Optional

Statement

string

Optional


Available Response Formats & Sample Data

{
  "ControllerCoverages": [
    {
      "ProductId": 1,
      "MonthId": 2,
      "ControllerId": 3,
      "DerivedField": {
        "ProductId": 1,
        "FormularyId": 1,
        "DerivedFieldId": 1,
        "DerivedValueId": 1,
        "MonthId": 1,
        "Value": "sample string 2",
        "Lives": 1,
        "PlanCount": 1,
        "Percentage": 1
      },
      "DerivedFieldId": 4,
      "Lives": 5,
      "PlanCount": 6
    },
    {
      "ProductId": 1,
      "MonthId": 2,
      "ControllerId": 3,
      "DerivedField": {
        "ProductId": 1,
        "FormularyId": 1,
        "DerivedFieldId": 1,
        "DerivedValueId": 1,
        "MonthId": 1,
        "Value": "sample string 2",
        "Lives": 1,
        "PlanCount": 1,
        "Percentage": 1
      },
      "DerivedFieldId": 4,
      "Lives": 5,
      "PlanCount": 6
    }
  ],
  "SummaryCoverages": [
    {
      "DerivedFieldId": 1,
      "DerivedValueId": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Value": "sample string 4",
      "Lives": 1,
      "PlanCount": 1,
      "Percentage": 1
    },
    {
      "DerivedFieldId": 1,
      "DerivedValueId": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Value": "sample string 4",
      "Lives": 1,
      "PlanCount": 1,
      "Percentage": 1
    }
  ],
  "Statement": "sample string 1"
}
<DerivedFieldCoveragesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.mmitnetwork.com/formulary/derivedfield">
  <ControllerCoverages>
    <DerivedFieldControllerCoverage>
      <ControllerId>3</ControllerId>
      <DerivedField>
        <DerivedFieldId>1</DerivedFieldId>
        <DerivedValueId>1</DerivedValueId>
        <FormularyId>1</FormularyId>
        <Lives>1</Lives>
        <MonthId>1</MonthId>
        <Percentage>1</Percentage>
        <PlanCount>1</PlanCount>
        <ProductId>1</ProductId>
        <Value>sample string 2</Value>
      </DerivedField>
      <DerivedFieldId>4</DerivedFieldId>
      <Lives>5</Lives>
      <MonthId>2</MonthId>
      <PlanCount>6</PlanCount>
      <ProductId>1</ProductId>
    </DerivedFieldControllerCoverage>
    <DerivedFieldControllerCoverage>
      <ControllerId>3</ControllerId>
      <DerivedField>
        <DerivedFieldId>1</DerivedFieldId>
        <DerivedValueId>1</DerivedValueId>
        <FormularyId>1</FormularyId>
        <Lives>1</Lives>
        <MonthId>1</MonthId>
        <Percentage>1</Percentage>
        <PlanCount>1</PlanCount>
        <ProductId>1</ProductId>
        <Value>sample string 2</Value>
      </DerivedField>
      <DerivedFieldId>4</DerivedFieldId>
      <Lives>5</Lives>
      <MonthId>2</MonthId>
      <PlanCount>6</PlanCount>
      <ProductId>1</ProductId>
    </DerivedFieldControllerCoverage>
  </ControllerCoverages>
  <Statement>sample string 1</Statement>
  <SummaryCoverages>
    <DerivedFieldSummaryCoverage>
      <DerivedFieldId>1</DerivedFieldId>
      <DerivedValueId>1</DerivedValueId>
      <Description>sample string 3</Description>
      <Lives>1</Lives>
      <Name>sample string 2</Name>
      <Percentage>1</Percentage>
      <PlanCount>1</PlanCount>
      <Value>sample string 4</Value>
    </DerivedFieldSummaryCoverage>
    <DerivedFieldSummaryCoverage>
      <DerivedFieldId>1</DerivedFieldId>
      <DerivedValueId>1</DerivedValueId>
      <Description>sample string 3</Description>
      <Lives>1</Lives>
      <Name>sample string 2</Name>
      <Percentage>1</Percentage>
      <PlanCount>1</PlanCount>
      <Value>sample string 4</Value>
    </DerivedFieldSummaryCoverage>
  </SummaryCoverages>
</DerivedFieldCoveragesResponse>

Build Request


NameDescription Input Value Type Required / Optional
ProductId

The Id of the Product

integer

Required

DerivedFieldId

The Derived Field Id

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 "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 used (Default: 4)

integer

Optional

SummaryUseFormTrakControllerExclusions

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

boolean

Default value is False





Request URL

GET Formulary/v1/DerivedField/Coverage?ProductId=ProductId&DerivedFieldId=DerivedFieldId&BenefitDesignId=BenefitDesignId&ChannelId=ChannelId&PlanTypeId=PlanTypeId&StateId=StateId&CBSAId=CBSAId&TerritoryId=TerritoryId&Options=Options&LivesTypeId=LivesTypeId&SummaryUseFormTrakControllerExclusions=SummaryUseFormTrakControllerExclusions

Status

Response Details