Every resource in HealthCloud — platform objects like Organizations and Workflows, and FHIR R4 clinical objects like Patients and Observations — described with field-level documentation, JSON examples, relationships, and events.
HealthCloud has two layers of objects: platform-native objects that represent your infrastructure, and FHIR R4 clinical objects that represent patient data.
The top-level account entity. All Projects, Assets, and Deployments belong to an Organization. Billing, RBAC, and audit logs are scoped here.
Fields
idstringrequiredUnique identifier (org_...)
namestringrequiredDisplay name of the organization
slugstringrequiredURL-safe unique slug
plan"starter"|"growth"|"enterprise"requiredSubscription tier
hipaa_baa_signedbooleanWhether a BAA is on file
created_atstring (ISO 8601)Account creation timestamp
Example
{
"id": "org_healthsystem_01",
"name": "Riverside Health System",
"slug": "riverside-health",
"plan": "enterprise",
"hipaa_baa_signed": true,
"created_at": "2024-01-15T09:00:00Z"
}A logical workspace inside an Organization. Projects group Assets, Deployments, Workflows, and Data Sources for a specific clinical use case.
Fields
idstringrequiredUnique project identifier (proj_...)
org_idstringrequiredParent organization
namestringrequiredProject display name
blueprintstringBlueprint used to scaffold this project
status"active"|"archived"requiredLifecycle status
environment"sandbox"|"staging"|"production"requiredTarget environment
Example
{
"id": "proj_rpm_2026",
"org_id": "org_healthsystem_01",
"name": "RPM Chronic Disease Program",
"blueprint": "remote-patient-monitoring",
"status": "active",
"environment": "production"
}A versioned, publishable unit of healthcare AI — a model, agent, dataset, workflow template, or connector. Assets live in the Marketplace and can be deployed to Projects.
Fields
idstringrequiredAsset identifier (asset_...)
type"model"|"agent"|"dataset"|"connector"|"workflow"requiredAsset category
namestringrequiredDisplay name
versionstringrequiredSemantic version (e.g. 2.1.0)
publisher_idstringrequiredOrganization that published this asset
fhir_compatiblebooleanFHIR R4 I/O compliance flag
Example
{
"id": "asset_glucose_anomaly_v2",
"type": "model",
"name": "Glucose Anomaly Detector",
"version": "2.1.0",
"publisher_id": "org_healthsystem_01",
"fhir_compatible": true
}A live, running instance of an Asset in a specific environment. Deployments track configuration, resource allocation, health status, and runtime logs.
Fields
idstringrequiredDeployment identifier (dep_...)
asset_idstringrequiredThe asset being deployed
project_idstringrequiredProject this deployment belongs to
environment"sandbox"|"staging"|"production"requiredTarget environment
status"active"|"failed"|"stopped"requiredCurrent deployment state
configobjectRuntime configuration key-value pairs
Example
{
"id": "dep_glucose_prod_01",
"asset_id": "asset_glucose_anomaly_v2",
"project_id": "proj_rpm_2026",
"environment": "production",
"status": "active",
"config": {
"threshold_mgdl": 250,
"alert_channel": "ehr_notification"
}
}An autonomous clinical AI agent with defined capabilities, tool access, and a structured input/output schema. Agents can be orchestrated in multi-step Workflows.
Fields
idstringrequiredAgent identifier (agent_...)
namestringrequiredDisplay name
type"clinical"|"administrative"|"diagnostic"requiredAgent purpose classification
capabilitiesstring[]requiredList of actions this agent can perform
mcp_toolsstring[]MCP tool IDs available to this agent
input_schemaobjectrequiredFHIR resource types this agent accepts
Example
{
"id": "agent_anomaly_detector",
"name": "Glucose Anomaly Agent",
"type": "clinical",
"capabilities": [
"analyze_glucose_trend",
"generate_alert",
"route_to_care_team"
],
"mcp_tools": ["fhir_read", "alert_create"],
"input_schema": { "resource": "Observation" }
}A directed acyclic graph of Agents, data transformations, and conditional logic. Workflows define the orchestration logic for end-to-end clinical automation.
Fields
idstringrequiredWorkflow identifier (wf_...)
project_idstringrequiredProject this workflow belongs to
namestringrequiredWorkflow display name
trigger"event"|"schedule"|"manual"requiredWhat starts this workflow
nodesWorkflowNode[]requiredOrdered array of processing steps
status"active"|"paused"|"draft"requiredOperational state
Example
{
"id": "wf_rpm_alert_pipeline",
"project_id": "proj_rpm_2026",
"name": "RPM Alert Pipeline",
"trigger": "event",
"nodes": [
{ "type": "agent", "agent_id": "agent_anomaly_detector" },
{ "type": "condition", "if": "alert.severity >= HIGH" },
{ "type": "action", "action": "notify_provider" }
],
"status": "active"
}PatientThe root entity for all clinical data. Represents a person receiving care. In HealthCloud, every Observation, Encounter, and Alert is linked to a Patient record.
Fields
idstringrequiredPlatform-assigned identifier (pat_...)
resourceType"Patient"requiredAlways "Patient" for FHIR compliance
nameHumanName[]requiredGiven and family name array
birthDatestring (ISO 8601)Date of birth (YYYY-MM-DD)
gender"male"|"female"|"other"Administrative gender
identifierIdentifier[]MRN, SSN, or external identifiers
Example
{
"id": "pat_123",
"resourceType": "Patient",
"name": [{
"use": "official",
"family": "Doe",
"given": ["Jane"]
}],
"birthDate": "1985-06-15",
"gender": "female",
"identifier": [{
"system": "http://hospital.org/mrn",
"value": "MRN-2024-00123"
}]
}ObservationA clinical measurement or finding — vital signs, lab results, device readings, and diagnostic assessments. The primary output of RPM devices and AI models.
Fields
idstringrequiredPlatform-assigned identifier (obs_...)
status"final"|"preliminary"|"amended"requiredResult finalization status
codeCodeableConceptrequiredLOINC code identifying the measurement type
subjectReference (Patient)requiredPatient this observation belongs to
valueQuantityQuantityNumeric result with unit
effectiveDateTimestring (ISO 8601)When the measurement was taken
Example
{
"id": "obs_456",
"resourceType": "Observation",
"status": "final",
"code": {
"coding": [{
"system": "http://loinc.org",
"code": "2339-0",
"display": "Glucose [Mass/volume] in Blood"
}]
},
"subject": { "reference": "Patient/pat_123" },
"valueQuantity": {
"value": 247,
"unit": "mg/dL"
},
"effectiveDateTime": "2026-03-17T14:22:00Z"
}HealthCloud objects form a hierarchy from Organization down to FHIR clinical data. Understanding these relationships is key to designing effective clinical AI systems.
| From | Relationship | To | Description |
|---|---|---|---|
Organization | has many | Project | An Org owns one or more Projects |
Project | deploys | Asset | Projects deploy Assets from the Marketplace |
Project | contains | Workflow | Projects contain one or more Workflows |
Workflow | orchestrates | Agent | Workflows orchestrate Agents as nodes |
Agent | consumes | Observation | Agents read FHIR Observations as input |
Observation | belongs to | Patient | Observations are linked to a Patient |
Asset | becomes | Deployment | A deployed Asset becomes a Deployment |
Platform objects like Deployments, Workflows, and Agents move through a defined set of states. Transitions emit Platform Events that you can subscribe to via webhooks.
Created but not yet active. Editable, not processing.
Under test. Processes synthetic data only.
Live in production. Processing real clinical data.
Temporarily suspended. Can be resumed without reconfiguration.
Permanently stopped. Audit logs retained for 7 years.
Access to objects is controlled by Organization-level RBAC. Each role has defined read/write permissions scoped to specific object types.
| Role | Objects | Access Level |
|---|---|---|
| Owner | Organization, Project, Asset, Deployment, Workflow, Agent | Full read/write/delete |
| Admin | Project, Asset, Deployment, Workflow, Agent | Read/write, no delete on Org |
| Developer | Asset, Deployment, Workflow, Agent | Read/write in assigned Projects |
| Viewer | All (read-only) | Read-only across all objects |
| Clinical | Patient, Observation | Read PHI objects in approved Projects |
Every state change on a platform object emits a structured event. Subscribe to events via the Webhooks API to build reactive integrations and monitoring.
| Event Type | Object | Description |
|---|---|---|
deployment.created | Deployment | Fired when a new deployment is provisioned |
deployment.failed | Deployment | Fired when a deployment enters error state |
workflow.run.completed | Workflow | Fired when a workflow execution finishes |
workflow.run.failed | Workflow | Fired when a workflow execution encounters an error |
agent.alert_generated | Agent | Fired when an agent emits a clinical alert |
observation.received | Observation | Fired when a new FHIR Observation is ingested |
Trace a single glucose reading from device ingestion through AI analysis, alert routing, and billing — showing how all 8 objects interact in a real RPM workflow.
POST /api/v1/observations
// Glucose device transmits reading → FHIR Observation created
{ "resourceType": "Observation", "subject": "Patient/pat_123",
"code": { "coding": [{ "code": "2339-0" }] },
"valueQuantity": { "value": 285, "unit": "mg/dL" } }// Platform Event: observation.received
// Workflow wf_rpm_alert_pipeline receives trigger
// Agent agent_anomaly_detector is invoked with the Observation
{ "agent_id": "agent_anomaly_detector",
"input": { "observation_id": "obs_456", "patient_id": "pat_123" } }// Agent evaluates glucose vs. patient baseline (240 mg/dL)
// Threshold exceeded → alert generated
{ "type": "agent.alert_generated",
"severity": "HIGH",
"message": "Glucose 285 mg/dL exceeds threshold (240). Immediate review recommended.",
"routed_to": "care_team_id_01" }// FHIR Observation written to Epic via SMART on FHIR
// CPT billing event generated: 99457 (20 min device review)
{ "cpt_code": "99457", "duration_minutes": 22,
"patient_id": "pat_123", "deployment_id": "dep_glucose_prod_01",
"billing_month": "2026-03" }Explore the API interactively, read end-to-end guides, or open Studio to start building your first clinical AI project.