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
Search Started
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
| Variant | What it is |
|---|---|
| suggested | AI match with confidence. |
| paging | Previous 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
| Prop | Type | Default | Description |
|---|---|---|---|
from * | string | — | Sender line shown at the top of the page ("From: Lakeview Heart (312) 555-0188"); required |
pages * | number | — | Number of pages; required |
patients | ComboboxOption[] | [] | Combobox options for the patient search |
patientQuery | string | none | Initial patient search text |
ai | FaxAISuggestion | none | {text, confidence} |
page | number | undefined (uncontrolled) | Controlled current page (1-based) |
defaultPage | number | 1 | Initial page (uncontrolled) |
onPageChange | (page: number) => void | — | Called when the page changes |
documentTypes | string[] | ['Lab result', 'Referral', 'Prior auth response', 'Medical records', 'Other'] | Document type options |
routes | string[] | ['James Bell MD', 'Clinical Inbox', 'Billing'] | Route-to options |
onFile | (values: FaxIndexValues) => void | none | Called by File to Chart with the form values |
onJunk | () => void | none | Called 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>
| Kind | Name | Description |
|---|---|---|
| attribute | from | Sender line shown at the top of the page ("From: Lakeview Heart (312) 555-0188"); required |
| attribute | pages | Number of pages; required |
| property / JSON attribute | patients | Combobox options for the patient search; default [] |
| attribute | patient-query / patientQuery | Initial patient search text; default none |
| property / JSON attribute | ai | {text, confidence}; default none |
| attribute | page | Controlled current page (1-based); default undefined (uncontrolled) |
| attribute | default-page / defaultPage | Initial page (uncontrolled); default 1 |
| property / JSON attribute | document-types / documentTypes | Document type options; default ['Lab result', 'Referral', 'Prior auth response', 'Medical records', 'Other'] |
| property / JSON attribute | routes | Route-to options; default ['James Bell MD', 'Clinical Inbox', 'Billing'] |
| attribute | default-checked / defaultChecked | |
| property / JSON attribute | default-value / defaultValue | |
| attribute | auto-focus / autoFocus | |
| event | co-page-change | Called when the page changes (React: onPageChange) |
| event | co-file | Called by File to Chart with the form values; default none (React: onFile) |
| event | co-junk | Called by Mark as Junk; default none (React: onJunk) |