@ovok/native/questionnaire-response-form

FHIR questionnaire forms: providers, navigation, item renderers and answer helpers.

Import from @ovok/native/questionnaire-response-form.

ComponentsCopy Anchor Link

QuestionnaireFormCopy Anchor Link

const QuestionnaireForm: NamedExoticComponent<QuestionnaireFormProps> & object & object;

Form that renders a FHIR Questionnaire and submits a QuestionnaireResponse; compose it with the QuestionnaireForm.* sub-components.

Type DeclarationCopy Anchor Link

QuestionnaireFormProviderCopy Anchor Link

const QuestionnaireFormProvider: MemoExoticComponent<(__namedParameters) => Element>;

Owns the Formik state, validation and submission for a questionnaire and provides it to descendants.

QuestionnaireNavigationProviderCopy Anchor Link

const QuestionnaireNavigationProvider: React.FC<React.PropsWithChildren<QuestionnaireNavigationProviderProps>>;

Provides navigation state and next and previous handlers to the form controls.

HooksCopy Anchor Link

useQuestionnaireForm()Copy Anchor Link

function useQuestionnaireForm(): QuestionnaireFormContextType;

Returns the questionnaire form context; must be used within a QuestionnaireFormProvider.

ReturnsCopy Anchor Link

QuestionnaireFormContextType

useQuestionnaireNavigation()Copy Anchor Link

function useQuestionnaireNavigation(): QuestionnaireNavigationContextType;

Returns the navigation state and handlers; must be used within a QuestionnaireNavigationProvider.

ReturnsCopy Anchor Link

QuestionnaireNavigationContextType

useQuestionnaireNavigationState()Copy Anchor Link

function useQuestionnaireNavigationState(
   currentItem,
   currentPageIndex,
   currentItemIndex,
   enabledItems,
   pages,
   values,
   allEnabledItems,
   renderItem?
): NavigationState;

Derives navigation flags and the item count from the current position and answers.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

NavigationState

ClassesCopy Anchor Link

QuestionnaireSubmitUtilsCopy Anchor Link

Helpers for building and saving a QuestionnaireResponse.

ConstructorsCopy Anchor Link

ConstructorCopy Anchor Link

new QuestionnaireSubmitUtils(): QuestionnaireSubmitUtils;

ReturnsCopy Anchor Link

QuestionnaireSubmitUtils

MethodsCopy Anchor Link

createQuestionnaireResponse()Copy Anchor Link

static createQuestionnaireResponse(
   responses,
   pages,
   questionnaire,
   renderItem?,
   resolver?,
   unitOptionsResolver?
): QuestionnaireResponse;

Builds a QuestionnaireResponse from the form values; its status is in-progress while required items are unanswered, otherwise completed.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

QuestionnaireResponse

persistQuestionnaireResponse()Copy Anchor Link

static persistQuestionnaireResponse(
   client,
   response,
   extractObservations
): Promise<QuestionnaireResponse>;

Saves the response idempotently by its identifier. When extractObservations is set, also creates the extracted Observations and marks the response completed in one transaction.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<QuestionnaireResponse>

The saved QuestionnaireResponse.

ThrowsCopy Anchor Link

Error with a translation key when the save, the extraction or the required transaction support fails.

questionnaireHasObservationExtraction()Copy Anchor Link

static questionnaireHasObservationExtraction(questionnaire): boolean;

Whether the questionnaire, or any of its items, asks for Observations to be extracted from the response.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

boolean

FunctionsCopy Anchor Link

getQuestionnaireAnswerPickerOptions()Copy Anchor Link

function getQuestionnaireAnswerPickerOptions(item, locale?): QuestionnaireAnswerPickerOption[];

Builds picker options from a choice item's answer options, in order.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

QuestionnaireAnswerPickerOption[]

getQuestionnaireItemConstraints()Copy Anchor Link

function getQuestionnaireItemConstraints(
   item,
   answers?,
   resolver?,
   unitOptionsResolver?
): QuestionnaireItemConstraints;

Reads the value, length, step and unit constraints from a questionnaire item's extensions.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

QuestionnaireItemConstraints

getQuestionnaireNumericPickerOptions()Copy Anchor Link

function getQuestionnaireNumericPickerOptions(
   item,
   constraints,
   locale?,
   maximumOptions?
): QuestionnaireNumericPickerOption[];

Builds picker options from the item's min, max and step; returns an empty list when the range is missing, invalid or larger than maximumOptions.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

QuestionnaireNumericPickerOption[]

useInitialSelectedValues()Copy Anchor Link

function useInitialSelectedValues(
   pages,
   values,
   setFieldValue
): void;

Hook to handle initializing conditional questions with default values

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

void

useNavigationHandlers()Copy Anchor Link

function useNavigationHandlers(__namedParameters): object;

Provides navigation handlers for the questionnaire form

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

InterfacesCopy Anchor Link

QuestionnaireFormContextTypeCopy Anchor Link

Value of the questionnaire form context: Formik state plus questionnaire navigation state and helpers.

ExtendsCopy Anchor Link

• FormikProps<QuestionnaireFormValues>

PropertiesCopy Anchor Link

QuestionnaireFormValuesCopy Anchor Link

Form values keyed by item linkId.

IndexableCopy Anchor Link

[key: string]: QuestionnaireFormValue

PropertiesCopy Anchor Link

QuestionnaireHeaderPropsCopy Anchor Link

Props for QuestionnaireForm.Header; also accepts View props except style.

ExtendsCopy Anchor Link

• Omit<ViewProps, "style">

PropertiesCopy Anchor Link

Type AliasesCopy Anchor Link

ExtendedQuestionnaireItemCopy Anchor Link

type ExtendedQuestionnaireItem = QuestionnaireItem & object;

A FHIR Questionnaire item with extra fields for translations, helper text and placeholders.

Type DeclarationCopy Anchor Link

QuestionnaireAnswerPickerOptionCopy Anchor Link

type QuestionnaireAnswerPickerOption = object;

A picker option for a choice item, pairing a label with its answer.

PropertiesCopy Anchor Link

labelCopy Anchor Link

label: string;

Display text for the option.

valueCopy Anchor Link

value: QuestionnaireResponseItemAnswer;

Answer stored when the option is chosen.

QuestionnaireConstraintResolverCopy Anchor Link

type QuestionnaireConstraintResolver = (constraint, item, answers) => unknown;

Resolves a calculated constraint extension to a concrete value; return undefined or null to fall back to the static value.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

unknown

QuestionnaireFormPropsCopy Anchor Link

type QuestionnaireFormProps = (ViewProps | ScrollViewProps) & QuestionnaireFormProviderProps & object;

Props for QuestionnaireForm: View or ScrollView props plus the provider props.

Type DeclarationCopy Anchor Link

QuestionnaireFormProviderPropsCopy Anchor Link

type QuestionnaireFormProviderProps = object & (
  | {
  onError?: (error) => void;
  onSubmit?: undefined;
  onSuccess?: (response) => void;
}
  | {
  onError?: undefined;
  onSubmit?: (values, formikHelpers?) => Promise<void>;
  onSuccess?: undefined;
});

Props for the questionnaire form provider; pass either onSubmit, or onSuccess and onError.

Type DeclarationCopy Anchor Link

QuestionnaireFormValueCopy Anchor Link

type QuestionnaireFormValue =
  | QuestionnaireResponseItemAnswerValue
  | QuestionnaireResponseItemAnswer
  | null
  | undefined;

The answer stored for one questionnaire item.

QuestionnaireItemConstraintsCopy Anchor Link

type QuestionnaireItemConstraints = object;

Constraints derived from a questionnaire item's extensions.

PropertiesCopy Anchor Link

maxLength?Copy Anchor Link

maxLength?: number;

Maximum text length.

maxQuantity?Copy Anchor Link

maxQuantity?: Quantity;

Maximum allowed quantity.

maxValue?Copy Anchor Link

maxValue?: number | string;

Maximum allowed value.

minLength?Copy Anchor Link

minLength?: number;

Minimum text length.

minQuantity?Copy Anchor Link

minQuantity?: Quantity;

Minimum allowed quantity.

minValue?Copy Anchor Link

minValue?: number | string;

Minimum allowed value.

step?Copy Anchor Link

step?: number;

Slider step; only set when positive.

unitOpen?Copy Anchor Link

unitOpen?: string;

Whether units outside the options are allowed; defaults to "optionsOnly".

unitOptionsCopy Anchor Link

unitOptions: Coding[];

Unit choices for quantity items, de-duplicated.

unitValueSet?Copy Anchor Link

unitValueSet?: string;

Canonical of the value set providing unit choices.

unresolvedDynamicBoundsCopy Anchor Link

unresolvedDynamicBounds: ("minValue" | "maxValue" | "minQuantity" | "maxQuantity")[];

Bounds backed by a calculated value that the resolver did not resolve.

unresolvedUnitValueSetCopy Anchor Link

unresolvedUnitValueSet: boolean;

true when a unit value set exists but the resolver did not expand it.

QuestionnaireItemRendererCopy Anchor Link

type QuestionnaireItemRenderer = (props) => ReactNode;

Renders a questionnaire item; used to override the built-in controls.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

ReactNode

QuestionnaireItemRenderPropsCopy Anchor Link

type QuestionnaireItemRenderProps = object;

Props passed to a custom questionnaire item renderer.

PropertiesCopy Anchor Link

constraintsCopy Anchor Link

constraints: QuestionnaireItemConstraints;

Constraints derived from the item's extensions.

itemCopy Anchor Link

item: ExtendedQuestionnaireItem;

The questionnaire item to render.

locale?Copy Anchor Link

locale?: string;

Locale used for item text.

onChangeCopy Anchor Link

onChange: (value) => void;

Call with the new answer when the user changes it.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

void

testID?Copy Anchor Link

testID?: string;

Test identifier for the rendered item.

value?Copy Anchor Link

value?: QuestionnaireFormValue;

Current answer for the item.

QuestionnaireNavigationProviderPropsCopy Anchor Link

type QuestionnaireNavigationProviderProps = object;

Props for the questionnaire navigation provider.

PropertiesCopy Anchor Link

allEnabledItemsCopy Anchor Link

allEnabledItems: ExtendedQuestionnaireItem[];

Enabled items across all pages.

currentItemCopy Anchor Link

currentItem: ExtendedQuestionnaireItem | undefined;

The item currently shown, or undefined when there is none.

currentItemIndexCopy Anchor Link

currentItemIndex: number;

Index of the current item.

currentPageCopy Anchor Link

currentPage: ExtendedQuestionnaireItem;

The page currently shown.

currentPageIndexCopy Anchor Link

currentPageIndex: number;

Index of the current page.

enabledItemsCopy Anchor Link

enabledItems: ExtendedQuestionnaireItem[];

Enabled items of the current page.

formikCopy Anchor Link

formik: object;

Subset of Formik state the navigation depends on.

isSubmittingCopy Anchor Link

isSubmitting: boolean;

Whether the form is being submitted.

valuesCopy Anchor Link

values: QuestionnaireFormValues;

Current form values.

pagesCopy Anchor Link

pages: ExtendedQuestionnaireItem[];

The pages of the questionnaire.

renderItem?Copy Anchor Link

renderItem?: QuestionnaireItemRenderer;

Custom renderer for questionnaire items.

resolveQuestionnaireConstraint?Copy Anchor Link

resolveQuestionnaireConstraint?: QuestionnaireConstraintResolver;

Resolves constraints (such as min and max values) for an item.

resolveQuestionnaireUnitOptions?Copy Anchor Link

resolveQuestionnaireUnitOptions?: QuestionnaireUnitOptionsResolver;

Resolves the selectable units for a quantity item.

setCurrentItemIndexCopy Anchor Link

setCurrentItemIndex: React.Dispatch<React.SetStateAction<number>>;

Sets the current item index.

setCurrentPageIndexCopy Anchor Link

setCurrentPageIndex: React.Dispatch<React.SetStateAction<number>>;

Sets the current page index.

setErrorMessageCopy Anchor Link

setErrorMessage: React.Dispatch<React.SetStateAction<string | null>>;

Sets the validation error message.

valuesCopy Anchor Link

values: QuestionnaireFormValues;

Current form values.

QuestionnaireNumericPickerOptionCopy Anchor Link

type QuestionnaireNumericPickerOption = object;

A picker option for a numeric item, pairing a formatted label with its number.

PropertiesCopy Anchor Link

labelCopy Anchor Link

label: string;

Formatted number shown for the option.

valueCopy Anchor Link

value: number;

Numeric value of the option.

QuestionnaireUnitOptionsResolverCopy Anchor Link

type QuestionnaireUnitOptionsResolver = (valueSet, item, answers) => Coding[] | undefined;

Resolves a unitValueSet canonical to its unit codings, or undefined when it cannot be resolved.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Coding[] | undefined

ResponseValuesCopy Anchor Link

type ResponseValues = Record<string, QuestionnaireFormValue>;

Form values keyed by item linkId.

VariablesCopy Anchor Link

QuestionnaireFormContextCopy Anchor Link

const QuestionnaireFormContext: Context<
  | QuestionnaireFormContextType
| undefined>;

Context holding the questionnaire form state.

QuestionnaireNavigationContextCopy Anchor Link

const QuestionnaireNavigationContext: Context<QuestionnaireNavigationContextType | undefined>;

Context holding the questionnaire navigation state and handlers.