API Changelog

All notable changes to the HIE API will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[1.1.0] - 2026-01-30

Added

• Preauth Polymorphism: Enabled polymorphic request support for POST /api/v1/preauths, allowing submission of various preauthorization types (Normal, Surgical, Renal, Oncology, Optical, Imaging, Dental) via multipart/form-data.
• Preauth Schemas: Added specialized request schemas for all preauthorization types.

Changed

• Metadata Harmonization: Updated summaries, descriptions, and tags for over 25 endpoints in Claims, Emergency, Interventions, and Patients services to align with legacy API documentation standards.
• Tag Alignment: Standardized tags across the eClaims and Preauth API (e.g., Billing, Claim Dispatch, Emergency, Preauths, Eligibility) to match the openapi.json definitions.
• Parameter Preservation: Harmonized metadata while explicitly preserving the new API's parameter structure, ensuring no breaking changes to request signatures.

Fixed

• API Validation: Fixed a missing path parameter definition in api_v1_preauths_diagnoses_{icd_code}.json.
• Tag Inconsistencies: Corrected generic Claims tags to more specific functional categories (e.g., Start Visit Consent, Claim Dispatch, Billing).

[1.0.0] - 2025-12-11

Added

• New Endpoints:
  • /api/v1/patients/eligibility (Check Eligibility)
  • /api/v1/patients/benefits (Get Benefits)
  • /api/v1/claims/otp-discharge (Discharge OTP)
  • /api/v1/claims/discharge (Discharge Patient)
• Metadata Restoration: Restored legacy descriptions, tags, and parameters for 19 endpoints to ensure backward compatibility.

Changed

• Directory Structure:
  • Migrated all OAS components to apis/components.
  • Updated all $ref paths to point to the new shared components location.
• Endpoint Updates:
  • /api/v1/patients/sub-benefits: Restored legacy parameters (beneficiary_cr_id, applicable_schemes, facility_id, search).

Fixed

• Bundling: Fixed schema resolution errors during the bundling process by restoring missing legacy schemas.
• Schema References: Corrected broken $ref paths in multiple endpoint files.

Removed

• Unused Schemas: Deleted 113 unused schema files to clean up the codebase.
• Temporary Directories: Removed HIE-Middlewar-OAS directory after migration.