Skip to main content

FaxDocumentViewer

ComplexWork queues<co-fax-document-viewer>

FaxDocumentViewer shows an incoming fax page next to the indexing form: patient, document type, route, file or junk, with an AI match suggestion.

import { FaxDocumentViewer } from 'health-components';

Examples​

Suggested Match​

Storybook

Search Started​

Storybook

Usage​

<FaxDocumentViewer from="Quest Diagnostics" pages={3} patients={patients} ai={{ text: "...", confidence: "high" }} />

When to use​

  • Indexing faxes and scans to charts.

When not to use​

  • Sending faxes: a form.

Variants and states​

VariantWhat it is
suggestedAI match with confidence.
pagingPrevious and next page.

Accessibility​

  • Page image has a text label; pager buttons labelled.

Do and don't​

  • Do: A person confirms the patient match.
  • Don't: Auto-file on a name match.

Props​

PropTypeDefaultDescription
from *string—Sender line shown at the top of the page ("From: Lakeview Heart (312) 555-0188"); required
pages *number—Number of pages; required
patientsComboboxOption[][]Combobox options for the patient search
patientQuerystringnoneInitial patient search text
aiFaxAISuggestionnone{text, confidence}
pagenumberundefined (uncontrolled)Controlled current page (1-based)
defaultPagenumber1Initial page (uncontrolled)
onPageChange(page: number) => void—Called when the page changes
documentTypesstring[]['Lab result', 'Referral', 'Prior auth response', 'Medical records', 'Other']Document type options
routesstring[]['James Bell MD', 'Clinical Inbox', 'Billing']Route-to options
onFile(values: FaxIndexValues) => voidnoneCalled by File to Chart with the form values
onJunk() => voidnoneCalled by Mark as Junk

Also accepts native attributes, including defaultChecked, defaultValue, autoFocus, plus className and event handlers on the root element.

Angular, Vue and HTML​

Register the elements once (Angular guide), then use <co-fax-document-viewer>. Attributes take strings; arrays and objects are set as properties (Angular [prop], Vue :prop) or as JSON attributes. Callbacks are DOM events with the value in event.detail.

Angular template
<co-fax-document-viewer from="…" pages="…" [patients]="patients" (co-page-change)="onPageChange($event.detail)"></co-fax-document-viewer>
KindNameDescription
attributefromSender line shown at the top of the page ("From: Lakeview Heart (312) 555-0188"); required
attributepagesNumber of pages; required
property / JSON attributepatientsCombobox options for the patient search; default []
attributepatient-query / patientQueryInitial patient search text; default none
property / JSON attributeai{text, confidence}; default none
attributepageControlled current page (1-based); default undefined (uncontrolled)
attributedefault-page / defaultPageInitial page (uncontrolled); default 1
property / JSON attributedocument-types / documentTypesDocument type options; default ['Lab result', 'Referral', 'Prior auth response', 'Medical records', 'Other']
property / JSON attributeroutesRoute-to options; default ['James Bell MD', 'Clinical Inbox', 'Billing']
attributedefault-checked / defaultChecked
property / JSON attributedefault-value / defaultValue
attributeauto-focus / autoFocus
eventco-page-changeCalled when the page changes (React: onPageChange)
eventco-fileCalled by File to Chart with the form values; default none (React: onFile)
eventco-junkCalled by Mark as Junk; default none (React: onJunk)