ws Web Service

Click here for a complete list of operations.

GetVisitInfo

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/GetVisitInfo"

<?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>
    <GetVisitInfo xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <VisitInfo>
        <ID>int</ID>
      </VisitInfo>
    </GetVisitInfo>
  </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>
    <GetVisitInfoResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <GetVisitInfoResult>
        <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>int</TimeAndAttendancePIN>
            <PayCode xsi:nil="true" />
            <DateofBirth>dateTime</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>
          <TasksPerformed>
            <Task xsi:nil="true" />
            <Task xsi:nil="true" />
          </TasksPerformed>
        </VisitInfo>
      </GetVisitInfoResult>
    </GetVisitInfoResponse>
  </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>
    <GetVisitInfo xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <VisitInfo>
        <ID>int</ID>
      </VisitInfo>
    </GetVisitInfo>
  </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>
    <GetVisitInfoResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <GetVisitInfoResult>
        <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>int</TimeAndAttendancePIN>
            <PayCode xsi:nil="true" />
            <DateofBirth>dateTime</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>
          <TasksPerformed>
            <Task xsi:nil="true" />
            <Task xsi:nil="true" />
          </TasksPerformed>
        </VisitInfo>
      </GetVisitInfoResult>
    </GetVisitInfoResponse>
  </soap12:Body>
</soap12:Envelope>