API Reference

Sends an OTP via SMS (Twilio) or WhatsApp to the patient's registered phone number. Rate-limited to prevent abuse.

Request Body

Response — 200 OK

{
  "status": "otp_sent",
  "expires_in": 300,
  "channel": "sms"
}

Verifies the OTP and returns an access token (JWT) and a refresh token (HttpOnly cookie).

Response — 200 OK

{
  "access_token": "eyJhbGciOiJIUzI1NiIs...",
  "token_type": "bearer",
  "expires_in": 900,
  "user": {
    "id": "pat_01JFGH3K2MNPQ4RS5TUVWXYZ",
    "phone": "+919876543210",
    "role": "patient"
  }
}

Exchange a Google ID token for a PatientPulse session. Suitable for web app login flows.

Returns the full profile of the currently authenticated user including role, organization, and permissions.

Pass a lab report (PDF or image reference) and receive structured clinical interpretation — abnormal flags, trend markers, recommended actions.

Response — 200 OK

{
  "interpretation": {
    "summary": "HbA1c elevated at 7.8% — borderline diabetic range.",
    "abnormal_markers": [
      { "name": "HbA1c", "value": "7.8%", "flag": "HIGH" },
      { "name": "Triglycerides", "value": "210 mg/dL", "flag": "HIGH" }
    ],
    "recommendations": ["Repeat HbA1c in 3 months", "Dietary consult advised"],
    "confidence": 0.91
  }
}

Submit consultation transcript or audio reference; receive a structured SOAP note with chief complaint, history, assessment, and plan.

Returns ML-generated demand forecast (XGBoost + Prophet ensemble) for OPD and Emergency departments. Used for capacity planning and staffing optimization.

Returns a complete FHIR R4 Bundle containing Patient, Conditions, Medications, Observations, and Appointments resources.

Response — 200 OK

{
  "resourceType": "Bundle",
  "type": "collection",
  "entry": [
    {
      "resource": {
        "resourceType": "Patient",
        "id": "pat_01JFGH3K2MNPQ4RS5TUVWXYZ",
        "name": [{ "text": "Ramesh Kumar" }],
        "birthDate": "1985-04-15",
        "identifier": [{ "system": "https://abha.gov.in", "value": "12-3456-7890-1234" }]
      }
    }
  ]
}

Poll the status of an ABHA identity linking request. Links are initiated via the mobile app and processed asynchronously by the ABDM connector.

Triggered automatically on consult completion (Feature 7A). Can also be called manually to push specific records to a patient's ABHA-linked health locker.

Submit a pre-authorization or claim to the payer via NHCX. Returns a correlation_id for status polling.

Polls the National Health Claims Exchange for real-time claim status using the correlation ID returned at claim submission.

Identical contract to PatientPulse auth. Can be proxied to canonical PatientPulse backend via NODE_AUTH_PROXY_ENABLED=true.

Returns all health records for a profile, grouped by category (labs, prescriptions, imaging, discharge summaries).

Response — 200 OK

{
  "profile_id": "prof_abc123",
  "records": {
    "labs": [/* ... */],
    "prescriptions": [/* ... */],
    "imaging": [/* ... */]
  },
  "total_records": 47,
  "last_updated": "2025-11-14T10:30:00Z"
}

Queues an async AI job to extract structured health markers (diagnoses, medications, vitals) from a health record document.

Sets revoked_at timestamp. All subsequent requests using this key will receive 401 invalid_api_key. Irreversible — rotate instead if you need a replacement.

Atomically revokes the old key and creates a replacement with the same environment, plan, scopes, and label. The new plaintext key is returned once.