API Error Message Reference

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.

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

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).

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.

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.

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.

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).

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.

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

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

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

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

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.

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

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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.

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

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

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