All notable changes to the Aton Health API will be documented here. We follow semantic versioning and maintain backward compatibility whenever possible.

Version 1.1.0 - 2025-10-28

Added

• Qualified Referrals API - New endpoint suite for handling pre-qualified patient referrals from partners

New API Endpoints

• POST /referrals/qualified - Submit pre-qualified patient referrals with detailed patient information
• GET /referrals/qualified - Retrieve all submitted qualified referrals
• GET /referrals/qualified/{external_source_id} - Get specific qualified referral by external partner ID

Key Features

• Separate storage system for qualified referrals independent of trial-based referrals
• Comprehensive field validation including date format enforcement and gender validation
• Full audit trail with submission timestamps and structured logging

Benefits for Partners

• Streamlined workflow for pre-qualified patients bypassing initial screening
• Rich data collection supporting enhanced patient matching and care coordination
• Independent operations allowing parallel processing of standard and qualified referrals

Version 1.0.1 - 2025-10-14

Improved

• Enhanced logging and monitoring for better API reliability and debugging
• Improved error reporting with more detailed error messages and tracking
• Performance optimizations for faster response times
• Better audit trail capabilities for compliance and troubleshooting

Technical Notes

• No breaking changes to existing API endpoints
• All existing integrations continue to work without modification
• Improved internal logging structure for better support capabilities

Version 1.0.0 - 2025-10-13

Added

• 🎉 Initial public release of the Aton Health Patient Referrals API
• OAuth 2.0 authentication using Microsoft Identity Platform for secure access
• Patient referrals management with comprehensive submission and retrieval endpoints
• Clinical trials discovery to identify active trials accepting referrals
• Health check endpoints for integration monitoring and connectivity testing
• Comprehensive error handling with detailed error messages and status codes
• Rate limiting to ensure fair usage and service reliability
• HIPAA-compliant architecture with encrypted data transmission and secure storage

API Endpoints

• POST /referrals/ - Submit new patient referrals
• GET /referrals/ - Retrieve all submitted referrals
• GET /referrals/{trial_id}/{outcomes_id} - Get specific referral by ID
• GET /referrals/trials - List all active clinical trials
• GET /health/ping - API connectivity and health check

Environments

• Development: https://dev-api.aton.health/api/v1
• Production: https://api.aton.health/api/v1

Authentication

• Method: OAuth 2.0 Client Credentials flow
• Token Endpoint: Microsoft Identity Platform
• Token Lifetime: ~1 hour with automatic refresh capability

Partner Notes

• This is the first stable release ready for production integration
• All endpoints are fully tested and validated for HIPAA compliance
• Comprehensive documentation and code examples available
• Sandbox environment available for development and testing
• Integration support provided by our technical team

Breaking Changes Policy

We are committed to maintaining API stability and backward compatibility. When breaking changes are necessary:

• 30-day advance notice via email to all registered partners
• Detailed migration guides with code examples
• Parallel API versions supported during transition periods
• Direct technical support for migration assistance

What constitutes a breaking change:

• Removing or renaming API endpoints
• Changing required request parameters
• Modifying response data structures
• Changing authentication requirements
• Altering error response formats

Non-breaking changes (no notice required):

• Adding new optional parameters
• Adding new response fields
• Adding new endpoints
• Improving error messages
• Performance optimizations
• Bug fixes

Deprecation Schedule

Currently, no features are scheduled for deprecation. When deprecations occur:

• 90-day minimum notice before removal
• Migration path provided with updated documentation
• Support assistance available during transition
• Continued support until removal date

Version Support

Support Levels:

• Full support: New features, bug fixes, security updates
• Security only: Critical security patches only
• End of life: No updates or support

How to Stay Updated

Automatic Notifications

• Email alerts for breaking changes and major updates (automatic for all partners)
• Service announcements for maintenance windows and outages

Manual Tracking

• Subscribe to this changelog by bookmarking this page
• Join partner webinars for updates and Q&A sessions

Integration Health Monitoring

We recommend monitoring these indicators in your integration:

• API response times and error rates
• Authentication token refresh patterns
• Rate limiting near your usage limits

Feedback & Suggestions

Your feedback shapes our API development roadmap. Contact us with:

• Feature requests for new capabilities
• Integration challenges you're facing
• Performance feedback from your usage patterns
• Documentation improvements that would help your team

Contact: integration-support@atonhealth.com

Migration Guides

Migrating to v1.0.1 from v1.0.0

No action required - this is a non-breaking update focused on internal improvements.

Future Migrations

Detailed migration guides will be provided here when version updates require code changes.

Questions about API changes?

Contact our integration team at integration-support@atonhealth.com for assistance with any version updates or migration planning.

Last Updated: October 14, 2025
API Version: 1.0.1
Documentation Version: 1.0