Appointment

The Appointment API feature allows the user to book a patient appointment with the provider, reschedule an existing appointment, cancel an existing appointment. This feature also allows the user to delete an existing appointment time slot of the Provider so that no patient can book an appointment in that time slot.

The Appointment Changed Subscription feature will allow the user to retrieve changes to appointments (generally scheduled, cancelled, check-in) or changes to the provider appointment slots. The user will need to subscribe. For more information about subscriptions, please refer Changed Data Subscriptions.

The athena Telehealth Room feature retrieves details for a valid native athenaTelehealth appointment. Be aware that the invite link is to an unauthenticated web app. Clients should first check if their appointment is a native athenaTelehealth appointment by using our single appointment endpoint GET /appointments/{appointmentid}, our appointment changed data subscription GET /appointments/changed, or our booked appointment slots endpoint GET /appointments/booked. The patient url and join token are only valid on the day of the appointment. Please communicate the device check link (https://telehealth.px.athena.io/device-check) in your patient messaging.

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

Submit

Endpoints

Primary

PUT

Book
appointment

GET

Get appointment
details

PUT

Cancel
appointment

PUT

Reschedule
appointment

GET

Gets the appointment id tied to the confirmation hash in the appointment confirmation
email

GET

Retrieve athenaone telehealth invite
url.

POST

Retrieve athenaone telehealth deep link join
url.
Subscription

GET

Get list of changes in appointment slots based on subscribed
events

GET

Get list of appointment slot change
subscription(s)

POST

Subscribe to all/specific change events for appointment
slots

DELETE

Unsubscribe to all/specific change events for appointment
slots

GET

Get list of appointment slot change events to which you can
subscribe

Book appointment

PUT

/v1/{practiceid}/appointments/{appointmentid}

Create a single appointment for specific patient

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

appointmenttypeid integer The appointment type to be booked. This field should never be used for booking appointments for web-based scheduling. The use of this field is reserved for digital check-in (aka "kiosk") or an application used by practice staff. One of this or reasonid is required.

bookingnote string A note from the patient about why this appointment is being booked

departmentid integer The athenaNet department ID.

donotsendconfirmationemail boolean For clients with athenaCommunicator, certain appointment types can be configured to have an appointment confirmation email sent to the patient at time of appointment booking. If this parameter is set to true, that email will not be sent. This should only be used if you plan on sending a confirmation email via another method.

ignoreschedulablepermission boolean By default, we allow booking of appointments marked as schedulable via the web. This flag allows you to bypass that restriction for booking.

insuranceinfo object Patient insurance information, which will be added to the note on the appointment.

nopatientcase boolean By default, we create a patient case upon booking an appointment for new patients. Setting this to true bypasses that patient case.

patientid integer The athenaNet patient ID.

reasonid integer The appointment reason ID to be booked. This field is required for booking appointments for web-based scheduling and is a reason that is retrieved from the /patientappointmentreasons call.

urgentyn boolean Set this field in order to set the urgent flag in athena (if the practice settings allow for this).

Output Parameters

Expand all

appointmentcopay string Detailed information about the copay for this appointment. Gives more detail than the COPAY field. Note: this information is not yet available in all practices, we are rolling this out slowly.

appointmentid string Appointment ID of the booked appointment

appointmentstatus string The athenaNet appointment status. There are several possible statuses. x=cancelled. f=future. (It can include appointments where were never checked in, even if the appointment date is in the past. It is up to a practice to cancel appointments as a no show when appropriate to do so.) o=open. 2=checked in. 3=checked out. 4=charge entered (i.e. a past appointment).

appointmenttype string The practice-friendly (not patient friendly) name for this appointment type. Note that this may not be the same as the booked appointment because of "generic" slots.

appointmenttypeid string This is the ID for the appointment type. Note that this may not be the same as the booked appointment because of "generic" slots.

chargeentrynotrequired string This field will tell if an appointment has been marked as not requiring change entry.

chargeentrynotrequiredreason string This field will give the reason that an appointment has been marked as not requiring charge entry.

claims array As detailed in /claims, if requested.

appointmentid string The appointment ID associated with this claim.

billedproviderid string The provider ID of the billing provider for this claim.

billedservicedate string The billed date of service.

chargeamount string The total amount billed for all services from this claim.

claimcreateddate string The date the claim was created.

claimid string athenaNet's internal ID for this claim, specific to the practice.

diagnoses array

Diagnoses is an array of all diagnoses. Each entry in the array is a hash with several fields. /ccda is a better clinical representation. These fields are:

patientpayer string The status and notes of a responsible payer. This payer is the patient.

primaryinsurancepayer string The status and notes of a responsible payer. This payer is the primary insurace.

procedures array

Procedures is an array of all procedures. /ccda is a better clinical representation. These fields are:

referringproviderid integer The referring provider ID for this claim. See /referringproviders. This is not the same as the ID from the /providers call.

secondaryinsurancepayer string The status and notes of a responsible payer. This payer is the secondary insurace.

transactiondetails string A hash of ids ("transactionid") to amounts; these should sum to the chargeamount. Please note that this has been deprecated in lieu of the data being available in the procedures section.

transactionid string A unique ID for the primary transaction this claim represents. May be useful for debugging.

copay string Expected copay for this appointment. Based on the appointment type, the patient's primary insurance, and any copays collected. To see the amounts used in this calculated value, see the APPOINTMENTCOPAY fields.

date string The appointment date.

departmentid string

duration integer In minutes

encounterid string The encounter id associated with this appointment, useful for certain other calls. Only present for appointments with Clinicals that have been checked in.

encounterprep string If true, encounter prep has been started for the encounter associated with this appointment.

encounterstate string The status of the clinical encounter associated with this appointment (OPEN, CLOSED, DELETED, PEND, etc.). This differs from encounterstatus, which refers to the status of the patient in the encounter.

encounterstatus string The status of this patient in the encounter (READYFORSTAFF, WITHSTAFF, READFORPROVIDER, CHECKEDOUT). Only present for appointments with Clinicals that have been checked in.

frozenyn string If true, this appointment slot is frozen

hl7providerid integer This is the raw provider ID that should be used ONLY if using this appointment in conjunction with an HL7 message and with athenahealth's prior guidance. It is only available in some situations.

insurances array List of active patient insurance packages. Only shown for single or multiple booked appointments if SHOWINSURANCE is set.

adjusterfax string CASE POLICY FIELD - Fax for the adjuster on this case policy. Only available for auto insurance or worker's comp case policies.

adjusterfirstname string CASE POLICY FIELD - First name of the adjuster on this case policy. Only available for auto insurance or worker's comp case policies.

adjusterlastname string CASE POLICY FIELD - Last name of the adjuster on this case policy. Only available for auto insurance or worker's comp case policies.

adjusterphone string CASE POLICY FIELD - Phone number/other contact info for the adjuster on this case policy. Only available for auto insurance or worker's comp case policies.

anotherpartyresponsibleyn string CASE POLICY FIELD - Boolean field indicating if another party was responsible for this accident.

autoaccidentstate string CASE POLICY FIELD - Two-letter abbreviation for the state in which the auto accident took place. Only meaningful for auto insurance case policies.

cancelled string The date in which the insurance was marked cancelled.

caseinjurydate string CASE POLICY FIELD - Date of the injury. Required for auto insurance, legal, and worker's comp case policies.

casepolicytypename string CASE POLICY FIELD - The name of this type of case policy.

ccmstatusid integer Status ID of current CCM enrollment.

ccmstatusname string The name of current CCM enrollment status.

coinsurancepercent number The coinsurance percentage for this insurance. If you've just POSTed a new insurance you will have to wait for the auto eligbility check before this field populates.

copays string Details about the copays for this insurance package. If you've just POSTed a new insurance you will have to wait for the auto eligbility check before these populate.

descriptionofinjury string CASE POLICY FIELD - A description of the injury. Only available for auto insurance and worker's comp case policies.

eligibilitylastchecked string Date the eligibility was last checked.

eligibilitymessage string The message, usually from our engine, of the eligibility check.

eligibilityreason string The source of the current status. Athena is our eligibility engine.

eligibilitystatus string Current eligibility status of this insurance package.

employerid string The employer ID associated with the patient's insurance.

expirationdate string Date the insurance expires.

icd10codes string CASE POLICY FIELD - See documentation for ICD9CODES.

icd9codes string CASE POLICY FIELD - A list of ICD9 accepted diagnosis codes. Only available for worker's comp case policies.

injuredbodypart string CASE POLICY FIELD - Text field for describing the injured body part. Only available for auto insurance and worker's comp case policies.

insuranceclaimnumber string CASE POLICY FIELD - The auto insurance claim number or the worker's comp claim number.

insuranceid string The athena insurance policy ID.

insuranceidnumber string The insurance policy ID number (as presented on the insurance card itself).

insurancepackageaddress1 string Address 1 for the AthenaNet insurance Package.

insurancepackageaddress2 string Address 2 for the AthenaNet insurance Package.

insurancepackagecity string City for the AthenaNet insurance Package.

insurancepackageid integer The athenaNet insurance package ID.

insurancepackagestate string State of the AthenaNet insurance package

insurancepackagezip string Zip code of the AthenaNet insurance package

insurancephone string The phone number for the insurance company. Note: This defaults to the insurance package phone number. If this is set, it will override it. Likewise if blanked out, it will go back to default.

insuranceplandisplayname string Superpackagename of the specific insurance package.

insuranceplanname string Name of the specific insurance package.

insurancepolicyholder string The full name of the insurance policy holder.

insurancepolicyholderaddress1 string The first address line of the insurance policy holder.

insurancepolicyholderaddress2 string The second address line of the insurance policy holder.

insurancepolicyholdercity string The city of the insurance policy holder.

insurancepolicyholdercountrycode string The country code (3 letter) of the insurance policy holder.

insurancepolicyholdercountryiso3166 string The ISO 3166 country code of the insurance policy holder.

insurancepolicyholderdob string The DOB of the insurance policy holder (mm/dd/yyyy).

insurancepolicyholderfirstname string The first name of the insurance policy holder. Except for self-pay, required for new policies.

insurancepolicyholderlastname string The last name of the insurance policy holder. Except for self-pay, required for new policies.

insurancepolicyholdermiddlename string The middle name of the insurance policy holder.

insurancepolicyholdersex string The sex of the insurance policy holder. Except for self-pay, required for new policies.

insurancepolicyholderssn string The SSN of the insurance policy holder.

insurancepolicyholderstate string The state of the insurance policy holder.

insurancepolicyholdersuffix string The suffix of the insurance policy holder.

insurancepolicyholderzip string The zip of the insurance policy holder.

insuranceproducttype string The athenaNet insurance product type.

insurancetype string Type of insurance. E.g., Medicare Part B, Group Policy, HMO, etc.

insuredentitytypeid integer The ID of the entity type for this insurance.

insuredidnumber string The insurance policy ID number of insured.

insuredpcp string

insuredpcpnpi integer The national provider id of the primary care physcian assicated with the insurance.

insuredreferringprovider string The referring provider that is associated with the insurance.

ircid integer Insurance category / company internal ID

ircname string Insurance category / company. E.g., United Healthcare, BCBS-MA, etc.

issuedate string Date the insurance was issued.

note string The athenaNet insurance notes.

policynumber string The insurance group number. This is sometimes present on an insurance card.

relatedtoautoaccidentyn string CASE POLICY FIELD - Boolean field indicating whether this case policy is related to an auto accident.

relatedtoemploymentyn string CASE POLICY FIELD - Boolean field indicating whether this case policy is related to the patient's employer.

relatedtootheraccidentyn string CASE POLICY FIELD - Boolean field indicating whether this case policy is related to another accident. Only available for worker's comp case policies.

relationshiptoinsured string This patient's relationship to the policy holder (text).

relationshiptoinsuredid integer This patient's relationship to the policy holder (as an ID). See the mapping.

repricername string CASE POLICY FIELD - Name for the repricer. Only available for worker's comp case policies.

repricerphone string CASE POLICY FIELD - Phone number for the repricer. Only available for worker's comp case policies.

sequencenumber integer 1 = primary, 2 = secondary, 3 = tertiary, etc. Must have a primary before a secondary and a secondary before a tertiary, etc.

slidingfeeplanid integer If the patient is on a sliding fee plan, this is the ID of that plan. See /slidingfeeplans.

stateofreportedinjury string CASE POLICY FIELD - Two-letter state abbreviation for the state this injury was reported in. Only available for worker's comp case policies.

patient string As detailed in /patients, if requested.

patientappointmenttypename string The patient-friendly name for this appointment type. Note that this may not be the same as the booked appointment because of "generic" slots.

patientid string The athenaNet patient ID for this appointment

patientlocationid string The location of the patient. See /patientlocation for practice list. Only present for appointments with Clinicals that have been checked in.

providerid string

referringproviderid integer The referring provider ID.

renderingproviderid integer The rendering provider ID.

rescheduledappointmentid string When an appointment is rescheduled, this is the ID of the replacement appointment.

startcheckin string The timestamp when the appointment started the check in process. If this is set while an appointment is still in status 'f', it means that the check-in process has begun but is not yet completed.

starttime string As HH:MM (where HH is the 0-23 hour and MM is the minute). This time is local to the department.

stopcheckin string The timestamp when the check-in process was finished for this appointment.

supervisingproviderid integer The supervising provider ID.

urgentyn string Urgent flag for the appointment.

useexpectedprocedurecodes array An array of expected procedure codes attached to this appointment.

Example Code

Get appointment details

GET

/v1/{practiceid}/appointments/{appointmentid}

Retrieves the details of a specific appointment. Note: This endpoint may rely on specific settings to be enabled in athenaNet Production to function properly that are not required in other environments. Please see Permissioned Rollout of APIs for more information if you are experiencing issues.

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

showcopay boolean By default, the expected co-pay is returned. For performance purposes, you can set this to false and copay will not be populated.

showclaimdetail boolean Include claim information, if available, associated with the appointment.

showinsurance boolean Include patient insurance information.

showexpectedprocedurecodes boolean Show expected procedure codes

showpatientdetail boolean Include patient information for each patient associated with an appointment.

showtelehealth boolean Show indicator for if this is a native athenatelehealth appointment

ignorerestrictions boolean When showing patient detail for appointments, the patient information for patients with record restrictions and blocked patients will not be shown. Setting this flag to true will show that information for those patients.