ws

Click here for a complete list of operations.

CreateCaregiverNote

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

<?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>
    <CreateCaregiverNote xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <CaregiverNoteInfo>
        <CaregiverID>int</CaregiverID>
        <SubjectID>int</SubjectID>
        <Note>string</Note>
        <PatientID>int</PatientID>
        <PayerPatientNote>string</PayerPatientNote>
        <ReasonID>int</ReasonID>
        <SendNotifications>
          <MobileAppOrSMS>string</MobileAppOrSMS>
          <Email>string</Email>
          <VoiceMessage>string</VoiceMessage>
        </SendNotifications>
      </CaregiverNoteInfo>
    </CreateCaregiverNote>
  </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>
    <CreateCaregiverNoteResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <CreateCaregiverNoteResult>
        <CaregiverNoteInfo>
          <CaregiverID>int</CaregiverID>
          <NoteID>long</NoteID>
        </CaregiverNoteInfo>
      </CreateCaregiverNoteResult>
    </CreateCaregiverNoteResponse>
  </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>
    <CreateCaregiverNote xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <CaregiverNoteInfo>
        <CaregiverID>int</CaregiverID>
        <SubjectID>int</SubjectID>
        <Note>string</Note>
        <PatientID>int</PatientID>
        <PayerPatientNote>string</PayerPatientNote>
        <ReasonID>int</ReasonID>
        <SendNotifications>
          <MobileAppOrSMS>string</MobileAppOrSMS>
          <Email>string</Email>
          <VoiceMessage>string</VoiceMessage>
        </SendNotifications>
      </CaregiverNoteInfo>
    </CreateCaregiverNote>
  </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>
    <CreateCaregiverNoteResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <CreateCaregiverNoteResult>
        <CaregiverNoteInfo>
          <CaregiverID>int</CaregiverID>
          <NoteID>long</NoteID>
        </CaregiverNoteInfo>
      </CreateCaregiverNoteResult>
    </CreateCaregiverNoteResponse>
  </soap12:Body>
</soap12:Envelope>