ws Web Service

Click here for a complete list of operations.

CreatePatient

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

<?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>
    <CreatePatient xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <PatientInfo>
        <OfficeID>int</OfficeID>
        <FirstName>string</FirstName>
        <MiddleName>string</MiddleName>
        <LastName>string</LastName>
        <BirthDate>dateTime</BirthDate>
        <Gender>string</Gender>
        <CoordinatorID1>int</CoordinatorID1>
        <CoordinatorID2>int</CoordinatorID2>
        <CoordinatorID3>int</CoordinatorID3>
        <PriorityCode>int</PriorityCode>
        <ServiceRequestStartDate>dateTime</ServiceRequestStartDate>
        <NurseID>int</NurseID>
        <AdmissionID>string</AdmissionID>
        <MRNumber>int</MRNumber>
        <MedicaidNumber>string</MedicaidNumber>
        <MedicareNumber>string</MedicareNumber>
        <AcceptedServices>
          <Discipline>string</Discipline>
          <Discipline>string</Discipline>
        </AcceptedServices>
        <ExpandedTimeForAutoVerification>string</ExpandedTimeForAutoVerification>
        <AutomaticDownwardAdjustment>string</AutomaticDownwardAdjustment>
        <SSN>string</SSN>
        <AllowDuplicate>int</AllowDuplicate>
        <Alerts>string</Alerts>
        <SourceOfAdmission>int</SourceOfAdmission>
        <TeamID>int</TeamID>
        <BranchID>int</BranchID>
        <LocationID>int</LocationID>
        <EligibilityDetail>
          <MedicaidStartDate>dateTime</MedicaidStartDate>
          <MedicaidEndDate>dateTime</MedicaidEndDate>
          <ManagedCareStartDate>dateTime</ManagedCareStartDate>
          <ManagedCareEndDate>dateTime</ManagedCareEndDate>
        </EligibilityDetail>
        <Addresses>
          <Address>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <CrossStreet>string</CrossStreet>
            <City>string</City>
            <Zip5>int</Zip5>
            <Zip4>int</Zip4>
            <Notes>string</Notes>
            <State>string</State>
            <County>string</County>
            <PhoneLocation>string</PhoneLocation>
            <BeaconLocation>string</BeaconLocation>
            <FOBLocation>string</FOBLocation>
            <IsPrimaryAddress>string</IsPrimaryAddress>
            <AddressTypes>string</AddressTypes>
          </Address>
          <Address>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <CrossStreet>string</CrossStreet>
            <City>string</City>
            <Zip5>int</Zip5>
            <Zip4>int</Zip4>
            <Notes>string</Notes>
            <State>string</State>
            <County>string</County>
            <PhoneLocation>string</PhoneLocation>
            <BeaconLocation>string</BeaconLocation>
            <FOBLocation>string</FOBLocation>
            <IsPrimaryAddress>string</IsPrimaryAddress>
            <AddressTypes>string</AddressTypes>
          </Address>
        </Addresses>
        <AlternateBilling>
          <FirstName>string</FirstName>
          <MiddleName>string</MiddleName>
          <LastName>string</LastName>
          <Street>string</Street>
          <City>string</City>
          <State>string</State>
          <Zip5>int</Zip5>
        </AlternateBilling>
        <EmergencyContacts>
          <EmergencyContact>
            <Name>string</Name>
            <RelationshipID>int</RelationshipID>
            <LivesWithPatient>string</LivesWithPatient>
            <HaveKeys>string</HaveKeys>
            <Phone1>string</Phone1>
            <Phone2>string</Phone2>
            <Address>string</Address>
          </EmergencyContact>
          <EmergencyContact>
            <Name>string</Name>
            <RelationshipID>int</RelationshipID>
            <LivesWithPatient>string</LivesWithPatient>
            <HaveKeys>string</HaveKeys>
            <Phone1>string</Phone1>
            <Phone2>string</Phone2>
            <Address>string</Address>
          </EmergencyContact>
        </EmergencyContacts>
        <EmergencyPreparedness>
          <EvacuationZoneID>int</EvacuationZoneID>
          <EvacuationLocationID>int</EvacuationLocationID>
          <MobilityStatusID>int</MobilityStatusID>
          <ElectricEquipmentDependency>
            <ElectricEquipmentID>int</ElectricEquipmentID>
            <ElectricEquipmentID>int</ElectricEquipmentID>
          </ElectricEquipmentDependency>
        </EmergencyPreparedness>
        <EVVRequired>string</EVVRequired>
        <FOBRequired>string</FOBRequired>
        <FOBDeviceID>string</FOBDeviceID>
        <BeaconRequired>string</BeaconRequired>
        <BeaconDeviceID>string</BeaconDeviceID>
        <FobSealId>string</FobSealId>
        <WageParity>string</WageParity>
        <WageParityFromDate1>dateTime</WageParityFromDate1>
        <WageParityToDate1>dateTime</WageParityToDate1>
        <WageParityFromDate2>dateTime</WageParityFromDate2>
        <WageParityToDate2>dateTime</WageParityToDate2>
        <HomePhone>string</HomePhone>
        <Phone2>string</Phone2>
        <Phone2Description>string</Phone2Description>
        <Phone3>string</Phone3>
        <Phone3Description>string</Phone3Description>
        <Direction>string</Direction>
      </PatientInfo>
    </CreatePatient>
  </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>
    <CreatePatientResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <CreatePatientResult>
        <PatientID>int</PatientID>
      </CreatePatientResult>
    </CreatePatientResponse>
  </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>
    <CreatePatient xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <PatientInfo>
        <OfficeID>int</OfficeID>
        <FirstName>string</FirstName>
        <MiddleName>string</MiddleName>
        <LastName>string</LastName>
        <BirthDate>dateTime</BirthDate>
        <Gender>string</Gender>
        <CoordinatorID1>int</CoordinatorID1>
        <CoordinatorID2>int</CoordinatorID2>
        <CoordinatorID3>int</CoordinatorID3>
        <PriorityCode>int</PriorityCode>
        <ServiceRequestStartDate>dateTime</ServiceRequestStartDate>
        <NurseID>int</NurseID>
        <AdmissionID>string</AdmissionID>
        <MRNumber>int</MRNumber>
        <MedicaidNumber>string</MedicaidNumber>
        <MedicareNumber>string</MedicareNumber>
        <AcceptedServices>
          <Discipline>string</Discipline>
          <Discipline>string</Discipline>
        </AcceptedServices>
        <ExpandedTimeForAutoVerification>string</ExpandedTimeForAutoVerification>
        <AutomaticDownwardAdjustment>string</AutomaticDownwardAdjustment>
        <SSN>string</SSN>
        <AllowDuplicate>int</AllowDuplicate>
        <Alerts>string</Alerts>
        <SourceOfAdmission>int</SourceOfAdmission>
        <TeamID>int</TeamID>
        <BranchID>int</BranchID>
        <LocationID>int</LocationID>
        <EligibilityDetail>
          <MedicaidStartDate>dateTime</MedicaidStartDate>
          <MedicaidEndDate>dateTime</MedicaidEndDate>
          <ManagedCareStartDate>dateTime</ManagedCareStartDate>
          <ManagedCareEndDate>dateTime</ManagedCareEndDate>
        </EligibilityDetail>
        <Addresses>
          <Address>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <CrossStreet>string</CrossStreet>
            <City>string</City>
            <Zip5>int</Zip5>
            <Zip4>int</Zip4>
            <Notes>string</Notes>
            <State>string</State>
            <County>string</County>
            <PhoneLocation>string</PhoneLocation>
            <BeaconLocation>string</BeaconLocation>
            <FOBLocation>string</FOBLocation>
            <IsPrimaryAddress>string</IsPrimaryAddress>
            <AddressTypes>string</AddressTypes>
          </Address>
          <Address>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <CrossStreet>string</CrossStreet>
            <City>string</City>
            <Zip5>int</Zip5>
            <Zip4>int</Zip4>
            <Notes>string</Notes>
            <State>string</State>
            <County>string</County>
            <PhoneLocation>string</PhoneLocation>
            <BeaconLocation>string</BeaconLocation>
            <FOBLocation>string</FOBLocation>
            <IsPrimaryAddress>string</IsPrimaryAddress>
            <AddressTypes>string</AddressTypes>
          </Address>
        </Addresses>
        <AlternateBilling>
          <FirstName>string</FirstName>
          <MiddleName>string</MiddleName>
          <LastName>string</LastName>
          <Street>string</Street>
          <City>string</City>
          <State>string</State>
          <Zip5>int</Zip5>
        </AlternateBilling>
        <EmergencyContacts>
          <EmergencyContact>
            <Name>string</Name>
            <RelationshipID>int</RelationshipID>
            <LivesWithPatient>string</LivesWithPatient>
            <HaveKeys>string</HaveKeys>
            <Phone1>string</Phone1>
            <Phone2>string</Phone2>
            <Address>string</Address>
          </EmergencyContact>
          <EmergencyContact>
            <Name>string</Name>
            <RelationshipID>int</RelationshipID>
            <LivesWithPatient>string</LivesWithPatient>
            <HaveKeys>string</HaveKeys>
            <Phone1>string</Phone1>
            <Phone2>string</Phone2>
            <Address>string</Address>
          </EmergencyContact>
        </EmergencyContacts>
        <EmergencyPreparedness>
          <EvacuationZoneID>int</EvacuationZoneID>
          <EvacuationLocationID>int</EvacuationLocationID>
          <MobilityStatusID>int</MobilityStatusID>
          <ElectricEquipmentDependency>
            <ElectricEquipmentID>int</ElectricEquipmentID>
            <ElectricEquipmentID>int</ElectricEquipmentID>
          </ElectricEquipmentDependency>
        </EmergencyPreparedness>
        <EVVRequired>string</EVVRequired>
        <FOBRequired>string</FOBRequired>
        <FOBDeviceID>string</FOBDeviceID>
        <BeaconRequired>string</BeaconRequired>
        <BeaconDeviceID>string</BeaconDeviceID>
        <FobSealId>string</FobSealId>
        <WageParity>string</WageParity>
        <WageParityFromDate1>dateTime</WageParityFromDate1>
        <WageParityToDate1>dateTime</WageParityToDate1>
        <WageParityFromDate2>dateTime</WageParityFromDate2>
        <WageParityToDate2>dateTime</WageParityToDate2>
        <HomePhone>string</HomePhone>
        <Phone2>string</Phone2>
        <Phone2Description>string</Phone2Description>
        <Phone3>string</Phone3>
        <Phone3Description>string</Phone3Description>
        <Direction>string</Direction>
      </PatientInfo>
    </CreatePatient>
  </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>
    <CreatePatientResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <CreatePatientResult>
        <PatientID>int</PatientID>
      </CreatePatientResult>
    </CreatePatientResponse>
  </soap12:Body>
</soap12:Envelope>