API Error Messages

If you require assistance with interpreting these error messages or the action that is required to rectify the issue, contact 3rd Party Integration Support Desk with the subject "State Abbreviation" API Technical Support Request.

Element	Error Code	Error Message	Action
providerTaxID	102001	Provider Tax ID is required	Include the Provider Federal Tax ID and call API.
providerTaxID	102002	Provider is not found based on Provider Tax ID	The Provider was not found. Provide the correct federal Tax ID and call API.
providerTaxID	102003	Provider is not active	Use a Provider that is active and call API.
providerTaxID	102004	Invalid Provider Tax ID format	Review the EVV Data Aggregator Specification and confirm that your data is in the required format. Make the required changes and call API.
qualifier	102005	Invalid Qualifier value	Correct the Caregiver's Qualifier and call API.
qualifier	102006	Multiple Caregiver records found based on Qualifier value. Please provide unique identifier	Use a Caregiver Qualifier that is unique for this Caregiver and call API.
externalID	102007	Unique Caregiver identifier in the external system is required	Include the External ID and call API.
Ssn	102008	Caregiver's SSN is required	Include the Caregiver's SSN and call API.
Ssn	102009	Invalid Caregiver's SSN format	Review the EVV Data Aggregator Specification and confirm that your data is in the required format. Make the required changes and call API.
dateOfBirth	102010	Caregiver's Date of Birth is required	Include the Caregiver's Date of Birth and call API.
dateOfBirth	102011	Caregiver's Date of Birth value should be less than current date	The Caregiver's Date of Birth is using a date in the future. Resolve issue and call API.
lastName	102012	Caregiver's Last Name is required	Include the Caregiver's Last Name and call API.
firstName	102013	Caregiver's FirstName is required	Include the Caregiver's First Name and call API.
gender	102014	Caregiver's Gender Is required	Include the Caregiver's Gender and call API. If you do not wish to send the gender, enter ‘Other’.
gender	102015	Invalid Caregiver's Gender value	Correct the Caregiver's Gender and call API. If you do not wish to send the gender, enter ‘Other’.
email	102016	Invalid Caregiver's Email Format	Review the EVV Data Aggregator Specification and confirm that your data is in the required format. Make the required changes and call API.
phoneNumber	102017	Invalid Caregiver's Phone Number Format	Review the EVV Data Aggregator Specification and confirm that your data is in the required format. Make the required changes and call API.
Type	102018	Caregiver's Type is required	Include the Caregiver's Type and call API.
type	102019	Invalid Caregiver's Type value	Correct the Caregiver's Type and call API.
type	102020	You cannot change the type of a Caregiver that has been previously assigned to a visit.	Correct the Caregiver's Type and call API.
professionalLicenseNumber	102021	Caregiver's Professional License Number is required	Include the Caregiver's Professional License Number and call API.
hireDate	102022	Caregiver's Hire Date is required	Include the Caregiver's Hire Date and call API.
state	102023	State is required	Include the Caregiver's State and call API.
zipcode	102024	ZIP Code is required	Include the Caregiver's ZIP Code and call API.
zipcode	102025	Invalid ZIP Code format	Review the EVV Data Aggregator Specification and confirm that your data is in the required format. Make the required changes and call API.
client_id	102026	Records that are created with a specific ClientID must be updated using the same ClientID	Call API with correct ClientID.
client_id	102027	ClientID does not have access permission to update the Provider's Caregiver record	Resolve permission issue.
ssn	102028	Caregiver with same SSN already exists.	Provide unique Caregiver SSN or default SSN value (999999999) and call API.
externalID	102029	Length of the External ID cannot exceed 20 characters	Correct the External ID value and call API.
Unknown	102999	Can occur if there is an interruption in service.	Contact HHAeXchange to inquire and to determine the resolution.

EVV Error Messages Closed

If you require assistance with interpreting these error messages or the action that is required to rectify the issue, contact 3rd Party Integration Support Desk with the subject 'State Abbreviation' API Technical Support Request.

Element	Error Code	Error Message	Action
providerTaxID	101001	Provider Tax ID is required	Include the Provider Federal Tax ID and call API.
providerTaxID	101002	Provider is not found based on Provider Tax ID	The Provider was not found. Provide the correct federal Tax ID and call API.
providerTaxID	101003	Provider is not active	Contact HHAeXchange to rectify this issue.
providerTaxID	101004	Invalid Provider Tax ID format	Review the EVV Data Aggregator Specification and confirm that your data is in the required format. Make the required changes and call API.
office	101005	Office (qualifier and identifier) is required	Include Office (qualifier and identifier) and call API.
office	101006	Invalid Office’s Qualifier value	Correct the Office's Qualifier and call API.
office	101007	Office is not found based on Qualifier value	Office was not found. Provide the correct Qualifier value and call API.
office	101008	Office is not active	Contact HHAeXchange to rectify this issue.
office	101009	Multiple Office records found based on Qualifier value. Please provide unique identifier.	Use an Office Qualifier that is unique for this Office and call API.
member	101010	Member (qualifier and identifier) is required	Include Member (qualifier and identifier) and call API.
member	101011	Invalid Member's Qualifier value	Correct the Member's Qualifier and call API.
member	101012	Member is not found based on Qualifier value	Member was not found. Provide the correct Qualifier value and call API.
member	101013	Member is not active	Contact operating agency and determine why Member is not active. Once the issue is resolved call API.
member	101014	Multiple Member records found based on Qualifier value. Please provide unique identifier.	Use a Member Qualifier that is unique for this Member and call API.
caregiver	101015	Caregiver (qualifier and identifier) is required	Include Caregiver (qualifier and identifier) and call API.
caregiver	101016	Invalid Caregiver's Qualifier value	Correct the Caregiver's Qualifier and call API.
caregiver	101017	Caregiver is not found based on Qualifier value	Provide the correct Qualifier value and call API.
caregiver	101018	Caregiver is not active	Change the Caregiver status to Active and call API.
caregiver	101019	Caregiver is not linked with Provider	Link the Caregiver to the Provider and call API.
caregiver	101020	Multiple Caregiver records found based on Qualifier value. Please provide unique identifier.	Use a Caregiver Qualifier that is unique for this Caregiver and call API.
caregiver	101021	Visit cannot be greater than 25 hours	Change the Visit duration to be less than or equal to 25 hours and call API. Please note, Alabama Medicaid has a maximum check out window in place per service code. Even though, the allowable schedule duration cannot exceed 25 hrs in the system; Alabama Medicaid will determine the visit as compliant based on the maximum check out window set for each service code. This information can be referenced in the policies and procedures contract given to the provider agency.
caregiver	101022	Caregiver is restricted. No Schedule can be created.	Caregiver cannot provide services until Payer removes Caregiver from the Restriction List. Resolve the issue and call API.
caregiver	101023	Caregiver was previously declined by the patient	Resolve the issue with the Caregiver and call API.
caregiver	101024	Caregiver is marked as absent	Resolve the issue with the Caregiver and call API.
payerID	101025	Payer ID is required	Include the Payer ID and call API.
payerID	101026	Invalid Payer ID value	Correct the Payer ID and call API.
payerID	101027	Payer is not active	Contact HHAeXchange to rectify this issue.
payerID	101028	There is no active contract for this visit	If Member is Active for the time for which you are billing, then contact the Operating Agency and request to Start of Care plan date and/or Discharge date.
externalVisitID	101029	External VisitID is required	Include External Visit ID and call API.
evvmsid	101030	EVVMSID is required when EVV record needs to be updated	Include EVVMSID and call API.
evvmsid	101031	EVVMSID is not found	Confirm that the EVVMSID submitted matches the EVVMSID in the HHAeXchange system and call API.
evvmsid	101032	EVVMSID does not belong to this payer	Use a EVVMSID that is linked with this Payer and call API.
evvmsid	101033	EVVMSID does not belong to this provider	Use a EVVMSID that is linked with this Provider and call API.
procedureCode	101034	Procedure Code is required	Include Service/Procedure Code and call API.
procedureCode	101035	Procedure Code is not found	Confirm that the Service/Procedure Code submitted matches the Service/Procedure Code in HHAeXchange. Correct the issue and call API.
procedureCode	101036	Procedure Code is not active	Contact HHAeXchange to rectify this issue.
procedureCode	101037	The service type was set to either Skilled or Non-Skilled for this visit when created and cannot be changed.	The incorrect Service Type was used for the EVVMSID. Correct the issue and call API.
procedureCode	101038	Procedure Code is not mapped to Caregiver's Discipline	Contact HHAeXchange to rectify this issue.
procedureModifierCode	101039	Maximum 4 Procedure Modifier codes are allowed.	Correct the Procedure Modifier Codes and call API.
timezone	101040	Time zone is required	Include Time zone and call API.
timezone	101041	Invalid Time zone value	Correct the Time zone and call API.
scheduleStartTime	101042	Schedule Start Time is required	Include the Schedule Start Time and call API.
scheduleEndTime	101043	Schedule End Time is required	Include Schedule End Time and call API.
scheduleStartTime/EndTime	101044	Schedule cannot be greater than 24 hours	Change the Schedule duration to be less than or equal to 24 hours and call API. Please note, Alabama Medicaid has a maximum check out window in place per service code. Even though, the allowable schedule duration cannot exceed 24 hrs in the system; Alabama Medicaid will determine the visit as compliant based on the maximum check out window set for each service code. This information can be referenced in the policies and procedures contract given to the provider agency.
scheduleStartTime/EndTime	101045	Schedule duration is 0	Schedule Start and End Time should not have the same value. Correct the issue and call API.
visitStartDateTime	101046	Visit Start Time is required when Visit End Date Time OR EVV Clock In Time is provided	Include Visit Start Time and call API.
visitStartDateTime	101047	Visit Start Time cannot be greater than current date	The Visit Start Time is using a time in the future. Resolve issue and call API.
visitEndDateTime	101048	Visit End Time is required when “EVV Clock Out Time” is provided	Include Visit End Time and call API.
visitEndDateTime	101049	Visit End Time cannot be greater than current date	The Visit End Time is using a time in the future. Resolve issue and call API.
visitEndDateTime	101050	Visit End Time must be greater than Visit Start Date Time	Resolve the issue and call API.
visitStartDateTime/EndDateTime	101051	Visit duration is 0	EVV Start and End Time should not have the same value; this might be an export issue. Consult with your third-party provider and advise of the issue. Make the required changes and call API.
evv > clockIn/Out	101052	Once EVV Clock In/Out is completed, then change in EVV Clock In/Out is not allowed in subsequent requests	Delete the visit and resubmit.
evv > clockIn/Out	101053	If the EVV Clock Out is provided, then the EVV Clock In is mandatory	Add the EVV Clock Into the Visit with Clock Out and call API.
evv > clockIn/Out	101054	Once visit is confirmed manually, then EVV Clock In/Out is not allowed in subsequent requests	Delete the visit and resubmit.
evv > clockIn/Out > callType	101055	Call Type is required when EVV Clock In/Out Time is confirmed via EVV	Include Call Type and call API.
evv > clockIn/Out > callType	101056	Invalid Call Type value	Correct the Call Type and call API.
evv > clockIn/Out > callLatitude	101057	Call Latitude is required when EVV Clock In/Out Time is confirmed by GPS (i.e., CallType = Mobile)	Include Call Latitude and call API.
evv > clockIn/Out > callLatitude	101058	Invalid Call Latitude value	Correct the Call Latitude and call API.
evv > clockIn/Out > callLongitude	101059	Call Longitude is required when EVV Clock In/Out Time is confirmed by GPS (i.e., CallType = Mobile)	Include Call Longitude and call API.
evv > clockIn/Out > callLongitude	101060	Invalid Call Longitude value	Correct the Call Longitude and call API.
evv > clockIn/Out > originatingPhoneNumber	101061	Originating Phone Number is required when EVV Clock In/Out Time is confirmed by Telephony (i.e., CallType = Telephony)	Include Originating Phone Number and call API.
evv > clockIn/Out > originatingPhoneNumber	101062	Invalid Originating Phone Number format	Review the EVV Data Aggregator Specification and confirm that your data is in the required format. Make the required changes and call API.
evv > clockIn/Out > serviceAddress	101063	Service Address is required when EVV Clock In/Out Time is confirmed via EVV	Include Service Address and call API.
evv > clockIn/Out > serviceAddress > addressLine1	101064	AddressLine1 is required when EVV Clock In/Out Time is confirmed via EVV	Include Address Line 1 and call API.
evv > clockIn/Out > serviceAddress > city	101065	City is required when EVV Clock In/Out Time is confirmed via EVV	Include City and call API.
evv > clockIn/Out > serviceAddress > state	101066	State Code is required when EVV Clock In/Out Time is confirmed via EVV	Include State Code and call API.
evv > clockIn/Out > serviceAddress > zipcode	101067	ZIP Code is Required when EVV Clock In/Out Time is confirmed via EVV	Include ZIP Code and call API.
evv > clockIn/Out > serviceAddress > zipcode	101068	Invalid ZIP Code format	Review the EVV Data Aggregator Specification and confirm that your data is in the required format. Make the required changes and call API.
evv > clockOut > performedTasks	101070	Invalid Duties (Performed Task/Refused Task) field value	Correct the value in the Duties field and call API.
missed	101071	A missed visit request must not contain Clock In/Out information	Remove Clock In/Out information and call API.
missedVisit > reasonCode	101072	Missed Visit Reason Code is required when Missed flag is marked as True	Include Missed EVV Reason Code and call API.
missedVisit > reasonCode	101073	Invalid Missed Visit Reason Code value	Correct the Missed Visit Reason Code and call API.
missedVisit > reasonCode	101074	Missed Visit Reason Code is not active	Contact HHAeXchange to rectify this issue.
missedVisit > actionCode	101075	Missed Visit Action Code is required when Missed flag is marked as True	Include Missed EVV Action Code and call API.
missedVisit > actionCode	101076	Invalid Missed Visit Action Code value	Correct the Missed Visit Action Code and call API.
missedVisit > actionCode	101077	Missed Visit Action Code is not active	Contact HHAeXchange to rectify this issue.
missedVisit > comment	101117	Missed Visit Reason Note is Required	Update visit with note in host system and resend to HHAeXchange.
missedVisit > comment	101119	Missed Visit Reason Note Length is Insufficient	Update visit note length to the appropriate length (256 characters) in host system and resend to HHAeXchange.
editVisit > reasonCode	101078	Edit Visit Reason Code is required	Include Edit Visit Reason Code and call API.
editVisit > reasonCode	101079	Invalid Edit Visit Reason Code value	Correct the Edit Visit Reason Code and call API.
editVisit > reasonCode	101080	Edit Visit Reason Code is not active	Contact HHAeXchange to rectify this issue.
editVisit > actionCode	101081	Edit Visit Action Code is required	Include Edit Visit Action Code and call API.
editVisit > actionCode	101082	Invalid Edit Visit Action Code value	Correct the Edit Visit Action Code and call API.
editVisit > actionCode	101083	Edit Visit Action Code is not active	Contact HHAeXchange to rectify this issue.
editVisit > comment	101118	Edit Visit Reason Note is Required	Update visit with note in host system and resend to HHAeXchange.
editVisit > comment	101120	Edit Visit Reason Note Length is Insufficient	Update visit note length to the appropriate length (256 characters) in host system and resend to HHAeXchange.
Shift Overlap	101085	Another Visit is using the same time in full or in part	Overlapped Shift times are not allowed. Correct the times so they are not sharing the same time.
Visit	101086	Visit is already billed	If you are attempting to edit the visit, and the visit has been billed in HHAeXchange, this action is not allowed. Adjustments would need to be re-billed to the Payer.
Batch Visits	101087	The number of input records exceed the max limit per submission	Reduce the records being submitted in batch to be less than or equal to 100 and call API.
Visit	101088	Visit date is not in range of Eligibility Start and End date	Call API with correct date.
client_id	101089	Records that are created with a specific ClientID must be updated using the same ClientID	Call API with correct ClientID.
client_id	101090	ClientID does not have access permission to update the Provider's Visit record	Resolve permission issue.
Visit	101091	Schedule Date should be the visit day or the next day of the visit (inclusive of EVV)	Correct the Schedule, Visit and EVV Start/End date and/or time and call API.
member	101092	Length of the Member’s Identifier cannot exceed max characters of the Qualifier. Refer to the endpoint description for this field	Correct the Member’s Identifier value and call API.
caregiver	101093	Length of the Caregiver’s Identifier cannot exceed max characters of the Qualifier. Refer to the endpoint description for this field	Correct the Caregiver’s Identifier value and call API.
externalVisitID	101094	Length of the External Visit ID cannot exceed 30 characters	Correct the External Visit ID value and call API.
EVVMSID	101095	Length of the EVVMSID cannot exceed 64 characters	Correct the EVVMSID value and call API.
EVVMSID	101096	The external evvmsid contains invalid characters. Please only use alphanumeric characters in addition to '-' and '_'	Correct the EVVMSID value and call API.
Unknown	101999	Can occur if there is an interruption in service	Contact HHAeXchange to inquire and to determine the resolution.
employerInternalNumber	101122	Invalid Employer Internal Number Length	Max Length for Employer Internal Number is up to 10 characters
employerName	101123	Invalid Employer Name Length	Max Length for Employer Name is up to 10 characters