Procedure Record List

ProcedureRecordList is a list of a patient's procedures, 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

  • Appendectomy Completed
  • No known procedures
Show demo markup
<ul class="procedure-record-list" data-status="known" aria-label="Procedures"><li class="procedure-record-list-item" data-status="completed"><span class="procedure-record-list-item-procedure">Appendectomy</span> <span class="procedure-record-list-item-status">Completed</span> <time class="procedure-record-list-item-performed" datetime="2018-04-22">22 Apr 2018</time></li></ul><ul class="procedure-record-list" data-status="none-known" aria-label="No known procedures"><li class="procedure-record-list-status">No known procedures</li></ul>
Usage example
<ProcedureRecordList
  status="known"
  statusLabel="Procedures"
>
  <ProcedureRecordListItem
    procedure="Appendectomy"
    status="completed"
    statusLabel="Completed"
    performed="2018-04-22"
    performedLabel="22 Apr 2018"
  />
</ProcedureRecordList>

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

<ProcedureRecordList>
  <!-- content -->
</ProcedureRecordList>

Usage

<ProcedureRecordList
  status="known"
  statusLabel="Procedures"
>
  <ProcedureRecordListItem
    procedure="Appendectomy"
    status="completed"
    statusLabel="Completed"
    performed="2018-04-22"
    performedLabel="22 Apr 2018"
  />
</ProcedureRecordList>

<ProcedureRecordList
  status="none-known"
  statusLabel="No known procedures"
/>

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
  • children: slot (optional) — procedure-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 procedures, 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.
  • For another part of the record, use its own record list, or record-list.

Headless

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

Styles

.procedure-record-list, .procedure-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="procedure-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.procedure-record-list-status, so the list is never blank
  • Holds procedure-record-list-item items when the status is known
  • A missing status or statusLabel raises a development warning (Svelte, React, Vue, Angular)

Related components

  • procedure-record-list-item — one procedure in a procedure record list, with its status and when it was performed
  • 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: procedure-record-list
  • PascalCase: ProcedureRecordList
  • Description: a list of a patient's procedures, 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: .procedure-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
  • children: slot (optional) — procedure-record-list-item items
  • ...restProps: any — additional HTML attributes spread onto the root

Markdown

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