Patient Information

Heidi allows you to provide patient information for the current patient. When providing patient information as params to Heidi.open() or Heidi.setPatient(), you should use this format:

Please note, all fields are optional however providing them will add more contextual information when generating notes

PatientInfo

At runtime, gender values are parsed case-insensitively and trimmed; we recommend using lowercase literals to satisfy TypeScript.

TypeScript Interface

interface PatientInfo {
  id: string;
  name: string;
  gender?: "male" | "female" | "other" | "unknown";
  dob?: string;
}