@medplum/react 4.3.3 → 4.3.4

package/dist/cjs/index.d.ts

@@ -72,6 +72,7 @@ import { Schedule } from '@medplum/fhirtypes';
 import { SearchParameter } from '@medplum/fhirtypes';
 import { SearchRequest } from '@medplum/core';
 import { ServiceRequest } from '@medplum/fhirtypes';
+import { Signature } from '@medplum/fhirtypes';
 import { Slot } from '@medplum/fhirtypes';
 import { StructureDefinition } from '@medplum/fhirtypes';
 import { Subscription } from '@medplum/fhirtypes';
@@ -378,7 +379,7 @@ export declare function buildFieldNameString(key: string): string;
 
 export declare function buildInitialResponse(questionnaire: Questionnaire, questionnaireResponse?: QuestionnaireResponse): QuestionnaireResponse;
 
-export declare function buildInitialResponseItem(item: QuestionnaireItem, questionnaireResponseItem?: QuestionnaireResponseItem[]): QuestionnaireResponseItem;
+export declare function buildInitialResponseItem(item: QuestionnaireItem): QuestionnaireResponseItem;
 
 export declare function CalendarInput(props: CalendarInputProps): JSX.Element;
 
@@ -624,7 +625,17 @@ export declare interface ErrorBoundaryState {
     readonly lastLocation: string;
 }
 
-export declare function evaluateCalculatedExpressionsInQuestionnaire(items: QuestionnaireItem[], response: QuestionnaireResponse | undefined): QuestionnaireResponseItem[];
+/**
+ * Evaluates the calculated expressions in a questionnaire.
+ * Updates response item answers in place with the calculated values.
+ *
+ * See: https://build.fhir.org/ig/HL7/sdc/StructureDefinition-sdc-questionnaire-calculatedExpression.html
+ *
+ * @param items - The questionnaire items to evaluate.
+ * @param response - The questionnaire response to evaluate against.
+ * @param responseItems - The response items to update.
+ */
+export declare function evaluateCalculatedExpressionsInQuestionnaire(items: QuestionnaireItem[], response: QuestionnaireResponse, responseItems?: QuestionnaireResponseItem[] | undefined): void;
 
 /**
  * Creates a Blob object from the JSON object given and downloads the object.
@@ -699,20 +710,6 @@ export declare function getItemInitialValue(initial: QuestionnaireItemInitial |
 
 export declare function getNewMultiSelectValues(selected: string[], propertyName: string, item: QuestionnaireItem): QuestionnaireResponseItemAnswer[];
 
-/**
- * Returns the number of pages in the questionnaire.
- *
- * By default, a questionnaire is represented as a simple single page questionnaire,
- * so the default return value is 1.
- *
- * If the questionnaire has a page extension on the first item, then the number of pages
- * is the number of top level items in the questionnaire.
- *
- * @param questionnaire - The questionnaire to get the number of pages for.
- * @returns The number of pages in the questionnaire. Default is 1.
- */
-export declare function getNumberOfPages(questionnaire: Questionnaire): number;
-
 /**
  * Returns a string representing the operation.
  * @param op - The operation code.
@@ -722,7 +719,7 @@ export declare function getOpString(op: Operator): string;
 
 /**
  * Returns the reference filter for the given questionnaire item.
- * @see https://build.fhir.org/ig/HL7/fhir-extensions//StructureDefinition-questionnaire-referenceFilter-definitions.html
+ * @see https://build.fhir.org/ig/HL7/fhir-extensions/StructureDefinition-questionnaire-referenceFilter-definitions.html
  * @param item - The questionnaire item to get the reference filter for.
  * @param subject - Optional subject reference.
  * @param encounter - Optional encounter reference.
@@ -837,8 +834,19 @@ export declare function isAuxClick(e: MouseEvent_2): boolean;
  */
 export declare function isCheckboxCell(el: Element): boolean;
 
+/**
+ * Returns true if the item is a choice question.
+ * @param item - The questionnaire item to check.
+ * @returns True if the item is a choice question, false otherwise.
+ */
 export declare function isChoiceQuestion(item: QuestionnaireItem): boolean;
 
+/**
+ * Returns true if the questionnaire item is enabled based on the enableWhen conditions or expression.
+ * @param item - The questionnaire item to check.
+ * @param questionnaireResponse - The questionnaire response to check against.
+ * @returns True if the question is enabled, false otherwise.
+ */
 export declare function isQuestionEnabled(item: QuestionnaireItem, questionnaireResponse: QuestionnaireResponse | undefined): boolean;
 
 export declare function isSortDescending(definition: SearchRequest): boolean;
@@ -921,8 +929,6 @@ export declare const MemoizedFhirPathTable: MemoExoticComponent<typeof FhirPathT
  */
 export declare const MemoizedSearchControl: typeof SearchControl;
 
-export declare function mergeUpdatedItems(mergedItems: QuestionnaireResponseItem[], updatedItems: QuestionnaireResponseItem[]): QuestionnaireResponseItem[];
-
 export declare function MoneyDisplay(props: MoneyDisplayProps): JSX.Element | null;
 
 export declare interface MoneyDisplayProps {
@@ -1062,6 +1068,22 @@ export declare interface QuantityInputProps extends ComplexTypeInputProps<Quanti
     readonly disableWheel?: boolean;
 }
 
+export declare const QUESTIONNAIRE_CALCULATED_EXPRESSION_URL = "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-calculatedExpression";
+
+export declare const QUESTIONNAIRE_ENABLED_WHEN_EXPRESSION_URL = "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression";
+
+export declare const QUESTIONNAIRE_ITEM_CONTROL_URL = "http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl";
+
+export declare const QUESTIONNAIRE_REFERENCE_FILTER_URL = "http://hl7.org/fhir/StructureDefinition/questionnaire-referenceFilter";
+
+export declare const QUESTIONNAIRE_REFERENCE_RESOURCE_URL = "http://hl7.org/fhir/StructureDefinition/questionnaire-referenceResource";
+
+export declare const QUESTIONNAIRE_SIGNATURE_REQUIRED_URL = "http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired";
+
+export declare const QUESTIONNAIRE_SIGNATURE_RESPONSE_URL = "http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature";
+
+export declare const QUESTIONNAIRE_VALIDATION_ERROR_URL = "http://hl7.org/fhir/StructureDefinition/questionnaire-validationError";
+
 export declare function QuestionnaireBuilder(props: QuestionnaireBuilderProps): JSX.Element | null;
 
 export declare interface QuestionnaireBuilderProps {
@@ -1072,10 +1094,67 @@ export declare interface QuestionnaireBuilderProps {
 
 export declare function QuestionnaireForm(props: QuestionnaireFormProps): JSX.Element | null;
 
-export declare const QuestionnaireFormContext: Context<    {
-subject?: Reference;
-encounter?: Reference<Encounter>;
-}>;
+export declare interface QuestionnaireFormLoadedState {
+    /** Not loading */
+    readonly loading: false;
+    /** The loaded questionnaire */
+    questionnaire: Questionnaire;
+    /** The current draft questionnaire response */
+    questionnaireResponse: QuestionnaireResponse;
+    /** Optional questionnaire subject */
+    subject?: Reference;
+    /** Optional questionnaire encounter */
+    encounter?: Reference<Encounter>;
+    /** The top level items for the current page */
+    items: QuestionnaireItem[];
+    /** The response items for the current page */
+    responseItems: QuestionnaireResponseItem[];
+    /**
+     * Adds a new group item to the current context.
+     * @param context - The current context of the questionnaire response items.
+     * @param item - The questionnaire item that is being added to the group.
+     */
+    onAddGroup: (context: QuestionnaireResponseItem[], item: QuestionnaireItem) => void;
+    /**
+     * Adds an answer to a repeating item.
+     * @param context - The current context of the questionnaire response items.
+     * @param item - The questionnaire item that is being answered.
+     */
+    onAddAnswer: (context: QuestionnaireResponseItem[], item: QuestionnaireItem) => void;
+    /**
+     * Changes an answer value.
+     * @param context - The current context of the questionnaire response items.
+     * @param item - The questionnaire item that is being answered.
+     * @param answer - The answer(s) provided by the user for the questionnaire item.
+     */
+    onChangeAnswer: (context: QuestionnaireResponseItem[], item: QuestionnaireItem, answer: QuestionnaireResponseItemAnswer[]) => void;
+    /**
+     * Sets or updates the signature for the questionnaire response.
+     * @param signature - The signature to set, or undefined to clear the signature.
+     */
+    onChangeSignature: (signature: Signature | undefined) => void;
+}
+
+export declare interface QuestionnaireFormLoadingState {
+    /** Currently loading data such as the Questionnaire or the QuestionnaireResponse default value */
+    readonly loading: true;
+}
+
+export declare interface QuestionnaireFormPage {
+    readonly linkId: string;
+    readonly title: string;
+    readonly group: QuestionnaireItem & {
+        type: 'group';
+    };
+}
+
+export declare interface QuestionnaireFormPaginationState extends QuestionnaireFormLoadedState {
+    readonly pagination: true;
+    pages: QuestionnaireFormPage[];
+    activePage: number;
+    onNextPage: () => void;
+    onPrevPage: () => void;
+}
 
 export declare interface QuestionnaireFormProps {
     readonly questionnaire: Questionnaire | Reference<Questionnaire>;
@@ -1090,6 +1169,12 @@ export declare interface QuestionnaireFormProps {
     readonly onSubmit?: (response: QuestionnaireResponse) => void;
 }
 
+export declare interface QuestionnaireFormSinglePageState extends QuestionnaireFormLoadedState {
+    readonly pagination: false;
+}
+
+export declare type QuestionnaireFormState = QuestionnaireFormLoadingState | QuestionnaireFormSinglePageState | QuestionnaireFormPaginationState;
+
 export declare const QuestionnaireItemType: {
     readonly group: "group";
     readonly display: "display";
@@ -1542,6 +1627,16 @@ export declare function setQuestionnaireItemReferenceTargetTypes(item: Questionn
  */
 export declare function setSort(definition: SearchRequest, sort: string, desc?: boolean): SearchRequest;
 
+export declare function SignatureInput(props: SignatureInputProps): JSX.Element;
+
+export declare interface SignatureInputProps extends PaperProps {
+    readonly width?: number;
+    readonly height?: number;
+    readonly defaultValue?: Signature;
+    readonly who?: Reference<ProfileResource>;
+    readonly onChange: ((value: Signature | undefined) => void) | undefined;
+}
+
 /**
  * The SignInForm component allows users to sign in to Medplum.
  *
@@ -1612,6 +1707,7 @@ export declare interface ThreadChatProps {
     readonly title?: string;
     readonly onMessageSent?: (message: Communication) => void;
     readonly inputDisabled?: boolean;
+    readonly excludeHeader?: boolean;
     readonly onError?: (err: Error) => void;
 }
 
@@ -1684,6 +1780,18 @@ export declare function useMedplumProfile(): ProfileResource | undefined;
  */
 export declare function usePrevious<T>(value: T): T | undefined;
 
+export declare function useQuestionnaireForm(props: UseQuestionnaireFormProps): Readonly<QuestionnaireFormState>;
+
+export declare interface UseQuestionnaireFormProps {
+    readonly questionnaire: Questionnaire | Reference<Questionnaire>;
+    readonly defaultValue?: QuestionnaireResponse | Reference<QuestionnaireResponse>;
+    readonly subject?: Reference;
+    readonly encounter?: Reference<Encounter>;
+    readonly source?: QuestionnaireResponse['source'];
+    readonly disablePagination?: boolean;
+    readonly onChange?: (response: QuestionnaireResponse) => void;
+}
+
 /**
  * React Hook to use a FHIR reference.
  * Handles the complexity of resolving references and caching resources.

package/dist/esm/index.d.ts

@@ -72,6 +72,7 @@ import { Schedule } from '@medplum/fhirtypes';
 import { SearchParameter } from '@medplum/fhirtypes';
 import { SearchRequest } from '@medplum/core';
 import { ServiceRequest } from '@medplum/fhirtypes';
+import { Signature } from '@medplum/fhirtypes';
 import { Slot } from '@medplum/fhirtypes';
 import { StructureDefinition } from '@medplum/fhirtypes';
 import { Subscription } from '@medplum/fhirtypes';
@@ -378,7 +379,7 @@ export declare function buildFieldNameString(key: string): string;
 
 export declare function buildInitialResponse(questionnaire: Questionnaire, questionnaireResponse?: QuestionnaireResponse): QuestionnaireResponse;
 
-export declare function buildInitialResponseItem(item: QuestionnaireItem, questionnaireResponseItem?: QuestionnaireResponseItem[]): QuestionnaireResponseItem;
+export declare function buildInitialResponseItem(item: QuestionnaireItem): QuestionnaireResponseItem;
 
 export declare function CalendarInput(props: CalendarInputProps): JSX.Element;
 
@@ -624,7 +625,17 @@ export declare interface ErrorBoundaryState {
     readonly lastLocation: string;
 }
 
-export declare function evaluateCalculatedExpressionsInQuestionnaire(items: QuestionnaireItem[], response: QuestionnaireResponse | undefined): QuestionnaireResponseItem[];
+/**
+ * Evaluates the calculated expressions in a questionnaire.
+ * Updates response item answers in place with the calculated values.
+ *
+ * See: https://build.fhir.org/ig/HL7/sdc/StructureDefinition-sdc-questionnaire-calculatedExpression.html
+ *
+ * @param items - The questionnaire items to evaluate.
+ * @param response - The questionnaire response to evaluate against.
+ * @param responseItems - The response items to update.
+ */
+export declare function evaluateCalculatedExpressionsInQuestionnaire(items: QuestionnaireItem[], response: QuestionnaireResponse, responseItems?: QuestionnaireResponseItem[] | undefined): void;
 
 /**
  * Creates a Blob object from the JSON object given and downloads the object.
@@ -699,20 +710,6 @@ export declare function getItemInitialValue(initial: QuestionnaireItemInitial |
 
 export declare function getNewMultiSelectValues(selected: string[], propertyName: string, item: QuestionnaireItem): QuestionnaireResponseItemAnswer[];
 
-/**
- * Returns the number of pages in the questionnaire.
- *
- * By default, a questionnaire is represented as a simple single page questionnaire,
- * so the default return value is 1.
- *
- * If the questionnaire has a page extension on the first item, then the number of pages
- * is the number of top level items in the questionnaire.
- *
- * @param questionnaire - The questionnaire to get the number of pages for.
- * @returns The number of pages in the questionnaire. Default is 1.
- */
-export declare function getNumberOfPages(questionnaire: Questionnaire): number;
-
 /**
  * Returns a string representing the operation.
  * @param op - The operation code.
@@ -722,7 +719,7 @@ export declare function getOpString(op: Operator): string;
 
 /**
  * Returns the reference filter for the given questionnaire item.
- * @see https://build.fhir.org/ig/HL7/fhir-extensions//StructureDefinition-questionnaire-referenceFilter-definitions.html
+ * @see https://build.fhir.org/ig/HL7/fhir-extensions/StructureDefinition-questionnaire-referenceFilter-definitions.html
  * @param item - The questionnaire item to get the reference filter for.
  * @param subject - Optional subject reference.
  * @param encounter - Optional encounter reference.
@@ -837,8 +834,19 @@ export declare function isAuxClick(e: MouseEvent_2): boolean;
  */
 export declare function isCheckboxCell(el: Element): boolean;
 
+/**
+ * Returns true if the item is a choice question.
+ * @param item - The questionnaire item to check.
+ * @returns True if the item is a choice question, false otherwise.
+ */
 export declare function isChoiceQuestion(item: QuestionnaireItem): boolean;
 
+/**
+ * Returns true if the questionnaire item is enabled based on the enableWhen conditions or expression.
+ * @param item - The questionnaire item to check.
+ * @param questionnaireResponse - The questionnaire response to check against.
+ * @returns True if the question is enabled, false otherwise.
+ */
 export declare function isQuestionEnabled(item: QuestionnaireItem, questionnaireResponse: QuestionnaireResponse | undefined): boolean;
 
 export declare function isSortDescending(definition: SearchRequest): boolean;
@@ -921,8 +929,6 @@ export declare const MemoizedFhirPathTable: MemoExoticComponent<typeof FhirPathT
  */
 export declare const MemoizedSearchControl: typeof SearchControl;
 
-export declare function mergeUpdatedItems(mergedItems: QuestionnaireResponseItem[], updatedItems: QuestionnaireResponseItem[]): QuestionnaireResponseItem[];
-
 export declare function MoneyDisplay(props: MoneyDisplayProps): JSX.Element | null;
 
 export declare interface MoneyDisplayProps {
@@ -1062,6 +1068,22 @@ export declare interface QuantityInputProps extends ComplexTypeInputProps<Quanti
     readonly disableWheel?: boolean;
 }
 
+export declare const QUESTIONNAIRE_CALCULATED_EXPRESSION_URL = "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-calculatedExpression";
+
+export declare const QUESTIONNAIRE_ENABLED_WHEN_EXPRESSION_URL = "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression";
+
+export declare const QUESTIONNAIRE_ITEM_CONTROL_URL = "http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl";
+
+export declare const QUESTIONNAIRE_REFERENCE_FILTER_URL = "http://hl7.org/fhir/StructureDefinition/questionnaire-referenceFilter";
+
+export declare const QUESTIONNAIRE_REFERENCE_RESOURCE_URL = "http://hl7.org/fhir/StructureDefinition/questionnaire-referenceResource";
+
+export declare const QUESTIONNAIRE_SIGNATURE_REQUIRED_URL = "http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired";
+
+export declare const QUESTIONNAIRE_SIGNATURE_RESPONSE_URL = "http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature";
+
+export declare const QUESTIONNAIRE_VALIDATION_ERROR_URL = "http://hl7.org/fhir/StructureDefinition/questionnaire-validationError";
+
 export declare function QuestionnaireBuilder(props: QuestionnaireBuilderProps): JSX.Element | null;
 
 export declare interface QuestionnaireBuilderProps {
@@ -1072,10 +1094,67 @@ export declare interface QuestionnaireBuilderProps {
 
 export declare function QuestionnaireForm(props: QuestionnaireFormProps): JSX.Element | null;
 
-export declare const QuestionnaireFormContext: Context<    {
-subject?: Reference;
-encounter?: Reference<Encounter>;
-}>;
+export declare interface QuestionnaireFormLoadedState {
+    /** Not loading */
+    readonly loading: false;
+    /** The loaded questionnaire */
+    questionnaire: Questionnaire;
+    /** The current draft questionnaire response */
+    questionnaireResponse: QuestionnaireResponse;
+    /** Optional questionnaire subject */
+    subject?: Reference;
+    /** Optional questionnaire encounter */
+    encounter?: Reference<Encounter>;
+    /** The top level items for the current page */
+    items: QuestionnaireItem[];
+    /** The response items for the current page */
+    responseItems: QuestionnaireResponseItem[];
+    /**
+     * Adds a new group item to the current context.
+     * @param context - The current context of the questionnaire response items.
+     * @param item - The questionnaire item that is being added to the group.
+     */
+    onAddGroup: (context: QuestionnaireResponseItem[], item: QuestionnaireItem) => void;
+    /**
+     * Adds an answer to a repeating item.
+     * @param context - The current context of the questionnaire response items.
+     * @param item - The questionnaire item that is being answered.
+     */
+    onAddAnswer: (context: QuestionnaireResponseItem[], item: QuestionnaireItem) => void;
+    /**
+     * Changes an answer value.
+     * @param context - The current context of the questionnaire response items.
+     * @param item - The questionnaire item that is being answered.
+     * @param answer - The answer(s) provided by the user for the questionnaire item.
+     */
+    onChangeAnswer: (context: QuestionnaireResponseItem[], item: QuestionnaireItem, answer: QuestionnaireResponseItemAnswer[]) => void;
+    /**
+     * Sets or updates the signature for the questionnaire response.
+     * @param signature - The signature to set, or undefined to clear the signature.
+     */
+    onChangeSignature: (signature: Signature | undefined) => void;
+}
+
+export declare interface QuestionnaireFormLoadingState {
+    /** Currently loading data such as the Questionnaire or the QuestionnaireResponse default value */
+    readonly loading: true;
+}
+
+export declare interface QuestionnaireFormPage {
+    readonly linkId: string;
+    readonly title: string;
+    readonly group: QuestionnaireItem & {
+        type: 'group';
+    };
+}
+
+export declare interface QuestionnaireFormPaginationState extends QuestionnaireFormLoadedState {
+    readonly pagination: true;
+    pages: QuestionnaireFormPage[];
+    activePage: number;
+    onNextPage: () => void;
+    onPrevPage: () => void;
+}
 
 export declare interface QuestionnaireFormProps {
     readonly questionnaire: Questionnaire | Reference<Questionnaire>;
@@ -1090,6 +1169,12 @@ export declare interface QuestionnaireFormProps {
     readonly onSubmit?: (response: QuestionnaireResponse) => void;
 }
 
+export declare interface QuestionnaireFormSinglePageState extends QuestionnaireFormLoadedState {
+    readonly pagination: false;
+}
+
+export declare type QuestionnaireFormState = QuestionnaireFormLoadingState | QuestionnaireFormSinglePageState | QuestionnaireFormPaginationState;
+
 export declare const QuestionnaireItemType: {
     readonly group: "group";
     readonly display: "display";
@@ -1542,6 +1627,16 @@ export declare function setQuestionnaireItemReferenceTargetTypes(item: Questionn
  */
 export declare function setSort(definition: SearchRequest, sort: string, desc?: boolean): SearchRequest;
 
+export declare function SignatureInput(props: SignatureInputProps): JSX.Element;
+
+export declare interface SignatureInputProps extends PaperProps {
+    readonly width?: number;
+    readonly height?: number;
+    readonly defaultValue?: Signature;
+    readonly who?: Reference<ProfileResource>;
+    readonly onChange: ((value: Signature | undefined) => void) | undefined;
+}
+
 /**
  * The SignInForm component allows users to sign in to Medplum.
  *
@@ -1612,6 +1707,7 @@ export declare interface ThreadChatProps {
     readonly title?: string;
     readonly onMessageSent?: (message: Communication) => void;
     readonly inputDisabled?: boolean;
+    readonly excludeHeader?: boolean;
     readonly onError?: (err: Error) => void;
 }
 
@@ -1684,6 +1780,18 @@ export declare function useMedplumProfile(): ProfileResource | undefined;
  */
 export declare function usePrevious<T>(value: T): T | undefined;
 
+export declare function useQuestionnaireForm(props: UseQuestionnaireFormProps): Readonly<QuestionnaireFormState>;
+
+export declare interface UseQuestionnaireFormProps {
+    readonly questionnaire: Questionnaire | Reference<Questionnaire>;
+    readonly defaultValue?: QuestionnaireResponse | Reference<QuestionnaireResponse>;
+    readonly subject?: Reference;
+    readonly encounter?: Reference<Encounter>;
+    readonly source?: QuestionnaireResponse['source'];
+    readonly disablePagination?: boolean;
+    readonly onChange?: (response: QuestionnaireResponse) => void;
+}
+
 /**
  * React Hook to use a FHIR reference.
  * Handles the complexity of resolving references and caching resources.