API Error Message Reference

Error messages will have an "error" and, sometimes, a "detailedmessage". Some calls may even return additional information (such as missing fields) for the use of the developer. Only the error itself, however, should be displayed to an end user.

Some errors may come directly from API Gateway before they reach athenaNet. These errors are outlined here. They generally have no JSONed content, where responses from the backend will have JSON explanations.

Below is a comprehensive list of potential REST API error codes.

4XX Error Messages

Code Public Message Details
400 No CDS subscription found. There is no CDS subscription to the specified hook.
400 Invalid encounter diagnosis SNOMED code. The specified diagnosis SNOMED code does not exist in the given encounter.
400 Practice is not configured correctly.

There is an issue with the configuration of the practice. This may likely be a configuration setting which needs to be turned off or on.

400 Unable to update CDS partner configuration as one does not exist.

A CDS partner configuration must be created before CDS partner settings may be updated. Use POST to create a CDS partner configuration.

400 One or more of the provided app urls is malformed.  
400 The analytes for this point of care test cannot be updated.  
400 Invalid attachment type id. This error occurs when an invalid attachment type is provided.
400 Secondary insurance without primary.

There must be a primary insurance package in place prior to adding a secondary insurance pacakge. When adding a secondary insurance, the first insurance should not be self-pay (package id 0).

400 Invalid clinical order type id. The clinical order type id specified doesn't exist.
400 Unable to verify the provided test signature.

athenahealth is unable to verify the test signature using the provided public key. Make sure the test signature is base64 encoded and generated using the sha512 algorithm signing the CDS partner 'name' with the private key.

400 Unable to attach uploaded document.

This attachment was unable to be attached. This is most often because the file is encrypted, but it can also occur when a PDF has DOS line feeds.

400 Only open or in review encounters can be modified. Only open or in review encounters can be modified.
400 This insurance is not eligible for this operation.  
400 The form submitted had an invalid structure. The JSON posted for the health history form content is invalid.
400 Only pend, open or in review encounters can be modified. Only pend, open or in review encounters can be modified.
400 Invalid document attachment. Check attachment type.  
400 The document subclass being created is invalid.  
400 The provided version is not valid. The provided CDS hooks version is not valid.
400 Additional fields are required.

This is used when fields are required for a particular call. There are circumstances where fields aren't technically required, but a combination of fields together are required. The details for these contiditions can be found on the individual documentation pages for each resource.

400 The data provided is invalid.

This occurs if arguments are provided, but there is a problem with the validity of the data (e.g. end date before a start date).

400 Check-in requirements not met.

Not all of the items required before check-in have been completed yet. Use the GET version of the appointment check-in call to determine which sections are still incomplete.

400 The form submitted was in the wrong form (though in the correct structure).

The JSON posted for the health history form content was valid JSON, but not an array.

400 This endpoint is not yet available for this practice. Please see https://developer.athenahealth.com/docs/read/reference/Permissioned_Rollout_of_APIs for more information. This endpoint has not been activated for all practices.
400 The appointment is already frozen  
400 The request body contains invalid data.  
400 Invalid clinical order type group.

This error occurs when a document is not part of a valid order type group for the current request.

400 Unknown or invalid CDS hook. The CDS hook may not exist or is disabled for the specified practice.
400 The data provided is invalid.

The appointment confirmation ID does not match our list of valid confirmation statuses.

400 In general, dates must be mm/dd/yyyy. In general, dates must be mm/dd/yyyy.
400

For this document subclass, you must supply a valid appointment ID for a checked-in appointment.

 
400 The document is not associated with a corresponding clinical result.  
400 Unable to read the document attachment.  
400 Unable to perform the action because of the appointment's status. Occurs when the appointment status is not applicable for the action.
400 The data provided is invalid.

The reason ID provided, along with the department and provider, doesn't map to an actual appointment type in athenaNet. This ID should not appear in the list of appointment reasons for this department and provider.

400 Email is not set for this patient but must be for this call.  
400 Input is invalid.  
400

The appointment being used is checked-in but is not set up with an encounter.

 
400 Invalid encounterid. The encounterid you specified doesn't exist.
400 The document class used does not match the document with that ID.  
400 Required data is missing.  
400 For this document subclass, you must supply an appointment ID.  
400 Invalid form ID. This occurs if the portal form ID specified does not exist or is not active.
400 The appointment is already unfrozen  
400 One or more of the specified fields cannot be null.

There are certain fields that will cause an update to a CDS subscription to fail if their values stringify to the empty string.

400

You must use a valid appointmentcancelreasonid. For a list of valid IDs please call /appointmentcancelreasons.

 
400 Authorization denied for CCDA access.

Used when the caller does not yet have permission to access this patient's chart. This happens when patient consent is required for information sharing but has not yet been given.

400 Form validation failure. This occurs if Clinical Content form validation fails.
400 The form submitted contained invalid information.

The JSON posted for the health history form content was valid JSON, but had invalid internal information.

400 Invalid e-signature fields.

If an e-signature name is provided without a valid timestamp, or a timestamp is provided without a name, this error will occur.

400 The appointment provided already has an encounter, so a new encounter could not be created.

This occurs if the user tries to create an encounter for an appointment that already has an encounter.

400 Not able to save the data. Not able to save the data.
400 Invalid departmentid or departmentid/patientid combination.

The departmentid you specified either doesn't exist, or if used with a patientid, this means the patient does not exist in that department.

400 The interfacevendor ID is not set up for this API key.  
402 Incorrect permissions for 3-legged user. This occurs if there is a 3-legged authorization error.
402 Incorrect permissions.

This occurs if invalid credentials were received or if the API partner has not been given access to a particular client.

403 API is disabled.  
403 athenahealth fax system disabled push confirmations for the vendor. athenahealth fax system disabled push confirmations for the vendor.
403 Too many claims are requested.

Processing this request would be compute intensive since there are more claims than allowed.

403 Changed messages require setup (subscription) that has not been done. Changed message require subscribing first. This setup has not been done.
403 One or more required access scopes are missing.  
403 This call is not allowed against this practice ID.  
403 Invalid brand/chart combination.

The brand you specified either doesn't exist, or the brand does not have access to the requested chart.

403 The user is not authorized to call this endpoint for the given ID(s).  
404 Problem ID is invalid. Problem with supplied ID could not be found.
404 No data was found for this request  
404 Invalid chartsharinggroupid or chartsharinggroupid/patientid combination.

The chartsharinggroupid you specified either doesn't exist or the patient does not exist in that chartsharinggroup.

404 Invalid practice.  
404 No documents were found that meet the criteria specified.  
404 Provider ID is invalid. Provider is not allowed to create order group.
404 Invalid Feature  
404 The document is not currently available. This error occurs when a document is not in a valid state for the current request.
404 No feature version created for the toggle  
404 The appointment cannot be canceled at this time.

This error occurs when the patient is either checked-in or has already canceled an appointment.

404 Vaccine ID is invalid. Vaccine ID should be a number prefixed with an H (historical) or C (clinical) character.
404 The appointment is not available.  
404 Schedulerollout api cannot be used in the production environment.  
404 There is a conflict between the data provided and the data entered by the patient. There is a conflict between data provided by the user and data entered by the patient.
404 Invalid claim id. This error occurs when an invalid claim id is provided.
404

Family relation with this relation and relationkeyid combination could not be found.

 
404 No valid image was found.  
404 Invalid Feature Version for the toggle  
404 No insurance package is active at the sequence number given.  
404 An unknown API path was called. This occurs if the path specified is invalid.
404 The requested ID does not exist. The requested ID does not exist.
404 A void was attempted after the transaction was settled (or previously voided).

Voids may only happen until a payment is settled, typically around 8 pm Eastern nightly.

404 Invalid CVX code. You must supply a valid CVX code for the vaccine.
404 An incorrect API path was called. This occurs if the path specified does not contain a practice ID.
404 Patient ID is invalid. No patient exists with this ID.
404 Fax is not found in outbound fax queue table. Fax is not found in outbound fax queue table.
404 The data provided is invalid.

In the event of data not matching (e.g. patient ID and appointment ID don't agree), this is the error that is returned.

404 It is too late to cancel this appointment. There is not enough time between now and the appointment time to cancel.
406 There could be a possibility that a fax was delivered to a wrong destination. There could be a possibility that a fax was delivered to a wrong destination.
406 An unsupported Accept header was given. An unsupported Accept header was given.
406 Invalid If-Match header. Invalid If-Match header.
409 Duplicate PaymentBatch Requeue PaymentBatch already requeued
409 An existing contract has already been created for this patient/appointment.  
409 A conflict occurred with the current state of the target resource.

This occurs if there is a conflict with the current state of the target resource (e.g. duplicate data where none is allowed)

409 That appointment time was already booked. The detailed message will include if it was the same or a different patient.
409 Invalid Booking: No availability for this appointment type and duration No availability for this appointment type and duration
409 Invalid Booking: This patient cannot book this appointment Patient can't book this appointment
409 Cannot create a new CDS subscription as one already exists for this hook A CDS partner may only add one subscription per hook.
409

An existing insurance package exists. Use PUT to update or DELETE to deactivate.

 
409 Unable to create a CDS partner configuration because one already exists.

Marketplace partners may only have one CDS partner configuration. Once created, use PUT to update CDS partner settings.

409 Invalid Booking: This appointment type is not approved during your selected time for this provider. This appointment type is not approved during your selected time for this provider.
409 Invalid Booking: Rule violation

This appointment violates one of the rules in BusCall::Appointment::RunSchedulingRulesPipeline

409 That appointment time was already booked or not available for booking. The slot is already filled.
409 Multi-user conflict was detected.  
409 That appointment time was already booked. The detailed message will include if it was the same or a different patient.
410 The paymentbatch is already moved to next state The paymentbatch is already moved to next state
410 The appointment is not available.  
412 Failed to update due to not meeting the request condition. Failed to update due to not meeting the request condition.
412 Missing required If-Match header. Missing If-Match header.
429 This endpoint has been called too often or too recently. Please wait a while and try again.

When we're rate or time limiting a particular API. Usually used for resource-intensive calls.

 

5XX Error Messages

Code Public Message Details
500 There was an internal error getting appointments.  
500

An internal error has occurred while processing a payment transaction. If any payment transaction was initiated, it will be automatically reversed. Please consult front desk staff before re-attempting this transaction.

 
500 E-signature failure. There was an internal failure writing e-signature information.
500 Though an image was expected, we were unable to retrieve it.  
500 There was an internal error with updating clinical note tasks.  
500 There was an internal error handling this appointment.  
500 Unable to retrieve patient data.

There was an internal problem getting patient data. This may be transitory, but it may imply underlying data issues and athenahealth will need to be consulted.

500 There was an internal error creating the document.  
500 There was an internal error processing your Patient Identity Management Service request. An uncaught and uncategorized internal error occurred.
500 We were unable to void the transaction.

An unknown error while voiding; this can happen in some conditions while transactions are being settled.

500 Cannot delete a scheduled or non-existing appointment slot.  
500 There was an internal error with updating patient history.  
500 Could not create a rolloutwave for the given featurekey.  
500 There was an internal error getting stays.  
500

There was an internal error while auto-closing the document. No document was created.

 
500 An internal error has occurred.  
500

Unable to get check-in requirements for this department. At least one appointment must exist for this call to work.

 
500 There was an internal error connecting.  
500 There was an unknown internal error reading the document attachment.  
500 An internal error has occurred.  
500 There was an internal error while updating document(s).  
500 There was an internal error getting appointments.  
503 A concurrent request for changed messages was made.  

 

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit

On this Page