Skip to main content
HomeDocsAPI Reference

API Reference

7 production FHIR R4 APIs with OpenAPI 3.1 specs, OAuth 2.0 authentication, and interactive sandbox documentation. All APIs return standard FHIR R4 bundles with Da Vinci and US Core profile conformance.

API landscape showing 7 FHIR R4 APIs — Patient Access, Provider Access, Prior Authorization, Payer-to-Payer, Claims Scrubbing, Risk Adjustment, and Encounter Service
7 production APIs — 4 CMS-0057-F required + 3 operational

Environments

EnvironmentBase URLAuth
Productionhttps://api.cloudhealthoffice.com/fhir/r4OAuth 2.0 (Azure AD)
Sandboxhttps://sandbox.cloudhealthoffice.com/fhir/r4Test tokens (synthetic data)
Local Devhttp://localhost:3000/fhir/r4Bearer test-token

Interactive OpenAPI docs are available at the API Sandbox. All requests require an X-Tenant-ID header for multi-tenant routing.

Authentication

Production APIs use OAuth 2.0 with Azure AD (Microsoft Entra ID). The FHIR server publishes a SMART on FHIR configuration at /.well-known/smart-configuration with supported scopes including patient/*.read, user/*.read, and system/*.read.

# Discover OAuth endpoints
curl https://api.cloudhealthoffice.com/fhir/r4/.well-known/smart-configuration

# Get access token (client credentials)
curl -X POST https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token \
  -d "grant_type=client_credentials" \
  -d "client_id={client_id}" \
  -d "client_secret={client_secret}" \
  -d "scope=api://cloudhealthoffice/.default"

Patient Access API

CMS-9115-F and CMS-0057-F required. Enables patients to access their complete health data via FHIR.

EndpointMethodDescription
/Patient/{id}GETPatient demographics and contact information
/Coverage?patient={id}GETActive benefits and eligibility
/Claim?patient={id}GETClaims history (X12 837 → FHIR Claim)
/ExplanationOfBenefit?patient={id}GETPayment details (X12 835 → FHIR EOB)
/Encounter?patient={id}GETHealthcare visits and services
/Condition?patient={id}GETDiagnoses and clinical conditions

Provider Access API

Gives in-network providers access to member clinical and claims data with Da Vinci PDex profile conformance.

EndpointMethodDescription
/Patient/$member-matchPOSTMatch patient across payers without sharing raw identifiers
/Group/{id}/$exportPOSTBulk FHIR export for attributed members

Prior Authorization API

Converts prior auth from phone/fax to real-time FHIR with Da Vinci PAS, CRD, and DTR conformance. Bidirectional X12 278 mapping.

EndpointMethodDescription
/Claim/$submitPOSTSubmit prior auth request (X12 278 → FHIR)
/Claim/$inquirePOSTCheck prior auth status
/Claim/{id}/$cancelPOSTCancel existing prior auth
/SubscriptionPOSTSubscribe to auth status updates

Payer-to-Payer API

Enables data exchange when members switch health plans. Supports Bulk FHIR $export operations.

EndpointMethodDescription
/Patient/$member-matchPOSTIdentify member in source payer system
/Patient/{id}/$everythingGETComplete member record transfer
/Group/$exportPOSTBulk transfer for member cohorts

Operational APIs

Claims Scrubbing

NCCI/MUE edit checking, CPT validation, diagnosis code verification, and custom payer scrub rules.

Risk Adjustment

HCC (Hierarchical Condition Category) coding and RAF (Risk Adjustment Factor) score calculation for Medicare Advantage and ACA risk adjustment.

Encounter Service

State and federal encounter submission management for Medicaid MCOs, including encounter data validation, submission tracking, and reconciliation.

OpenAPI specs

Full OpenAPI 3.1 specifications are available in the api/openapi directory on GitHub. Explore them interactively in the API Sandbox.