# Patient Whiteboard card

> Canonical HTML: https://screenrig.ai/docs/cards/patient-whiteboard/

Supplied bedside care team, goals and daily plan at a glance.

Display one supplied bedside-board snapshot featuring care-team names, goals and a daily plan with completion states provided by staff. Hidden initially, the board removes patient details for cleared, future-dated, invalid, expired or over-age snapshots. Patient names appear only when enabled in the display setting. Primetime styling pairs a restrained entrance with quiet clipboard linework.

## Live card

This card is drawn in your browser by the same code the Players run, with sample data.

Category: Health. Tags: Healthcare, Schedules, Lobbies and reception.

## Layouts

This fullscreen card fills the whole screen in landscape or portrait and is not placed as a corner, chip, or strip.

Layouts: full. Forms: landscape, portrait.

[Card layouts, themes and publishing](/docs/cards/). [Browse the cards](/apps/#cards).

## Data and privacy

This card uses its configured properties and live card data.

Bedside patient information. The producer controls access and supplies one current episode snapshot; name display is off by default. Visibility is a display control, not an authorization decision.

## Properties

For theme, background, accent and position, see [Common properties](/docs/cards/#common-properties).

Set static properties in `params`. Bind `data` to a project card data key for live values; that document holds only dynamic properties. Without a data key, put the complete configuration in `params`. Nested rows describe the contents of their parent property.

### Static properties

| Name | Type | Default | Values and limits | Description |
| --- | --- | --- | --- | --- |
| `title` | string | `"Your care board"` | maxLength: `100` |  |
| `showPatientName` | boolean | `false` |  |  |
| `maxAgeHours` | integer | `12` | minimum: `1`; maximum: `72` |  |
| `staleMinutes` | integer | `60` | minimum: `1`; maximum: `1440` |  |

### Dynamic properties

| Name | Type | Default | Values and limits | Description |
| --- | --- | --- | --- | --- |
| `visibility` | string | `"hidden"` | `"hidden"`, `"bedside"` | Display setting only; upstream access control still governs patient data. |
| `board` | object, null | `null` | additionalProperties: `false` | One complete bedside-board snapshot for one episode. Clearing this value, hiding it, an invalid/future timestamp or its expiry removes displayed patient details. |
| `board.episodeKey` | string |  | minLength: `1`; maxLength: `100`; Required |  |
| `board.room` | string |  | maxLength: `80`; Required |  |
| `board.displayName` | string | `""` | maxLength: `100` |  |
| `board.updatedAt` | string |  | maxLength: `64`; Required |  |
| `board.expiresAt` | string |  | maxLength: `64`; Required |  |
| `board.note` | string | `""` | maxLength: `240` |  |
| `board.team` | array | `[]` | maxItems: `4` |  |
| `board.team[].role` | string |  | minLength: `1`; maxLength: `60`; Required |  |
| `board.team[].name` | string |  | minLength: `1`; maxLength: `100`; Required |  |
| `board.goals` | array | `[]` | maxItems: `4` |  |
| `board.plan` | array | `[]` | maxItems: `6` |  |
| `board.plan[].label` | string |  | minLength: `1`; maxLength: `160`; Required |  |
| `board.plan[].time` | string | `""` | maxLength: `40` |  |
| `board.plan[].status` | string | `"pending"` | `"pending"`, `"done"`, `"cancelled"` |  |

## Canvas example

Add this item to a playlist page’s `primitives`. [Publish the playlist and assign a screen](/docs/cards/#publish-a-card-canvas).

```json
{
  "id": "patient-whiteboard",
  "primitive": "card",
  "card": "patient-whiteboard",
  "major": 1,
  "params": {
    "theme": "neomustard"
  },
  "rect": {
    "x": 0,
    "y": 0,
    "width": 1920,
    "height": 1080
  },
  "layer": 0,
  "content_fit": "fill",
  "data": "example-key"
}
```

## Write live data

The canvas example binds its `data` field to `example-key`. That value is a data key: a name this canvas item chooses, not the name of the card. Give each canvas item its own key when items should show different data, or share one key when they should show the same data. Keys are scoped to the project, follow the K/V key grammar, and cannot start with `feed:`.

Create this document before showing the card, then replace it to update the screen without republishing. Writes to a key that live canvas items bind are checked against each bound card’s dynamic properties. Use the same project as the playlist.

Save the document as `card-data.json`. The CLI reads the document itself, with no wrapper:

```json
{
  "visibility": "hidden",
  "board": null
}
```

```console
screenrig card-data put example-key --file card-data.json
```

Or call the API directly. The API wraps the same document in a `document` field. An agent token already names its project, so no project header is sent; if you send `ScreenRig-Project`, it must match the token’s project. Supply your API authorization through the environment; see [API authentication](/docs/authentication/).

```console
curl --request PUT "https://api.screenrig.ai/api/card-data/example-key" \
  --header "Authorization: Bearer $SCREENRIG_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{"document":{"visibility":"hidden","board":null}}'
```