@medplum/core 3.0.2 → 3.0.3

package/dist/cjs/index.d.ts

@@ -395,6 +395,7 @@ export declare const ContentType: {
     readonly SVG: "image/svg+xml";
     readonly TEXT: "text/plain";
     readonly TYPESCRIPT: "text/typescript";
+    readonly PING: "x-application/ping";
 };
 
 /**
@@ -1197,9 +1198,10 @@ export declare function getDisplayString(resource: Resource): string;
  * Returns an element definition by type and property name.
  * @param typeName - The type name.
  * @param propertyName - The property name.
+ * @param profileUrl - (optional) The URL of the current resource profile
  * @returns The element definition if found.
  */
-export declare function getElementDefinition(typeName: string, propertyName: string): InternalSchemaElement | undefined;
+export declare function getElementDefinition(typeName: string, propertyName: string, profileUrl?: string): InternalSchemaElement | undefined;
 
 /**
  * Returns an element definition from mapping of elements by property name.
@@ -1255,7 +1257,9 @@ export declare function getIdentifier(resource: Resource, system: string): strin
  */
 export declare function getImageSrc(resource: Resource): string | undefined;
 
-export declare function getNestedProperty(value: TypedValue, key: string): (TypedValue | TypedValue[] | undefined)[];
+export declare function getNestedProperty(value: TypedValue, key: string, options?: {
+    profileUrl?: string;
+}): (TypedValue | TypedValue[] | undefined)[];
 
 /**
  * Returns a human friendly display name for a FHIR element definition path.
@@ -1338,18 +1342,24 @@ export declare function getStatus(outcome: OperationOutcome): number;
  * This function returns the value and the type.
  * @param input - The base context (FHIR resource or backbone element).
  * @param path - The property path.
+ * @param options - (optional) Additional options
  * @returns The value of the property and the property type.
  */
-export declare function getTypedPropertyValue(input: TypedValue, path: string): TypedValue[] | TypedValue | undefined;
+export declare function getTypedPropertyValue(input: TypedValue, path: string, options?: GetTypedPropertyValueOptions): TypedValue[] | TypedValue | undefined;
+
+export declare interface GetTypedPropertyValueOptions {
+    /** (optional) URL of a resource profile for type resolution */
+    profileUrl?: string;
+}
 
 /**
  * Returns the value of the property and the property type using a type schema.
- * @param value - The base context (FHIR resource or backbone element).
+ * @param typedValue - The base context (FHIR resource or backbone element).
  * @param path - The property path.
  * @param element - The property element definition.
  * @returns The value of the property and the property type.
  */
-export declare function getTypedPropertyValueWithSchema(value: TypedValue['value'], path: string, element: InternalSchemaElement): TypedValue[] | TypedValue | undefined;
+export declare function getTypedPropertyValueWithSchema(typedValue: TypedValue, path: string, element: InternalSchemaElement): TypedValue[] | TypedValue | undefined;
 
 /**
  * Global schema singleton.
@@ -2647,7 +2657,7 @@ export declare class MedplumClient extends EventTarget_2 {
      * @param resourceType - The FHIR resource type.
      * @param id - The resource ID.
      * @param options - Optional fetch options.
-     * @returns The resource if available; undefined otherwise.
+     * @returns The resource if available.
      */
     readResource<K extends ResourceType>(resourceType: K, id: string, options?: RequestInit): ReadablePromise<ExtractResource<K>>;
     /**
@@ -2668,7 +2678,7 @@ export declare class MedplumClient extends EventTarget_2 {
      * @category Read
      * @param reference - The FHIR reference object.
      * @param options - Optional fetch options.
-     * @returns The resource if available; undefined otherwise.
+     * @returns The resource if available.
      */
     readReference<T extends Resource>(reference: Reference<T>, options?: RequestInit): ReadablePromise<T>;
     /**
@@ -2684,9 +2694,10 @@ export declare class MedplumClient extends EventTarget_2 {
      * If the schema is already cached, the promise is resolved immediately.
      * @category Schema
      * @param profileUrl - The FHIR URL of the profile
-     * @returns Promise to a schema with the requested profile.
+     * @param options - (optional) Additional options
+     * @returns Promise with an array of URLs of the profile(s) loaded.
      */
-    requestProfileSchema(profileUrl: string): Promise<void>;
+    requestProfileSchema(profileUrl: string, options?: RequestProfileSchemaOptions): Promise<string[]>;
     /**
      * Reads resource history by resource type and ID.
      *
@@ -2725,7 +2736,7 @@ export declare class MedplumClient extends EventTarget_2 {
      * @param id - The resource ID.
      * @param vid - The version ID.
      * @param options - Optional fetch options.
-     * @returns The resource if available; undefined otherwise.
+     * @returns The resource if available.
      */
     readVersion<K extends ResourceType>(resourceType: K, id: string, vid: string, options?: RequestInit): ReadablePromise<ExtractResource<K>>;
     /**
@@ -3168,7 +3179,7 @@ export declare class MedplumClient extends EventTarget_2 {
      * @param options - Optional fetch options.
      * @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>, body: any, contentType?: string, waitForResponse?: boolean, options?: RequestInit): Promise<any>;
+    pushToAgent(agent: Agent | Reference<Agent>, destination: Device | Reference<Device> | string, body: any, contentType?: string, waitForResponse?: boolean, options?: RequestInit): Promise<any>;
     /**
      * @category Authentication
      * @returns The Login State
@@ -4474,6 +4485,11 @@ export declare function removeDuplicates(arr: TypedValue[]): TypedValue[];
  */
 export declare function reorderBundle(bundle: Bundle): Bundle;
 
+export declare interface RequestProfileSchemaOptions {
+    /** (optional) Whether to include nested profiles, e.g. from extensions. Defaults to false. */
+    expandProfile?: boolean;
+}
+
 /**
  * Returns the ID portion of a reference.
  * @param input - A FHIR reference or resource.
@@ -4599,6 +4615,7 @@ export declare interface SliceDefinition {
     elements: Record<string, InternalSchemaElement>;
     min: number;
     max: number;
+    binding?: ElementDefinitionBinding;
 }
 
 export declare interface SliceDiscriminator {
@@ -4620,6 +4637,15 @@ export declare interface SortRule {
     descending?: boolean;
 }
 
+/**
+ * Splits a string into an array of strings using the specified delimiter.
+ * Unlike the built-in split function, this function will split the string into a maximum of exactly n parts.
+ * Trailing empty strings are included in the result.
+ * @param str - The string to split.
+ * @param delim - The delimiter.
+ * @param n - The maximum number of parts to split the string into.
+ * @returns The resulting array of strings.
+ */
 export declare function splitN(str: string, delim: string, n: number): string[];
 
 /**

package/dist/esm/index.d.ts

@@ -395,6 +395,7 @@ export declare const ContentType: {
     readonly SVG: "image/svg+xml";
     readonly TEXT: "text/plain";
     readonly TYPESCRIPT: "text/typescript";
+    readonly PING: "x-application/ping";
 };
 
 /**
@@ -1197,9 +1198,10 @@ export declare function getDisplayString(resource: Resource): string;
  * Returns an element definition by type and property name.
  * @param typeName - The type name.
  * @param propertyName - The property name.
+ * @param profileUrl - (optional) The URL of the current resource profile
  * @returns The element definition if found.
  */
-export declare function getElementDefinition(typeName: string, propertyName: string): InternalSchemaElement | undefined;
+export declare function getElementDefinition(typeName: string, propertyName: string, profileUrl?: string): InternalSchemaElement | undefined;
 
 /**
  * Returns an element definition from mapping of elements by property name.
@@ -1255,7 +1257,9 @@ export declare function getIdentifier(resource: Resource, system: string): strin
  */
 export declare function getImageSrc(resource: Resource): string | undefined;
 
-export declare function getNestedProperty(value: TypedValue, key: string): (TypedValue | TypedValue[] | undefined)[];
+export declare function getNestedProperty(value: TypedValue, key: string, options?: {
+    profileUrl?: string;
+}): (TypedValue | TypedValue[] | undefined)[];
 
 /**
  * Returns a human friendly display name for a FHIR element definition path.
@@ -1338,18 +1342,24 @@ export declare function getStatus(outcome: OperationOutcome): number;
  * This function returns the value and the type.
  * @param input - The base context (FHIR resource or backbone element).
  * @param path - The property path.
+ * @param options - (optional) Additional options
  * @returns The value of the property and the property type.
  */
-export declare function getTypedPropertyValue(input: TypedValue, path: string): TypedValue[] | TypedValue | undefined;
+export declare function getTypedPropertyValue(input: TypedValue, path: string, options?: GetTypedPropertyValueOptions): TypedValue[] | TypedValue | undefined;
+
+export declare interface GetTypedPropertyValueOptions {
+    /** (optional) URL of a resource profile for type resolution */
+    profileUrl?: string;
+}
 
 /**
  * Returns the value of the property and the property type using a type schema.
- * @param value - The base context (FHIR resource or backbone element).
+ * @param typedValue - The base context (FHIR resource or backbone element).
  * @param path - The property path.
  * @param element - The property element definition.
  * @returns The value of the property and the property type.
  */
-export declare function getTypedPropertyValueWithSchema(value: TypedValue['value'], path: string, element: InternalSchemaElement): TypedValue[] | TypedValue | undefined;
+export declare function getTypedPropertyValueWithSchema(typedValue: TypedValue, path: string, element: InternalSchemaElement): TypedValue[] | TypedValue | undefined;
 
 /**
  * Global schema singleton.
@@ -2647,7 +2657,7 @@ export declare class MedplumClient extends EventTarget_2 {
      * @param resourceType - The FHIR resource type.
      * @param id - The resource ID.
      * @param options - Optional fetch options.
-     * @returns The resource if available; undefined otherwise.
+     * @returns The resource if available.
      */
     readResource<K extends ResourceType>(resourceType: K, id: string, options?: RequestInit): ReadablePromise<ExtractResource<K>>;
     /**
@@ -2668,7 +2678,7 @@ export declare class MedplumClient extends EventTarget_2 {
      * @category Read
      * @param reference - The FHIR reference object.
      * @param options - Optional fetch options.
-     * @returns The resource if available; undefined otherwise.
+     * @returns The resource if available.
      */
     readReference<T extends Resource>(reference: Reference<T>, options?: RequestInit): ReadablePromise<T>;
     /**
@@ -2684,9 +2694,10 @@ export declare class MedplumClient extends EventTarget_2 {
      * If the schema is already cached, the promise is resolved immediately.
      * @category Schema
      * @param profileUrl - The FHIR URL of the profile
-     * @returns Promise to a schema with the requested profile.
+     * @param options - (optional) Additional options
+     * @returns Promise with an array of URLs of the profile(s) loaded.
      */
-    requestProfileSchema(profileUrl: string): Promise<void>;
+    requestProfileSchema(profileUrl: string, options?: RequestProfileSchemaOptions): Promise<string[]>;
     /**
      * Reads resource history by resource type and ID.
      *
@@ -2725,7 +2736,7 @@ export declare class MedplumClient extends EventTarget_2 {
      * @param id - The resource ID.
      * @param vid - The version ID.
      * @param options - Optional fetch options.
-     * @returns The resource if available; undefined otherwise.
+     * @returns The resource if available.
      */
     readVersion<K extends ResourceType>(resourceType: K, id: string, vid: string, options?: RequestInit): ReadablePromise<ExtractResource<K>>;
     /**
@@ -3168,7 +3179,7 @@ export declare class MedplumClient extends EventTarget_2 {
      * @param options - Optional fetch options.
      * @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>, body: any, contentType?: string, waitForResponse?: boolean, options?: RequestInit): Promise<any>;
+    pushToAgent(agent: Agent | Reference<Agent>, destination: Device | Reference<Device> | string, body: any, contentType?: string, waitForResponse?: boolean, options?: RequestInit): Promise<any>;
     /**
      * @category Authentication
      * @returns The Login State
@@ -4474,6 +4485,11 @@ export declare function removeDuplicates(arr: TypedValue[]): TypedValue[];
  */
 export declare function reorderBundle(bundle: Bundle): Bundle;
 
+export declare interface RequestProfileSchemaOptions {
+    /** (optional) Whether to include nested profiles, e.g. from extensions. Defaults to false. */
+    expandProfile?: boolean;
+}
+
 /**
  * Returns the ID portion of a reference.
  * @param input - A FHIR reference or resource.
@@ -4599,6 +4615,7 @@ export declare interface SliceDefinition {
     elements: Record<string, InternalSchemaElement>;
     min: number;
     max: number;
+    binding?: ElementDefinitionBinding;
 }
 
 export declare interface SliceDiscriminator {
@@ -4620,6 +4637,15 @@ export declare interface SortRule {
     descending?: boolean;
 }
 
+/**
+ * Splits a string into an array of strings using the specified delimiter.
+ * Unlike the built-in split function, this function will split the string into a maximum of exactly n parts.
+ * Trailing empty strings are included in the result.
+ * @param str - The string to split.
+ * @param delim - The delimiter.
+ * @param n - The maximum number of parts to split the string into.
+ * @returns The resulting array of strings.
+ */
 export declare function splitN(str: string, delim: string, n: number): string[];
 
 /**