@aehrc/smart-forms-renderer 1.0.0-alpha.42.dev4 → 1.0.0-alpha.42.dev5

package/dist/index.d.ts

@@ -0,0 +1,1283 @@
+import * as fhir_r4 from 'fhir/r4';
+import { Expression, FhirResource, Extension, Coding, QuestionnaireItemEnableWhen, QuestionnaireResponseItemAnswer, QuestionnaireItem, QuestionnaireResponseItem, QuestionnaireItemAnswerOption, Questionnaire, QuestionnaireResponse, OperationOutcome, Patient, Practitioner, Encounter, Observation } from 'fhir/r4';
+import * as react from 'react';
+import react__default, { JSX, ReactNode, ComponentType } from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import Client from 'fhirclient/lib/Client';
+import * as _emotion_styled from '@emotion/styled';
+import * as _mui_system from '@mui/system';
+import * as _mui_material_styles from '@mui/material/styles';
+import { Breakpoint, ThemeOptions } from '@mui/material/styles';
+import * as zustand_vanilla from 'zustand/vanilla';
+import { Diff } from 'deep-diff';
+import { Breakpoints } from '@mui/material';
+import { QueryClient } from '@tanstack/react-query';
+
+/**
+ * Tab interface
+ *
+ * @property tabIndex - The index of the tab
+ * @property isComplete - Whether the tab is marked as complete
+ * @property isHidden - Whether the tab is hidden
+ */
+type Tab = {
+    tabIndex: number;
+    isComplete: boolean;
+    isHidden: boolean;
+};
+/**
+ * Key-value pair of tabs `Record<linkId, Tab>`
+ */
+type Tabs = Record<string, Tab>;
+
+/**
+ * Variables interface
+ *
+ * @property fhirPathVariables - Key-value pair of FHIRPath variable expressions in a Questionnaire item `Record<linkId, array of FHIRPath expressions>`
+ * @property xFhirQueryVariables - Key-value pair of x-fhir-query variables `Record<variable name, x-fhir-query variable properties>`
+ */
+interface Variables {
+    fhirPathVariables: Record<string, Expression[]>;
+    xFhirQueryVariables: Record<string, VariableXFhirQuery>;
+}
+/**
+ * VariableXFhirQuery interface
+ *
+ * @property valueExpression - FHIRPath Expression of the variable
+ * @property result - FHIR resource result of the executed query
+ */
+interface VariableXFhirQuery {
+    valueExpression: Expression;
+    result?: FhirResource;
+}
+
+/**
+ * LaunchContext interface
+ *
+ * @property url - Launch context URL
+ * @property extension - Possible contents of the launch context as an array of extensions
+ */
+interface LaunchContext extends Extension {
+    url: 'http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-launchContext';
+    extension: LaunchContextExtensions;
+}
+type LaunchContextExtensions = [LaunchContextName, LaunchContextType] | [LaunchContextName, LaunchContextType, LaunchContextDescription];
+type LaunchContextName = LaunchContextNameId | LaunchContextNameCoding;
+interface LaunchContextNameId extends Extension {
+    url: 'name';
+    valueId: string;
+}
+interface LaunchContextNameCoding extends Extension {
+    url: 'name';
+    valueCoding: LaunchContextNameCodingValueCoding;
+}
+interface LaunchContextNameCodingValueCoding extends Coding {
+    code: 'patient' | 'encounter' | 'location' | 'user' | 'study';
+}
+interface LaunchContextType extends Extension {
+    url: 'type';
+    valueCode: FhirResourceString;
+}
+interface LaunchContextDescription extends Extension {
+    url: 'description';
+    valueString: string;
+}
+type FhirResourceString = 'Account' | 'ActivityDefinition' | 'AdverseEvent' | 'AllergyIntolerance' | 'Appointment' | 'AppointmentResponse' | 'AuditEvent' | 'Basic' | 'Binary' | 'BiologicallyDerivedProduct' | 'BodyStructure' | 'Bundle' | 'CapabilityStatement' | 'CarePlan' | 'CareTeam' | 'CatalogEntry' | 'ChargeItem' | 'ChargeItemDefinition' | 'Claim' | 'ClaimResponse' | 'ClinicalImpression' | 'CodeSystem' | 'Communication' | 'CommunicationRequest' | 'CompartmentDefinition' | 'Composition' | 'ConceptMap' | 'Condition' | 'Consent' | 'Contract' | 'Coverage' | 'CoverageEligibilityRequest' | 'CoverageEligibilityResponse' | 'DetectedIssue' | 'Device' | 'DeviceDefinition' | 'DeviceMetric' | 'DeviceRequest' | 'DeviceUseStatement' | 'DiagnosticReport' | 'DocumentManifest' | 'DocumentReference' | 'EffectEvidenceSynthesis' | 'Encounter' | 'Endpoint' | 'EnrollmentRequest' | 'EnrollmentResponse' | 'EpisodeOfCare' | 'EventDefinition' | 'Evidence' | 'EvidenceVariable' | 'ExampleScenario' | 'ExplanationOfBenefit' | 'FamilyMemberHistory' | 'Flag' | 'Goal' | 'GraphDefinition' | 'Group' | 'GuidanceResponse' | 'HealthcareService' | 'ImagingStudy' | 'Immunization' | 'ImmunizationEvaluation' | 'ImmunizationRecommendation' | 'ImplementationGuide' | 'InsurancePlan' | 'Invoice' | 'Library' | 'Linkage' | 'List' | 'Location' | 'Measure' | 'MeasureReport' | 'Media' | 'Medication' | 'MedicationAdministration' | 'MedicationDispense' | 'MedicationKnowledge' | 'MedicationRequest' | 'MedicationStatement' | 'MedicinalProduct' | 'MedicinalProductAuthorization' | 'MedicinalProductContraindication' | 'MedicinalProductIndication' | 'MedicinalProductIngredient' | 'MedicinalProductInteraction' | 'MedicinalProductManufactured' | 'MedicinalProductPackaged' | 'MedicinalProductPharmaceutical' | 'MedicinalProductUndesirableEffect' | 'MessageDefinition' | 'MessageHeader' | 'MolecularSequence' | 'NamingSystem' | 'NutritionOrder' | 'Observation' | 'ObservationDefinition' | 'OperationDefinition' | 'OperationOutcome' | 'Organization' | 'OrganizationAffiliation' | 'Parameters' | 'Patient' | 'PaymentNotice' | 'PaymentReconciliation' | 'Person' | 'PlanDefinition' | 'Practitioner' | 'PractitionerRole' | 'Procedure' | 'Provenance' | 'Questionnaire' | 'QuestionnaireResponse' | 'RelatedPerson' | 'RequestGroup' | 'ResearchDefinition' | 'ResearchElementDefinition' | 'ResearchStudy' | 'ResearchSubject' | 'RiskAssessment' | 'RiskEvidenceSynthesis' | 'Schedule' | 'SearchParameter' | 'ServiceRequest' | 'Slot' | 'Specimen' | 'SpecimenDefinition' | 'StructureDefinition' | 'StructureMap' | 'Subscription' | 'Substance' | 'SubstanceNucleicAcid' | 'SubstancePolymer' | 'SubstanceProtein' | 'SubstanceReferenceInformation' | 'SubstanceSourceMaterial' | 'SubstanceSpecification' | 'SupplyDelivery' | 'SupplyRequest' | 'Task' | 'TerminologyCapabilities' | 'TestReport' | 'TestScript' | 'ValueSet' | 'VerificationResult' | 'VisionPrescription';
+
+/**
+ * EnableWhenExpressions interface
+ *
+ * @property singleExpressions - Key-value pair of non-repeat group enableWhen expressions `Record<linkId, enableWhenExpression properties>`
+ * @property repeatExpressions - Key-value pair of repeat group enableWhen expressions `Record<linkId, enableWhenExpression properties>`
+ */
+interface EnableWhenExpressions {
+    singleExpressions: Record<string, EnableWhenSingleExpression>;
+    repeatExpressions: Record<string, EnableWhenRepeatExpression>;
+}
+interface EnableWhenSingleExpression {
+    expression: string;
+    isEnabled?: boolean;
+}
+interface EnableWhenRepeatExpression {
+    expression: string;
+    parentLinkId: string;
+    enabledIndexes: boolean[];
+}
+/**
+ * EnableWhenItems interface
+ *
+ * @property singleItems - Key-value pair of non-repeat group enableWhen items `Record<linkId, enableWhen properties>`
+ * @property repeatItems - Key-value pair of repeat group enableWhen items `Record<linkId, enableWhen properties>`
+ */
+interface EnableWhenItems {
+    singleItems: Record<string, EnableWhenSingleItemProperties>;
+    repeatItems: Record<string, EnableWhenRepeatItemProperties>;
+}
+interface EnableWhenSingleItemProperties {
+    linked: EnableWhenSingleLinkedItem[];
+    isEnabled: boolean;
+    enableBehavior?: QuestionnaireItem['enableBehavior'];
+}
+interface EnableWhenRepeatItemProperties {
+    linked: EnableWhenRepeatLinkedItem[];
+    parentLinkId: string;
+    enabledIndexes: boolean[];
+    enableBehavior?: QuestionnaireItem['enableBehavior'];
+}
+interface EnableWhenSingleLinkedItem {
+    enableWhen: QuestionnaireItemEnableWhen;
+    answer?: QuestionnaireResponseItemAnswer[];
+}
+interface EnableWhenRepeatLinkedItem {
+    enableWhen: QuestionnaireItemEnableWhen;
+    parentLinkId: string;
+    answers: QuestionnaireResponseItemAnswer[];
+}
+
+/**
+ * CalculatedExpression interface
+ *
+ * @property expression - CalculatedExpression FHIRPath expression
+ * @property from - Whether the expressions is for the item itself or for item._text
+ * @property value - Evaluated value of the expression via FHIRPath
+ */
+interface CalculatedExpression {
+    expression: string;
+    from: 'item' | 'item._text';
+    value?: number | string | boolean | object | null;
+}
+
+interface QrRepeatGroup {
+    linkId: string;
+    qrItems: QuestionnaireResponseItem[];
+}
+
+interface RenderingExtensions {
+    displayUnit: string;
+    displayPrompt: string;
+    displayInstructions: string;
+    displayFlyover: string | JSX.Element | JSX.Element[];
+    readOnly: boolean;
+    entryFormat: string;
+    required: boolean;
+    quantityUnit: QuestionnaireItemAnswerOption | null;
+}
+declare function useRenderingExtensions(qItem: QuestionnaireItem): RenderingExtensions;
+
+interface QItemOverrideComponentProps {
+    qItem: QuestionnaireItem;
+    qrItem: QuestionnaireResponseItem | QuestionnaireResponseItem[] | null;
+    isRepeated: boolean;
+    isTabled?: boolean;
+    renderingExtensions?: RenderingExtensions;
+    groupCardElevation?: number;
+    parentIsReadOnly?: boolean;
+    feedbackFromParent?: string;
+    parentIsRepeatGroup?: boolean;
+    parentRepeatGroupIndex?: number;
+    parentStyles?: Record<string, string>;
+    onQrItemChange: (qrItem: QuestionnaireResponseItem) => unknown;
+    onQrRepeatGroupChange: (qrRepeatGroup: QrRepeatGroup) => unknown;
+}
+interface SdcUiOverrideComponentProps {
+    displayText: string | JSX.Element | JSX.Element[];
+    readOnly?: boolean;
+}
+
+/**
+ * SmartFormsRenderer properties
+ *
+ * @property questionnaire - Input FHIR R4 Questionnaire to be rendered
+ * @property questionnaireResponse - Pre-populated QuestionnaireResponse to be rendered (optional)
+ * @property additionalVariables - Additional key-value pair of SDC variables `Record<name, variable extension>` for testing (optional)
+ * @property terminologyServerUrl - Terminology server url to fetch terminology. If not provided, the default terminology server will be used. (optional)
+ * @property fhirClient - FHIRClient object to perform further FHIR calls. At the moment it's only used in answerExpressions (optional)
+ * @property readOnly - Applies read-only mode to all items in the form
+ *
+ * @author Sean Fong
+ */
+interface SmartFormsRendererProps {
+    questionnaire: Questionnaire;
+    questionnaireResponse?: QuestionnaireResponse;
+    additionalVariables?: Record<string, object>;
+    terminologyServerUrl?: string;
+    fhirClient?: Client;
+    readOnly?: boolean;
+}
+/**
+ * A self-initialising wrapper around the BaseRenderer rendering engine.
+ * Will be deprecated in version 1.0.0. For alternative usage, see:
+ * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/storybookWrappers/InitialiseFormWrapperForStorybook.tsx#L40-L57
+ *
+ * @see SmartFormsRendererProps for props.
+ *
+ * @author Sean Fong
+ */
+declare function SmartFormsRenderer(props: SmartFormsRendererProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * Main component of the form-rendering engine.
+ * Renders the Questionnaire and QuestionnaireResponse defined in the state management stores QuestionnaireStore and QuestionnaireResponseStore respectively.
+ * Use buildForm() in your wrapping component or in an event handler to initialise the form.
+ *
+ * @author Sean Fong
+ */
+declare function BaseRenderer(): react_jsx_runtime.JSX.Element;
+
+interface PropsWithQrItemChangeHandler {
+    onQrItemChange: (qrItem: QuestionnaireResponseItem) => unknown;
+}
+interface PropsWithQrRepeatGroupChangeHandler {
+    onQrRepeatGroupChange: (qrRepeatGroup: QrRepeatGroup) => unknown;
+}
+interface PropsWithIsRepeatedAttribute {
+    isRepeated: boolean;
+}
+interface PropsWithIsTabledRequiredAttribute {
+    isTabled: boolean;
+}
+interface PropsWithShowMinimalViewAttribute {
+    showMinimalView?: boolean;
+}
+interface PropsWithParentIsReadOnlyAttribute {
+    parentIsReadOnly?: boolean;
+}
+interface PropsWithFeedbackFromParentAttribute {
+    feedbackFromParent?: string;
+}
+interface PropsWithParentIsRepeatGroupAttribute {
+    parentIsRepeatGroup?: boolean;
+    parentRepeatGroupIndex?: number;
+}
+
+interface SingleItemProps extends PropsWithQrItemChangeHandler, PropsWithIsRepeatedAttribute, PropsWithIsTabledRequiredAttribute, PropsWithShowMinimalViewAttribute, PropsWithParentIsReadOnlyAttribute, PropsWithParentIsRepeatGroupAttribute, PropsWithFeedbackFromParentAttribute {
+    qItem: QuestionnaireItem;
+    qrItem: QuestionnaireResponseItem | null;
+    groupCardElevation: number;
+    parentStyles?: Record<string, string>;
+}
+/**
+ * Main component to render a repeating, non-group Questionnaire item.
+ * Store and manages the state of multiple instances of SingleItem in a repeating item.
+ *
+ * @author Sean Fong
+ */
+declare function SingleItem(props: SingleItemProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * Page interface
+ *
+ * @property pageIndex - The index of the page
+ * @property isComplete - Whether the page is marked as complete
+ * @property isHidden - Whether the page is hidden
+ */
+type Page = {
+    pageIndex: number;
+    isComplete: boolean;
+    isHidden: boolean;
+};
+/**
+ * Key-value pair of pages `Record<linkId, Page>`
+ */
+type Pages = Record<string, Page>;
+
+interface GroupItemProps extends PropsWithQrItemChangeHandler, PropsWithIsRepeatedAttribute, PropsWithParentIsReadOnlyAttribute, PropsWithParentIsRepeatGroupAttribute {
+    qItem: QuestionnaireItem;
+    qrItem: QuestionnaireResponseItem | null;
+    groupCardElevation: number;
+    disableCardView?: boolean;
+    tabIsMarkedAsComplete?: boolean;
+    tabs?: Tabs;
+    currentTabIndex?: number;
+    pageIsMarkedAsComplete?: boolean;
+    pages?: Pages;
+    currentPageIndex?: number;
+    parentStyles?: Record<string, string>;
+}
+declare function GroupItem(props: GroupItemProps): react_jsx_runtime.JSX.Element | null;
+
+interface RepeatItemProps extends PropsWithQrItemChangeHandler, PropsWithShowMinimalViewAttribute, PropsWithParentIsReadOnlyAttribute {
+    qItem: QuestionnaireItem;
+    qrItem: QuestionnaireResponseItem | null;
+    groupCardElevation: number;
+}
+/**
+ * Main component to render a repeating, non-group Questionnaire item.
+ *
+ * @author Sean Fong
+ */
+declare function RepeatItem(props: RepeatItemProps): react_jsx_runtime.JSX.Element;
+
+interface RepeatGroupProps extends PropsWithQrRepeatGroupChangeHandler, PropsWithShowMinimalViewAttribute, PropsWithParentIsReadOnlyAttribute, PropsWithParentIsRepeatGroupAttribute {
+    qItem: QuestionnaireItem;
+    qrItems: QuestionnaireResponseItem[];
+    groupCardElevation: number;
+    parentStyles?: Record<string, string>;
+}
+/**
+ * Main component to render a repeating, group Questionnaire item.
+ * Store and manages the state of multiple instances of GroupItem in a repeating group.
+ *
+ * @author Sean Fong
+ */
+declare function RepeatGroup(props: RepeatGroupProps): react_jsx_runtime.JSX.Element;
+
+interface GroupTableProps extends PropsWithQrRepeatGroupChangeHandler, PropsWithIsRepeatedAttribute, PropsWithShowMinimalViewAttribute, PropsWithParentIsReadOnlyAttribute {
+    qItem: QuestionnaireItem;
+    qrItems: QuestionnaireResponseItem[];
+    groupCardElevation: number;
+    parentStyles?: Record<string, string>;
+}
+/**
+ * Main component to render a Group Table (gtable) Questionnaire item.
+ * @see {@link https://hl7.org/fhir/extensions/CodeSystem-questionnaire-item-control.html}
+ *
+ * @author Sean Fong
+ */
+declare function GroupTable(props: GroupTableProps): react_jsx_runtime.JSX.Element | null;
+
+interface GridGroupProps extends PropsWithQrItemChangeHandler, PropsWithShowMinimalViewAttribute, PropsWithParentIsReadOnlyAttribute {
+    qItem: QuestionnaireItem;
+    qrItem: QuestionnaireResponseItem | null;
+    groupCardElevation: number;
+    parentStyles?: Record<string, string>;
+}
+/**
+ * Main component to render a Group Grid (grid) Questionnaire item.
+ * @see {@link https://hl7.org/fhir/extensions/CodeSystem-questionnaire-item-control.html}
+ *
+ * @author Sean Fong
+ */
+declare function GridGroup(props: GridGroupProps): react_jsx_runtime.JSX.Element | null;
+
+/**
+ * Parse a FHIR date string to a date to be consumed and displayed by the DateItem component.
+ *
+ * @author Sean Fong
+ */
+declare function parseFhirDateToDisplayDate(fhirDate: string): {
+    displayDate: string;
+    dateParseFail?: boolean;
+};
+
+interface ItemFieldGridProps {
+    qItem: QuestionnaireItem;
+    readOnly: boolean;
+    labelChildren?: ReactNode;
+    fieldChildren?: ReactNode;
+    feedback?: string;
+    dateFeedback?: string;
+    timeFeedback?: string;
+}
+declare function ItemFieldGrid(props: ItemFieldGridProps): react_jsx_runtime.JSX.Element;
+
+interface ItemLabelProps {
+    qItem: QuestionnaireItem;
+    readOnly: boolean;
+    isDisplayItem?: boolean;
+    parentStyles?: Record<string, string>;
+}
+declare const ItemLabel: react__default.NamedExoticComponent<ItemLabelProps>;
+
+interface BooleanFieldProps {
+    qItem: QuestionnaireItem;
+    readOnly: boolean;
+    valueBoolean: boolean | undefined;
+    feedback: string;
+    calcExpUpdated: boolean;
+    onCheckedChange: (newValue: string) => void;
+    onClear: () => void;
+}
+declare const BooleanField: react__default.NamedExoticComponent<BooleanFieldProps>;
+
+interface StringFieldProps extends PropsWithIsTabledRequiredAttribute {
+    linkId: string;
+    itemType: string;
+    input: string;
+    feedback: string;
+    displayPrompt: string;
+    displayUnit: string;
+    entryFormat: string;
+    readOnly: boolean;
+    calcExpUpdated: boolean;
+    onInputChange: (value: string) => void;
+}
+declare function StringField(props: StringFieldProps): react_jsx_runtime.JSX.Element;
+
+interface DecimalFieldProps extends PropsWithIsTabledRequiredAttribute {
+    linkId: string;
+    itemType: string;
+    input: string;
+    feedback: string;
+    displayPrompt: string;
+    displayUnit: string;
+    entryFormat: string;
+    readOnly: boolean;
+    calcExpUpdated: boolean;
+    onInputChange: (value: string) => void;
+}
+declare function DecimalField(props: DecimalFieldProps): react_jsx_runtime.JSX.Element;
+
+interface ChoiceRadioSingleProps {
+    value: string;
+    label: string;
+    readOnly: boolean;
+    fullWidth: boolean;
+}
+declare function ChoiceRadioSingle(props: ChoiceRadioSingleProps): react_jsx_runtime.JSX.Element;
+
+declare const FullWidthFormComponentBox: _emotion_styled.StyledComponent<_mui_system.BoxOwnProps<_mui_material_styles.Theme> & Omit<Omit<react.DetailedHTMLProps<react.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
+    ref?: ((instance: HTMLDivElement | null) => void) | react.RefObject<HTMLDivElement> | null | undefined;
+}, keyof _mui_system.BoxOwnProps<_mui_material_styles.Theme>> & _mui_system.MUIStyledCommonProps<_mui_material_styles.Theme>, {}, {}>;
+
+interface AnswerExpression {
+    expression: string;
+    value?: QuestionnaireItemAnswerOption;
+}
+
+/**
+ * InitialExpression interface
+ *
+ * @property expression - InitialExpression FHIRPath expression
+ */
+interface InitialExpression {
+    expression: string;
+}
+
+interface TargetConstraint {
+    key: string;
+    severityCode: 'error' | 'warning';
+    valueExpression: Expression;
+    human: string;
+    location?: string;
+    linkId?: string;
+    isEnabled?: boolean;
+}
+
+interface ProcessedValueSet {
+    initialValueSetUrl: string;
+    updatableValueSetUrl: string;
+    bindingParameters: BindingParameter[];
+    isDynamic: boolean;
+    linkIds: string[];
+}
+interface BindingParameter {
+    name: string;
+    value: string;
+    fhirPathExpression?: string;
+}
+
+type ComputedQRItemUpdates = Record<string, QuestionnaireResponseItem | null>;
+
+/**
+ * QuestionnaireStore properties and methods
+ * Properties can be accessed for fine-grain details.
+ * Methods are usually used internally, using them from an external source is not recommended.
+ *
+ * @property sourceQuestionnaire - FHIR R4 Questionnaire to render
+ * @property itemTypes - Key-value pair of item types `Record<linkId, item.type>`
+ * @property itemPreferredTerminologyServers - Key-value pair of item types `Record<linkId, preferred terminology servers>`
+ * @property tabs - Key-value pair of tabs `Record<linkId, Tab>`
+ * @property currentTabIndex - Index of the current tab
+ * @property pages - Key-value pair of pages `Record<linkId, Page>`
+ * @property currentPageIndex - Index of the current page
+ * @property variables - Questionnaire variables object containing FHIRPath and x-fhir-query variables
+ * @property launchContexts - Key-value pair of launch contexts `Record<launch context name, launch context properties>`
+ * @property targetConstraints - Key-value pair of target constraints `Record<target constraint key, target constraint properties>`
+ * @property targetConstraintLinkIds - Key-value pair of linkIds against target constraint key(s) `Record<linkId, target constraint keys>`
+ * @property enableWhenItems - EnableWhenItems object containing enableWhen items and their linked questions
+ * @property enableWhenLinkedQuestions - Key-value pair of linked questions to enableWhen items `Record<linkId, linkIds of linked questions>`
+ * @property enableWhenIsActivated - Flag to turn enableWhen checks on/off
+ * @property enableWhenExpressions - EnableWhenExpressions object containing enableWhen expressions
+ * @property calculatedExpressions - Key-value pair of calculated expressions `Record<linkId, array of calculated expression properties>`
+ * @property answerExpressions - Key-value pair of answer expressions `Record<linkId, answer expression properties>`
+ * @property processedValueSets - Key-value pair of (pre-)processed value set codings `Record<valueSetUrl, ProcessedValueSet>`
+ * @property cachedValueSetCodings - Key-value pair of cached value set codings `Record<valueSetUrl, codings>`
+ * @property fhirPathContext - Key-value pair of evaluated FHIRPath values `Record<variable name, evaluated value(s)>`
+ * @property fhirPathTerminologyCache - Key-value pair of cached FHIRPath Terminology results `Record<cacheKey, cached terminology result>`
+ * @property populatedContext - Key-value pair of one-off pre-populated FHIRPath values `Record<variable/launchContext/sourceQueries batch name, evaluated value(s)>`
+ * @property qItemOverrideComponents - Key-value pair of React component overrides for Questionnaire Items via linkId `Record<linkId, React component>`
+ * @property sdcUiOverrideComponents - Key-value pair of React component overrides for SDC UI Controls https://hl7.org/fhir/extensions/ValueSet-questionnaire-item-control.html `Record<SDC UI code, React component>`
+ * @property focusedLinkId - LinkId of the currently focused item
+ * @property readOnly - Flag to set the form to read-only mode
+ * @property buildSourceQuestionnaire - Used to build the source questionnaire with the provided questionnaire and optionally questionnaire response, additional variables, terminology server url and readyOnly flag
+ * @property destroySourceQuestionnaire - Used to destroy the source questionnaire and reset all properties
+ * @property switchTab - Used to switch the current tab index
+ * @property switchPage - Used to switch the current page index
+ * @property markTabAsComplete - Used to mark a tab index as complete
+ * @property markPageAsComplete - Used to mark a page index as complete
+ * @property updateEnableWhenItem - Used to update linked enableWhen items by updating a question with a new answer
+ * @property mutateRepeatEnableWhenItems - Used to add or remove instances of repeating enableWhen items
+ * @property toggleEnableWhenActivation - Used to toggle enableWhen checks on/off
+ * @property updateExpressions - Used to update all SDC expressions based on the updated questionnaire response
+ * @property addCodingToCache - Used to add a coding to the cached value set codings
+ * @property updatePopulatedProperties - Used to update all SDC expressions based on a pre-populated questionnaire response
+ * @property onFocusLinkId - Used to set the focused linkId
+ * @property setPopulatedContext - Used to set the populated contexts (launchContext, sourceQueries, x-fhir-query vars) for debugging purposes, and optionally add to the FHIRPath context
+ * @property setFormAsReadOnly - Used to set the form as read-only
+ *
+ * @author Sean Fong
+ */
+interface QuestionnaireStoreType {
+    sourceQuestionnaire: Questionnaire;
+    itemTypes: Record<string, string>;
+    itemPreferredTerminologyServers: Record<string, string>;
+    tabs: Tabs;
+    currentTabIndex: number;
+    pages: Pages;
+    currentPageIndex: number;
+    variables: Variables;
+    launchContexts: Record<string, LaunchContext>;
+    targetConstraints: Record<string, TargetConstraint>;
+    targetConstraintLinkIds: Record<string, string[]>;
+    enableWhenItems: EnableWhenItems;
+    enableWhenLinkedQuestions: Record<string, string[]>;
+    enableWhenIsActivated: boolean;
+    enableWhenExpressions: EnableWhenExpressions;
+    calculatedExpressions: Record<string, CalculatedExpression[]>;
+    initialExpressions: Record<string, InitialExpression>;
+    answerExpressions: Record<string, AnswerExpression>;
+    processedValueSets: Record<string, ProcessedValueSet>;
+    cachedValueSetCodings: Record<string, Coding[]>;
+    fhirPathContext: Record<string, any>;
+    fhirPathTerminologyCache: Record<string, any>;
+    populatedContext: Record<string, any>;
+    qItemOverrideComponents: Record<string, ComponentType<QItemOverrideComponentProps>>;
+    sdcUiOverrideComponents: Record<string, ComponentType<SdcUiOverrideComponentProps>>;
+    focusedLinkId: string;
+    readOnly: boolean;
+    buildSourceQuestionnaire: (questionnaire: Questionnaire, questionnaireResponse?: QuestionnaireResponse, additionalVariables?: Record<string, object>, terminologyServerUrl?: string, readOnly?: boolean, qItemOverrideComponents?: Record<string, ComponentType<QItemOverrideComponentProps>>, sdcUiOverrideComponents?: Record<string, ComponentType<SdcUiOverrideComponentProps>>) => Promise<void>;
+    destroySourceQuestionnaire: () => void;
+    switchTab: (newTabIndex: number) => void;
+    switchPage: (newPageIndex: number) => void;
+    markTabAsComplete: (tabLinkId: string) => void;
+    markPageAsComplete: (pageLinkId: string) => void;
+    updateEnableWhenItem: (linkId: string, newAnswer: QuestionnaireResponseItemAnswer[] | undefined, parentRepeatGroupIndex: number | null) => void;
+    mutateRepeatEnableWhenItems: (parentRepeatGroupLinkId: string, parentRepeatGroupIndex: number, actionType: 'add' | 'remove') => void;
+    toggleEnableWhenActivation: (isActivated: boolean) => void;
+    updateExpressions: (updatedResponse: QuestionnaireResponse) => Promise<ComputedQRItemUpdates>;
+    addCodingToCache: (valueSetUrl: string, codings: Coding[]) => void;
+    updatePopulatedProperties: (populatedResponse: QuestionnaireResponse, populatedContext?: Record<string, any>, persistTabIndex?: boolean) => Promise<QuestionnaireResponse>;
+    onFocusLinkId: (linkId: string) => void;
+    setPopulatedContext: (newPopulatedContext: Record<string, any>, addToFhirPathContext?: boolean) => void;
+    setFormAsReadOnly: (readOnly: boolean) => void;
+}
+/**
+ * Questionnaire state management store which contains all properties and methods to manage the state of the questionnaire.
+ * This is the vanilla version of the store which can be used in non-React environments.
+ * @see QuestionnaireStoreType for available properties and methods.
+ *
+ * @author Sean Fong
+ */
+declare const questionnaireStore: zustand_vanilla.StoreApi<QuestionnaireStoreType>;
+/**
+ * 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.
+ * @see QuestionnaireStoreType for available properties and methods.
+ * @see questionnaireStore for the vanilla store.
+ *
+ * @author Sean Fong
+ */
+declare const useQuestionnaireStore: zustand_vanilla.StoreApi<QuestionnaireStoreType> & {
+    use: {
+        sourceQuestionnaire: () => Questionnaire;
+        itemTypes: () => Record<string, string>;
+        itemPreferredTerminologyServers: () => Record<string, string>;
+        tabs: () => Tabs;
+        currentTabIndex: () => number;
+        pages: () => Pages;
+        currentPageIndex: () => number;
+        variables: () => Variables;
+        launchContexts: () => Record<string, LaunchContext>;
+        targetConstraints: () => Record<string, TargetConstraint>;
+        targetConstraintLinkIds: () => Record<string, string[]>;
+        enableWhenItems: () => EnableWhenItems;
+        enableWhenLinkedQuestions: () => Record<string, string[]>;
+        enableWhenIsActivated: () => boolean;
+        enableWhenExpressions: () => EnableWhenExpressions;
+        calculatedExpressions: () => Record<string, CalculatedExpression[]>;
+        initialExpressions: () => Record<string, InitialExpression>;
+        answerExpressions: () => Record<string, AnswerExpression>;
+        processedValueSets: () => Record<string, ProcessedValueSet>;
+        cachedValueSetCodings: () => Record<string, Coding[]>;
+        fhirPathContext: () => Record<string, any>;
+        fhirPathTerminologyCache: () => Record<string, any>;
+        populatedContext: () => Record<string, any>;
+        qItemOverrideComponents: () => Record<string, ComponentType<QItemOverrideComponentProps>>;
+        sdcUiOverrideComponents: () => Record<string, ComponentType<SdcUiOverrideComponentProps>>;
+        focusedLinkId: () => string;
+        readOnly: () => boolean;
+        buildSourceQuestionnaire: () => (questionnaire: Questionnaire, questionnaireResponse?: QuestionnaireResponse, additionalVariables?: Record<string, object>, terminologyServerUrl?: string, readOnly?: boolean, qItemOverrideComponents?: Record<string, ComponentType<QItemOverrideComponentProps>>, sdcUiOverrideComponents?: Record<string, ComponentType<SdcUiOverrideComponentProps>>) => Promise<void>;
+        destroySourceQuestionnaire: () => () => void;
+        switchTab: () => (newTabIndex: number) => void;
+        switchPage: () => (newPageIndex: number) => void;
+        markTabAsComplete: () => (tabLinkId: string) => void;
+        markPageAsComplete: () => (pageLinkId: string) => void;
+        updateEnableWhenItem: () => (linkId: string, newAnswer: QuestionnaireResponseItemAnswer[] | undefined, parentRepeatGroupIndex: number | null) => void;
+        mutateRepeatEnableWhenItems: () => (parentRepeatGroupLinkId: string, parentRepeatGroupIndex: number, actionType: 'add' | 'remove') => void;
+        toggleEnableWhenActivation: () => (isActivated: boolean) => void;
+        updateExpressions: () => (updatedResponse: QuestionnaireResponse) => Promise<ComputedQRItemUpdates>;
+        addCodingToCache: () => (valueSetUrl: string, codings: Coding[]) => void;
+        updatePopulatedProperties: () => (populatedResponse: QuestionnaireResponse, populatedContext?: Record<string, any>, persistTabIndex?: boolean) => Promise<QuestionnaireResponse>;
+        onFocusLinkId: () => (linkId: string) => void;
+        setPopulatedContext: () => (newPopulatedContext: Record<string, any>, addToFhirPathContext?: boolean) => void;
+        setFormAsReadOnly: () => (readOnly: boolean) => void;
+    };
+};
+
+/**
+ * QuestionnaireResponseStore properties and methods
+ * Properties can be accessed for fine-grain details.
+ * Methods are usually used internally, but it is possible to use them externally to hook into the renderer for more fine-grain control.
+ *
+ * @property key - The React key of the questionnaireResponse, used internally for refreshing the BaseRenderer
+ * @property sourceResponse - The original response created when the form is first initialised i.e. empty, pre-populated, opened saved draft
+ * @property updatableResponse - The current state of the response that is being updated via form fields
+ * @property updatableResponseItems - Key-value pair of updatableResponse items `Record<linkId, QR.item(s)>`
+ * @property formChangesHistory - Array of form changes history in the form of deep-diff objects
+ * @property invalidItems - Key-value pair of invalid items based on defined value constraints in the questionnaire `Record<linkId, OperationOutcome>`
+ * @property requiredItemsIsHighlighted - Required items are not highlighted by default (to provide a less-jarring UX), but can be manually toggled to be highlighted
+ * @property responseIsValid - Whether there are any invalid items in the response
+ * @property validateQuestionnaireResponse - Used to validate the questionnaire response based on the questionnaire
+ * @property buildSourceResponse - Used to build the source response when the form is first initialised
+ * @property setUpdatableResponseAsPopulated - Used to set a pre-populated response as the current response
+ * @property updateResponse - Used to update the current response
+ * @property setUpdatableResponseAsSaved - Used to set a saved response as the current response
+ * @property setUpdatableResponseAsEmpty - Used to set an empty response as the current response
+ * @property destroySourceResponse - Used to destroy the source response  and reset all properties
+ * @property highlightRequiredItems - Used to highlight invalid items and show error feedback in the UI
+ *
+ * @author Sean Fong
+ */
+interface QuestionnaireResponseStoreType {
+    key: string;
+    sourceResponse: QuestionnaireResponse;
+    updatableResponse: QuestionnaireResponse;
+    updatableResponseItems: Record<string, QuestionnaireResponseItem[]>;
+    formChangesHistory: (Diff<QuestionnaireResponse, QuestionnaireResponse>[] | null)[];
+    invalidItems: Record<string, OperationOutcome>;
+    requiredItemsIsHighlighted: boolean;
+    responseIsValid: boolean;
+    validateQuestionnaire: (questionnaire: Questionnaire, updatedResponse: QuestionnaireResponse) => void;
+    buildSourceResponse: (response: QuestionnaireResponse) => void;
+    setUpdatableResponseAsPopulated: (populatedResponse: QuestionnaireResponse) => void;
+    updateResponse: (updatedResponse: QuestionnaireResponse) => void;
+    setUpdatableResponseAsSaved: (savedResponse: QuestionnaireResponse) => void;
+    setUpdatableResponseAsEmpty: (clearedResponse: QuestionnaireResponse) => void;
+    destroySourceResponse: () => void;
+    highlightRequiredItems: () => void;
+}
+/**
+ * QuestionnaireResponse state management store which contains all properties and methods to manage the state of the questionnaireResponse.
+ * This is the vanilla version of the store which can be used in non-React environments.
+ * @see QuestionnaireResponseStoreType for available properties and methods.
+ *
+ * @author Sean Fong
+ */
+declare const questionnaireResponseStore: zustand_vanilla.StoreApi<QuestionnaireResponseStoreType>;
+/**
+ * QuestionnaireResponse 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.
+ * @see QuestionnaireResponseStoreType for available properties and methods.
+ * @see questionnaireResponseStore for the vanilla store.
+ *
+ * @author Sean Fong
+ */
+declare const useQuestionnaireResponseStore: zustand_vanilla.StoreApi<QuestionnaireResponseStoreType> & {
+    use: {
+        key: () => string;
+        sourceResponse: () => QuestionnaireResponse;
+        updatableResponse: () => QuestionnaireResponse;
+        updatableResponseItems: () => Record<string, QuestionnaireResponseItem[]>;
+        formChangesHistory: () => (Diff<QuestionnaireResponse, QuestionnaireResponse>[] | null)[];
+        invalidItems: () => Record<string, OperationOutcome>;
+        requiredItemsIsHighlighted: () => boolean;
+        responseIsValid: () => boolean;
+        validateQuestionnaire: () => (questionnaire: Questionnaire, updatedResponse: QuestionnaireResponse) => void;
+        buildSourceResponse: () => (response: QuestionnaireResponse) => void;
+        setUpdatableResponseAsPopulated: () => (populatedResponse: QuestionnaireResponse) => void;
+        updateResponse: () => (updatedResponse: QuestionnaireResponse) => void;
+        setUpdatableResponseAsSaved: () => (savedResponse: QuestionnaireResponse) => void;
+        setUpdatableResponseAsEmpty: () => (clearedResponse: QuestionnaireResponse) => void;
+        destroySourceResponse: () => () => void;
+        highlightRequiredItems: () => () => void;
+    };
+};
+
+/**
+ * SmartConfigStore properties and methods
+ * Properties can be accessed for fine-grain details.
+ * Methods are usually used internally, using them from an external source is not recommended.
+ *
+ * @property client - The FHIRClient object (https://github.com/smart-on-fhir/client-js)
+ * @property patient - The patient resource in context
+ * @property user - The user resource in context
+ * @property encounter - The encounter resource in context
+ * @property setClient - Set the FHIRClient object when launching via SMART App Launch
+ * @property setPatient - Set the patient resource in context
+ * @property setUser - Set the user resource in context
+ * @property setEncounter - Set the encounter resource in context
+ *
+ * @author Sean Fong
+ */
+interface SmartConfigStoreType {
+    client: Client | null;
+    patient: Patient | null;
+    user: Practitioner | null;
+    encounter: Encounter | null;
+    setClient: (client: Client) => void;
+    setPatient: (patient: Patient) => void;
+    setUser: (user: Practitioner) => void;
+    setEncounter: (encounter: Encounter) => void;
+}
+/**
+ * Smart Config state management store. This is only used for answerExpressions.
+ * It is recommended to manage the state of the FHIRClient, patient, user, and encounter in the parent application, since the renderer doesn't provide pre-population capabilities.
+ * Will be deprecated in version 1.0.0.
+ *
+ * This is the vanilla version of the store which can be used in non-React environments.
+ * @see SmartConfigStoreType for available properties and methods.
+ *
+ * @author Sean Fong
+ */
+declare const smartConfigStore: zustand_vanilla.StoreApi<SmartConfigStoreType>;
+/**
+ * Smart Config state management store. This is only used for answerExpressions.
+ * It is recommended to manage the state of the FHIRClient, patient, user, and encounter in the parent application, since the renderer doesn't provide pre-population capabilities.
+ * Will be deprecated in version 1.0.0.
+ *
+ * This is the React version of the store which can be used as React hooks in React functional components.
+ * @see SmartConfigStoreType for available properties and methods.
+ * @see smartConfigStore for the vanilla store.
+ *
+ * @author Sean Fong
+ */
+declare const useSmartConfigStore: zustand_vanilla.StoreApi<SmartConfigStoreType> & {
+    use: {
+        client: () => Client | null;
+        patient: () => Patient | null;
+        user: () => Practitioner | null;
+        encounter: () => Encounter | null;
+        setClient: () => (client: Client) => void;
+        setPatient: () => (patient: Patient) => void;
+        setUser: () => (user: Practitioner) => void;
+        setEncounter: () => (encounter: Encounter) => void;
+    };
+};
+
+/**
+ * TerminologyServerStore properties and methods
+ * Properties can be accessed for fine-grain details.
+ * Methods are usually used internally, using them from an external source is not recommended.
+ *
+ * @property url - The current terminology server URL
+ * @property setUrl - Set the terminology server URL
+ * @property resetUrl - Reset the terminology server URL to the default
+ *
+ * @author Sean Fong
+ */
+interface TerminologyServerStoreType {
+    url: string;
+    setUrl: (newUrl: string) => void;
+    resetUrl: () => void;
+}
+/**
+ * Terminology server state management store. This is used for resolving valueSets externally.
+ * Defaults to use https://tx.ontoserver.csiro.au/fhir.
+ * This is the vanilla version of the store which can be used in non-React environments.
+ * @see TerminologyServerStoreType for available properties and methods.
+ *
+ * @author Sean Fong
+ */
+declare const terminologyServerStore: zustand_vanilla.StoreApi<TerminologyServerStoreType>;
+/**
+ * Terminology server state management store. This is used for resolving valueSets externally.
+ * Defaults to use https://tx.ontoserver.csiro.au/fhir.
+ * This is the React version of the store which can be used as React hooks in React functional components.
+ * @see TerminologyServerStoreType for available properties and methods.
+ *
+ * @author Sean Fong
+ */
+declare const useTerminologyServerStore: zustand_vanilla.StoreApi<TerminologyServerStoreType> & {
+    use: {
+        url: () => string;
+        setUrl: () => (newUrl: string) => void;
+        resetUrl: () => () => void;
+    };
+};
+
+/**
+ * React hook to determine if a QuestionnaireItem is hidden via item.hidden, enableWhens, enableWhenExpressions.
+ * When checking for repeating group enableWhen items, the parentRepeatGroupIndex should be provided.
+ *
+ * @author Sean Fong
+ */
+declare function useHidden(qItem: QuestionnaireItem, parentRepeatGroupIndex?: number): boolean;
+
+declare function useReadOnly(qItem: QuestionnaireItem, parentIsReadOnly: boolean | undefined, parentRepeatGroupIndex?: number): boolean;
+
+/**
+ * React hook wrapping around the buildForm() function to build a form from a questionnaire and an optional QuestionnaireResponse.
+ * @see buildForm() for more information.
+ *
+ * @param questionnaire - Questionnaire to be rendered
+ * @param questionnaireResponse - Pre-populated/draft/loaded QuestionnaireResponse to be rendered (optional)
+ * @param readOnly - Applies read-only mode to all items in the form view
+ * @param terminologyServerUrl - Terminology server url to fetch terminology. If not provided, the default terminology server will be used. (optional)
+ * @param additionalVariables - Additional key-value pair of SDC variables `Record<name, variable extension>` for testing (optional)
+ * @param rendererStylingOptions - Renderer styling to be applied to the form. See docs for styling options. (optional)
+ * @param qItemOverrideComponents - FIXME add comment
+ * @param sdcUiOverrideComponents - FIXME add comment
+ *
+ *
+ * @author Sean Fong
+ */
+declare function useBuildForm(questionnaire: Questionnaire, questionnaireResponse?: QuestionnaireResponse, readOnly?: boolean, terminologyServerUrl?: string, additionalVariables?: Record<string, object>, rendererStylingOptions?: RendererStyling, qItemOverrideComponents?: Record<string, ComponentType<QItemOverrideComponentProps>>, sdcUiOverrideComponents?: Record<string, ComponentType<SdcUiOverrideComponentProps>>): boolean;
+
+/**
+ * Default QueryClient used by the renderer.
+ * You can customise your own QueryClient with your own options, use v4 of @tanstack/react-query.
+ * @see {@link https://tanstack.com/query/v4/docs/reference/QueryClient}
+ *
+ * @author Sean Fong
+ */
+declare function useRendererQueryClient(): QueryClient;
+
+declare function useValidationFeedback(qItem: QuestionnaireItem, feedbackFromParent: string | undefined, input: string): string;
+
+interface TerminologyError {
+    error: Error | null;
+    answerValueSet: string;
+}
+declare function useValueSetCodings(qItem: QuestionnaireItem): {
+    codings: Coding[];
+    terminologyError: TerminologyError;
+    dynamicCodingsUpdated: boolean;
+};
+
+interface UseStringCalculatedExpression {
+    calcExpUpdated: boolean;
+}
+interface useStringCalculatedExpressionProps {
+    qItem: QuestionnaireItem;
+    inputValue: string;
+    onChangeByCalcExpressionString: (newValueString: string) => void;
+    onChangeByCalcExpressionNull: () => void;
+}
+declare function useStringCalculatedExpression(props: useStringCalculatedExpressionProps): UseStringCalculatedExpression;
+
+declare function useDisplayCqfAndCalculatedExpression(qItem: QuestionnaireItem): string | null;
+
+interface UseCodingCalculatedExpression {
+    calcExpUpdated: boolean;
+}
+interface UseCodingCalculatedExpressionProps {
+    qItem: QuestionnaireItem;
+    valueInString: string;
+    onChangeByCalcExpressionString: (newValueInString: string) => void;
+    onChangeByCalcExpressionNull: () => void;
+}
+declare function useCodingCalculatedExpression(props: UseCodingCalculatedExpressionProps): UseCodingCalculatedExpression;
+declare function objectIsCoding(obj: any): obj is Coding;
+
+/**
+ * Props for the useResponsive() hook -  used to determine if the screen size matches a given breakpoint query.
+ *
+ * @param {'up' | 'down' | 'between' | 'only'} query - The type of query:
+ *   - `'up'`: Matches screen sizes above and including `start`.
+ *   - `'down'`: Matches screen sizes below and including `start`.
+ *   - `'between'`: Matches screen sizes between `start` and `end` (inclusive).
+ *   - `'only'`: Matches exactly the `start` size.
+ * @param {'xs' | 'sm' | 'md' | 'lg' | 'xl'} start - The starting breakpoint - can be extended via MUI BreakpointOverrides.
+ * @param {'xs' | 'sm' | 'md' | 'lg' | 'xl'} end - The ending breakpoint (required if `query` is `'between'`) - can be extended via MUI BreakpointOverrides.
+ *
+ * @example
+ * // Check if the screen size is at least 'md' (medium)
+ * const isMdUp = useResponsive({ query: 'up', start: 'md' });
+ *
+ * @example
+ * // Check if the screen size is exactly 'lg' (large)
+ * const isLgOnly = useResponsive({ query: 'only', start: 'lg' });
+ *
+ * @example
+ * // Check if the screen size is at least 'tablet' - this is a custom breakpoint https://mui.com/material-ui/customization/breakpoints/#custom-breakpoints
+ * const isTabletUp = useResponsive({ query: 'up', start: 'tablet' });
+ **/
+interface UseResponsiveProps {
+    query: 'up' | 'down' | 'between' | 'only';
+    start: Breakpoint;
+    end?: Breakpoint;
+}
+/**
+ * A hook to determine if the screen size matches a given breakpoint query.
+ *
+ * @param props - The responsive query options.
+ *
+ * @returns {boolean} `true` if the current screen size matches the query, otherwise `false`.
+ *
+ * @example
+ * // Check if the screen size is at least 'md' (medium)
+ * const isMdUp = useResponsive({ query: 'up', start: 'md' });
+ *
+ * @example
+ * // Check if the screen size is exactly 'lg' (large)
+ * const isLgOnly = useResponsive({ query: 'only', start: 'lg' });
+ *
+ * @example
+ * // Check if the screen size is at least 'tablet' - this is a custom breakpoint https://mui.com/material-ui/customization/breakpoints/#custom-breakpoints
+ * const isTabletUp = useResponsive({ query: 'up', start: 'tablet' });
+ */
+declare function useResponsive(props: UseResponsiveProps): boolean;
+
+/**
+ * RendererStyling interface
+ * Provides fine-grained control over the styling and behaviour of the renderer.
+ *
+ * @property requiredIndicatorPosition - Defines where the required asterisk (*) is placed relative to the label.
+ *   - `"start"` (default): Asterisk appears before the label.
+ *   - `"end"`: Asterisk appears after the label.
+ *
+ * @property itemResponsive - Controls responsive layout settings for item labels and fields.
+ *   @property labelBreakpoints - Defines breakpoints for label width at different screen sizes.
+ *     - Default: `{ xs: 12, md: 4 }`
+ *   @property fieldBreakpoints - Defines breakpoints for field width at different screen sizes.
+ *     - Default: `{ xs: 12, md: 8 }`
+ *   @property columnGapPixels - Spacing (in pixels) between the label and the field.
+ *     - Default: `32`
+ *   @property rowGapPixels - Vertical spacing (in pixels) between stacked items.
+ *     - Default: `4`
+ *
+ * @property showTabbedFormAt - Defines when the form should switch to a tabbed layout based on screen size.
+ *   - Default: `{ query: 'up', start: 'md' }`
+ *
+ * @property tabListWidthOrResponsive - Configures the width of the tab list, either as a fixed number or responsive breakpoints.
+ *   - Default: `{ tabListBreakpoints: { xs: 12, sm: 3, md: 3, lg: 2.75 }, tabContentBreakpoints: { xs: 12, sm: 9, md: 9, lg: 9.25 } }`
+ *
+ * @property textFieldWidth - Defines the default width for text input fields (in pixels).
+ *   - Default: `320`
+ *
+ * @property inputsFlexGrow - Determines whether input fields should grow to fill available space.
+ *   - `false` (default): Inputs maintain their default size.
+ *   - `true`: Inputs expand to fill space.
+ *
+ * @property reverseBooleanYesNo - If `true`, swaps "Yes" and "No" options for boolean fields.
+ *   - Default: `false`
+ *
+ * @property hideClearButton - If `true`, hides the clear button on input fields.
+ *   - Default: `false`
+ *
+ * @property hideQuantityComparatorField - If `true`, hides the quantity comparator field.
+ *   - Default: `false`
+ *
+ * @property enableWhenAsReadOnly - Determines whether fields hidden by `enableWhen` logic should still be shown as read-only.
+ *   - Can be `true` (all fields affected) or a `Set<QuestionnaireItem['type']>` to specify types.
+ *   - Default: `false`
+ *
+ * @property disablePageCardView - If `true`, disables the card-style layout for pages.
+ *   - Default: `false`
+ *
+ * @property disablePageButtons - If `true`, hides navigation buttons for pages.
+ *   - Default: `false`
+ *
+ * @property disableTabButtons - If `true`, hides navigation buttons for tabs.
+ *   - Default: `false`
+ *
+ * @property readOnlyVisualStyle - If `true`, item.readOnly will result in form fields having MUI disabled property and styles (recommended from usability perspective). If `false`, item.readOnly will result in form fields having HTML readonly property (less stable, but recommended from accessibility perspective).
+ *   - Default: `true`
+ */
+interface RendererStyling {
+    readOnlyVisualStyle?: 'disabled' | 'readonly';
+    requiredIndicatorPosition?: 'start' | 'end';
+    itemResponsive?: {
+        labelBreakpoints: Partial<Breakpoints['values']>;
+        fieldBreakpoints: Partial<Breakpoints['values']>;
+        columnGapPixels: number;
+        rowGapPixels: number;
+    };
+    showTabbedFormAt?: UseResponsiveProps;
+    tabListWidthOrResponsive?: number | {
+        tabListBreakpoints: Partial<Breakpoints['values']>;
+        tabContentBreakpoints: Partial<Breakpoints['values']>;
+    };
+    textFieldWidth?: number;
+    inputsFlexGrow?: boolean;
+    reverseBooleanYesNo?: boolean;
+    hideClearButton?: boolean;
+    hideQuantityComparatorField?: boolean;
+    enableWhenAsReadOnly?: boolean | Set<QuestionnaireItem['type']>;
+    disablePageCardView?: boolean;
+    disablePageButtons?: boolean;
+    disableTabButtons?: boolean;
+}
+/**
+ * RendererStylingStore properties and methods
+ *
+ * @author Sean Fong
+ */
+interface RendererStylingStoreType {
+    readOnlyVisualStyle: 'disabled' | 'readonly';
+    requiredIndicatorPosition: 'start' | 'end';
+    itemResponsive: {
+        labelBreakpoints: Partial<Breakpoints['values']>;
+        fieldBreakpoints: Partial<Breakpoints['values']>;
+        columnGapPixels: number;
+        rowGapPixels: number;
+    };
+    tabListWidthOrResponsive: number | {
+        tabListBreakpoints: Partial<Breakpoints['values']>;
+        tabContentBreakpoints: Partial<Breakpoints['values']>;
+    };
+    showTabbedFormAt: UseResponsiveProps;
+    textFieldWidth: number;
+    inputsFlexGrow: boolean;
+    reverseBooleanYesNo: boolean;
+    hideClearButton: boolean;
+    hideQuantityComparatorField: boolean;
+    enableWhenAsReadOnly: boolean | Set<QuestionnaireItem['type']>;
+    disablePageCardView: boolean;
+    disablePageButtons: boolean;
+    disableTabButtons: boolean;
+    setRendererStyling: (params: RendererStyling) => void;
+}
+/**
+ * @author Sean Fong
+ */
+declare const rendererStylingStore: zustand_vanilla.StoreApi<RendererStylingStoreType>;
+declare const useRendererStylingStore: zustand_vanilla.StoreApi<RendererStylingStoreType> & {
+    use: {
+        readOnlyVisualStyle: () => "disabled" | "readonly";
+        requiredIndicatorPosition: () => "start" | "end";
+        itemResponsive: () => {
+            labelBreakpoints: Partial<Breakpoints['values']>;
+            fieldBreakpoints: Partial<Breakpoints['values']>;
+            columnGapPixels: number;
+            rowGapPixels: number;
+        };
+        tabListWidthOrResponsive: () => number | {
+            tabListBreakpoints: Partial<Breakpoints['values']>;
+            tabContentBreakpoints: Partial<Breakpoints['values']>;
+        };
+        showTabbedFormAt: () => UseResponsiveProps;
+        textFieldWidth: () => number;
+        inputsFlexGrow: () => boolean;
+        reverseBooleanYesNo: () => boolean;
+        hideClearButton: () => boolean;
+        hideQuantityComparatorField: () => boolean;
+        enableWhenAsReadOnly: () => boolean | Set<"string" | "boolean" | "group" | "display" | "question" | "decimal" | "integer" | "date" | "dateTime" | "time" | "text" | "url" | "choice" | "open-choice" | "attachment" | "reference" | "quantity">;
+        disablePageCardView: () => boolean;
+        disablePageButtons: () => boolean;
+        disableTabButtons: () => boolean;
+        setRendererStyling: () => (params: RendererStyling) => void;
+    };
+};
+
+/**
+ * Build the form with an initial Questionnaire and an optional filled QuestionnaireResponse.
+ * If a QuestionnaireResponse is not provided, an empty QuestionnaireResponse is set as the initial QuestionnaireResponse.
+ * There are other optional properties such as applying readOnly, providing a terminology server url and additional variables.
+ *
+ * @param questionnaire - Questionnaire to be rendered
+ * @param questionnaireResponse - Pre-populated/draft/loaded QuestionnaireResponse to be rendered (optional)
+ * @param readOnly - Applies read-only mode to all items in the form view
+ * @param terminologyServerUrl - Terminology server url to fetch terminology. If not provided, the default terminology server will be used. (optional)
+ * @param additionalVariables - Additional key-value pair of SDC variables `Record<name, variable extension>` for testing (optional)
+ * @param qItemOverrideComponents - FIXME add comment
+ * @param sdcUiOverrideComponents - FIXME add comment
+ *
+ * @author Sean Fong
+ */
+declare function buildForm(questionnaire: Questionnaire, questionnaireResponse?: QuestionnaireResponse, readOnly?: boolean, terminologyServerUrl?: string, additionalVariables?: Record<string, object>, qItemOverrideComponents?: Record<string, ComponentType<QItemOverrideComponentProps>>, sdcUiOverrideComponents?: Record<string, ComponentType<SdcUiOverrideComponentProps>>): Promise<void>;
+/**
+ * Destroy the form to clean up the questionnaire and questionnaireResponse stores.
+ *
+ * @author Sean Fong
+ */
+declare function destroyForm(): void;
+/**
+ * Get the filled QuestionnaireResponse at its current state.
+ * If no changes have been made to the form, the initial QuestionnaireResponse is returned.
+ *
+ * @author Sean Fong
+ */
+declare function getResponse(): QuestionnaireResponse;
+/**
+ * Remove all empty/hidden answers from the filled QuestionnaireResponse.
+ * This takes into account enableWhens, enableWhenExpressions, items without item.answer, empty item.answer arrays and empty strings.
+ * This does not remove items that are hidden by the http://hl7.org/fhir/StructureDefinition/questionnaire-hidden extension.
+ *
+ * @author Sean Fong
+ */
+declare function removeEmptyAnswersFromResponse(questionnaire: Questionnaire, questionnaireResponse: QuestionnaireResponse): QuestionnaireResponse;
+/**
+ * Remove all instances of item.answer.id from the filled QuestionnaireResponse.
+ * These IDs are used internally for rendering repeating items, and can be safely left out of the final response.
+ *
+ * @author Sean Fong
+ */
+declare function removeInternalIdsFromResponse(questionnaire: Questionnaire, questionnaireResponse: QuestionnaireResponse): QuestionnaireResponse;
+
+/**
+ * Initialise a questionnaireResponse from a given questionnaire
+ * optionally takes in an existing questionnaireResponse to be initialised
+ *
+ * @author Sean Fong
+ */
+declare function initialiseQuestionnaireResponse(questionnaire: Questionnaire, questionnaireResponse?: QuestionnaireResponse): QuestionnaireResponse;
+
+/**
+ * Create an empty group qrItem from a given group qItem
+ *
+ * @author Sean Fong
+ */
+declare function createEmptyQrGroup(qItem: QuestionnaireItem): QuestionnaireResponseItem;
+/**
+ * Create an empty qrItem from a given qItem, optionally with an answer key
+ *
+ * @author Sean Fong
+ */
+declare function createEmptyQrItem(qItem: QuestionnaireItem, answerKey: string | undefined): QuestionnaireResponseItem;
+/**
+ * Updates the QuestionnaireResponseItem group by adding/removing a new/modified child QuestionnaireResponseItem into/from a qrGroup
+ * Takes either a single newQrItem or an array of newQrItems
+ *
+ * @author Sean Fong
+ */
+declare function updateQrItemsInGroup(newQrItem: QuestionnaireResponseItem | null, newQrRepeatGroup: QrRepeatGroup | null, questionnaireResponseOrQrItem: QuestionnaireResponseItem | QuestionnaireResponse, qItemsIndexMap: Record<string, number>): void;
+
+/**
+ * Generate an array of QuestionnaireResponseItems corresponding to its QuestionnaireItem indexes an array.
+ * QuestionnaireItems without a corresponding QuestionnaireResponseItem is set as undefined.
+ * i.e. QItems = [QItem0, QItem1, QItem2]. Only QItem0 and QItem2 have QrItems
+ * Generated array: [QrItem0, undefined, QrItem2]
+ * Note: There's a bug where if the qItems are child items from a repeat group, the function fails at the isRepeatGroup line.
+ *       Ensure that repeat groups are handled prior to calling this function.
+ *
+ * @author Sean Fong
+ */
+declare function getQrItemsIndex(qItems: QuestionnaireItem[], qrItems: QuestionnaireResponseItem[], qItemsIndexMap: Record<string, number>): (QuestionnaireResponseItem | QuestionnaireResponseItem[] | undefined)[];
+/**
+ * Generate a dictionary of QuestionnaireItems linkIds mapped to their respective array indexes `<linkId, QItemIndex>`
+ * i.e. `{ ee2589d5: 0, f9aaa187: 1, 88cab112: 2 }`
+ * where ee2589d5, f9aaa187 and 88cab112 are linkIds of QItem0, QItem1 and QItem2 respectively
+ *
+ * @author Sean Fong
+ */
+declare function mapQItemsIndex(questionnaireOrQItem: QuestionnaireItem | Questionnaire): Record<string, number>;
+
+/**
+ * Check if the extension has an itemControl code equal to the given itemControlCode
+ *
+ * @author Sean Fong
+ */
+declare function isSpecificItemControl(qItem: QuestionnaireItem, itemControlCode: string): boolean;
+/**
+ * Check if the decimal value has a quantity precision for the decimal value
+ *
+ * @author Sean Fong
+ */
+declare function getDecimalPrecision(qItem: QuestionnaireItem): number | null;
+
+interface isHiddenByEnableWhensParams {
+    linkId: string;
+    enableWhenIsActivated: boolean;
+    enableWhenItems: EnableWhenItems;
+    enableWhenExpressions: EnableWhenExpressions;
+    parentRepeatGroupIndex?: number;
+}
+declare function isHiddenByEnableWhen(params: isHiddenByEnableWhensParams): boolean;
+/**
+ * Check if qItem is a repeat item AND if it isn't a checkbox item
+ * Note: repeat checkbox items are rendered as multi-select checkbox instead of being rendered as a traditional repeat item
+ *
+ * @author Sean Fong
+ */
+declare function isRepeatItemAndNotCheckbox(qItem: QuestionnaireItem): boolean;
+
+declare function parseDecimalStringWithPrecision(input: string, precision: number | null): string;
+declare function parseDecimalStringToFloat(input: string, precision: number): number;
+
+/**
+ * ItemToRepopulate interface
+ *
+ * @property qItem - The QuestionnaireItem to repopulate
+ * @property heading - The heading of the group to repopulate
+ * @property newQRItem - The new QuestionnaireResponseItem to replace the old one
+ * @property oldQRItem - The old QuestionnaireResponseItem to be replaced
+ * @property newQRItems - The new QuestionnaireResponseItems to replace the old ones
+ * @property oldQRItems - The old QuestionnaireResponseItems to be replaced
+ *
+ * @author Sean Fong
+ */
+interface ItemToRepopulate {
+    qItem: QuestionnaireItem | null;
+    heading: string | null;
+    newQRItem?: QuestionnaireResponseItem;
+    oldQRItem?: QuestionnaireResponseItem;
+    newQRItems?: QuestionnaireResponseItem[];
+    oldQRItems?: QuestionnaireResponseItem[];
+}
+/**
+ * Compare latest data from the server with the current QuestionnaireResponse and decide items to re-populate
+ *
+ * @author Sean Fong
+ */
+declare function generateItemsToRepopulate(populatedResponse: QuestionnaireResponse): Record<string, ItemToRepopulate>;
+
+/**
+ * Re-populate checked items in the re-population dialog into the current QuestionnaireResponse
+ *
+ * @author Sean Fong
+ */
+declare function repopulateResponse(checkedItemsToRepopulate: Record<string, ItemToRepopulate>): fhir_r4.QuestionnaireResponse;
+
+/**
+ * Extract an array of Observations from a QuestionnaireResponse and its source Questionnaire.
+ * @see https://build.fhir.org/ig/HL7/sdc/extraction.html#observation-based-extraction
+ *
+ * @author Riza Nafis
+ */
+declare function extractObservationBased(questionnaire: Questionnaire, questionnaireResponse: QuestionnaireResponse): Observation[];
+
+declare function getQuestionnaireItem(questionnaire: Questionnaire, targetLinkId: string): QuestionnaireItem | null;
+
+/**
+ * Default theme used by the renderer using Material UI. You can customise your own theme by defining a new ThemeProvider.
+ * @see {@link https://mui.com/material-ui/customization/theming/}
+ *
+ * @author Sean Fong
+ */
+declare function RendererThemeProvider({ children }: {
+    children: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+
+declare const themeOptions: ThemeOptions;
+
+interface InitialiseFormWrapperProps {
+    questionnaire: Questionnaire;
+    questionnaireResponse?: QuestionnaireResponse;
+    readOnly?: boolean;
+    terminologyServerUrl?: string;
+    additionalVariables?: Record<string, object>;
+    fhirClient?: Client;
+}
+/**
+ * This is a one-to-one replacement for the SmartFormsRenderer for demo purposes.
+ * Instead of using this React component, define your own wrapper component that uses the BaseRenderer directly.
+ * Things to note:
+ * - It is required to wrap the BaseRenderer with the QueryClientProvider to make requests.
+ * - You can wrap the BaseRenderer with the RendererThemeProvider to apply the default renderer theme used in Smart Forms. Optionally, you can define your own ThemeProvider https://mui.com/material-ui/customization/theming/.
+ * - Make your buildForm() call in a button click or other event handler. Alternatively, you can use the useInitialiseForm hook to initialise the form.
+ * - Make your own initialiseFhirClient() call in a button click or other event handler. Alternatively, you can use the useInitialiseForm hook to initialise the form.
+ * - The initialised FHIRClient is only used for further FHIR calls. It does not provide pre-population capabilities.
+ *
+ * For button click usage examples of buildForm(), see:
+ * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/storybookWrappers/BuildFormButtonTesterWrapperForStorybook.tsx
+ * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/storybookWrappers/BuildFormButtonForStorybook.tsx
+ * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/storybookWrappers/PrePopWrapperForStorybook.tsx
+ * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/storybookWrappers/PrePopButtonForStorybook.tsx
+ *
+ * @author Sean Fong
+ */
+declare function InitialiseFormWrapperForStorybook(props: InitialiseFormWrapperProps): react_jsx_runtime.JSX.Element;
+
+export { BaseRenderer, BooleanField, type CalculatedExpression, ChoiceRadioSingle, DecimalField, FullWidthFormComponentBox, GridGroup, GroupItem, GroupTable, InitialiseFormWrapperForStorybook, type InitialiseFormWrapperProps, ItemFieldGrid, ItemLabel, type ItemToRepopulate, type LaunchContext, type QItemOverrideComponentProps, type QuestionnaireResponseStoreType, type QuestionnaireStoreType, type RendererStyling, type RendererStylingStoreType, RendererThemeProvider, RepeatGroup, RepeatItem, type SdcUiOverrideComponentProps, SingleItem, type SmartConfigStoreType, SmartFormsRenderer, type SmartFormsRendererProps, StringField, type Tab, type Tabs, type TerminologyServerStoreType, type UseResponsiveProps, type VariableXFhirQuery, type Variables, buildForm, createEmptyQrGroup, createEmptyQrItem, destroyForm, extractObservationBased, generateItemsToRepopulate, getDecimalPrecision, getQrItemsIndex, getQuestionnaireItem, getResponse, initialiseQuestionnaireResponse, isHiddenByEnableWhen, isRepeatItemAndNotCheckbox, isSpecificItemControl, mapQItemsIndex, objectIsCoding, parseDecimalStringToFloat, parseDecimalStringWithPrecision, parseFhirDateToDisplayDate, questionnaireResponseStore, questionnaireStore, removeEmptyAnswersFromResponse, removeInternalIdsFromResponse, rendererStylingStore, repopulateResponse, smartConfigStore, terminologyServerStore, themeOptions, updateQrItemsInGroup, useBuildForm, useCodingCalculatedExpression, useDisplayCqfAndCalculatedExpression, useHidden, useQuestionnaireResponseStore, useQuestionnaireStore, useReadOnly, useRendererQueryClient, useRendererStylingStore, useRenderingExtensions, useResponsive, useSmartConfigStore, useStringCalculatedExpression, useTerminologyServerStore, useValidationFeedback, useValueSetCodings };