Skip to main content

Function: useBuildForm()

useBuildForm(questionnaire, questionnaireResponse?, readOnly?, terminologyServerUrl?, additionalVariables?): boolean

React hook wrapping around the buildForm() function to build a form from a questionnaire and an optional QuestionnaireResponse.

Parameters

ParameterTypeDescription
questionnaireQuestionnaireQuestionnaire to be rendered
questionnaireResponse?QuestionnaireResponsePre-populated/draft/loaded QuestionnaireResponse to be rendered (optional)
readOnly?booleanApplies read-only mode to all items in the form view
terminologyServerUrl?stringTerminology server url to fetch terminology. If not provided, the default terminology server will be used. (optional)
additionalVariables?Record<string, object>Additional key-value pair of SDC variables Record<name, variable extension> for testing (optional)

Returns

boolean

See

buildForm() for more information.