Understand how HealthCloud works before you write your first API call. This page gives you the mental model you need to build quickly and correctly.
HealthCloud is a platform where you Install → Configure → Deploy → Run.
Instead of building everything from scratch, you install prebuilt components (assets), connect them to real-world systems, and orchestrate logic using workflows.
Every application built on HealthCloud follows this sequence from first API call to production system.
Apps, agents, models, datasets, and connectors are all assets — installable, configurable, deployable components.
POST /v1/assets/install
{
"asset_id": "agent_prior_auth_v1",
"project_id": "proj_123"
}Installing an asset does not run it. You must deploy it. A deployment is a configured, running instance of an asset.
POST /v1/deployments
{
"asset_id": "agent_prior_auth_v1",
"environment": "production",
"config": {
"payer_api": "cms_prior_auth"
}
}Workflows define the logic of your application — connecting agents, APIs, and data across sequential steps.
POST /v1/workflows/run
{
"workflow_id": "uti_screening",
"input": {
"patient_id": "pat_123"
}
}All clinical data is stored and queried as FHIR R4 resources. Patient, Observation, Condition, and Encounter are first-class objects.
{
"resourceType": "Observation",
"code": {
"coding": [{
"system": "http://loinc.org",
"code": "8310-5",
"display": "Body temperature"
}]
},
"valueQuantity": {
"value": 101.2,
"unit": "F"
}
}Use API keys for all platform interactions. Keys are scoped to an organization and optionally to a project.
// Include in every request: Authorization: Bearer hc_test_sk_xxxxxxxxxxxxxxxx // Sandbox keys start with hc_test_ // Production keys start with hc_live_
Every resource is scoped to an organization and project. PHI is isolated by tenant with no cross-contamination.
// Every API response includes scope metadata:
{
"organization_id": "org_123",
"project_id": "proj_abc",
"environment": "production"
}Agents are AI-powered workers that execute tasks. They are the execution units of your healthcare application — pre-built, configurable, and deployed on demand.
Eligibility Agent
Prior Auth Agent
Diagnostic Agent
Care Coordination Agent
You don't build integrations — you configure them. Connect Epic, Athenahealth, Quest, and CMS APIs in minutes via the integration catalog.
Epic
Athenahealth
Quest Diagnostics
CMS Prior Auth API
HealthCloud is event-driven. Subscribe to platform events and build reactive systems without polling.
workflow.completedA workflow finished executiondiagnostic.result_readyAI returned a diagnostic resultdeployment.failedA deployment encountered an errorBuild a diagnostic app in 5 steps:
You now have the mental model. Make your first API call in the explorer or open Studio to build your first project.