@medplum/react 3.1.8 → 3.1.10

package/dist/cjs/index.d.ts

@@ -70,6 +70,7 @@ import { SearchRequest } from '@medplum/core';
 import { ServiceRequest } from '@medplum/fhirtypes';
 import { Slot } from '@medplum/fhirtypes';
 import { StructureDefinition } from '@medplum/fhirtypes';
+import { Subscription } from '@medplum/fhirtypes';
 import { Task } from '@medplum/fhirtypes';
 import { TextProps } from '@mantine/core';
 import { Timing } from '@medplum/fhirtypes';
@@ -939,6 +940,11 @@ export declare interface QuestionnaireBuilderProps {
 
 export declare function QuestionnaireForm(props: QuestionnaireFormProps): JSX.Element | null;
 
+export declare const QuestionnaireFormContext: Context<    {
+subject?: Reference<Resource> | undefined;
+encounter?: Reference<Encounter> | undefined;
+}>;
+
 export declare interface QuestionnaireFormProps {
     readonly questionnaire: Questionnaire | Reference<Questionnaire>;
     readonly subject?: Reference;
@@ -1538,7 +1544,20 @@ export declare function useSearchOne<K extends ResourceType>(resourceType: K, qu
  */
 export declare function useSearchResources<K extends ResourceType>(resourceType: K, query?: QueryTypes): [ResourceArray<ExtractResource<K>> | undefined, boolean, OperationOutcome | undefined];
 
-export declare function useSubscription(criteria: string, callback: (bundle: Bundle) => void): void;
+/**
+ * Creates an in-memory `Subscription` resource with the given criteria on the Medplum server and calls the given callback when an event notification is triggered by a resource interaction over a WebSocket connection.
+ *
+ * Subscriptions created with this hook are lightweight, share a single WebSocket connection, and are automatically untracked and cleaned up when the containing component is no longer mounted.
+ *
+ * @param criteria - The FHIR search criteria to subscribe to.
+ * @param callback - The callback to call when a notification event `Bundle` for this `Subscription` is received.
+ * @param options - Optional options used to configure the created `Subscription`.
+ */
+export declare function useSubscription(criteria: string, callback: (bundle: Bundle) => void, options?: UseSubscriptionOptions): void;
+
+export declare type UseSubscriptionOptions = {
+    subscriptionProps?: Partial<Subscription>;
+};
 
 /**
  * A low-level component to autocomplete based on a FHIR Valueset.

package/dist/esm/index.d.ts

@@ -70,6 +70,7 @@ import { SearchRequest } from '@medplum/core';
 import { ServiceRequest } from '@medplum/fhirtypes';
 import { Slot } from '@medplum/fhirtypes';
 import { StructureDefinition } from '@medplum/fhirtypes';
+import { Subscription } from '@medplum/fhirtypes';
 import { Task } from '@medplum/fhirtypes';
 import { TextProps } from '@mantine/core';
 import { Timing } from '@medplum/fhirtypes';
@@ -939,6 +940,11 @@ export declare interface QuestionnaireBuilderProps {
 
 export declare function QuestionnaireForm(props: QuestionnaireFormProps): JSX.Element | null;
 
+export declare const QuestionnaireFormContext: Context<    {
+subject?: Reference<Resource> | undefined;
+encounter?: Reference<Encounter> | undefined;
+}>;
+
 export declare interface QuestionnaireFormProps {
     readonly questionnaire: Questionnaire | Reference<Questionnaire>;
     readonly subject?: Reference;
@@ -1538,7 +1544,20 @@ export declare function useSearchOne<K extends ResourceType>(resourceType: K, qu
  */
 export declare function useSearchResources<K extends ResourceType>(resourceType: K, query?: QueryTypes): [ResourceArray<ExtractResource<K>> | undefined, boolean, OperationOutcome | undefined];
 
-export declare function useSubscription(criteria: string, callback: (bundle: Bundle) => void): void;
+/**
+ * Creates an in-memory `Subscription` resource with the given criteria on the Medplum server and calls the given callback when an event notification is triggered by a resource interaction over a WebSocket connection.
+ *
+ * Subscriptions created with this hook are lightweight, share a single WebSocket connection, and are automatically untracked and cleaned up when the containing component is no longer mounted.
+ *
+ * @param criteria - The FHIR search criteria to subscribe to.
+ * @param callback - The callback to call when a notification event `Bundle` for this `Subscription` is received.
+ * @param options - Optional options used to configure the created `Subscription`.
+ */
+export declare function useSubscription(criteria: string, callback: (bundle: Bundle) => void, options?: UseSubscriptionOptions): void;
+
+export declare type UseSubscriptionOptions = {
+    subscriptionProps?: Partial<Subscription>;
+};
 
 /**
  * A low-level component to autocomplete based on a FHIR Valueset.