Runtime API Examples

This page demonstrates usage of some of the runtime APIs provided by VitePress.

The main useData() API can be used to access site, theme, and page data for the current page. It works in both .md and .vue files:

<script setup>
import { useData } from 'vitepress'

const { theme, page, frontmatter } = useData()
</script>

## Results

### Theme Data
<pre>{{ theme }}</pre>

### Page Data
<pre>{{ page }}</pre>

### Page Frontmatter
<pre>{{ frontmatter }}</pre>

Results

Theme Data

{
  "search": {
    "provider": "local"
  },
  "logo": {
    "light": "/logo/fossible-logo-light.svg",
    "dark": "/logo/fossible-logo-dark.svg"
  },
  "siteTitle": false,
  "nav": [
    {
      "text": "Digital Health",
      "items": [
        {
          "text": "Biograph",
          "link": "/products/biograph/",
          "icon": "lucide-heart",
          "subtitle": "CareOps & ERP Platform"
        },
        {
          "text": "Health Data Platform ",
          "link": "/products/medplum/",
          "icon": "lucide-database",
          "subtitle": "Medplum - FHIR CDR"
        },
        {
          "text": "The Fossible Stack ",
          "link": "/guide/stack",
          "icon": "lucide-layers",
          "subtitle": "Enterprise Stack"
        }
      ]
    },
    {
      "text": "Solutions",
      "link": "/solutions/"
    },
    {
      "text": "Resources",
      "items": [
        {
          "text": "Docs",
          "link": "/guide/biograph-docs/",
          "icon": "lucide-book-open",
          "subtitle": "Documentation"
        },
        {
          "text": "Blog",
          "link": "/blog/",
          "icon": "lucide-pencil",
          "subtitle": "Latest Updates"
        }
      ]
    },
    {
      "text": "|",
      "link": ""
    },
    {
      "text": "About",
      "link": "/about/"
    },
    {
      "text": "Contact Us",
      "link": "/contact/"
    }
  ],
  "sidebar": {
    "/guide/": [
      {
        "text": "Biograph Docs",
        "collapsed": true,
        "items": [
          {
            "text": "Overview",
            "link": "/guide/biograph-docs/"
          },
          {
            "text": "Getting Started",
            "collapsed": true,
            "items": [
              {
                "text": "What is Biograph",
                "link": "/guide/biograph-docs/getting-started/overview"
              },
              {
                "text": "Who Should Use Biograph",
                "link": "/guide/biograph-docs/getting-started/users"
              },
              {
                "text": "Key Features & Benefits",
                "link": "/guide/biograph-docs/getting-started/features"
              },
              {
                "text": "Healthcare Workflow",
                "link": "/guide/biograph-docs/getting-started/workflow"
              },
              {
                "text": "System Architecture",
                "link": "/guide/biograph-docs/getting-started/architecture"
              },
              {
                "text": "Terminology & Concepts",
                "link": "/guide/biograph-docs/getting-started/glossary"
              },
              {
                "text": "Quick Start Guide",
                "link": "/guide/biograph-docs/getting-started/quickstart"
              }
            ]
          },
          {
            "text": "Role-Based Workflows",
            "collapsed": true,
            "items": [
              {
                "text": "Clinical Administrator",
                "link": "/guide/biograph-docs/user-personas/clinical-administrator"
              },
              {
                "text": "Reception / Front Desk",
                "link": "/guide/biograph-docs/user-personas/reception--front-desk"
              },
              {
                "text": "Physicians / Practitioner",
                "link": "/guide/biograph-docs/user-personas/physicians-practitioner"
              },
              {
                "text": "Nurse",
                "link": "/guide/biograph-docs/user-personas/nurse"
              },
              {
                "text": "Laboratory User",
                "link": "/guide/biograph-docs/user-personas/laboratory-user"
              },
              {
                "text": "Pharmacist",
                "link": "/guide/biograph-docs/user-personas/pharmacist"
              },
              {
                "text": "Billing Staff",
                "link": "/guide/biograph-docs/user-personas/billing-staff"
              },
              {
                "text": "Hospital Management",
                "link": "/guide/biograph-docs/user-personas/hospital--management-administartor"
              },
              {
                "text": "Patients",
                "link": "/guide/biograph-docs/user-personas/patients"
              }
            ]
          },
          {
            "text": "Setup & Configuration",
            "collapsed": true,
            "items": [
              {
                "text": "Installation",
                "link": "/guide/biograph-docs/setup/installation"
              },
              {
                "text": "Healthcare Settings",
                "link": "/guide/biograph-docs/setup/healthcare-settings"
              },
              {
                "text": "Masters Configuration",
                "link": "/guide/biograph-docs/setup/masters"
              },
              {
                "text": "Facility Setup",
                "link": "/guide/biograph-docs/setup/facility"
              },
              {
                "text": "User Management",
                "link": "/guide/biograph-docs/setup/users"
              },
              {
                "text": "Security & Compliance",
                "link": "/guide/biograph-docs/setup/security"
              }
            ]
          },
          {
            "text": "Patient Management",
            "collapsed": true,
            "items": [
              {
                "text": "Patient Registration",
                "link": "/guide/biograph-docs/patient-care/registration"
              },
              {
                "text": "Medical History",
                "link": "/guide/biograph-docs/patient-care/medical-history"
              },
              {
                "text": "Patient Dashboard",
                "link": "/guide/biograph-docs/patient-care/dashboard"
              },
              {
                "text": "Duplicate Detection",
                "link": "/guide/biograph-docs/patient-care/duplicate-detection"
              },
              {
                "text": "Patient Care Types",
                "link": "/guide/biograph-docs/patient-care/care-types"
              }
            ]
          },
          {
            "text": "Staff & Attendance",
            "collapsed": true,
            "items": [
              {
                "text": "Shift Management",
                "link": "/guide/biograph-docs/hr-workforce/shift-management"
              },
              {
                "text": "Attendance Management",
                "link": "/guide/biograph-docs/hr-workforce/attendance-management"
              },
              {
                "text": "Time Tracking",
                "link": "/guide/biograph-docs/hr-workforce/Time"
              },
              {
                "text": "Overtime Management",
                "link": "/guide/biograph-docs/hr-workforce/Overtime"
              }
            ]
          },
          {
            "text": "Practitioner Management",
            "collapsed": true,
            "items": [
              {
                "text": "Practitioner Setup",
                "link": "/guide/biograph-docs/patient-care/practitioner-setup"
              },
              {
                "text": "Practitioner Types",
                "link": "/guide/biograph-docs/patient-care/practitioner-types"
              },
              {
                "text": "Availability & Scheduling",
                "link": "/guide/biograph-docs/patient-care/practitioner-scheduling"
              },
              {
                "text": "Charges & Fee Validity",
                "link": "/guide/biograph-docs/patient-care/practitioner-charges"
              },
              {
                "text": "Referring Physicians",
                "link": "/guide/biograph-docs/patient-care/referrals"
              }
            ]
          },
          {
            "text": "Appointments & Scheduling",
            "collapsed": true,
            "items": [
              {
                "text": "Prerequisites",
                "link": "/guide/biograph-docs/clinical-workflows/appointment-prerequisites"
              },
              {
                "text": "Booking Appointments",
                "link": "/guide/biograph-docs/clinical-workflows/booking-appointments"
              },
              {
                "text": "Queue Management",
                "link": "/guide/biograph-docs/clinical-workflows/appointment-queue-management"
              },
              {
                "text": "Appointment Calendar",
                "link": "/guide/biograph-docs/clinical-workflows/appointment-calendar"
              },
              {
                "text": "Cancel & Reschedule",
                "link": "/guide/biograph-docs/clinical-workflows/cancel-reschedule"
              },
              {
                "text": "Status Workflow",
                "link": "/guide/biograph-docs/clinical-workflows/appointment-status"
              },
              {
                "text": "Billing Integration",
                "link": "/guide/biograph-docs/clinical-workflows/appointment-billing"
              },
              {
                "text": "Teleconsultation",
                "link": "/guide/biograph-docs/clinical-workflows/teleconsultation"
              }
            ]
          },
          {
            "text": "Clinical Consultation",
            "collapsed": true,
            "items": [
              {
                "text": "Encounter Overview",
                "link": "/guide/biograph-docs/clinical-workflows/encounter-overview"
              },
              {
                "text": "Creating Encounters",
                "link": "/guide/biograph-docs/clinical-workflows/creating-encounters"
              },
              {
                "text": "Clinical Documentation",
                "link": "/guide/biograph-docs/clinical-workflows/clinical-documentation"
              },
              {
                "text": "Orders & Prescriptions",
                "link": "/guide/biograph-docs/clinical-workflows/orders-prescriptions"
              },
              {
                "text": "Medical Coding",
                "link": "/guide/biograph-docs/clinical-workflows/medical-coding"
              },
              {
                "text": "Follow-up & Fee Validity",
                "link": "/guide/biograph-docs/clinical-workflows/followup-fee-validity"
              }
            ]
          },
          {
            "text": "Nursing & Tasks",
            "collapsed": true,
            "items": [
              {
                "text": "Nursing Tasks",
                "link": "/guide/biograph-docs/clinical-workflows/nursing-tasks"
              },
              {
                "text": "Checklist Templates",
                "link": "/guide/biograph-docs/clinical-workflows/nursing-checklists"
              },
              {
                "text": "Service Requests",
                "link": "/guide/biograph-docs/clinical-workflows/service-requests"
              }
            ]
          },
          {
            "text": "Clinical Procedures",
            "collapsed": true,
            "items": [
              {
                "text": "Procedure Creation",
                "link": "/guide/biograph-docs/clinical-workflows/procedure-creation"
              },
              {
                "text": "Procedure Templates",
                "link": "/guide/biograph-docs/clinical-workflows/procedure-templates"
              },
              {
                "text": "Procedure Workflow",
                "link": "/guide/biograph-docs/clinical-workflows/procedure-workflow"
              },
              {
                "text": "Consumables & Billing",
                "link": "/guide/biograph-docs/clinical-workflows/procedure-billing"
              }
            ]
          },
          {
            "text": "Laboratory & Diagnostics",
            "collapsed": true,
            "items": [
              {
                "text": "Lab Test Templates",
                "link": "/guide/biograph-docs/diagnostics/lab-test-templates"
              },
              {
                "text": "Sample Collection",
                "link": "/guide/biograph-docs/diagnostics/sample-collection"
              },
              {
                "text": "Lab Test Creation",
                "link": "/guide/biograph-docs/diagnostics/lab-test-creation"
              },
              {
                "text": "Observations & Results",
                "link": "/guide/biograph-docs/diagnostics/observations"
              },
              {
                "text": "Diagnostic Reports",
                "link": "/guide/biograph-docs/diagnostics/diagnostic-reports"
              }
            ]
          },
          {
            "text": "Inpatient Management",
            "collapsed": true,
            "items": [
              {
                "text": "Admission Process",
                "link": "/guide/biograph-docs/inpatient/admission"
              },
              {
                "text": "Bed & Occupancy",
                "link": "/guide/biograph-docs/inpatient/bed-management"
              },
              {
                "text": "Transfers",
                "link": "/guide/biograph-docs/inpatient/transfers"
              },
              {
                "text": "Medication Orders",
                "link": "/guide/biograph-docs/inpatient/medication-orders"
              },
              {
                "text": "Medication Administration",
                "link": "/guide/biograph-docs/inpatient/medication-administration"
              },
              {
                "text": "Progress Notes",
                "link": "/guide/biograph-docs/inpatient/progress-notes"
              },
              {
                "text": "Treatment Counselling",
                "link": "/guide/biograph-docs/inpatient/treatment-counselling"
              },
              {
                "text": "Discharge Planning",
                "link": "/guide/biograph-docs/inpatient/discharge-planning"
              },
              {
                "text": "Discharge Summary",
                "link": "/guide/biograph-docs/inpatient/discharge-summary"
              }
            ]
          },
          {
            "text": "Rehabilitation",
            "collapsed": true,
            "items": [
              {
                "text": "Exercise Types",
                "link": "/guide/biograph-docs/specialized/exercise-types"
              },
              {
                "text": "Therapy Types",
                "link": "/guide/biograph-docs/specialized/therapy-types"
              },
              {
                "text": "Therapy Plans",
                "link": "/guide/biograph-docs/specialized/therapy-plans"
              },
              {
                "text": "Therapy Sessions",
                "link": "/guide/biograph-docs/specialized/therapy-sessions"
              },
              {
                "text": "Patient Assessments",
                "link": "/guide/biograph-docs/specialized/patient-assessments"
              }
            ]
          },
          {
            "text": "Pharmacy & Medication",
            "collapsed": true,
            "items": [
              {
                "text": "Medication Catalog",
                "link": "/guide/biograph-docs/specialized/medication-catalog"
              },
              {
                "text": "Prescription Processing",
                "link": "/guide/biograph-docs/specialized/prescription-processing"
              },
              {
                "text": "Stock Integration",
                "link": "/guide/biograph-docs/specialized/stock-integration"
              },
              {
                "text": "Medication Requests",
                "link": "/guide/biograph-docs/specialized/medication-requests"
              }
            ]
          },
          {
            "text": "Billing & Finance",
            "collapsed": true,
            "items": [
              {
                "text": "Service Item Mapping",
                "link": "/guide/biograph-docs/billing-insurance/service-items"
              },
              {
                "text": "Patient Billing",
                "link": "/guide/biograph-docs/billing-insurance/patient-billing"
              },
              {
                "text": "Package Billing",
                "link": "/guide/biograph-docs/billing-insurance/package-billing"
              },
              {
                "text": "Invoice Workflow",
                "link": "/guide/biograph-docs/billing-insurance/invoice-workflow"
              },
              {
                "text": "Payment Processing",
                "link": "/guide/biograph-docs/billing-insurance/payments"
              },
              {
                "text": "Financial Reports",
                "link": "/guide/biograph-docs/billing-insurance/financial-reports"
              }
            ]
          },
          {
            "text": "Insurance",
            "collapsed": true,
            "items": [
              {
                "text": "Payor Setup",
                "link": "/guide/biograph-docs/billing-insurance/insurance-payor"
              },
              {
                "text": "Contracts",
                "link": "/guide/biograph-docs/billing-insurance/insurance-contracts"
              },
              {
                "text": "Eligibility & Coverage",
                "link": "/guide/biograph-docs/billing-insurance/insurance-eligibility"
              },
              {
                "text": "Patient Policies",
                "link": "/guide/biograph-docs/billing-insurance/patient-policies"
              },
              {
                "text": "Coverage Creation",
                "link": "/guide/biograph-docs/billing-insurance/coverage-creation"
              },
              {
                "text": "Claim Workflow",
                "link": "/guide/biograph-docs/billing-insurance/claim-workflow"
              }
            ]
          },
          {
            "text": "Reports & Analytics",
            "collapsed": true,
            "items": [
              {
                "text": "Clinical Reports",
                "link": "/guide/biograph-docs/analytics-regional/clinical-reports"
              },
              {
                "text": "Operational Reports",
                "link": "/guide/biograph-docs/analytics-regional/operational-reports"
              },
              {
                "text": "Dashboards & KPIs",
                "link": "/guide/biograph-docs/analytics-regional/dashboards"
              }
            ]
          },
          {
            "text": "Regional (India)",
            "collapsed": true,
            "items": [
              {
                "text": "ABDM Integration",
                "link": "/guide/biograph-docs/analytics-regional/abdm"
              }
            ]
          }
        ]
      },
      {
        "text": "Getting Started",
        "items": [
          {
            "text": "Introduction",
            "link": "/guide/"
          },
          {
            "text": "Demo Sites",
            "link": "/guide/demo-sites"
          }
        ]
      }
    ]
  }
}

Page Data

{
  "title": "Runtime API Examples",
  "description": "",
  "frontmatter": {
    "outline": "deep"
  },
  "headers": [],
  "relativePath": "api-examples.md",
  "filePath": "api-examples.md"
}

Page Frontmatter

{
  "outline": "deep"
}

More

Check out the documentation for the full list of runtime APIs.