Record List

RecordList is a list of records from one section of a patient's record, whose status is never blank. It renders as a <ul>. 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

  • Blood pressure 128/82 mmHg Final
  • No vital signs recorded
Show demo markup
<ul class="record-list" data-status="known" aria-label="Vital signs"><li class="record-list-item" data-status="final">Blood pressure 128/82 mmHg <span class="record-list-item-status">Final</span> <time class="record-list-item-updated" datetime="2026-11-03">Updated 3 Nov 2026</time></li></ul><ul class="record-list" data-status="none-known" aria-label="No vital signs recorded"><li class="record-list-status">No vital signs recorded</li></ul>
Usage example
<RecordList
  status="known"
  statusLabel="Vital signs"
>
  <RecordListItem
    status="final"
    statusLabel="Final"
    updated="2026-11-03"
    updatedLabel="Updated 3 Nov 2026"
    >Blood pressure 128/82 mmHg</RecordListItem
  >
</RecordList>

<RecordList
  status="none-known"
  statusLabel="No vital signs recorded"
/>
Show Svelte source
// In your Svelte component:
import RecordList from "lily-design-system-svelte-headless/components/RecordList/RecordList.svelte";

<RecordList>
  <!-- content -->
</RecordList>

Usage

<RecordList
  status="known"
  statusLabel="Vital signs"
>
  <RecordListItem
    status="final"
    statusLabel="Final"
    updated="2026-11-03"
    updatedLabel="Updated 3 Nov 2026"
    >Blood pressure 128/82 mmHg</RecordListItem
  >
</RecordList>

<RecordList
  status="none-known"
  statusLabel="No vital signs recorded"
/>

Props

  • status: "known" | "none-known" | "not-recorded" | "unavailable" | "omitted" | "not-applicable" (required) — rendered as data-status
  • statusLabel: string (required) — the status in words; names the list, and is its one item unless status is known
  • label: string (optional) — the accessible name, when it should differ from statusLabel
  • coverageLabel: string (optional) — what the list is a view of, in the consumer's words: its window and order, what it leaves out and why, which sources did not answer. Rendered first, as <li class="record-list-coverage"> (spec/lessons/zoblocks)
  • children: slot (optional) — record-list-item items
  • ...restProps: any — additional HTML attributes spread onto the root

Keyboard Interactions

None. This is not an interactive component.

ARIA

  • A <ul> named by aria-label; the status is text, never an icon or a colour alone

When to Use

  • Use for a patient's records, wherever a missing list could be misread.
  • Use with none-known, not-recorded, unavailable or omitted when there is nothing to list: each is a different fact.

When Not to Use

  • Do not leave the list empty for "none": set status instead.
  • Do not use for a list that is not part of a patient's record — use list or summary-list.

Headless

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

Styles

.record-list, .record-list-status and [data-status].

Testing

  • Each of the five statuses renders its consumer text; known renders only its items
  • label overrides the accessible name
  • A missing status 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 <ul class="record-list"> named by aria-label (label, else statusLabel)
  • status is required and renders as data-status: known, none-known, not-recorded, unavailable, omitted, not-applicable
  • For any status but known, statusLabel is the list's one item, li.record-list-status, so the list is never blank
  • Holds record-list-item items when the status is known
  • A missing status or statusLabel raises a development warning (Svelte, React, Vue, Angular)

Related components

  • record-list-item — one record in a record list, with its status and last update around the consumer's content
  • record-list and the other record lists — the same status contract for each part of a record

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: record-list
  • PascalCase: RecordList
  • Description: a list of records from one section of a patient's record, whose status is never blank
  • Status: experimental — new, implemented and unit-tested in every headless library; not yet exercised in a composed flow
  • HTML tag: <ul>
  • CSS class: .record-list
  • Interactive: no

ARIA

  • A <ul> named by aria-label; the status is text, never an icon or a colour alone

Keyboard

  • Not interactive

Props

  • status: "known" | "none-known" | "not-recorded" | "unavailable" | "omitted" | "not-applicable" (required) — rendered as data-status
  • statusLabel: string (required) — the status in words; names the list, and is its one item unless status is known
  • label: string (optional) — the accessible name, when it should differ from statusLabel
  • coverageLabel: string (optional) — what the list is a view of (window, order, what is left out, sources that did not answer); rendered first, as <li class="record-list-coverage">
  • children: slot (optional) — record-list-item items
  • ...restProps: any — additional HTML attributes spread onto the root

Markdown

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