Variable: useQuestionnaireStore

const useQuestionnaireStore: StoreApi<QuestionnaireStoreType> & object

Questionnaire state management store which contains all properties and methods to manage the state of the questionnaire. This is the React version of the store which can be used as React hooks in React functional components.

Type Declaration

use

use: object

use.addCodingToCache()

addCodingToCache: () => (valueSetUrl, codings) => void

Returns

(valueSetUrl, codings): void

Parameters

Parameter	Type
valueSetUrl	string
codings	Coding[]

Returns

void

use.additionalContext()

additionalContext: () => Record<string, any>

Returns

Record<string, any>

use.answerExpressions()

answerExpressions: () => Record<string, AnswerExpression>

Returns

Record<string, AnswerExpression>

use.answerOptionsToggleExpressions()

answerOptionsToggleExpressions: () => Record<string, AnswerOptionsToggleExpression[]>

Returns

Record<string, AnswerOptionsToggleExpression[]>

use.buildSourceQuestionnaire()

buildSourceQuestionnaire: () => (questionnaire, questionnaireResponse?, additionalContext?, terminologyServerUrl?, readOnly?, qItemOverrideComponents?, sdcUiOverrideComponents?) => Promise<void>

Returns

(questionnaire, questionnaireResponse?, additionalContext?, terminologyServerUrl?, readOnly?, qItemOverrideComponents?, sdcUiOverrideComponents?): Promise<void>

Parameters

Parameter	Type
questionnaire	Questionnaire
questionnaireResponse?	QuestionnaireResponse
additionalContext?	Record<string, any>
terminologyServerUrl?	string
readOnly?	boolean
qItemOverrideComponents?	Record<string, ComponentType<QItemOverrideComponentProps>>
sdcUiOverrideComponents?	Record<string, ComponentType<SdcUiOverrideComponentProps>>

Returns

Promise<void>

use.cachedValueSetCodings()

cachedValueSetCodings: () => Record<string, Coding[]>

Returns

Record<string, Coding[]>

use.calculatedExpressions()

calculatedExpressions: () => Record<string, CalculatedExpression[]>

Returns

Record<string, CalculatedExpression[]>

use.currentPageIndex()

currentPageIndex: () => number

Returns

number

use.currentTabIndex()

currentTabIndex: () => number

Returns

number

use.destroySourceQuestionnaire()

destroySourceQuestionnaire: () => () => void

Returns

(): void

Returns

void

use.enableWhenExpressions()

enableWhenExpressions: () => EnableWhenExpressions

Returns

EnableWhenExpressions

use.enableWhenIsActivated()

enableWhenIsActivated: () => boolean

Returns

boolean

use.enableWhenItems()

enableWhenItems: () => EnableWhenItems

Returns

EnableWhenItems

use.enableWhenLinkedQuestions()

enableWhenLinkedQuestions: () => Record<string, string[]>

Returns

Record<string, string[]>

use.fhirPathContext()

fhirPathContext: () => Record<string, any>

Returns

Record<string, any>

use.fhirPathTerminologyCache()

fhirPathTerminologyCache: () => Record<string, any>

Returns

Record<string, any>

use.focusedLinkId()

focusedLinkId: () => string

Returns

string

use.initialExpressions()

initialExpressions: () => Record<string, InitialExpression>

Returns

Record<string, InitialExpression>

use.itemMap()

itemMap: () => Record<string, Omit<QuestionnaireItem, "item">>

Returns

Record<string, Omit<QuestionnaireItem, "item">>

use.itemPreferredTerminologyServers()

itemPreferredTerminologyServers: () => Record<string, string>

Returns

Record<string, string>

use.launchContexts()

launchContexts: () => Record<string, LaunchContext>

Returns

Record<string, LaunchContext>

use.markPageAsComplete()

markPageAsComplete: () => (pageLinkId) => void

Returns

(pageLinkId): void

Parameters

Parameter	Type
pageLinkId	string

Returns

void

use.markTabAsComplete()

markTabAsComplete: () => (tabLinkId) => void

Returns

(tabLinkId): void

Parameters

Parameter	Type
tabLinkId	string

Returns

void

use.mutateRepeatEnableWhenItems()

mutateRepeatEnableWhenItems: () => (parentRepeatGroupLinkId, parentRepeatGroupIndex, actionType) => void

Returns

(parentRepeatGroupLinkId, parentRepeatGroupIndex, actionType): void

Parameters

Parameter	Type
parentRepeatGroupLinkId	string
parentRepeatGroupIndex	number
actionType	"add" | "remove"

Returns

void

use.onFocusLinkId()

onFocusLinkId: () => (linkId) => void

Returns

(linkId): void

Parameters

Parameter	Type
linkId	string

Returns

void

use.pages()

pages: () => Pages

Returns

Pages

use.processedValueSets()

processedValueSets: () => Record<string, ProcessedValueSet>

Returns

Record<string, ProcessedValueSet>

use.qItemOverrideComponents()

qItemOverrideComponents: () => Record<string, ComponentType<QItemOverrideComponentProps>>

Returns

Record<string, ComponentType<QItemOverrideComponentProps>>

use.readOnly()

readOnly: () => boolean

Returns

boolean

use.resetToFirstVisiblePage()

resetToFirstVisiblePage: () => () => void

Returns

(): void

Returns

void

use.resetToFirstVisibleTab()

resetToFirstVisibleTab: () => () => void

Returns

(): void

Returns

void

use.sdcUiOverrideComponents()

sdcUiOverrideComponents: () => Record<string, ComponentType<SdcUiOverrideComponentProps>>

Returns

Record<string, ComponentType<SdcUiOverrideComponentProps>>

use.setAdditionalContext()

setAdditionalContext: () => (additionalContext) => void

Returns

(additionalContext): void

Parameters

Parameter	Type
additionalContext	Record<string, any>

Returns

void

use.setFormAsReadOnly()

setFormAsReadOnly: () => (readOnly) => void

Returns

(readOnly): void

Parameters

Parameter	Type
readOnly	boolean

Returns

void

use.sourceQuestionnaire()

sourceQuestionnaire: () => Questionnaire

Returns

Questionnaire

use.switchPage()

switchPage: () => (newPageIndex) => void

Returns

(newPageIndex): void

Parameters

Parameter	Type
newPageIndex	number

Returns

void

use.switchTab()

switchTab: () => (newTabIndex) => void

Returns

(newTabIndex): void

Parameters

Parameter	Type
newTabIndex	number

Returns

void

use.tabs()

tabs: () => Tabs

Returns

Tabs

use.targetConstraintLinkIds()

targetConstraintLinkIds: () => Record<string, string[]>

Returns

Record<string, string[]>

use.targetConstraints()

targetConstraints: () => Record<string, TargetConstraint>

Returns

Record<string, TargetConstraint>

use.toggleEnableWhenActivation()

toggleEnableWhenActivation: () => (isActivated) => void

Returns

(isActivated): void

Parameters

Parameter	Type
isActivated	boolean

Returns

void

use.updateEnableWhenItem()

updateEnableWhenItem: () => (linkId, newAnswer, parentRepeatGroupIndex) => void

Returns

(linkId, newAnswer, parentRepeatGroupIndex): void

Parameters

Parameter	Type
linkId	string
newAnswer	QuestionnaireResponseItemAnswer[] | undefined
parentRepeatGroupIndex	number | null

Returns

void

use.updateExpressions()

updateExpressions: () => (updatedResponse, isInitialUpdate) => Promise<void>

Returns

(updatedResponse, isInitialUpdate): Promise<void>

Parameters

Parameter	Type
updatedResponse	QuestionnaireResponse
isInitialUpdate	boolean

Returns

Promise<void>

use.variables()

variables: () => Variables

Returns

Variables

See

• QuestionnaireStoreType for available properties and methods.
• questionnaireStore for the vanilla store.