CharmHealth FHIR API Guide: Prescriptions and Access
CTO & Co-Founder
CTO & Co-Founder at Nirmitee.io. Architects healthcare integrations across FHIR, SMART on FHIR, ABDM and NHCX, writing from production experience taking hospital software from sandbox to go-live.

CharmHealth is a cloud EHR from MedicalMine Inc. Its FHIR API is public and certified. It reads prescriptions, but it cannot write them. MedicationRequest supports read and search only, and no resource in Charm's live capability statement supports create, update or delete. For the commercial side of a CharmHealth project, see our CharmHealth integration services.
This guide is for a product lead or buyer who has to connect a product to CharmHealth, and for the engineer who will build it. It covers access and every documented route. It shows the MedicationRequest calls with a real request and response. It also lists the limits and fees Charm states, and what Charm leaves unpublished. Last checked: Nov 18, 2026.
CharmHealth FHIR API at a glance
| Question | Short answer |
|---|---|
| Who grants access? | Charm issues a client ID after you sign its API License Agreement. Each practice admin then adds your client ID in Settings, Account, API Keys. |
| Who signs? | Your company signs the API License Agreement with MedicalMine. A separate Deployment License is needed to publish the app. |
| Are there public documents? | Yes. A FHIR API reference with request and response examples, linked from the ONC CHPL listing. |
| Which routes exist? | FHIR R4 (patient, provider and backend apps), C-CDA export, bulk export, and Charm-run interfaces for eRx, labs, Direct and public health. |
| What does it cost? | No fee for patient access. $2,000 a year per practice for all other uses. License prices are not published. |
| How long does it take? | Charm publishes no times. |
| What is the biggest limit? | Read only. You cannot create a prescription, or any other record, through the API. |
What can you build with the CharmHealth FHIR API?
Eight use cases follow. All of them read data, because the API does not write. Each points to a row in the read table in section 6 (rows R1 to R10). Charm publishes no build times, so this guide gives no build estimate. Build complexity is our own rating.
Several of these use cases keep a copy of the data. The API terms say you will not "maintain a cache or store using any kind of storage of any set or subset of data accessed using the API". Settle storage with Charm in writing before you build any of them.
1. Show a patient's current prescriptions in your app
- Who it is for: patient apps, care navigation and remote monitoring products.
- The value: the patient sees active prescriptions and dosing text from the chart, signed in with their own Charm PHR login.
- Build complexity: low.
- How well it works: well. A patient app gets
patient/MedicationRequest.rsand Charm charges no fee for patient access. See row R1 and R2.
2. Medication history for reconciliation at a transition of care
- Who it is for: care management, home health and transitional care teams.
- The value: the medication list, dispenses and allergies arrive in one pull, so staff stop retyping them.
- Build complexity: medium.
- How well it works: reads work through MedicationRequest, MedicationDispense, MedicationAdministration and AllergyIntolerance. Any change goes back into Charm by hand. See rows R1 to R4.
3. Refill and adherence reminders
- Who it is for: patient engagement and pharmacy services.
- The value: reminders are timed from the date a prescription was written and its dosing.
- Build complexity: low to medium.
- How well it works: search by
status=activeandauthoredongives the list. There are no webhooks, so you poll for new prescriptions. See row R1.
4. A drug and condition view launched inside the Charm chart
- Who it is for: clinical decision support and specialty app vendors.
- The value: a provider opens your app from the chart, with the patient already selected.
- Build complexity: medium.
- How well it works: Charm supports EHR launch with patient context. Results show in your app only. Nothing writes back to the chart. See rows R1, R4 and R5.
5. Prior authorization and benefit preparation
- Who it is for: prior authorization and revenue cycle products.
- The value: the drug, diagnosis and coverage arrive together for a request packet.
- Build complexity: medium.
- How well it works: MedicationRequest, Condition and Coverage are all readable. Charm already runs Real-Time Prescription Benefit inside its own prescribing screen, so check the overlap first. See rows R1, R4 and R7.
6. Population reports through bulk export
- Who it is for: quality reporting, value-based care and research teams.
- The value: one job exports a group of patients across resources.
- Build complexity: medium to high.
- How well it works:
$exportruns on a Patient Category (Group) with SMART Backend Services. Storage of the output falls under the no-storing term above. See row R10.
7. Pull a patient's full record as a C-CDA
- Who it is for: referral platforms and record transfer services.
- The value: one call returns the patient's whole record as an HL7 C-CDA file, with an optional date range.
- Build complexity: low.
- How well it works:
GET /patients/{patient_id}/ccdareturns XML. See row R9.
8. Care gap checks for a payer or care team
- Who it is for: payers, ACOs and care gap tools.
- The value: labs, vitals and conditions are read in one pass to flag open gaps.
- Build complexity: medium.
- How well it works: Observation, DiagnosticReport and Condition are readable, with granular scopes by category. Closing the gap happens in Charm. See rows R4 and R5.
The eight CharmHealth use cases compared
| Use case | Who it is for | Build complexity (our rating) | Row in the read table |
|---|---|---|---|
| 1. Current prescriptions in a patient app | Patient apps | Low | R1, R2 |
| 2. Medication reconciliation | Care management | Medium | R1 to R4 |
| 3. Refill and adherence reminders | Engagement and pharmacy | Low to medium | R1 |
| 4. Drug and condition view in the chart | Decision support | Medium | R1, R4, R5 |
| 5. Prior authorization preparation | Revenue cycle | Medium | R1, R4, R7 |
| 6. Population reports | Quality and research | Medium to high | R10 |
| 7. Full record as C-CDA | Referral and transfer | Low | R9 |
| 8. Care gap checks | Payers and ACOs | Medium | R4, R5 |
How do you get access to the CharmHealth FHIR API?
You apply to Charm, sign its license, and then each practice switches your app on. Charm lists three steps: fill out the API Access Request form, wait for Charm to "review and send the instructions on using the API", then build.
The developer license
Submit the CharmHealth Certified API Access Request form with your contact details and the app you plan to build. Charm's representatives then contact you "to discuss your requirements and assist you in signing our API License Agreement". A development license is bought per developer. Once it is issued, Charm gives you a client ID. A confidential client also gets a client secret.
The practice switch
The practice admin must add your client ID under Settings, Account, API Keys in their own Charm account. Without this, a provider or backend app cannot read that practice's data.
Going live
To publish the app, you need a separate Deployment License, and you must "present/showcase your application to MedicalMine Inc." first. Support is a third license. The development license "does not entitle you to any technical support or bug fixes".
Help from Charm
Charm runs an API webinar on Tuesdays, 10 to 11 AM Pacific.
What does CharmHealth API access give you?
You get a sandbox for building, then production access per practice. Charm's terms say "Sandbox environment will be provided for development purpose." Charm does not publish the sandbox URL, its test data, or how it is refreshed.
| Stage | What you get | Source |
|---|---|---|
| After the license | Client ID, client secret for confidential clients, sandbox | |
| Per practice | Read access to that practice's data once the admin adds your client ID | |
| Patient apps | One patient's record, with the patient's PHR login | |
| Provider apps | Many patients, with the provider's EHR login | |
| Backend apps | System read scopes and bulk export, with no user |
The production FHIR base URL is https://ehr2.charmtracker.com/api/ehr/v2/fhir. Tokens come from https://accounts.charmtracker.com/oauth/v2/token.
What are the ways to integrate with CharmHealth?
FHIR is the only documented API. The API program page says "REST APIs", but its only documentation link is the FHIR reference. Other routes are interfaces Charm runs itself.
| Route | What it does | Fits when |
|---|---|---|
| FHIR R4, patient app | One patient reads their own record | You build a patient app |
| FHIR R4, provider app (SMART) | A provider launches your app from the chart or signs in to it | You build a clinician tool |
| FHIR R4, backend | System read scopes and bulk export | You run reports or sync jobs |
| C-CDA export | Whole record per patient as XML | You need a document, not resources |
| Surescripts eRx (in Charm) | Charm sends prescriptions and gets refills | Prescribing stays in Charm |
| Labs and imaging (Charm-run) | LabCorp, Quest and others, or a custom interface Charm builds | You are a lab |
| Direct messaging | DataMotion HISP | Referral documents |
| Public health | HL7 to immunization registries and agencies | Registry reporting |
What can you read and write with the CharmHealth FHIR API?
You can read 31 resource types. You can write none of them. The table lists the rows the use cases point to.
| Row | Resource or function | Read | Write | Calls |
|---|---|---|---|---|
| R1 | MedicationRequest | Read, search | No | GET /MedicationRequest, GET /MedicationRequest/{id}, POST /MedicationRequest/_search |
| R2 | Medication | Read by ID | No | GET /Medication/{id} |
| R3 | MedicationDispense, MedicationAdministration | Read, search | No | List, Get, Search |
| R4 | Patient, AllergyIntolerance, Condition | Read, search | No | List, Get, Search |
| R5 | Observation, DiagnosticReport, ServiceRequest, Specimen | Read, search | No | List, Get, Search |
| R6 | Encounter, Appointment, Practitioner, Organization, Location | Read, search | No | List, Get, Search |
| R7 | Coverage | Read, search | No | List, Get, Search |
| R8 | CarePlan, CareTeam, Goal, Immunization, Procedure, DocumentReference, and others | Read, search | No | List, Get, Search |
| R9 | C-CDA export | Read | No | GET /patients/{patient_id}/ccda |
| R10 | Bulk export | Read | No | GET /Group/{group_id}/$export, GET /$export-poll-status, DELETE /$export-poll-status |
What the MedicationRequest scopes and capability statement say
The scope patient/MedicationRequest.rs "Allows READ and SEARCH access to medication request of a patient." The system scope is system/MedicationRequest.r, and "Under System Scopes, only read access is supported." The live capability statement lists four interactions for MedicationRequest: search-type, read, vread and history-instance.
Search parameters are patient, encounter, intent, authoredon, status, _include=MedicationRequest:medication, _revinclude=Provenance:target and page. patient is required for patient apps. The resource follows the US Core MedicationRequest profile.
What is not possible with the CharmHealth FHIR API?
The API cannot write any record or send a prescription. Each gap comes with the usual workaround.
| What you cannot do | Source | Usual workaround |
|---|---|---|
| Create, update or cancel a MedicationRequest | The prescriber writes it in Charm, which sends it through Surescripts. | |
| Write any other resource (notes, results, appointments, patients) | Staff enter it in Charm, or send a document by Direct. | |
| Send a controlled substance prescription from your app | EPCS runs inside Charm with ExoStar. | |
| Get pushed events or webhooks | Poll search calls, or run bulk export on a schedule. | |
| Store or cache API data without Charm's agreement | Agree storage terms with Charm in writing before the build. | |
| Build a product that competes with Charm | Not open. Charm can cut access. | |
| Write system scopes | Backend apps read only. | |
| Send prescriptions to a pharmacy outside Surescripts | Not covered by Charm's eRx. |
What are the CharmHealth FHIR API limits?
Charm says a call limit exists but does not publish the number. Its ONC disclosure says "There is a limit on the number API calls allowed in a specific duration". A 429 response means "API usage limit exceeded".
| Limit | Value | Source |
|---|---|---|
| Call rate | Exists, number not published | |
| Daily queries | Charm "may also reasonably limit the number of daily API queries" | |
| Storing data | Not allowed under the API terms | |
| Purpose | "solely for the purpose of patient care or benefit" | |
| Writes | None, on any resource | |
| System scopes | Read only | |
| In-app C-CDA bulk export | 1,000 patients a day, run at night | |
| Paging | page parameter on list calls | |
| eRx network | Surescripts pharmacies only |
Ask Charm for the call limit per minute and per day, and whether it is per practice or per client ID.
How much does CharmHealth integration cost?
Charm publishes one API price. Patient access is free. All other API use costs $2,000 a year per practice. Its disclosure says: "Use of certified APIs for all other purposes needs an annual subscription fee of $2000 per practice." A contract is required.
- Development license (per developer): price not published.
- Deployment license: price not published.
- Development or production support: price not published.
- eRx for the practice: a one-time Experian identity check, plus a monthly or annual fee per provider. Amounts not published.
- EPCS: an annual fee per provider through ExoStar. Amount not published.
- Custom lab interface: a one-time fee plus an annual fee per site. Amounts not published.
Ask Charm for the development, deployment and support license prices in writing, and who pays the $2,000 a year, you or the practice.
How long does a CharmHealth integration take?
Charm publishes no times for any step. The API program page says only "We will get back to you soon".
Plan the calendar around the parts that need someone else: Charm's review and the license signing, the sandbox issue, each practice adding your client ID, and the Deployment License review of your app. On the prescribing side, a practice starts getting pharmacy refill requests after it sends 5 new prescriptions from Charm, if no other vendor holds refills for that address.
How do you build a CharmHealth FHIR integration, step by step?
A provider app has four stages: license, practice switch, sign-in, and reads.
Stage 1. Get the license and client ID
Apply, sign the API License Agreement and receive the client ID. Build against the sandbox.
Stage 2. The practice adds your client ID
The practice admin adds it under Settings, Account, API Keys.
Stage 3. Sign in with SMART
Send the user to the authorize endpoint with your scopes. This example is from Charm's docs:
GET https://accounts.charmtracker.com/oauth/v2/auth?scope=patient/Patient.rs&client_id={client_id}&state=tempstate&response_type=code&redirect_uri=https://app.example.com/oauth
POST the returned code to https://accounts.charmtracker.com/oauth/v2/token for an access token and, for confidential clients, a refresh token. Public clients use PKCE with S256.
Stage 4. Read prescriptions
This request and response are from Charm's FHIR docs, with the sample token removed.
GET /api/ehr/v2/fhir/MedicationRequest?patient=Patient/1036765000000056009
Authorization: Bearer <access_token>
{
"resourceType": "Bundle",
"type": "searchset",
"total": 1,
"entry": [
{
"fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/MedicationRequest/1036765000000106501",
"resource": {
"resourceType": "MedicationRequest",
"id": "1036765000000106501",
"status": "active",
"intent": "order",
"reportedReference": { "reference": "Practitioner/1036765000000021021" },
"medicationReference": { "reference": "Medication/1036765000000106499" },
"subject": { "reference": "Patient/1036765000000056009" },
"encounter": { "reference": "Encounter/1036765000000102063" },
"authoredOn": "2022-11-02T00:00:00-07:00",
"requester": { "reference": "Practitioner/1036765000000021021" },
"dosageInstruction": [
{
"text": "2 capsule(s) once a month in the evening for 2 Month(s), intravenous route",
"route": { "text": "intravenous" }
}
]
}
}
]
}
The drug itself sits in the Medication resource. Add _include=MedicationRequest:medication, or call GET /Medication/{id}.
The backend set-up
A backend app shares a JWK URL and its scopes with Charm, signs a JWT with RS384, and posts it to the token endpoint for a system/*.r token. Bulk export then starts with GET /Group/{group_id}/$export, where the group is a Patient Category. You poll $export-poll-status until it returns 200 with file URLs.
Which CharmHealth FHIR API quirks should you know?
Two host names
The docs use ehr2.charmtracker.com, while all 5,281 endpoints in Charm's published base URL file use ehr.charmtracker.com. Test both.
Token expiry is in milliseconds
The expires_in value is in milliseconds, not seconds.
More interactions than the docs show
The docs list List, Get and Search, while the capability statement also lists vread and history.
POST search returns 201
The docs show HTTP/1.1 201 Created for a _search call.
An extra header on C-CDA
The C-CDA example sends an api_key header next to the Bearer token.
Two practitioner references
The MedicationRequest example has both requester and reportedReference.
Old examples
The response examples in the docs are dated November 2022.
Granular scopes are narrow
They exist only for Condition and Observation categories.
A typo in the terms
The API terms cite "ยง170.316(g)(7)". The ONC rule is 170.315.
Native apps
A mobile app registers a custom URL scheme as its redirect.
What should you check before you sign with CharmHealth?
Check storage, cost and support in the contract, since the terms leave them open.
Security and compliance, as Charm states them
CharmHealth EHR 1.2 holds an active ONC 2015 Edition listing, CHPL 15.04.04.1948.ChAR.12.00.1.181115, including the e-prescribing and FHIR API criteria. The terms make you "solely responsible for all aspects of HIPAA compliance in your application", and you indemnify MedicalMine.
Rules for your side
Keep the client secret and tokens on your server. Store nothing from the API until Charm agrees in writing. Keep the use within patient care.
Testing
Build in the sandbox, then test with one practice that has added your client ID. Test the 429 path, since the limit number is not published.
Questions to ask Charm before you sign
- What are the call limits per minute and per day?
- May we store data read from the API, and on what terms?
- What do the development, deployment and support licenses cost?
- Who pays the $2,000 a year per practice?
- What is the sandbox URL, and what test data does it hold?
- How long do the access review and the Deployment License review take?
- Is there any route to create or update a MedicationRequest, now or planned?
- Which host should production calls use, ehr or ehr2?
- Is there any REST API beyond the FHIR reference?
- Will webhooks or FHIR Subscriptions be added?
What is the next step for a CharmHealth integration?
Planning a CharmHealth integration? We scope the reads, the access steps and the build with you. Start at our CharmHealth integration service, or see our wider EHR integration services.
Ready to scale?
Talk to our healthcare engineering team about building, integrating, and shipping faster.
Frequently Asked Questions
Does CharmHealth have a FHIR API?
Can I write a MedicationRequest to CharmHealth?
Can my app send prescriptions through CharmHealth?
How do I get CharmHealth API access?
How much does the CharmHealth API cost?
Does CharmHealth have a sandbox?
What is the CharmHealth FHIR base URL?
Does CharmHealth support SMART on FHIR?
What is the CharmHealth API rate limit?
Does CharmHealth support bulk FHIR export?


