IPrimeSuiteAPI REST API Documentation


MedicationTherapeuticAlternativesGet


Method: POST

URI Template: https://api-test.greenwaymedical.com/Integration/RESTv1.0/PrimeSuiteAPIService/MedicationTherapeuticAlternativesGet

Request Format: Xml or Json

Request XML Example (schema): 

<?xml version="1.0" encoding="utf-16"?>
<MedicationTherapeuticAlternativesGetRequest>
  <Header>
    <SourceSiteID>String Content</SourceSiteID>
    <DestinationSiteID>String Content</DestinationSiteID>
    <PrimeSuiteUserID>0</PrimeSuiteUserID>
  </Header>
  <Credentials>
    <PrimeSuiteCredential>
      <PrimeSuiteSiteId>String Content</PrimeSuiteSiteId>
      <PrimeSuiteUserName>String Content</PrimeSuiteUserName>
      <PrimeSuiteUserPassword>String Content</PrimeSuiteUserPassword>
      <PrimeSuiteUserAlias>String Content</PrimeSuiteUserAlias>
    </PrimeSuiteCredential>
    <VendorCredential>
      <VendorLogin>String Content</VendorLogin>
      <VendorPassword>String Content</VendorPassword>
    </VendorCredential>
  </Credentials>
  <MNID>0</MNID>
  <MEDID>0</MEDID>
  <PBMPatientInfo>
    <CopayID>String Content</CopayID>
    <CoverageID>String Content</CoverageID>
    <AlternativeID>String Content</AlternativeID>
    <FormularyID>String Content</FormularyID>
    <PlanName>String Content</PlanName>
    <PayerName>String Content</PayerName>
  </PBMPatientInfo>
</MedicationTherapeuticAlternativesGetRequest>

Request Json Example (schema): 

{
  "Header": {
    "SourceSiteID": "String Content",
    "DestinationSiteID": "String Content",
    "PrimeSuiteUserID": 0
  },
  "Credentials": {
    "PrimeSuiteCredential": {
      "PrimeSuiteSiteId": "String Content",
      "PrimeSuiteUserName": "String Content",
      "PrimeSuiteUserPassword": "String Content",
      "PrimeSuiteUserAlias": "String Content"
    },
    "VendorCredential": {
      "VendorLogin": "String Content",
      "VendorPassword": "String Content"
    }
  },
  "MNID": 0,
  "MEDID": 0,
  "PBMPatientInfo": {
    "CopayID": "String Content",
    "CoverageID": "String Content",
    "AlternativeID": "String Content",
    "FormularyID": "String Content",
    "PlanName": "String Content",
    "PayerName": "String Content"
  }
}

Response Format: Xml

Response XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<MedicationTherapeuticAlternativesGetResponse>
  <TherapeuticAlternatives>
    <medid>String Content</medid>
    <Altmedid>String Content</Altmedid>
    <MedDescription>String Content</MedDescription>
    <MedDescription1>String Content</MedDescription1>
    <AlternativeDescription>String Content</AlternativeDescription>
    <PreferenceLevel>String Content</PreferenceLevel>
    <DrugName>String Content</DrugName>
    <Strength>String Content</Strength>
    <StrengthUnits>String Content</StrengthUnits>
    <ProductServiceID>String Content</ProductServiceID>
    <PackageType>String Content</PackageType>
    <GCNSeqNo>String Content</GCNSeqNo>
    <FormularyStatus>String Content</FormularyStatus>
    <FormularyStatusID>String Content</FormularyStatusID>
    <RxRequired>String Content</RxRequired>
    <GorB>String Content</GorB>
    <MNID>String Content</MNID>
    <DoseForm>String Content</DoseForm>
    <DoseFormID>String Content</DoseFormID>
    <DoseQuantityUnit>String Content</DoseQuantityUnit>
    <DefaultPackage>String Content</DefaultPackage>
    <RouteID>String Content</RouteID>
    <Route>String Content</Route>
    <DeaCode>String Content</DeaCode>
    <AlternativeCopay>
      <CoPayID>String Content</CoPayID>
      <medid>String Content</medid>
      <PharmacyType>String Content</PharmacyType>
      <FlatCoPayAmount>String Content</FlatCoPayAmount>
      <PercentCoPayRate>String Content</PercentCoPayRate>
      <FirstCoPayTerm>String Content</FirstCoPayTerm>
      <MinimumCoPay>String Content</MinimumCoPay>
      <MaximumCoPay>String Content</MaximumCoPay>
      <DaysSupplyPerCoPay>String Content</DaysSupplyPerCoPay>
      <CoPayTier>String Content</CoPayTier>
      <MaximumCoPayTier>String Content</MaximumCoPayTier>
      <ProductType>String Content</ProductType>
      <FormularyStatusDesc>String Content</FormularyStatusDesc>
      <ProductServiceID>String Content</ProductServiceID>
      <MedicationDescription>String Content</MedicationDescription>
      <OutOfPocketRangeStart>String Content</OutOfPocketRangeStart>
      <OutOfPocketRangeEnd>String Content</OutOfPocketRangeEnd>
    </AlternativeCopay>
  </TherapeuticAlternatives>
  <Copays>
    <CoPayID>String Content</CoPayID>
    <medid>String Content</medid>
    <PharmacyType>String Content</PharmacyType>
    <FlatCoPayAmount>String Content</FlatCoPayAmount>
    <PercentCoPayRate>String Content</PercentCoPayRate>
    <FirstCoPayTerm>String Content</FirstCoPayTerm>
    <MinimumCoPay>String Content</MinimumCoPay>
    <MaximumCoPay>String Content</MaximumCoPay>
    <DaysSupplyPerCoPay>String Content</DaysSupplyPerCoPay>
    <CoPayTier>String Content</CoPayTier>
    <MaximumCoPayTier>String Content</MaximumCoPayTier>
    <ProductType>String Content</ProductType>
    <FormularyStatusDesc>String Content</FormularyStatusDesc>
    <ProductServiceID>String Content</ProductServiceID>
    <MedicationDescription>String Content</MedicationDescription>
    <OutOfPocketRangeStart>String Content</OutOfPocketRangeStart>
    <OutOfPocketRangeEnd>String Content</OutOfPocketRangeEnd>
  </Copays>
</MedicationTherapeuticAlternativesGetResponse>

Response Format: Json

Response Example (schema):

{
  "TherapeuticAlternatives": [
    {
      "medid": "String Content",
      "Altmedid": "String Content",
      "MedDescription": "String Content",
      "MedDescription1": "String Content",
      "AlternativeDescription": "String Content",
      "PreferenceLevel": "String Content",
      "DrugName": "String Content",
      "Strength": "String Content",
      "StrengthUnits": "String Content",
      "ProductServiceID": "String Content",
      "PackageType": "String Content",
      "GCNSeqNo": "String Content",
      "FormularyStatus": "String Content",
      "FormularyStatusID": "String Content",
      "RxRequired": "String Content",
      "GorB": "String Content",
      "MNID": "String Content",
      "DoseForm": "String Content",
      "DoseFormID": "String Content",
      "DoseQuantityUnit": "String Content",
      "DefaultPackage": "String Content",
      "RouteID": "String Content",
      "Route": "String Content",
      "DeaCode": "String Content",
      "AlternativeCopay": {
        "CoPayID": "String Content",
        "medid": "String Content",
        "PharmacyType": "String Content",
        "FlatCoPayAmount": "String Content",
        "PercentCoPayRate": "String Content",
        "FirstCoPayTerm": "String Content",
        "MinimumCoPay": "String Content",
        "MaximumCoPay": "String Content",
        "DaysSupplyPerCoPay": "String Content",
        "CoPayTier": "String Content",
        "MaximumCoPayTier": "String Content",
        "ProductType": "String Content",
        "FormularyStatusDesc": "String Content",
        "ProductServiceID": "String Content",
        "MedicationDescription": "String Content",
        "OutOfPocketRangeStart": "String Content",
        "OutOfPocketRangeEnd": "String Content"
      }
    }
  ],
  "Copays": [
    {
      "CoPayID": "String Content",
      "medid": "String Content",
      "PharmacyType": "String Content",
      "FlatCoPayAmount": "String Content",
      "PercentCoPayRate": "String Content",
      "FirstCoPayTerm": "String Content",
      "MinimumCoPay": "String Content",
      "MaximumCoPay": "String Content",
      "DaysSupplyPerCoPay": "String Content",
      "CoPayTier": "String Content",
      "MaximumCoPayTier": "String Content",
      "ProductType": "String Content",
      "FormularyStatusDesc": "String Content",
      "ProductServiceID": "String Content",
      "MedicationDescription": "String Content",
      "OutOfPocketRangeStart": "String Content",
      "OutOfPocketRangeEnd": "String Content"
    }
  ]
}