ws Web Service

Click here for a complete list of operations.

GetPatientDemographics

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

<?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>
    <GetPatientDemographics xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <PatientInfo>
        <ID>string</ID>
      </PatientInfo>
    </GetPatientDemographics>
  </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>
    <GetPatientDemographicsResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <GetPatientDemographicsResult>
        <PatientInfo>
          <AgencyID>int</AgencyID>
          <OfficeID>int</OfficeID>
          <PatientID>int</PatientID>
          <FirstName>string</FirstName>
          <MiddleName>string</MiddleName>
          <LastName>string</LastName>
          <BirthDate>string</BirthDate>
          <Gender>string</Gender>
          <Coordinators>
            <Coordinator xsi:nil="true" />
            <Coordinator xsi:nil="true" />
          </Coordinators>
          <PriorityCode>int</PriorityCode>
          <ServiceRequestStartDate>string</ServiceRequestStartDate>
          <Nurse>
            <ID>int</ID>
            <Name>string</Name>
          </Nurse>
          <AdmissionID>string</AdmissionID>
          <MedicaidNumber>string</MedicaidNumber>
          <MedicareNumber>string</MedicareNumber>
          <AcceptedServices>
            <Discipline>string</Discipline>
            <Discipline>string</Discipline>
          </AcceptedServices>
          <SSN>string</SSN>
          <Alerts>string</Alerts>
          <SourceOfAdmission>
            <ID>int</ID>
            <Name>string</Name>
          </SourceOfAdmission>
          <Team>
            <ID>int</ID>
            <Name>string</Name>
          </Team>
          <Location>
            <ID>int</ID>
            <Name>string</Name>
          </Location>
          <Branch>
            <ID>int</ID>
            <Name>string</Name>
          </Branch>
          <Addresses>
            <Address xsi:nil="true" />
            <Address xsi:nil="true" />
          </Addresses>
          <HomePhone>string</HomePhone>
          <Phone2>string</Phone2>
          <Phone2Description>string</Phone2Description>
          <Phone3>string</Phone3>
          <Phone3Description>string</Phone3Description>
          <HomePhoneLocationAddressID>string</HomePhoneLocationAddressID>
          <HomePhoneLocationAddress>string</HomePhoneLocationAddress>
          <HomePhone2LocationAddressID>string</HomePhone2LocationAddressID>
          <HomePhone2LocationAddress>string</HomePhone2LocationAddress>
          <HomePhone3LocationAddressID>string</HomePhone3LocationAddressID>
          <HomePhone3LocationAddress>string</HomePhone3LocationAddress>
          <Direction>string</Direction>
          <AlternateBilling>
            <FirstName>string</FirstName>
            <MiddleName>string</MiddleName>
            <LastName>string</LastName>
            <Street>string</Street>
            <City>string</City>
            <State>string</State>
            <Zip5>string</Zip5>
          </AlternateBilling>
          <EmergencyContacts>
            <EmergencyContact xsi:nil="true" />
            <EmergencyContact xsi:nil="true" />
          </EmergencyContacts>
          <EmergencyPreparedness>
            <EvacuationZone xsi:nil="true" />
            <EvacuationLocation xsi:nil="true" />
            <MobilityStatus xsi:nil="true" />
            <ElectricEquipmentDependency xsi:nil="true" />
          </EmergencyPreparedness>
          <PayerID>int</PayerID>
          <PayerName>string</PayerName>
          <PayerCoordinatorID>int</PayerCoordinatorID>
          <PayerCoordinatorName>string</PayerCoordinatorName>
          <PatientStatusID>int</PatientStatusID>
          <PatientStatusName>string</PatientStatusName>
          <WageParity>string</WageParity>
          <WageParityFromDate1>string</WageParityFromDate1>
          <WageParityToDate1>string</WageParityToDate1>
          <WageParityFromDate2>string</WageParityFromDate2>
          <WageParityToDate2>string</WageParityToDate2>
          <PrimaryLanguageID>int</PrimaryLanguageID>
          <PrimaryLanguage>string</PrimaryLanguage>
          <SecondaryLanguageID>int</SecondaryLanguageID>
          <SecondaryLanguage>string</SecondaryLanguage>
          <AllowedCaregiverAccessPatientInfoToMobileApp>
            <Caregiver xsi:nil="true" />
            <Caregiver xsi:nil="true" />
          </AllowedCaregiverAccessPatientInfoToMobileApp>
          <LastModifiedDate>string</LastModifiedDate>
          <MedicaidStartDate>string</MedicaidStartDate>
          <MedicaidEndDate>string</MedicaidEndDate>
          <ManagedCareStartDate>string</ManagedCareStartDate>
          <ManagedCareEndDate>string</ManagedCareEndDate>
          <DischargeDate>string</DischargeDate>
        </PatientInfo>
      </GetPatientDemographicsResult>
    </GetPatientDemographicsResponse>
  </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>
    <GetPatientDemographics xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <PatientInfo>
        <ID>string</ID>
      </PatientInfo>
    </GetPatientDemographics>
  </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>
    <GetPatientDemographicsResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <GetPatientDemographicsResult>
        <PatientInfo>
          <AgencyID>int</AgencyID>
          <OfficeID>int</OfficeID>
          <PatientID>int</PatientID>
          <FirstName>string</FirstName>
          <MiddleName>string</MiddleName>
          <LastName>string</LastName>
          <BirthDate>string</BirthDate>
          <Gender>string</Gender>
          <Coordinators>
            <Coordinator xsi:nil="true" />
            <Coordinator xsi:nil="true" />
          </Coordinators>
          <PriorityCode>int</PriorityCode>
          <ServiceRequestStartDate>string</ServiceRequestStartDate>
          <Nurse>
            <ID>int</ID>
            <Name>string</Name>
          </Nurse>
          <AdmissionID>string</AdmissionID>
          <MedicaidNumber>string</MedicaidNumber>
          <MedicareNumber>string</MedicareNumber>
          <AcceptedServices>
            <Discipline>string</Discipline>
            <Discipline>string</Discipline>
          </AcceptedServices>
          <SSN>string</SSN>
          <Alerts>string</Alerts>
          <SourceOfAdmission>
            <ID>int</ID>
            <Name>string</Name>
          </SourceOfAdmission>
          <Team>
            <ID>int</ID>
            <Name>string</Name>
          </Team>
          <Location>
            <ID>int</ID>
            <Name>string</Name>
          </Location>
          <Branch>
            <ID>int</ID>
            <Name>string</Name>
          </Branch>
          <Addresses>
            <Address xsi:nil="true" />
            <Address xsi:nil="true" />
          </Addresses>
          <HomePhone>string</HomePhone>
          <Phone2>string</Phone2>
          <Phone2Description>string</Phone2Description>
          <Phone3>string</Phone3>
          <Phone3Description>string</Phone3Description>
          <HomePhoneLocationAddressID>string</HomePhoneLocationAddressID>
          <HomePhoneLocationAddress>string</HomePhoneLocationAddress>
          <HomePhone2LocationAddressID>string</HomePhone2LocationAddressID>
          <HomePhone2LocationAddress>string</HomePhone2LocationAddress>
          <HomePhone3LocationAddressID>string</HomePhone3LocationAddressID>
          <HomePhone3LocationAddress>string</HomePhone3LocationAddress>
          <Direction>string</Direction>
          <AlternateBilling>
            <FirstName>string</FirstName>
            <MiddleName>string</MiddleName>
            <LastName>string</LastName>
            <Street>string</Street>
            <City>string</City>
            <State>string</State>
            <Zip5>string</Zip5>
          </AlternateBilling>
          <EmergencyContacts>
            <EmergencyContact xsi:nil="true" />
            <EmergencyContact xsi:nil="true" />
          </EmergencyContacts>
          <EmergencyPreparedness>
            <EvacuationZone xsi:nil="true" />
            <EvacuationLocation xsi:nil="true" />
            <MobilityStatus xsi:nil="true" />
            <ElectricEquipmentDependency xsi:nil="true" />
          </EmergencyPreparedness>
          <PayerID>int</PayerID>
          <PayerName>string</PayerName>
          <PayerCoordinatorID>int</PayerCoordinatorID>
          <PayerCoordinatorName>string</PayerCoordinatorName>
          <PatientStatusID>int</PatientStatusID>
          <PatientStatusName>string</PatientStatusName>
          <WageParity>string</WageParity>
          <WageParityFromDate1>string</WageParityFromDate1>
          <WageParityToDate1>string</WageParityToDate1>
          <WageParityFromDate2>string</WageParityFromDate2>
          <WageParityToDate2>string</WageParityToDate2>
          <PrimaryLanguageID>int</PrimaryLanguageID>
          <PrimaryLanguage>string</PrimaryLanguage>
          <SecondaryLanguageID>int</SecondaryLanguageID>
          <SecondaryLanguage>string</SecondaryLanguage>
          <AllowedCaregiverAccessPatientInfoToMobileApp>
            <Caregiver xsi:nil="true" />
            <Caregiver xsi:nil="true" />
          </AllowedCaregiverAccessPatientInfoToMobileApp>
          <LastModifiedDate>string</LastModifiedDate>
          <MedicaidStartDate>string</MedicaidStartDate>
          <MedicaidEndDate>string</MedicaidEndDate>
          <ManagedCareStartDate>string</ManagedCareStartDate>
          <ManagedCareEndDate>string</ManagedCareEndDate>
          <DischargeDate>string</DischargeDate>
        </PatientInfo>
      </GetPatientDemographicsResult>
    </GetPatientDemographicsResponse>
  </soap12:Body>
</soap12:Envelope>