IPrimeSuiteAPI REST API Documentation


PatientListFilterListGet


Method: POST

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

Request Format: Xml or Json

Request XML Example (schema):

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

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"
    }
  }
}

Response Format: Xml

Response XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<FilterListGetResponse>
  <Filters>
    <FilterID>0</FilterID>
    <Decription>String Content</Decription>
    <FieldSelected>
      <AppointmentDate>false</AppointmentDate>
      <AppointmentTime>false</AppointmentTime>
      <PatientName>false</PatientName>
      <Picture>false</Picture>
      <PatientID>false</PatientID>
      <AppointmentType>false</AppointmentType>
      <Resource>false</Resource>
      <CareProvider>false</CareProvider>
      <VisitID>false</VisitID>
      <VisitType>false</VisitType>
      <TimeIn>false</TimeIn>
      <TimeOut>false</TimeOut>
      <ChiefComplaint>false</ChiefComplaint>
      <Comments>false</Comments>
      <OtherID>false</OtherID>
      <ptArea>false</ptArea>
      <ptStatus>false</ptStatus>
      <ptResponsible>false</ptResponsible>
      <StartTime>false</StartTime>
      <VisitDate>false</VisitDate>
      <UserName>false</UserName>
      <ChargesEntered>false</ChargesEntered>
      <SuperBillStatus>false</SuperBillStatus>
      <CopayPosted>false</CopayPosted>
      <AppointmentLocationName>false</AppointmentLocationName>
      <RTC>false</RTC>
      <EligibilityStatus>false</EligibilityStatus>
      <AppointmentDateOrder>0</AppointmentDateOrder>
      <AppointmentTimeOrder>0</AppointmentTimeOrder>
      <PatientNameOrder>0</PatientNameOrder>
      <PictureOrder>0</PictureOrder>
      <PatientIDOrder>0</PatientIDOrder>
      <AppointmentTypeOrder>0</AppointmentTypeOrder>
      <ResourceOrder>0</ResourceOrder>
      <CareProviderOrder>0</CareProviderOrder>
      <VisitIDOrder>0</VisitIDOrder>
      <VisitTypeOrder>0</VisitTypeOrder>
      <TimeInOrder>0</TimeInOrder>
      <TimeOutOrder>0</TimeOutOrder>
      <ChiefComplaintOrder>0</ChiefComplaintOrder>
      <CommentsOrder>0</CommentsOrder>
      <OtherIDOrder>0</OtherIDOrder>
      <ptAreaOrder>0</ptAreaOrder>
      <ptStatusOrder>0</ptStatusOrder>
      <ptResponsibleOrder>0</ptResponsibleOrder>
      <StartTimeOrder>0</StartTimeOrder>
      <VisitDateOrder>0</VisitDateOrder>
      <UserNameOrder>0</UserNameOrder>
      <ChargesEnteredOrder>0</ChargesEnteredOrder>
      <SuperBillStatusOrder>0</SuperBillStatusOrder>
      <CopayPostedOrder>0</CopayPostedOrder>
      <AppointmentLocationNameOrder>0</AppointmentLocationNameOrder>
      <RTCOrder>0</RTCOrder>
      <EligibilityStatusOrder>0</EligibilityStatusOrder>
      <DateOFBirth>false</DateOFBirth>
      <DateOFBirthOrder>0</DateOFBirthOrder>
      <AppointmentEndTime>false</AppointmentEndTime>
      <AppointmentEndTimeOrder>0</AppointmentEndTimeOrder>
    </FieldSelected>
  </Filters>
</FilterListGetResponse>

Response Format: Json

Response Example (schema):

{
  "Filters": [
    {
      "FilterID": 0,
      "Decription": "String Content",
      "FieldSelected": {
        "AppointmentDate": false,
        "AppointmentTime": false,
        "PatientName": false,
        "Picture": false,
        "PatientID": false,
        "AppointmentType": false,
        "Resource": false,
        "CareProvider": false,
        "VisitID": false,
        "VisitType": false,
        "TimeIn": false,
        "TimeOut": false,
        "ChiefComplaint": false,
        "Comments": false,
        "OtherID": false,
        "ptArea": false,
        "ptStatus": false,
        "ptResponsible": false,
        "StartTime": false,
        "VisitDate": false,
        "UserName": false,
        "ChargesEntered": false,
        "SuperBillStatus": false,
        "CopayPosted": false,
        "AppointmentLocationName": false,
        "RTC": false,
        "EligibilityStatus": false,
        "AppointmentDateOrder": 0,
        "AppointmentTimeOrder": 0,
        "PatientNameOrder": 0,
        "PictureOrder": 0,
        "PatientIDOrder": 0,
        "AppointmentTypeOrder": 0,
        "ResourceOrder": 0,
        "CareProviderOrder": 0,
        "VisitIDOrder": 0,
        "VisitTypeOrder": 0,
        "TimeInOrder": 0,
        "TimeOutOrder": 0,
        "ChiefComplaintOrder": 0,
        "CommentsOrder": 0,
        "OtherIDOrder": 0,
        "ptAreaOrder": 0,
        "ptStatusOrder": 0,
        "ptResponsibleOrder": 0,
        "StartTimeOrder": 0,
        "VisitDateOrder": 0,
        "UserNameOrder": 0,
        "ChargesEnteredOrder": 0,
        "SuperBillStatusOrder": 0,
        "CopayPostedOrder": 0,
        "AppointmentLocationNameOrder": 0,
        "RTCOrder": 0,
        "EligibilityStatusOrder": 0,
        "DateOFBirth": false,
        "DateOFBirthOrder": 0,
        "AppointmentEndTime": false,
        "AppointmentEndTimeOrder": 0
      }
    }
  ]
}