API Terms of Use
Careexpand EHR Certified API: Terms of Use
Terms version v2024.11.1 · Effective November 17, 2026
The terms for software that calls the Careexpand EHR certified API. They are public: reading them, and reading the API documentation, requires no account, login, registration or agreement.
| Publisher | Careexpand LLC, 9400 North Central Expressway, Dallas, Texas 75231 |
| Applies to | The Careexpand EHR certified API: 45 CFR 170.315(g)(7), (g)(9) and (g)(10) |
| Documentation | Application Access API ((g)(7), (g)(9)): https://api.kintsugi.develop.careexpandcloud.com/api/onc-docs |
| Standardized API for patient and population services ((g)(10)): https://api.kintsugi.develop.careexpandcloud.com/api/g10-docs | |
| Software release covered | v2024.11.1 |
| Contact | support@careexpand.com |
1. What these terms cover
These terms apply to any person or organization ("Developer") that builds or operates software ("Application") that calls the Careexpand EHR certified API ("API"). The API has two parts, each described by its own documentation.
1.1 Application Access API: (g)(7) and (g)(9)
| Operation | Purpose |
|---|---|
POST /api/v1/auth/sign-up | Create an account |
POST /api/v1/auth/sign-in | Obtain a bearer token |
GET /api/v1/patients | Find and select a patient ((g)(7)) |
GET /api/v1/user-fhir/{resourceType}/{fhirId} | Translate the selected patient's identifier for the routes that need it |
GET /api/v1/patients/{patientFhirId}/support, /timeline; GET /api/v1/patients/{patientUserId}/medications, /encounters/timeline | Read the selected patient's data |
GET /api/v1/patients/{patientFhirId}/ccd | All of a patient's data as a C-CDA R2.1 Continuity of Care Document, for the whole record, one date or a date range ((g)(9)) |
1.2 Standardized API: (g)(10)
HL7 FHIR R4, US Core 7.0.0, SMART App Launch 2.2.0 and SMART Backend Services, with FHIR Bulk Data for multi-patient access.
| Area | Operations |
|---|---|
| Discovery | GET /.well-known/smart-configuration (also under /api/fhir), GET /api/fhir/metadata, GET /api/v1/smart/service-base-urls, GET /api/v1/smart/style.json |
| Registration | POST /api/v1/smart/register, POST /api/v1/smart/register/backend-service |
| Authorization | GET / POST /api/v1/smart/authorize, POST /api/v1/smart/token, POST /api/v1/smart/launch |
| Patient control | GET /api/v1/smart/apps, DELETE /api/v1/smart/apps/{clientId}, POST /api/v1/smart/revoke, POST /api/v1/smart/introspect |
| Data | GET /api/fhir/{path} (US Core reads and searches, Bulk Data export), GET /api/fhir/$bulk-export-locations |
The capability statement at GET /api/fhir/metadata is the authoritative list of FHIR resources and search parameters.
Other routes on the same server are not part of the API and are not covered by these terms. Sending a request to the API means the Developer accepts these terms.
2. Fees
There is no fee for any part of the API. Nothing is charged to create an account, register an Application, obtain credentials or tokens, read the documentation, call the API, receive any response, or export data, whether for a single patient or a population. No fee is charged per call, per patient, per document, per Application or per Developer, and no fee is charged to patients or to the Applications they choose.
3. Getting access
3.1 No pre-approval of Applications
Careexpand does not require an Application to be reviewed, approved, certified or allow-listed, by Careexpand or by a provider, before it can use the API. There is no application review and no technical gate based on which Application is calling.
3.2 Application Access API ((g)(7), (g)(9))
The Application Access API does not issue separate credentials per Application. An Application authenticates as a Careexpand EHR user account:
POST /api/v1/auth/sign-upcreates an active account and returns a token. It needs no prior credential, and no approval step follows.POST /api/v1/auth/sign-inexchanges the account's email and password for a bearer token. If the account holder has enrolled two-factor authentication, the request must also carry the current 6-digit code intotpCode; without it the API answers401witherror.details.code=MFA_REQUIRED.
3.3 Standardized API ((g)(10))
- Patient-facing and user-facing Applications register themselves.
POST /api/v1/smart/register(RFC 7591 dynamic registration) needs no credential and issues aclient_idat once, with no review and no agreement to accept. A public client gets no secret and must use PKCE. A confidential client also receives aclient_secret, or usesprivate_key_jwt. - Multi-patient (Backend Services) Applications are registered by the provider.
POST /api/v1/smart/register/backend-serviceis called by an administrator of the provider organization, because a system client reads a whole population and must be tied to one organization. The client must useprivate_key_jwtwith ajwks_uri. This is the only registration step that involves the provider, and it does not evaluate what the Application does.
3.4 Access to patient data comes from the provider or the patient
A credential does not reach any patient's data on its own.
- (g)(7) and (g)(9): each request is checked against a permission held by the account (for example
patient.read) and the account's organization scope, worked out on the server. A request parameter cannot widen it. A request outside it is refused with403or404, as documented. - (g)(10): access is limited to the scopes the patient or user granted when authorizing the Application, which may be narrower than the scopes requested. Category-restricted scopes are enforced on every response. Backend Services clients reach only the organization they were registered for.
4. Required agreements
- Careexpand requires no separate developer agreement, license, partnership or certification to use the API. These terms are the whole of what Careexpand requires.
- Careexpand does not require a Business Associate Agreement with Careexpand to use the API. Each Developer works out its own status under HIPAA. A Developer acting for a provider may need a Business Associate Agreement with that provider; a Developer acting at a patient's direction generally does not. Careexpand does not decide this for the Developer.
- Providers' use of Careexpand EHR is governed by their own agreement with Careexpand. That agreement does not bind a Developer and is not a condition of API access.
5. Tokens and sessions
5.1 Application Access API
- Send the token as
Authorization: Bearer <token>over HTTPS. - A token stops working at the earlier of its
expclaim, set per deployment, and the end of the session's idle timeout, set by the provider organization (default 15 minutes, from 1 minute to 24 hours). Requests to the API do not extend it. - Every request re-checks the session; a token whose session has ended gets
401. - There is no refresh endpoint. Sign in again.
5.2 Standardized API
- Authorization code flow with PKCE (
S256only). The authorization code is single-use and can be redeemed only by the client that started the launch. - Grants:
authorization_code,refresh_token,client_credentials(Backend Services, with an RS384- or ES384-signedclient_assertion). - Refresh tokens are issued to public and confidential clients. Their lifetime is set on the deployment's authorization server and renews in full on every refresh.
- A token is accepted only if this server issued the grant behind it.
- The patient or user can see and withdraw an Application's access at any time (
GET /api/v1/smart/apps,DELETE /api/v1/smart/apps/{clientId}). Once withdrawn, tokens already issued to that Application stop working. Applications must handle this.
6. Permitted use
An Application may use the API to access, and let its user access, the electronic health information the credential is authorized to read, for any lawful purpose that user is entitled to. This includes a patient's access to their own record, a provider's treatment, payment and health care operations, and population services through Backend Services.
7. Developer policies
A Developer and its Application must:
- Follow the law, including HIPAA and HITECH where they apply to the Developer, 42 CFR Part 2 where it applies, and state privacy law.
- Use data only as the user authorized. Tell users in plain language what data the Application reads, why, where it is stored, and who it is shared with. Do not use data from the API for advertising, marketing or sale unless the patient has authorized it and the law allows it.
- Protect the data. Use only HTTPS and validate the server certificate. Store retrieved data, credentials, secrets, private keys and tokens encrypted, never in source control, logs, URLs or analytics. Do not put a client secret or account credential inside an Application distributed to end users; such Applications register as public clients.
- Keep credentials to their holder. Do not share, sell or publish credentials, two-factor codes, secrets or tokens, or use one account or client on behalf of another party.
- Stay within authorized access. Do not try to reach records outside the granted permissions, scopes or organization, including by changing identifiers, and do not try to get around authentication, two-factor, rate limits or access checks.
- Not re-identify de-identified data, or combine API data with other sources to do so.
- Not overload the service. Keep request rates in line with real use, honor
429andRetry-After, back off after5xxresponses, cache where the data allows, and use Bulk Data rather than repeated single-patient searches for population exports. - Not misrepresent itself. Register accurate Application details (
client_name,redirect_uris, contacts). Do not impersonate a provider, a patient or Careexpand, or suggest Careexpand endorses or has certified the Application. - Report incidents. Tell Careexpand at support@careexpand.com of any actual or suspected compromise of credentials, secrets, keys, tokens, or data obtained through the API, without unreasonable delay and within 72 hours of becoming aware of it. This is in addition to any breach notice the Developer owes under HIPAA or state law.
- Stop and delete when access ends. Honor a patient's withdrawal of authorization, or a provider's instruction to stop, promptly. When access ends, delete or return data obtained through the API unless the law requires keeping it.
8. What Careexpand will not do
In line with the API Conditions of Certification (45 CFR 170.404) and the information blocking rules (45 CFR Part 171), Careexpand will not:
- charge a fee, require a separate agreement, or require approval in advance for use of the API, except the provider-side registration of Backend Services clients described in 3.3;
- grant, deny or limit access, or apply these terms differently, because a Developer competes with Careexpand or because of its business relationship with Careexpand;
- require a Developer to transfer intellectual property rights in its Application, or to share data the Application generates, as a condition of access;
- restrict a Developer from speaking about the usability, interoperability, security, user experience or business practices of the API;
- use these terms, registration or credentials to restrict lawful access to, exchange of, or use of electronic health information.
9. Service base URLs
Careexpand publishes the (g)(10) service base URLs for the provider organizations using Careexpand EHR, free and without registration, at GET /api/v1/smart/service-base-urls, as a FHIR Bundle of Endpoint and Organization resources (45 CFR 170.404(b)(2)).
10. Rate limits
To protect accounts from password guessing, the two credential endpoints of the Application Access API are limited per client IP address, for every Developer on the same basis:
| Operation | Limit |
|---|---|
POST /api/v1/auth/sign-in | 20 requests per 60 seconds |
POST /api/v1/auth/sign-up | 20 requests per hour |
A request over the limit gets 429 with a Retry-After header giving the seconds to wait.
No other operation has a rate limit today. If limits are introduced or these change, they will apply to every Developer on the same basis, be published in the documentation, and be announced under section 13 before they take effect, except for an emergency measure needed to protect the service.
11. Security and audit
- The API is served only over TLS. Careexpand runs no plain-HTTP deployment of it; plain-HTTP requests are redirected to HTTPS.
- Requests to the API are recorded in the Careexpand EHR audit log, including who acted, the operation and the time. Audit records may be provided to the provider organization, to a patient exercising their rights, or to a regulator. An Application must not tell users its API activity is not logged.
12. Third parties
Careexpand EHR keeps clinical data in an HL7 FHIR R4 server (HAPI FHIR) that Careexpand runs as part of the product. Developers reach it only through the API. No third party makes patient data available directly to Developers, and a Developer needs no account with any third party to use the API.
13. Changes
- A change to the API or to these terms is published as a new version of the documentation, and these terms carry the same version.
- A change that removes an operation, resource, scope or response field, changes an existing operation incompatibly, or adds an obligation on Developers is announced on the documentation pages at least 30 days before it takes effect, unless a shorter period is needed for security or by law.
- New operations, optional parameters, resources, scopes and response fields can be added without notice. Applications must ignore what they do not recognize.
14. Suspension
Careexpand may suspend an account's or client's access to the API only as far as needed:
- to stop use that breaks section 7;
- to stop activity that threatens the security or integrity of the service or of patient data;
- when the provider organization asks, or the account's relationship with it ends; or
- when the law or a regulator requires it.
Except where immediate action is needed for security or by law, Careexpand will tell the Developer why, at the account's email address or the registered client contacts, and give a reasonable chance to fix the problem. Access is restored once the cause is resolved. Careexpand will not suspend access to restrict lawful access to electronic health information, and will never treat serving a patient's right of access as a reason to suspend.
15. Warranty and liability
The API is provided as described in its documentation and otherwise "as is". To the extent the law allows, Careexpand disclaims implied warranties and is not liable for indirect or consequential damages arising from an Application's use of the API. Careexpand does not warrant any Application, and using the API does not make a Developer a partner or agent of Careexpand. Nothing in this section limits Careexpand's obligations under 45 CFR Parts 170 and 171, or any liability that cannot lawfully be limited.
16. Governing law
These terms are governed by the laws of the State of Texas, without regard to its conflict-of-law rules, except where federal law applies.
17. Contact
Questions about the API or these terms, registration, credentials, and incident reports: support@careexpand.com.
Version history
| Terms version | Software release | Date | Change |
|---|---|---|---|
| v2024.11.1 | v2024.11.1 | November 17, 2026 | First publication. One set of terms for 45 CFR 170.315(g)(7), (g)(9) and (g)(10) |