Skip to main content

​
Welcome

Claros Health provides a powerful and flexible way for healthcare technology companies to integrate quality reporting capabilities into their existing systems. Built on Django, this API enables seamless integration of our quality reporting features into your technology stack, allowing you to:
  • Automate quality measure reporting and data collection
  • Streamline the submission of quality metrics to regulatory bodies
  • Integrate quality reporting workflows into your existing applications
  • Generate comprehensive patient reports and conduct detailed audits
  • Access real-time quality performance data
  • Maintain compliance with healthcare quality reporting requirements

​
Authentication

All API endpoints require authentication using an API key. You can manage your API keys through the dashboard, where you can create new keys, revoke existing ones, and monitor their usage.

​
Base URL

The API is served from https://backend.claros.health. All endpoints are relative to this base URL.

​
Available Endpoints

The Quality Reporting System provides the following endpoints:

​
Patients

  • GET /patients: Retrieve all patients associated with the authenticated user
  • GET /patients/{patient_id}: Get detailed information about a specific patient
  • POST /patients/{patient_id}/pdf: Upload a patient’s PDF document for processing

​
Numerical Variables

  • GET /variables: Retrieve all numerical variables
  • POST /variables: Create a new numerical variable
  • PUT /variables/{variable_id}: Update an existing numerical variable
  • PUT /patients/{patient_id}/variables/{variable_id}: Update a patient’s variable value
  • POST /patients/{patient_id}/variables/{variable_id}/scrape: Extract variable value from patient documents

​
Date Variables

  • GET /date-variables: Retrieve all date variables
  • POST /date-variables: Create a new date variable
  • PUT /date-variables/{variable_id}: Update an existing date variable
  • PUT /patients/{patient_id}/date-variables/{variable_id}: Update a patient’s date variable value
  • POST /patients/{patient_id}/date-variables/{variable_id}/scrape: Extract date value from patient documents

​
Metrics

  • GET /metrics: Retrieve all available metrics
  • POST /metrics: Create a new metric
  • PUT /metrics/{metric_id}: Update an existing metric
  • GET /metrics/{metric_id}: Get detailed information about a specific metric

​
Reports

  • GET /cms-reports: Retrieve CMS reporting data and analytics
Each endpoint returns data in a consistent JSON structure, with appropriate metadata and pagination information where applicable.

​
Response Format

All responses are returned in JSON format. Date values are returned in ISO format.

​
Common Response Codes

  • 200 OK: Request successful
  • 401 Unauthorized: Authentication required
  • 403 Forbidden: User not authorized to access the resource
  • 404 Not Found: Resource not found
  • 405 Method Not Allowed: Invalid HTTP method
  • 500 Internal Server Error: Server error

​
Data Types

The API uses the following data types:
  • integer: Whole numbers
  • string: Text values
  • boolean: True/false values
  • array: Lists of values
  • object: Key-value pairs
  • null: Empty or undefined values