Appointments

The Appointment Management API provides a robust solution for scheduling, managing, and tracking appointments efficiently. It enables seamless integration with applications.

Create or update a appointment

To create or update a appointment you can use the next path

POST {base_url}/appointment/upsert

The body allows the following fields:

Field	Required	Description
id	No	Number field that identifies the appointment, necessary to modify an appointment.
appointmentDate	Yes	Object representing the date of the appointment, using Dialogflow's date format.
appointmentTime	Yes	Object representing the time of the appointment, using Dialogflow's time format.
durationMinutes	Yes	Number field specifying the duration of the appointment in minutes.
reason	No	String field providing the reason for the appointment.
status	Yes	Enum field representing the current status of the appointment. (scheduled,confirmation,follow-up,completed or canceled)
notes	No	String field providing additional notes about the appointment.
patient	Yes	Object containing information about the patient involved in the appointment.
patientPhoneNumber	Yes	String field that defines the phone number of the patient.

Example

{
    "appointmentDate": {
        "year": 2024,
        "month": 11,
        "day": 12
    },
    "appointmentTime": {
        "minutes": 30,
        "seconds": 0,
        "nanos": 0,
        "hours": 0
    },
    "durationMinutes": 30,
    "reason": "Flu",
    "status": "canceled",
    "notes": "Caused by influenza viruses (types A, B, C, and D), Spread through respiratory droplets when coughing, sneezing, or talking.",
    "patient": {
        "name": "John Snow",
        "original": "John"
    },
    "patientPhoneNumber": "0018554248040"
}

Create or update a appointment​

Create or update a appointment