Developer Documentation

VitalEdge API Documentation

Build powerful healthcare integrations with our RESTful API and HL7 FHIR R4 endpoints. Full documentation for authentication, endpoints, and examples.

FHIR R4 DocumentationRequest API Access

Authentication

JWT tokens, OAuth 2.0, API keys

REST Endpoints

Patients, observations, alerts

FHIR R4

HL7 FHIR resources & profiles

Code Examples

Sample code and tutorials

Authentication

VitalEdge API uses JWT (JSON Web Tokens) for authentication. All API requests must include a valid access token in the Authorization header.

JWT Bearer Tokens

Primary authentication method. Access tokens expire after 15 minutes, refresh tokens after 7 days.

Authorization: Bearer eyJhbGciOiJIUzI1NiIs...

Organization Context

Multi-tenant isolation requires organization ID header for all requests.

X-Organization-ID: org_abc123

Rate Limits

Standard: 1,000 requests/minute | Enterprise: 10,000 requests/minute

Authentication Flow
// 1. Login to get tokens
POST /api/auth/login
{
  "email": "user@example.com",
  "password": "secure_password"
}

// Response
{
  "accessToken": "eyJhbG...",
  "refreshToken": "eyJhbG...",
  "expiresIn": 900,
  "user": { "id": "user_123", ... }
}

// 2. Use access token for requests
GET /api/patients
Headers:
  Authorization: Bearer eyJhbG...
  X-Organization-ID: org_abc123

REST API Endpoints

Authentication

POST/api/auth/login
POST/api/auth/refresh
POST/api/auth/logout
POST/api/auth/mfa/verify

Patients

GET/api/patients
GET/api/patients/:id
POST/api/patients
PATCH/api/patients/:id

Observations

GET/api/observations
POST/api/observations
GET/api/observations/patient/:patientId

Alerts

GET/api/alerts
GET/api/alerts/triage
POST/api/alerts/:id/resolve
POST/api/alerts/bulk-resolve

Enrollments

GET/api/enrollments
POST/api/enrollments
PATCH/api/enrollments/:id

Billing

GET/api/billing/summary/:orgId/:month
GET/api/billing/readiness/:enrollmentId/:month
GET/api/billing/export/:orgId/:month

Full API reference with request/response schemas available in our OpenAPI specification.

Request full API documentation

Code Examples

Create an Observation

Record clinical observations from devices, manual entry, or patient self-report. Observations are linked to enrollments for accurate billing calculations.

Supports multiple data sources (DEVICE, MANUAL, API)
Automatic alert rule evaluation
Links to billing enrollments automatically
JavaScript
// Example: Create an observation
const response = await fetch('https://api.vsumup-health.com/api/observations', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_JWT_TOKEN',
    'Content-Type': 'application/json',
    'X-Organization-ID': 'org_abc123'
  },
  body: JSON.stringify({
    patientId: 'patient_xyz',
    metricDefinitionId: 'metric_bp_systolic',
    value: 142,
    unit: 'mmHg',
    source: 'DEVICE',
    recordedAt: '2025-01-31T10:30:00Z'
  })
});

const observation = await response.json();
// { id: "obs_123", patientId: "patient_xyz", value: 142, ... }

Client Libraries

Official SDKs to accelerate your integration. Sign up to be notified when they launch.

JS

JavaScript/TypeScript

Coming Soon
PY

Python

Coming Soon
RB

Ruby

Coming Soon
GO

Go

Planned

Ready to Build?

Get API access and start integrating VitalEdge with your healthcare systems today.

Request API AccessView FHIR Docs