ws Web Service

Click here for a complete list of operations.

CreatePatientAuthorization

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

<?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>
    <CreatePatientAuthorization xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <CreateAuthorizationInfo>
        <PatientID>int</PatientID>
        <ContractID>int</ContractID>
        <DisciplineID>int</DisciplineID>
        <ServiceCodeID>int</ServiceCodeID>
        <AuthorizationNumber>string</AuthorizationNumber>
        <FromDate>dateTime</FromDate>
        <ToDate>dateTime</ToDate>
        <HoursPerAuthPeriod>decimal</HoursPerAuthPeriod>
        <SpecificDateType>boolean</SpecificDateType>
        <WeekDay>boolean</WeekDay>
        <WeekEnd>boolean</WeekEnd>
        <BankedHours>string</BankedHours>
        <IsAdditionalRules>string</IsAdditionalRules>
        <Period>string</Period>
        <MaxHoursPeriod>decimal</MaxHoursPeriod>
        <SatMinutes>decimal</SatMinutes>
        <SunMinutes>decimal</SunMinutes>
        <MonMinutes>decimal</MonMinutes>
        <TueMinutes>decimal</TueMinutes>
        <WedMinutes>decimal</WedMinutes>
        <ThuMinutes>decimal</ThuMinutes>
        <FriMinutes>decimal</FriMinutes>
        <DXCode1>string</DXCode1>
        <DXCode2>string</DXCode2>
        <DXCode3>string</DXCode3>
        <AdditionalRules>
          <AdditionalRule>
            <MaximumVisits>int</MaximumVisits>
            <Period>string</Period>
            <OfXHours>decimal</OfXHours>
          </AdditionalRule>
          <AdditionalRule>
            <MaximumVisits>int</MaximumVisits>
            <Period>string</Period>
            <OfXHours>decimal</OfXHours>
          </AdditionalRule>
        </AdditionalRules>
        <Notes>string</Notes>
        <BillingDiagnosisCodes>
          <BillingDiagnosisCode>
            <DiagnosisCode>string</DiagnosisCode>
            <Description>string</Description>
            <IsPrimary>string</IsPrimary>
          </BillingDiagnosisCode>
          <BillingDiagnosisCode>
            <DiagnosisCode>string</DiagnosisCode>
            <Description>string</Description>
            <IsPrimary>string</IsPrimary>
          </BillingDiagnosisCode>
        </BillingDiagnosisCodes>
        <ProgramCode>string</ProgramCode>
        <BudgetAmount>decimal</BudgetAmount>
        <ProviderNumber>string</ProviderNumber>
      </CreateAuthorizationInfo>
    </CreatePatientAuthorization>
  </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>
    <CreatePatientAuthorizationResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <CreatePatientAuthorizationResult>
        <PatientAuthorization>
          <PatientID>int</PatientID>
          <AuthorizationID>long</AuthorizationID>
        </PatientAuthorization>
      </CreatePatientAuthorizationResult>
    </CreatePatientAuthorizationResponse>
  </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>
    <CreatePatientAuthorization xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <Authentication>
        <AppName>string</AppName>
        <AppSecret>string</AppSecret>
        <AppKey>string</AppKey>
      </Authentication>
      <CreateAuthorizationInfo>
        <PatientID>int</PatientID>
        <ContractID>int</ContractID>
        <DisciplineID>int</DisciplineID>
        <ServiceCodeID>int</ServiceCodeID>
        <AuthorizationNumber>string</AuthorizationNumber>
        <FromDate>dateTime</FromDate>
        <ToDate>dateTime</ToDate>
        <HoursPerAuthPeriod>decimal</HoursPerAuthPeriod>
        <SpecificDateType>boolean</SpecificDateType>
        <WeekDay>boolean</WeekDay>
        <WeekEnd>boolean</WeekEnd>
        <BankedHours>string</BankedHours>
        <IsAdditionalRules>string</IsAdditionalRules>
        <Period>string</Period>
        <MaxHoursPeriod>decimal</MaxHoursPeriod>
        <SatMinutes>decimal</SatMinutes>
        <SunMinutes>decimal</SunMinutes>
        <MonMinutes>decimal</MonMinutes>
        <TueMinutes>decimal</TueMinutes>
        <WedMinutes>decimal</WedMinutes>
        <ThuMinutes>decimal</ThuMinutes>
        <FriMinutes>decimal</FriMinutes>
        <DXCode1>string</DXCode1>
        <DXCode2>string</DXCode2>
        <DXCode3>string</DXCode3>
        <AdditionalRules>
          <AdditionalRule>
            <MaximumVisits>int</MaximumVisits>
            <Period>string</Period>
            <OfXHours>decimal</OfXHours>
          </AdditionalRule>
          <AdditionalRule>
            <MaximumVisits>int</MaximumVisits>
            <Period>string</Period>
            <OfXHours>decimal</OfXHours>
          </AdditionalRule>
        </AdditionalRules>
        <Notes>string</Notes>
        <BillingDiagnosisCodes>
          <BillingDiagnosisCode>
            <DiagnosisCode>string</DiagnosisCode>
            <Description>string</Description>
            <IsPrimary>string</IsPrimary>
          </BillingDiagnosisCode>
          <BillingDiagnosisCode>
            <DiagnosisCode>string</DiagnosisCode>
            <Description>string</Description>
            <IsPrimary>string</IsPrimary>
          </BillingDiagnosisCode>
        </BillingDiagnosisCodes>
        <ProgramCode>string</ProgramCode>
        <BudgetAmount>decimal</BudgetAmount>
        <ProviderNumber>string</ProviderNumber>
      </CreateAuthorizationInfo>
    </CreatePatientAuthorization>
  </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>
    <CreatePatientAuthorizationResponse xmlns="https://www.hhaexchange.com/apis/hhaws.integration">
      <CreatePatientAuthorizationResult>
        <PatientAuthorization>
          <PatientID>int</PatientID>
          <AuthorizationID>long</AuthorizationID>
        </PatientAuthorization>
      </CreatePatientAuthorizationResult>
    </CreatePatientAuthorizationResponse>
  </soap12:Body>
</soap12:Envelope>