Welcome to HiQOR API Documentation

Welcome to the documentation for HiQOR API. This documentation provides detailed information about the HiQOR API endpoints, their functionality, and how to use them effectively.

Table of Contents

API Overview

The HiQOR API is designed to handle all aspects of patient data processing, from secure data intake to results delivery. HiQOR acts as the central data platform, ensuring seamless data collection, storage, and processing for various health assessments.

  • Patient Data Management: Secure intake and handling of structured health data
  • Data Processing: HiQOR processes and organizes received health data, ensuring structured insights
  • Result Delivery: Processed results are delivered via API or SNS subscriptions
  • Authentication: Validate user credentials and manage access tokens

Base URL

All API requests should be made to the following base URL:

https://7hh4csiioi.execute-api.us-west-2.amazonaws.com/default

Authentication

All API calls require authentication to securely access HiQOR's processing environment. Tokens must be included in the request header to validate access. See the Authentication section for more details on how to obtain and use tokens.

Rate Limiting

To ensure fair usage and maintain service quality, our API implements rate limiting. The current rate limits are:

  • 100 requests per minute per API key
  • 1000 requests per hour per API key

If you exceed these limits, you'll receive a 429 Too Many Requests response. The response will include a Retry-After header indicating how long to wait before making another request.

If you need higher rate limits, please contact our API team to discuss your requirements.

Error Handling

The HiQOR API uses conventional HTTP response codes to indicate the success or failure of an API request. In general:

  • 2xx range indicate success
  • 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, etc.)
  • 5xx range indicate an error with HiQOR's servers

Some common error codes include:

400 Bad Request - Your request is invalid.
401 Unauthorized - Your API key is wrong.
403 Forbidden - The requested resource is hidden for administrators only.
404 Not Found - The specified resource could not be found.
429 Too Many Requests - You have exceeded your rate limit.
500 Internal Server Error - We had a problem with our server. Try again later.
503 Service Unavailable - We're temporarily offline for maintenance. Please try again later.

Getting Help

If you encounter any issues, have questions about using the API, or need to set up webhooks or SNS subscriptions, please don't hesitate to contact our development team at api@hiqor.com.