Skip to main content

ReferralCard

ComplexWork queues<co-referral-card>

ReferralCard summarizes an outgoing or incoming referral with status, reason, urgency, authorization and its status timeline.

import { ReferralCard } from 'health-components';

Examples​

With Timeline​

Storybook

Statuses​

Storybook

Usage​

<ReferralCard referral={ref} actions={<Button size="sm">Send Records</Button>} />

When to use​

  • Referral detail and queues.

When not to use​

  • Prior auth itself: PriorAuthTimeline.

Variants and states​

VariantWhat it is
statusesDraft, Sent, Received, Scheduled, Seen, Report Back, Declined, Needs Info.
timelineOptional history.

Accessibility​

  • Status word in a badge.

Do and don't​

  • Do: Close the loop: track Report Back.
  • Don't: Lose referrals after Sent.

Props​

PropTypeDefaultDescription
referral *ReferralData—{specialty, patient, to, status, reason, urgency, auth?, from, timeline?}; required
actionsReactNodenoneButtons under the card body
flatbooleanfalseBorder instead of shadow
paddingCardPadding'default''default' | 'compact' (10px) | 'none' (edge-to-edge tables)
footerReactNodenoneFooter content
asElementType'section'Root tag name

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-referral-card>. 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-referral-card default-checked auto-focus [referral]="referral"></co-referral-card>
KindNameDescription
property / JSON attributereferral{specialty, patient, to, status, reason, urgency, auth?, from, timeline?}; required
attributedefault-checked / defaultChecked
property / JSON attributedefault-value / defaultValue
attributeauto-focus / autoFocus
attributeflatBorder instead of shadow; default false
attributepadding'default' | 'compact' (10px) | 'none' (edge-to-edge tables); default 'default'
property / JSON attributeasRoot tag name; default 'section'
slotactionsButtons under the card body; default none Plain text also works as the `actions` attribute.
slotfooterFooter content; default none Plain text also works as the `footer` attribute.