BriteAPI Changelog

The changelog is a curated list of notable updates in the BriteAPI DrugInfo. While minor backwards-compatible additions and improvements (such as performance enhancements of an endpoint) might not be listed here, significant new features and updates are documented.

April 2024

  • New Bookings and Scheduling API:
    • API, allows developers to seamlessly integrate dynamic medical booking and scheduling functionalities into their applications.
      • Developers can now draw from britelinks infrastructure to manage and facilitate medical appointments efficiently.

February 2024

  • New Clinical APIS:

    • Drug Dosage Information: Introduced a new endpoint, GET /api/v1/dosages, offering comprehensive drug dosage data across all available forms.
    • Food Interaction Endpoint: Added a sub-endpoint for drug-to-food interactions, enhancing the API's utility in clinical settings.

  • Chemistry API Updates:

    • Pagination Support: Implemented pagination for all endpoints, enabling smoother data retrieval for large datasets.
    • Enhanced Search and Filters: Incorporated dynamic fuzzy and exact search capabilities, improving accessibility to chemistry data.
    • Expanded Drug Classifications: Augmented the API with additional drug classifications, enriching the available chemical structure information.

  • New Disease API:

    • Comprehensive Disease Data: Released a new API endpoint, GET /api/v1/diseases, offering access to detailed information on over 5,000 diseases.
    • Advanced Search Capabilities: Enabled searching for diseases by name with options for fuzzy or exact matches, using the n and exact query parameters.
    • Customizable Detail Levels: The r query parameter lets users choose between receiving basic disease names or detailed information, including synonyms and classifications.
    • Dynamic Sorting and Pagination: Added functionality for alphabetical sorting (s and sOrder parameters) and cursor-based pagination to efficiently manage large datasets, supporting batch sizes up to 250.

  • Added Labs API:

    • Data Access for Laboratory Tests: Introduced a new API endpoint, GET /api/v1/labs, to provide access to a comprehensive list of laboratory tests.
    • Flexible Search: Users can search for tests based on test names, category names, or subcategory names using the n query parameter.
    • Conditional Field Inclusion: The r query parameter allows users to specify whether to include additional fields in the test model for detailed information.
    • Efficient Pagination: Implemented cursor-based pagination for smooth navigation through test data, with a default batch size of 25 tests.

  • Added Premises API:

    • Access to Premises Information: Introduced the GET /api/v1/premises endpoint for accessing premises information related to pharmacies and healthcare facilities.
    • Search by Premise Name: Users can search for premises by premise name(s) using the n query parameter.
    • Conditional Data Retrieval: The r query parameter provides the option to include additional fields in the premises data, enabling more detailed information when needed.
    • Efficient Pagination: Implemented cursor-based pagination for seamless retrieval of premises data, with a default batch size of 25 premises.

January 2024

  • Updated Condition Endpoint:

    • Enhanced Query Flexibility: The q parameter is now optional, enabling users to fetch all conditions or apply specific name-based filters.
    • Extended Data Retrieval: Added the r parameter to include detailed information about related drugs and indications in the response.
    • Improved Pagination: Introduced cursor-based pagination for efficient navigation through large datasets, with a default batch size of 10 conditions.

  • New API Endpoint - Categories: Added new endpoint GET /api/v1/categories for fetching categories of drugs. This endpoint supports filtering by category names and includes options for pagination and detailed drug information retrieval. Here are the key features:

    • Filtering by Category Names: Users can now filter categories by passing a comma-separated list of category names using the c query parameter.
    • Pagination Support: To handle large sets of data efficiently, the endpoint implements cursor-based pagination, allowing users to fetch categories in batches of 25. The cursor query parameter and a nextCursor in the response facilitate this functionality.
    • Drug Information Inclusion: An optional feature where users can choose to include related drug information in the category data by setting the r query parameter to true.
    • Enhanced Data Integrity and Security: The endpoint utilizes the stripServerHtml utility function to ensure the API response is free of HTML, catering to systems that require plain text data.

  • Updated - Get All Drugs Endpoint: The Get All Drugs endpoint has been enhanced with pagination support, improving data handling and user experience. The updated features include:

    • Cursor-Based Pagination: A nextCursor parameter is now included in responses, enabling efficient batch-wise data fetching and better handling of large datasets.
    • Improved Response Handling: The pagination update ensures a smoother and more manageable data retrieval process, especially for applications dealing with extensive drug databases.

  • New Utility Function - stripServerHtml: A new utility function stripServerHtml has been added to our suite of tools. This function is crucial for:

    • Removing HTML Content: It efficiently strips HTML content from API response data, ensuring compatibility with systems that necessitate plain text.
    • Enhancing Security: By removing HTML, it also reduces the risk of HTML injection attacks and improves overall data security.
    • Detailed usage and benefits can be found in Handling HTML Content.

December 2023

  • Enhanced: Added comprehensive drug interaction data. This update allows users to access detailed information on potential interactions between different drugs, enhancing patient safety and care.
  • Improved: Optimized API response times. Made significant backend improvements to ensure faster data retrieval, providing a more efficient user experience.

November 2023

  • New: Introduced optional JSON data returns, formatted according to FHIR-HL7 standards. This enhancement caters to the needs of systems utilizing FHIR-HL7, allowing for seamless integration and interoperability.
  • Added: Implemented a drug classification system. Users can now retrieve drugs based on their classification, aiding in more precise and categorically organized searches.

October 2023

  • Added: Implemented API authentication. Enhanced security measures now require API keys for accessing endpoints, ensuring secure and authorized usage.
  • Updated: Included drug formulation and packaging information. This additional data provides users with detailed insights into various drug formulations and packaging types available.

September 2023

  • Initial Release: Launched the BriteAPI with a set of core endpoints including drug identification, basic drug information, and dosage guidelines. This initial rollout marked the beginning of our journey to provide comprehensive and reliable clinical data services.
  • New: Added support for drug adverse effect data. This feature enables users to access information about potential side effects associated with different drugs.