ws Web Service

Click here for a complete list of operations.

GetPatientNotes

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

<?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>
    <GetPatientNotes xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <PatientID>int</PatientID>
      <ModifiedAfter>dateTime</ModifiedAfter>
      <LastPatientNoteID>long</LastPatientNoteID>
    </GetPatientNotes>
  </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>
    <GetPatientNotesResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <GetPatientNotesResult>
        <PatientNotes>
          <PatientNote>
            <PatientNoteID>int</PatientNoteID>
            <PatientID>int</PatientID>
            <AgencyID>int</AgencyID>
            <PayerID>int</PayerID>
            <CreatedBy>string</CreatedBy>
            <NoteDate>string</NoteDate>
            <NoteFrom>string</NoteFrom>
            <NoteReason xsi:nil="true" />
            <NoteType>string</NoteType>
            <FromDate>string</FromDate>
            <ToDate>string</ToDate>
            <StartDate>string</StartDate>
            <ReplacementCaregiver xsi:nil="true" />
            <Note>string</Note>
            <EmergencyOfPriority>string</EmergencyOfPriority>
            <EmailTo>string</EmailTo>
            <Internal>string</Internal>
          </PatientNote>
          <PatientNote>
            <PatientNoteID>int</PatientNoteID>
            <PatientID>int</PatientID>
            <AgencyID>int</AgencyID>
            <PayerID>int</PayerID>
            <CreatedBy>string</CreatedBy>
            <NoteDate>string</NoteDate>
            <NoteFrom>string</NoteFrom>
            <NoteReason xsi:nil="true" />
            <NoteType>string</NoteType>
            <FromDate>string</FromDate>
            <ToDate>string</ToDate>
            <StartDate>string</StartDate>
            <ReplacementCaregiver xsi:nil="true" />
            <Note>string</Note>
            <EmergencyOfPriority>string</EmergencyOfPriority>
            <EmailTo>string</EmailTo>
            <Internal>string</Internal>
          </PatientNote>
        </PatientNotes>
      </GetPatientNotesResult>
    </GetPatientNotesResponse>
  </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>
    <GetPatientNotes xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <PatientID>int</PatientID>
      <ModifiedAfter>dateTime</ModifiedAfter>
      <LastPatientNoteID>long</LastPatientNoteID>
    </GetPatientNotes>
  </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>
    <GetPatientNotesResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <GetPatientNotesResult>
        <PatientNotes>
          <PatientNote>
            <PatientNoteID>int</PatientNoteID>
            <PatientID>int</PatientID>
            <AgencyID>int</AgencyID>
            <PayerID>int</PayerID>
            <CreatedBy>string</CreatedBy>
            <NoteDate>string</NoteDate>
            <NoteFrom>string</NoteFrom>
            <NoteReason xsi:nil="true" />
            <NoteType>string</NoteType>
            <FromDate>string</FromDate>
            <ToDate>string</ToDate>
            <StartDate>string</StartDate>
            <ReplacementCaregiver xsi:nil="true" />
            <Note>string</Note>
            <EmergencyOfPriority>string</EmergencyOfPriority>
            <EmailTo>string</EmailTo>
            <Internal>string</Internal>
          </PatientNote>
          <PatientNote>
            <PatientNoteID>int</PatientNoteID>
            <PatientID>int</PatientID>
            <AgencyID>int</AgencyID>
            <PayerID>int</PayerID>
            <CreatedBy>string</CreatedBy>
            <NoteDate>string</NoteDate>
            <NoteFrom>string</NoteFrom>
            <NoteReason xsi:nil="true" />
            <NoteType>string</NoteType>
            <FromDate>string</FromDate>
            <ToDate>string</ToDate>
            <StartDate>string</StartDate>
            <ReplacementCaregiver xsi:nil="true" />
            <Note>string</Note>
            <EmergencyOfPriority>string</EmergencyOfPriority>
            <EmailTo>string</EmailTo>
            <Internal>string</Internal>
          </PatientNote>
        </PatientNotes>
      </GetPatientNotesResult>
    </GetPatientNotesResponse>
  </soap12:Body>
</soap12:Envelope>