# athenahealth

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

App · 23 actions. Web page: https://docs.lodol.com/docs/integrations/athenahealth

## Actions

### Add appointment note

Add a note to an appointment.

**Inputs**

- Appointment ID (`appointment_id`, text, required): The appointment's ID, from a list step, Book appointment or an earlier step.
- Note (`text`, text, required): The note.
- Show on the schedule (`show_on_schedule`, true/false): Turn on to show the note on the provider's schedule. Default: `false`.

**Outputs**

- `appointment_id` (text): The appointment's ID
- `note_id` (text): The new note's ID

**Example output**

```json
{
  "appointment_id": "1483308",
  "note_id": "73628"
}
```

### Add open slot

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

**Inputs**

- Department (`department_id`, text, required): The department (location). Pick one, or give its ID from an earlier step.
- Provider (`athena_provider_id`, text, required): The provider whose schedule gets the slot.
- Appointment type (`appointment_type_id`, text, required): The type of appointment the slot is for.
- Date (`date`, date, required): The day of the slot.
- Time (`time`, time, required): The start time of the slot.

**Outputs**

- `appointment_id` (text): The new slot's appointment ID
- `appointment_ids` (list): Every slot created

**Example output**

```json
{
  "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 ID (`appointment_id`, text, required): The open slot's appointment ID, from List open slots or Add open slot.
- Patient ID (`patient_id`, text, required): The patient's ID, from Search patients, Register patient or an earlier step.
- Appointment type (`appointment_type_id`, text): Book it as this type. Defaults to the slot's own.
- Department (`department_id`, text): The department of the slot, if athenahealth asks for it.
- Booking note (`booking_note`, text): Why the appointment is being made.
- Send the patient a confirmation (`send_confirmation`, true/false): Turn on to have athenahealth email the patient. Default: `false`.
- Allow slots closed to online booking (`allow_closed_slots`, true/false): Book a slot the practice hasn't opened for booking through the API. Default: `false`.

**Outputs**

- `appointment` (object): The booked appointment

**Example output**

```json
{
  "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 ID (`appointment_id`, text, required): The appointment's ID, from a list step, Book appointment or an earlier step.
- Patient ID (`patient_id`, text, required): The patient's ID, from Search patients, Register patient or an earlier step.
- Reason (`reason`, text): Why it is being cancelled, as the practice would record it.

**Outputs**

- `appointment_id` (text): The appointment's ID
- `cancelled` (true/false): True once athenahealth cancelled it

**Example output**

```json
{
  "appointment_id": "1483308",
  "cancelled": true
}
```

### Get appointment

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

**Inputs**

- Appointment ID (`appointment_id`, text, required): The appointment's ID, from a list step, Book appointment or an earlier step.

**Outputs**

- `appointment` (object): The appointment

**Example output**

```json
{
  "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 ID (`patient_id`, text, required): The patient's ID, from Search patients, Register patient or an earlier step.
- Department (`department_id`, text): The department to read the patient in, if athenahealth asks for it.

**Outputs**

- `patient` (object): The patient

**Example output**

```json
{
  "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 ID (`patient_id`, text, required): The patient's ID, from Search patients, Register patient or an earlier step.
- Department (`department_id`, text, required): The department whose chart to read.

**Outputs**

- `allergies` (list): The allergies
- `count` (number): How many allergies
- `no_known_drug_allergies` (true/false): True if the chart says no known drug allergies

**Example output**

```json
{
  "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 ID (`appointment_id`, text, required): The appointment's ID, from a list step, Book appointment or an earlier step.
- How many (`limit`, number): How many to return, 1 to 1000. Defaults to 50. From 1 to 1000. Default: `50`.
- Skip (`offset`, number): How many to skip, to get the page after an earlier one: the next_offset it gave. At least 0.

**Outputs**

- `count` (number): How many are in this page
- `next_offset` (number): Pass this as Skip to get the next page; empty on the last page
- `notes` (list): The notes
- `total_count` (number): How many there are in all

**Example output**

```json
{
  "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 many (`limit`, number): How many to return, 1 to 1000. Defaults to 50. From 1 to 1000. Default: `50`.
- Skip (`offset`, number): How many to skip, to get the page after an earlier one: the next_offset it gave. At least 0.

**Outputs**

- `appointment_types` (list): The appointment types
- `count` (number): How many are in this page
- `next_offset` (number): Pass this as Skip to get the next page; empty on the last page
- `total_count` (number): How many there are in all

**Example output**

```json
{
  "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**

- Department (`department_id`, text, required): The department (location). Pick one, or give its ID from an earlier step.
- From (`start_date`, date, required): The first day to look at.
- To (`end_date`, date, required): The last day to look at.
- Provider (`athena_provider_id`, text): Only this provider. Pick one, or give an ID from an earlier step.
- Appointment type (`appointment_type_id`, text): Only this type of appointment.
- Patient ID (`patient_id`, text): Only this patient's appointments.
- How many (`limit`, number): How many to return, 1 to 1000. Defaults to 50. From 1 to 1000. Default: `50`.
- Skip (`offset`, number): How many to skip, to get the page after an earlier one: the next_offset it gave. At least 0.

**Outputs**

- `appointments` (list): The booked appointments
- `count` (number): How many are in this page
- `next_offset` (number): Pass this as Skip to get the next page; empty on the last page
- `total_count` (number): How many there are in all

**Example output**

```json
{
  "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 many (`limit`, number): How many to return, 1 to 1000. Defaults to 50. From 1 to 1000. Default: `50`.
- Skip (`offset`, number): How many to skip, to get the page after an earlier one: the next_offset it gave. At least 0.

**Outputs**

- `count` (number): How many are in this page
- `departments` (list): The departments
- `next_offset` (number): Pass this as Skip to get the next page; empty on the last page
- `total_count` (number): How many there are in all

**Example output**

```json
{
  "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 ID (`patient_id`, text, required): The patient's ID, from Search patients, Register patient or an earlier step.
- Department (`department_id`, text, required): The department whose chart to read.
- How many (`limit`, number): How many to return, 1 to 1000. Defaults to 50. From 1 to 1000. Default: `50`.
- Skip (`offset`, number): How many to skip, to get the page after an earlier one: the next_offset it gave. At least 0.

**Outputs**

- `count` (number): How many are in this page
- `lab_results` (list): The lab results
- `next_offset` (number): Pass this as Skip to get the next page; empty on the last page
- `total_count` (number): How many there are in all

**Example output**

```json
{
  "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 ID (`patient_id`, text, required): The patient's ID, from Search patients, Register patient or an earlier step.
- Department (`department_id`, text, required): The department whose chart to read.

**Outputs**

- `count` (number): How many medications
- `medications` (list): The medications

**Example output**

```json
{
  "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**

- Department (`department_id`, text, required): The department (location). Pick one, or give its ID from an earlier step.
- From (`start_date`, date): The first day to look at. Defaults to today.
- To (`end_date`, date): The last day to look at.
- Provider (`athena_provider_id`, text): Only this provider. Pick one, or give an ID from an earlier step.
- Appointment type (`appointment_type_id`, text): Only this type of appointment.
- Include slots closed to online booking (`include_all_slots`, true/false): Also list slots the practice hasn't opened for booking through the API. Default: `false`.
- How many (`limit`, number): How many to return, 1 to 1000. Defaults to 50. From 1 to 1000. Default: `50`.
- Skip (`offset`, number): How many to skip, to get the page after an earlier one: the next_offset it gave. At least 0.

**Outputs**

- `appointments` (list): The open slots
- `count` (number): How many are in this page
- `next_offset` (number): Pass this as Skip to get the next page; empty on the last page
- `total_count` (number): How many there are in all

**Example output**

```json
{
  "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 ID (`patient_id`, text, required): The patient's ID, from Search patients, Register patient or an earlier step.
- From (`start_date`, date): Only appointments on or after this day.
- To (`end_date`, date): Only appointments on or before this day.
- Department (`department_id`, text): Only appointments in this department.
- Include cancelled (`include_cancelled`, true/false): Also list cancelled appointments. Default: `false`.
- How many (`limit`, number): How many to return, 1 to 1000. Defaults to 50. From 1 to 1000. Default: `50`.
- Skip (`offset`, number): How many to skip, to get the page after an earlier one: the next_offset it gave. At least 0.

**Outputs**

- `appointments` (list): The patient's appointments
- `count` (number): How many are in this page
- `next_offset` (number): Pass this as Skip to get the next page; empty on the last page
- `total_count` (number): How many there are in all

**Example output**

```json
{
  "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 ID (`patient_id`, text, required): The patient's ID, from Search patients, Register patient or an earlier step.
- Department (`department_id`, text, required): The department whose chart to read.

**Outputs**

- `count` (number): How many problems
- `problems` (list): The problems

**Example output**

```json
{
  "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 name (`name`, text): Only providers with this last name.
- Specialty (`specialty`, text): Only providers with this specialty, such as Family Medicine.
- How many (`limit`, number): How many to return, 1 to 1000. Defaults to 50. From 1 to 1000. Default: `50`.
- Skip (`offset`, number): How many to skip, to get the page after an earlier one: the next_offset it gave. At least 0.

**Outputs**

- `count` (number): How many are in this page
- `next_offset` (number): Pass this as Skip to get the next page; empty on the last page
- `providers` (list): The providers
- `total_count` (number): How many there are in all

**Example output**

```json
{
  "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 ID (`patient_id`, text, required): The patient's ID, from Search patients, Register patient or an earlier step.
- Department (`department_id`, text, required): The department whose chart to read.

**Outputs**

- `count` (number): How many readings
- `vitals` (list): The readings

**Example output**

```json
{
  "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**

- Department (`department_id`, text, required): The department the patient is registered in.
- First name (`first_name`, text, required): Their first name.
- Last name (`last_name`, text, required): Their last name.
- Date of birth (`date_of_birth`, date, required): Their date of birth.
- Middle name (`middle_name`, text): Their middle name.
- Preferred name (`preferred_name`, text): The name they like to be called.
- Sex (`sex`, text): Their sex as athenahealth records it. One of: `F` (Female), `M` (Male).
- Email (`email`, text): Their email address.
- Mobile phone (`mobile_phone`, text): A 10-digit North American number, such as 6175550123.
- Home phone (`home_phone`, text): A 10-digit North American number, such as 6175550123.
- Work phone (`work_phone`, text): A 10-digit North American number, such as 6175550123.
- Address (`address1`, text): Street address.
- Address line 2 (`address2`, text): Apartment, suite or unit.
- City (`city`, text): City.
- State (`state`, text): Two-letter state code, such as MA.
- ZIP code (`zip_code`, text): Five digits, such as 02472.
- Agreed to be called (`consent_to_call`, true/false): Turn on if the patient agreed to phone calls. Default: `false`.
- Agreed to be texted (`consent_to_text`, true/false): Turn on if the patient agreed to text messages. Default: `false`.

**Outputs**

- `created` (true/false): False if athenahealth matched an existing patient instead
- `patient_id` (text): The new patient's ID

**Example output**

```json
{
  "created": true,
  "patient_id": "12345"
}
```

### Remove appointment note

Remove a note from an appointment.

**Inputs**

- Appointment ID (`appointment_id`, text, required): The appointment's ID, from a list step, Book appointment or an earlier step.
- Note ID (`note_id`, text, required): The note's ID, from List appointment notes or Add appointment note.

**Outputs**

- `appointment_id` (text): The appointment's ID
- `deleted` (true/false): True once the note is gone
- `note_id` (text): The note's ID

**Example output**

```json
{
  "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 ID (`appointment_id`, text, required): The appointment's ID, from a list step, Book appointment or an earlier step.

**Outputs**

- `appointment_id` (text): The slot's appointment ID
- `deleted` (true/false): True once the slot is gone

**Example output**

```json
{
  "appointment_id": "1485328",
  "deleted": true
}
```

### Search patients

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

**Inputs**

- First name (`first_name`, text): Their first name.
- Last name (`last_name`, text): Their last name.
- Date of birth (`date_of_birth`, date): Their date of birth.
- Phone number (`phone`, text): Any of their phone numbers, 10 digits.
- Department (`department_id`, text): Only patients in this department.
- How many (`limit`, number): How many to return, 1 to 1000. Defaults to 50. From 1 to 1000. Default: `50`.
- Skip (`offset`, number): How many to skip, to get the page after an earlier one: the next_offset it gave. At least 0.

**Outputs**

- `count` (number): How many are in this page
- `next_offset` (number): Pass this as Skip to get the next page; empty on the last page
- `patients` (list): The matching patients
- `total_count` (number): How many there are in all

**Example output**

```json
{
  "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 ID (`patient_id`, text, required): The patient's ID, from Search patients, Register patient or an earlier step.
- Department (`department_id`, text): The department the patient is seen in, if it matters for the change.
- First name (`first_name`, text): Their first name.
- Last name (`last_name`, text): Their last name.
- Date of birth (`date_of_birth`, date): Their date of birth.
- Middle name (`middle_name`, text): Their middle name.
- Preferred name (`preferred_name`, text): The name they like to be called.
- Sex (`sex`, text): Their sex as athenahealth records it. One of: `F` (Female), `M` (Male).
- Email (`email`, text): Their email address.
- Mobile phone (`mobile_phone`, text): A 10-digit North American number, such as 6175550123.
- Home phone (`home_phone`, text): A 10-digit North American number, such as 6175550123.
- Work phone (`work_phone`, text): A 10-digit North American number, such as 6175550123.
- Address (`address1`, text): Street address.
- Address line 2 (`address2`, text): Apartment, suite or unit.
- City (`city`, text): City.
- State (`state`, text): Two-letter state code, such as MA.
- ZIP code (`zip_code`, text): Five digits, such as 02472.
- Agreed to be called (`consent_to_call`, true/false): Turn on if the patient agreed to phone calls. Default: `false`.
- Agreed to be texted (`consent_to_text`, true/false): Turn on if the patient agreed to text messages. Default: `false`.

**Outputs**

- `patient_id` (text): The patient's ID
- `updated` (true/false): True once athenahealth saved the change

**Example output**

```json
{
  "patient_id": "12345",
  "updated": true
}
```
