IPrimeSuiteAPI REST API Documentation


ReferralGet


Method: POST

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

Request Format: Xml or Json

Request XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<ReferralGetRequest>
  <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>
  <referralID>String Content</referralID>
</ReferralGetRequest>

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"
    }
  },
  "referralID": "String Content"
}

Response Format: Xml

Response XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<ReferralGetResponse>
  <Referral>
    <ReferralID>0</ReferralID>
    <InsID>0</InsID>
    <PreCertNumber>String Content</PreCertNumber>
    <CreateDate>String Content</CreateDate>
    <PreCertStartDate>String Content</PreCertStartDate>
    <PreCertEndDate>String Content</PreCertEndDate>
    <ProcedureMasterID>0</ProcedureMasterID>
    <Active>false</Active>
    <CategoryID>0</CategoryID>
    <Category>String Content</Category>
    <ReferralType>
      <ReferralTypeID>String Content</ReferralTypeID>
      <Description>String Content</Description>
      <Active>String Content</Active>
      <InUse>String Content</InUse>
    </ReferralType>
    <SubType>
      <SubTypeID>String Content</SubTypeID>
      <Description>String Content</Description>
      <Active>String Content</Active>
      <InUse>String Content</InUse>
    </SubType>
    <StatusID>0</StatusID>
    <Status>String Content</Status>
    <OutOFNetworkReasonID>0</OutOFNetworkReasonID>
    <OutOFNetworkReason>String Content</OutOFNetworkReason>
    <Description>String Content</Description>
    <Contact>String Content</Contact>
    <Email>String Content</Email>
    <URL>String Content</URL>
    <BillingPhone>String Content</BillingPhone>
    <EligibilityPhone>String Content</EligibilityPhone>
    <Fax>String Content</Fax>
    <PreCertPhone>String Content</PreCertPhone>
    <CoPayAmount>0</CoPayAmount>
    <DeductAmount>0</DeductAmount>
    <DeductMet>0</DeductMet>
    <OutOfPocketAmount>0</OutOfPocketAmount>
    <OutOfPocketMet>0</OutOfPocketMet>
    <FollowUpDays>0</FollowUpDays>
    <InsurancePercent>0</InsurancePercent>
    <CareProviderID>0</CareProviderID>
    <CareProvider>String Content</CareProvider>
    <ReferringProviderID>0</ReferringProviderID>
    <ReferringProvider>String Content</ReferringProvider>
    <PrimaryProviderID>0</PrimaryProviderID>
    <PrimaryProvider>String Content</PrimaryProvider>
    <SpecialtyID>String Content</SpecialtyID>
    <Specialty>String Content</Specialty>
    <DateReceived>String Content</DateReceived>
    <NumberOfVisits>0</NumberOfVisits>
    <NumberOfVisitsRemaining>0</NumberOfVisitsRemaining>
    <NumberOfVisitsUsed>0</NumberOfVisitsUsed>
    <MaxBenAmount>0</MaxBenAmount>
    <Other>String Content</Other>
    <CPTCode>String Content</CPTCode>
    <CPTDataType>0</CPTDataType>
    <CPTRangeStart>String Content</CPTRangeStart>
    <CPTRangeEnd>String Content</CPTRangeEnd>
    <ICD9Code>String Content</ICD9Code>
    <ICD9DataType>0</ICD9DataType>
    <ICD9RangeStart>String Content</ICD9RangeStart>
    <ICD9RangeEnd>String Content</ICD9RangeEnd>
    <Comments>String Content</Comments>
    <InpatOutpat>0</InpatOutpat>
    <FacilityID>0</FacilityID>
    <Facility>String Content</Facility>
    <FacilityTypeID>0</FacilityTypeID>
    <FacilityType>String Content</FacilityType>
    <DiagnosisDate>String Content</DiagnosisDate>
    <ProposedSurgeryDate>String Content</ProposedSurgeryDate>
    <ProposedAdmissionDate>String Content</ProposedAdmissionDate>
    <ProposedDischargeDate>String Content</ProposedDischargeDate>
    <PatientID>0</PatientID>
    <ReferredDate>String Content</ReferredDate>
    <ReferralReason>String Content</ReferralReason>
    <NetworkStatus>false</NetworkStatus>
    <ApptDate>String Content</ApptDate>
    <ApptTime>String Content</ApptTime>
    <VisitID>0</VisitID>
    <VisitDate>String Content</VisitDate>
    <BookedBy>0</BookedBy>
    <BookedByName>String Content</BookedByName>
    <OrderDate>String Content</OrderDate>
    <LastModUserID>0</LastModUserID>
    <LastModUserName>String Content</LastModUserName>
    <CreateUser>0</CreateUser>
    <CreateUserName>String Content</CreateUserName>
    <Diagnoses>
      <DxCode>String Content</DxCode>
      <DxDetails>String Content</DxDetails>
      <DxCodeICD10>String Content</DxCodeICD10>
      <LexicalID>0</LexicalID>
    </Diagnoses>
    <Documents>
      <DocID>0</DocID>
      <DocumentName>String Content</DocumentName>
      <AttachedDate>String Content</AttachedDate>
      <AttachedByUserName>String Content</AttachedByUserName>
      <AttachedByUserID>0</AttachedByUserID>
      <Comment>String Content</Comment>
    </Documents>
    <Notes>
      <NoteID>0</NoteID>
      <NoteDate>String Content</NoteDate>
      <UserID>0</UserID>
      <UserName>String Content</UserName>
      <Comment>String Content</Comment>
    </Notes>
    <Procedures>
      <CPTCode>String Content</CPTCode>
      <ProcedureDetails>String Content</ProcedureDetails>
    </Procedures>
    <PrelimDxCode>String Content</PrelimDxCode>
    <PlanBillingPhoneNumber>String Content</PlanBillingPhoneNumber>
    <InsuranceDeductible>String Content</InsuranceDeductible>
    <InsurancePlanPercent>0</InsurancePlanPercent>
    <PlanContact>String Content</PlanContact>
  </Referral>
</ReferralGetResponse>

Response Format: Json

Response Example (schema):

{
  "Referral": {
    "ReferralID": 0,
    "InsID": 0,
    "PreCertNumber": "String Content",
    "CreateDate": "String Content",
    "PreCertStartDate": "String Content",
    "PreCertEndDate": "String Content",
    "ProcedureMasterID": 0,
    "Active": false,
    "CategoryID": 0,
    "Category": "String Content",
    "ReferralType": {
      "ReferralTypeID": "String Content",
      "Description": "String Content",
      "Active": "String Content",
      "InUse": "String Content"
    },
    "SubType": {
      "SubTypeID": "String Content",
      "Description": "String Content",
      "Active": "String Content",
      "InUse": "String Content"
    },
    "StatusID": 0,
    "Status": "String Content",
    "OutOFNetworkReasonID": 0,
    "OutOFNetworkReason": "String Content",
    "Description": "String Content",
    "Contact": "String Content",
    "Email": "String Content",
    "URL": "String Content",
    "BillingPhone": "String Content",
    "EligibilityPhone": "String Content",
    "Fax": "String Content",
    "PreCertPhone": "String Content",
    "CoPayAmount": 0.0,
    "DeductAmount": 0.0,
    "DeductMet": 0.0,
    "OutOfPocketAmount": 0.0,
    "OutOfPocketMet": 0.0,
    "FollowUpDays": 0,
    "InsurancePercent": 0,
    "CareProviderID": 0,
    "CareProvider": "String Content",
    "ReferringProviderID": 0,
    "ReferringProvider": "String Content",
    "PrimaryProviderID": 0,
    "PrimaryProvider": "String Content",
    "SpecialtyID": "String Content",
    "Specialty": "String Content",
    "DateReceived": "String Content",
    "NumberOfVisits": 0,
    "NumberOfVisitsRemaining": 0,
    "NumberOfVisitsUsed": 0,
    "MaxBenAmount": 0.0,
    "Other": "String Content",
    "CPTCode": "String Content",
    "CPTDataType": 0,
    "CPTRangeStart": "String Content",
    "CPTRangeEnd": "String Content",
    "ICD9Code": "String Content",
    "ICD9DataType": 0,
    "ICD9RangeStart": "String Content",
    "ICD9RangeEnd": "String Content",
    "Comments": "String Content",
    "InpatOutpat": 0,
    "FacilityID": 0,
    "Facility": "String Content",
    "FacilityTypeID": 0,
    "FacilityType": "String Content",
    "DiagnosisDate": "String Content",
    "ProposedSurgeryDate": "String Content",
    "ProposedAdmissionDate": "String Content",
    "ProposedDischargeDate": "String Content",
    "PatientID": 0,
    "ReferredDate": "String Content",
    "ReferralReason": "String Content",
    "NetworkStatus": false,
    "ApptDate": "String Content",
    "ApptTime": "String Content",
    "VisitID": 0,
    "VisitDate": "String Content",
    "BookedBy": 0,
    "BookedByName": "String Content",
    "OrderDate": "String Content",
    "LastModUserID": 0,
    "LastModUserName": "String Content",
    "CreateUser": 0,
    "CreateUserName": "String Content",
    "Diagnoses": [
      {
        "DxCode": "String Content",
        "DxDetails": "String Content",
        "DxCodeICD10": "String Content",
        "LexicalID": 0
      }
    ],
    "Documents": [
      {
        "DocID": 0,
        "DocumentName": "String Content",
        "AttachedDate": "String Content",
        "AttachedByUserName": "String Content",
        "AttachedByUserID": 0,
        "Comment": "String Content"
      }
    ],
    "Notes": [
      {
        "NoteID": 0,
        "NoteDate": "String Content",
        "UserID": 0,
        "UserName": "String Content",
        "Comment": "String Content"
      }
    ],
    "Procedures": [
      {
        "CPTCode": "String Content",
        "ProcedureDetails": "String Content"
      }
    ],
    "PrelimDxCode": "String Content",
    "PlanBillingPhoneNumber": "String Content",
    "InsuranceDeductible": "String Content",
    "InsurancePlanPercent": 0,
    "PlanContact": "String Content"
  }
}