@medplum/core 5.0.4 → 5.0.6

package/dist/esm/index.d.ts

@@ -37,6 +37,7 @@ import type { OperationOutcomeIssue } from '@medplum/fhirtypes';
 import type { Patient } from '@medplum/fhirtypes';
 import type { Period } from '@medplum/fhirtypes';
 import type { Practitioner } from '@medplum/fhirtypes';
+import type { PractitionerRole } from '@medplum/fhirtypes';
 import type { Project } from '@medplum/fhirtypes';
 import type { ProjectMembership } from '@medplum/fhirtypes';
 import type { ProjectMembershipAccess } from '@medplum/fhirtypes';
@@ -45,7 +46,7 @@ import type { Quantity } from '@medplum/fhirtypes';
 import type { QuestionnaireResponse } from '@medplum/fhirtypes';
 import type { QuestionnaireResponseItemAnswer } from '@medplum/fhirtypes';
 import type { Range as Range_2 } from '@medplum/fhirtypes';
-import type { Readable } from 'stream';
+import type { Readable } from 'node:stream';
 import type { Reference } from '@medplum/fhirtypes';
 import type { RelatedPerson } from '@medplum/fhirtypes';
 import type { Resource } from '@medplum/fhirtypes';
@@ -369,6 +370,16 @@ export declare interface BotEvent<T = unknown> {
     readonly headers?: Record<string, string | string[] | undefined>;
 }
 
+/**
+ * Builds a CDS request.
+ * @param medplum - The Medplum client.
+ * @param user - The user resource.
+ * @param service - The CDS service definition.
+ * @param context - The CDS request context.
+ * @returns The fully populated CDS request.
+ */
+export declare function buildCdsRequest(medplum: MedplumClient, user: CdsUserResource, service: CdsService, context: Record<string, unknown>): Promise<CdsRequest>;
+
 export declare function buildElementsContext({ parentContext, path, elements, profileUrl, debugMode, accessPolicyResource, }: {
     /** The most recent `ElementsContextType` in which this context is being built. */
     parentContext: ElementsContextType | undefined;
@@ -415,7 +426,7 @@ export declare function calculateAgeString(birthDateStr: string, endDateStr?: st
 
 export declare type CanBePopulated = {
     length: number;
-} | object;
+} | Record<string, any>;
 
 /**
  * Determines if the current user can read the specified resource type.
@@ -449,6 +460,152 @@ export declare function canWriteResourceType(accessPolicy: AccessPolicy, resourc
 
 export declare function capitalize(word: string): string;
 
+/**
+ * CDS Action.
+ * See {@link https://cds-hooks.hl7.org/#actions | CDS Actions} for full details.
+ */
+export declare type CdsAction = CdsCreateAction | CdsUpdateAction | CdsDeleteAction;
+
+/**
+ * CDS Card definition.
+ * See {@link https://cds-hooks.hl7.org/#card-attributes | CDS Cards} for full details.
+ */
+export declare interface CdsCard {
+    readonly uuid?: string;
+    readonly summary: string;
+    readonly detail?: string;
+    readonly indicator: 'info' | 'warning' | 'hard-stop';
+    readonly source?: CdsSource;
+    readonly suggestions?: CdsSuggestion[];
+    readonly links?: CdsLink[];
+}
+
+/**
+ * CDS Create Action.
+ * See {@link https://cds-hooks.hl7.org/#actions | CDS Actions} for full details.
+ */
+export declare interface CdsCreateAction {
+    readonly type: 'create';
+    readonly description: string;
+    readonly resource: Resource;
+}
+
+/**
+ * CDS Delete Action.
+ * See {@link https://cds-hooks.hl7.org/#actions | CDS Actions} for full details.
+ */
+export declare interface CdsDeleteAction {
+    readonly type: 'delete';
+    readonly description: string;
+    readonly resourceId: string;
+}
+
+/**
+ * CDS Discovery Response definition.
+ * See {@link https://cds-hooks.hl7.org/#discovery | CDS Hooks Discovery} for full details.
+ */
+export declare interface CdsDiscoveryResponse {
+    readonly services: CdsService[];
+}
+
+/**
+ * CDS FHIR Authorization definition.
+ */
+export declare interface CdsFhirAuthorization {
+    readonly access_token: string;
+    readonly token_type: string;
+    readonly expires_in?: number;
+    readonly scope?: string;
+    readonly subject?: string;
+}
+
+/**
+ * CDS Link definition.
+ * See {@link https://cds-hooks.hl7.org/#link | CDS Link} for full details.
+ */
+export declare interface CdsLink {
+    readonly label: string;
+    readonly url: string;
+    readonly type: 'absolute' | 'smart' | 'relative';
+    readonly appContext?: string;
+    readonly autolaunchable?: boolean;
+}
+
+/**
+ * CDS Request definition.
+ * See {@link https://cds-hooks.hl7.org/#http-request-1 | Calling a CDS Service} for full details.
+ */
+export declare interface CdsRequest {
+    readonly hook: string;
+    readonly hookInstance: string;
+    readonly context: Record<string, unknown>;
+    readonly prefetch?: Record<string, unknown>;
+}
+
+/**
+ * CDS Request with FHIR authorization.
+ */
+export declare interface CdsRequestWithAuth extends CdsRequest {
+    readonly fhirServer: string;
+    readonly fhirAuthorization: CdsFhirAuthorization;
+}
+
+/**
+ * CDS Response definition.
+ * See {@link https://cds-hooks.hl7.org/#cds-service-response | CDS Service Response} for full details.
+ */
+export declare interface CdsResponse {
+    readonly cards: CdsCard[];
+    readonly systemActions?: CdsAction[];
+}
+
+/**
+ * CDS Service definition.
+ * See {@link https://cds-hooks.hl7.org/#response | CDS Hooks Discovery} for full details.
+ */
+export declare interface CdsService {
+    readonly id: string;
+    readonly hook: string;
+    readonly title?: string;
+    readonly description?: string;
+    readonly usageRequirements?: string;
+    readonly prefetch?: Record<string, string>;
+}
+
+/**
+ * CDS Source definition.
+ * See {@link https://cds-hooks.hl7.org/#source | CDS Source} for full details.
+ */
+export declare interface CdsSource {
+    readonly label: string;
+    readonly url?: string;
+    readonly icon?: string;
+    readonly topic?: Coding;
+}
+
+/**
+ * CDS Suggestion definition.
+ * See {@link https://cds-hooks.hl7.org/#suggestion | CDS Suggestions} for full details.
+ */
+export declare interface CdsSuggestion {
+    readonly label: string;
+    readonly uuid?: string;
+    readonly isRecommended?: boolean;
+    readonly actions: CdsAction[];
+}
+
+/**
+ * CDS Update Action.
+ * See {@link https://cds-hooks.hl7.org/#actions | CDS Actions} for full details.
+ */
+export declare interface CdsUpdateAction {
+    readonly type: 'update';
+    readonly description: string;
+    readonly resource: Resource;
+}
+
+export declare type CdsUserResource = WithId<Patient | Practitioner | PractitionerRole | RelatedPerson>;
+
 /**
  * Recursively checks for null values in an object.
  *
@@ -858,6 +1015,21 @@ export declare const DEFAULT_MAX_SEARCH_COUNT = 1000;
 
 export declare const DEFAULT_SEARCH_COUNT = 20;
 
+/**
+ * Derives an "identifier" search parameter from a reference search parameter.
+ *
+ * FHIR references can have an "identifier" property.
+ *
+ * Any FHIR reference search parameter can be used to search for resources with an identifier.
+ *
+ * However, the FHIR specification does not define an "identifier" search parameter for every resource type.
+ *
+ * This function derives an "identifier" search parameter from a reference search parameter.
+ * @param inputParam - The original reference search parameter.
+ * @returns The derived "identifier" search parameter.
+ */
+export declare function deriveIdentifierSearchParameter(inputParam: SearchParameter): SearchParameter;
+
 export declare class DotAtom extends InfixOperatorAtom {
     constructor(left: Atom, right: Atom);
     eval(context: AtomContext, input: TypedValue[]): TypedValue[];
@@ -1852,6 +2024,8 @@ export declare function getIdentifier(resource: Resource, system: string): strin
  */
 export declare function getImageSrc(resource: Resource): string | undefined;
 
+export declare function getInnerDerivedIdentifierExpression(expression: string): string | undefined;
+
 export declare function getNestedProperty(value: TypedValueWithPath | undefined, key: string, options: {
     profileUrl?: string;
     withPath: true;
@@ -1862,6 +2036,8 @@ export declare function getNestedProperty(value: TypedValue | undefined, key: st
     withPath?: false;
 }): (TypedValue | TypedValue[] | undefined)[];
 
+export declare function getParsedDerivedIdentifierExpression(originalExpression: string, atom: FhirPathAtom): FhirPathAtom;
+
 export declare function getParsedExpressionForResourceType(resourceType: string, expression: string): FhirPathAtom;
 
 /**
@@ -2652,7 +2828,7 @@ export declare function isPeriod(input: unknown): input is Period;
  */
 export declare function isPopulated<T extends {
     length: number;
-} | object>(arg: CanBePopulated | undefined | null): arg is T;
+} | Record<string, any>>(arg: CanBePopulated | undefined | null): arg is T;
 
 /**
  * Returns true if the type code is a primitive type.
@@ -4247,6 +4423,20 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * @returns Promise to the result. If waiting for response, the result is the response body. Otherwise, it is an operation outcome.
      */
     pushToAgent(agent: Agent | Reference<Agent>, destination: Device | Reference<Device> | string, body: any, contentType?: string, waitForResponse?: boolean, options?: PushToAgentOptions): Promise<any>;
+    /**
+     * Reads the list of available CDS services.
+     * @param options - Optional fetch options.
+     * @returns The list of CDS services.
+     */
+    getCdsServices(options?: MedplumRequestOptions): Promise<CdsDiscoveryResponse>;
+    /**
+     * Calls a CDS service by ID.
+     * @param id - The CDS service ID.
+     * @param body - The CDS request body.
+     * @param options - Optional fetch options.
+     * @returns The CDS response.
+     */
+    callCdsService(id: string, body: CdsRequest, options?: MedplumRequestOptions): Promise<CdsResponse>;
     /**
      * @category Authentication
      * @returns The Login State
@@ -5413,6 +5603,22 @@ export declare const OAuthGrantType: {
 
 export declare type OAuthGrantType = (typeof OAuthGrantType)[keyof typeof OAuthGrantType];
 
+/**
+ * OAuth Signing Algorithms
+ * See {@link https://datatracker.ietf.org/doc/html/rfc7519 | RFC 7519} for full details.
+ */
+export declare const OAuthSigningAlgorithm: {
+    readonly ES256: "ES256";
+    readonly ES384: "ES384";
+    readonly ES512: "ES512";
+    readonly HS256: "HS256";
+    readonly RS256: "RS256";
+    readonly RS384: "RS384";
+    readonly RS512: "RS512";
+};
+
+export declare type OAuthSigningAlgorithm = (typeof OAuthSigningAlgorithm)[keyof typeof OAuthSigningAlgorithm];
+
 /**
  * OAuth 2.0 Client Authentication Methods
  * See: https://openid.net/specs/openid-connect-core-1_0.html#ClientAuthentication
@@ -5655,7 +5861,7 @@ export declare class ParserBuilder {
   * @param query - Optional collection of additional query string parameters.
   * @returns A parsed SearchRequest.
   */
- export declare function parseSearchRequest<T extends Resource = Resource>(url: T['resourceType'] | URL | string, query?: Record<string, string[] | string | undefined>): SearchRequest<T>;
+ export declare function parseSearchRequest<T extends Resource = Resource>(url: URL | string, query?: Record<string, string[] | string | undefined>): SearchRequest<T>;
 
  /**
   * Parses a StructureDefinition resource into an internal schema better suited for
@@ -5774,7 +5980,7 @@ export declare class ParserBuilder {
 
  /**
   * List of property types.
-  * http://www.hl7.org/fhir/valueset-defined-types.html
+  * http://www.hl7.org/fhir/R4/valueset-defined-types.html
   * The list here includes additions found from StructureDefinition resources.
   */
  export declare const PropertyType: {
@@ -5793,6 +5999,8 @@ export declare class ParserBuilder {
      readonly Distance: "Distance";
      readonly Dosage: "Dosage";
      readonly Duration: "Duration";
+     readonly Element: "Element";
+     readonly ElementDefinition: "ElementDefinition";
      readonly Expression: "Expression";
      readonly Extension: "Extension";
      readonly HumanName: "HumanName";
@@ -5800,6 +6008,7 @@ export declare class ParserBuilder {
      readonly MarketingStatus: "MarketingStatus";
      readonly Meta: "Meta";
      readonly Money: "Money";
+     readonly MoneyQuantity: "MoneyQuantity";
      readonly Narrative: "Narrative";
      readonly ParameterDefinition: "ParameterDefinition";
      readonly Period: "Period";
@@ -5813,6 +6022,7 @@ export declare class ParserBuilder {
      readonly RelatedArtifact: "RelatedArtifact";
      readonly SampledData: "SampledData";
      readonly Signature: "Signature";
+     readonly SimpleQuantity: "SimpleQuantity";
      readonly SubstanceAmount: "SubstanceAmount";
      readonly SystemString: "http://hl7.org/fhirpath/System.String";
      readonly Timing: "Timing";
@@ -5837,6 +6047,7 @@ export declare class ParserBuilder {
      readonly uri: "uri";
      readonly url: "url";
      readonly uuid: "uuid";
+     readonly xhtml: "xhtml";
  };
 
  /**
@@ -5869,9 +6080,14 @@ export declare class ParserBuilder {
  export declare type QueryTypes = URLSearchParams | string[][] | Record<string, string | number | boolean | undefined> | string | undefined;
 
  export declare type RateLimitInfo = {
+     /** Name of the rate limiter. */
      name: string;
+     /** Remaining rate limit quota units. */
      remainingUnits: number;
+     /** Number of seconds until the rate limit resets to its full quota. */
      secondsUntilReset: number;
+     /** Timestamp (seconds from 1970-01-01T00:00:00Z) after which the rate limiter resets to its full quota. */
+     resetsAfter: number;
  };
 
  /**
@@ -6621,16 +6837,16 @@ export declare class ParserBuilder {
 
  export declare class TypedEventTarget<TEvents extends Record<string, Event_2>> {
      private readonly emitter;
-     dispatchEvent<TEventType extends keyof TEvents & string>(event: TEvents[TEventType]): void;
-     addEventListener<TEventType extends keyof TEvents & string>(type: TEventType, handler: (event: TEvents[TEventType]) => void): void;
-     removeEventListener<TEventType extends keyof TEvents & string>(type: TEventType, handler: (event: TEvents[TEventType]) => void): void;
+     dispatchEvent<TEventType extends keyof TEvents>(event: TEvents[TEventType]): void;
+     addEventListener<TEventType extends keyof TEvents>(type: TEventType, handler: (event: TEvents[TEventType]) => void): void;
+     removeEventListener<TEventType extends keyof TEvents>(type: TEventType, handler: (event: TEvents[TEventType]) => void): void;
      removeAllListeners(): void;
      /**
       * Gets the number of listeners for the provided Event type.
       * @param type - The name of the Event type.
       * @returns The number of listeners for this Event type.
       */
-     listenerCount<TEventType extends keyof TEvents & string>(type: TEventType): number;
+     listenerCount<TEventType extends keyof TEvents>(type: TEventType): number;
  }
 
  export declare interface TypedValue {