GET api/patients/{patientId}/therapeuticAlternatives?patientEligibilityId={patientEligibilityId}&ndc={ndc}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
patientId

integer

Required

patientEligibilityId

integer

Required

ndc

string

Required

Body Parameters

None.

Response Information

Resource Description

ListResponseOfTherapeuticAlternativesResponse
NameDescriptionTypeAdditional information
Items

Collection of TherapeuticAlternativesResponse

None.

Result

Result

None.

Response Formats

application/json, text/json

Sample:
{
  "Items": [
    {
      "Ndc": "sample string 1",
      "FormularyStatus": "sample string 2",
      "Copay": {
        "IsDrugSpecific": true,
        "PharmacyType": 1,
        "FlatCopayAmount": 1.1,
        "PercentCopayAmount": 1.1,
        "FlatCopayAmountFirst": true,
        "MinimumCopayAmount": 1.1,
        "MaximumCopayAmount": 1.1,
        "DaysSupply": 1,
        "CopayTier": 1,
        "MaximumCopayTier": 1,
        "OutOfPocketMinimum": 1.1,
        "OutOfPocketMaximum": 1.1
      },
      "DisplayName": "sample string 3",
      "FormularyInfo": {
        "ProductId": 1,
        "Ndc": "sample string 2",
        "FormularyStatusId": 3,
        "FormularyAbbreviation": "sample string 4",
        "FormularyStatusMessage": "sample string 5",
        "OrderRank": 6,
        "IsGeneric": true,
        "IsRx": true
      },
      "FullDisplayString": "sample string 4",
      "DisplayStrength": "sample string 5",
      "DefaultDispenseUnitID": 6,
      "LexiGenProductID": 7,
      "LexiDrugSynID": 8,
      "LexiSynonymTypeID": 9,
      "Schedule": 10,
      "IsDetox": true,
      "HasGHB": true,
      "RxCUI": 13,
      "Result": {
        "ResultCode": "sample string 1",
        "ResultDescription": "sample string 2"
      }
    },
    {
      "Ndc": "sample string 1",
      "FormularyStatus": "sample string 2",
      "Copay": {
        "IsDrugSpecific": true,
        "PharmacyType": 1,
        "FlatCopayAmount": 1.1,
        "PercentCopayAmount": 1.1,
        "FlatCopayAmountFirst": true,
        "MinimumCopayAmount": 1.1,
        "MaximumCopayAmount": 1.1,
        "DaysSupply": 1,
        "CopayTier": 1,
        "MaximumCopayTier": 1,
        "OutOfPocketMinimum": 1.1,
        "OutOfPocketMaximum": 1.1
      },
      "DisplayName": "sample string 3",
      "FormularyInfo": {
        "ProductId": 1,
        "Ndc": "sample string 2",
        "FormularyStatusId": 3,
        "FormularyAbbreviation": "sample string 4",
        "FormularyStatusMessage": "sample string 5",
        "OrderRank": 6,
        "IsGeneric": true,
        "IsRx": true
      },
      "FullDisplayString": "sample string 4",
      "DisplayStrength": "sample string 5",
      "DefaultDispenseUnitID": 6,
      "LexiGenProductID": 7,
      "LexiDrugSynID": 8,
      "LexiSynonymTypeID": 9,
      "Schedule": 10,
      "IsDetox": true,
      "HasGHB": true,
      "RxCUI": 13,
      "Result": {
        "ResultCode": "sample string 1",
        "ResultDescription": "sample string 2"
      }
    }
  ],
  "Result": {
    "ResultCode": "sample string 1",
    "ResultDescription": "sample string 2"
  }
}

application/xml, text/xml

Sample:
<ListResponseOfTherapeuticAlternativesResponse8Vkccj_Sk xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13">
  <Result>
    <ResultCode>sample string 1</ResultCode>
    <ResultDescription>sample string 2</ResultDescription>
  </Result>
  <Items>
    <TherapeuticAlternativesResponse>
      <Result>
        <ResultCode>sample string 1</ResultCode>
        <ResultDescription>sample string 2</ResultDescription>
      </Result>
      <Copay>
        <CopayTier>1</CopayTier>
        <DaysSupply>1</DaysSupply>
        <FlatCopayAmount>1.1</FlatCopayAmount>
        <FlatCopayAmountFirst>true</FlatCopayAmountFirst>
        <IsDrugSpecific>true</IsDrugSpecific>
        <MaximumCopayAmount>1.1</MaximumCopayAmount>
        <MaximumCopayTier>1</MaximumCopayTier>
        <MinimumCopayAmount>1.1</MinimumCopayAmount>
        <OutOfPocketMaximum>1.1</OutOfPocketMaximum>
        <OutOfPocketMinimum>1.1</OutOfPocketMinimum>
        <PercentCopayAmount>1.1</PercentCopayAmount>
        <PharmacyType>MailOrder</PharmacyType>
      </Copay>
      <DefaultDispenseUnitID>6</DefaultDispenseUnitID>
      <DisplayName>sample string 3</DisplayName>
      <DisplayStrength>sample string 5</DisplayStrength>
      <FormularyInfo>
        <FormularyAbbreviation>sample string 4</FormularyAbbreviation>
        <FormularyStatusId>3</FormularyStatusId>
        <FormularyStatusMessage>sample string 5</FormularyStatusMessage>
        <IsGeneric>true</IsGeneric>
        <IsRx>true</IsRx>
        <Ndc>sample string 2</Ndc>
        <OrderRank>6</OrderRank>
        <ProductId>1</ProductId>
      </FormularyInfo>
      <FormularyStatus>sample string 2</FormularyStatus>
      <FullDisplayString>sample string 4</FullDisplayString>
      <HasGHB>true</HasGHB>
      <IsDetox>true</IsDetox>
      <LexiDrugSynID>8</LexiDrugSynID>
      <LexiGenProductID>7</LexiGenProductID>
      <LexiSynonymTypeID>9</LexiSynonymTypeID>
      <Ndc>sample string 1</Ndc>
      <RxCUI>13</RxCUI>
      <Schedule>10</Schedule>
    </TherapeuticAlternativesResponse>
    <TherapeuticAlternativesResponse>
      <Result>
        <ResultCode>sample string 1</ResultCode>
        <ResultDescription>sample string 2</ResultDescription>
      </Result>
      <Copay>
        <CopayTier>1</CopayTier>
        <DaysSupply>1</DaysSupply>
        <FlatCopayAmount>1.1</FlatCopayAmount>
        <FlatCopayAmountFirst>true</FlatCopayAmountFirst>
        <IsDrugSpecific>true</IsDrugSpecific>
        <MaximumCopayAmount>1.1</MaximumCopayAmount>
        <MaximumCopayTier>1</MaximumCopayTier>
        <MinimumCopayAmount>1.1</MinimumCopayAmount>
        <OutOfPocketMaximum>1.1</OutOfPocketMaximum>
        <OutOfPocketMinimum>1.1</OutOfPocketMinimum>
        <PercentCopayAmount>1.1</PercentCopayAmount>
        <PharmacyType>MailOrder</PharmacyType>
      </Copay>
      <DefaultDispenseUnitID>6</DefaultDispenseUnitID>
      <DisplayName>sample string 3</DisplayName>
      <DisplayStrength>sample string 5</DisplayStrength>
      <FormularyInfo>
        <FormularyAbbreviation>sample string 4</FormularyAbbreviation>
        <FormularyStatusId>3</FormularyStatusId>
        <FormularyStatusMessage>sample string 5</FormularyStatusMessage>
        <IsGeneric>true</IsGeneric>
        <IsRx>true</IsRx>
        <Ndc>sample string 2</Ndc>
        <OrderRank>6</OrderRank>
        <ProductId>1</ProductId>
      </FormularyInfo>
      <FormularyStatus>sample string 2</FormularyStatus>
      <FullDisplayString>sample string 4</FullDisplayString>
      <HasGHB>true</HasGHB>
      <IsDetox>true</IsDetox>
      <LexiDrugSynID>8</LexiDrugSynID>
      <LexiGenProductID>7</LexiGenProductID>
      <LexiSynonymTypeID>9</LexiSynonymTypeID>
      <Ndc>sample string 1</Ndc>
      <RxCUI>13</RxCUI>
      <Schedule>10</Schedule>
    </TherapeuticAlternativesResponse>
  </Items>
</ListResponseOfTherapeuticAlternativesResponse8Vkccj_Sk>