Immunization Record List Item

ImmunizationRecordListItem is one immunization in an immunization record list, with vaccine, date, dose and status. It renders as a <li>. Every word is the consumer's.

Status: experimental — new, implemented and unit-tested in every headless library; not yet exercised in a composed flow.

Example

  • MMR vaccine Dose 2 of 2 Given AB1234
Show demo markup
<ul class="immunization-record-list" data-status="known" aria-label="Immunizations"><li class="immunization-record-list-item" data-status="completed"><span class="immunization-record-list-item-vaccine">MMR vaccine</span> <time class="immunization-record-list-item-occurrence" datetime="2025-09-12">12 Sep 2025</time> <span class="immunization-record-list-item-dose-number">Dose 2 of 2</span> <span class="immunization-record-list-item-status">Given</span> <span class="immunization-record-list-item-lot-number">AB1234</span></li></ul>
Usage example
<ImmunizationRecordListItem
  vaccine="MMR vaccine"
  occurrence="2025-09-12"
  occurrenceLabel="12 Sep 2025"
  doseNumberLabel="Dose 2 of 2"
  status="completed"
  statusLabel="Given"
  lotNumber="AB1234"
/>
Show Svelte source
// In your Svelte component:
import ImmunizationRecordListItem from "lily-design-system-svelte-headless/components/ImmunizationRecordListItem/ImmunizationRecordListItem.svelte";

<ImmunizationRecordListItem>
  <!-- content -->
</ImmunizationRecordListItem>

Usage

<ImmunizationRecordListItem
  vaccine="MMR vaccine"
  occurrence="2025-09-12"
  occurrenceLabel="12 Sep 2025"
  doseNumberLabel="Dose 2 of 2"
  status="completed"
  statusLabel="Given"
  lotNumber="AB1234"
/>

Props

  • subjectLabel: string (optional) -- whose record it is, when it is not the patient's ("Mother", "Fetus 1"); rendered first as -subject, so a relative's history is never read as the patient's
  • vaccine: string (required) — the vaccine given; never truncated
  • occurrence: string (optional) — when it was given, for <time datetime>
  • occurrenceLabel: string (optional) — that date as the consumer writes it; the <time> shows only when set
  • doseNumberLabel: string (optional) — the dose in words ("Dose 2 of 2")
  • status: "completed" | "entered-in-error" | "not-done" (optional) — FHIR Immunization status; rendered as data-status
  • statusLabel: string (optional; required when status is set) — the status in words
  • lotNumber: string (optional) — the vaccine's lot number
  • children: slot (optional) — anything else, such as a link to the full record
  • ...restProps: any — additional HTML attributes spread onto the root

Keyboard Interactions

None. This is not an interactive component.

ARIA

  • No ARIA beyond the native <li>; every status is text, never colour alone

When to Use

  • Use inside immunization-record-list for each entry.
  • Use when the entry's statuses and dates matter to the reader.

When Not to Use

  • Do not use outside a immunization-record-list.
  • Do not use for "none known" or "not recorded" — that is the list's status.

Headless

This headless component ships zero CSS and decides nothing visual. The consumer provides all styling targeting the .immunization-record-list-item class hook, and every word.

Styles

.immunization-record-list-item and its parts, and [data-status].

Testing

  • Each part renders, each status as text and as data-*, dates as <time datetime>
  • Only the given parts render
  • A status without words raises a development warning

Advice

  • Take every word from your own translation, including the status words; Lily ships none.
  • Map FHIR codes to these values in your code; Lily does not read FHIR resources.
  • Format dates with Intl.DateTimeFormat, with the month as text so they cannot be read two ways.

Implementation Notes

  • Renders <li class="immunization-record-list-item"> with parts -vaccine, -occurrence, -dose-number, -status, -lot-number
  • status (completed, entered-in-error, not-done) renders as data-status, and statusLabel as text; a status without words raises a development warning
  • -occurrence is a <time datetime>, shown only when its label is given
  • The vaccine is never truncated

Related components

  • immunization-record-list — a list of a patient's immunizations, whose status is never blank

References


Lily™ and Lily Design System™ are trademarks.

Canonical contract

Generated from this component's canonical metadata — the machine-checked source the implementations are held to.

Metadata

  • Component: immunization-record-list-item
  • PascalCase: ImmunizationRecordListItem
  • Description: one immunization in an immunization record list, with vaccine, date, dose and status
  • Status: experimental — new, implemented and unit-tested in every headless library; not yet exercised in a composed flow
  • HTML tag: <li>
  • CSS class: .immunization-record-list-item
  • Interactive: no

ARIA

  • No ARIA beyond the native <li>; every status is text, never colour alone

Keyboard

  • Not interactive

Props

  • subjectLabel: string (optional) -- whose record it is, when it is not the patient's ("Mother", "Fetus 1"); rendered first as -subject, so a relative's history is never read as the patient's
  • vaccine: string (required) — the vaccine given; never truncated
  • occurrence: string (optional) — when it was given, for <time datetime>
  • occurrenceLabel: string (optional) — that date as the consumer writes it; the <time> shows only when set
  • doseNumberLabel: string (optional) — the dose in words ("Dose 2 of 2")
  • status: "completed" | "entered-in-error" | "not-done" (optional) — FHIR Immunization status; rendered as data-status
  • statusLabel: string (optional; required when status is set) — the status in words
  • lotNumber: string (optional) — the vaccine's lot number
  • children: slot (optional) — anything else, such as a link to the full record
  • ...restProps: any — additional HTML attributes spread onto the root

Markdown

This page as Markdown, for people and AI tools: immunization-record-list-item.md