Skip to main content

Welcome to VidaPlus API

VidaPlus API is a comprehensive hospital management solution designed to streamline healthcare operations. Built with FastAPI, it provides secure, organized, and well-documented endpoints for managing all aspects of hospital administration.

What is VidaPlus API?

VidaPlus API is a REST API that enables hospitals and healthcare facilities to manage their operations efficiently. The system handles everything from patient registration to prescription management, providing a complete backend solution for healthcare applications.
The API uses JWT (JSON Web Token) authentication to ensure secure access to all protected endpoints.

Key Features

VidaPlus API provides comprehensive management capabilities across multiple domains:

Patient Management

Complete CRUD operations for patient registration, consultation, updates, and removal. Manage patient demographics, contact information, and medical history.

Healthcare Professionals

Manage healthcare professionals with role-based permissions and authentication. Track credentials, specializations, and availability.

Appointments

Schedule, list, update, and cancel medical appointments. Coordinate between patients and healthcare professionals efficiently.

Medical Records

Create and access complete medical histories for patients. Maintain comprehensive prontuários (medical records) with secure access control.

Prescriptions

Register and control medical prescriptions. Track medications, dosages, and prescription history for each patient.

Laboratory Exams

Request, track, and manage laboratory exam results. Monitor the complete lifecycle of medical tests.

Bed Management

Manage hospital bed occupancy and availability. Track bed assignments and optimize hospital capacity.

Inventory Control

Complete inventory management for hospital supplies, medications, and equipment. Track stock levels and manage procurement.

Technology Stack

VidaPlus API is built using modern, production-ready technologies:
  • Python 3.13 - Latest Python version for optimal performance
  • FastAPI - High-performance async web framework
  • SQLAlchemy - Powerful ORM with async support
  • PostgreSQL - Robust relational database
  • Pydantic - Data validation using Python type hints
  • PyJWT - JSON Web Token implementation
  • Alembic - Database migration management
  • pytest - Comprehensive testing framework

API Architecture

The API follows RESTful principles with organized endpoints grouped by resource:
  • /pacientes/ - Patient management
  • /profissionais/ - Healthcare professional management
  • /consultas/ - Appointment scheduling
  • /prontuario/ - Medical records
  • /prescricoes/ - Prescription management
  • /exames/ - Laboratory exam management
  • /leitos/ - Bed management
  • /estoque/ - Inventory control
  • /auth/token/ - Authentication endpoints
Each endpoint supports standard CRUD operations with proper validation, permission checks, and business logic enforcement.

Interactive Documentation

VidaPlus API includes built-in interactive documentation powered by FastAPI:
  • Swagger UI: Available at /docs - Interactive API explorer
  • ReDoc: Available at /redoc - Alternative documentation view
  • OpenAPI Schema: Available at /api/v1/openapi.json - Machine-readable API specification

Security & Authentication

The API implements enterprise-grade security:
1

JWT Authentication

All protected endpoints require a valid JWT access token obtained through the login endpoint.
2

Role-Based Access Control

Different user types (patients, professionals, administrators) have specific permissions enforced at the endpoint level.
3

Password Hashing

Passwords are securely hashed using Argon2 through the pwdlib library.
4

Token Refresh

Support for token refresh to maintain secure, long-lived sessions without storing passwords.

Getting Started

Ready to start using VidaPlus API? Follow our quickstart guide to make your first API call in minutes.

Quickstart Guide

Learn how to install dependencies, authenticate, and make your first API request

Need Help?

If you encounter any issues or have questions:
  • Check the API Reference section for detailed endpoint documentation
  • Review Authentication guide for security-related questions
  • Explore Examples for common use cases and code samples

Developer: VidaPlus API is developed and maintained by Rauane Lima

Build docs developers (and LLMs) love