IPrimeSuiteAPI REST API Documentation


PatientERXEligibilityGet


Method: POST

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

Request Format: Xml or Json

Request XML Example (schema): 

<?xml version="1.0" encoding="utf-16"?>
<PatientERXEligibilityGetRequest>
  <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>
  <PatientID>0</PatientID>
</PatientERXEligibilityGetRequest>

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"
    }
  },
  "PatientID": 0
}

Response Format: Xml

Response XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<PatientERXEligibilityGetResponse>
  <InsuranceInformationList>
    <MailOrderOutOfPocket>String Content</MailOrderOutOfPocket>
    <LTC>String Content</LTC>
    <SpecialityPharmacy>String Content</SpecialityPharmacy>
    <RetailOutOfPocket>String Content</RetailOutOfPocket>
    <PlanID>String Content</PlanID>
    <PlanName>String Content</PlanName>
    <InsuredName>String Content</InsuredName>
    <PolicyGroupNumber>String Content</PolicyGroupNumber>
    <CoverageStatus>String Content</CoverageStatus>
    <RetailPharmacyBenefits>String Content</RetailPharmacyBenefits>
    <MailOrderBenefits>String Content</MailOrderBenefits>
    <PCN>String Content</PCN>
    <PolicyHolder>String Content</PolicyHolder>
    <BenefitSourceName>String Content</BenefitSourceName>
    <RelationshipToInsured>String Content</RelationshipToInsured>
    <CopayID>String Content</CopayID>
    <CoverageID>String Content</CoverageID>
    <AlternativeID>String Content</AlternativeID>
    <FormularyID>String Content</FormularyID>
    <LastRetrievedDate>String Content</LastRetrievedDate>
    <PatientInformationChange>String Content</PatientInformationChange>
    <InsuredFirstName>String Content</InsuredFirstName>
    <InsuredLastName>String Content</InsuredLastName>
    <InsuredMiddleName>String Content</InsuredMiddleName>
    <InsuredSuffix>String Content</InsuredSuffix>
    <InsuredAddressLine1>String Content</InsuredAddressLine1>
    <InsuredAddressLine2>String Content</InsuredAddressLine2>
    <InsuredCity>String Content</InsuredCity>
    <InsuredState>String Content</InsuredState>
    <InsuredZip>String Content</InsuredZip>
    <InsuredDOB>String Content</InsuredDOB>
    <InsuredGender>String Content</InsuredGender>
    <ErrorDescription>String Content</ErrorDescription>
    <ReasonCode>String Content</ReasonCode>
    <ResponseActionCode>String Content</ResponseActionCode>
    <PayerName>String Content</PayerName>
  </InsuranceInformationList>
</PatientERXEligibilityGetResponse>

Response Format: Json

Response Example (schema):

{
  "InsuranceInformationList": [
    {
      "MailOrderOutOfPocket": "String Content",
      "LTC": "String Content",
      "SpecialityPharmacy": "String Content",
      "RetailOutOfPocket": "String Content",
      "PlanID": "String Content",
      "PlanName": "String Content",
      "InsuredName": "String Content",
      "PolicyGroupNumber": "String Content",
      "CoverageStatus": "String Content",
      "RetailPharmacyBenefits": "String Content",
      "MailOrderBenefits": "String Content",
      "PCN": "String Content",
      "PolicyHolder": "String Content",
      "BenefitSourceName": "String Content",
      "RelationshipToInsured": "String Content",
      "CopayID": "String Content",
      "CoverageID": "String Content",
      "AlternativeID": "String Content",
      "FormularyID": "String Content",
      "LastRetrievedDate": "String Content",
      "PatientInformationChange": "String Content",
      "InsuredFirstName": "String Content",
      "InsuredLastName": "String Content",
      "InsuredMiddleName": "String Content",
      "InsuredSuffix": "String Content",
      "InsuredAddressLine1": "String Content",
      "InsuredAddressLine2": "String Content",
      "InsuredCity": "String Content",
      "InsuredState": "String Content",
      "InsuredZip": "String Content",
      "InsuredDOB": "String Content",
      "InsuredGender": "String Content",
      "ErrorDescription": "String Content",
      "ReasonCode": "String Content",
      "ResponseActionCode": "String Content",
      "PayerName": "String Content"
    }
  ]
}