Skip to main content

Introduction

This technical documentation is exclusively intended for the IT departments of healthcare centers that intend to make use of the AIMS platform. Herein you will find detailed information on the platform's architecture, core functionalities, and API instructions for seamless use.

Overview​

The AIMS platform is an advanced risk assessment tool specializing in Oropharyngeal Dysphagia (OD), Aspiration Pneumonia (AP), and Malnutrition (MN). It is architected to allow IT professionals to submit non-identifying patient data and receive immediate risk predictions.

Core Functionalities​

1. Risk Prediction​

The cornerstone of the AIMS platform is its capability to deliver risk assessments for specific diseases: Oropharyngeal Dysphagia (OD), Aspiration Pneumonia (AP), and Malnutrition (MN).

Features:​

  • Real-time Analysis: Immediate risk evaluation upon data submission.
  • Multi-disease Support: Capable of assessing risks for multiple diseases concurrently.

Requirements:​

  • Data Format: Patient data must conform to predefined structures and types.
  • API Calls: Proper API call formation is required to initiate the risk assessment.

2. Data Standardization​

The platform does not adapt to varying data structures from different healthcare systems. It is imperative that the data submitted via web query conforms to a specific, predetermined structure.

Requirements:​

  • Fixed Data Schema: Data must be submitted according to a specific schema that will be provided.
  • Data Validation: Mandatory validation checks are in place, and data not conforming to the specified structure will be rejected.

3. API Availability​

The AIMS platform provides a robust API to facilitate data exchange and function calls.

Features:​

  • RESTful Architecture: Built on REST principles for ease of integration.
  • Secure Transmission: All data is encrypted during transmission.
  • Extensive Documentation: Comprehensive API documentation for straightforward implementation.

Requirements:​

  • Authentication: API keys are required for access.
  • Rate Limiting: Restrictions on the number of API calls per minute to ensure system stability.
note

The algorithmic details that power these functionalities are proprietary and not available for public review.

Technical Integration

This section provides detailed guidance on how to interact with the AIMS platform as a standalone web service. As the platform is not designed for direct integration into existing healthcare IT systems, the focus will be on using the web service effectively through secure HTTPS requests and understanding the associated responses.

Web Service Interaction​

1. API Endpoints​

An exhaustive list of API endpoints that can be called to retrieve risk assessments, each with their respective request and response formats and parameters.

2. Request/Response Formats​

Example structures for well-formed API requests and the responses to expect. This includes details on successful outcomes and possible error scenarios.

3. Sample API Calls​

Illustrative examples or code snippets demonstrating how to make HTTPS requests to the AIMS web service effectively.

Security Measures​

1. HTTPS Protocol​

Details on the HTTPS encryption protocols employed to ensure secure data transmission.

2. Authentication​

Methods available for authenticating API calls, such as API keys.

Error Handling and Debugging​

1. Error Codes​

A detailed list of error codes you might encounter while interacting with the web service, along with troubleshooting guidance.

2. HTTP Status Codes​

Explanation of the HTTP status codes returned by the AIMS web service and what each implies.

Resource Limits​

1. Rate Limiting​

Policies and limitations on the number of API calls that can be made within a given time frame to ensure fair usage and system stability.

Resources​

  • API Documentation: Specifics for interfacing with the AIMS platform via API.
  • Debugging Guide: Instructions for debugging common issues and understanding error codes.

Relevant Publications​

For those interested in the validation and effectiveness of the AIMS platform: