Appointment APIs

Authorization: Bearer YOUR_AUTH_TOKEN

/appointments

curl -X GET "http://localhost:3000/appointments?date=2025-01-15&status=scheduled" \
  -H "Authorization: Bearer YOUR_AUTH_TOKEN"

{
  "success": true,
  "data": [
    {
      "id": 123,
      "appointment_date": "2025-01-15",
      "appointment_time": "10:00",
      "duration": 30,
      "status": "scheduled",
      "reason": "Regular checkup",
      "notes": "Patient reports mild headaches",
      "patient": {
        "id": 456,
        "first_name": "John",
        "last_name": "Doe",
        "phone_number": "9999999999",
        "age": 35
      },
      "doctor": {
        "id": 789,
        "first_name": "Dr. Sarah",
        "last_name": "Smith",
        "speciality": "General Physician",
        "consultation_fee": 500
      },
      "clinic": {
        "id": 101,
        "name": "City Health Clinic"
      },
      "created_at": "2025-01-10T08:30:00Z",
      "updated_at": "2025-01-12T14:20:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 20,
    "total": 45,
    "total_pages": 3
  }
}

{
  "appointment": {
    "clinic_patient_id": 456,
    "clinic_doctor_id": 789,
    "appointment_date": "2025-01-15",
    "appointment_time": "10:00",
    "duration": 30,
    "reason": "Regular checkup",
    "notes": "Patient reports mild headaches",
    "appointment_type": "consultation",
    "booking_source": "online"
  }
}

curl -X POST http://localhost:3000/appointments \
  -H "Authorization: Bearer YOUR_AUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "appointment": {
      "clinic_patient_id": 456,
      "clinic_doctor_id": 789,
      "appointment_date": "2025-01-15",
      "appointment_time": "10:00",
      "reason": "Regular checkup"
    }
  }'

{
  "success": true,
  "data": {
    "id": 123,
    "appointment_date": "2025-01-15",
    "appointment_time": "10:00",
    "status": "scheduled",
    "appointment_number": "APT001234",
    "confirmation_code": "ABC123",
    // ... complete appointment data
  },
  "message": "Appointment booked successfully"
}

{
  "success": false,
  "error": "Appointment could not be created",
  "errors": {
    "appointment_time": ["is not available"],
    "clinic_doctor_id": ["doctor is not available on this date"]
  }
}

curl -X GET http://localhost:3000/appointments/123 \
  -H "Authorization: Bearer YOUR_AUTH_TOKEN"

{
  "success": true,
  "data": {
    "id": 123,
    "appointment_date": "2025-01-15",
    "appointment_time": "10:00",
    "duration": 30,
    "status": "scheduled",
    "reason": "Regular checkup",
    "notes": "Patient reports mild headaches",
    "appointment_type": "consultation",
    "appointment_number": "APT001234",
    "confirmation_code": "ABC123",
    "patient": {
      "id": 456,
      "first_name": "John",
      "last_name": "Doe",
      "phone_number": "9999999999",
      "email": "john.doe@email.com",
      "age": 35,
      "gender": "M",
      "blood_group": "O+",
      "allergies": ["Penicillin"],
      "medical_history": "Hypertension, Diabetes Type 2"
    },
    "doctor": {
      "id": 789,
      "first_name": "Dr. Sarah",
      "last_name": "Smith",
      "speciality": "General Physician",
      "qualification": "MBBS, MD",
      "consultation_fee": 500,
      "experience_years": 8
    },
    "clinic": {
      "id": 101,
      "name": "City Health Clinic",
      "address": "123 Main St, Mumbai",
      "phone_number": "9888888888"
    },
    "vitals": {
      "weight": 70,
      "height": 175,
      "bp_systolic": 120,
      "bp_diastolic": 80,
      "pulse": 72,
      "temperature": 98.6
    },
    "prescriptions": [],
    "invoices": [],
    "created_at": "2025-01-10T08:30:00Z",
    "updated_at": "2025-01-12T14:20:00Z"
  }
}

{
  "appointment": {
    "appointment_date": "2025-01-16",
    "appointment_time": "11:00",
    "reason": "Follow-up checkup",
    "notes": "Updated notes",
    "status": "confirmed"
  }
}

curl -X PUT http://localhost:3000/appointments/123 \
  -H "Authorization: Bearer YOUR_AUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "appointment": {
      "appointment_time": "11:00",
      "status": "confirmed"
    }
  }'

curl -X DELETE "http://localhost:3000/appointments/123?reason=Patient%20rescheduled" \
  -H "Authorization: Bearer YOUR_AUTH_TOKEN"

{
  "success": true,
  "message": "Appointment cancelled successfully"
}

{
  "check_in_time": "2025-01-15T09:55:00Z",
  "vitals": {
    "weight": 70,
    "height": 175,
    "bp_systolic": 120,
    "bp_diastolic": 80,
    "pulse": 72,
    "temperature": 98.6
  }
}

curl -X POST http://localhost:3000/appointments/123/check_in \
  -H "Authorization: Bearer YOUR_AUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "vitals": {
      "weight": 70,
      "bp_systolic": 120,
      "bp_diastolic": 80
    }
  }'

curl -X POST http://localhost:3000/appointments/123/start_consultation \
  -H "Authorization: Bearer YOUR_AUTH_TOKEN"

{
  "success": true,
  "data": {
    "id": 123,
    "status": "in_progress",
    "consultation_started_at": "2025-01-15T10:05:00Z"
  },
  "message": "Consultation started"
}

{
  "diagnosis": "Common cold with mild fever",
  "treatment_notes": "Prescribed antibiotics and rest",
  "next_visit_date": "2025-01-22",
  "prescriptions": [
    {
      "medicine_name": "Paracetamol",
      "dosage": "500mg",
      "frequency": "Twice daily",
      "duration": "5 days",
      "instructions": "Take after meals"
    }
  ],
  "investigations": [
    {
      "test_name": "Complete Blood Count",
      "notes": "Routine check"
    }
  ]
}

curl -X POST http://localhost:3000/appointments/123/complete \
  -H "Authorization: Bearer YOUR_AUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "diagnosis": "Common cold",
    "treatment_notes": "Rest and medication"
  }'

curl -X GET "http://localhost:3000/appointments/slots?doctor_id=789&date=2025-01-15" \
  -H "Authorization: Bearer YOUR_AUTH_TOKEN"

{
  "success": true,
  "data": {
    "date": "2025-01-15",
    "doctor": {
      "id": 789,
      "name": "Dr. Sarah Smith",
      "speciality": "General Physician"
    },
    "available_slots": [
      {
        "time": "09:00",
        "available": true
      },
      {
        "time": "09:30",
        "available": true
      },
      {
        "time": "10:00",
        "available": false,
        "reason": "Already booked"
      },
      {
        "time": "10:30",
        "available": true
      }
    ],
    "total_slots": 16,
    "available_count": 12,
    "booked_count": 4
  }
}

curl -X GET http://localhost:3000/appointments/today \
  -H "Authorization: Bearer YOUR_AUTH_TOKEN"

curl -X GET "http://localhost:3000/appointments/upcoming?days=14" \
  -H "Authorization: Bearer YOUR_AUTH_TOKEN"

scheduled → confirmed → checked_in → in_progress → completed
    ↓           ↓           ↓            ↓
cancelled   cancelled   cancelled    cancelled
    ↓           ↓           ↓
no_show     no_show     no_show

{
  "success": false,
  "error": "Time slot not available",
  "errors": {
    "appointment_time": ["Doctor is not available at this time"]
  }
}

{
  "success": false,
  "error": "Patient not found",
  "details": "No patient found with ID 456 in your clinic"
}

{
  "success": false,
  "error": "Invalid status transition",
  "details": "Cannot change status from 'completed' to 'scheduled'"
}

{
  "event": "appointment.created",
  "data": {
    "appointment_id": 123,
    "patient_id": 456,
    "doctor_id": 789,
    "clinic_id": 101,
    "appointment_date": "2025-01-15",
    "appointment_time": "10:00"
  },
  "timestamp": "2025-01-10T08:30:00Z"
}