@medplum/core 3.1.6 → 3.1.7

package/dist/cjs/index.d.ts

@@ -18,6 +18,7 @@ import { Device } from '@medplum/fhirtypes';
 import { ElementDefinition } from '@medplum/fhirtypes';
 import { ElementDefinitionBinding } from '@medplum/fhirtypes';
 import { Extension } from '@medplum/fhirtypes';
+import { ExtensionValue } from '@medplum/fhirtypes';
 import { ExtractResource } from '@medplum/fhirtypes';
 import { HumanName } from '@medplum/fhirtypes';
 import { Identifier } from '@medplum/fhirtypes';
@@ -48,6 +49,7 @@ import { ResourceType } from '@medplum/fhirtypes';
 import { SearchParameter } from '@medplum/fhirtypes';
 import { StructureDefinition } from '@medplum/fhirtypes';
 import { StructureMap } from '@medplum/fhirtypes';
+import { Subscription } from '@medplum/fhirtypes';
 import type { TDocumentDefinitions } from 'pdfmake/interfaces';
 import type { TFontDictionary } from 'pdfmake/interfaces';
 import { Timing } from '@medplum/fhirtypes';
@@ -241,6 +243,12 @@ export declare interface AtomContext {
     variables: Record<string, TypedValue>;
 }
 
+export declare interface BackgroundJobContext {
+    interaction: BackgroundJobInteraction;
+}
+
+export declare type BackgroundJobInteraction = 'create' | 'update' | 'delete';
+
 export declare function badRequest(details: string, expression?: string): OperationOutcome;
 
 export declare interface BaseAgentMessage {
@@ -293,7 +301,7 @@ export declare interface BotEvent<T = Resource | Hl7Message | string | Record<st
     readonly traceId?: string;
 }
 
-export declare function buildElementsContext({ parentContext, path, elements, profileUrl, debugMode, }: {
+export declare function buildElementsContext({ parentContext, path, elements, profileUrl, debugMode, accessPolicyResource, }: {
     /** The most recent `ElementsContextType` in which this context is being built. */
     parentContext: ElementsContextType | undefined;
     /** The FHIR path from the root resource to which the keys of `elements` are relative. */
@@ -307,6 +315,7 @@ export declare function buildElementsContext({ parentContext, path, elements, pr
     profileUrl?: string;
     /** Whether debug logging is enabled */
     debugMode?: boolean;
+    accessPolicyResource?: AccessPolicyResource;
 }): ElementsContextType | undefined;
 
 export declare function buildTypeName(components: string[]): string;
@@ -663,20 +672,39 @@ export declare type ElementsContextType = {
     /** The FHIR path from the root resource to which the keys of `elements` are relative. */
     path: string;
     /**
-     * The mapping of keys to `InternalSchemaElement` at the current `path` relative to the
+     * The mapping of keys to `ExtendedInternalSchemaElement` at the current `path` relative to the
      * root resource. `elements` originate from either `InternalTypeSchema.elements` or
      * `SliceDefinition.elements` when the elements context is created within a slice.
      */
-    elements: Record<string, InternalSchemaElement>;
+    elements: Record<string, ExtendedInternalSchemaElement>;
     /**
      * Similar mapping as `elements`, but with keys being the full path from the root resource rather
      * than relative to `path`, in other words, the keys of the Record are `${path}.${key}`.
      */
-    elementsByPath: Record<string, InternalSchemaElement>;
+    elementsByPath: Record<string, ExtendedInternalSchemaElement>;
     /** The URL, if any, of the resource profile or extension from which the `elements` collection originated. */
     profileUrl: string | undefined;
     /** Whether debug logging is enabled */
     debugMode: boolean;
+    /** The `AccessPolicyResource` provided, if any, used to determine hidden and readonly elements. */
+    accessPolicyResource?: AccessPolicyResource;
+    /**
+     * Used to get an `ExtendedElementProperties` object for an element at a given path. This
+     * is primarily useful when working with elements not included in `InternalTypeSchema.elements`
+     * as is the case for nested elements that have not been modified by a profile or extension,
+     * e.g. Patient.name.family.
+     *
+     * This function does not attempt to determine if the input `path` is actually an element in the
+     * resource. When a syntactically correct path to a nonexistent element, e.g. Patient.foobar, is provided,
+     * a `ExtendedElementProperties` object with default values is returned.
+     *
+     * @param path - The full path to an element in the resource, e.g. Patient.name.family
+     * @returns An `ExtendedElementProperties` object with `readonly` and `hidden` properties for the
+     * element at `path`, or `undefined` if the input path is malformed.
+     */
+    getExtendedProps(path: string): ExtendedElementProperties | undefined;
+    /** `true` if this is a default/placeholder `ElementsContextType` */
+    isDefaultContext?: boolean;
 };
 
 export declare interface ElementType {
@@ -772,6 +800,15 @@ declare class EventTarget_2 {
 }
 export { EventTarget_2 as EventTarget }
 
+export declare type ExtendedElementProperties = {
+    readonly: boolean;
+    hidden: boolean;
+};
+
+export declare interface ExtendedInternalSchemaElement extends InternalSchemaElement {
+    readonly?: boolean;
+}
+
 export declare type ExternalSecret<T extends ExternalSecretPrimitive = ExternalSecretPrimitive> = {
     system: ExternalSecretSystem;
     key: string;
@@ -1412,7 +1449,7 @@ export declare function getExtension(resource: any, ...urls: string[]): Extensio
  * @param urls - Array of extension URLs.  Each entry represents a nested extension.
  * @returns The extension value if found; undefined otherwise.
  */
-export declare function getExtensionValue(resource: any, ...urls: string[]): string | undefined;
+export declare function getExtensionValue(resource: any, ...urls: string[]): ExtensionValue | undefined;
 
 /**
  * Returns the resource identifier for the given system.
@@ -1853,7 +1890,7 @@ export declare interface IncludeTarget {
     resourceType: string;
     searchParam: string;
     targetType?: string;
-    modifier?: string;
+    modifier?: 'iterate';
 }
 
 /**
@@ -2060,6 +2097,8 @@ export declare function isEmpty(v: unknown): boolean;
  */
 export declare function isFhircastResourceType(resourceType: FhircastResourceType): boolean;
 
+export declare function isFhirCriteriaMet(subscription: Subscription, currentResource: Resource, getPreviousResource: (currentResource: Resource) => Promise<Resource | undefined>): Promise<boolean>;
+
 export declare function isGone(outcome: OperationOutcome): boolean;
 
 /**
@@ -4195,10 +4234,12 @@ export declare interface MedplumInfraConfig {
     rdsReaderInstanceType?: string;
     rdsProxyEnabled?: boolean;
     cacheNodeType?: string;
+    cacheSecurityGroupId?: string;
     desiredServerCount: number;
     serverImage: string;
     serverMemory: number;
     serverCpu: number;
+    loadBalancerSecurityGroupId?: string;
     loadBalancerLoggingBucket?: string;
     loadBalancerLoggingPrefix?: string;
     clamscanEnabled: boolean;
@@ -4307,10 +4348,12 @@ export declare interface MedplumSourceInfraConfig {
     rdsReaderInstanceType?: ValueOrExternalSecret<string>;
     rdsProxyEnabled?: ValueOrExternalSecret<boolean>;
     cacheNodeType?: ValueOrExternalSecret<string>;
+    cacheSecurityGroupId?: ValueOrExternalSecret<string>;
     desiredServerCount: ValueOrExternalSecret<number>;
     serverImage: ValueOrExternalSecret<string>;
     serverMemory: ValueOrExternalSecret<number>;
     serverCpu: ValueOrExternalSecret<number>;
+    loadBalancerSecurityGroupId?: ValueOrExternalSecret<string>;
     loadBalancerLoggingBucket?: ValueOrExternalSecret<string>;
     loadBalancerLoggingPrefix?: ValueOrExternalSecret<string>;
     clamscanEnabled: ValueOrExternalSecret<boolean>;
@@ -5019,6 +5062,16 @@ export declare type ResourceArray<T extends Resource = Resource> = T[] & {
     bundle: Bundle<T>;
 };
 
+export declare type ResourceMatchesSubscriptionCriteria = {
+    resource: Resource;
+    subscription: Subscription;
+    context: BackgroundJobContext;
+    logger?: Logger;
+    getPreviousResource: (currentResource: Resource) => Promise<Resource | undefined>;
+};
+
+export declare function resourceMatchesSubscriptionCriteria({ resource, subscription, context, getPreviousResource, logger, }: ResourceMatchesSubscriptionCriteria): Promise<boolean>;
+
 export declare interface ResourceVisitor {
     onEnterObject?: (path: string, value: TypedValueWithPath, schema: InternalTypeSchema) => void;
     onExitObject?: (path: string, value: TypedValueWithPath, schema: InternalTypeSchema) => void;
@@ -5194,6 +5247,17 @@ export declare function sortStringArray(array: string[]): string[];
  */
 export declare function splitN(str: string, delim: string, n: number): string[];
 
+/**
+ * Splits a FHIR search value on commas.
+ * Respects backslash escape.
+ *
+ * See: https://hl7.org/fhir/r4/search.html#escaping
+ *
+ * @param input - The FHIR search value to split.
+ * @returns The individual search values.
+ */
+export declare function splitSearchOnComma(input: string): string[];
+
 /**
  * Reads data from a Readable stream and returns a Promise that resolves with a Buffer containing all the data.
  * @param stream - The Readable stream to read from.

package/dist/esm/index.d.ts

@@ -18,6 +18,7 @@ import { Device } from '@medplum/fhirtypes';
 import { ElementDefinition } from '@medplum/fhirtypes';
 import { ElementDefinitionBinding } from '@medplum/fhirtypes';
 import { Extension } from '@medplum/fhirtypes';
+import { ExtensionValue } from '@medplum/fhirtypes';
 import { ExtractResource } from '@medplum/fhirtypes';
 import { HumanName } from '@medplum/fhirtypes';
 import { Identifier } from '@medplum/fhirtypes';
@@ -48,6 +49,7 @@ import { ResourceType } from '@medplum/fhirtypes';
 import { SearchParameter } from '@medplum/fhirtypes';
 import { StructureDefinition } from '@medplum/fhirtypes';
 import { StructureMap } from '@medplum/fhirtypes';
+import { Subscription } from '@medplum/fhirtypes';
 import type { TDocumentDefinitions } from 'pdfmake/interfaces';
 import type { TFontDictionary } from 'pdfmake/interfaces';
 import { Timing } from '@medplum/fhirtypes';
@@ -241,6 +243,12 @@ export declare interface AtomContext {
     variables: Record<string, TypedValue>;
 }
 
+export declare interface BackgroundJobContext {
+    interaction: BackgroundJobInteraction;
+}
+
+export declare type BackgroundJobInteraction = 'create' | 'update' | 'delete';
+
 export declare function badRequest(details: string, expression?: string): OperationOutcome;
 
 export declare interface BaseAgentMessage {
@@ -293,7 +301,7 @@ export declare interface BotEvent<T = Resource | Hl7Message | string | Record<st
     readonly traceId?: string;
 }
 
-export declare function buildElementsContext({ parentContext, path, elements, profileUrl, debugMode, }: {
+export declare function buildElementsContext({ parentContext, path, elements, profileUrl, debugMode, accessPolicyResource, }: {
     /** The most recent `ElementsContextType` in which this context is being built. */
     parentContext: ElementsContextType | undefined;
     /** The FHIR path from the root resource to which the keys of `elements` are relative. */
@@ -307,6 +315,7 @@ export declare function buildElementsContext({ parentContext, path, elements, pr
     profileUrl?: string;
     /** Whether debug logging is enabled */
     debugMode?: boolean;
+    accessPolicyResource?: AccessPolicyResource;
 }): ElementsContextType | undefined;
 
 export declare function buildTypeName(components: string[]): string;
@@ -663,20 +672,39 @@ export declare type ElementsContextType = {
     /** The FHIR path from the root resource to which the keys of `elements` are relative. */
     path: string;
     /**
-     * The mapping of keys to `InternalSchemaElement` at the current `path` relative to the
+     * The mapping of keys to `ExtendedInternalSchemaElement` at the current `path` relative to the
      * root resource. `elements` originate from either `InternalTypeSchema.elements` or
      * `SliceDefinition.elements` when the elements context is created within a slice.
      */
-    elements: Record<string, InternalSchemaElement>;
+    elements: Record<string, ExtendedInternalSchemaElement>;
     /**
      * Similar mapping as `elements`, but with keys being the full path from the root resource rather
      * than relative to `path`, in other words, the keys of the Record are `${path}.${key}`.
      */
-    elementsByPath: Record<string, InternalSchemaElement>;
+    elementsByPath: Record<string, ExtendedInternalSchemaElement>;
     /** The URL, if any, of the resource profile or extension from which the `elements` collection originated. */
     profileUrl: string | undefined;
     /** Whether debug logging is enabled */
     debugMode: boolean;
+    /** The `AccessPolicyResource` provided, if any, used to determine hidden and readonly elements. */
+    accessPolicyResource?: AccessPolicyResource;
+    /**
+     * Used to get an `ExtendedElementProperties` object for an element at a given path. This
+     * is primarily useful when working with elements not included in `InternalTypeSchema.elements`
+     * as is the case for nested elements that have not been modified by a profile or extension,
+     * e.g. Patient.name.family.
+     *
+     * This function does not attempt to determine if the input `path` is actually an element in the
+     * resource. When a syntactically correct path to a nonexistent element, e.g. Patient.foobar, is provided,
+     * a `ExtendedElementProperties` object with default values is returned.
+     *
+     * @param path - The full path to an element in the resource, e.g. Patient.name.family
+     * @returns An `ExtendedElementProperties` object with `readonly` and `hidden` properties for the
+     * element at `path`, or `undefined` if the input path is malformed.
+     */
+    getExtendedProps(path: string): ExtendedElementProperties | undefined;
+    /** `true` if this is a default/placeholder `ElementsContextType` */
+    isDefaultContext?: boolean;
 };
 
 export declare interface ElementType {
@@ -772,6 +800,15 @@ declare class EventTarget_2 {
 }
 export { EventTarget_2 as EventTarget }
 
+export declare type ExtendedElementProperties = {
+    readonly: boolean;
+    hidden: boolean;
+};
+
+export declare interface ExtendedInternalSchemaElement extends InternalSchemaElement {
+    readonly?: boolean;
+}
+
 export declare type ExternalSecret<T extends ExternalSecretPrimitive = ExternalSecretPrimitive> = {
     system: ExternalSecretSystem;
     key: string;
@@ -1412,7 +1449,7 @@ export declare function getExtension(resource: any, ...urls: string[]): Extensio
  * @param urls - Array of extension URLs.  Each entry represents a nested extension.
  * @returns The extension value if found; undefined otherwise.
  */
-export declare function getExtensionValue(resource: any, ...urls: string[]): string | undefined;
+export declare function getExtensionValue(resource: any, ...urls: string[]): ExtensionValue | undefined;
 
 /**
  * Returns the resource identifier for the given system.
@@ -1853,7 +1890,7 @@ export declare interface IncludeTarget {
     resourceType: string;
     searchParam: string;
     targetType?: string;
-    modifier?: string;
+    modifier?: 'iterate';
 }
 
 /**
@@ -2060,6 +2097,8 @@ export declare function isEmpty(v: unknown): boolean;
  */
 export declare function isFhircastResourceType(resourceType: FhircastResourceType): boolean;
 
+export declare function isFhirCriteriaMet(subscription: Subscription, currentResource: Resource, getPreviousResource: (currentResource: Resource) => Promise<Resource | undefined>): Promise<boolean>;
+
 export declare function isGone(outcome: OperationOutcome): boolean;
 
 /**
@@ -4195,10 +4234,12 @@ export declare interface MedplumInfraConfig {
     rdsReaderInstanceType?: string;
     rdsProxyEnabled?: boolean;
     cacheNodeType?: string;
+    cacheSecurityGroupId?: string;
     desiredServerCount: number;
     serverImage: string;
     serverMemory: number;
     serverCpu: number;
+    loadBalancerSecurityGroupId?: string;
     loadBalancerLoggingBucket?: string;
     loadBalancerLoggingPrefix?: string;
     clamscanEnabled: boolean;
@@ -4307,10 +4348,12 @@ export declare interface MedplumSourceInfraConfig {
     rdsReaderInstanceType?: ValueOrExternalSecret<string>;
     rdsProxyEnabled?: ValueOrExternalSecret<boolean>;
     cacheNodeType?: ValueOrExternalSecret<string>;
+    cacheSecurityGroupId?: ValueOrExternalSecret<string>;
     desiredServerCount: ValueOrExternalSecret<number>;
     serverImage: ValueOrExternalSecret<string>;
     serverMemory: ValueOrExternalSecret<number>;
     serverCpu: ValueOrExternalSecret<number>;
+    loadBalancerSecurityGroupId?: ValueOrExternalSecret<string>;
     loadBalancerLoggingBucket?: ValueOrExternalSecret<string>;
     loadBalancerLoggingPrefix?: ValueOrExternalSecret<string>;
     clamscanEnabled: ValueOrExternalSecret<boolean>;
@@ -5019,6 +5062,16 @@ export declare type ResourceArray<T extends Resource = Resource> = T[] & {
     bundle: Bundle<T>;
 };
 
+export declare type ResourceMatchesSubscriptionCriteria = {
+    resource: Resource;
+    subscription: Subscription;
+    context: BackgroundJobContext;
+    logger?: Logger;
+    getPreviousResource: (currentResource: Resource) => Promise<Resource | undefined>;
+};
+
+export declare function resourceMatchesSubscriptionCriteria({ resource, subscription, context, getPreviousResource, logger, }: ResourceMatchesSubscriptionCriteria): Promise<boolean>;
+
 export declare interface ResourceVisitor {
     onEnterObject?: (path: string, value: TypedValueWithPath, schema: InternalTypeSchema) => void;
     onExitObject?: (path: string, value: TypedValueWithPath, schema: InternalTypeSchema) => void;
@@ -5194,6 +5247,17 @@ export declare function sortStringArray(array: string[]): string[];
  */
 export declare function splitN(str: string, delim: string, n: number): string[];
 
+/**
+ * Splits a FHIR search value on commas.
+ * Respects backslash escape.
+ *
+ * See: https://hl7.org/fhir/r4/search.html#escaping
+ *
+ * @param input - The FHIR search value to split.
+ * @returns The individual search values.
+ */
+export declare function splitSearchOnComma(input: string): string[];
+
 /**
  * Reads data from a Readable stream and returns a Promise that resolves with a Buffer containing all the data.
  * @param stream - The Readable stream to read from.