Card Definitions
This section describes the structure of card definitions, including card data, card layout, card footer, and card UI actions.
All card definitions must be included in the input.json
file.
Cards
A card contains multiple data types, user interface elements, and interactive functions triggered by events.
Field Name | Value Type | Description |
---|---|---|
id | string | The unique ID of the card. |
name | string | The name of the card. |
description | string | The description of the card. |
status | string | The status of the card is set to Active. |
card_definition_ref | string | The reference to the UI component of the card. |
side | string | The side on which data is presented. |
role | string | The role ID is referenced in the card. |
transaction_data_ref | string | The reference to the transaction data used upon initialization. |
journey | string | The journey to which the card belongs. |
outgoing_events | array | The events or actions triggered by the card. |
pre_rendering_events | array | The events or actions used to initialize the card. |
Card definition structure
Each card definition is located in the /definitions/card/
folder.
Card data - The information or data displayed within the card, such as texts, images, and links.
Card layout - The arrangement and organization of elements within the card, including body content style, and footer menus.
Card footer - The additional options, navigation buttons, or menus at the bottom of the card for user interaction and navigation.
Card UI actions - The actions triggered by user interactions within the card, such as navigation, form submissions, or data updates.
Card data
Card data can include text, images, links or different types of information relevant to a healthcare journey.
Card layout
The card body displays the card's content, which includes tiles, texts, images, and interactive functions. For information on supported tiles, see Tiles. For details on supported functions, see Functions.
Card footer
The card footer includes buttons or actions used to interact with the card itself or navigate to other related cards. These buttons or actions can perform specific tasks like submitting information, saving changes, or going back to previous screens.
Card UI actions
The card UI actions define user interactions within the card's content. These actions trigger functionalities like navigation, data updates, input validation, or external function calls.
Last updated