Commure EHR FHIR API

The Commure EHR FHIR API is a FHIR R4B server that exposes patient health data from Air to authorized third-party applications. It is compliant with US Core 6.1.0 profiles and the ONC (g)(10) Standardized API certification criteria (§170.315(g)(10)). All responses are returned in application/fhir+json format.

Service Base URL: https://onc.api.staging-ehr.athelas.comFHIR Version: R4B (4.0.1) · US Core Version: 6.1.0 · Content Type: application/fhir+json

SMART on FHIR Configuration

The server publishes its SMART App Launch v2.0 discovery document at the well-known path below. This is an unauthenticated GET — no token required.

GET https://onc.api.staging-ehr.athelas.com/.well-known/smart-configuration

The document advertises every authorization/token endpoint, the supported scopes, grant types, client-authentication methods, PKCE methods, and SMART capabilities.

Example `.well-known/smart-configuration` output

{
  "issuer": "https://cognito-idp.us-east-2.amazonaws.com/us-east-2_KudjXF579",
  "jwks_uri": "https://cognito-idp.us-east-2.amazonaws.com/us-east-2_KudjXF579/.well-known/jwks.json",
  "authorization_endpoint": "https://onc.api.staging-ehr.athelas.com/authorize",
  "token_endpoint": "https://onc.api.staging-ehr.athelas.com/token",
  "introspection_endpoint": "https://onc.api.staging-ehr.athelas.com/introspect",
  "revocation_endpoint": "https://onc.api.staging-ehr.athelas.com/revoke",
  "token_endpoint_auth_methods_supported": [
    "none",
    "client_secret_post",
    "client_secret_basic",
    "private_key_jwt"
  ],
  "token_endpoint_auth_signing_alg_values_supported": ["RS256", "ES256"],
  "grant_types_supported": [
    "authorization_code",
    "client_credentials",
    "refresh_token"
  ],
  "response_types_supported": ["code"],
  "scopes_supported": [
    "openid", "profile", "fhirUser", "launch", "launch/patient", "offline_access",
    "patient/Patient.rs", "patient/AllergyIntolerance.rs", "patient/CarePlan.rs",
    "patient/CareTeam.rs", "patient/Condition.rs", "patient/Coverage.rs",
    "patient/Device.rs", "patient/DiagnosticReport.rs", "patient/DocumentReference.rs",
    "patient/Encounter.rs", "patient/Goal.rs", "patient/Immunization.rs",
    "patient/Location.rs", "patient/MedicationDispense.rs", "patient/MedicationRequest.rs",
    "patient/Observation.rs", "patient/Organization.rs", "patient/Practitioner.rs",
    "patient/PractitionerRole.rs", "patient/Procedure.rs", "patient/Provenance.rs",
    "patient/RelatedPerson.rs", "patient/ServiceRequest.rs", "patient/Specimen.rs",
    "system/*.rs"
  ],
  "code_challenge_methods_supported": ["S256"],
  "capabilities": [
    "launch-ehr",
    "launch-standalone",
    "client-public",
    "client-confidential-symmetric",
    "client-confidential-asymmetric",
    "context-ehr-patient",
    "context-standalone-patient",
    "sso-openid-connect",
    "permission-patient",
    "permission-offline",
    "permission-v2",
    "authorize-post"
  ]
}

SMART Endpoint Reference

Endpoint	URL
Authorization	`https://onc.api.staging-ehr.athelas.com/authorize`
Token	`https://onc.api.staging-ehr.athelas.com/token`
Introspection	`https://onc.api.staging-ehr.athelas.com/introspect`
Revocation	`https://onc.api.staging-ehr.athelas.com/revoke`
JWKS URI	`https://cognito-idp.us-east-2.amazonaws.com/us-east-2_KudjXF579/.well-known/jwks.json`
Issuer	`https://cognito-idp.us-east-2.amazonaws.com/us-east-2_KudjXF579`
SMART Style	`https://onc.api.staging-ehr.athelas.com/smart-style.json`

CapabilityStatement

The server’s FHIR CapabilityStatement (the “conformance statement”) lists every supported resource, interaction, search parameter, supported US Core profile, and the SMART security configuration. It is available as an unauthenticated GET and can be exported directly:

GET https://onc.api.staging-ehr.athelas.com/metadata
Accept: application/fhir+json

The statement declares fhirVersion: 4.0.1, the application/fhir+json format, the SMART OAuth URIs (via the oauth-uris security extension), and one rest.resource entry per supported resource with its supportedProfile, interactions, and searchParam list.

Example `CapabilityStatement` (abridged)

{
  "resourceType": "CapabilityStatement",
  "status": "active",
  "kind": "instance",
  "fhirVersion": "4.0.1",
  "format": ["application/fhir+json"],
  "implementationGuide": [
    "http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core|6.1.0"
  ],
  "rest": [
    {
      "mode": "server",
      "security": {
        "extension": [
          {
            "url": "http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris",
            "extension": [
              { "url": "authorize", "valueUri": "https://onc.api.staging-ehr.athelas.com/authorize" },
              { "url": "token",     "valueUri": "https://onc.api.staging-ehr.athelas.com/token" },
              { "url": "introspect","valueUri": "https://onc.api.staging-ehr.athelas.com/introspect" },
              { "url": "revoke",    "valueUri": "https://onc.api.staging-ehr.athelas.com/revoke" }
            ]
          }
        ],
        "service": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/restful-security-service",
                "code": "SMART-on-FHIR"
              }
            ]
          }
        ]
      },
      "resource": [
        {
          "type": "Patient",
          "supportedProfile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
          ],
          "interaction": [{ "code": "read" }, { "code": "search-type" }],
          "searchParam": [
            { "name": "_id",       "type": "token" },
            { "name": "identifier","type": "token" },
            { "name": "name",      "type": "string" },
            { "name": "birthdate", "type": "date" },
            { "name": "gender",    "type": "token" }
          ]
        }
        /* ...one entry per supported resource (see Resource Endpoints below)... */
      ]
    }
  ]
}

Application Registration & Onboarding Guide

Follow these steps to onboard a new application against the Commure EHR FHIR API.

Review the documentation and Terms of Use

Read this reference and the API Terms of Use. Confirm the FHIR resources and SMART scopes your application requires (see Scopes and the Resource-to-USCDI Mapping Matrix).

Request application registration

Applications are registered in AWS Cognito. Self-serve registration is planned for a future release; today, contact Commure (d/b/a Athelas) to register.Provide the following:

Organization name and technical contact
Description of the application and the FHIR resources / scopes needed
Whether the app is patient-facing, provider-facing, or a backend service
Client type: public (no secret, uses PKCE), confidential (has secret), or backend service (private_key_jwt)
Redirect URI(s)
SMART Launch URI (for EHR launch apps)
JWKS URL (for backend-service / asymmetric clients)

Receive your credentials

Upon approval you will receive:

client_id — used in all OAuth flows
client_secret — for confidential clients only

Store secrets and private keys securely; never embed them in distributable public clients.

Configure SMART discovery

Point your client at the .well-known/smart-configuration document to discover the authorization and token endpoints, then implement the Authorization flow that matches your client type.

Test against the sandbox

Use the staging Service Base URL (https://onc.api.staging-ehr.athelas.com) to exercise the authorization flows, scope enforcement, resource reads/searches, and bulk export. No registration, sandbox, or production fees apply.

Validate conformance

Validate your integration with the ONC Inferno (g)(10) Standardized API test kit against the US Core Conformance Statement and SMART App Launch v2.0 / Bulk Data v2.0 suites.

Go live

Once validated, request production access from Commure (d/b/a Athelas). Production access to the certified API capabilities is granted on non-discriminatory terms (see API Terms of Use).

Authorization

The server implements SMART on FHIR v2 (§170.215(a)(3)) using AWS Cognito as the identity provider.

Supported Grant Types

authorization_code — Standalone and EHR launch (patient and provider apps)
client_credentials — Backend Services Authorization (bulk data, system-level access)
refresh_token — Token refresh for offline access

Token Authentication Methods

Method	Use for
`none`	Public apps (PKCE required)
`client_secret_post`	Confidential apps, secret in `POST` body
`client_secret_basic`	Confidential apps, secret in `Authorization` header
`private_key_jwt`	Asymmetric client auth for Backend Services

SMART Standalone Launch Flow

App redirects the user to GET /authorize with response_type=code, client_id, redirect_uri, scope, state, aud, and PKCE code_challenge.
The server presents a consent page where the user selects which scopes to grant.
After consent, the server redirects to the app’s redirect_uri with an authorization code.
App exchanges the code via POST /token to receive access_token, id_token, and optionally refresh_token.
App includes the access token as Authorization: Bearer <token> on all FHIR API requests.

EHR Launch Flow

EHR initiates launch via GET /launch/{patient_id}?app_launch_url=<url> (optionally with encounter_id). This redirects to the app’s launch URL with a launch parameter.
App redirects to GET /authorize including the launch parameter in addition to the standard OAuth params.
The rest of the flow follows the standalone flow. The resulting token includes patient and optionally encounter launch context claims.

Backend Services Authorization (Bulk Data)

For system-level access (e.g., bulk export):

App generates a signed JWT (client_assertion) using its private key registered with Cognito.
App calls POST /token with:
- grant_type=client_credentials
- client_assertion=<signed_jwt>
- client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer
- scope=system/*.*
The server returns a bearer access token valid for system-level operations.

Token Introspection

POST /introspect

Validates an access token and returns its claims. Request body (form-encoded): token=<access_token>

Token Revocation

POST /revoke

Revokes an access or refresh token. Request body (form-encoded): token=<token>, client_id=<client_id>, optionally client_secret, token_type_hint.

Token Refresh

Include grant_type=refresh_token and refresh_token=<token> in the POST /token body. Note: Refresh tokens are issued only when the offline_access scope is granted. Tokens issued to confidential clients are valid for a minimum of 3 months.

Scopes

The server supports SMART v2 granular scopes. All resource scopes use the .rs (read-search) action.

Context Scopes

Scope	Purpose
`openid`	OpenID Connect
`profile`	User profile
`fhirUser`	Resolves the current user as a FHIR resource
`offline_access`	Issue a refresh token
`launch`	EHR launch context

Patient-Level Resource Scopes

Scope	Resource Access Granted
`patient/AllergyIntolerance.rs`	Allergy and intolerance records
`patient/CarePlan.rs`	Care plans
`patient/CareTeam.rs`	Care team members
`patient/Condition.rs`	All conditions (problems, diagnoses, health concerns)
`patient/Coverage.rs`	Insurance coverage
`patient/Device.rs`	Implantable devices
`patient/DiagnosticReport.rs`	Diagnostic reports (lab, notes)
`patient/DocumentReference.rs`	Clinical documents and chart notes
`patient/Encounter.rs`	Encounters and visits
`patient/Goal.rs`	Health goals
`patient/Immunization.rs`	Immunization records
`patient/Location.rs`	Practice locations
`patient/MedicationDispense.rs`	Medication dispense records
`patient/MedicationRequest.rs`	Medication requests and prescriptions
`patient/Observation.rs`	All observations (vitals, labs, surveys, SDOH)
`patient/Organization.rs`	Organizations
`patient/Patient.rs`	Patient demographics
`patient/Practitioner.rs`	Practitioners
`patient/PractitionerRole.rs`	Practitioner roles
`patient/Procedure.rs`	Procedures
`patient/Provenance.rs`	Provenance records
`patient/RelatedPerson.rs`	Related persons (family, guardians)
`patient/ServiceRequest.rs`	Service and referral requests
`patient/Specimen.rs`	Specimens

Granular Scopes

For Condition and Observation, category-level granular scopes are supported:

patient/Condition.rs?category=http://terminology.hl7.org/CodeSystem/condition-category|encounter-diagnosis
patient/Condition.rs?category=http://terminology.hl7.org/CodeSystem/condition-category|problem-list-item
patient/Condition.rs?category=http://hl7.org/fhir/us/core/CodeSystem/condition-category|health-concern

patient/Observation.rs?category=http://terminology.hl7.org/CodeSystem/observation-category|vital-signs
patient/Observation.rs?category=http://terminology.hl7.org/CodeSystem/observation-category|laboratory
patient/Observation.rs?category=http://terminology.hl7.org/CodeSystem/observation-category|social-history
patient/Observation.rs?category=http://terminology.hl7.org/CodeSystem/observation-category|survey
patient/Observation.rs?category=http://hl7.org/fhir/us/core/CodeSystem/us-core-category|sdoh

If a granular scope is granted, the server restricts search results to only that category. For example, a token with patient/Condition.rs?category=encounter-diagnosis cannot read problem-list or health-concern conditions.

US Core Conformance Statement

The Commure EHR FHIR API conforms to the HL7 US Core Implementation Guide STU 6.1.0 on FHIR R4 (4.0.1), supporting the USCDI v3 data set, as required by the ONC §170.315(g)(10) Standardized API certification criterion.

Conformance area	Statement
Implementation Guide	US Core 6.1.0 — `http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core` (version `6.1.0`)
FHIR version	R4B (`4.0.1`)
Data set	USCDI v3
SMART App Launch	SMART App Launch v2.0.0 — `§170.215(b)`
Bulk Data Access	HL7 FHIR Bulk Data Access (Flat FHIR) v2.0.0 — `§170.215(a)(4)`
Supported profiles	All US Core 6.1.0 profiles listed in the Resource-to-USCDI Mapping Matrix; asserted in the CapabilityStatement via `supportedProfile`.
Must Support	US Core “Must Support” elements are populated when present in the source record; absent data is represented per US Core (omission or a US Core data-absent reason).
Required search parameters	The required US Core search parameters and combination searches are implemented per profile (see Resource Endpoints).
Provenance	US Core Provenance is supported and returned via `_revinclude=Provenance:target` on any resource search.
Profile declaration	Each returned resource declares its US Core profile in `meta.profile`.

Terminology / vocabulary standards used to satisfy US Core bindings: LOINC, SNOMED CT, RxNorm, CVX (immunizations), ICD-10-CM, CPT/HCPCS, UCUM (units), and HL7 / FHIR code systems. How to verify conformance: retrieve the live /metadata CapabilityStatement, and run the ONC Inferno (g)(10) test kit against the Service Base URL.

Resource-to-USCDI Mapping Matrix

This matrix shows where each USCDI v3 data class (the data set supported by US Core 6.1.0) is available through the API — the conformant US Core profile, the FHIR resource, and the endpoint a client calls to retrieve it. See Resource Endpoints for the full search parameters of each endpoint.

USCDI v3 Data Class	US Core 6.1.0 Profile	FHIR Resource	API Endpoint(s)
Patient Demographics	US Core Patient Profile	Patient	`GET /Patient` · `GET /Patient/{id}`
Assessment and Plan of Treatment	US Core CarePlan Profile	CarePlan	`GET /CarePlan?category=assess-plan`
Care Team Members	US Core CareTeam Profile	CareTeam	`GET /CareTeam`
Clinical Notes (Consultation, Discharge, Progress)	US Core DocumentReference Profile	DocumentReference	`GET /DocumentReference` · `GET /DiagnosticReport`
Goals: Patient Goals	US Core Goal Profile	Goal	`GET /Goal`
Health Concerns	US Core Condition Profile	Condition	`GET /Condition?category=health-concern`
Immunizations	US Core Immunization Profile	Immunization	`GET /Immunization`
Lab Tests and Results	US Core Lab Result Observation Profile, US Core DiagnosticReport for Lab	Observation, DiagnosticReport	`GET /Observation?category=laboratory` · `GET /DiagnosticReport`
Medications	US Core MedicationRequest Profile	MedicationRequest, MedicationDispense	`GET /MedicationRequest` · `GET /MedicationDispense`
Medication Allergies	US Core AllergyIntolerance Profile	AllergyIntolerance	`GET /AllergyIntolerance`
Problems	US Core Condition Profile	Condition	`GET /Condition?category=problem-list-item`
Procedures	US Core Procedure Profile	Procedure	`GET /Procedure`
Provenance	US Core Provenance Profile	Provenance	`_revinclude=Provenance:target` · `GET /Provenance/{id}`
Smoking Status	US Core Smoking Status Observation Profile	Observation	`GET /Observation?category=social-history`
Unique Device Identifiers (Implantable)	US Core Implantable Device Profile	Device	`GET /Device`
Vital Signs	US Core Vital Signs Profiles, US Core Pulse Oximetry	Observation	`GET /Observation?category=vital-signs`
Encounters	US Core Encounter Profile	Encounter	`GET /Encounter`
Insurance Coverage	US Core Coverage Profile	Coverage	`GET /Coverage`
Service Requests / Referrals	US Core ServiceRequest Profile	ServiceRequest	`GET /ServiceRequest`
Specimens	US Core Specimen Profile	Specimen	`GET /Specimen`
Related Persons	US Core RelatedPerson Profile	RelatedPerson	`GET /RelatedPerson`

Resource Endpoints

All resource endpoints require a valid Bearer token with the appropriate scope. Searches return a FHIR Bundle of type searchset; single-resource reads return the resource directly.

Date parameters support FHIR comparator prefixes: eq, ne, gt, lt, ge, le.All search endpoints support both GET (query parameters) and POST /_search (form-encoded body) forms.

Patient

Required scope: patient/Patient.rs

Interaction	Endpoint
Read	`GET /Patient/{id}`
Search (GET)	`GET /Patient`
Search (POST)	`POST /Patient/_search`

Search Parameters: _id, identifier, name, birthdate, gender, _count (default 50, max 200), _revinclude Supported combination searches: birthdate + name, gender + name

AllergyIntolerance

Required scope: patient/AllergyIntolerance.rs

Interaction	Endpoint
Read	`GET /AllergyIntolerance/{id}`
Search (GET)	`GET /AllergyIntolerance`
Search (POST)	`POST /AllergyIntolerance/_search`

Search Parameters: _id, patient, clinical-status, _count, _revinclude

CarePlan

Required scope: patient/CarePlan.rs

Interaction	Endpoint
Read	`GET /CarePlan/{id}`
Search (GET)	`GET /CarePlan`
Search (POST)	`POST /CarePlan/_search`

Search Parameters: _id, patient, category, identifier, _count, _revinclude

CareTeam

Required scope: patient/CareTeam.rs

Interaction	Endpoint
Read	`GET /CareTeam/{id}`
Search (GET)	`GET /CareTeam`
Search (POST)	`POST /CareTeam/_search`

Search Parameters: patient, status, _include, _revinclude

Condition

Required scope: patient/Condition.rs (or a granular category scope)

Granular scopes are enforced. If the token only has patient/Condition.rs?category=encounter-diagnosis, results are restricted to that category.

Interaction	Endpoint
Read	`GET /Condition/{id}`
Search (GET)	`GET /Condition`
Search (POST)	`POST /Condition/_search`

Search Parameters: _id, patient, category, clinical-status, code, identifier, _count, _revinclude

Coverage

Required scope: patient/Coverage.rs

Interaction	Endpoint
Read	`GET /Coverage/{id}`
Search (GET)	`GET /Coverage`
Search (POST)	`POST /Coverage/_search`

Search Parameters: _id, patient, identifier, _count, _revinclude

Device

Required scope: patient/Device.rs

Interaction	Endpoint
Read	`GET /Device/{id}`
Search (GET)	`GET /Device`
Search (POST)	`POST /Device/_search`

Search Parameters: _id, patient, type, _count, _revinclude

DiagnosticReport

Required scope: patient/DiagnosticReport.rs

Interaction	Endpoint
Read	`GET /DiagnosticReport/{id}`
Search (GET)	`GET /DiagnosticReport`
Search (POST)	`POST /DiagnosticReport/_search`

Search Parameters: _id, patient, category, type, code, status, date, _count, _revinclude

DocumentReference

Required scope: patient/DocumentReference.rs Covers clinical documents and chart notes (consultation notes, progress notes, discharge summaries, etc.).

Interaction	Endpoint
Read	`GET /DocumentReference/{id}`
Search (GET)	`GET /DocumentReference`
Search (POST)	`POST /DocumentReference/_search`

Search Parameters: _id, patient, category, type, status, date, _count, _revinclude

Encounter

Required scope: patient/Encounter.rs

Interaction	Endpoint
Read	`GET /Encounter/{id}`
Search (GET)	`GET /Encounter`
Search (POST)	`POST /Encounter/_search`

Search Parameters: _id, patient, date, identifier, _count, _revinclude

Goal

Required scope: patient/Goal.rs

Interaction	Endpoint
Read	`GET /Goal/{id}`
Search (GET)	`GET /Goal`
Search (POST)	`POST /Goal/_search`

Search Parameters: _id, patient, lifecycle-status, target-date, _count, _revinclude

Immunization

Required scope: patient/Immunization.rs

Interaction	Endpoint
Read	`GET /Immunization/{id}`
Search (GET)	`GET /Immunization`
Search (POST)	`POST /Immunization/_search`

Search Parameters: _id, patient, date, status, vaccine-code, lot-number, manufacturer, identifier, _count, _revinclude

Location

Required scope: patient/Location.rs

Interaction	Endpoint
Search (GET)	`GET /Location`

MedicationDispense

Required scope: patient/MedicationDispense.rs

Interaction	Endpoint
Read	`GET /MedicationDispense/{id}`
Search (GET)	`GET /MedicationDispense`
Search (POST)	`POST /MedicationDispense/_search`

Search Parameters: _id, patient, whenhandedover, status, medication, identifier, _count, _revinclude

MedicationRequest

Required scope: patient/MedicationRequest.rs

Interaction	Endpoint
Read	`GET /MedicationRequest/{id}`
Search (GET)	`GET /MedicationRequest`
Search (POST)	`POST /MedicationRequest/_search`

Search Parameters: _id, patient, authoredon, status, intent, encounter, medication, identifier, _count, _revinclude

Observation

Required scope: patient/Observation.rs (or a granular category scope)

Granular scopes are enforced. If the token only has patient/Observation.rs?category=vital-signs, results are filtered to vital-signs observations only.

Interaction	Endpoint
Read	`GET /Observation/{id}`
Search (GET)	`GET /Observation`
Search (POST)	`POST /Observation/_search`

Search Parameters: _id, patient, category, code, date, _count, _revinclude Supported category values:

http://terminology.hl7.org/CodeSystem/observation-category|vital-signs
http://terminology.hl7.org/CodeSystem/observation-category|laboratory
http://terminology.hl7.org/CodeSystem/observation-category|social-history
http://terminology.hl7.org/CodeSystem/observation-category|survey
http://hl7.org/fhir/us/core/CodeSystem/us-core-category|sdoh

Organization

Required scope: patient/Organization.rs

Interaction	Endpoint
Read	`GET /Organization/{id}`
Search (GET)	`GET /Organization`

Practitioner

Required scope: patient/Practitioner.rs

Interaction	Endpoint
Read	`GET /Practitioner/{id}`
Search (GET)	`GET /Practitioner`

Search Parameters: _id, name, family, given, telecom, address, address-city, address-state, address-postalcode, identifier, _count

Procedure

Required scope: patient/Procedure.rs

Interaction	Endpoint
Read	`GET /Procedure/{id}`
Search (GET)	`GET /Procedure`
Search (POST)	`POST /Procedure/_search`

Search Parameters: _id, patient, date, code, status, category, performer, identifier, _count, _revinclude

Provenance

Required scope: valid Bearer token (JWT) Provenance resources are returned inline via _revinclude=Provenance:target on any resource search. They can also be read directly by ID.

Interaction	Endpoint
Read	`GET /Provenance/{id}`

Note: To include Provenance in a search response, add _revinclude=Provenance:target to any resource search. Provenance entries appear in the Bundle with search.mode = include.

RelatedPerson

Required scope: patient/RelatedPerson.rs

Interaction	Endpoint
Read	`GET /RelatedPerson/{id}`
Search (GET)	`GET /RelatedPerson`

Search Parameters: _id, patient

ServiceRequest

Required scope: patient/ServiceRequest.rs

Interaction	Endpoint
Read	`GET /ServiceRequest/{id}`
Search (GET)	`GET /ServiceRequest`
Search (POST)	`POST /ServiceRequest/_search`

Search Parameters: _id, patient, category, code, authored, status, intent, identifier, _count, _revinclude

Specimen

Required scope: patient/Specimen.rs

Interaction	Endpoint
Read	`GET /Specimen/{id}`
Search (GET)	`GET /Specimen`

Bulk Data API

The server implements the HL7 FHIR Bulk Data Access (Flat FHIR) v2.0 specification.

Export Endpoints

Export Type	Endpoint	Description
Group Export	`GET /Group/{group_id}/$export`	Export data for all patients in a specific group
Patient Export	`GET /Patient/$export`	Export data for all patients the client has access to
System Export	`GET /$export`	System-level export of all resources

All export requests require the Prefer: respond-async header and a valid Bearer token. The server returns 202 Accepted with a Content-Location header pointing to the status endpoint.

Optional query parameters: _outputFormat, _since

Export Job Management

Operation	Endpoint	Description
Check Status	`GET /bulk-status/{job_id}`	Poll job status; returns `202` while in progress, `200` with manifest when complete
Cancel Job	`DELETE /bulk-status/{job_id}`	Cancel an in-progress export job
Download File	`GET /bulk_files/{filename}`	Download an exported NDJSON file

Status responses:

202 Accepted with X-Progress header — job in progress
200 OK with JSON manifest — job complete; manifest includes output[] URLs for each resource type
500 with OperationOutcome — job failed

Exported files are in application/fhir+ndjson format, one resource per line.

Group Management

Operation	Endpoint
List Groups	`GET /Group`
Read Group	`GET /Group/{id}`

Responses and Error Handling

Successful Responses

Status	Meaning
`200 OK`	Request succeeded; body contains FHIR resource or Bundle
`202 Accepted`	Bulk export accepted; polling in progress

Error Responses

All error responses return a JSON body with a detail field (non-FHIR endpoints) or a FHIR OperationOutcome resource (bulk data endpoints).

Status	Meaning
`400 Bad Request`	Invalid request parameters or malformed token
`401 Unauthorized`	Missing or invalid Bearer token
`403 Forbidden`	Token valid but insufficient scope for the requested resource
`404 Not Found`	Resource with the given ID does not exist
`500 Internal Server Error`	Unexpected server error

Additional Notes

Read-only API: All resource interactions are read (search-type, read) only. Write operations are not supported.
Provenance via _revinclude: To retrieve Provenance alongside any resource, append _revinclude=Provenance:target to any search query.
FHIR Version: FHIR R4B (4.0.1)
US Core Version: 6.1.0
Content Type: All responses use application/fhir+json
Connections: TLS 1.2 or higher required; connections below 1.2 are rejected.

API Terms of Use

These Terms of Use govern access to the Commure EHR FHIR API (the “API”). By registering for or accessing the API, the developer (“you”) agrees to these terms. They are published in accordance with the ONC Health IT Certification Program API Conditions of Certification (45 CFR §170.404).

Permitted use

The API provides read-only access to electronic health information for authorized patients, their personal representatives, and authorized third-party applications, consistent with the scopes granted at authorization.
Access is limited to the data authorized by the patient (or the authorizing user) and the granted SMART scopes. You must not attempt to access data beyond your authorized scope.

Fees and non-discrimination

There are no fees for application registration, sandbox access, or production use of the certified API capabilities.
Access is provided on non-discriminatory terms consistent with §170.404. Fair-and-reasonable fees under §170.404(a)(4) may apply only to optional value-added services beyond the certified capabilities.

Developer responsibilities

Comply with all applicable laws, including HIPAA and the 21st Century Cures Act information-blocking provisions.
Protect client_secret values, private keys, and tokens. Do not embed secrets in distributable public clients; use PKCE for public clients.
Use TLS 1.2 or higher for all connections; connections below TLS 1.2 are rejected.
Honor the patient’s authorization decisions and granted scopes, and provide a clear privacy notice describing how your application uses and discloses data.
Do not use the API to disrupt, overload, or circumvent the security of the service, and respect published rate limits and acceptable-use expectations.

Suspension and changes

Commure (d/b/a Athelas) may suspend or revoke access that poses a security risk, violates these terms, or harms patients or the service, consistent with §170.404 permitted exceptions.
These terms and the API may change over time; material changes will be reflected on this page. The API is provided “as is” without warranties except as required by law.

For questions about these terms or API access, contact Commure (d/b/a Athelas) at support@athelas.com.

Service Base URL

The published Service Base URL directory (FHIR Endpoint Bundle) for the Commure EHR FHIR API is available at: https://onc.api.staging-ehr.athelas.com/onc/base.json

FAQ

Where do I find the CapabilityStatement and SMART configuration?

Both are unauthenticated GET endpoints on the Service Base URL: the FHIR CapabilityStatement at /metadata and the SMART discovery document at /.well-known/smart-configuration. Examples of each output are included on this page.

How do I register an application?

Self-serve registration is planned for a future release. Today, contact Commure (d/b/a Athelas) to register — see the Application Registration & Onboarding Guide. There are no registration, sandbox, or production fees.

Which version of US Core and USCDI does the API support?

The API conforms to US Core 6.1.0 on FHIR R4 (4.0.1) and supports the USCDI v3 data set. See the US Core Conformance Statement and the Resource-to-USCDI Mapping Matrix.

How do I validate my integration for ONC (g)(10)?

Run the ONC Inferno (g)(10) Standardized API test kit against the Service Base URL. It exercises SMART App Launch v2.0, US Core 6.1.0, and Bulk Data v2.0 conformance.

Can I write data back through the API?

No. The API is read-only — all interactions are read and search-type. Write operations are not supported.

​SMART on FHIR Configuration

​Example .well-known/smart-configuration output

​ SMART Endpoint Reference

​CapabilityStatement

​Example CapabilityStatement (abridged)

​Application Registration & Onboarding Guide

Review the documentation and Terms of Use

Request application registration

Receive your credentials

Configure SMART discovery

Test against the sandbox

Validate conformance

Go live

​Authorization

​ Supported Grant Types

​ Token Authentication Methods

​ SMART Standalone Launch Flow

​ EHR Launch Flow

​ Backend Services Authorization (Bulk Data)

​ Token Introspection

​ Token Revocation

​ Token Refresh

​Scopes

​Context Scopes

​Patient-Level Resource Scopes

​Granular Scopes

​US Core Conformance Statement

​Resource-to-USCDI Mapping Matrix

​Resource Endpoints

​ Patient

​ AllergyIntolerance

​ CarePlan

​ CareTeam

​ Condition

​ Coverage

​ Device

​ DiagnosticReport

​ DocumentReference

​ Encounter

​ Goal

​ Immunization

​ Location

​ MedicationDispense

​ MedicationRequest

​ Observation

​ Organization

​ Practitioner

​ Procedure

​ Provenance

​ RelatedPerson

​ ServiceRequest

​ Specimen

​Bulk Data API

​ Export Endpoints

​ Export Job Management

​ Group Management

​Responses and Error Handling

​Successful Responses

​Error Responses

​Additional Notes

​API Terms of Use

​ Permitted use

​ Fees and non-discrimination

​ Developer responsibilities

​ Suspension and changes

​Service Base URL

​FAQ

SMART on FHIR Configuration

Example `.well-known/smart-configuration` output

SMART Endpoint Reference

CapabilityStatement

Example `CapabilityStatement` (abridged)

Application Registration & Onboarding Guide

Authorization

Supported Grant Types

Token Authentication Methods

SMART Standalone Launch Flow

EHR Launch Flow

Backend Services Authorization (Bulk Data)

Token Introspection

Token Revocation

Token Refresh

Scopes

Context Scopes

Patient-Level Resource Scopes

Granular Scopes

US Core Conformance Statement

Resource-to-USCDI Mapping Matrix

Resource Endpoints

Patient

AllergyIntolerance

CarePlan

CareTeam

Condition

Coverage

Device

DiagnosticReport

DocumentReference

Encounter

Goal

Immunization

Location

MedicationDispense

MedicationRequest

Observation

Organization

Practitioner

Procedure

Provenance

RelatedPerson

ServiceRequest

Specimen

Bulk Data API

Export Endpoints

Export Job Management

Group Management

Responses and Error Handling

Successful Responses

Error Responses

Additional Notes

API Terms of Use

Permitted use

Fees and non-discrimination

Developer responsibilities

Suspension and changes

Service Base URL

FAQ