IPrimeSuiteAPI REST API Documentation


PatientInsuranceGet


Method: POST

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

Request Format: Xml or Json

Request XML Example (schema): 

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

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"?>
<InsuranceGetResponse>
  <Insurance>
    <InsCoveragePatID>0</InsCoveragePatID>
    <InsCoverageID>0</InsCoverageID>
    <Priority>0</Priority>
    <SubOrder>0</SubOrder>
    <PolicyGroupNumber>String Content</PolicyGroupNumber>
    <PolicyNumber>String Content</PolicyNumber>
    <StartDate>String Content</StartDate>
    <EndDate>String Content</EndDate>
    <Active>0</Active>
    <PreCertNumber>String Content</PreCertNumber>
    <PreCertStartDate>String Content</PreCertStartDate>
    <PreCertEndDate>String Content</PreCertEndDate>
    <NumberOfVisitsRemaining>String Content</NumberOfVisitsRemaining>
    <InsurancePlan>
      <PlanID>String Content</PlanID>
      <InsuranceID>String Content</InsuranceID>
      <InsuranceName>String Content</InsuranceName>
      <PlanName>String Content</PlanName>
      <InsDocVisitCoPay>0</InsDocVisitCoPay>
      <EffectiveFrom>String Content</EffectiveFrom>
      <EffectiveTo>String Content</EffectiveTo>
      <EligibilityStatus>String Content</EligibilityStatus>
      <CompanyName>String Content</CompanyName>
      <PlanNumber>String Content</PlanNumber>
      <Address>
        <AddressID>0</AddressID>
        <Country>0</Country>
        <CountryName></CountryName>
        <AddressLine1>String Content</AddressLine1>
        <AddressLine2>String Content</AddressLine2>
        <City>String Content</City>
        <PostalCode>String Content</PostalCode>
        <State>0</State>
        <StateString></StateString>
        <County>String Content</County>
        <FaxNumber>String Content</FaxNumber>
        <PhoneNumber1>String Content</PhoneNumber1>
        <PhoneNumber2>String Content</PhoneNumber2>
      </Address>
    </InsurancePlan>
    <PolicyHolder>
      <PersonID>String Content</PersonID>
      <FullName>String Content</FullName>
      <Relation>String Content</Relation>
    </PolicyHolder>
  </Insurance>
</InsuranceGetResponse>

Response Format: Json

Response Example (schema):

{
  "Insurance": [
    {
      "InsCoveragePatID": 0,
      "InsCoverageID": 0,
      "Priority": 0,
      "SubOrder": 0,
      "PolicyGroupNumber": "String Content",
      "PolicyNumber": "String Content",
      "StartDate": "String Content",
      "EndDate": "String Content",
      "Active": 0,
      "PreCertNumber": "String Content",
      "PreCertStartDate": "String Content",
      "PreCertEndDate": "String Content",
      "NumberOfVisitsRemaining": "String Content",
      "InsurancePlan": {
        "PlanID": "String Content",
        "InsuranceID": "String Content",
        "InsuranceName": "String Content",
        "PlanName": "String Content",
        "InsDocVisitCoPay": 0.0,
        "EffectiveFrom": "String Content",
        "EffectiveTo": "String Content",
        "EligibilityStatus": "String Content",
        "CompanyName": "String Content",
        "PlanNumber": "String Content",
        "Address": {
          "AddressID": 0,
          "Country": 0,
          "CountryName": "",
          "AddressLine1": "String Content",
          "AddressLine2": "String Content",
          "City": "String Content",
          "PostalCode": "String Content",
          "State": 0,
          "StateString": "",
          "County": "String Content",
          "FaxNumber": "String Content",
          "PhoneNumber1": "String Content",
          "PhoneNumber2": "String Content"
        }
      },
      "PolicyHolder": {
        "PersonID": "String Content",
        "FullName": "String Content",
        "Relation": "String Content"
      }
    }
  ]
}