Skip to main content

Overview

The Medical Appointment Management API is a preliminary prototype built with .NET 10, designed as a foundation for a healthcare scheduling system. Currently, the API includes a fully functional Medical Specialties resource with complete CRUD operations, while other resources (Patients, Doctors, and Appointments) are defined as architectural placeholders for future implementation.
Development Status: This is a preliminary project. Only the /api/Especialidad endpoints are fully implemented and functional. Patient, Doctor, and Appointment endpoints are architectural stubs that will be implemented in future development phases.

What is this API?

Currently Implemented

Manage medical specialties - Fully functional CRUD operations for medical specialties (Cardiology, Pediatrics, etc.)

Planned for Future Development

The following features are architecturally defined but not yet implemented:
  • 🔄 Manage patient records - Store and retrieve patient information (planned)
  • 🔄 Organize medical staff - Maintain doctor profiles with specialties (planned)
  • 🔄 Schedule appointments - Create and track appointments (planned)
  • 🔄 Track appointment status - Monitor appointment lifecycle (planned)

Key Features

RESTful Architecture

Clean, predictable API endpoints following REST best practices with proper HTTP methods and status codes

Service-Oriented Design

Well-structured service layer with dependency injection for maintainable and testable code

OpenAPI Integration

Full OpenAPI 3.0 specification with interactive Scalar UI for easy exploration and testing

Type-Safe

Built with C# and .NET 10 for robust type checking and compile-time safety

Who Should Use This API?

This API is designed for:
  • Healthcare Application Developers - Building patient scheduling systems, clinic management software, or telemedicine platforms
  • Mobile App Developers - Creating iOS/Android apps for medical appointment booking
  • Web Developers - Building healthcare portals and patient management dashboards
  • System Integrators - Integrating appointment scheduling into existing healthcare systems

Core Resources

The API is designed around four primary resources:

✅ Specialties (Especialidades) - IMPLEMENTED

Define and manage medical specialties like Cardiology, Pediatrics, General Medicine, etc. This resource is fully functional with complete CRUD operations.

🔄 Patients (Pacientes) - PLANNED

Patient information structure is defined, but endpoints are not yet implemented.

🔄 Doctors (Medicos) - PLANNED

Doctor profile structure is defined with specialty relationships, but endpoints are not yet implemented.

🔄 Appointments (Citas) - PLANNED

Appointment data model is defined with status tracking, but endpoints are not yet implemented.

Technology Stack

  • .NET 10 - Latest .NET framework for high-performance web APIs
  • ASP.NET Core - Modern web framework with built-in dependency injection
  • OpenAPI/Swagger - API specification and documentation
  • Scalar - Beautiful, interactive API documentation UI
  • C# 12 - Latest C# language features including required properties

Getting Started

Quick Start Guide

Get up and running in minutes with our step-by-step quickstart guide. Clone the repository, run the project, and make your first API call.

Architecture Overview

The API follows a clean architecture pattern:
Controllers → Services → Data Storage
  • Controllers - Handle HTTP requests and responses
  • Services - Implement business logic and data operations
  • Models - Define entities and data transfer objects (DTOs)
Learn more about the architecture in the Architecture guide.

Next Steps

Quickstart

Run the API and make your first request

API Reference

Explore all available endpoints

Data Models

Understand the entity structures

Development Guide

Learn how to extend the API

Build docs developers (and LLMs) love