Tenant Onboarding¶

Overview¶

Tenant onboarding is the process of registering a healthcare organization within the VitalBridge platform.

A tenant represents an independent healthcare organization such as:

Hospital
Clinic
Healthcare Network
Telehealth Provider
Wellness Organization

Tenant onboarding establishes the organizational foundation required before administrators, providers, and patients can be managed.

Onboarding Workflow¶

sequenceDiagram
  actor User as Client/Frontend
  participant Gateway as vb-gateway
  participant Tenant as vb-tenant-registry-service
  participant Admin as vb-admin-service
  participant Identity as vb-identity-service
  User->>Gateway: POST /api/v1/tenants
  Gateway-->>User: 202 Accepted
  Gateway-)Tenant: Emit ``vb.tenant.register`` (Command)
  Note over Tenant: Atomic Transaction
  Tenant->>Tenant: Insert Tenant record
  Tenant->>Tenant: Write to Outbox
  Tenant-)Admin: Emit ``vb.admin.create`` (Outbox Command)
  Tenant-)Kafka: Emit ``vb.tenant.created`` (Outbox Event)
  Note over Admin: Atomic Transaction
  Admin->>Admin: Insert Admin record
  Admin->>Admin: Write to Outbox
  Admin-)Identity: Emit ``vb.admin.created`` (Outbox Event)
  Note over Identity: Provisioning
  Identity->>Keycloak: Create Keycloak User
  Identity->>Keycloak: Assign ROLE_TENANT_ADMIN
  Identity->>Identity: Write keycloak_users record + Outbox
  Identity-)Kafka: Emit ``vb.admin.keycloak_user_created``

Hold "Alt" / "Option" to enable pan & zoom

Information Collected¶

Organization Information¶

Organization Name
Organization Type
Timezone
Address

Primary Contact¶

First Name
Last Name
Email Address
Mobile Number

The primary contact becomes the initial Tenant Administrator.

Onboarding Outcome¶

Successful onboarding results in:

Tenant creation
Tenant identifier assignment
Primary administrator creation
Identity provisioning
Platform access activation