Texas Medicaid Electronic Visit Verification (EVV) Data Aggregator API Specifications

This specification provides guidance and instructions in preparing data for import to HHAeXchange. Herein are the various Application Programming Interface (API) endpoint definitions indicating required fields and proper format for a successful import.

The topic is intended for project management and technical teams at designated providers and/or Electronic Visit Verification (EVV) vendors who are implementing this interface.

If additional assistance is needed, please submit a ticket to EINTSupport@hhaexchange.com. Cases are escalated to the Enterprise Integration Service Desk (EISD) Production Support queue. An available Technical Team Member will contact you directly to assist.

Credentials Closed

Every web service method at HHAeXchange expects users to provide the following values for authentication and authorization. The following three parameters/values are required for every method call.

Value	Description
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.
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.

Value

Description

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.

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.

Error Codes Closed

The following are the HTTP Response Status Codes returned by the APIs and their meaning:

A 400 status code is logged for agency-specific error alerts, along with the corresponding error message.

A 500 status code is used for failure messages, along with the detailed failure description.

A 200 status code is logged for successful requests. If the web service call is not successful, an error code is returned with an Error ID; explained briefly in the table below and described later in this topic.

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

The list provides 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.

Patient Information Closed

The following methods are available to access Patient Information.

Reading Patient Information Closed

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 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.
GetPatientContracts	Returns details of Patient Contracts.
SearchPatientAuthorizations	Returns a list of authorizations associated with a 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.

Writing Patient Information Closed

The following methods can be used to perform various data modification operations related to Patient records.

Method	Description
CreatePatient	This method creates a new Patient record with the demographic information provided. If an Admission ID is not provided, a new Admission ID is auto generated by the system. If an Admission ID is provided and a Patient with the same Admission ID exists in the system, the method fails with an error message indicating that the Patient already exists.
UpdatePatientDemographics	Use this method to update Patient demographic information.

Interface Documentation Closed

Web service methods related to Patient Information are covered in this section.

Search Patients Closed

Allows users to search for Patients matching a given search criteria.

Request Data: click here to view the SOAP request and response.

Search Patients
Field	Description	Type	Data Type
FirstName	Patient’s First Name. Can search 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. Possibe values: All Hospitalized Waiting Discharged Active Hold 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 is 10 digits with 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

Response Data: 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.

Get Patient Demographics Closed

Retrieves Patient demographic information for a given record.

Request Data: click here to view the SOAP request and response.

Get Patient Demographics
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

Response Data: 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.

Create Patient Closed

Allows users to create a new Patient record in HHAeXchange. If the method call is successful a new patient is created with Waiting status and the ID of the newly created Patient is returned to the calling application.

Request Data: click here to view the SOAP request and response.

Create Patient
Field	Description	Type	Data Type
OfficeID	Retrieve a list of valid Values and their IDs by calling the method GetOffices documented in the Reference Tables section.	Required	Number
FirstName	Patient’s First Name	Required	string
MiddleName	Patient’s Middle Name	Optional	string
LastName	Patient’s Last Name	Required	string
BirthDate	Format: YYYY-MM-DD	Required	Date
Gender	Male, Female or Other	Required	String
CoordinatorID1	ID of a valid coordinator record to be assigned to the newly created Patient. A list of valid Coordinators along with their S can be retrieved by calling the method GetCoordinators documented under the Reference Tables Section.	Required	Number
AdmissionID	If not specified, the system auto generates a new Admission ID. If specified and another Patient with the same Admission ID exists in the system, the operation fails.	Optional	String
MRNumber	MR Number of the Patient (Displays as Patient ID in the application)	Optional	Number
MedicaidNumber	Format: XX99999XX Field can be configured as required in Office Setup.	Situational	String
AcceptedServices	List of Disciplines. At least one value is required. Retrieve a list of valid Values and their IDs by calling the method GetDisciplines documented in the Reference Tables section.	Required	String
Address1	Field can be configured as required in Office Setup.	Situational	String
Address2	Address2	Optional	String
CrossStreet	CrossStreet	Optional	String
City	City	Optional	String
Zip5	Format: 99999	Required	Number
Zip4	Format: 9999	Optional	Number
Notes	Notes	Optional	String
State	State	Optional	String
County	County	Optional	String
PhoneLocation	Accepted Values: HomePhone1, HomePhone2, HomePhone3 can be passed multiple Phones with pipe separated like HomePhone1, HomePhone2, and HomePhone3. Default address will be Primary Address.	Optional	String
IsPrimaryAddress	Value: Yes or No	Situational	String
AddressTypes	Accepted values: Home, GPS, Community. Home and Community can not be selected together. Multiple values can be passed with comma separated. If not passed then default address type will be Home and GPS.	Optional	String
HomePhone	Format: 999-999-9999	Optional	String
Phone2	Format: 999-999-9999	Optional	String
Phone2Description	Phone2Description	Optional	String
Phone3	Format: 999-999-9999	Optional	String
Phone3Description	Phone3Description	Optional	String
Direction	Direction	Optional	String
EmergencyContacts Name	Name	Optional	String
EmergencyContacts RelationshipID	RelationshipID – A list of valid relationships and their IDs can be retrieved by calling GetEmergencyContactRelationships methoddocumented under the Reference Tables section.	Optional	Number
EmergencyContacts LivesWithPatient	LivesWithPatient - Yes or No	Optional	String
EmergencyContacts HaveKeys	HaveKeys - Yes or No	Optional	String
EmergencyContacts Phone1	Format: 999-999-9999	Optional	String
EmergencyContacts Phone2	Format: 999-999-9999	Optional	String
EmergencyContacts Address	Address	Optional	String

This creates a Patient with a Primary Address with GPS as the default Address Type(s).

Response Data: 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.

Update Patient Demographics Closed

Use this method to update Patient demographic information.

Request Data: click here to view the SOAP request and response.

The data structure for CreatePatient and UpdatePatientDemographics methods are almost same with the following exceptions:

When calling UpdatePatientDemographics method, always specify the PatientID (which uniquely identifies each Patient). When creating a New Patient, the Patient ID is returned along with the response data. Obtain the Patient ID by calling the SearchPatients method.
OfficeID and AdmissionID values cannot be edited, the values are available only when a Patient is created.

If AddressType is not passed and blank then Home and GPS will be default Address Type.

Create Patient
Field	Description	Type	Data Type
PatientID	Unique ID of Patient in HHAeXchange. Obtain Patient ID by calling SearchPatients method.	Required	Number
FirstName	Patient’s First Name	Required	string
MiddleName	Patient’s Middle Name	Optional	string
LastName	Patient’s Last Name	Required	string
BirthDate	Format: YYYY-MM-DD	Required	Date
Gender	Male or Female or Other	Required	String
CoordinatorID1	ID of a valid coordinator record to be assigned to the newly created Patient. A list of valid coordinators along with their ID can be retrieved by calling the method GetCoordinators documented under the Reference Tables Section.	Required	Number
MRNumber	MR Number of the Patient (Displays as Patient ID in the application)	Optional	Number
MedicaidNumber	Format: XX99999XX Field can be configured as required in Office Setup.	Situational	String
AcceptedServices	List of Disciplines. At least one value is required. Retrieve a list of valid values and their IDs by calling the method GetDisciplines documented in the Reference Tables section.	Required	String
Address1	Field can be configured as required in Office Setup.	Situational	String
Address2	Address2	Optional	String
CrossStreet	CrossStreet	Optional	String
City	City	Optional	String
Zip5	Format: 99999	Required	Number
Zip4	Format: 9999	Optional	Number
Notes	Notes	Optional	String
State	State	Optional	String
County	County	Optional	String
PhoneLocation	Accepted Values: HomePhone1, HomePhone2, HomePhone3 can be passed multiple Phones with pipe separated like HomePhone1, HomePhone2, and HomePhone3. Default address will be Primary Address.	Optional	String
IsPrimaryAddress	Value: Yes or No	Situational	String
AddressTypes	Accepted values: Home, GPS, Community Home and Community can not be selected together. Multiple values can be passed with comma separated. If not passed then default address type will be Home and GPS.	Optional	String
HomePhone	Format: 999-999-9999	Optional	String
Phone2	Format: 999-999-9999	Optional	String
Phone2Description	Phone 2 Description	Optional	String
Phone3	Format: 999-999-9999	Optional	String
Phone3Description	Phone 3 Description	Optional	String
Direction	Direction	Optional	String
EmergencyContacts Name	Name	Optional	String
EmergencyContacts RelationshipID	RelationshipID – A list of valid relationships and their IDs can be retrieved by calling GetEmergencyContactRelationships method documented under the Reference Tables section.	Optional	Number
EmergencyContacts LivesWithPatient	LivesWithPatient – Yes or No	Optional	String
EmergencyContacts HaveKeys	HaveKeys- Yes or No	Optional	String
EmergencyContacts Phone1	Format: 999-999-9999	Optional	String
EmergencyContacts Phone2	Format: 999-999-9999	Optional	String
EmergencyContacts Address	Address	Optional	String

Response Data: 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.

Get Patient Contracts Closed

Returns Patient Contracts for given Patient from HHAeXchange.

Request Data: click here to view the SOAP request and response.

Get Patient Contracts
Field	Description	Type	Data Type
PatientID	Unique ID of the Patient in HHAeXchange.	Required	Number
VisitDate	Format: YYYY-MM-DD	Optional	Date

Response Data: 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.

Get Patient Contracts Result
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

Add Patient Contract Closed

Allows to add Patient Contracts for given Patient in HHAeXchange.

Request Data: click here to view the SOAP request and response.

Add Patient Contract
Field	Description	Type	Data Type
PatientID	Unique ID of the Patient in HHAeXchange.	Required	Number
Contract ID	Retrieve a list of Contracts by calling the method GetContracts documented in the Reference Tables section.	Required	Number
AltPatientID	Alternate Patient Number	Optional	String
StartDate	Format: YYYY-MM-DD	Required	Date
ServiceCodeID	Retrieve a list of Service Codes by calling the method GetBillingServiceCodes documented in the Reference Tables section.	Required	Number
IsPrimaryContract	Possible Values: True or False	Optional	String

Response Data: 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.

Update Patient Contract Closed

Allows to Update Patient Contracts for given Patient in HHAeXchange.

Request Data: click here to view the SOAP request and response.

Update Patient Contract
Field	Description	Type	Data Type
PatientID	Unique ID of the Patient in HHAeXchange.	Required	Number
PlacementID	Unique ID of the Patient Contract ID in HHAeXchange. This can be obtained by calling the method GetPatientContracts.	Required	Number
UpdateAltPatientID	Possible Values: True or False If Value is True, then only AltPatientID will be updated.	Optional	String
AltPatientID	Alternate Patient Number	Optional	String
UpdateStartDate	Possible Values: True or False If Value is true, the StartDate, SourceOfAdmissionID, StartNote will be updated.	Optional	String
StartDate	Format: YYYY-MM-DD Required if UpdateStartDate is true.	Situational	Date
SourceOfAdmissionID	Retrieve a list of Source of Admissions by calling the GetSourceOfAdmissions method as documented in the Reference Tables section.	Optional	Number
StartNote	Note	Optional	String
UpdateServiceCode	Possible Values: True or False If Value is true, the ServiceCodeID is updated.	Optional	String
ServiceCodeID	Retrieve a list of Service Codes by calling the method GetBillingServiceCodes documented in the Reference Tables section.	Optional	Number
UpdateDischargeDate	Possible Values: True or False If Value is true, the DischargeDate, DischargeToID, DischargeReasonID, DischargeNote are updated.	Optional	String
DischargeDate	Format: YYYY-MM-DD	Optional	Date
DischargeToID	Patient Discharge To ID. Retrieve a list of Patient Discharge To by calling the GetPatientDischargeTo method as documented in the Reference Tables section. Required if UpdateDischargeDate is true and DischargeDate is not blank.	Situational	Number
DischargeReasonID	Patient Discharge Reason ID. Retrieve a list of Contract Discharge Reason by calling the GetContractDischargeReason method as documented in the Reference Tables section. Required if UpdateDischargeDate is true and DischargeDate is not blank.	Situational	Number
DischargeNote	Note	Optional	String
IsPrimaryContract	Possible Values: True or False	Optional	String

Response Data: 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.

Search Patient Authorizations Closed

Allows users to search for Authorization entries associated with a given Patient ID.

Request Data: click here to view the SOAP request and response.

Search Patient Authorizations
Field	Description	Type	Data Type
PatientID	Patient ID to retrieve authorization information	Required	Number

Response Data: 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.

Get Patient Authorization Info Closed

Returns details of an authorization record identified by a given Authorization ID.

Request Data: click here to view the SOAP request and response.

Get Patient Authorization Info Request
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

Get Patient Authorization Info Request

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

Response Data: 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.

Create Patient Authorization Closed

A client application can call this method to create an authorization for Patient.

Request Data: click here to view the SOAP request and response.

Create Patient Authorization
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
Discipline	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 GetBillingServiceCodes documented in the Reference Tables section.	Required	Number
AuthorizationNumber	The authorization number for this authorization. If the authorization number is not available, enter TEMP. This will flag the authorization as temporary.	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 and .75 are allowed. Decimal values must be two digits if used. Example: 10.50 Only applies to Period = Daily, Weekly or Monthly. If Service Code type is configured as Visit in HHAeXchange, you can pass unit value in the same field. Example: 1	Optional	Decimal
SpecificDateType	Possible Values: True or False	Optional	Boolean
WeekDay	Possible Values: True or False Required if Specific Date Type = True	Situational	Boolean
WeekEnd	Possible Values: True or False Required if Specific Date Type = True	Situational	Boolean
BankedHours	Possible values: Y or N	Optional	String

Create Patient Authorization
Field	Description	Type	Data Type
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 and .75 are allowed. Decimal values must be two digits if used. Example: 10.50 If Service Code type is configured as Visit in HHAeXchange, you can pass unit value in the same field. Example: 1	Optional	Decimal
SatMinutes	Decimal values of .25, .50 and .75 are allowed. Decimal values must be two digits if used. Example: 10.50	Optional	Decimal
SunMinutes	Decimal values of .25, .50 and .75 are allowed. Decimal values must be two digits if used. Example: 10.50	Optional	Decimal
MonMinutes	Decimal values of .25, .50 and .75 are allowed. Decimal values must be two digits if used. Example: 10.50	Optional	Decimal
TueMinutes	Decimal values of .25, .50 and .75 are allowed. Decimal values must be two digits if used. Example: 10.50	Optional	Decimal
WedMinutes	Decimal values of .25, .50 and .75 are allowed. Decimal values must be two digits if used. Example: 10.50	Optional	Decimal
ThuMinutes	Decimal values of .25, .50 and .75 are allowed. Decimal values must be two digits if used. Example: 10.50	Optional	Decimal
FriMinutes	Decimal values of .25, .50 and .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: True or False	Optional	String
Program Code	Program Code	Optional	String
BudgetAmount	Budget Amount	Optional	Decimal
ProviderNumber	Required if Payer code type of contract is LTC. Value must be 9 digits numeric.	Situational	String

Response Data: 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.

Update Patient Authorization Closed

A client application can call this method to update authorization for Patient.

Request Data: click here to view the SOAP request and response.

Update Patient Authorization
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 GetBillingServiceCodes 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 and .75 are allowed. Decimal values must be two digits if used. Example: 10.50 Only applies to Period = Daily, Weekly or Monthly. If Service Code type is configured as Visit in HHAeXchange, you can pass unit value in the same field. Example: 1	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	Possible Values: True or False Required if Specific Date Type = True	Situational	Boolean

Update Patient Authorization
Field	Description	Type	Data Type
WeekEnd	Possible Values: True or False Required if Specific Date Type = True.	Situational	Boolean
MaxHoursPeriod	Decimal values of .25, .50 and .75 are allowed. Decimal values must be two digits if used. Example: 10.50 If Service Code type is configured as Visit in HHAeXchange, you can pass unit value in the same field. Example: 1	Optional	Decimal
SatMinutes	Decimal values of .25, .50 and .75 are allowed. Decimal values must be two digits if used. Example: 10.50	Optional	Decimal
SunMinutes	Decimal values of .25, .50 and .75 are allowed. Decimal values must be two digits if used. Example: 10.50	Optional	Decimal
MonMinutes	Decimal values of .25, .50 and .75 are allowed. Decimal values must be two digits if used. Example: 10.50	Optional	Decimal
TueMinutes	Decimal values of .25, .50 and .75 are allowed. Decimal values must be two digits if used. Example: 10.50	Optional	Decimal
WedMinutes	Decimal values of .25, .50 and .75 are allowed. Decimal values must be two digits if used. Example: 10.50	Optional	Decimal
ThuMinutes	Decimal values of .25, .50 and .75 are allowed. Decimal values must be two digits if used. Example: 10.50	Optional	Decimal
FriMinutes	Decimal values of .25, .50 and .75 are allowed. Decimal values must be two digits if used. Example: 10.50	Optional	Decimal
AuthorizationAdditional RuleID	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	BlackNote	Optional	String
DiagnosisCode	Billing Diagnosis ICD-10 Code	Optional	String
Description	Description of ICD-10 Code	Optional	String

Response Data: 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.

Caregiver Information Closed

Throughout this topic, Service Provider, also known as Caregiver, will be referred to as Caregiver. The following methods are available to access Caregiver information.

Reading Caregiver Information Closed

The following methods allow users to view/retrieve Caregiver information from HHAeXchange.

Method	Allows users to…
SearchCaregivers	Search for a list of Caregivers matching a given search criteria. This returns a list of CaregiverIDs (which is a unique identifier of each Caregiver record). The ID returned by this method can be submitted to GetCaregiverDemographics method to retrieve the demographic information of the given Caregiver.
GetCaregiverDemographics	Retrieve Caregiver Demographic Information. Results return the information of one Caregiver at a time. When calling this method, submit the Caregiver ID to access. Use the SearchCaregivers method to retrieve the Caregiver IDs of the based on the search criteria.

Writing Caregiver Information Closed

The following methods are used to perform various data modification operations related to Caregiver records.

Method	Allows users to…
CreateCaregiver	Create a New Caregiver record.
UpdateCaregiverDemograpics	Update Caregiver Demographic Information.

Interface Documentation Closed

Web service methods related to Caregiver Information is covered in this section.

Search Caregivers Closed

Allows users to search for Caregivers matching a given search criteria.

Request Data: click here to view the SOAP request and response.

Search Caregivers Request
Field	Description	Type	Data Type
FirstName	Caregiver’s first name. Searches for partial names as well (using starts-with algorithm).	Optional	Text
LastName	Caregiver’s last name. Searches for partial names as well (using starts-with algorithm).	Optional	Text
Status	Caregiver Status Filter. Possible values: All Hold Active On Leave Inactive Terminated Rejected All is assumed if a filter is not specified.	Optional	Text
PhoneNumber	Searches for Caregivers matching a given phone number inHome Phone, Phone2 and Phone3 fields. The number requires 10 digits, no special characters are allowed.	Optional	Text
CaregiverCode	Searches for a Caregiver by Caregiver Code. An exact-match algorithm is used and partial search is not supported.	Optional	Text
EmployeeType	Caregiver Employee Type Filter values: All Employee Applicant	Optional	Text
SSN	Caregiver’s SSN	Optional	Text
AlternateCaregiverCode	Caregiver’s Alternate Caregiver Code	Optional	Text

Response Data: 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.

Get Caregiver Demographics Closed

Retrieves Caregiver demographic information for a given record.

Request Data: click here to view the SOAP request and response.

Get Caregiver Demographics
Field	Description	Type	Data Type
ID	Primary Key of the Caregiver to be retrieved. This call is typically followed by a call to SearchCaregivers method that retrieves the IDs of the desired Caregivers using various search filters.	Required	Number

Response Data: 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.

Get Caregiver Demographics Result
Field	Description	Data Type
ID	Primary Key of the Caregiver to be retrieved	Number
FirstName	Caregivers’s FirstName	String
MiddleName	Caregiver’s MiddleName	String
LastName	Caregiver’s LastName	String
Intials	Caregiver’s Initials	String
Gender	Possible Values: Male or Female	String
CaregiverGenderID	Caregiver Gender ID in HHAeXchange	String
BirthDate	Caregiver’s Birthdate Format: YYYY-MM-DD	String
CaregiverCode	Caregiver Code in HHAeXchange.	Number
TimeAndAttendancePIN	Time and Attendance PIN of the Caregiver in HHAeXchange	Number
AlternateCaregiverCode	Altername Caregiver Code in HHAeXchange	String
MobileID	MobileID in HHAeXchange	Number
MobileIDType	Mobile ID type in HHAeXchange	String
MobileIDTypeDescription	Mobile ID type Description in HHAeXchange. Possible Values: Clinical or Non Clinical	String
SSN	SSN in HHAeXchange	String
Ethnicity	List of Caregiver Ethnicity
ID	Ethnicity ID in HHAeXchange	Number
Name	Ethnicity Name in HHAeXchange	String
RehireDate	Rehire date of Caregiver Format: YYYY-MM-DD	String

Get Caregiver Demographics Result
Field	Description	Data Type
RegistryNumber	Caregiver’s Registry Number	String
RegistryCheckedDate	Date the Caregiver information was entered/checked in the registry. Format: YYYY-MM-DD	String
ReferralSource	Caregiver’s Referral Source in HHAeXchange
ID	Referral Source ID	Number
Name	Referral Source Name	String
ReferralPerson	Referral Source Person	String
Address	Caregiver’s Address Information
Street1	Street 1	String
Street2	Street 2	String
City	City	String
State	State	String
Zip5	Zip5 - 5 Digit Zip Code	Number
Zip4	Zip4 - 4 Digit Zip Code	Number
HomePhone	HomePhone - Format: 999-999-9999	String
Phone2	Phone2 - Format: 999-999-9999	String
Phone3	Phone3 - Format: 999-999-9999	String
EmergencyContacts	List of Emergency Contacts of Caregivers
EmergencyContact	Emergency Contact Details
Name	Emergency Contact Person Name	String
Relationship	Relation with Emergency Contact Person
ID	Relationship ID	Number
Name	Relationship Name	String
Address	Address of Emergency Contact Person	String
Phone1	Phone 1 of Emergency Contact Person	String
Phone2	Phone 2 of Emergency Contact Person	String

Get Caregiver Demographics Result
Field	Description	Data Type
NotificationPreferences	Caregiver’s Notification Preferences in HHAeXchange
Method	Methods of Notification Preferences
ID	Method ID	Number
Name	Method Name	String
Email	Email ID for Notification	String
MobileOrSMS	Mobile Number to receive Text Message. Format: 999-999-9999	String
VoiceMessage	Phone number to receive voice message notifications. Format: 999-999-9999	String
CaregiverOffices	List of Caregiver’s Offices
Office	Office Information
OfficeID	Office ID	Number
OfficeName	Office Name	String
IsPrimary	Is Primary	Bool
InactiveReasonID	InActive Reason ID	Number
InactiveReason	InActive Reason	String
InactiveNote	Inactive Note	String
TerminatedDate Format: YYYY-MM-DD	Terminated Date	String
ProfessionalLicensenumber	Professional License number	String
NPINumber	NPINumber	String
SignedPayrollAgreementDate	Signed Payroll Agreement Date	String
LanguageID1	Language 1 ID	Number
Language1	Language 1	String
LanguageID2	Language 2 ID	Number
Language2	Language 2	String
LanguageID3	Language 3 ID	Number
Language3	Language 3	String
LanguageID4	Language 4 ID	Number
Language4	Language 4	String
LastModifiedDate	Last Modified Date. Format: YYYY-MM-DD	String
TimeZone	TimeZone of caregiver	String

CreateCaregiver Closed

Allows users to create a new Caregiver record in HHAeXchange. If the method call is successful a new Caregiver profile is created, and the ID of the newly created record is returned to the calling application.

Request Data: click here to view the SOAP request and response.

Create Caregivers
Field	Description	Type	Data Type
OfficeID	Retrieve a list of valid values and their IDs by calling the method GetOffices documented in the Reference Tables section.	Required	Number
FirstName		Required	String
MiddleName	Field can be configured as required in Office Setup.	Situational	String
LastName		Required	String
Initials	If not specified, the first letter of First Name and Last Name are used to create an initial value.	Optional	String
BirthDate		Required	Date
Gender	Male or Female Get gender name list by calling method GetCaregiveGender.	Required	String
AlternateCaregiverCode		Optional	String
SSN	Format: 999-99-9999 RehireDate (see table below) is required if there is another Caregiver with the same SSN in the system. Field can be configured as required in Office Setup.	Situational	String

Create Caregivers
Field	Description	Type	Data Type
RehireDate	YYYY-MM-DD – required if attempting to create a Caregiver with an SSN that already exists in another Caregiver.	Situational	Date
StatusID	Valid Caregiver Employee Status: 0 - Inactive 3 - On Leave 1 - Active 4 - Terminated 2 - Hold Valid Caregiver Applicant Status: 1 - Active 5 – Rejected	Required	Number
EmploymentTypes	List of Disciplines. One value is required either Clinical or Non-Clinical Disciplines for all. Retrieve a list of valid values and their IDs by calling the method GetDisciplines documented in the Reference Tables section.	Required	String
EmployeeID	Unique Provider Assigned ID	Required	String
ApplicationDate	Format: YYYY-MM-DD	Required	Date
Address Street1	Field can be configured as required in Office Setup.	Situational	String
Address Street2	Street2	Optional	String
Address City	Field can be configured as required in Office Setup.	Situational	String
Address State	Field can be configured as required in Office Setup.	Situational	String
Address Zip5	Zip5 - 5 Digit Zip Code.	Required	Number
Address Zip4	Zip4 - 4 Digit Zip Code. Field can be configured as required in Office Setup.	Situational	Number
HomePhone	Format: 999-999-9999	Optional	Number
Phone2	Format: 999-999-9999	Optional	Number
Phone3	Format: 999-999-9999	Optional	Number
EmergencyContacts Name	Name	Optional	String
EmergencyContacts RelationshipID	RelationshipID – Retrieve a list of valid relationships and their IDs by calling GetEmergencyContactRelationships method documented under the Reference Tables section.	Optional	Number
EmergencyContacts OtherRelationship	Other Relationship	Optional	String
EmergencyContacts Address	Address	Optional	String
EmergencyContacts Phone1	Phone1 – Format: 999-999-9999	Optional	String

Create Caregivers
Field	Description	Type	Data Type
EmergencyContacts Phone2	Phone2 – Format: 999-999-9999	Optional	String
NotificationPreferences Email	Email	Optional	String
NotificationPreferences MobileOrSMS	MobileOrSMS – Specify Mobile Number to receive Text Message. Format: 999-999-9999 Field can be configured as required in Office Setup.	Situational	Number
Language1	Retrieve a list of Languages by calling the method GetLanguages documented in the Reference Tables section. Field can be configured as required in Office Setup.	Situational	Number
Language2	Retrieve a list of Languages by calling the method GetLanguages documented in the Reference Tables section. Field can be configured as required in Office Setup.	Situational	Number
Language3	Retrieve a list of Languages by calling the method GetLanguages documented in the Reference Tables section.	Optional	Number
Language4	Retrieve a list of Languages by calling the method GetLanguages documented in the Reference Tables section.	Optional	Number
EmployeeType	Possible Values: Applicant or Employee. If not specified, the Employee value taken by default.	Required	String
InactiveReason	Retrieve a list of Inactive Reasons by calling the method GetStatusReasonsForCaregiver in the Reference Tables section.	Optional	Number
InactiveNote	Field can be configured as required in Office Setup.	Situational	String

Response Data: 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.

Update Caregiver Demographics Closed

Use this method to update Caregiver demographic information.

Request Data: click here to view the SOAP request and response.

A field marked with an asterisk (*) will retain previous value when sent as null/blank. If one of the fields is configured as required, its value cannot be null/blank.

Update Caregiver Demographics Request
Field	Description	Type	Data Type
CaregiverID	Unique ID of Caregiver in HHAeXchange.	Required	Number
FirstName		Required	String
MiddleName	Field can be configured as required in Office Setup.	Situational	String
LastName		Required	String
Initials	If not specified, the first letter of First Name and Last Name are used to create an initial value.	Optional	String
Gender	Male or Female	Required	String
BirthDate	Format: YYYY-MM-DD	Required	Date
AlternateCaregiverCode*		Optional	String
SSN	Format: 999-99-9999 RehireDate (see below) is required if there is another Caregiver with the same SSN in the system. Field can be configured as required in Office Setup.	Situational	String
RehireDate	YYYY-MM-DD – Required if attempting to create a Caregiver with an SSN that already exists in another Caregiver.	Situational	Date

Update Caregiver Demographics Request
Field	Description	Type	Data Type
StatusID	Valid Caregiver Employee Status: 0 - Inactive 3 - On Leave 1 - Active 4 - Terminated 2 - Hold Valid Caregiver Applicant Status: 1 - Active 5 – Rejected	Required	Number
TerminatedDate	Date of Terminate of Caregiver Required only when status is terminated.	Situational	Date
EmploymentTypes	List of Disciplines. One value is required, either Clinical or Non-Clinical Disciplines. Retrieve a list of valid values and their IDs by calling the method GetDisciplines documented in the Reference Tables section.	Required	String
EmployeeID*	Unique Provider Assiged ID	Required	String
ApplicationDate	Format: YYYY-MM-DD	Required	Date
Address Street1*	Field can be configured as required in Office Setup.	Situational	String
Address Street2*		Optional	String
Address City*	Field can be configured as required in Office Setup.	Situational	String
Address State*	Field can be configured as required in Office Setup.	Situational	String
Address Zip5	Zip5 - 5 Digit Zip Code	Required	Number
Address Zip4*	Zip4 - 4 Digit Zip Code Field can be configured as required in Office Setup.	Situational	Number
Address HomePhone*	HomePhone - 999-999-9999	Optional	String
Address Phone2*	Phone2 - 999-999-9999	Optional	String
Address Phone3*	Phone3 - 999-999-9999	Optional	String
EmergencyContacts Name*	Name	Optional	String
EmergencyContacts RelationshipID*	RelationshipID – Retrieve a list of valid relationships and their IDs by calling GetEmergencyContactRelationships method documented under the Reference Tables section.	Optional	Number
OtherRelationship	EmergencyContactsRelationshipID must be 2 to pass a value in this field.	Optional	String
EmergencyContacts Address*	Address	Optional	String
EmergencyContacts Phone1*	Phone1 – Format: 999-999-9999	Optional	String
EmergencyContacts Phone2*	Phone2 – Format: 999-999-9999	Optional	String

Update Caregiver Demographics Request
Field	Description	Type	Data Type
NotificationPreferences Email*	Field can be configured as required at Office Setup.	Situational	String
NotificationPreferences MobileOrSMS*	MobileOrSMS – Specify Mobile Number to receive Text Message. Format: 999-999-9999 Field can be configured as required in Office Setup.	Situational	String
Language1*	Retrieve a list of Languages by calling the method GetLanguages documented in the Reference Tables section. Field can be configured as required in Office Setup.	Situational	Number
Language2*	Retrieve a list of Languages by calling the method GetLanguages documented in the Reference Tables section. Field can be configured as required in Office Setup.	Situational	Number
Language3*	Retrieve a list of Languages by calling the method GetLanguages documented in the Reference Tables section.	Optional	Number
Language4*	Retrieve a list of Languages by calling the method GetLanguages documented in the Reference Tables section.	Optional	Number
EmployeeType	Possible Values: Applicant or Employee. If not specified, the Employee value taken by default.	Required	String
SecondaryOffices ID*	ID of Secondary Office.	Optional	String
InactiveReason*	Retrieve a list of Inactive Reasons by calling the method GetStatusReasonsForCaregiver in the Reference Tables section.	Optional	Number
InactiveNote*	Field can be configured as required in Office Setup.	Situational	String

The data structure for CreateCaregiver and UpdateCaregiverDemographics methods are almost same with the following exceptions.

When calling UpdateCaregiverDemographics method, always specify the CaregiverID (which uniquely identifies each Caregiver). When creating a new Caregiver, the Caregiver ID is returned along with the response data. A Caregiver ID can also be obtained by calling the SearchCaregivers method.
OfficeID and CaregiverCode values cannot be edited. The values are available only when a Caregiver profile is created.
TerminatedDate is required only when status is terminated.
When OtherRelationship is specified under EmergencyContacts section, RelationshipID will be -2 only.

Response Data: 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.

Update Caregiver Demographics Result
Field	Description	Data Type
CaregiverID	Unique ID of the Caregiver in HHAeXchange	Number

Schedule and Visit Information Closed

The following methods are available to access Schedule/Visit information.

Reading Schedule and Visit Information Closed

The following methods allow users to read Schedule and Visit information from HHAeXchange.

Method	Allows users to…
SearchVisits	Search for a list of visits matching a given search criteria. Returns a list of VisitIDs (which is a unique identifier of each Visit record). The ID returned by this method can be submitted to one of the methods listed below to retrieve additional information related to each Visit.
GetVisitInfoV2	Returns visit information related to the Visit specified by an ID.
GetVisitBillInfo	Returns Billing information the Visit specified by an ID.

Method

Allows users to…

SearchVisits

Search for a list of visits matching a given search criteria. Returns a list of VisitIDs (which is a unique identifier of each Visit record). The ID returned by this method can be submitted to one of the methods listed below to retrieve additional information related to each Visit.

GetVisitInfoV2

Returns visit information related to the Visit specified by an ID.

GetVisitBillInfo

Returns Billing information the Visit specified by an ID.

Writing Schedule and Visit Information Closed

The following methods allow users to write Schedule and Visit information in HHAeXchange.

Method	Allows users to…
CreateSchedule	Create Schedule information in HHAeXchange.
UpdateSchedule	Update Schedule based on given Schedule Information in HHAeXchange.
DeleteVisit	Delete Visit on given Visit Information in HHAeXchange.

Interface Documentation Closed

Web service methods related to visit information is documented in this section.

SearchVisits Closed

Allows users to search for Visits matching a given search criteria.

Request Data: click here to view the SOAP request and response.

Search Visits Request
Field	Description	Type	Data Type
StartDate	Beginning of the date range to search for Format: YYYY-MM-DD The range between StartDate and EndDate cannot be more than 1 day when PatientID & CaregiverID not passed. If PatientID & CaregiverID passed, range between StartDate and EndDate can be more than 1 day.	Required	Date
EndDate	End of the date range to search for Format: YYYY-MM-DD The range between StartDate and EndDate cannot be more than 1 day when PatientID & CaregiverID not passed. If PatientID & CaregiverID passed, range between StartDate and EndDate can be more than 1 day.	Required	Date
PatientID	Patient ID to search Required if Caregiver ID & StartDate and EndDate are not specified.	Situational	Number
CaregiverID	Caregiver ID to search Required if Patient ID & StartDate and EndDate are not specified.	Situational	Number
OfficeID	OfficeID is required in below condition to search Visit. It is required with StartDate & EndDate. It is required with Patient ID / Caregiver ID.	Optional	Number

Response Data: 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.

Get Schedule Info Closed

Retrieves schedule information of a specific visit by its ID.

Request Data: click here to view the SOAP request and response.

Get Schedule Info Request
Field	Description	Type	Data Type
ID	Primary Key of the Visit record to be retrieved. Retrieve ID by calling the SearchVisits method described earlier.	Required	Number

Response Data: 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.

Get Visit Info V2 Closed

Allows users to retrieve Visit information by using the Visit ID.

Request Data: click here to view the SOAP request and response.

Get Visit Info V2 Request
Field	Description	Type	Data Type
ID	Primary Key of the Visit record to be retrieved. Obtain ID by calling the SearchVisits method described earlier.	Required	Number

Response Data: 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.

Get Visit Info V2 Result
Field	Description	Data Type
ID	Primary Key of the Visit record to be retrieved. Obtain ID by calling the SearchVisits method described earlier.	Number
VisitDate	Visit/Schedule Date Format: YYYY-MM-DD	Date
Patient	Retreive Patient details incuding Patient ID, Admission Number, First Name and LastName.
Caregiver	Retreive Caregiver details including Caregiver ID, FirstName, LastName, CaregiverCode, TimeAndAttendancePIN, PayCodeID and PayCode Name.
ScheduleStartTime	Schedule Start Time Format: yyyy-mm-dd hh:mm	String
ScheduleEndTime	Schedule End Time Format: yyyy-mm-dd hh:mm	String
VisitStartTime	Visit Start Time v Format: yyyy-mm-dd hh:mm	String
VisitEndTime	Visit End Time Format: yyyy-mm-dd hh:mm	String
EVVStartTime	EVV Start Time Format: yyyy-mm-dd hh:mm	String
EVVEndTime	EVV End Time Format: yyyy-mm-dd hh:mm	String
IsMissedVisit	Visit Missed or Not Value: Yes or No	String
TTOT	Approved Travel Time Hours and Minutes
Verification	Show Verification details including VerifiedBy, Notes, VerifiedDate, VerifiedTime, SupervisorName.
Timesheet	TimeSheet Required: Yes or No TimeSheet Approved: Yes or No
Payroll
PayrollType	Payroll Type	String

Get Visit Info V2 Result
Field	Description	Data Type
PayCode	Pay Code	String
ServiceHours	Service Hours	String
TT-OTHours	TT/OTHours	String
PayUnits	Pay Units	String
PayRate	Pay Rate	String
PrebillingProblems
PrebillingProblemInfo	List of Prebilling Problems	String
TasksPerformed	Retreive Details Duty task including POCTaskCode, AdditionalValue, Status (Duties Performed/ Duties Refused/ Duties Not Performed), Category Name, Duty, Minutes.
VisitType	VisitType	String
ScheduleDuration	Schedule Duration	Number
ScheduleDurationHours	Schedule Duration Hours Format: HH	Number
ScheduleDurationMinutes	Schedule Duration Minutes Format: MM	Number
ClockInEvvType	Clock In EVV Type	String
ClockOutEvvType	Clock Out EVV Type	String
BilledAmount	Returns TotalBillingAmount only if service code is dollar based service code for that visit.	Number

Get Visit Info V2 Result
Field	Description	Data Type
Budget Number	Returns budget number value	Number
ActualHours	Returns ActualHours value	String
ActualHoursRounded	Returns ActualHoursRounded value	String
PayHours	Returns PayHours value	String
PayHoursUnrounded	Returns PayHoursUnrounded value	String
AdjustedHours	Returns AdjustedHours value Format: HHMM	String
TimeZone	TimeZone	String

Get Visit Bill Info Closed

Allows users to retrieve Billing information by using the Visit ID.

Request Data: click here to view the SOAP request and response.

Get Visit Bill Info Request
Field	Description	Type	Data Type
ID	Primary Key of the Visit record to be retrieved. Obtain ID by calling the SearchVisits method described earlier.	Required	Number

Response Data: 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.

CreateSchedule Closed

Allows users to create Non-Skilled and Skilled Schedule/Visit in HHAeXchange for a given Patient.

Request Data: click here to view the SOAP request and response.

Create Schedule Request
Field	Description	Type	Data Type
PatientID	Unique ID of the Patient in HHAeXchange.	Situational	Number
AdmissionID	Required If PatientID is not given. Patient Admission ID as seen in HHAeXchange.	Situational	String
PatientFirstName	Patient’s First Name. Required If PatientID and AdmissionID is not given.	Situational	String
PatientLastName	Patient’s Last Name Required If PatientID and AdmissionID is not given.	Situational	String
PatientDateOfBirth	Patient’s Date of Birth Required If PatientID and AdmissionID is not given. Format: YYYY-MM-DD	Situational	Date

Create Schedule Request
Field	Description	Type	Data Type
ScheduleType	Possbile values: Non-Skilled or Skilled	Required	String
VisitDate	Visit/Schedule Date Format: YYYY-MM-DD	Required	Date
ScheduleStartTime	Schedule Start time as per Agency/Office Timezone. Format: HHMM Start time must be 0000 if Visit Type is Daily Variable, Weekly Variable or No Schedule.	Required	Time
ScheduleEndTime	Schedule Start End as per Agency/Office Timezone. Format: HHMM Start time must be 0000 if Visit Type is Daily Variable, Weekly Variable or No Schedule.	Required	Time
IsScheduleTemporary	Possible values: Yes or No	Optional	String
CaregiverID	Unique ID of the Caregiver in HHAeXchange.	Situational	Number
CaregiverCode	Caregiver Code in HHAeXchange. Required If CaregiverID is not given.	Situational	String
CaregiverFirstName	Caregiver’s First Name. Required If CaregiverID and CaregiverCode is not given.	Situational	String
CaregiverLastName	Caregiver’s Last Name. Required If CaregiverID and CaregiverCode is not given.	Situational	String
CaregiverDateOfBirth	Caregiver’s Date of Birth. Required If CaregiverID and CaregiverCode is not given. Format: YYYY-MMDD	Situational	Date
PayCodeID	Retrieve a list of Pay Rate Code by calling the method GetCaregiverPayCodes for given CaregiverID documented in the Caregiver Information section. , If not given, the system takes the Caregiver’s Disciplines with Agency Default Pay Code as configured in Reference Table (if any).	Situational	Number
PayCodeName	Existing valid Pay Code in HHAeXchange. Required If PayCodeID is not given. If not given, then the system takes the Caregiver’s Disciplines with Agency Default Pay Code as configured in Reference Table (if any).	Situational	String
IsCaregiverTemporary	Possible values: Yes or No	Optional	String
PrimaryBillTo ContractID	Retrieve a list of Contracts by calling the method GetPatientContracts for given Patient ID documented in the Patient Information section. If not given, the Patient’s Primary Contract is considered by default (if any).	Situational	Number

Create Schedule Request
Field	Description	Type	Data Type
PrimaryBillTo ContractName	Existing valid Contract Name in HHAeXchange. Required If ContractID is not given. If not given, then the Patient’s Primary Contract is considered by default (if any).	Situational	String
PrimaryBillTo ServiceCodeID	Retrieve a list of Service Codes by calling the method GetContractServiceCode documented in the Reference Tables section. If not given, then the Default Service Code of the Primary Contract is considered (if any).	Situational	Number
PrimaryBillTo ServiceCodeName	Existing valid Service Code in HHAeXchange. Required If ServiceCodeID is not given. If not given, then the Default Service Code of the Primary Contract is considered (if any).	Situational	String
PrimaryBillTo Hours	Format: HH Required if Visit Type is Daily Fixed.	Situational	Number
PrimaryBillTo Minutes	Format: MM Required if Visit Type is Daily Fixed. .	Situational	Number
SecondaryBillTo ContractID	Retrieve a list of Contracts by calling the method GetPatientContracts for given Patient ID documented in the Patient Information section. Possible if Visit Type is Daily Fixed and PrimaryBillTo contract is private payer and SecondaryBillTo contract is selected.	Optional	Number
SecondaryBillTo ContractName	Existing valid Contract Name in HHAeXchange. Required If ContractID is not given.	Situational	String
SecondaryBillTo ServiceCodeID	Retrieve a list of Service Codes by calling the method GetContractServiceCodes documented in the Reference Tables section. Required if Visit Type is Daily Fixed and PrimaryBillTo contract is private payer and SecondaryBillTo contract is selected.	Situational	Number
SecondaryBillTo ServiceCodeName	Existing valid Service Code exists in HHAeXchange. Required If ServiceCodeID is not given.	Situational	String
SecondaryBillTo Hours	Hours: HH Required if Visit Type is Daily Fixed and PrimaryBillTo contract is private payer and SecondaryBillTo contract is selected.	Situational	Number
SecondaryBillTo Minutes	Minues: MM Required if Visit Type is Daily Fixed and PrimaryBillTo contract is private payer and SecondaryBillTo contract is selected.	Situational	Number
VisitType	Will allow Variable Schedule Types that exist in the HHAeXchange office configuration. Possible Values: Daily Variable Weekly Variable	Optional	String

Create Schedule Request
Field	Description	Type	Data Type
No Schedule Daily Fixed If not specified, the Daily Fixed value is set by default.
ScheduleDurationHours	Format: HH Required if Visit Type is Daily Variable, Weekly Variable or No Schedule.	Situational	Number
ScheduleDurationMinutes	Format: MM Required if Visit Type is Daily Variable, Weekly Variable or No Schedule.	Situational	Number
BudgetNumber	Required for UPR Contract if Enable Budget Number flag marked as True. Possible values:1 to 5	Situational	Number

Response Data: 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.

Create Schedule Result
Field	Description	Data Type
PatientID	Unique ID of the Patient in HHAeXchange.	Number
VisitID	Unique ID of the Visit/Schedule created in HHAeXchange.	Number

Create Weekly Variable Request Closed

Allows users to create weekly variable parameters.

Create Weekly Variable Request
Field	Description	Type	Data Type
PatientID	Unique ID of the Patient in HHAeXchange.	Required	Number
ContractID	Retrieve a list of Contracts by calling the method GetPatientContracts for given Patient ID documented in the Patient Information section. If Contract ID is not received, the Patient’s Primary Contract is considered by default (if any).	Optional	Number
ServiceCodeID	Retrieve a list of Service Codes by calling the method GetContractServiceCodes documented in the Reference Tables section. If the Service Code is not received, the Default Service Code of the Primary Contract is considered (if any).	Optional	Number
WeeklyHours	Format: HH	Optional	Number
WeeklyMinutes	Format: MM	Optional	Number
WeekStartDate	Format: YYYY-MM-DD	Optional	Date
WeekEndDate	Format: YYYY-MM-DD	Optional	Date

Response Data: 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.

Update Weekly Variable Request Closed

Allows users to update weekly variable parameters.

Update Weekly Variable Request
Field	Description	Type	Data Type
WeeklyVariableID	Unique ID of the weekly variable in HHAeXchange.	Required	Number
WeeklyHours	Format: HH	Optional	Number
WeeklyMinutes	Format: MM	Optional	Number

Update Schedule Closed

Allows users to update Non-Skilled and Skilled Schedule/Visit in HHAeXchange for a selected Visit ID.

Request Data: click here to view the SOAP request and response.

Update Schedule Request
Field	Description	Type	Data Type
ScheduleDuration Hours	Format: HH Required if Visit Type is Daily Variable, Weekly Variable or No Schedule.	Situational	Number
ScheduleDuration Minutes	Format: MM Required if Visit Type is Daily Variable, Weekly Variable or No Schedule.	Situational	Number
IsUpdateOnlyBilled Amount	Possible values: Yes or No Below flow works only for UPR or Internal patient: If IsUpdateOnlyBilledAmount is Yes and provided service code is dollar-based service code then it will update only billed amount. If IsUpdateOnlyBilledAmount is No and provided service code is dollar-based service code then it will update schedule and billed amount. If IsUpdateOnlyBilledAmount is No and provided service code is not dollar-based service code or regular service code then its works as per the existing flow and will update schedule only, it will not update the billed amount.	Optional	String
BilledAmount	If IsUpdateOnlyBilledAmount Yes then Billed Amount is required.	Situational	Number
BudgetNumber	Required for UPR Contract if Enable Budget Number flag marked as True. Possible values: 1 to 5	Situational	Number

Response Data: 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.

Update Schedule Result
Field	Description	Data Type
PatientID	Unique ID of the Patient in HHAeXchange.	Number
VisitID	Unique ID of the Visit/Schedule created in HHAeXchange.	Number

DeleteVisit Closed

Allows users to delete Visit information by using the Visit ID.

Delete Visit
Field	Description	Type	Data Type
VisitID	Primary Key of the Visit record to be retrieved. Obtain this ID by calling the SearchVisits method described earlier.	Required	Number
ReasonID	Obtain this ID by calling the GetVisitDeleteReasons method described in Reference Tables section.	Required	Number
Note	Visit Delete Note Required if Other Reason ID is selected.	Situational	Text

Response Data: 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.

Billing Information Closed

The following methods are available to access Payroll information.

Method	Allows users to…
SearchBilledVisits	Search Billed Visits by Visit From Date to To Date.

SearchBilledVisits Closed

A client application can call this method to retrieve Billed Visit belonging to a given Start Date and End Date and OfficeID or PatientID.

Request Data: click here to view the SOAP request and response.

Search Billed Visits
Field	Description	Type	Data Type
StartDate	Date filter. The web method returns a list of all Billed Visits or after this date. Format: YYYY-MM-DD	Required	Date
EndDate	Date filter. The web method returns a list of all Billed Visits created on or before this date. Format: YYYY-MM-DD	Required	Date
OfficeID	ID of the Office	Optional	Date
PatientID	Unique Patient ID	Optional	Date

Response Data: 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.

Search Billed Visits Result
Field	Description	Data Type
VisitID	Unique ID of the Schedule created/linked in HHAeXchange.	Number
PatientID	Unique PatientID	Number
ContractID	Unique ContractID	Number
OtherChargeID	Unique OtherChargeID	Number

Incremental Fetch Methods Closed

This section provides an overview of the various web methods available to retrieve changes incrementally from HHAeXchange. These methods allow users to retrieve changes occuring 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 the following:

Modified Date – Indicates the time when the record was modified. This is a UTC date/time or EST date/time format with precision up to milliseconds.

Every row returned by each of the Incremental Fetch Methods 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.

All the incremental fetch methods send 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.

Incremental Methods Closed

The following methods are available for incremental data fetch.

GetPatientChangesV2
GetPatientAuthorizationsChanges
GetDeletedPatientAuthorizations
GetCareGiverChangesV2
GetVisitChangesV2

Get Patient Changes V2 Closed

Retrieves Patient information from Patient records modified after a given date/time.

Request Data: 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.

Possible Format:

YYYY-MM-DD
YYYY-MM-DDTHH:MM:SS
YYYY-MM-DDTHH:MM:SS.MSS

Required

Date/Time

Response Data: 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.

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 inHHAeXchange.	Number
PatientID	Unique ID of the Patient in HHAeXchange.	Number
ModifiedDate	Modified/Created time in UTC. Format: YYYY-MM-DD	Date/Time
FirstName		String
MiddleName		String
LastName		String
StatusID	Possible Values: 1 - Waiting 5 - Discharged 2 - Pending 6 - Partially Pla 3 - Active 8 – Hold 4 - Hospitalized	Number
AdmissionID		String
MRNumber	Patient’s MR Number. (Displays as Patient ID in the application.)	String
Gender	Possible Values:Male or 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 Technical Support 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

Get Patient Changes V2 Result
Field	Description	Data Type
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 or 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 or 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 or No	String
Emergency Contact 1 HaveKeys	Possible Values: Yes or 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

Get Patient Changes V2 Result
Field	Description	Data Type
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 or No	String
Emergency Contact 2 Phone1	Possible Values: Yes or 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 Zones and corresponding ID by calling the GetEvacuationZones method as documented in the Reference Tables section.	Number
OtherEvacuationLocation		String
ElectricEquipmentDependenc y		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 or No	String
IsMutualLinked	Possible Values: Mutual or Link	String
MutualLinkPatientID	Mutual/Link Patient ID	Number
IsPrimaryPatient	Possible Values: Yes or No	String

Get Patient Changes V2 Result
Field	Description	Data Type
ServiceStartDate	Format: XXX-XXX-XXXX	Date
ProjectedDCDate	Format: XXX-XXX-XXXX	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 or 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
AllowedCaregiverAccessPatie ntInfoToMobileApp
Caregiver	List of Caregivers

Get Patient Changes V2 Result
Field	Description	Data Type
ID	Caregiver ID	Number
Name	Caregiver Name	String

Get Patient Authorization Changes Closed

Returns Patient Authorization Information changed/created after a specified date/time value.

Request Data: click here to view the SOAP request and response.

Get Patient Authorization Changes

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.

Possible Format:

YYYY-MM-DD
YYYY-MM-DDTHH:MM:SS YYYY-MM-DDTHH:MM:SS.MSS

Required

Date/Time

Response Data: 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.

Get Patient Authorizations Result
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

Get Patient Authorizations Result
Field	Description	Data Type
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
ProviderNumber	ProviderNumber	Number

Get Deleted Patient Authorizations Closed

Returns list of patient authorizations deleted after a specified date/time value.

Request Data: click here to view the SOAP request and response.

Get Deleted Patient Authorizations Request

Field

Description

Type

Data Type

ModifiedAfter

Specify a date/time value in EST to retrieve rows deleted after the given time.

Possible Format:

YYYY-MM-DD
YYYY-MM-DDTHH:MM:SS
YYYY-MM-DDTHH:MM:SS.MSS

Required

Date/Time

Response Data: 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.

Get Deleted Patient Authorizations Result
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

Get Deleted Patient Authorizations Result
Field	Description	Data Type
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

Get Caregiver Changes V2 Closed

Returns Caregiver information created or modified after a given date/time value.

Request Data: click here to view the SOAP request and response.

Get Caregiver 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 after the given time.

Possible Format:

YYYY-MM-DD
YYYY-MM-DDTHH:MM:SS
YYYY-MM-DDTHH:MM:SS.MSS

Required

Date/Time

Response Data: 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.

Get Caregiver Changes V2 Result
Field	Description	Type
AgencyID	ID of the Agency in HHAeXchange	Number
OfficeID		Number
CaregiverID	Unique ID of the Caregiver in HHAeXchange	Number
ModifiedDate	Modified/Created time Format: YYYY-MM-DD HH:MM:SS.MSS	String
FirstName		String
MiddleName		String
LastName		String
Initials		String
Gender	Possible Values: Male or Female	String
DateofBirth	Format: YYYY-MM-DD	String
CaregiverCode		String
TimeAndAttendancePIN	IVR ID for Time & Attendance	String
AlternateCaregiverCode		String
SSN		String
Ethnicity	Possible Values: White · Native Hawaiian Black · Unknown Hispanic · Two or More Races American Indian · Caribbean Indian Asian · Pacific Islander	String

Get Caregiver Changes V2 Result
Field	Description	Type
CaregiverMobileID	Caregiver Mobile ID	String
CaregiverMobileIDType	Caregiver’s Mobile ID type	String
Rehire	Caregiver is Rehire or Not Possible Values: Yes or No	String
RehireDate	Caregiver Rehire Date	String
CountryofBirth		String
MaritalStatus	Possible values: S (Single) or M (Married)	String
Dependents		String
EmployeeType	Possible Values: A (Applicant) or E (Employee)	String
Status	Possible Values: Inactive On Leave Active Terminated Hold Rejected	String
StatusReason	It is Applicable for all statuses and for applicant and employee types. Retrieve a list of Status Reasons by calling the GetStatusReasonsForCaregiver method as documented in the Reference Tables section.	Number
StatusNote	Applicable only if the status is not Active.	String
TerminatedDate	Only Applicable if Status is Terminated.	String
EmploymentTypes	List of the Disciplines For example: HHA, PCA, HSK	String
Sent105	Only Applicable if Status is Terminated. Possible values: Y (Yes) or N (No)	String
EmployeeID		String
ApplicationDate	Format: YYYY-MM-DD	String
TeamID	Retrieve a list of Caregiver Teams by calling the GetCaregiverTeams method documented in the Reference Tables section.	Number
LocationID	Retrieve a list of Locations by calling the GetLocations method documented in the Reference Tables section.	Number
BranchID	Retrieve a list of Branches by calling the GetBranches method documented in the Reference Tables section.	Number
Payer		String
Registrynumber		String
RegistryDate	Date the Caregiver information was entered/checked in the registry. Format: YYYY-MM-DD.	String
ReferralSourceID	Retrieve a list of Referral Sources by calling the GetCaregiverReferralSources method documented in the Reference Tables section.	Number
ReferralPerson		String

Get Caregiver Changes V2 Result
Field	Description	Type
SignedPayrollAgreement	Possible values: Y (Yes) or N (No)	String
SignedPayrollAgreementDate	Format: YYYY-MM-DD	String
ExclusionListCheckedOn	Format: YYYY-MM-DD	String
ExclusionListStatus	Possible values: Y (Yes) or N (No)	String
Address Street1		String
Address Street2		String
Address City		String
Address State		String
Address Zip5		String
Address Zip4		String
Address HomePhone	Format: XXX-XXX-XXXX	String
Address Phone2	Format: XXX-XXX-XXXX	String
Address Phone3	Format: XXX-XXX-XXXX	String
EmergencyContact1 Name		String
EmergencyContact1 Address		String
EmergencyContact1 RelationshipID	Retrieve a list of valid Relationships with corresponding ID by calling the GetEmergencyContactRelationships method documented under the Reference Tables section.	Number
EmergencyContact1 RelationshipName		String
EmergencyContact1 RelationshipOther	Only Applicable if Emergency1RelationshipName1 is Other.	String
EmergencyContact1 Phone1	Format: XXX-XXX-XXXX	String
EmergencyContact1 Phone2	Format: XXX-XXX-XXXX	String
EmergencyContact2 Name		String
EmergencyContact2 Address		String
EmergencyContact2 RelationshipID	Retrieve a list of valid Relationships with corresponding ID by calling the GetEmergencyContactRelationships method documented under the Reference Tables section.	Number
EmergencyContact2 RelationshipName		String
EmergencyContact2 RelationshipOther2	Only Applicable if Emergency1RelationshipName1 is Other.	String
EmergencyContact2 Phone1	Format: XXX-XXX-XXXX	String
EmergencyContact2 Phone2	Format: XXX-XXX-XXXX	String

Get Caregiver Changes V2 Result
Field	Description	Type
Notification MethodID	Method ID– Call GetCaregiverNotificationMethods to get a list of possible values.	Number
Notification Email		String
Notification MobileOrSMS	Format: XXX-XXX-XXXX	String
Notification VoiceMail	Format: XXX-XXX-XXXX	String
HireDate	Caregiver’s Hire Date	String
I9ABDocumentID	Retrieve a list of I9 Document Types by calling the GetI9Documents method documented in the Reference Tables section.	Number
I9CDocumentID	Name of the secondary I9 document	Number
I9DocumentExpiration	I9 Expiration Date Format: YYYY-MM-DD.	String
I9Verified	Possible values: Y (Yes) or N (No)	String
I9Notes	Notes	String
I9EVerifyNumber	I9 Verify Number	String
ProfessionalLicensenumber		String
NPInumber		String
Language1	Retireve a list of Languages by calling the GetLanguages method documented in the Reference Tables section.	Number
Language2	Retireve a list of Languages by calling the GetLanguages method documented in the Reference Tables section.	Number
Language3	Retireve a list of Languages by calling the GetLanguages method documented in the Reference Tables section.	Number
Language4	Retireve a list of Languages by calling the GetLanguages method documented in the Reference Tables section.	Number
Other		String
FirstWorkDate	First work day of caregiver	String
LastWorkDate	Last work day of caregiver	String
TimeZone	TimeZone of caregiver	String

Get Visit Changes V2 Closed

Returns Visit changed/created after a specified date/time value.

Request Data: click here to view the SOAP request and response.

Get Visit Changes V2 Request

Field

Description

Type

Data Type

ModifiedAfter

Specify a date/time value in EST to retrieve rows modified/created after the given time.

Possible Format:

YYYY-MM-DD
YYYY-MM-DDTHH:MM:SS
YYYY-MM-DDTHH:MM:SS.MSS

Required

Date/Time

Response Data: 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.

Get Visit Changes V2 Result
Field	Description	Data Type
VisitID	Unique Visit ID	Number
LastModifiedDate	Last Modified Date of Visit/Schedule Format: YYYY-MM-DD HH:MM	DateTime
OfficeID	Office ID	Number
VisitDate	Visit Date	String
Patient ID	Patient ID	Number
AdmissionNumber	Admission Number	Number

Get Visit Changes V2 Result
Field	Description	Data Type
FirstName	Patient First Name	String
LastName	Patient Last Name	String
Caregiver ID	Caregiver ID	Number
FirstName	Caregiver First Name	String
LastName	Caregiver Last Name	String
TimeAndAttendancePIN	Time And Attendance PIN	Number
PayCode	Pay Code	Number
ScheduleStartTime	Schedule Start Time Format: YYYY-MM-DD HH:MM	String
ScheduleEndTime	Schedule End Time Format: YYYY-MM-DD HH:MM	String
VisitStartTime	Visit Start Time Format: YYYY-MM-DD HH:MM	String
VisitEndTime	Visit End Time Format: YYYY-MM-DD HH:MM	String
EVVStartTime	EVV Start Time Format: YYYY-MM-DD HH:MM	String
EVVEndTime	EVV End Time Format: YYYY-MM-DD HH:MM	String
IsMissedVisit	Visit Missed or Not Value: Yes or No	String
TTOT Hours	Approved Travel Time Hours	Number
TTOT Minutes	Approved Travel Time Minutes	Number

Get Visit Changes V2 Result
Field	Description	Data Type
VerifiedBy	Verified By	String
Notes	Notes	String
VerifiedDate	Verified Date	DateTime
VerifiedTime	Verified Time	String
SupervisorName	Supervisor Name	String
Timesheet Required	TimeSheet Required: Yes or No	String
Timesheet Approved	TimeSheet Required: Yes or No	String
POCTaskCode	POC Task Code	Number
AdditionalValue	Additional Value	Number
Status	Status (Duties Performed/ Duties Refused/ Duties Not Performed)	String
Category	Category	String
Duty	Duty	String
Minutes	Minutes	Number
VisitType	VisitType	String
ScheduleDurationHours	Schedule Duration Hours Format: HH	Number
ScheduleDurationMinutes	Schedule Duration Minutes Format: MM	Number

Get Visit Changes V2 Result
Field	Description	Data Type
ClockInEvvType	Clock In EVV Type	String
ClockOutEvvType	Clock Out EVV Type	String
BilledAmount	Returns TotalBillingAmount only if service code is dollar based service code for that visit.	Number
Budget Number	Returns budget number value.	Number
ActualHours	Returns ActualHours value	String
ActualHoursRounded	Returns ActualHoursRounded value	String
PayHours	Returns PayHours value	String
PayHoursUnrounded	Returns PayHoursUnrounded value	String
AdjustedHours	Returns AdjustedHours value. Format: HHMM	String
TimeZone	TimeZone	String

Reference Tables Closed

This section provides an overview of the web methods available to interact with Reference Tables. Please click on the method name to view the SOAP request and response.

Reading Reference Table Information Closed

Method	Description/Returns…
GetCoordinators	A list of Coordinators Matching the Search Criteria
GetPatientDisciplines	A list of Available Patient Disciplines That are Assigned To the Profile
GetEmergencyContactRelationships	A list of Valid Entries for Emergency Contact Relationships
GetBillingServiceCodes	A list of Billing Service Codes
GetLanguages	A list of Languages for Patient and Caregiver
GetContracts	A list of Patient Contracts
GetContractServiceCode	A list of Service Codes for Given Contract
GetDisciplines	A list Available Disciplines
GetOffices	A list of Available Offices
GetGenders	A list of Available Patient Genders
GetCaregiverGender	A list of Available Caregiver Genders
GetPatientDischargeTo	A list of Patient Discharged To
GetContractDischargeReason	A list of Patient Contract Discharge Reason
GetStatusReasonsForCaregiver	A list of Status Reasons for Caregiver
GetCaregiverPayCodes	A list of Caregiver Pay Codes
GetScheduleBillInfoEditReasons	A list of Schedule Bill Info Edit Reasons
GetEthnicity	A list of Caregiver Ethnicity
GetSourceOfAdmissions	A list of Patient Admission Source
GetVisitDeleteReasons	Retrieve Visit Delete reason for a Visit ID
GetPatientAddress	Retrieve Address ID(s) for Patient