Illinois and Michigan Authorization Web Service
HHAeXchange offers numerous web service interfaces allowing third-party software systems to exchange data electronically. This document provides guidance in understanding the various interfaces and how to access them. This information applies to Illinois and Michigan users.
If additional assistance is needed, submit a ticket to Provider API Integrations. Cases are escalated to the Enterprise Integration Service Desk (EISD) Production Support queue. An available Support Team Members will contact you directly to assist.
For optimal system performance, HHAeXchange processes data in real time. The expectation is that data is sent by the provider or EVV vendor to HHAeXchange as it is added, changed, and/or deleted in the third-party system. HHAeXchange provides transaction statuses on a separate API call that is initiated by the third-party EVV system. HHAeXchange allows maximum 200 calls per method, per provider in a single minute.
The web service APIs are exposed as a Simple Object Access Protocol (SOAP) secure Hypertext Transfer Protocol (HTTPS) web service for third-party software systems.
Every web service method at HHAeXchange expects users to provide the following values for authentication and authorization. The following three parameters/values required for every method call.
| Value | Description |
|---|---|
| App Key | The App Key is used to create a user context to access the actual data. If the application attempts to access the data of more than one Agency (at HHAeXchange), then an App Key is required for each Agency. Contact the Agency to obtain their App Key and in turn, the Agency contacts HHAeXchange to obtain an App Key for the requestor. |
| App Name | This unique name identifies the User’s application (App). Contact the HHAeXchange Technical Team to register the App name. If the App name is not registered with HHAeXchange then the method call will fail. |
| App Secret | This secret value is only known by the App. Obtain this value from the HHAeXchange Technical Team. If the App Secret value is not provided or is incorrect, then the method call fails. |
If the web service call is not successful, an error object is returned with an Error ID; explained briefly in the table below and described later in this document.
| Error ID | Error Message | Description – Indicates that the… |
|---|---|---|
| -1 | User account is locked. | App Key value is not valid |
| -2 | User account is inactive. | App Key value is not valid |
| -5 | Invalid application key '[VALUE]' | App Key value is not valid |
| -6 | Invalid application secret key '[VALUE]' | App Secret value is not valid |
| -7 | Invalid application name '[VALUE]' | App Name value is not valid |
| -8 | Invalid application name/secret key | App Name/Secret pair is not correct |
| -11 | Internal server error | Unknown error |
These are the general error codes. Each method may add additional error numbers to help users determine the exact error. The additional error numbers (if any) are covered along with the documentation of the applicable web methods.
The following methods allow users to read Patient Information from HHAeXchange.
| Method | Description |
|---|---|
| SearchPatients |
Allows users to search for a list of patients matching a selected search criterion. The results return a list of PatientIDs (which is a unique identifier of each Patient record). The ID returned by this method can be submitted to GetPatientDemographics method to retrieve the demographic information of the given Patient. |
| GetPatientDemographics |
This method allows users to retrieve Patient demographic information. The results return the information of one Patient at a time. When calling this method, the Patient ID must be submitted to access the specific Patient. Use the SearchPatients method to retrieve the IDs of the Patients based on a search criterion. |
| SearchPatientAuthorizations |
Returns a list of authorizations associated with a given Patient (Identified by Patient ID). The ID returned by this method can be passed to GetPatientAuthorizationInfo method to retrieve the authorization details. |
| GetPatientAuthorizationInfo | Returns details of an authorization identified by the given Authorization ID. |
The following methods can be used to perform various data modification operations related to Patient records.
| Method | Description |
|---|---|
| CreatePatientAuthorization | Allows users to create a new authorization for a Patient. |
| UpdatePatientAuthorization | Allows users to update an existing authorization for a Patient. |
Allows users to search for Patients matching a given search criteria.
The following is the request format. You can also click here to view the SOAP request and response.
| Field | Description | Type | Data Type |
|---|---|---|---|
| FirstName | Patient’s First Name. Can searh for partial names (using ‘starts-with’ algorithm). | Optional | Text |
| LastName | Patient’s Last Name. Can searh for partial names (using ‘starts-with’ algorithm). | Optional | Text |
| Status |
Patient Status Filter. Possible values:
Active is assumed if a filter is not specified. |
Optional | Text |
| PhoneNumber | Searches for Patients matching a given phone number in patient Home Phone, Phone2 and Phone3 fields. The number should have 10 digits and no special characters are allowed. | Optional | Number |
| AdmissionID | Searches for a Patient by Admission ID. An exact match algorithm is used (partial search is not supported). | Optional | Text |
| MRNumber | Searches for a Patient by Medical Record (MR) Number (Displays as Patient ID in the application). An exact match algorithm is used (partial search is not supported). | Optional | Text |
| SSN | Patient SSN Number | Optional | Text |
If the method call is successful, the Status element of the Result node is set to Success. If the request fails, an error number is returned in the ErrorID element.
The number returned in the PatientID element is the Primary key of the patient record. This can be submitted to the GetPatientDemographics method to retrieve patient demographic information.
Retrieves Patient demographic information for a given record.
The following is the request format. You can also click here to view the SOAP request and response.
| Field | Description | Type | Data Type |
|---|---|---|---|
| ID | Primary Key of the Patient to be retrieved. This call is usually followed by a call to SearchPatients method which retrieves the IDs of the desired Patients based on search filters. | Required | Number |
If the method call is successful, the Status element of the Result node is set to Success. If the request fails, an error number is returned in the ErrorID element.
Returns Patient Contracts for given Patient from HHAeXchange.
The following is the request format. You can also click here to view the SOAP request and response.
| Field | Description | Type | Data Type |
|---|---|---|---|
| PatientID | Unique ID of the Patient in HHAeXchange. | Required | Number |
| VisitDate | Format: YYYY-MM-DD | Optional | Date |
| Field | Description | Data Type |
|---|---|---|
| PlacementID | Unique ID of the Placement in HHAeXchange. | Number |
| Contract ID | A list of Contracts can be retrieved by calling the method GetContracts documented in the Reference Tables section. | Number |
| Contract Name | Name of the Contract | String |
| IsPrimaryContract | Possible Values: Y (Yes) or N (No) | String |
| AltPatientID | Alternate Patient Number | String |
| ServiceStartDate | Format: YYYY-MM-DD | Date |
| SourceOfAdmission ID | Retrieve a list of Source of Admissions by calling the method GetSourceOfAdmissions documented in the Reference Tables section. | Number |
| SourceOfAdmission Name | Name of the Source of Admission | String |
| ServiceCode ID | Retrieve a list of Service Codes by calling the method GetBillingServiceCodes documented in the Reference Tables section. | String |
| ServiceCode Name | Name of the Service Code | String |
| DischargeDate | Format: YYYY-MM-DD | Date |
| DischargeTo ID | Patient Discharge to ID. Retrieve a list of Patient Discharge To by calling the method GetPatientDischargeTo documented in the Reference Tables section. | Number |
| DischargeTo Name | Name of the Discharge to Reason | String |
Allows users to search for Authorization entries associated with a given Patient ID.
The following is the request format. You can also click here to view the SOAP request and response.
| Field | Description | Type | Data Type |
|---|---|---|---|
| PatientID | Patient ID to retrieve authorization information. | Required | Number |
If the method call is successful, the Status element of the Result node is set to Success. If the request fails, an error number is returned in the ErrorID element.
The number returned in the ID element is the Primary Key of the authorization record. This can be submitted to the GetPatientAuthorizationInfo method to retrieve additional details of each Authorization record.
Returns details of an authorization record identified by a given Authorization ID.
The following is the request format. You can also click here to view the SOAP request and response.
| Field | Description | Required | Data Type |
|---|---|---|---|
| PatientID | ID of the Patient record to be queried | Required | Number |
| AuthorizationID | Unique ID of the authorization record returned. This can be obtained by making a call to SearchPatientAuthorizations method described earlier. | Required | Number |
If the method call is successful, the Status element of the Result node is set to Success. If the request fails, an error number is returned in the ErrorID element.
A client application can call this method to create an authorization for Patient.
The following is the request format. You can also click here to view the SOAP request and response.
| Field | Description | Type | Data Type |
|---|---|---|---|
| PatientID | Unique ID of the Patient in HHAeXchange | Required | Number |
| ContractID | Retrieve a list of Patient Contracts by calling the method GetPatientContracts documented in the Patient Information section. | Required | Number |
| DisciplineID | Retrieve a list of Disciplines by calling the method GetPatientDisciplines documented in the Reference Tables section. | Required | String |
| ServiceCodeID | Retrieve a list of Service Codes by calling the method GetContractServiceCode documented in the Reference Tables section. | Required | Number |
| AuthorizationNumber | The authorization number for this authorization. | Required | String |
| FromDate | Authorization Start Date. Format: YYYY-MM-DD | Required | String |
| ToDate | Authorization End Date. Format: YYYY-MM-DD | Required | String |
| HoursPerAuthPeriod | Decimal values of .25 | .50 | .75 are allowed. Decimal values must be two digits if used. Example: 10.50 Only applies to Period = Daily, Weekly or Monthly | Optional | Decimal |
| SpecificDateType | Possible Values: True or False If Period = Daily or Weekly | Optional | Boolean |
| WeekDay | Weekday possible values: True or False Required if Specific Date Type = True. | Situational | Boolean |
| WeekEnd | Weekend/Holiday possible values: True or False Required if Specific Date Type = True. | Situational | Boolean |
| BankedHours | Possible values: Y or N | Optional | String |
| IsAdditionalRules | Possible Values: True or False If True this authorization can be restricted further through 3 additional fields Maximum Visits, Period and Of X Hours | Required | String |
| Period | Possible Values: Daily, Weekly, Monthly or Entire Period | Required | String |
| MaxHoursPeriod | Decimal values of .25 | .50 | .75 are allowed. Decimal values must be two digits if used. Example: 10.50. | Optional | Decimal |
| SatMinutes | Decimal values of .25 | .50 | .75 are allowed. Decimal values must be two digits if used. Example: 10.50 | Optional | Decimal |
| SunMinutes | Decimal values of .25 | .50 | .75 are allowed. Decimal values must be two digits if used. Example: 10.50 | Optional | Decimal |
| MonMinutes | Decimal values of .25 | .50 | .75 are allowed. Decimal values must be two digits if used. Example: 10.50 | Optional | Decimal |
| TueMinutes | Decimal values of .25 | .50 | .75 are allowed. Decimal values must be two digits if used. Example: 10.50 | Optional | Decimal |
| WedMinutes | Decimal values of .25 | .50 | .75 are allowed. Decimal values must be two digits if used. Example: 10.50 | Optional | Decimal |
| ThuMinutes | Decimal values of .25 | .50 | .75 are allowed. Decimal values must be two digits if used. Example: 10.50 | Optional | Decimal |
| FriMinutes | Decimal values of .25 | .50 | .75 are allowed. Decimal values must be two digits if used. Example: 10.50 | Optional | Decimal |
| MaximumVisits | Whole number between 1 and 999 Required if Additional Rules = True. | Situational | Number |
| Period | Possible values: Week, Month or Entire Period Required if Additional Rules = True. | Situational | String |
| OfXHours | Number of hours which can be scheduled for visits under this additional rule. Format: 99.99 Required if Additional Rules = True. | Situational | Decimal |
| Note | Note | Optional | String |
| DiagnosisCode | Billing Diagnosis ICD-10 Code | Optional | String |
| Description | Description of ICD-10 Code | Optional | String |
| IsPrimary | Possible values: Yes or No | Optional | String |
| Program Code | Program Code | Optional | String |
| BudgetAmount | Budget Amount | Optional | Decimal |
If the method call is successful, the Status element of the Result node is set to Success and Authorization ID of the specified Patient is returned. If the request fails, an error number is returned in the ErrorID element.
A client application can call this method to update authorization for Patient.
The following is the request format. You can also click here to view the SOAP request and response.
| Field | Description | Type | Data Type |
|---|---|---|---|
| AuthorizationID | Unique ID of the authorization record. This can be obtained by calling the method SearchPatientAuthorizations | Required | Number |
| ContractID | Retrieve a list of Patient Contracts by calling the method GetPatientContracts documented in the Patient Information section. | Required | Number |
| DisciplineID | Retrieve a list of Disciplines by calling the method GetPatientDisciplines documented in the Reference Tables section | Required | String |
| ServiceCodeID | Retrieve a list of Service Codes by calling the method GetContractServiceCode documented in the Reference Tables section. | Required | Number |
| AuthorizationNumber | The authorization number for this authorization. | Required | String |
| FromDate | Authorization Start Date. Format: YYYY-MM-DD | Required | DateTime |
| ToDate | Authorization End Date. Format: YYYY-MM-DD | Required | DateTime |
| HoursPerAuthPeriod | Decimal values of .25 | .50 | .75 are allowed. Decimal values must be two digits if used. Example: 10.50. Only applies to Period = Daily, Weekly or Monthly | Optional | Decimal |
| BankedHours | Possible values: Y or N | Optional | String |
| IsAdditionalRules |
Possible Values: True or False If True, this authorization can be restricted further through 3 additional fields Maximum Visits, Period, and Of X Hours. |
Required | String |
| Period | Possible Values: Daily, Weekly, Monthly or Entire Period | Required | String |
| SpecificDateType | Possible Values: True or False If Period = Daily or Weekly | Optional | Boolean |
| WeekDay | Weekday possible values: True or False Required if Specific Date Type = True. | Situational | Boolean |
| WeekEnd | Weekend/Holiday possible values: True or False Required if Specific Date Type = True. | Situational | Boolean |
| MaxHoursPeriod | Decimal values of .25 | .50 | .75 are allowed. Decimal values must be two digits if used. Example: 10.50 | Optional | Decimal |
| SatMinutes | Decimal values of .25 | .50 | .75 are allowed. Decimal values must be two digits if used. Example: 10.50 | Optional | Decimal |
| SunMinutes | Decimal values of .25 | .50 | .75 are allowed. Decimal values must be two digits if used. Example: 10.50 | Optional | Decimal |
| MonMinutes | Decimal values of .25 | .50 | .75 are allowed. Decimal values must be two digits if used. Example: 10.50 | Optional | Decimal |
| TueMinutes | Decimal values of .25 | .50 | .75 are allowed. Decimal values must be two digits if used. Example: 10.50 | Optional | Decimal |
| WedMinutes | Decimal values of .25 | .50 | .75 are allowed. Decimal values must be two digits if used. Example: 10.50 | Optional | Decimal |
| ThuMinutes | Decimal values of .25 | .50 | .75 are allowed. Decimal values must be two digits if used. Example: 10.50 | Optional | Decimal |
| FriMinutes | Decimal values of .25 | .50 | .75 are allowed. Decimal values must be two digits if used. Example: 10.50 | Optional | Decimal |
| AuthorizationAdditionalRuleID | Unique Rule ID of the authorization record. This can be obtained by calling the method GetPatientAuthorizationInfo | Situational | Number |
| MaximumVisits | Whole number between 1 and 999 Required if Additional Rules = True. | Situational | Number |
| Period | Possible values: Week, Month or Entire Period Required if Additional Rules = True. | Situational | String |
| OfXHours | Number of hours which can be scheduled for visits under this additional rule. Format: 99.99 Required if Additional Rules = True. | Situational | Decimal |
| Note | Note | Optional | String |
| DiagnosisCode | Billing Diagnosis ICD-10 Code | Optional | String |
| Description | Description of ICD-10 Code | Optional | String |
| IsPrimary | Possible values: Yes or No | Optional | String |
| From Date | Blackout Start Date. Format: YYYY-MM-DD | Optional | DateTime |
| To Date | Blackout End Date. Format: YYYY-MM-DD | Optional | DateTime |
| Notes | Blackout Notes | Optional | String |
| Program Code | Program Code | Optional | String |
| BudgetAmount | Budget Amount | Optional | Decimal |
If the method call is successful, the Status element of the Result node is set to Success. If the request fails, an error number is returned in the ErrorID element.
This section provides an overview of the various web methods available to retrieve changes incrementally from HHAeXchange. This method allows users to retrieve changes occurring to various entities after the last successful synchronization attempt.
Changes are tracked using a key field in our change tracking system. Every time a record changes, a new row is generated in the change tracking system. The key field is Modified Date – Indicates the time when the record was modified. This is an EST date/time format with precision up to milliseconds.
Every row returned by each of the Incremental Fetch Method contains a value indicating the time when the change occurred. This value can be submitted to the subsequent requests to indicate the last change the user received; in turn, the web service sends the user the next group of changes which occurred after the specified time/sequence.
The incremental fetch method sends out data in batches of 100 records at a time. When calling this method, the web method sends out the oldest records first. Therefore, if more than 100 records were modified since the specified date/time values, the oldest 100 records are returned. When the results are processed, the user can verify that 100 are received. Users need to repeatedly call this web method until all the records are received.
In an ideal scenario, the calling application maintains/stores the ModifiedDate value of the last record received with the previous web method call and passes that value in the next web method call.
The following method is available for incremental data fetch.
-
GetPatientChangesV2
-
GetPatientAuthorizationChanges
-
GetDeletedPatientAuthorizations
Retrieves Patient information from Patient records modified after a given date/time.
The following is the request format. You can also click here to view the SOAP request and response.
| Get Patient Changes V2 Request | |||
|---|---|---|---|
| Field | Description | Type | Data Type |
| OfficeID | If the Agency is using the Multiple Office feature, an office ID can be specified here to filter the results. If this filter is missing, all the records (that the user has access to) are returned. | Optional | Number |
| ModifiedAfter | Specify a date/time value in EST to retrieve rows modified/created after the given time. | Required | Date/Time |
| Get Patient Changes V2 Result | ||
|---|---|---|
| Field | Description | Data Type |
| AgencyID | ID of the Agency in HHAeXchange | Number |
| OfficeID | Number | |
| PayerID | Unique ID of the Payer in HHAeXchange | Number |
| PatientID | Unique ID of the Patient in HHAeXchange | Number |
| ModifiedDate | Modified/Created time in UTC Format: YYYY-MM-DD HH:MM:SS.MSS | Date/Time |
| FirstName | String | |
| MiddleName | String | |
| LastName | String | |
| StatusID |
Possible Values: 1 - Waiting 2 - Pending 3 - Active 4 - Hospitalized 5 - Discharged 6 - Partially Pla 8 – Hold |
Number |
| AdmissionID | String | |
| MRNumber | Patient’s MR Number. Displays as Patient ID in the application. | String |
| Gender | Possible Values: Male | Female | String |
| DateOfBirth | Format: YYYY-MM-DD | Date |
| PriorityCode | Number | |
| AcceptedServices | String | |
| MedicaidNumber | String | |
| MedicareNumber | String | |
| SSN | SSN information is empty by default. To access this information, contact HHAeXchange Support Team to set up the necessary access policies and security procedures to have this information accessible through the interface. | String |
| Address1 | String | |
| Address2 | String | |
| City | String | |
| State | String | |
| Zip5 | Number | |
| Zip4 | String | |
| CrossStreet | String | |
| Direction | String | |
| HomePhone | Format: XXX-XXX-XXXX | String |
| Phone2 | Format: XXX-XXX-XXXX | String |
| Phone2Description | String | |
| Phone3 | Format: XXX-XXX-XXXX | String |
| Phone3Description | String | |
| WageParity | Possible Values: Yes | No | String |
| WageParityFromDate1 | Format: YYYY-MM-DD | Date |
| WageParityToDate1 | Format: YYYY-MM-DD | Date |
| WageParityFromDate2 | Format: YYYY-MM-DD | Date |
| WageParityToDate2 | Format: YYYY-MM-DD | Date |
| IsAlternateBilling | Possible Values: Yes | No | String |
| AlternateBilling FirstName | String | |
| AlternateBilling LastName | String | |
| AlternateBilling MiddleName | String | |
| AlternateBilling Street | String | |
| AlternateBilling City | String | |
| AlternateBilling State | String | |
| AlternateBilling ZipCode | String | |
| Emergency Contact 1 Name | String | |
| Emergency Contact 1 RelationshipID | Retrieve a list of valid Relationships and corresponding ID by calling the GetEmergencyContactRelationships method documented in the Reference Tables section. | Number |
| Emergency Contact 1 RelationshipName | String | |
| Emergency Contact 1 RelationshipOther | String | |
| Emergency Contact 1 LivesWithPatient | Possible Values: Yes | No | String |
| Emergency Contact 1 HaveKeys | Possible Values: Yes | No | String |
| Emergency Contact 1 Phone1 | Format: XXX-XXX-XXXX | String |
| Emergency Contact 1 Phone2 | Format: XXX-XXX-XXXX | String |
| Emergency Contact 1 Address | String | |
| Emergency Contact 2 Name | String | |
| Emergency Contact 2 RelationshipID | Retrieve a list of valid Relationships and corresponding ID by calling the GetEmergencyContactRelationships method documented in the Reference Tables section. | Number |
| Emergency Contact 2 RelationshipName | String | |
| Emergency Contact 2 RelationshipOther | String | |
| Emergency Contact 2 LivesWithPatient | String | |
| Emergency Contact 2 HaveKeys | Possible Values: Yes | No | String |
| Emergency Contact 2 Phone1 | Possible Values: Yes | No | String |
| Emergency Contact 2 Phone2 | Format: XXX-XXX-XXXX | String |
| Emergency Contact 2 Address | Format: XXX-XXX-XXXX | String |
| MobilityStatusID | Retrieve a list of valid Mobility Statuses and corresponding ID by calling the GetMobilityStatuses method as documented in the Reference Tables section. | Number |
| EvacuationZoneID | Retrieve a list of valid Evacuation Zones and corresponding ID by calling the GetEvacuationZones method as documented in the Reference Tables section. | Number |
| EvacuationLocationID | Retrieve a list of valid Evacuation Locations and corresponding ID by calling the GetEvacuationLocations method as documented in the Reference Tables section. | Number |
| OtherEvacuationLocation | String | |
| ElectricEquipmentDependency | String | |
| Description | String | |
| NurseID | Retrieve a list of valid Nurses and corresponding by calling the GetNurses method as documented in the Reference Tables section. | Number |
| Coordinators | String | |
| Frequency | String | |
| Cluster | Possible Values: Yes | No | String |
| IsMutualLinked | Possible Values: Mutual or Link | String |
| MutualLinkPatientID | Mutual/Link Patient ID | Number |
| IsPrimaryPatient | Possible Values: Yes | No | String |
| ServiceStartDate | Format: YYYY-MM-DD | Date |
| ProjectedDCDate | Format: YYYY-MM-DD | Date |
| SourceOfAdmissionID | Retrieve a list of Source of Admissions by calling the GetSourceOfAdmissions method as documented in the Reference Tables section. | Number |
| LocationID | Retrieve a list of Locations by calling the GetLocations method as documented in the Reference Tables Section. | Number |
| TeamID | A list of Patient Teams can be retrieved by calling the method GetPatientTeams documented in the Reference Tables Section. | Number |
| BranchID | A list of Branches can be retrieved by calling the method GetBranches documented in the Reference Tables Section. | Number |
| Alert | String | |
| ReferralMasterId | Referral ID | Number |
| ReferralReceivedDate | Referral Received Date | Date |
| ReferralSourceId | Referral Source ID | Number |
| ReferralStatusID | Retrieve a list of Referral Statuses by calling the GetReferralStatuses method as documented in the Reference Tables section. | String |
| ReferralLostReasonId | Applicable if ReferralStatus is Lost | Number |
| ReferralLostReasonNote | Applicable if ReferralStatus is Lost | String |
| CommissionStatus | Possible Values: Not Paid or Paid | String |
| ReferralContactId | Referral Contact Person ID | Number |
| ReferralIntakePersonId | Referral Intake Person ID | Number |
| AccountManagerId | Referral Account Manager ID | Number |
| RequestSpecialAgencyId | Number | |
| RequestGender | Possible Values: Male | Female | String |
| RequestPrimaryLanguage | Retrieve a list of Languages by calling the GetLanguages method as documented in the Reference Tables section. | Number |
| RequestSecondaryLanguage | Retrieve a list of Languages by calling the GetLanguages method as documented in the Reference Tables section. | Number |
| RequestOther | String | |
| AllowedCaregiverAccessPatient InfoToMobileApp | ||
| Caregiver | List of Caregivers | |
| ID | Caregiver ID | Number |
| Name | Caregiver Name | String |
Returns Patient Authorization Information changed/created after a specified date/time value.
| Field | Description | Type | Data Type |
|---|---|---|---|
| OfficeID | If specified, results are filtered by the given Office ID | Optional | Number |
| ModifiedAfter | Specify a date/time value in EST to retrieve rows modified/created after the given time. | Required | Date/Time |
If the method call is successful, the Status element of the Result node is set to Success. If the request fails, an error number is returned in the ErrorID element.
| Field | Description | Data Type |
|---|---|---|
| Patient | ||
| ID | Patient ID | Number |
| AdmissionNumber | Admission Number | Number |
| FirstName | FirstName | String |
| LastName | LastName | String |
| UpdatedDate | Last Updated Date Format: yyyy-mm-dd hh:mm | DateTime |
| OfficeID | OfficeID | Number |
| AuthorizationID | Authorization ID of the patient | |
| Contract | ||
| ID | Contract ID | Number |
| Name | Contract Name | String |
| Discipline | ||
| ID | Discipline ID | Number |
| Name | Discipline Name | String |
| AuthorizationNumber | Authorization Number | String |
| ServiceCode | ||
| ID | ServiceCode ID | Number |
| Name | ServiceCode Name | String |
| StartDate | Start Date | String |
| StopDate | Stop Date | String |
| MaxUnits | Max Units | Decimal |
| RemainingUnits | Remaining Units | Decimal |
| BankedHours | Banked Hours | String |
| Period | Return Period ID, Name details | Number |
| DailyMaxAuthorization | ||
| Sunday | Check DailyMaxAuthorization for Sunday | Number |
| Monday | Check DailyMaxAuthorization for Monday | Number |
| Tuesday | Check DailyMaxAuthorization for Tuesday | Number |
| Wednesday | Check DailyMaxAuthorization for Wednesday | Number |
| Thursday | Check DailyMaxAuthorization for Thursday | Number |
| Friday | Check DailyMaxAuthorization for Friday | Number |
| Saturday | Check DailyMaxAuthorization for Saturday | Number |
| WeeklyMaxAuthorization | Weekly Max Authorization | Number |
| EntirePeriodMaxAuthorization | Entire Period Max Authorization | Number |
| MonthlyPeriodMaxAuthorization | Monthly Period Max Authorization | Number |
| SpecificDateType | Specific Date Type | String |
| Weekday | Weekday | String |
| Weekend | Weekend | String |
| Notes | Notes | String |
| IsAdditionalRule | Check if AdditionlRule is present | String |
| AdditionalRules | ||
| AdditionalRule | List of AdditionalRules | |
| AdditionalRuleID | Additional Rule ID | Number |
| MaximumVisits | MaximumVisits | Number |
| Period | ||
| ID | Period ID | Number |
| Name | Period Name | String |
| Hours | Hours | Number |
| BillingDiagnosisCodes | ||
| BillingDiagnosisCode | List of Billing Diagnosis Codes | |
| DiagnosisCode | Diagnosis Code | String |
| Description | Description | String |
| IsPrimary | IsPrimary | String |
| AdmittingDiagnosis | Admitting Diagnosis | String |
| BlackOutDates | ||
| BlackOutDate | List of BlackOutDates | |
| FromDate | FromDate | String |
| ToDate | ToDate | String |
| BlackOutDateNotes | BlackOutDateNotes | String |
Returns list of patient authorizations deleted after a specified date/time value.
The following is the request format. You can also click here to view the SOAP request and response.
| Field | Description | Type | Data Type |
|---|---|---|---|
| ModifiedAfter | Specify a date/time value in EST to retrieve rows deleted after the given time. | Required | Date/Time |
If the method call is successful, the Status element of the Result node is set to Success. If the request fails, an error number is returned in the ErrorID element.
| Field | Description | Data Type |
|---|---|---|
| PatientAuthorizationID | Unique Patient Authorization ID | Number |
| AuthorizationNumber | Authorization number | String |
| DeletedDate | Deleted Date of Patient Authorization Format: YYYY-MM-DD HH:MM | DateTime |
| PatientID | Patient ID | Number |
| FromDate | From Date of Authorization Format: YYYY-MM-DD HH:MM | DateTime |
| ToDate | To Date of Authorization Format: YYYY-MM-DD HH:MM | DateTime |
| ServiceCategory | Service Category (For Internal and UPR Patient, Service Category will not have any value.) | String |
| ServiceType | Service Type (For Internal and UPR Patient, Service Type will not have any value.) | String |
| ServiceCode | Service Code | String |
| AuthorizationType | Authorization Type | String |
| AgencyID | Provider ID | Number |
| AgencyName | Agency Name | String |
| DeletedBy | DeletedBy | String |
| Contract | Contract (For Payer Patient, Contract will not have any value) | String |
| Discipline | Discipline (For Payer Patient, Discipline will not have any value) | String |
| Period | Period | String |
This section provides an overview of the web methods available to interact with Reference Tables. Please Click the method name to view the SOAP request and response.
| Method | Description/Returns… |
|---|---|
| GetPatientDisciplines | Available Patient Disciplines |
| GetBillingServiceCodes | A list of Billing Service Codes |
| GetContracts | A list of Contracts |
| GetContractServiceCode | Service Codes for given Internal Contract |
| GetOffices | All offices available in Agency |
| GetDisciplines | All Disciplines |