@medplum/core 5.0.7 → 5.0.8

package/dist/cjs/index.d.ts

@@ -3869,6 +3869,7 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * @returns The resource if available.
      */
     readReference<T extends Resource>(reference: Reference<T>, options?: MedplumRequestOptions): ReadablePromise<WithId<T>>;
+    readCanonical<RT extends ResourceType>(resourceType: RT | RT[], url: string, options?: MedplumRequestOptions): ReadablePromise<WithId<ExtractResource<RT>> | undefined>;
     /**
      * Requests the schema for a resource type.
      * If the schema is already cached, the promise is resolved immediately.
@@ -6298,6 +6299,30 @@ export declare class ParserBuilder {
   */
  export declare function reorderBundle(bundle: Bundle): Bundle;
 
+ /**
+  * Replaces prefetch query variables with values from the context or user profile.
+  *
+  * A prefetch token is a placeholder in a prefetch template that is *replaced by information from the hook's context*
+  * to construct the FHIR URL used to request the prefetch data.
+  *
+  * Prefetch tokens MUST be delimited by `{{` and `}}`, and MUST contain only the qualified path to a hook context field
+  * or one of the following user identifiers: `userPractitionerId`, `userPractitionerRoleId`, `userPatientId`, or `userRelatedPersonId`.
+  *
+  * Note that the spec says:
+  *
+  *   > Individual hooks specify which of their `context` fields can be used as prefetch tokens.
+  *   > Only root-level fields with a primitive value within the `context` object are eligible to be used as prefetch tokens.
+  *   > For example, `{{context.medication.id}}` is not a valid prefetch token because it attempts to access the `id` field of the `medication` field.
+  *
+  * Unfortunately, many CDS Hooks services do not follow this rule. Therefore, this implementation allows access to nested fields.
+  *
+  * @param user - The user resource.
+  * @param context - The CDS request context.
+  * @param query - The prefetch query template.
+  * @returns The prefetch query with variables replaced.
+  */
+ export declare function replaceQueryVariables(user: CdsUserResource, context: Record<string, unknown>, query: string): string;
+
  export declare interface RequestProfileSchemaOptions {
      /** (optional) Whether to include nested profiles, e.g. from extensions. Defaults to false. */
      expandProfile?: boolean;

package/dist/esm/index.d.ts

@@ -3869,6 +3869,7 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * @returns The resource if available.
      */
     readReference<T extends Resource>(reference: Reference<T>, options?: MedplumRequestOptions): ReadablePromise<WithId<T>>;
+    readCanonical<RT extends ResourceType>(resourceType: RT | RT[], url: string, options?: MedplumRequestOptions): ReadablePromise<WithId<ExtractResource<RT>> | undefined>;
     /**
      * Requests the schema for a resource type.
      * If the schema is already cached, the promise is resolved immediately.
@@ -6298,6 +6299,30 @@ export declare class ParserBuilder {
   */
  export declare function reorderBundle(bundle: Bundle): Bundle;
 
+ /**
+  * Replaces prefetch query variables with values from the context or user profile.
+  *
+  * A prefetch token is a placeholder in a prefetch template that is *replaced by information from the hook's context*
+  * to construct the FHIR URL used to request the prefetch data.
+  *
+  * Prefetch tokens MUST be delimited by `{{` and `}}`, and MUST contain only the qualified path to a hook context field
+  * or one of the following user identifiers: `userPractitionerId`, `userPractitionerRoleId`, `userPatientId`, or `userRelatedPersonId`.
+  *
+  * Note that the spec says:
+  *
+  *   > Individual hooks specify which of their `context` fields can be used as prefetch tokens.
+  *   > Only root-level fields with a primitive value within the `context` object are eligible to be used as prefetch tokens.
+  *   > For example, `{{context.medication.id}}` is not a valid prefetch token because it attempts to access the `id` field of the `medication` field.
+  *
+  * Unfortunately, many CDS Hooks services do not follow this rule. Therefore, this implementation allows access to nested fields.
+  *
+  * @param user - The user resource.
+  * @param context - The CDS request context.
+  * @param query - The prefetch query template.
+  * @returns The prefetch query with variables replaced.
+  */
+ export declare function replaceQueryVariables(user: CdsUserResource, context: Record<string, unknown>, query: string): string;
+
  export declare interface RequestProfileSchemaOptions {
      /** (optional) Whether to include nested profiles, e.g. from extensions. Defaults to false. */
      expandProfile?: boolean;