athenahealth

App · 23 actions

Automate scheduling and read charts in athenahealth's athenaOne: find and register patients, list, book and cancel appointments, manage open slots and notes, and read allergies, problems, medications, vitals and lab results.

Actions

ActionWhat it does
Add appointment noteAdd a note to an appointment.
Add open slotAdd an open slot to a provider's schedule on a date and time.
Book appointmentBook an open slot for a patient.
Cancel appointmentCancel a patient's booked appointment.
Get appointmentGet one appointment: its time, type, provider, patient and status.
Get patientGet one patient's details: name, date of birth, contact details, department and status.
List allergiesList a patient's allergies and reactions from the chart.
List appointment notesList the notes on an appointment, including the ones athenahealth adds itself.
List appointment typesList the practice's appointment types with their length.
List booked appointmentsList the appointments booked in a department between two dates, by provider, type or patient.
List departmentsList the practice's departments (its locations), with address, phone and time zone.
List lab resultsList a patient's lab results with each measurement and its normal range.
List medicationsList a patient's medications from the chart.
List open slotsList open appointment slots in a department, by provider, type or dates.
List patient's appointmentsList one patient's appointments, past and future, optionally between dates.
List problemsList a patient's problem list from the chart.
List providersList the practice's providers, optionally by last name or specialty.
List vitalsList a patient's vital sign readings (blood pressure, weight, temperature and others).
Register patientRegister a new patient.
Remove appointment noteRemove a note from an appointment.
Remove open slotRemove an open slot from a schedule.
Search patientsFind patients by name, date of birth, phone number or department.
Update patientChange a patient's name, date of birth or contact details.

Add appointment note

Add a note to an appointment.

Inputs

Appointment IDappointment_idtextRequired
The appointment's ID, from a list step, Book appointment or an earlier step.
NotetexttextRequired
The note.
Show on the scheduleshow_on_scheduletrue/false
Turn on to show the note on the provider's schedule.Default: false.

Outputs

appointment_idtext
The appointment's ID
note_idtext
The new note's ID
Example output
{
  "appointment_id": "1483308",
  "note_id": "73628"
}

Add open slot

Add an open slot to a provider's schedule on a date and time.

Inputs

Departmentdepartment_idtextRequired
The department (location). Pick one, or give its ID from an earlier step.
Providerathena_provider_idtextRequired
The provider whose schedule gets the slot.
Appointment typeappointment_type_idtextRequired
The type of appointment the slot is for.
DatedatedateRequired
The day of the slot.
TimetimetimeRequired
The start time of the slot.

Outputs

appointment_idtext
The new slot's appointment ID
appointment_idslist
Every slot created
Example output
{
  "appointment_id": "1485328",
  "appointment_ids": [
    "1485328"
  ]
}

Book appointment

Book an open slot for a patient. Nothing is emailed to the patient unless you turn on the confirmation.

Inputs

Appointment IDappointment_idtextRequired
The open slot's appointment ID, from List open slots or Add open slot.
Patient IDpatient_idtextRequired
The patient's ID, from Search patients, Register patient or an earlier step.
Appointment typeappointment_type_idtext
Book it as this type. Defaults to the slot's own.
Departmentdepartment_idtext
The department of the slot, if athenahealth asks for it.
Booking notebooking_notetext
Why the appointment is being made.
Send the patient a confirmationsend_confirmationtrue/false
Turn on to have athenahealth email the patient.Default: false.
Allow slots closed to online bookingallow_closed_slotstrue/false
Book a slot the practice hasn't opened for booking through the API.Default: false.

Outputs

appointmentobject
The booked appointment
Example output
{
  "appointment": {
    "appointment_id": "1483308",
    "appointment_type": "Office Visit",
    "appointment_type_id": "2",
    "date": "2026-11-13",
    "department_id": "1",
    "duration_minutes": 20,
    "last_modified": "2026-11-12T08:15:00",
    "notes": [
      "Booked by Lodol"
    ],
    "patient_id": "12345",
    "provider_id": "2200",
    "scheduled_at": "2026-11-12T08:15:00",
    "start_time": "09:00",
    "status": "f",
    "status_label": "Scheduled"
  }
}

Cancel appointment

Cancel a patient's booked appointment. The slot becomes open again.

Inputs

Appointment IDappointment_idtextRequired
The appointment's ID, from a list step, Book appointment or an earlier step.
Patient IDpatient_idtextRequired
The patient's ID, from Search patients, Register patient or an earlier step.
Reasonreasontext
Why it is being cancelled, as the practice would record it.

Outputs

appointment_idtext
The appointment's ID
cancelledtrue/false
True once athenahealth cancelled it
Example output
{
  "appointment_id": "1483308",
  "cancelled": true
}

Get appointment

Get one appointment: its time, type, provider, patient and status.

Inputs

Appointment IDappointment_idtextRequired
The appointment's ID, from a list step, Book appointment or an earlier step.

Outputs

appointmentobject
The appointment
Example output
{
  "appointment": {
    "appointment_id": "1483308",
    "appointment_type": "Office Visit",
    "appointment_type_id": "2",
    "date": "2026-11-13",
    "department_id": "1",
    "duration_minutes": 20,
    "last_modified": "2026-11-12T08:15:00",
    "notes": [
      "Booked by Lodol"
    ],
    "patient_id": "12345",
    "provider_id": "2200",
    "scheduled_at": "2026-11-12T08:15:00",
    "start_time": "09:00",
    "status": "f",
    "status_label": "Scheduled"
  }
}

Get patient

Get one patient's details: name, date of birth, contact details, department and status.

Inputs

Patient IDpatient_idtextRequired
The patient's ID, from Search patients, Register patient or an earlier step.
Departmentdepartment_idtext
The department to read the patient in, if athenahealth asks for it.

Outputs

patientobject
The patient
Example output
{
  "patient": {
    "address1": "1 Main Street",
    "address2": null,
    "city": "Watertown",
    "consent_to_call": true,
    "consent_to_text": false,
    "date_of_birth": "1980-01-15",
    "deceased_date": null,
    "department_id": "1",
    "email": "sam.example@example.com",
    "first_name": "Sam",
    "home_phone": null,
    "last_name": "Example",
    "last_updated": "2026-11-12T09:30:00",
    "middle_name": null,
    "mobile_phone": "6175550123",
    "patient_id": "12345",
    "preferred_name": null,
    "primary_provider_id": "2200",
    "registration_date": "2026-11-01",
    "sex": "F",
    "state": "MA",
    "status": "active",
    "test_patient": true,
    "work_phone": null,
    "zip": "02472"
  }
}

List allergies

List a patient's allergies and reactions from the chart.

Inputs

Patient IDpatient_idtextRequired
The patient's ID, from Search patients, Register patient or an earlier step.
Departmentdepartment_idtextRequired
The department whose chart to read.

Outputs

allergieslist
The allergies
countnumber
How many allergies
no_known_drug_allergiestrue/false
True if the chart says no known drug allergies
Example output
{
  "allergies": [
    {
      "allergen": "Penicillin",
      "allergen_id": "1001",
      "allergy_id": "A100",
      "categories": [
        "drug"
      ],
      "last_modified": "2026-10-01T10:00:00",
      "reactions": [
        "Hives"
      ]
    }
  ],
  "count": 1,
  "no_known_drug_allergies": false
}

List appointment notes

List the notes on an appointment, including the ones athenahealth adds itself.

Inputs

Appointment IDappointment_idtextRequired
The appointment's ID, from a list step, Book appointment or an earlier step.
How manylimitnumber
How many to return, 1 to 1000. Defaults to 50.From 1 to 1000. Default: 50.
Skipoffsetnumber
How many to skip, to get the page after an earlier one: the next_offset it gave.At least 0.

Outputs

countnumber
How many are in this page
next_offsetnumber
Pass this as Skip to get the next page; empty on the last page
noteslist
The notes
total_countnumber
How many there are in all
Example output
{
  "count": 1,
  "next_offset": null,
  "notes": [
    {
      "created_at": "2026-11-12T08:16:00",
      "created_by": "API-12345",
      "note_id": "73628",
      "show_on_schedule": false,
      "text": "Patient asked for a morning slot"
    }
  ],
  "total_count": 1
}

List appointment types

List the practice's appointment types with their length.

Inputs

How manylimitnumber
How many to return, 1 to 1000. Defaults to 50.From 1 to 1000. Default: 50.
Skipoffsetnumber
How many to skip, to get the page after an earlier one: the next_offset it gave.At least 0.

Outputs

appointment_typeslist
The appointment types
countnumber
How many are in this page
next_offsetnumber
Pass this as Skip to get the next page; empty on the last page
total_countnumber
How many there are in all
Example output
{
  "appointment_types": [
    {
      "appointment_type_id": "2",
      "duration_minutes": 20,
      "for_patients": true,
      "name": "Office Visit",
      "patient_facing_name": "Office Visit",
      "short_name": "OV"
    }
  ],
  "count": 1,
  "next_offset": null,
  "total_count": 1
}

List booked appointments

List the appointments booked in a department between two dates, by provider, type or patient.

Inputs

Departmentdepartment_idtextRequired
The department (location). Pick one, or give its ID from an earlier step.
Fromstart_datedateRequired
The first day to look at.
Toend_datedateRequired
The last day to look at.
Providerathena_provider_idtext
Only this provider. Pick one, or give an ID from an earlier step.
Appointment typeappointment_type_idtext
Only this type of appointment.
Patient IDpatient_idtext
Only this patient's appointments.
How manylimitnumber
How many to return, 1 to 1000. Defaults to 50.From 1 to 1000. Default: 50.
Skipoffsetnumber
How many to skip, to get the page after an earlier one: the next_offset it gave.At least 0.

Outputs

appointmentslist
The booked appointments
countnumber
How many are in this page
next_offsetnumber
Pass this as Skip to get the next page; empty on the last page
total_countnumber
How many there are in all
Example output
{
  "appointments": [
    {
      "appointment_id": "1483308",
      "appointment_type": "Office Visit",
      "appointment_type_id": "2",
      "date": "2026-11-13",
      "department_id": "1",
      "duration_minutes": 20,
      "last_modified": "2026-11-12T08:15:00",
      "notes": [
        "Booked by Lodol"
      ],
      "patient_id": "12345",
      "provider_id": "2200",
      "scheduled_at": "2026-11-12T08:15:00",
      "start_time": "09:00",
      "status": "f",
      "status_label": "Scheduled"
    }
  ],
  "count": 1,
  "next_offset": null,
  "total_count": 1
}

List departments

List the practice's departments (its locations), with address, phone and time zone.

Inputs

How manylimitnumber
How many to return, 1 to 1000. Defaults to 50.From 1 to 1000. Default: 50.
Skipoffsetnumber
How many to skip, to get the page after an earlier one: the next_offset it gave.At least 0.

Outputs

countnumber
How many are in this page
departmentslist
The departments
next_offsetnumber
Pass this as Skip to get the next page; empty on the last page
total_countnumber
How many there are in all
Example output
{
  "count": 1,
  "departments": [
    {
      "address": "311 Arsenal Street",
      "city": "Watertown",
      "department_id": "1",
      "name": "Main Street Clinic",
      "patient_facing_name": "Main Street Clinic",
      "phone": "(555) 004-0271",
      "place_of_service": "OFFICE",
      "provider_group_id": "1",
      "state": "MA",
      "time_zone": "America/New_York",
      "zip": "02472"
    }
  ],
  "next_offset": null,
  "total_count": 1
}

List lab results

List a patient's lab results with each measurement and its normal range.

Inputs

Patient IDpatient_idtextRequired
The patient's ID, from Search patients, Register patient or an earlier step.
Departmentdepartment_idtextRequired
The department whose chart to read.
How manylimitnumber
How many to return, 1 to 1000. Defaults to 50.From 1 to 1000. Default: 50.
Skipoffsetnumber
How many to skip, to get the page after an earlier one: the next_offset it gave.At least 0.

Outputs

countnumber
How many are in this page
lab_resultslist
The lab results
next_offsetnumber
Pass this as Skip to get the next page; empty on the last page
total_countnumber
How many there are in all
Example output
{
  "count": 1,
  "lab_results": [
    {
      "analytes": [
        {
          "abnormal_flag": "normal",
          "name": "color",
          "reference_range": "light yellow, yellow",
          "status": "final",
          "value": "Light Yellow"
        }
      ],
      "created_at": "2026-06-16T21:53:11",
      "description": "Urinalysis",
      "has_attachment": false,
      "lab_result_id": "5000",
      "priority": "routine"
    }
  ],
  "next_offset": null,
  "total_count": 1
}

List medications

List a patient's medications from the chart.

Inputs

Patient IDpatient_idtextRequired
The patient's ID, from Search patients, Register patient or an earlier step.
Departmentdepartment_idtextRequired
The department whose chart to read.

Outputs

countnumber
How many medications
medicationslist
The medications
Example output
{
  "count": 1,
  "medications": [
    {
      "discontinued": false,
      "entered_on": "2025-05-06",
      "medication": "cyclobenzaprine 10 mg tablet",
      "medication_entry_id": "H11998",
      "medication_id": "224617",
      "therapeutic_class": "SKELETAL MUSCLE RELAXANTS"
    }
  ]
}

List open slots

List open appointment slots in a department, by provider, type or dates.

Inputs

Departmentdepartment_idtextRequired
The department (location). Pick one, or give its ID from an earlier step.
Fromstart_datedate
The first day to look at. Defaults to today.
Toend_datedate
The last day to look at.
Providerathena_provider_idtext
Only this provider. Pick one, or give an ID from an earlier step.
Appointment typeappointment_type_idtext
Only this type of appointment.
Include slots closed to online bookinginclude_all_slotstrue/false
Also list slots the practice hasn't opened for booking through the API.Default: false.
How manylimitnumber
How many to return, 1 to 1000. Defaults to 50.From 1 to 1000. Default: 50.
Skipoffsetnumber
How many to skip, to get the page after an earlier one: the next_offset it gave.At least 0.

Outputs

appointmentslist
The open slots
countnumber
How many are in this page
next_offsetnumber
Pass this as Skip to get the next page; empty on the last page
total_countnumber
How many there are in all
Example output
{
  "appointments": [
    {
      "appointment_id": "1483309",
      "appointment_type": "Office Visit",
      "appointment_type_id": "2",
      "date": "2026-11-13",
      "department_id": "1",
      "duration_minutes": 20,
      "provider_id": "2200",
      "start_time": "09:20"
    }
  ],
  "count": 1,
  "next_offset": null,
  "total_count": 1
}

List patient's appointments

List one patient's appointments, past and future, optionally between dates.

Inputs

Patient IDpatient_idtextRequired
The patient's ID, from Search patients, Register patient or an earlier step.
Fromstart_datedate
Only appointments on or after this day.
Toend_datedate
Only appointments on or before this day.
Departmentdepartment_idtext
Only appointments in this department.
Include cancelledinclude_cancelledtrue/false
Also list cancelled appointments.Default: false.
How manylimitnumber
How many to return, 1 to 1000. Defaults to 50.From 1 to 1000. Default: 50.
Skipoffsetnumber
How many to skip, to get the page after an earlier one: the next_offset it gave.At least 0.

Outputs

appointmentslist
The patient's appointments
countnumber
How many are in this page
next_offsetnumber
Pass this as Skip to get the next page; empty on the last page
total_countnumber
How many there are in all
Example output
{
  "appointments": [
    {
      "appointment_id": "1483308",
      "appointment_type": "Office Visit",
      "appointment_type_id": "2",
      "date": "2026-11-13",
      "department_id": "1",
      "duration_minutes": 20,
      "last_modified": "2026-11-12T08:15:00",
      "notes": [
        "Booked by Lodol"
      ],
      "patient_id": "12345",
      "provider_id": "2200",
      "scheduled_at": "2026-11-12T08:15:00",
      "start_time": "09:00",
      "status": "f",
      "status_label": "Scheduled"
    }
  ],
  "count": 1,
  "next_offset": null,
  "total_count": 1
}

List problems

List a patient's problem list from the chart.

Inputs

Patient IDpatient_idtextRequired
The patient's ID, from Search patients, Register patient or an earlier step.
Departmentdepartment_idtextRequired
The department whose chart to read.

Outputs

countnumber
How many problems
problemslist
The problems
Example output
{
  "count": 1,
  "problems": [
    {
      "code": "59621000",
      "code_set": "SNOMED",
      "last_modified": "2026-10-01T10:00:00",
      "name": "Essential hypertension",
      "problem_id": "300",
      "start_date": "2025-06-01"
    }
  ]
}

List providers

List the practice's providers, optionally by last name or specialty.

Inputs

Last namenametext
Only providers with this last name.
Specialtyspecialtytext
Only providers with this specialty, such as Family Medicine.
How manylimitnumber
How many to return, 1 to 1000. Defaults to 50.From 1 to 1000. Default: 50.
Skipoffsetnumber
How many to skip, to get the page after an earlier one: the next_offset it gave.At least 0.

Outputs

countnumber
How many are in this page
next_offsetnumber
Pass this as Skip to get the next page; empty on the last page
providerslist
The providers
total_countnumber
How many there are in all
Example output
{
  "count": 1,
  "next_offset": null,
  "providers": [
    {
      "accepting_new_patients": true,
      "display_name": "Rivera, Alex",
      "entity_type": "Person",
      "first_name": "Alex",
      "last_name": "Rivera",
      "npi": "1234567893",
      "provider_id": "2200",
      "specialty": "Family Medicine"
    }
  ],
  "total_count": 1
}

List vitals

List a patient's vital sign readings (blood pressure, weight, temperature and others).

Inputs

Patient IDpatient_idtextRequired
The patient's ID, from Search patients, Register patient or an earlier step.
Departmentdepartment_idtextRequired
The department whose chart to read.

Outputs

countnumber
How many readings
vitalslist
The readings
Example output
{
  "count": 1,
  "vitals": [
    {
      "abbreviation": "BP",
      "code": "8462-4",
      "description": "Diastolic blood pressure",
      "reading_id": "0",
      "source": "FLOWSHEET",
      "taken_at": "2026-09-09T04:34:06",
      "value": "80.00",
      "vital": "BLOODPRESSURE"
    }
  ]
}

Register patient

Register a new patient. athenahealth can't delete patients, so check first with Search patients. Needs an email, phone number or ZIP code as well as the name and date of birth.

Inputs

Departmentdepartment_idtextRequired
The department the patient is registered in.
First namefirst_nametextRequired
Their first name.
Last namelast_nametextRequired
Their last name.
Date of birthdate_of_birthdateRequired
Their date of birth.
Middle namemiddle_nametext
Their middle name.
Preferred namepreferred_nametext
The name they like to be called.
Sexsextext
Their sex as athenahealth records it.One of: F (Female), M (Male).
Emailemailtext
Their email address.
Mobile phonemobile_phonetext
A 10-digit North American number, such as 6175550123.
Home phonehome_phonetext
A 10-digit North American number, such as 6175550123.
Work phonework_phonetext
A 10-digit North American number, such as 6175550123.
Addressaddress1text
Street address.
Address line 2address2text
Apartment, suite or unit.
Citycitytext
City.
Statestatetext
Two-letter state code, such as MA.
ZIP codezip_codetext
Five digits, such as 02472.
Agreed to be calledconsent_to_calltrue/false
Turn on if the patient agreed to phone calls.Default: false.
Agreed to be textedconsent_to_texttrue/false
Turn on if the patient agreed to text messages.Default: false.

Outputs

createdtrue/false
False if athenahealth matched an existing patient instead
patient_idtext
The new patient's ID
Example output
{
  "created": true,
  "patient_id": "12345"
}

Remove appointment note

Remove a note from an appointment.

Inputs

Appointment IDappointment_idtextRequired
The appointment's ID, from a list step, Book appointment or an earlier step.
Note IDnote_idtextRequired
The note's ID, from List appointment notes or Add appointment note.

Outputs

appointment_idtext
The appointment's ID
deletedtrue/false
True once the note is gone
note_idtext
The note's ID
Example output
{
  "appointment_id": "1483308",
  "deleted": true,
  "note_id": "73628"
}

Remove open slot

Remove an open slot from a schedule. A booked appointment can't be removed: cancel it instead.

Inputs

Appointment IDappointment_idtextRequired
The appointment's ID, from a list step, Book appointment or an earlier step.

Outputs

appointment_idtext
The slot's appointment ID
deletedtrue/false
True once the slot is gone
Example output
{
  "appointment_id": "1485328",
  "deleted": true
}

Search patients

Find patients by name, date of birth, phone number or department. Give at least one.

Inputs

First namefirst_nametext
Their first name.
Last namelast_nametext
Their last name.
Date of birthdate_of_birthdate
Their date of birth.
Phone numberphonetext
Any of their phone numbers, 10 digits.
Departmentdepartment_idtext
Only patients in this department.
How manylimitnumber
How many to return, 1 to 1000. Defaults to 50.From 1 to 1000. Default: 50.
Skipoffsetnumber
How many to skip, to get the page after an earlier one: the next_offset it gave.At least 0.

Outputs

countnumber
How many are in this page
next_offsetnumber
Pass this as Skip to get the next page; empty on the last page
patientslist
The matching patients
total_countnumber
How many there are in all
Example output
{
  "count": 1,
  "next_offset": null,
  "patients": [
    {
      "address1": "1 Main Street",
      "address2": null,
      "city": "Watertown",
      "consent_to_call": true,
      "consent_to_text": false,
      "date_of_birth": "1980-01-15",
      "deceased_date": null,
      "department_id": "1",
      "email": "sam.example@example.com",
      "first_name": "Sam",
      "home_phone": null,
      "last_name": "Example",
      "last_updated": "2026-11-12T09:30:00",
      "middle_name": null,
      "mobile_phone": "6175550123",
      "patient_id": "12345",
      "preferred_name": null,
      "primary_provider_id": "2200",
      "registration_date": "2026-11-01",
      "sex": "F",
      "state": "MA",
      "status": "active",
      "test_patient": true,
      "work_phone": null,
      "zip": "02472"
    }
  ],
  "total_count": 1
}

Update patient

Change a patient's name, date of birth or contact details. Fields left empty stay as they are.

Inputs

Patient IDpatient_idtextRequired
The patient's ID, from Search patients, Register patient or an earlier step.
Departmentdepartment_idtext
The department the patient is seen in, if it matters for the change.
First namefirst_nametext
Their first name.
Last namelast_nametext
Their last name.
Date of birthdate_of_birthdate
Their date of birth.
Middle namemiddle_nametext
Their middle name.
Preferred namepreferred_nametext
The name they like to be called.
Sexsextext
Their sex as athenahealth records it.One of: F (Female), M (Male).
Emailemailtext
Their email address.
Mobile phonemobile_phonetext
A 10-digit North American number, such as 6175550123.
Home phonehome_phonetext
A 10-digit North American number, such as 6175550123.
Work phonework_phonetext
A 10-digit North American number, such as 6175550123.
Addressaddress1text
Street address.
Address line 2address2text
Apartment, suite or unit.
Citycitytext
City.
Statestatetext
Two-letter state code, such as MA.
ZIP codezip_codetext
Five digits, such as 02472.
Agreed to be calledconsent_to_calltrue/false
Turn on if the patient agreed to phone calls.Default: false.
Agreed to be textedconsent_to_texttrue/false
Turn on if the patient agreed to text messages.Default: false.

Outputs

patient_idtext
The patient's ID
updatedtrue/false
True once athenahealth saved the change
Example output
{
  "patient_id": "12345",
  "updated": true
}

On this page