Skip to content
MedChartScan E/M
Start free

API access

The MedChartScan E/M API runs the same analysis as the app, from your own software, such as a billing system or a coding workflow. This page explains what the API does and how keys work in the app. The full reference is in the MedChartScan E/M API docs.

What the API does

With the API, your software can do the following:

  • Analyze one note and get the full report in the response.
  • Send up to 100 notes as a batch, analyzed in the background, and check on them until they finish.
  • List, search, and delete the results that your API keys created.
  • Read your organization's credit balance.

The API uses your organization's credits and its BAA status, the same as the app. A note analyzed through the API costs one credit when it succeeds, and nothing when it fails or isn't an office E/M visit.

API keys

Your software signs in to the API with an API key. A key has a client ID, which stays visible in the app, and a client secret, which is shown only once, when you create the key.

Owners and admins manage keys on the API keys page in the app:

  • Create a key. Click Create API key, give it a label, then copy the client secret right away. MedChartScan doesn't store the secret in a form it can show again. If you lose it, create a new key and revoke the old one.
  • Revoke a key. Revoking stops the key at once: requests that use it are refused from then on.
  • Track use. The page shows when each key was last used, and its calls and credits over the last 30 days.

The owners of your organization get an email each time someone creates or revokes a key. An organization can have up to 25 active keys.

Warning:

Keep the client secret on a server. Don't put it in a webpage, a mobile app, a spreadsheet, or an email.

Results from the API

Results that the API creates also appear on the Results page in the app for owners and admins, and for members when Members can see all results is on. Through the API, a key sees only what the API created in your organization. Results created in the app aren't visible through the API.

Test mode

While your organization is in testing mode, every request that analyzes notes must include "test_data": true. It's the API's version of the This is not real patient data checkbox. Results are labeled as test results and are deleted after 30 days. For more information, see Test mode in the API.

Start with the API

The overview and quickstart walks you through getting a token and analyzing a synthetic note with curl, Python, or JavaScript. Then see the following pages:

API access · MedChartScan E/M