@aehrc/smart-forms-renderer

Interfaces

Interface	Description
InitialiseFormWrapperProps	-
ItemToRepopulate	ItemToRepopulate interface
LaunchContext	LaunchContext interface
QuestionnaireResponseStoreType	QuestionnaireResponseStore properties and methods
QuestionnaireStoreType	QuestionnaireStore properties and methods
SmartConfigStoreType	SmartConfigStore properties and methods
SmartFormsRendererProps	SmartFormsRenderer properties
TerminologyServerStoreType	TerminologyServerStore properties and methods
VariableXFhirQuery	VariableXFhirQuery interface
Variables	Variables interface

Type Aliases

Type alias	Description
Tab	Tab interface
Tabs	Key-value pair of tabs Record<linkId, Tab>

Variables

Variable	Description
questionnaireResponseStore	QuestionnaireResponse state management store which contains all properties and methods to manage the state of the questionnaireResponse.
questionnaireStore	Questionnaire state management store which contains all properties and methods to manage the state of the questionnaire.
smartConfigStore	Smart Config state management store. This is only used for answerExpressions.
terminologyServerStore	Terminology server state management store. This is used for resolving valueSets externally.
useQuestionnaireResponseStore	QuestionnaireResponse state management store which contains all properties and methods to manage the state of the questionnaire.
useQuestionnaireStore	Questionnaire state management store which contains all properties and methods to manage the state of the questionnaire.
useSmartConfigStore	Smart Config state management store. This is only used for answerExpressions.
useTerminologyServerStore	Terminology server state management store. This is used for resolving valueSets externally.

Functions

Function	Description
BaseRenderer	Main component of the form-rendering engine.
GridGroup	Main component to render a Group Grid (grid) Questionnaire item.
GroupTable	Main component to render a Group Table (gtable) Questionnaire item.
InitialiseFormWrapperForStorybook	This is a one-to-one replacement for the SmartFormsRenderer for demo purposes.
RendererThemeProvider	Default theme used by the renderer using Material UI. You can customise your own theme by defining a new ThemeProvider.
RepeatGroup	Main component to render a repeating, group Questionnaire item.
RepeatItem	Main component to render a repeating, non-group Questionnaire item.
SingleItem	Main component to render a repeating, non-group Questionnaire item.
SmartFormsRenderer	A self-initialising wrapper around the BaseRenderer rendering engine.
buildForm	Build the form with an initial Questionnaire and an optional filled QuestionnaireResponse.
destroyForm	Destroy the form to clean up the questionnaire and questionnaireResponse stores.
extractObservationBased	Extract an array of Observations from a QuestionnaireResponse and its source Questionnaire.
generateItemsToRepopulate	Compare latest data from the server with the current QuestionnaireResponse and decide items to re-populate
getResponse	Get the filled QuestionnaireResponse at its current state.
initialiseQuestionnaireResponse	Initialise a questionnaireResponse from a given questionnaire
isRepeatItemAndNotCheckbox	Check if qItem is a repeat item AND if it isn't a checkbox item
isSpecificItemControl	Check if the extension has an itemControl code equal to the given itemControlCode
parseFhirDateToDisplayDate	Parse a FHIR date string to a date to be consumed and displayed by the DateItem component.
removeEmptyAnswersFromResponse	Remove all empty/hidden answers from the filled QuestionnaireResponse.
removeInternalIdsFromResponse	Remove all instances of item.answer.id from the filled QuestionnaireResponse.
repopulateResponse	Re-populate checked items in the re-population dialog into the current QuestionnaireResponse
useBuildForm	React hook wrapping around the buildForm() function to build a form from a questionnaire and an optional QuestionnaireResponse.
useHidden	React hook to determine if a QuestionnaireItem is hidden via item.hidden, enableWhens, enableWhenExpressions.
useRendererQueryClient	Default QueryClient used by the renderer.