Appointment Charge Entry Not Required Reasons

The Appointment Charge Entry Not Required Reasons feature will provide a facility to the user to indicate when a charge entry is not required for an appointment. The Appointment Charge Entry Not Required Reason Reference allows the user to specify the reason when an appointment does not require charge entry.

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

Endpoints

Add indicator that charge entry is not required on appointment

POST
/v1/{practiceid}/appointments/{appointmentid}/chargeentrynotrequired
Update the appointment record to indicate charge entry is not required
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
appointmentid integer appointmentid
Content-Type string Content type of the payload

❙ Request Body

Expand all
athenausername string athenaNet username of the person marking this appointment as not requiring charge entry.
chargeentrynotrequiredreason string Reason that this appointment is being marked as not requiring charge entry. This reason is specific to each practice and must be configured by that practice in athenaNet. The reasons, with descriptions, can be listed with the /configuration/appointments/chargeentrynotrequiredreasons endpoint.

Output Parameters

Expand all
errormessage string If success is false this is a field that may provide additional details.
success string Notes successfully marking the appointment as not requiring charge entry.
Example Code

Get list of charge entry not required reasons

GET
/v1/{practiceid}/configuration/appointments/chargeentrynotrequiredreasons
Returns a list of valid reasons to mark an appointment as charge entry not required. These reasons will be valid values for the NOBILLINGSLIPCANCELREASON field when posting.
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
limit integer Number of entries to return (default 1500, max 5000)
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
description string A more verbose name that may provide a little more detail.
reason string Reason to mark appointment as charge entry not required.
Example Code