Eden Health

Eden Health grdn.routes.impl.appointments API

Contains handlers for routes related to Appointments, Cases, Encounters etc. On timezones: Appointments are tied to Athena departments, and their date and start time are to be interpreted as representing a local datetime in the Athena department's time zone. Popups are special in that they have a dedicated department with the New York time zone, but their physical location (and thus time zone) could differ from that. To abstract over departments and popups, we introduce the notion of a location time zone, that is equal to the pop-up's time zone for popup appointments, and the department time zone for all others. All appointment times for appointments at physical locations are displayed to the user in the location time zone. All appointment times for virtual appointments are displayed to the user in their preferred time zone as communicated by the client.

GitHub OpenAPI
Business capability
Scheduling & Appointment Management BC-2800.10

Operations 16

GET /v2/appointment get-digital-visit-handler
POST /v2/appointment new-digital-visit-handler
POST /v2/appointment/book book-appointments-handler
GET /v2/appointment/booked booked-appointments-handler
GET /v2/appointment/booked-established booked-appointments-established-handler
PUT /v2/appointment/{appointment-id} checkout-digital-visit-handler
DELETE /v2/appointment/{appointment-id}/after-visit-summary delete-after-visit-summary-message-handler
POST /v2/appointment/{appointment-id}/after-visit-summary send-after-visit-summary-handler
PUT /v2/appointment/{appointment-id}/cancel cancel-appointment-handler
POST /v2/appointment/{appointment-id}/check-in check-in-appointment-handler
GET /v2/appointment/{appointment-id}/check-in get-check-in-screeners-handler
GET /v2/appointment/{appointment-id}/note get-appointment-note-handler
GET /v2/department/{department-id}/appointment-reasons appointment-reasons-by-dept-handler
GET /v2/department/{department-id}/reason/{appointment-reason-id}/open-grouped open-appointments-grouped-handler
PUT /v2/encounter/{encounter-id}/after-visit-summary update-after-visit-summary-handler
GET /v2/patient/{patient-id}/encounter/{encounter-id} get-encounter-handler

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/eden-health/refs/heads/main/openapi/eden-health-grdn-routes-impl-appointments-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/eden-health-grdn-routes-impl-appointments-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

eden-health-grdn-routes-impl-appointments-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: '1.0'
  title: Grdn grdn.handler Grdn.routes.impl.appointments API
  description: Eden Health Inc. primary backend API service.
servers:
- url: https://api.edenhealth.com/
tags:
- name: grdn.routes.impl.appointments
  description: "Contains handlers for routes related to Appointments, Cases, Encounters etc.\n\n  On timezones:\n\n  Appointments are tied to Athena departments, and their date and start time are\n  to be interpreted as representing a local datetime in the Athena department's\n  time zone.\n\n  Popups are special in that they have a dedicated department with the New York\n  time zone, but their physical location (and thus time zone) could differ from\n  that.\n\n  To abstract over departments and popups, we introduce the notion of a location\n  time zone, that is equal to the pop-up's time zone for popup appointments, and\n  the department time zone for all others.\n\n  All appointment times for appointments at physical locations are displayed to\n  the user in the location time zone.\n\n  All appointment times for virtual appointments are displayed to the user\n  in their preferred time zone as communicated by the client.\n  "
paths:
  /v2/appointment:
    get:
      summary: get-digital-visit-handler
      description: "Fetches a patients ongoing telehealth appointment. Ignores past ongoing\n  telehealth visits and only checks the most recent visit, if the most\n  recent visit is ongoing we return it."
      tags:
      - grdn.routes.impl.appointments
      parameters:
      - in: query
        name: patient-id
        description: 'origin spec: grdn.specs/patient-id-params'
        required: true
        schema:
          type: string
          format: uuid
      - in: query
        name: funnel-id
        description: 'origin spec: grdn.specs/patient-id-params'
        required: false
        schema:
          type: string
          format: uuid
      responses:
        default:
          description: Default success response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  appointment-id:
                    type: integer
                    format: int64
                    x-anyOf:
                    - type: integer
                      format: int64
                    - type: string
                  appointment-type-id:
                    type: integer
                    format: int64
                  appointment-status:
                    type: number
                    format: double
                  start-time:
                    type: string
                    x-allOf:
                    - type: string
                    - {}
                  copay:
                    type: number
                    format: double
                  patient-appointment-type-name:
                    type: string
                  appointment-type:
                    type: integer
                    format: int64
                    x-anyOf:
                    - type: integer
                      format: int64
                    - type: string
                  department-id:
                    type: string
                    x-anyOf:
                    - type: string
                    - type: integer
                      format: int64
                  appointmentcopay:
                    type: object
                    properties:
                      collectedforother:
                        type: number
                        format: double
                      collectedforappointment:
                        type: number
                        format: double
                      insurancecopay:
                        type: number
                        format: double
                    required:
                    - collectedforother
                    - collectedforappointment
                    - insurancecopay
                    title: grdn.specs.appointments/appointmentcopay
                  duration:
                    type: number
                    format: double
                  date:
                    type: string
                    x-allOf:
                    - type: string
                    - {}
                required:
                - appointment-id
                - date
                - copay
                - start-time
                - department-id
                - duration
                - appointment-type
                - appointment-type-id
                - patient-appointment-type-name
                - appointment-status
                - appointmentcopay
                title: grdn.specs.digital-visits/digital-visit
                x-anyOf:
                - type: object
                  properties:
                    appointment-id:
                      type: integer
                      format: int64
                      x-anyOf:
                      - type: integer
                        format: int64
                      - type: string
                    appointment-type-id:
                      type: integer
                      format: int64
                    appointment-status:
                      type: number
                      format: double
                    start-time:
                      type: string
                      x-allOf:
                      - type: string
                      - {}
                    copay:
                      type: number
                      format: double
                    patient-appointment-type-name:
                      type: string
                    appointment-type:
                      type: integer
                      format: int64
                      x-anyOf:
                      - type: integer
                        format: int64
                      - type: string
                    department-id:
                      type: string
                      x-anyOf:
                      - type: string
                      - type: integer
                        format: int64
                    appointmentcopay:
                      type: object
                      properties:
                        collectedforother:
                          type: number
                          format: double
                        collectedforappointment:
                          type: number
                          format: double
                        insurancecopay:
                          type: number
                          format: double
                      required:
                      - collectedforother
                      - collectedforappointment
                      - insurancecopay
                      title: grdn.specs.appointments/appointmentcopay
                    duration:
                      type: number
                      format: double
                    date:
                      type: string
                      x-allOf:
                      - type: string
                      - {}
                  required:
                  - appointment-id
                  - date
                  - copay
                  - start-time
                  - department-id
                  - duration
                  - appointment-type
                  - appointment-type-id
                  - patient-appointment-type-name
                  - appointment-status
                  - appointmentcopay
                  title: grdn.specs.digital-visits/digital-visit
                - {}
    post:
      summary: new-digital-visit-handler
      description: "Starts by checking for a patient's insurance. If they do not\n   have any, we set their insurance as self pay. Then, we create\n   an open appointment slot, book the patient into it, and check\n   them into it."
      tags:
      - grdn.routes.impl.appointments
      responses:
        default:
          description: Default success response.
          content:
            application/json:
              schema: {}
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                patient-id:
                  type: string
                  format: uuid
                appointment-type-id:
                  type: integer
                  format: int64
              required:
              - patient-id
              title: grdn.specs.appointments/new-digital-visit-params
        description: 'origin spec: grdn.specs.appointments/new-digital-visit-params'
  /v2/appointment/book:
    post:
      summary: book-appointments-handler
      description: "Book an appointment, send the confirmation, and then build a response. If a video visit ID\n  is provided, set the appointment ID for that visit in postgres."
      tags:
      - grdn.routes.impl.appointments
      responses:
        default:
          description: Default success response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: number
                    format: double
                  start-time:
                    type: string
                    x-allOf:
                    - type: string
                    - {}
                  time-zone:
                    type: string
                  duration:
                    type: number
                    format: double
                  department-id:
                    type: string
                    x-anyOf:
                    - type: string
                    - type: integer
                      format: int64
                  provider-id:
                    type: integer
                    format: int64
                    x-anyOf:
                    - type: integer
                      format: int64
                    - type: string
                  zoom-meeting-id:
                    type: string
                required:
                - id
                - start-time
                - time-zone
                - duration
                - department-id
                - provider-id
                title: grdn.specs.appointments/appointment
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                patient-id:
                  type: string
                  format: uuid
                next-step-id:
                  type: string
                  format: uuid
                appointment-ids:
                  type: array
                  items:
                    type: integer
                    format: int64
                    x-anyOf:
                    - type: integer
                      format: int64
                    - type: string
                current-user-tz:
                  type: string
                appointment-type:
                  type: integer
                  format: int64
                  x-anyOf:
                  - type: integer
                    format: int64
                  - type: string
                department-id:
                  type: string
                  x-anyOf:
                  - type: string
                  - type: integer
                    format: int64
                popup-id:
                  type: string
                  format: uuid
                video-visit-id:
                  type: string
                  format: uuid
                primary-complaint:
                  type: string
              required:
              - appointment-ids
              - department-id
              - appointment-type
              - primary-complaint
              - patient-id
              title: grdn.specs.appointments/book-appointments-params
        description: 'origin spec: grdn.specs.appointments/book-appointments-params'
  /v2/appointment/booked:
    get:
      summary: booked-appointments-handler
      description: Ask for all booked appointments for a patient.
      tags:
      - grdn.routes.impl.appointments
      parameters:
      - in: query
        name: patient-id
        description: 'origin spec: grdn.specs/patient-id-params'
        required: true
        schema:
          type: string
          format: uuid
      - in: query
        name: funnel-id
        description: 'origin spec: grdn.specs/patient-id-params'
        required: false
        schema:
          type: string
          format: uuid
      responses:
        default:
          description: Default success response.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    start-time:
                      type: string
                      x-allOf:
                      - type: string
                      - {}
                    provider-id:
                      type: integer
                      format: int64
                      x-anyOf:
                      - type: integer
                        format: int64
                      - type: string
                    id:
                      type: number
                      format: double
                    rendering-provider-id:
                      type:
                      - integer
                      - 'null'
                      format: int64
                    patient-appointment-type-name:
                      type: string
                    time-zone:
                      type: string
                    location:
                      type: object
                      properties:
                        name:
                          type: string
                        address-1:
                          type: string
                        city:
                          type: string
                        state:
                          type: string
                        zip:
                          type: string
                        address-2:
                          type:
                          - string
                          - 'null'
                      required:
                      - name
                      - address-1
                      - city
                      - state
                      - zip
                      title: grdn.specs.appointments/location
                    after-visit-summary:
                      type:
                      - object
                      - 'null'
                      properties:
                        appointment_id:
                          type: integer
                          format: int64
                        id:
                          type: string
                          format: uuid
                        patient_id:
                          type: string
                        updated-at: {}
                        status:
                          enum:
                          - ready-status
                          - pending-status
                          - sent-status
                          - expired-status
                          type: string
                        created-at: {}
                        content:
                          type:
                          - string
                          - 'null'
                        provider_id:
                          type: string
                        sending_provider_id:
                          type: string
                        encounter_id:
                          type: integer
                          format: int64
                        deleted_on: {}
                        message_id:
                          type: integer
                          format: int64
                      required:
                      - status
                      title: grdn.specs.after-visit-summary/after-visit-summary
                    encounter-id:
                      type:
                      - integer
                      - 'null'
                      format: int64
                      x-anyOf:
                      - type: integer
                        format: int64
                      - type: string
                    department-id:
                      type: string
                      x-anyOf:
                      - type: string
                      - type: integer
                        format: int64
                    duration:
                      type: number
                      format: double
                  required:
                  - id
                  - start-time
                  - duration
                  - time-zone
                  - department-id
                  - provider-id
                  - location
                  - patient-appointment-type-name
                  - rendering-provider-id
                  - after-visit-summary
                  title: grdn.specs.appointments/booked-appointment
  /v2/appointment/booked-established:
    get:
      summary: booked-appointments-established-handler
      description: "Ask for all booked appointments for a patient and returns\n   a vector of appointments and a boolean saying if the patient is established\n   TDD: https://edenhealth.atlassian.net/wiki/spaces/PE/pages/3350986788/TDD+Filter+Appointment+Reasons+on+Patient+App+depending+on+Patient+Status+New+VS+Established+Patient"
      tags:
      - grdn.routes.impl.appointments
      parameters:
      - in: query
        name: patient-id
        description: 'origin spec: grdn.specs/patient-id-params'
        required: true
        schema:
          type: string
          format: uuid
      - in: query
        name: funnel-id
        description: 'origin spec: grdn.specs/patient-id-params'
        required: false
        schema:
          type: string
          format: uuid
      responses:
        default:
          description: Default success response.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    start-time:
                      type: string
                      x-allOf:
                      - type: string
                      - {}
                    provider-id:
                      type: integer
                      format: int64
                      x-anyOf:
                      - type: integer
                        format: int64
                      - type: string
                    id:
                      type: number
                      format: double
                    rendering-provider-id:
                      type:
                      - integer
                      - 'null'
                      format: int64
                    patient-appointment-type-name:
                      type: string
                    time-zone:
                      type: string
                    location:
                      type: object
                      properties:
                        name:
                          type: string
                        address-1:
                          type: string
                        city:
                          type: string
                        state:
                          type: string
                        zip:
                          type: string
                        address-2:
                          type:
                          - string
                          - 'null'
                      required:
                      - name
                      - address-1
                      - city
                      - state
                      - zip
                      title: grdn.specs.appointments/location
                    after-visit-summary:
                      type:
                      - object
                      - 'null'
                      properties:
                        appointment_id:
                          type: integer
                          format: int64
                        id:
                          type: string
                          format: uuid
                        patient_id:
                          type: string
                        updated-at: {}
                        status:
                          enum:
                          - ready-status
                          - pending-status
                          - sent-status
                          - expired-status
                          type: string
                        created-at: {}
                        content:
                          type:
                          - string
                          - 'null'
                        provider_id:
                          type: string
                        sending_provider_id:
                          type: string
                        encounter_id:
                          type: integer
                          format: int64
                        deleted_on: {}
                        message_id:
                          type: integer
                          format: int64
                      required:
                      - status
                      title: grdn.specs.after-visit-summary/after-visit-summary
                    encounter-id:
                      type:
                      - integer
                      - 'null'
                      format: int64
                      x-anyOf:
                      - type: integer
                        format: int64
                      - type: string
                    department-id:
                      type: string
                      x-anyOf:
                      - type: string
                      - type: integer
                        format: int64
                    duration:
                      type: number
                      format: double
                  required:
                  - id
                  - start-time
                  - duration
                  - time-zone
                  - department-id
                  - provider-id
                  - location
                  - patient-appointment-type-name
                  - rendering-provider-id
                  - after-visit-summary
                  title: grdn.specs.appointments/booked-appointment
  /v2/appointment/{appointment-id}:
    put:
      summary: checkout-digital-visit-handler
      description: "Given patient and appointment, checkout the appointment\n  and send the patient a feedback survey. Always sends feedback\n  even if the checkout fails."
      tags:
      - grdn.routes.impl.appointments
      parameters:
      - in: path
        name: appointment-id
        description: 'origin spec: grdn.specs.appointments/checkout-digital-visit-params'
        required: true
        x-anyOf:
        - type: integer
          format: int64
        - type: string
        schema:
          type: integer
          format: int64
      responses:
        default:
          description: Default success response.
          content:
            application/json:
              schema: {}
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                patient-id:
                  type: string
                  format: uuid
              title: grdn.specs.appointments/checkout-digital-visit-params
        description: 'origin spec: grdn.specs.appointments/checkout-digital-visit-params'
  /v2/appointment/{appointment-id}/after-visit-summary:
    delete:
      summary: delete-after-visit-summary-message-handler
      description: "Updates an after-visit-summary message custom type to deleted and changes content to empty string.\n   If deleting message and image are successful, logs an event about the deleted message to the db."
      tags:
      - grdn.routes.impl.appointments
      parameters:
      - in: path
        name: appointment-id
        description: 'origin spec: grdn.specs.appointments/delete-after-visit-summary-message-params'
        required: true
        x-anyOf:
        - type: integer
          format: int64
        - type: string
        schema:
          type: integer
          format: int64
      responses:
        default:
          description: Default success response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  after-visit-summary:
                    type: object
                    properties:
                      appointment_id:
                        type: integer
                        format: int64
                      id:
                        type: string
                        format: uuid
                      patient_id:
                        type: string
                      updated-at: {}
                      status:
                        enum:
                        - ready-status
                        - pending-status
                        - sent-status
                        - expired-status
                        type: string
                      created-at: {}
                      content:
                        type:
                        - string
                        - 'null'
                      provider_id:
                        type: string
                      sending_provider_id:
                        type: string
                      encounter_id:
                        type: integer
                        format: int64
                      deleted_on: {}
                      message_id:
                        type: integer
                        format: int64
                    required:
                    - status
                    title: grdn.specs.after-visit-summary/after-visit-summary
                required:
                - after-visit-summary
                title: grdn.specs.appointments/delete-after-visit-summary-message-response
    post:
      summary: send-after-visit-summary-handler
      description: Creates an after-visit-summary record in grdn db and sends a message in the patient's chat.
      tags:
      - grdn.routes.impl.appointments
      parameters:
      - in: path
        name: appointment-id
        description: 'origin spec: grdn.specs.appointments/send-after-visit-summary-params'
        required: true
        x-anyOf:
        - type: integer
          format: int64
        - type: string
        schema:
          type: integer
          format: int64
      responses:
        default:
          description: Default success response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  after-visit-summary:
                    type: object
                    properties:
                      appointment_id:
                        type: integer
                        format: int64
                      id:
                        type: string
                        format: uuid
                      patient_id:
                        type: string
                      updated-at: {}
                      status:
                        enum:
                        - ready-status
                        - pending-status
                        - sent-status
                        - expired-status
                        type: string
                      created-at: {}
                      content:
                        type:
                        - string
                        - 'null'
                      provider_id:
                        type: string
                      sending_provider_id:
                        type: string
                      encounter_id:
                        type: integer
                        format: int64
                      deleted_on: {}
                      message_id:
                        type: integer
                        format: int64
                    required:
                    - status
                    title: grdn.specs.after-visit-summary/after-visit-summary
                required:
                - after-visit-summary
                title: grdn.specs.appointments/send-after-visit-summary-response
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                content:
                  type: string
                  allowEmptyValue: true
              required:
              - content
              title: grdn.specs.appointments/send-after-visit-summary-params
        description: 'origin spec: grdn.specs.appointments/send-after-visit-summary-params'
  /v2/appointment/{appointment-id}/cancel:
    put:
      summary: cancel-appointment-handler
      description: Cancels a patients appointment.
      tags:
      - grdn.routes.impl.appointments
      parameters:
      - in: path
        name: appointment-id
        description: 'origin spec: grdn.specs.appointments/appointment-id-params'
        required: true
        x-anyOf:
        - type: integer
          format: int64
        - type: string
        schema:
          type: integer
          format: int64
      responses:
        default:
          description: Default success response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  appointment-id:
                    type: integer
                    format: int64
                    x-anyOf:
                    - type: integer
                      format: int64
                    - type: string
                required:
                - appointment-id
                title: grdn.specs.appointments/cancel-appointment-response
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                message:
                  type: string
              title: grdn.specs.appointments/appointment-id-params
        description: 'origin spec: grdn.specs.appointments/appointment-id-params'
  /v2/appointment/{appointment-id}/check-in:
    post:
      summary: check-in-appointment-handler
      description: Given an existing appointment, checks the user in and assigns screeners.
      tags:
      - grdn.routes.impl.appointments
      parameters:
      - in: path
        name: appointment-id
        description: 'origin spec: grdn.specs.appointments/check-in-appointment-params'
        required: true
        x-anyOf:
        - type: integer
          format: int64
        - type: string
        schema:
          type: integer
          format: int64
      responses:
        default:
          description: Default success response.
          content:
            application/json:
              schema: {}
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                patient-id:
                  type: string
                  format: uuid
                screener-names:
                  type: array
                  items:
                    type: string
              required:
              - patient-id
              title: grdn.specs.appointments/check-in-appointment-params
        description: 'origin spec: grdn.specs.appointments/check-in-appointment-params'
    get:
      summary: get-check-in-screeners-handler
      description: Gets the screeners available for an appointment.
      tags:
      - grdn.routes.impl.appointments
      parameters:
      - in: path
        name: appointment-id
        description: 'origin spec: grdn.specs.appointments/appointment-id-params'
        required: true
        x-anyOf:
        - type: integer
          format: int64
        - type: string
        schema:
          type: integer
          format: int64
      - in: query
        name: message
        description: 'origin spec: grdn.specs.appointments/appointment-id-params'
        required: false
        schema:
          type: string
      responses:
        default:
          description: Default success response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  appointment-id:
                    type: integer
                    format: int64
                    x-anyOf:
                    - type: integer
                      format: int64
                    - type: string
                  screener-names:
 

# --- truncated at 32 KB (49 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/eden-health/refs/heads/main/openapi/eden-health-grdn-routes-impl-appointments-api-openapi.yml