TypeScript SDK Reference / GetHealthResult

Interface: GetHealthResult

The result of the getHealth function call, providing the current status of the vital sign scanning process. This interface is returned by each call to getHealth() and contains information about the scan progress, timing, and final results when available.

See

getHealth

Extended by

• ScanResult

Properties

error?

optional error: any

Error that occurred during scanning, if any (reserved for future use).

---

health?

optional health: Health

The final health analysis results, available when scanning is complete.

---

message?

optional message: string

Warning message about the scan (reserved for future use).

---

remainingTime

remainingTime: number

Time remaining in the current stage in seconds.

---

stage

stage: GetHealthStage

The current stage of the scanning process.

---

totalTime

totalTime: number | undefined

Total duration of the current stage in seconds, undefined if not known.