@medplum/core 0.9.4 → 0.9.7

package/dist/types/fhirpath/index.d.ts

@@ -0,0 +1,2 @@
+export * from './parse';
+export * from './tokenize';

package/dist/types/fhirpath/parse.d.ts

@@ -0,0 +1,17 @@
+import { FhirPathAtom } from './atoms';
+/**
+ * Parses a FHIRPath expression into an AST.
+ * The result can be used to evaluate the expression against a resource or other object.
+ * This method is useful if you know that you will evaluate the same expression many times
+ * against different resources.
+ * @param input The FHIRPath expression to parse.
+ * @returns The AST representing the expression.
+ */
+export declare function parseFhirPath(input: string): FhirPathAtom;
+/**
+ * Evaluates a FHIRPath expression against a resource or other object.
+ * @param input The FHIRPath expression to parse.
+ * @param context The resource or object to evaluate the expression against.
+ * @returns The result of the FHIRPath expression against the resource or object.
+ */
+export declare function evalFhirPath(input: string, context: unknown): unknown[];

package/dist/types/fhirpath/tokenize.d.ts

@@ -0,0 +1,5 @@
+export interface Token {
+    id: string;
+    value: string;
+}
+export declare function tokenize(str: string): Token[];

package/dist/types/fhirpath/utils.d.ts

@@ -0,0 +1,65 @@
+import { Period, Quantity } from '@medplum/fhirtypes';
+/**
+ * Ensures that the value is wrapped in an array.
+ * @param input The input as a an array or a value.
+ * @returns The input as an array.
+ */
+export declare function ensureArray(input: unknown): unknown[];
+/**
+ * Applies a function to single value or an array of values.
+ * @param context The context which will be passed to the function.
+ * @param fn The function to apply.
+ * @returns The result of the function.
+ */
+export declare function applyMaybeArray(context: unknown, fn: (context: unknown) => unknown): unknown;
+/**
+ * Determines if the input is an empty array.
+ * @param obj Any value or array of values.
+ * @returns True if the input is an empty array.
+ */
+export declare function isEmptyArray(obj: unknown): boolean;
+export declare function isFalsy(obj: unknown): boolean;
+/**
+ * Converts unknown object into a JavaScript boolean.
+ * Note that this is different than the FHIRPath "toBoolean",
+ * which has particular semantics around arrays, empty arrays, and type conversions.
+ * @param obj Any value or array of values.
+ * @returns The converted boolean value according to FHIRPath rules.
+ */
+export declare function toJsBoolean(obj: unknown): boolean;
+/**
+ * Removes duplicates in array using FHIRPath equality rules.
+ * @param arr The input array.
+ * @returns The result array with duplicates removed.
+ */
+export declare function removeDuplicates(arr: unknown[]): unknown[];
+/**
+ * Determines if two values are equal according to FHIRPath equality rules.
+ * @param x The first value.
+ * @param y The second value.
+ * @returns True if equal.
+ */
+export declare function fhirPathEquals(x: unknown, y: unknown): boolean | [];
+/**
+ * Determines if two values are equal according to FHIRPath equality rules.
+ * @param x The first value.
+ * @param y The second value.
+ * @returns True if equal.
+ */
+export declare function fhirPathEquivalent(x: unknown, y: unknown): boolean | [];
+export declare function fhirPathIs(value: unknown, desiredType: unknown): boolean;
+/**
+ * Determines if the input is a Period object.
+ * This is heuristic based, as we do not have strong typing at runtime.
+ * @param input The input value.
+ * @returns True if the input is a period.
+ */
+export declare function isPeriod(input: unknown): input is Period;
+/**
+ * Determines if the input is a Quantity object.
+ * This is heuristic based, as we do not have strong typing at runtime.
+ * @param input The input value.
+ * @returns True if the input is a quantity.
+ */
+export declare function isQuantity(input: unknown): input is Quantity;
+export declare function isQuantityEquivalent(x: Quantity, y: Quantity): boolean;

package/dist/types/format.d.ts

@@ -1,15 +1,15 @@
-import { Address, HumanName } from '@medplum/fhirtypes';
-export interface AddressFormatOptions {
-    all?: boolean;
-    use?: boolean;
-}
-export interface HumanNameFormatOptions {
-    all?: boolean;
-    prefix?: boolean;
-    suffix?: boolean;
-    use?: boolean;
-}
-export declare function formatAddress(address: Address, options?: AddressFormatOptions): string;
-export declare function formatHumanName(name: HumanName, options?: HumanNameFormatOptions): string;
-export declare function formatGivenName(name: HumanName): string;
-export declare function formatFamilyName(name: HumanName): string;
+import { Address, HumanName } from '@medplum/fhirtypes';
+export interface AddressFormatOptions {
+    all?: boolean;
+    use?: boolean;
+}
+export interface HumanNameFormatOptions {
+    all?: boolean;
+    prefix?: boolean;
+    suffix?: boolean;
+    use?: boolean;
+}
+export declare function formatAddress(address: Address, options?: AddressFormatOptions): string;
+export declare function formatHumanName(name: HumanName, options?: HumanNameFormatOptions): string;
+export declare function formatGivenName(name: HumanName): string;
+export declare function formatFamilyName(name: HumanName): string;

package/dist/types/hl7.d.ts

@@ -1,43 +1,43 @@
-export declare const SEGMENT_SEPARATOR = "\r";
-export declare const FIELD_SEPARATOR = "|";
-export declare const COMPONENT_SEPARATOR = "^";
-/**
- * The Hl7Message class represents one HL7 message.
- * A message is a collection of segments.
- * Note that we do not strictly parse messages, and only use default delimeters.
- */
-export declare class Hl7Message {
-    readonly segments: Hl7Segment[];
-    constructor(segments: Hl7Segment[]);
-    get(index: number | string): Hl7Segment | undefined;
-    getAll(name: string): Hl7Segment[];
-    toString(): string;
-    buildAck(): Hl7Message;
-    static parse(text: string): Hl7Message;
-}
-/**
- * The Hl7Segment class represents one HL7 segment.
- * A segment is a collection of fields.
- * The name field is the first field.
- * Note that we do not strictly parse messages, and only use default delimeters.
- */
-export declare class Hl7Segment {
-    readonly name: string;
-    readonly fields: Hl7Field[];
-    constructor(fields: Hl7Field[] | string[]);
-    get(index: number): Hl7Field;
-    toString(): string;
-    static parse(text: string): Hl7Segment;
-}
-/**
- * The Hl7Field class represents one HL7 field.
- * A field is a collection of components.
- * Note that we do not strictly parse messages, and only use default delimeters.
- */
-export declare class Hl7Field {
-    readonly components: string[];
-    constructor(components: string[]);
-    get(index: number): string;
-    toString(): string;
-    static parse(text: string): Hl7Field;
-}
+export declare const SEGMENT_SEPARATOR = "\r";
+export declare const FIELD_SEPARATOR = "|";
+export declare const COMPONENT_SEPARATOR = "^";
+/**
+ * The Hl7Message class represents one HL7 message.
+ * A message is a collection of segments.
+ * Note that we do not strictly parse messages, and only use default delimeters.
+ */
+export declare class Hl7Message {
+    readonly segments: Hl7Segment[];
+    constructor(segments: Hl7Segment[]);
+    get(index: number | string): Hl7Segment | undefined;
+    getAll(name: string): Hl7Segment[];
+    toString(): string;
+    buildAck(): Hl7Message;
+    static parse(text: string): Hl7Message;
+}
+/**
+ * The Hl7Segment class represents one HL7 segment.
+ * A segment is a collection of fields.
+ * The name field is the first field.
+ * Note that we do not strictly parse messages, and only use default delimeters.
+ */
+export declare class Hl7Segment {
+    readonly name: string;
+    readonly fields: Hl7Field[];
+    constructor(fields: Hl7Field[] | string[]);
+    get(index: number): Hl7Field;
+    toString(): string;
+    static parse(text: string): Hl7Segment;
+}
+/**
+ * The Hl7Field class represents one HL7 field.
+ * A field is a collection of components.
+ * Note that we do not strictly parse messages, and only use default delimeters.
+ */
+export declare class Hl7Field {
+    readonly components: string[];
+    constructor(components: string[]);
+    get(index: number): string;
+    toString(): string;
+    static parse(text: string): Hl7Field;
+}

package/dist/types/index.d.ts

@@ -1,10 +1,11 @@
-export * from './cache';
-export * from './client';
-export * from './format';
-export * from './hl7';
-export * from './outcomes';
-export * from './readablepromise';
-export * from './search';
-export * from './searchparams';
-export * from './types';
-export * from './utils';
+export * from './cache';
+export * from './client';
+export * from './fhirpath';
+export * from './format';
+export * from './hl7';
+export * from './outcomes';
+export * from './readablepromise';
+export * from './search';
+export * from './searchparams';
+export * from './types';
+export * from './utils';

package/dist/types/jwt.d.ts

@@ -1,5 +1,5 @@
-/**
- * Parses the JWT payload.
- * @param token JWT token
- */
-export declare function parseJWTPayload(token: string): Record<string, number | string>;
+/**
+ * Parses the JWT payload.
+ * @param token JWT token
+ */
+export declare function parseJWTPayload(token: string): Record<string, number | string>;

package/dist/types/outcomes.d.ts

@@ -1,22 +1,22 @@
-import { OperationOutcome } from '@medplum/fhirtypes';
-export declare const allOk: OperationOutcome;
-export declare const created: OperationOutcome;
-export declare const notModified: OperationOutcome;
-export declare const notFound: OperationOutcome;
-export declare const gone: OperationOutcome;
-export declare const accessDenied: OperationOutcome;
-export declare function badRequest(details: string, expression?: string): OperationOutcome;
-export declare function isOk(outcome: OperationOutcome): boolean;
-export declare function isNotFound(outcome: OperationOutcome): boolean;
-export declare function isGone(outcome: OperationOutcome): boolean;
-export declare function getStatus(outcome: OperationOutcome): number;
-/**
- * Asserts that the operation completed successfully and that the resource is defined.
- * @param outcome The operation outcome.
- * @param resource The resource that may or may not have been returned.
- */
-export declare function assertOk<T>(outcome: OperationOutcome, resource: T | undefined): asserts resource is T;
-export declare class OperationOutcomeError extends Error {
-    readonly outcome: OperationOutcome;
-    constructor(outcome: OperationOutcome);
-}
+import { OperationOutcome } from '@medplum/fhirtypes';
+export declare const allOk: OperationOutcome;
+export declare const created: OperationOutcome;
+export declare const notModified: OperationOutcome;
+export declare const notFound: OperationOutcome;
+export declare const gone: OperationOutcome;
+export declare const accessDenied: OperationOutcome;
+export declare function badRequest(details: string, expression?: string): OperationOutcome;
+export declare function isOk(outcome: OperationOutcome): boolean;
+export declare function isNotFound(outcome: OperationOutcome): boolean;
+export declare function isGone(outcome: OperationOutcome): boolean;
+export declare function getStatus(outcome: OperationOutcome): number;
+/**
+ * Asserts that the operation completed successfully and that the resource is defined.
+ * @param outcome The operation outcome.
+ * @param resource The resource that may or may not have been returned.
+ */
+export declare function assertOk<T>(outcome: OperationOutcome, resource: T | undefined): asserts resource is T;
+export declare class OperationOutcomeError extends Error {
+    readonly outcome: OperationOutcome;
+    constructor(outcome: OperationOutcome);
+}

package/dist/types/readablepromise.d.ts

@@ -1,43 +1,43 @@
-/**
- * The ReadablePromise class wraps a request promise suitable for React Suspense.
- * See: https://blog.logrocket.com/react-suspense-data-fetching/#wrappromise-js
- * See: https://github.com/ovieokeh/suspense-data-fetching/blob/master/lib/api/wrapPromise.js
- */
-export declare class ReadablePromise<T> implements Promise<T> {
-    #private;
-    readonly [Symbol.toStringTag]: string;
-    constructor(requestPromise: Promise<T>);
-    /**
-     * Returns true if the promise is pending.
-     * @returns True if the Promise is pending.
-     */
-    isPending(): boolean;
-    /**
-     * Attempts to read the value of the promise.
-     * If the promise is pending, this method will throw a promise.
-     * If the promise rejected, this method will throw the rejection reason.
-     * If the promise resolved, this method will return the resolved value.
-     * @returns The resolved value of the Promise.
-     */
-    read(): T;
-    /**
-     * Attaches callbacks for the resolution and/or rejection of the Promise.
-     * @param onfulfilled The callback to execute when the Promise is resolved.
-     * @param onrejected The callback to execute when the Promise is rejected.
-     * @returns A Promise for the completion of which ever callback is executed.
-     */
-    then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | undefined | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null): Promise<TResult1 | TResult2>;
-    /**
-     * Attaches a callback for only the rejection of the Promise.
-     * @param onrejected The callback to execute when the Promise is rejected.
-     * @returns A Promise for the completion of the callback.
-     */
-    catch<TResult = never>(onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | undefined | null): Promise<T | TResult>;
-    /**
-     * Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The
-     * resolved value cannot be modified from the callback.
-     * @param onfinally The callback to execute when the Promise is settled (fulfilled or rejected).
-     * @returns A Promise for the completion of the callback.
-     */
-    finally(onfinally?: (() => void) | undefined | null): Promise<T>;
-}
+/**
+ * The ReadablePromise class wraps a request promise suitable for React Suspense.
+ * See: https://blog.logrocket.com/react-suspense-data-fetching/#wrappromise-js
+ * See: https://github.com/ovieokeh/suspense-data-fetching/blob/master/lib/api/wrapPromise.js
+ */
+export declare class ReadablePromise<T> implements Promise<T> {
+    #private;
+    readonly [Symbol.toStringTag]: string;
+    constructor(requestPromise: Promise<T>);
+    /**
+     * Returns true if the promise is pending.
+     * @returns True if the Promise is pending.
+     */
+    isPending(): boolean;
+    /**
+     * Attempts to read the value of the promise.
+     * If the promise is pending, this method will throw a promise.
+     * If the promise rejected, this method will throw the rejection reason.
+     * If the promise resolved, this method will return the resolved value.
+     * @returns The resolved value of the Promise.
+     */
+    read(): T;
+    /**
+     * Attaches callbacks for the resolution and/or rejection of the Promise.
+     * @param onfulfilled The callback to execute when the Promise is resolved.
+     * @param onrejected The callback to execute when the Promise is rejected.
+     * @returns A Promise for the completion of which ever callback is executed.
+     */
+    then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | undefined | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null): Promise<TResult1 | TResult2>;
+    /**
+     * Attaches a callback for only the rejection of the Promise.
+     * @param onrejected The callback to execute when the Promise is rejected.
+     * @returns A Promise for the completion of the callback.
+     */
+    catch<TResult = never>(onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | undefined | null): Promise<T | TResult>;
+    /**
+     * Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The
+     * resolved value cannot be modified from the callback.
+     * @param onfinally The callback to execute when the Promise is settled (fulfilled or rejected).
+     * @returns A Promise for the completion of the callback.
+     */
+    finally(onfinally?: (() => void) | undefined | null): Promise<T>;
+}

package/dist/types/search.d.ts

@@ -1,62 +1,62 @@
-export declare const DEFAULT_SEARCH_COUNT = 20;
-export interface SearchRequest {
-    readonly resourceType: string;
-    filters?: Filter[];
-    sortRules?: SortRule[];
-    offset?: number;
-    count?: number;
-    fields?: string[];
-    name?: string;
-    total?: 'none' | 'estimate' | 'accurate';
-}
-export interface Filter {
-    code: string;
-    operator: Operator;
-    value: string;
-    unitSystem?: string;
-    unitCode?: string;
-}
-export interface SortRule {
-    code: string;
-    descending?: boolean;
-}
-/**
- * Search operators.
- * These operators represent "modifiers" and "prefixes" in FHIR search.
- * See: https://www.hl7.org/fhir/search.html
- */
-export declare enum Operator {
-    EQUALS = "eq",
-    NOT_EQUALS = "ne",
-    GREATER_THAN = "gt",
-    LESS_THAN = "lt",
-    GREATER_THAN_OR_EQUALS = "ge",
-    LESS_THAN_OR_EQUALS = "le",
-    STARTS_AFTER = "sa",
-    ENDS_BEFORE = "eb",
-    APPROXIMATELY = "ap",
-    CONTAINS = "contains",
-    EXACT = "exact",
-    TEXT = "text",
-    ABOVE = "above",
-    BELOW = "below",
-    IN = "in",
-    NOT_IN = "not-in",
-    OF_TYPE = "of-type"
-}
-/**
- * Parses a URL into a SearchRequest.
- *
- * See the FHIR search spec: http://hl7.org/fhir/r4/search.html
- *
- * @param url The URL to parse.
- * @returns Parsed search definition.
- */
-export declare function parseSearchDefinition(url: string): SearchRequest;
-/**
- * Formats a search definition object into a query string.
- * Note: The return value does not include the resource type.
- * @param {!SearchRequest} definition The search definition.
- * @returns Formatted URL.
- */
-export declare function formatSearchQuery(definition: SearchRequest): string;
+export declare const DEFAULT_SEARCH_COUNT = 20;
+export interface SearchRequest {
+    readonly resourceType: string;
+    filters?: Filter[];
+    sortRules?: SortRule[];
+    offset?: number;
+    count?: number;
+    fields?: string[];
+    name?: string;
+    total?: 'none' | 'estimate' | 'accurate';
+}
+export interface Filter {
+    code: string;
+    operator: Operator;
+    value: string;
+    unitSystem?: string;
+    unitCode?: string;
+}
+export interface SortRule {
+    code: string;
+    descending?: boolean;
+}
+/**
+ * Search operators.
+ * These operators represent "modifiers" and "prefixes" in FHIR search.
+ * See: https://www.hl7.org/fhir/search.html
+ */
+export declare enum Operator {
+    EQUALS = "eq",
+    NOT_EQUALS = "ne",
+    GREATER_THAN = "gt",
+    LESS_THAN = "lt",
+    GREATER_THAN_OR_EQUALS = "ge",
+    LESS_THAN_OR_EQUALS = "le",
+    STARTS_AFTER = "sa",
+    ENDS_BEFORE = "eb",
+    APPROXIMATELY = "ap",
+    CONTAINS = "contains",
+    EXACT = "exact",
+    TEXT = "text",
+    ABOVE = "above",
+    BELOW = "below",
+    IN = "in",
+    NOT_IN = "not-in",
+    OF_TYPE = "of-type"
+}
+/**
+ * Parses a URL into a SearchRequest.
+ *
+ * See the FHIR search spec: http://hl7.org/fhir/r4/search.html
+ *
+ * @param url The URL to parse.
+ * @returns Parsed search definition.
+ */
+export declare function parseSearchDefinition(url: string): SearchRequest;
+/**
+ * Formats a search definition object into a query string.
+ * Note: The return value does not include the resource type.
+ * @param {!SearchRequest} definition The search definition.
+ * @returns Formatted URL.
+ */
+export declare function formatSearchQuery(definition: SearchRequest): string;

package/dist/types/searchparams.d.ts

@@ -1,35 +1,35 @@
-import { ElementDefinition, SearchParameter } from '@medplum/fhirtypes';
-import { IndexedStructureDefinition } from './types';
-export declare enum SearchParameterType {
-    BOOLEAN = "BOOLEAN",
-    NUMBER = "NUMBER",
-    QUANTITY = "QUANTITY",
-    TEXT = "TEXT",
-    REFERENCE = "REFERENCE",
-    DATE = "DATE",
-    DATETIME = "DATETIME",
-    PERIOD = "PERIOD"
-}
-export interface SearchParameterDetails {
-    readonly columnName: string;
-    readonly type: SearchParameterType;
-    readonly elementDefinition?: ElementDefinition;
-    readonly array?: boolean;
-}
-/**
- * Returns the type details of a SearchParameter.
- *
- * The SearchParameter resource has a "type" parameter, but that is missing some critical information.
- *
- * For example:
- *   1) The "date" type includes "date", "datetime", and "period".
- *   2) The "token" type includes enums and booleans.
- *   3) Arrays/multiple values are not reflected at all.
- *
- * @param structureDefinitions Collection of StructureDefinition resources indexed by name.
- * @param resourceType The root resource type.
- * @param searchParam The search parameter.
- * @returns The search parameter type details.
- */
-export declare function getSearchParameterDetails(structureDefinitions: IndexedStructureDefinition, resourceType: string, searchParam: SearchParameter): SearchParameterDetails;
-export declare function getExpressionForResourceType(resourceType: string, expression: string): string | undefined;
+import { ElementDefinition, SearchParameter } from '@medplum/fhirtypes';
+import { IndexedStructureDefinition } from './types';
+export declare enum SearchParameterType {
+    BOOLEAN = "BOOLEAN",
+    NUMBER = "NUMBER",
+    QUANTITY = "QUANTITY",
+    TEXT = "TEXT",
+    REFERENCE = "REFERENCE",
+    DATE = "DATE",
+    DATETIME = "DATETIME",
+    PERIOD = "PERIOD"
+}
+export interface SearchParameterDetails {
+    readonly columnName: string;
+    readonly type: SearchParameterType;
+    readonly elementDefinition?: ElementDefinition;
+    readonly array?: boolean;
+}
+/**
+ * Returns the type details of a SearchParameter.
+ *
+ * The SearchParameter resource has a "type" parameter, but that is missing some critical information.
+ *
+ * For example:
+ *   1) The "date" type includes "date", "datetime", and "period".
+ *   2) The "token" type includes enums and booleans.
+ *   3) Arrays/multiple values are not reflected at all.
+ *
+ * @param structureDefinitions Collection of StructureDefinition resources indexed by name.
+ * @param resourceType The root resource type.
+ * @param searchParam The search parameter.
+ * @returns The search parameter type details.
+ */
+export declare function getSearchParameterDetails(structureDefinitions: IndexedStructureDefinition, resourceType: string, searchParam: SearchParameter): SearchParameterDetails;
+export declare function getExpressionForResourceType(resourceType: string, expression: string): string | undefined;