abridge-hello-world
Create a minimal Abridge ambient AI clinical documentation example. Use when testing Abridge integration, verifying EHR connectivity, or learning how Abridge captures and structures clinical conversations. Trigger: "abridge hello world", "abridge example", "abridge quick start", "test abridge".
Best use case
abridge-hello-world is best used when you need a repeatable AI agent workflow instead of a one-off prompt.
Create a minimal Abridge ambient AI clinical documentation example. Use when testing Abridge integration, verifying EHR connectivity, or learning how Abridge captures and structures clinical conversations. Trigger: "abridge hello world", "abridge example", "abridge quick start", "test abridge".
Teams using abridge-hello-world should expect a more consistent output, faster repeated execution, less prompt rewriting.
When to use this skill
- You want a reusable workflow that can be run more than once with consistent structure.
When not to use this skill
- You only need a quick one-off answer and do not need a reusable workflow.
- You cannot install or maintain the underlying files, dependencies, or repository context.
Installation
Claude Code / Cursor / Codex
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/abridge-hello-world/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How abridge-hello-world Compares
| Feature / Agent | abridge-hello-world | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
Create a minimal Abridge ambient AI clinical documentation example. Use when testing Abridge integration, verifying EHR connectivity, or learning how Abridge captures and structures clinical conversations. Trigger: "abridge hello world", "abridge example", "abridge quick start", "test abridge".
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
Related Guides
Best AI Skills for Claude
Explore the best AI skills for Claude and Claude Code across coding, research, workflow automation, documentation, and agent operations.
AI Agents for Coding
Browse AI agent skills for coding, debugging, testing, refactoring, code review, and developer workflows across Claude, Cursor, and Codex.
ChatGPT vs Claude for Agent Skills
Compare ChatGPT and Claude for AI agent skills across coding, writing, research, and reusable workflow execution.
SKILL.md Source
# Abridge Hello World
## Overview
Minimal working example demonstrating Abridge's ambient clinical documentation. This creates a simulated encounter session, sends audio/transcript data, and receives a structured clinical note.
## Prerequisites
- Completed `abridge-install-auth` setup
- Abridge sandbox credentials configured
- Node.js 18+ with TypeScript
## Instructions
### Step 1: Create Project Structure
```bash
mkdir abridge-hello-world && cd abridge-hello-world
npm init -y
npm install axios dotenv typescript @types/node
npx tsc --init --target ES2022 --module NodeNext --moduleResolution NodeNext
```
### Step 2: Build the Encounter Session Client
```typescript
// src/encounter-session.ts
import axios, { AxiosInstance } from 'axios';
interface EncounterSession {
session_id: string;
patient_id: string;
provider_id: string;
encounter_type: 'outpatient' | 'inpatient' | 'emergency';
status: 'active' | 'processing' | 'completed';
created_at: string;
}
interface ClinicalNote {
note_id: string;
session_id: string;
sections: {
chief_complaint: string;
history_present_illness: string;
review_of_systems: string;
physical_exam: string;
assessment: string;
plan: string;
};
icd10_codes: Array<{ code: string; description: string }>;
cpt_codes: Array<{ code: string; description: string }>;
confidence_score: number;
source_citations: Array<{
section: string;
text: string;
audio_timestamp_start: number;
audio_timestamp_end: number;
}>;
}
class AbridgeClient {
private api: AxiosInstance;
constructor() {
this.api = axios.create({
baseURL: process.env.ABRIDGE_SANDBOX_URL || 'https://sandbox.api.abridge.com/v1',
headers: {
'Authorization': `Bearer ${process.env.ABRIDGE_CLIENT_SECRET}`,
'X-Org-Id': process.env.ABRIDGE_ORG_ID!,
'Content-Type': 'application/json',
},
timeout: 30000,
});
}
async createSession(
patientId: string,
providerId: string,
encounterType: EncounterSession['encounter_type'] = 'outpatient'
): Promise<EncounterSession> {
const { data } = await this.api.post('/sessions', {
patient_id: patientId,
provider_id: providerId,
encounter_type: encounterType,
specialty: 'internal_medicine',
language: 'en',
});
return data;
}
async submitTranscript(sessionId: string, transcript: string): Promise<void> {
await this.api.post(`/sessions/${sessionId}/transcript`, {
text: transcript,
format: 'plain_text',
});
}
async generateNote(sessionId: string): Promise<ClinicalNote> {
// Trigger note generation
await this.api.post(`/sessions/${sessionId}/generate`);
// Poll for completion (Abridge processes asynchronously)
let attempts = 0;
while (attempts < 30) {
const { data: session } = await this.api.get(`/sessions/${sessionId}`);
if (session.status === 'completed') {
const { data: note } = await this.api.get(`/sessions/${sessionId}/note`);
return note;
}
await new Promise(r => setTimeout(r, 2000));
attempts++;
}
throw new Error('Note generation timed out after 60s');
}
}
export { AbridgeClient, EncounterSession, ClinicalNote };
```
### Step 3: Run the Hello World Example
```typescript
// src/main.ts
import 'dotenv/config';
import { AbridgeClient } from './encounter-session';
// Sample clinical conversation transcript (de-identified)
const SAMPLE_TRANSCRIPT = `
Doctor: Good morning, what brings you in today?
Patient: I've been having this persistent cough for about two weeks now.
Doctor: Is it a dry cough or are you producing any sputum?
Patient: It's mostly dry, but sometimes I cough up a little clear mucus.
Doctor: Any fever, chills, or shortness of breath?
Patient: No fever, but I do feel a little short of breath when I climb stairs.
Doctor: Are you a smoker?
Patient: No, I quit about five years ago. I smoked for about ten years before that.
Doctor: Let me listen to your lungs. Take a deep breath... Okay, I hear some mild
wheezing in both lung fields. Your oxygen saturation is 97%.
Doctor: I think this is likely a post-viral cough, possibly with some mild reactive
airway disease given your smoking history. I'd like to start you on an inhaler
and have you come back in two weeks. If the cough persists, we'll get a chest X-ray.
Patient: Sounds good, thank you.
`;
async function main() {
const client = new AbridgeClient();
// 1. Create encounter session
console.log('Creating encounter session...');
const session = await client.createSession('patient_demo_001', 'provider_demo_001');
console.log(`Session created: ${session.session_id}`);
// 2. Submit transcript
console.log('Submitting transcript...');
await client.submitTranscript(session.session_id, SAMPLE_TRANSCRIPT);
console.log('Transcript submitted');
// 3. Generate clinical note
console.log('Generating clinical note (this may take 10-30 seconds)...');
const note = await client.generateNote(session.session_id);
console.log('\n=== Generated Clinical Note ===');
console.log(`Chief Complaint: ${note.sections.chief_complaint}`);
console.log(`Assessment: ${note.sections.assessment}`);
console.log(`Plan: ${note.sections.plan}`);
console.log(`\nICD-10 Codes: ${note.icd10_codes.map(c => c.code).join(', ')}`);
console.log(`Confidence: ${(note.confidence_score * 100).toFixed(1)}%`);
console.log(`Source Citations: ${note.source_citations.length} segments linked`);
}
main().catch(console.error);
```
## Output
- Encounter session created in Abridge sandbox
- Transcript processed through Abridge's ambient AI engine
- Structured SOAP note with ICD-10/CPT codes
- Source citations mapping AI output to conversation segments
## Error Handling
| Error | Cause | Solution |
|-------|-------|----------|
| `401 Unauthorized` | Invalid sandbox credentials | Re-check `.env.local` credentials |
| `422 Invalid specialty` | Unsupported specialty code | Use supported values from API docs |
| Note generation timeout | Large/complex transcript | Increase polling timeout beyond 60s |
| Empty note sections | Transcript too short | Provide at least 30 seconds of conversation |
| Missing ICD codes | Ambiguous clinical content | Ensure transcript includes clear diagnoses |
## Resources
- [Abridge Product Overview](https://www.abridge.com/product)
- [Abridge AI Technology](https://www.abridge.com/ai)
- [HL7 FHIR Clinical Notes](https://hl7.org/fhir/clinicalnotes.html)
## Next Steps
Proceed to `abridge-local-dev-loop` for development workflow with live audio capture.Related Skills
workhuman-hello-world
Workhuman hello world for employee recognition and rewards API. Use when integrating Workhuman Social Recognition, or building recognition workflows with HRIS systems. Trigger: "workhuman hello world".
wispr-hello-world
Wispr Flow hello world for voice-to-text API integration. Use when integrating Wispr Flow dictation, WebSocket streaming, or building voice-powered applications. Trigger: "wispr hello world".
windsurf-hello-world
Create your first Windsurf Cascade interaction and Supercomplete experience. Use when starting with Windsurf, testing your setup, or learning basic Cascade and Supercomplete workflows. Trigger with phrases like "windsurf hello world", "windsurf example", "windsurf quick start", "first windsurf project", "try windsurf".
webflow-hello-world
Create a minimal working Webflow Data API v2 example. Use when starting a new Webflow integration, testing your setup, or learning basic Webflow API patterns — list sites, read CMS collections, create items. Trigger with phrases like "webflow hello world", "webflow example", "webflow quick start", "simple webflow code", "first webflow API call".
vercel-hello-world
Create a minimal working Vercel deployment with a serverless API route. Use when starting a new Vercel project, testing your setup, or learning basic Vercel deployment and API route patterns. Trigger with phrases like "vercel hello world", "vercel example", "vercel quick start", "simple vercel project", "first vercel deploy".
veeva-hello-world
Veeva Vault hello world with REST API and VQL. Use when integrating with Veeva Vault for life sciences document management. Trigger: "veeva hello world".
vastai-hello-world
Rent your first GPU instance on Vast.ai and run a workload. Use when starting a new Vast.ai integration, testing your setup, or learning basic Vast.ai GPU rental patterns. Trigger with phrases like "vastai hello world", "vastai example", "vastai quick start", "rent first gpu", "vastai first instance".
twinmind-hello-world
Create your first TwinMind meeting transcription and AI summary. Use when starting with TwinMind, testing your setup, or learning basic transcription and summary patterns. Trigger with phrases like "twinmind hello world", "first twinmind meeting", "twinmind quick start", "test twinmind transcription".
together-hello-world
Run inference with Together AI -- chat completions, streaming, and model selection. Use when testing open-source models, comparing model performance, or learning the Together AI API. Trigger: "together hello world, together AI example, run llama".
techsmith-hello-world
Capture a screenshot with Snagit COM API and produce a Camtasia video. Use when automating screen captures, batch-processing recordings, or building documentation pipelines with TechSmith tools. Trigger: "techsmith hello world, snagit capture, camtasia render".
supabase-hello-world
Run your first Supabase query — insert a row and read it back. Use when starting a new Supabase project, verifying your connection works, or learning the basic insert-then-select pattern with @supabase/supabase-js. Trigger with phrases like "supabase hello world", "first supabase query", "supabase quick start", "test supabase connection", "supabase insert and select".
stackblitz-hello-world
Boot a WebContainer, mount files, install npm packages, and run a dev server in the browser. Use when learning WebContainers, building browser-based IDEs, or running Node.js without a backend server. Trigger: "stackblitz hello world", "webcontainer example", "run node in browser".