🚀Getting started

1. Explore the Documentation

Review the API Reference Docs to confirm our platform fits your use case for:

  • Retrieving external medical records

  • Summarizing clinical data with AI

  • Querying medical records for clinical insights

2. Create an Account

Sign up via our web application to get started. This gives you access to our standalone dashboard and begins the setup process.

2b. Complete Clinician Verification (Required for Record Retrieval)

To retrieve medical records through the Carequality® Health Information Exchange (HIE), a licensed clinician must be verified.

We’ll ask for:

  • Full name, email, mobile number

  • Practice address

  • NPI (National Provider Identifier)

  • Valid photo ID

Account verification typically takes 48–72 hours. Once approved, you’ll be able to search for real patients and review AI summaries within the app. You'll be able to use the API while waiting for verification.

3. Try out the Application

Explore the application interface:

  • Search for real patients (if verified)

  • Upload your own PDFs

  • Review AI-generated summaries

  • Ask real questions on medical data with RAG

This gives you a hands-on preview of what you’ll receive via the API.

4. Download the data as JSON, CDA, or FHIR

From the app, you can export:

  • AI summaries

  • Original medical records

Choose between JSON, CDA, or FHIR formats as these are identical to the outputs you'll receive via the API.

5. Get an API Key from the App

Once logged in, go to the Account → API Access in the app to generate your personal API key.

6. Try the API using or GitHub

You can test the API right away in test mode:

7. Start Using It on Real Patients

Your free trial includes 30 days or 100 patient summaries, whichever comes first.

You can search, retrieve, and summarize real patient records, all through the app or API. When the trial ends, the subscription is based on our API Pricing.

Please keep in mind that as per the Carequality® Framework Policy for reciprocity, you will need to send new treatment notes back to us via our API within 7 business days. Learn more about Carequality® Framework Policy.

Last updated