ws Web Service

Click here for a complete list of operations.

GetVisitInfoV2

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /Integration/ENT/V1.8/ws.asmx HTTP/1.1
Host: implementation.hhaexchange.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://www.hhaexchange.com/apis/hhaws.integration/GetVisitInfoV2"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetVisitInfoV2 xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <VisitInfo>
        <ID>int</ID>
      </VisitInfo>
    </GetVisitInfoV2>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetVisitInfoV2Response xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <GetVisitInfoV2Result>
        <VisitInfo>
          <ID>int</ID>
          <VisitDate>string</VisitDate>
          <Patient>
            <ID>int</ID>
            <AdmissionNumber>string</AdmissionNumber>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
          </Patient>
          <Caregiver>
            <ID>int</ID>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <CaregiverCode>string</CaregiverCode>
            <TimeAndAttendancePIN>string</TimeAndAttendancePIN>
            <PayCode xsi:nil="true" />
            <DateofBirth>string</DateofBirth>
          </Caregiver>
          <ScheduleStartTime>string</ScheduleStartTime>
          <ScheduleEndTime>string</ScheduleEndTime>
          <VisitStartTime>string</VisitStartTime>
          <VisitEndTime>string</VisitEndTime>
          <EVVStartTime>string</EVVStartTime>
          <EVVEndTime>string</EVVEndTime>
          <IsMissedVisit>string</IsMissedVisit>
          <TTOT>
            <Hours>int</Hours>
            <Minutes>int</Minutes>
          </TTOT>
          <Verification>
            <VerifiedBy>string</VerifiedBy>
            <Notes>string</Notes>
            <VerifiedDate>dateTime</VerifiedDate>
            <VerifiedTime>string</VerifiedTime>
            <SupervisorName>string</SupervisorName>
          </Verification>
          <Timesheet>
            <Required>string</Required>
            <Approved>string</Approved>
          </Timesheet>
          <Payroll>
            <PayrollType>string</PayrollType>
            <PayCode>string</PayCode>
            <ServiceHours>string</ServiceHours>
            <TT-OTHours>string</TT-OTHours>
            <PayUnits>string</PayUnits>
            <PayRate>string</PayRate>
          </Payroll>
          <PrebillingProblems>
            <PrebillingProblemInfo xsi:nil="true" />
            <PrebillingProblemInfo xsi:nil="true" />
          </PrebillingProblems>
          <TasksPerformed>
            <Task xsi:nil="true" />
            <Task xsi:nil="true" />
          </TasksPerformed>
          <VisitType>string</VisitType>
          <ScheduleDuration>
            <ScheduleDurationHours>int</ScheduleDurationHours>
            <ScheduleDurationMinutes>int</ScheduleDurationMinutes>
          </ScheduleDuration>
          <ClockInEvvType>string</ClockInEvvType>
          <ClockOutEvvType>string</ClockOutEvvType>
          <VisitAggregationStatus>
            <Status>string</Status>
            <StatusDate>dateTime</StatusDate>
          </VisitAggregationStatus>
          <BilledAmount>string</BilledAmount>
          <BudgetNumber>int</BudgetNumber>
          <ActualHours>string</ActualHours>
          <ActualHoursRounded>string</ActualHoursRounded>
          <PayHours>string</PayHours>
          <PayHoursUnrounded>string</PayHoursUnrounded>
          <AdjustedHours>string</AdjustedHours>
          <TimeZone>string</TimeZone>
          <SplitVisitID>long</SplitVisitID>
          <OriginalVisitID>long</OriginalVisitID>
          <SuggestedStartTime>string</SuggestedStartTime>
          <SuggestedEndTime>string</SuggestedEndTime>
          <IsScheduleTemporary>string</IsScheduleTemporary>
          <IsCaregiverTemporary>string</IsCaregiverTemporary>
        </VisitInfo>
      </GetVisitInfoV2Result>
    </GetVisitInfoV2Response>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /Integration/ENT/V1.8/ws.asmx HTTP/1.1
Host: implementation.hhaexchange.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetVisitInfoV2 xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <VisitInfo>
        <ID>int</ID>
      </VisitInfo>
    </GetVisitInfoV2>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetVisitInfoV2Response xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <GetVisitInfoV2Result>
        <VisitInfo>
          <ID>int</ID>
          <VisitDate>string</VisitDate>
          <Patient>
            <ID>int</ID>
            <AdmissionNumber>string</AdmissionNumber>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
          </Patient>
          <Caregiver>
            <ID>int</ID>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <CaregiverCode>string</CaregiverCode>
            <TimeAndAttendancePIN>string</TimeAndAttendancePIN>
            <PayCode xsi:nil="true" />
            <DateofBirth>string</DateofBirth>
          </Caregiver>
          <ScheduleStartTime>string</ScheduleStartTime>
          <ScheduleEndTime>string</ScheduleEndTime>
          <VisitStartTime>string</VisitStartTime>
          <VisitEndTime>string</VisitEndTime>
          <EVVStartTime>string</EVVStartTime>
          <EVVEndTime>string</EVVEndTime>
          <IsMissedVisit>string</IsMissedVisit>
          <TTOT>
            <Hours>int</Hours>
            <Minutes>int</Minutes>
          </TTOT>
          <Verification>
            <VerifiedBy>string</VerifiedBy>
            <Notes>string</Notes>
            <VerifiedDate>dateTime</VerifiedDate>
            <VerifiedTime>string</VerifiedTime>
            <SupervisorName>string</SupervisorName>
          </Verification>
          <Timesheet>
            <Required>string</Required>
            <Approved>string</Approved>
          </Timesheet>
          <Payroll>
            <PayrollType>string</PayrollType>
            <PayCode>string</PayCode>
            <ServiceHours>string</ServiceHours>
            <TT-OTHours>string</TT-OTHours>
            <PayUnits>string</PayUnits>
            <PayRate>string</PayRate>
          </Payroll>
          <PrebillingProblems>
            <PrebillingProblemInfo xsi:nil="true" />
            <PrebillingProblemInfo xsi:nil="true" />
          </PrebillingProblems>
          <TasksPerformed>
            <Task xsi:nil="true" />
            <Task xsi:nil="true" />
          </TasksPerformed>
          <VisitType>string</VisitType>
          <ScheduleDuration>
            <ScheduleDurationHours>int</ScheduleDurationHours>
            <ScheduleDurationMinutes>int</ScheduleDurationMinutes>
          </ScheduleDuration>
          <ClockInEvvType>string</ClockInEvvType>
          <ClockOutEvvType>string</ClockOutEvvType>
          <VisitAggregationStatus>
            <Status>string</Status>
            <StatusDate>dateTime</StatusDate>
          </VisitAggregationStatus>
          <BilledAmount>string</BilledAmount>
          <BudgetNumber>int</BudgetNumber>
          <ActualHours>string</ActualHours>
          <ActualHoursRounded>string</ActualHoursRounded>
          <PayHours>string</PayHours>
          <PayHoursUnrounded>string</PayHoursUnrounded>
          <AdjustedHours>string</AdjustedHours>
          <TimeZone>string</TimeZone>
          <SplitVisitID>long</SplitVisitID>
          <OriginalVisitID>long</OriginalVisitID>
          <SuggestedStartTime>string</SuggestedStartTime>
          <SuggestedEndTime>string</SuggestedEndTime>
          <IsScheduleTemporary>string</IsScheduleTemporary>
          <IsCaregiverTemporary>string</IsCaregiverTemporary>
        </VisitInfo>
      </GetVisitInfoV2Result>
    </GetVisitInfoV2Response>
  </soap12:Body>
</soap12:Envelope>