IPrimeSuiteAPI REST API Documentation


ReferralListGet


Method: POST

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

Request Format: Xml or Json

Request XML Example (schema): 

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

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

Response Format: Xml

Response XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<ReferralGetListResponse>
  <ReferralList>
    <ReferralID>String Content</ReferralID>
    <ReferredDate>String Content</ReferredDate>
    <ReferredFrom>String Content</ReferredFrom>
    <VisitDate>String Content</VisitDate>
    <VisitID>String Content</VisitID>
    <ReferredTo>String Content</ReferredTo>
    <AuthorizationType>String Content</AuthorizationType>
    <AuthorizationStatus>String Content</AuthorizationStatus>
  </ReferralList>
  <TotalRows>0</TotalRows>
</ReferralGetListResponse>

Response Format: Json

Response Example (schema):

{
  "ReferralList": [
    {
      "ReferralID": "String Content",
      "ReferredDate": "String Content",
      "ReferredFrom": "String Content",
      "VisitDate": "String Content",
      "VisitID": "String Content",
      "ReferredTo": "String Content",
      "AuthorizationType": "String Content",
      "AuthorizationStatus": "String Content"
    }
  ],
  "TotalRows": 0
}