{ "schemaVersion": 1, "packageVersion": "1.99.0", "components": [ { "kind": "component", "id": "accordion", "capabilities": [ "expand", "select_single", "select_multiple" ], "state": [ { "name": "openItems", "type": "string[]", "description": "Ids (values) of currently-expanded items. Single-mode accordions return an array with 0 or 1 entries.", "descriptionKey": "ui.agent.accordion.state.openItems" } ], "actions": [ { "name": "expand", "safety": "read", "argsType": "{ itemId: string }", "argsSchema": { "type": "object", "properties": { "itemId": { "type": "string" } }, "required": [ "itemId" ] }, "idempotent": true, "examples": [ { "args": { "itemId": "billing" }, "note": "Expand the \"billing\" panel." } ], "description": "Expand the item with the given value.", "descriptionKey": "ui.agent.accordion.actions.expand" }, { "name": "collapse", "safety": "read", "argsType": "{ itemId: string }", "argsSchema": { "type": "object", "properties": { "itemId": { "type": "string" } }, "required": [ "itemId" ] }, "idempotent": true, "description": "Collapse the item with the given value.", "descriptionKey": "ui.agent.accordion.actions.collapse" }, { "name": "clear", "safety": "read", "idempotent": true, "description": "Collapse all items. Only meaningful for multi-mode accordions; single-mode equivalent to collapsing the active item.", "descriptionKey": "ui.agent.accordion.actions.clear" } ], "domHooks": { "root": { "attr": "data-component", "value": "accordion" }, "instanceId": { "attr": "data-component-id", "sourceProp": "id", "description": "Sourced from the id prop." }, "item": { "attr": "data-item-id", "description": "Each Accordion.Item emits its value as data-item-id." } } }, { "kind": "component", "id": "address-autocomplete", "capabilities": [ "select_single", "filter", "open", "close" ], "state": [ { "name": "value", "type": "string", "description": "Current free-text value of the address input.", "descriptionKey": "ui.agent.addressAutocomplete.state.value" }, { "name": "query", "type": "string", "description": "Current query driving the suggestion listbox.", "descriptionKey": "ui.agent.addressAutocomplete.state.query" }, { "name": "isOpen", "type": "boolean", "description": "True when the suggestion listbox is visible.", "descriptionKey": "ui.agent.addressAutocomplete.state.isOpen" } ], "actions": [ { "name": "set_value", "safety": "write", "argsType": "{ value: string }", "argsSchema": { "type": "object", "properties": { "value": { "type": "string", "description": "Text to place in the input (also runs a fetch)." } }, "required": [ "value" ] }, "idempotent": true, "openWorld": true, "examples": [ { "args": { "value": "Via Roma 12" }, "note": "Seed a partial address." } ], "description": "Set the input text programmatically; opens and refreshes the suggestion list (issues an external address-lookup fetch).", "descriptionKey": "ui.agent.addressAutocomplete.actions.setValue" }, { "name": "apply_filter", "safety": "read", "argsType": "{ query: string }", "argsSchema": { "type": "object", "properties": { "query": { "type": "string", "description": "Query text to filter the address suggestions." } }, "required": [ "query" ] }, "idempotent": true, "openWorld": true, "description": "Set the query text, which refreshes the suggestion list via an external address-lookup fetch.", "descriptionKey": "ui.agent.addressAutocomplete.actions.applyFilter" }, { "name": "clear", "safety": "write", "idempotent": true, "description": "Clear the typed text and dismiss the suggestion list.", "descriptionKey": "ui.agent.addressAutocomplete.actions.clear" }, { "name": "open", "safety": "read", "idempotent": true, "description": "Open the suggestion listbox.", "descriptionKey": "ui.agent.addressAutocomplete.actions.open" }, { "name": "close", "safety": "read", "idempotent": true, "description": "Close the suggestion listbox.", "descriptionKey": "ui.agent.addressAutocomplete.actions.close" } ], "domHooks": { "root": { "attr": "data-component", "value": "address-autocomplete", "description": "Marks the AddressAutocomplete wrapper." }, "instanceId": { "attr": "data-component-id", "sourceProp": "id", "description": "Sourced from the id prop. Required to address a specific field from the agent." } } }, { "kind": "component", "id": "address-fields", "capabilities": [ "set_value" ], "state": [ { "name": "value", "type": "object", "description": "The current structured address: { street, city, postcode, province, country, formatted }.", "descriptionKey": "ui.agent.addressFields.state.value" } ], "actions": [ { "name": "set_value", "safety": "write", "argsType": "{ value: StructuredAddress }", "argsSchema": { "type": "object", "properties": { "value": { "type": "object", "properties": { "street": { "type": "string" }, "city": { "type": "string" }, "postcode": { "type": "string" }, "province": { "type": "string", "description": "UPPERCASED province code." }, "country": { "type": "string", "description": "ISO alpha-2, lowercased." }, "formatted": { "type": "string" } } } }, "required": [ "value" ] }, "idempotent": true, "description": "Replace the entire address.", "descriptionKey": "ui.agent.addressFields.actions.setValue" }, { "name": "set_field", "safety": "write", "argsType": "{ field: 'street' | 'city' | 'postcode' | 'province' | 'country'; value: string }", "argsSchema": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "street", "city", "postcode", "province", "country" ] }, "value": { "type": "string" } }, "required": [ "field", "value" ] }, "idempotent": true, "examples": [ { "args": { "field": "country", "value": "it" }, "note": "Set the country to Italy." } ], "description": "Set a single address field. Setting `country` also clears the now-stale province.", "descriptionKey": "ui.agent.addressFields.actions.setField" } ], "domHooks": { "root": { "attr": "data-component", "value": "address-fields" }, "instanceId": { "attr": "data-component-id", "sourceProp": "id", "description": "Sourced from the id prop." } } }, { "kind": "component", "id": "agenda-card", "capabilities": [ "pick" ], "state": [], "actions": [], "domHooks": { "root": { "attr": "data-component", "value": "agenda-card", "description": "Marks the element as a kit AgendaCard. The card root also emits data-component-id sourced from item.id and data-status with the appointment lifecycle." }, "instanceId": { "attr": "data-component-id", "sourceProp": "item.id", "description": "Sourced from item.id — the stable appointment identifier." } } }, { "kind": "component", "id": "agenda-tray", "capabilities": [ "pick" ], "state": [ { "name": "items", "type": "Array<{ id: string; status: string }>", "description": "Currently-displayed appointments. Ids + status only — never patient identity.", "descriptionKey": "ui.agent.agendaTray.state.items" } ], "actions": [ { "name": "select_item", "safety": "read", "argsType": "{ id: string }", "argsSchema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] }, "examples": [ { "args": { "id": "appt-204" }, "note": "Open appointment appt-204." } ], "description": "Activate the appointment with the given id.", "descriptionKey": "ui.agent.agendaTray.actions.selectItem" } ], "domHooks": { "root": { "attr": "data-component", "value": "agenda-tray", "description": "Marks the AgendaTray wrapper." }, "instanceId": { "attr": "data-component-id", "sourceProp": "id", "description": "Sourced from the id prop. Required to address a specific tray from the agent." }, "item": { "attr": "data-appointment-id", "description": "Stable appointment id emitted on each rendered AgendaCard inside the tray." } } }, { "kind": "component", "id": "ai-consent-banner", "capabilities": [], "state": [ { "name": "consentState", "type": "'granted' | 'required' | 'pending'", "description": "Current consent state. Structural only — never the grantee identity.", "descriptionKey": "ui.agent.aiConsentBanner.state.consentState" }, { "name": "armed", "type": "boolean", "description": "Whether the consent confirmation checkbox is ticked (required state only).", "descriptionKey": "ui.agent.aiConsentBanner.state.armed" } ], "actions": [], "domHooks": { "root": { "attr": "data-component", "value": "ai-consent-banner", "description": "Marks the AiConsentBanner root region." }, "instanceId": { "attr": "data-component-id", "sourceProp": "id", "description": "Sourced from the id prop. Required to address a specific banner from the agent." } } }, { "kind": "component", "id": "ai-credits-exhausted-notice", "capabilities": [], "state": [], "actions": [], "domHooks": { "root": { "attr": "data-component", "value": "ai-credits-exhausted-notice", "description": "Marks the out-of-credits notice. Each next-step button carries `data-credits-action=\"buy|upgrade|support|costs\"`." } } }, { "kind": "component", "id": "ai-credits-notice", "capabilities": [], "state": [], "actions": [], "domHooks": { "root": { "attr": "data-component", "value": "ai-credits-notice", "description": "Marks the element as a kit AiCreditsNotice card body. Carries a sibling `data-mode=\"included|bundles\"` attribute for which notice is showing." } } }, { "kind": "component", "id": "ai-credits-warning", "capabilities": [], "state": [], "actions": [], "domHooks": { "root": { "attr": "data-component", "value": "ai-credits-warning", "description": "Marks the quiet credit lines. Each line carries `data-credits-line=\"low|expiring|exhausted\"`." } } }, { "kind": "component", "id": "ai-prompt-input", "capabilities": [ "edit_inline", "submit" ], "state": [ { "name": "value", "type": "string", "description": "Current text in the composer (no PHI processing).", "descriptionKey": "ui.agent.aiPromptInput.state.value" }, { "name": "isEmpty", "type": "boolean", "description": "True when the composer has no text and no attachments.", "descriptionKey": "ui.agent.aiPromptInput.state.isEmpty" }, { "name": "isSubmitting", "type": "boolean", "description": "True while an onSubmit invocation is in flight (best-effort).", "descriptionKey": "ui.agent.aiPromptInput.state.isSubmitting" } ], "actions": [ { "name": "set_value", "safety": "write", "argsType": "{ value: string }", "argsSchema": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] }, "idempotent": true, "examples": [ { "args": { "value": "Summarise the last visit" }, "note": "Replace composer text." } ], "description": "Replace the composer text with the given value.", "descriptionKey": "ui.agent.aiPromptInput.actions.setValue" }, { "name": "clear", "safety": "destructive", "idempotent": true, "description": "Clear text and attachments. Irreversible from the same UI.", "descriptionKey": "ui.agent.aiPromptInput.actions.clear" }, { "name": "submit", "safety": "write", "openWorld": true, "description": "Submit the current composer state via onSubmit.", "descriptionKey": "ui.agent.aiPromptInput.actions.submit" }, { "name": "focus", "safety": "read", "description": "Move keyboard focus into the textarea.", "descriptionKey": "ui.agent.aiPromptInput.actions.focus" } ], "domHooks": { "root": { "attr": "data-component", "value": "ai-prompt-input", "description": "Marks the AIPromptInput wrapper." }, "instanceId": { "attr": "data-component-id", "sourceProp": "id", "description": "Sourced from the id prop; addresses a specific composer instance." } } }, { "kind": "component", "id": "alert", "capabilities": [ "dismiss" ], "state": [], "actions": [], "domHooks": { "root": { "attr": "data-component", "value": "alert", "description": "Marks the element as a kit Alert. The root also emits `data-state=\"open\" | \"closing\"` while the dismiss animation runs. Alerts inherit native `id` from props, which is what agents address them by. An alert with `dismissKey` that was dismissed in this browser is not rendered at all." } } }, { "kind": "component", "id": "anamnesis-card", "capabilities": [], "state": [], "actions": [], "domHooks": { "root": { "attr": "data-component", "value": "anamnesis-card", "description": "Marks the element as a kit AnamnesisCard. The root also emits data-has-flags when at least one answer is a clinical red-flag — a structural boolean only, never the underlying answer." }, "instanceId": { "attr": "data-component-id", "sourceProp": "id", "description": "Sourced from the id prop — the stable questionnaire identifier." } } }, { "kind": "component", "id": "anamnesis-summary-card", "capabilities": [], "state": [ { "name": "summary", "type": "{ id?: string; sectionCount: number; answerCount: number; highlightedCount: number; unansweredCount: number }", "description": "Structural summary of the anamnesis card — section, answer, highlighted and unanswered counts plus the consumer id. Never question labels or answer values.", "descriptionKey": "ui.agent.anamnesisSummaryCard.state.summary" } ], "actions": [], "domHooks": { "root": { "attr": "data-component", "value": "anamnesis-summary-card", "description": "Marks the AnamnesisSummaryCard root region." }, "instanceId": { "attr": "data-component-id", "sourceProp": "id", "description": "Sourced from the id prop." }, "item": { "attr": "data-answer-id", "description": "One per answer row (KeyValuePair); the value is the intake field key. Highlighted rows also carry data-highlighted." } } }, { "kind": "component", "id": "app-frame", "capabilities": [], "state": [], "actions": [], "domHooks": { "root": { "attr": "data-component", "value": "app-frame", "description": "Marks the AppFrame layout wrapper. Inner landmarks (Header, Sidebar, main) carry their own component hooks." } } }, { "kind": "component", "id": "appointment-card", "capabilities": [ "pick" ], "state": [], "actions": [], "domHooks": { "root": { "attr": "data-component", "value": "appointment-card", "description": "Marks the element as a kit AppointmentCard. The root also emits data-component-id sourced from item.id, data-state with the appointment lifecycle, and data-type with the delivery channel." }, "instanceId": { "attr": "data-component-id", "sourceProp": "item.id", "description": "Sourced from item.id — the stable appointment identifier." } } }, { "kind": "component", "id": "appointment-details-panel", "capabilities": [ "open", "close", "set_value" ], "state": [ { "name": "eventId", "type": "string | null", "description": "The occurrence on screen or being read, as the host identifies it. After a failed or refused read, the occurrence it was for when the host says so. Null when there is none, or the host did not say.", "descriptionKey": "ui.agent.appointmentDetailsPanel.state.eventId" }, { "name": "loadStatus", "type": "'loading' | 'ready' | 'error' | 'refused'", "description": "Where the read is: loading, ready, failed (with Retry) or refused. Actions need ready.", "descriptionKey": "ui.agent.appointmentDetailsPanel.state.loadStatus" }, { "name": "appointmentStatus", "type": "'confirmed' | 'waiting' | 'in_care' | 'done' | 'cancelled' | 'absent' | null", "description": "The appointment status as last saved here or read. Null when none is recorded or nothing is on screen.", "descriptionKey": "ui.agent.appointmentDetailsPanel.state.appointmentStatus" }, { "name": "allowedStatuses", "type": "string[]", "description": "The statuses set_status accepts now, in menu order. Empty when the status is read-only.", "descriptionKey": "ui.agent.appointmentDetailsPanel.state.allowedStatuses" }, { "name": "offeredActions", "type": "string[]", "description": "The footer actions on offer, as their data-action values (for example edit-appointment, delete-appointment), in footer order, including any folded into More.", "descriptionKey": "ui.agent.appointmentDetailsPanel.state.offeredActions" }, { "name": "historyOpen", "type": "boolean", "description": "Whether the History sub-view covers the details.", "descriptionKey": "ui.agent.appointmentDetailsPanel.state.historyOpen" }, { "name": "privacy", "type": "boolean", "description": "Whether privacy mode is on. The patient identity and personal fields are then masked on screen.", "descriptionKey": "ui.agent.appointmentDetailsPanel.state.privacy" } ], "actions": [ { "name": "open_history", "safety": "read", "idempotent": true, "openWorld": true, "errors": [ "No appointment is on screen, or History is not offered." ], "description": "Slide the appointment's history over the details, as its header button does; the host reads it then if it did not send it with the details. It lists who changed what, and when.", "descriptionKey": "ui.agent.appointmentDetailsPanel.actions.openHistory" }, { "name": "close_history", "safety": "read", "idempotent": true, "description": "Return from History to the details.", "descriptionKey": "ui.agent.appointmentDetailsPanel.actions.closeHistory" }, { "name": "set_status", "safety": "phi", "argsType": "{ status: string }", "argsSchema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "confirmed", "waiting", "in_care", "done", "cancelled", "absent" ] } }, "required": [ "status" ] }, "idempotent": true, "openWorld": true, "errors": [ "The status is read-only: no appointment on screen, no host save, readOnly, or no allowed statuses.", "The status is not in allowedStatuses.", "A status save is already in flight.", "The host refused the change. The previous status stays and the panel shows the message." ], "examples": [ { "args": { "status": "waiting" } } ], "description": "Save a new appointment status through the host, as the footer control does. Resolves once the host has saved it.", "descriptionKey": "ui.agent.appointmentDetailsPanel.actions.setStatus" }, { "name": "retry", "safety": "read", "openWorld": true, "errors": [ "Retry is not offered: the read has not failed or been refused as retryable, or the host offers no Retry." ], "description": "Ask the host to read the appointment again, after a failed read or a refusal it marked retryable.", "descriptionKey": "ui.agent.appointmentDetailsPanel.actions.retry" } ], "domHooks": { "root": { "attr": "data-component", "value": "appointment-details-panel", "description": "Marks the panel. It also carries data-event-id and data-status. Inside, cards carry data-card (patient, appointment, notes, treatments), footer actions data-action, and the History and description sub-views data-details-subview. An action in offeredActions with no data-action in the footer strip is folded into More: click the panel's [data-component=\"button-group\"] [data-component=\"icon-button\"][aria-haspopup=\"menu\"], and its menu item carries the same data-action." }, "instanceId": { "attr": "data-component-id", "sourceProp": "id", "description": "Sourced from the id prop, or generated." } } }, { "kind": "component", "id": "appointment-peek", "capabilities": [], "state": [], "actions": [], "domHooks": { "root": { "attr": "data-component", "value": "appointment-peek", "description": "Marks the element as a kit AppointmentPeek summary." } } }, { "kind": "component", "id": "appointment-timeline", "capabilities": [ "scroll", "pick" ], "state": [ { "name": "items", "type": "Array<{ id: string; state: string }>", "description": "Currently-rendered appointments. Ids + lifecycle state only — never patient identity.", "descriptionKey": "ui.agent.appointmentTimeline.state.items" } ], "actions": [ { "name": "select_item", "safety": "read", "argsType": "{ id: string }", "argsSchema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] }, "idempotent": true, "description": "Activate the appointment with the given id.", "descriptionKey": "ui.agent.appointmentTimeline.actions.selectItem" }, { "name": "jump_to_today", "safety": "read", "idempotent": true, "description": "Re-anchor the timeline scroll on today's appointments.", "descriptionKey": "ui.agent.appointmentTimeline.actions.jumpToToday" } ], "domHooks": { "root": { "attr": "data-component", "value": "appointment-timeline", "description": "Marks the AppointmentTimeline wrapper." }, "instanceId": { "attr": "data-component-id", "sourceProp": "id", "description": "Sourced from the id prop. Required to address a specific timeline from the agent." }, "item": { "attr": "data-appointment-id", "description": "Stable appointment id emitted on each rendered AppointmentCard inside the timeline." } } }, { "kind": "component", "id": "appointment-tray", "capabilities": [ "pick" ], "state": [ { "name": "items", "type": "Array<{ id: string; state: string }>", "description": "Currently-displayed appointments. Ids + lifecycle state only — never patient identity.", "descriptionKey": "ui.agent.appointmentTray.state.items" } ], "actions": [ { "name": "select_item", "safety": "read", "argsType": "{ id: string }", "argsSchema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] }, "idempotent": true, "description": "Activate the appointment with the given id.", "descriptionKey": "ui.agent.appointmentTray.actions.selectItem" } ], "domHooks": { "root": { "attr": "data-component", "value": "appointment-tray", "description": "Marks the AppointmentTray wrapper." }, "instanceId": { "attr": "data-component-id", "sourceProp": "id", "description": "Sourced from the id prop. Required to address a specific tray from the agent." }, "item": { "attr": "data-appointment-id", "description": "Stable appointment id emitted on each rendered AppointmentCard inside the tray." } } }, { "kind": "component", "id": "aspect-ratio", "capabilities": [], "state": [], "actions": [], "domHooks": { "root": { "attr": "data-component", "value": "aspect-ratio", "description": "Marks the element as a kit AspectRatio wrapper." } } }, { "kind": "component", "id": "audio-recorder", "capabilities": [ "capture", "submit" ], "state": [ { "name": "isRecording", "type": "boolean", "description": "True while actively capturing audio (not paused).", "descriptionKey": "ui.agent.audioRecorder.state.isRecording" }, { "name": "duration", "type": "number", "description": "Elapsed recording time in milliseconds (paused time excluded).", "descriptionKey": "ui.agent.audioRecorder.state.duration" }, { "name": "hasRecording", "type": "boolean", "description": "True when a completed recording is available for submission.", "descriptionKey": "ui.agent.audioRecorder.state.hasRecording" } ], "actions": [ { "name": "start_recording", "safety": "write", "returns": "void", "errors": [ "Microphone permission denied", "No audio input device" ], "description": "Request microphone permission and begin recording.", "descriptionKey": "ui.agent.audioRecorder.actions.startRecording" }, { "name": "stop_recording", "safety": "write", "description": "Stop the current recording and finalise the blob.", "descriptionKey": "ui.agent.audioRecorder.actions.stopRecording" }, { "name": "discard", "safety": "destructive", "idempotent": true, "description": "Cancel the recording. Irreversible — the captured audio is dropped.", "descriptionKey": "ui.agent.audioRecorder.actions.discard" }, { "name": "submit", "safety": "write", "description": "Stop the active recording, finalising it via onRecordingComplete.", "descriptionKey": "ui.agent.audioRecorder.actions.submit" } ], "domHooks": { "root": { "attr": "data-component", "value": "audio-recorder", "description": "Marks the AudioRecorder wrapper." }, "instanceId": { "attr": "data-component-id", "sourceProp": "id", "description": "Sourced from the id prop." } } }, { "kind": "component", "id": "audio-visualiser", "capabilities": [], "state": [], "actions": [], "domHooks": { "root": { "attr": "data-component", "value": "audio-visualiser", "description": "Marks the element as a kit AudioVisualiser canvas." } } }, { "kind": "component", "id": "autocomplete", "capabilities": [ "select_single", "filter", "open", "close" ], "state": [ { "name": "value", "type": "string | null", "description": "Currently-selected option value, or null when nothing is committed.", "descriptionKey": "ui.agent.autocomplete.state.value" }, { "name": "query", "type": "string", "description": "Current free-text query in the input.", "descriptionKey": "ui.agent.autocomplete.state.query" }, { "name": "isOpen", "type": "boolean", "description": "True when the suggestion popup is visible. Open with no suggestions to show reads false.", "descriptionKey": "ui.agent.autocomplete.state.isOpen" } ], "actions": [ { "name": "set_value", "safety": "write", "argsType": "{ value: string | null }", "argsSchema": { "type": "object", "properties": { "value": { "type": [ "string", "null" ] } }, "required": [ "value" ] }, "idempotent": true, "description": "Set the committed value programmatically.", "descriptionKey": "ui.agent.autocomplete.actions.setValue" }, { "name": "apply_filter", "safety": "read", "argsType": "{ query: string }", "argsSchema": { "type": "object", "properties": { "query": { "type": "string" } }, "required": [ "query" ] }, "idempotent": true, "description": "Set the input query, which filters the suggestion list.", "descriptionKey": "ui.agent.autocomplete.actions.applyFilter" }, { "name": "clear", "safety": "destructive", "idempotent": true, "description": "Clear the committed value and the query. Discards the typed input.", "descriptionKey": "ui.agent.autocomplete.actions.clear" }, { "name": "open", "safety": "read", "idempotent": true, "description": "Open the suggestion list.", "descriptionKey": "ui.agent.autocomplete.actions.open" }, { "name": "close", "safety": "read", "idempotent": true, "description": "Close the suggestion list.", "descriptionKey": "ui.agent.autocomplete.actions.close" } ], "domHooks": { "root": { "attr": "data-component", "value": "autocomplete" }, "instanceId": { "attr": "data-component-id", "sourceProp": "id", "description": "Sourced from the id prop." }, "item": { "attr": "data-option-id", "description": "Each suggestion emits its value as data-option-id." } } }, { "kind": "component", "id": "avatar", "capabilities": [], "state": [], "actions": [], "domHooks": { "root": { "attr": "data-component", "value": "avatar", "description": "Marks the element as a kit Avatar." } } }, { "kind": "component", "id": "badge", "capabilities": [], "state": [], "actions": [], "domHooks": { "root": { "attr": "data-component", "value": "badge", "description": "Marks the element as a kit Badge." } } }, { "kind": "component", "id": "benefit-card", "capabilities": [], "state": [], "actions": [], "domHooks": { "root": { "attr": "data-component", "value": "benefit-card", "description": "Marks the BenefitCard root. Presentational — no agent-driven state." } } }, { "kind": "component", "id": "bishop-score", "capabilities": [ "set_value" ], "state": [ { "name": "selection", "type": "Partial>", "description": "The five cervical-exam findings keyed by component (dilation, effacement, station, consistency, position). Each value is an enumerated option key, not free text.", "descriptionKey": "ui.agent.bishopScore.state.selection" }, { "name": "result", "type": "{ total: number, band: string } | null", "description": "Computed Bishop result — total (0–13) and favourability band (unfavourable / intermediate / favourable). Null until all five findings are set.", "descriptionKey": "ui.agent.bishopScore.state.result" } ], "actions": [ { "name": "set_value", "safety": "write", "argsType": "{ component: BishopComponent, value: string }", "argsSchema": { "type": "object", "properties": { "component": { "enum": [ "dilation", "effacement", "station", "consistency", "position" ], "description": "Which cervical-exam finding to set." }, "value": { "type": "string", "description": "Enumerated option key for that finding (e.g. dilation \"closed\" | \"1-2\" | \"3-4\" | \"5+\")." } }, "required": [ "component", "value" ] }, "idempotent": true, "examples": [ { "args": { "component": "dilation", "value": "3-4" }, "note": "Record cervical dilation of 3–4 cm (2 points)." } ], "description": "Set one cervical-exam finding to an enumerated option value. Unknown component/value pairs are ignored.", "descriptionKey": "ui.agent.bishopScore.actions.setValue" }, { "name": "reset", "safety": "write", "idempotent": true, "description": "Clear all five findings and the computed result.", "descriptionKey": "ui.agent.bishopScore.actions.reset" }, { "name": "get_result", "safety": "read", "returns": "{ total: number, band: string } | null", "returnsSchema": { "oneOf": [ { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0, "maximum": 13 }, "band": { "enum": [ "unfavourable", "intermediate", "favourable" ] } }, "required": [ "total", "band" ] }, { "type": "null" } ] }, "idempotent": true, "description": "Return the computed Bishop result, or null until all five findings are set.", "descriptionKey": "ui.agent.bishopScore.actions.getResult" } ], "domHooks": { "root": { "attr": "data-component", "value": "bishop-score", "description": "Marks the BishopScore calculator wrapper." }, "instanceId": { "attr": "data-component-id", "sourceProp": "id", "description": "Sourced from the id prop. Required to address a specific calculator instance." } } }, { "kind": "component", "id": "bmi-calculator", "capabilities": [ "set_value", "view_change" ], "state": [ { "name": "unitSystem", "type": "'metric' | 'imperial'", "description": "Active unit system the inputs are entered in.", "descriptionKey": "ui.agent.bmiCalculator.state.unitSystem" }, { "name": "inputs", "type": "{ heightCm: number | null, weightKg: number | null }", "description": "Canonical metric measurements regardless of the active unit system — height in centimetres and weight in kilograms, or null when unset.", "descriptionKey": "ui.agent.bmiCalculator.state.inputs" }, { "name": "result", "type": "{ bmi: number, category: string } | null", "description": "Computed BMI (kg/m²) and WHO category (underweight / normal / overweight / obese). Null until both height and weight are valid.", "descriptionKey": "ui.agent.bmiCalculator.state.result" } ], "actions": [ { "name": "set_value", "safety": "write", "argsType": "{ heightCm?: number | null, weightKg?: number | null }", "argsSchema": { "type": "object", "properties": { "heightCm": { "type": [ "number", "null" ], "description": "Height in centimetres (canonical metric).", "minimum": 0 }, "weightKg": { "type": [ "number", "null" ], "description": "Weight in kilograms (canonical metric).", "minimum": 0 } }, "additionalProperties": false }, "idempotent": true, "examples": [ { "args": { "heightCm": 175, "weightKg": 72 }, "note": "A 175 cm, 72 kg patient → BMI ~23.5 (normal)." } ], "description": "Set height (cm) and/or weight (kg) in canonical metric units. Omitted fields are left unchanged.", "descriptionKey": "ui.agent.bmiCalculator.actions.setValue" }, { "name": "set_unit_system", "safety": "write", "argsType": "{ unitSystem: 'metric' | 'imperial' }", "argsSchema": { "type": "object", "properties": { "unitSystem": { "enum": [ "metric", "imperial" ], "description": "Unit system to display the inputs in." } }, "required": [ "unitSystem" ] }, "idempotent": true, "description": "Switch the input unit system. Entered figures are preserved by conversion; the computed BMI is unchanged.", "descriptionKey": "ui.agent.bmiCalculator.actions.setUnitSystem" }, { "name": "reset", "safety": "write", "idempotent": true, "description": "Clear height and weight and the computed result.", "descriptionKey": "ui.agent.bmiCalculator.actions.reset" }, { "name": "get_result", "safety": "read", "returns": "{ bmi: number, category: string } | null", "returnsSchema": { "oneOf": [ { "type": "object", "properties": { "bmi": { "type": "number", "minimum": 0 }, "category": { "enum": [ "underweight", "normal", "overweight", "obese" ] } }, "required": [ "bmi", "category" ] }, { "type": "null" } ] }, "idempotent": true, "description": "Return the computed BMI + WHO category, or null until both inputs are valid.", "descriptionKey": "ui.agent.bmiCalculator.actions.getResult" } ], "domHooks": { "root": { "attr": "data-component", "value": "bmi-calculator", "description": "Marks the BmiCalculator wrapper." }, "instanceId": { "attr": "data-component-id", "sourceProp": "id", "description": "Sourced from the id prop. Required to address a specific calculator instance." } } }, { "kind": "component", "id": "booking", "capabilities": [ "navigate" ], "state": [ { "name": "variant", "type": "string", "description": "Active variant — one of `inline-list`, `accordion`, `calendar`, `flexible`, `progress`.", "descriptionKey": "ui.agent.booking.state.variant" }, { "name": "currentStep", "type": "number", "description": "The step the flow is on: 1 insurance, 2 specialty, 3 service, 4 provider, 5 date, 6 time, 7 patient details, payment or optional SMS code verification, 8 confirmation after all required steps succeed, including the \"Time reserved\" view that opens a host address after a short delay. Read this back after `goto_step` to see where the clamp landed.", "descriptionKey": "ui.agent.booking.state.currentStep" } ], "actions": [ { "name": "reset", "safety": "destructive", "idempotent": true, "errors": [ "Refused while a payment session is open (step 7): the consumer must cancel the hold first.", "Refused while SMS code verification is pending (step 7): the locked form and code box stay, and the submitted booking remains active. The host owns cancellation." ], "description": "Clear the booking value back to an empty state. Use to abandon an in-progress flow.", "descriptionKey": "ui.agent.booking.actions.reset" }, { "name": "goto_step", "safety": "read", "argsType": "{ step: 1 | 2 | 3 | 4 | 5 | 6 | 7 }", "argsSchema": { "type": "object", "properties": { "step": { "type": "integer", "enum": [ 1, 2, 3, 4, 5, 6, 7 ], "description": "Target step (1-7)." } }, "required": [ "step" ] }, "idempotent": true, "errors": [ "Navigation stays on step 7 while payment or SMS code verification is pending.", "Requested step is not yet reachable — clamped to the first incomplete step.", "Requested step is hidden for this practice (e.g. insurance outside Germany, or provider choice turned off) — clamped to the first incomplete step." ], "examples": [ { "args": { "step": 1 }, "note": "Return to the first step." } ], "description": "Jump to the given step. A step that is hidden for this practice, or that sits ahead of the first incomplete step, clamps to that first incomplete step — read `currentStep` back to see where it landed.", "descriptionKey": "ui.agent.booking.actions.gotoStep" } ], "domHooks": { "root": { "attr": "data-component", "value": "booking", "description": "Marks the Booking root region. The host prop hideEmail (boolean, default false) hides the email field, skips its validation and omits email from submission. The host prop emailOptional (boolean, default false) keeps email visible and optional unless used for confirmation. Email is marked and validated as required when selected in the channel picker or singleConfirmationChannel radio, or when the effective confirmation channel is email. With a hidden picker, the form and success screen use the sole enabled channel, or email when multiple channels are enabled. This includes payment and blocked-payment flows, which omit stored selections from submission. Omitting confirmationChannels also defaults to email. Selecting SMS without email makes the field optional again. The optional/required marker updates visually when the channel changes, with no announcement of that change. Validation updates immediately using the existing email error. With emailOptional, surrounding spaces are trimmed before validation, even when email is required for confirmation. Optional blank values are omitted from submission; filled values are sent trimmed. hideEmail takes precedence over emailOptional. Neither prop changes confirmation channels; pair with confirmationChannels [\"sms\"] for SMS-only confirmation with no channel picker. The optional codeStep prop adds SMS verification after submission and before any payment: the submitted form stays in place but locked (controls disabled, text still readable, not hidden), the code box opens below it, and a Change button, for the patient only (no agent action unlocks it), unlocks the form for a new booking request (the host keeps the earlier request until it expires; the kit cannot cancel it). With payment, a correct code opens the payment stage, and the step remains 7 until payment succeeds; without payment it remains 7 until verification succeeds. It then becomes 8. Patient contact details and verification codes are never exposed through this adapter." }, "instanceId": { "attr": "data-component-id", "sourceProp": "id", "description": "Sourced from the id prop." } } }, { "kind": "component", "id": "booking-reserved", "capabilities": [], "state": [], "actions": [], "domHooks": { "root": { "attr": "data-component", "value": "booking-reserved", "description": "Marks the standalone or embedded reserved-time handover. The host verifies the booking and supplies the destination. No URL, appointment details or patient data are exposed through the adapter." } } }, { "kind": "component", "id": "breadcrumb", "capabilities": [ "navigate" ], "state": [ { "name": "items", "type": "Array<{ id: string, href?: string }>", "description": "Ordered list of crumb ids + hrefs in display order. Labels are intentionally excluded — they may contain PHI.", "descriptionKey": "ui.agent.breadcrumb.state.items" } ], "actions": [ { "name": "navigate_to", "safety": "read", "argsType": "{ id: string }", "argsSchema": { "type": "object", "properties": { "id": { "type": "string", "description": "Stable opaque crumb id (from getItems)." } }, "required": [ "id" ] }, "idempotent": true, "examples": [ { "args": { "id": "/patients" }, "note": "Navigate to the patients crumb." } ], "description": "Activate the crumb with the given id — equivalent to clicking the link.", "descriptionKey": "ui.agent.breadcrumb.actions.navigateTo" } ], "domHooks": { "root": { "attr": "data-component", "value": "breadcrumb", "description": "Marks the Breadcrumb root `