@medplum/core 2.1.9 → 2.1.10

package/dist/types/schema.d.ts

@@ -1,43 +0,0 @@
-import { OperationOutcomeIssue } from '@medplum/fhirtypes';
-/**
- * Validates that the given string is a valid FHIR resource type.
- * On success, silently returns void.
- * On failure, throws an OperationOutcomeError.
- *
- * ```ts
- * validateResourceType('Patient'); // nothing
- * validateResourceType('XYZ'); // throws OperationOutcomeError
- * ```
- *
- * Note that this depends on globalSchema, which is populated by the StructureDefinition loader.
- *
- * In a server context, you can load all schema definitions:
- *
- * ```ts
- * import { indexStructureDefinitionBundle } from '@medplum/core';
- * import { readJson } from '@medplum/definitions';
- * import { Bundle } from '@medplum/fhirtypes';
- *
- * indexStructureDefinitionBundle(readJson('fhir/r4/profiles-resources.json') as Bundle);
- * ```
- *
- * In a client context, you can load the schema definitions using MedplumClient:
- *
- * ```ts
- * import { MedplumClient } from '@medplum/core';
- *
- * const medplum = new MedplumClient();
- * await medplum.requestSchema('Patient');
- * ```
- * @param resourceType The candidate resource type string.
- */
-export declare function validateResourceType(resourceType: string): void;
-/**
- * Recursively checks for null values in an object.
- *
- * Note that "null" is a special value in JSON that is not allowed in FHIR.
- * @param value Input value of any type.
- * @param path Path string to the value for OperationOutcome.
- * @param issues Output list of issues.
- */
-export declare function checkForNull(value: unknown, path: string, issues: OperationOutcomeIssue[]): void;

package/dist/types/search/details.d.ts

@@ -1,37 +0,0 @@
-import { SearchParameter } from '@medplum/fhirtypes';
-import { Atom } from '../fhirlexer/parse';
-import { InternalSchemaElement } from '../typeschema/types';
-export declare enum SearchParameterType {
-    BOOLEAN = "BOOLEAN",
-    NUMBER = "NUMBER",
-    QUANTITY = "QUANTITY",
-    TEXT = "TEXT",
-    REFERENCE = "REFERENCE",
-    CANONICAL = "CANONICAL",
-    DATE = "DATE",
-    DATETIME = "DATETIME",
-    PERIOD = "PERIOD",
-    UUID = "UUID"
-}
-export interface SearchParameterDetails {
-    readonly columnName: string;
-    readonly type: SearchParameterType;
-    readonly elementDefinitions?: InternalSchemaElement[];
-    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 resourceType The root resource type.
- * @param searchParam The search parameter.
- * @returns The search parameter type details.
- */
-export declare function getSearchParameterDetails(resourceType: string, searchParam: SearchParameter): SearchParameterDetails;
-export declare function getExpressionsForResourceType(resourceType: string, expression: string): Atom[];
-export declare function getExpressionForResourceType(resourceType: string, expression: string): string | undefined;

package/dist/types/search/match.d.ts

@@ -1,9 +0,0 @@
-import { Resource } from '@medplum/fhirtypes';
-import { SearchRequest } from './search';
-/**
- * Determines if the resource matches the search request.
- * @param resource The resource that was created or updated.
- * @param searchRequest The subscription criteria as a search request.
- * @returns True if the resource satisfies the search request.
- */
-export declare function matchesSearchRequest(resource: Resource, searchRequest: SearchRequest): boolean;

package/dist/types/search/search.d.ts

@@ -1,102 +0,0 @@
-import { Resource } from '@medplum/fhirtypes';
-import { TypedValue } from '../types';
-export declare const DEFAULT_SEARCH_COUNT = 20;
-export interface SearchRequest<T extends Resource = Resource> {
-    readonly resourceType: T['resourceType'];
-    filters?: Filter[];
-    sortRules?: SortRule[];
-    offset?: number;
-    count?: number;
-    fields?: string[];
-    name?: string;
-    total?: 'none' | 'estimate' | 'accurate';
-    include?: IncludeTarget[];
-    revInclude?: IncludeTarget[];
-    summary?: 'true' | 'text' | 'data';
-}
-export interface Filter {
-    code: string;
-    operator: Operator;
-    value: string;
-}
-export interface SortRule {
-    code: string;
-    descending?: boolean;
-}
-export interface IncludeTarget {
-    resourceType: string;
-    searchParam: string;
-    targetType?: string;
-    modifier?: string;
-}
-/**
- * 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",
-    NOT = "not",
-    ABOVE = "above",
-    BELOW = "below",
-    IN = "in",
-    NOT_IN = "not-in",
-    OF_TYPE = "of-type",
-    MISSING = "missing",
-    IDENTIFIER = "identifier",
-    ITERATE = "iterate"
-}
-/**
- * Parses a search URL into a search request.
- * @param resourceType The FHIR resource type.
- * @param query The collection of query string parameters.
- * @returns A parsed SearchRequest.
- */
-export declare function parseSearchRequest<T extends Resource = Resource>(resourceType: T['resourceType'], query: Record<string, string[] | string | undefined>): SearchRequest<T>;
-/**
- * Parses a search URL into a search request.
- * @param url The search URL.
- * @returns A parsed SearchRequest.
- */
-export declare function parseSearchUrl<T extends Resource = Resource>(url: URL): SearchRequest<T>;
-/**
- * Parses a URL string into a SearchRequest.
- * @param url The URL to parse.
- * @returns Parsed search definition.
- */
-export declare function parseSearchDefinition<T extends Resource = Resource>(url: string): SearchRequest<T>;
-/**
- * Parses a FHIR criteria string into a SearchRequest.
- * FHIR criteria strings are found on resources such as Subscription.
- * @param criteria The FHIR criteria string.
- * @returns Parsed search definition.
- */
-export declare function parseCriteriaAsSearchRequest(criteria: string): SearchRequest;
-/**
- * Parses an extended FHIR search criteria string (i.e. application/x-fhir-query), evaluating
- * any embedded FHIRPath subexpressions (e.g. `{{ %patient.id }}`) with the provided variables.
- *
- * @see https://hl7.org/fhir/fhir-xquery.html
- * @param query The X-Fhir-Query string to parse
- * @param variables Values to pass into embedded FHIRPath expressions
- * @returns The parsed search request
- */
-export declare function parseXFhirQuery(query: string, variables: Record<string, TypedValue>): SearchRequest;
-/**
- * Formats a search definition object into a query string.
- * Note: The return value does not include the resource type.
- * @param definition The search definition.
- * @returns Formatted URL.
- */
-export declare function formatSearchQuery(definition: SearchRequest): string;

package/dist/types/sftp.d.ts

@@ -1,9 +0,0 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { Readable } from 'stream';
-/**
- * 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.
- * @returns A Promise that resolves with a Buffer containing all the data from the Readable stream.
- */
-export declare function streamToBuffer(stream: Readable): Promise<Buffer>;

package/dist/types/storage.d.ts

@@ -1,55 +0,0 @@
-/**
- * The ClientStorage class is a utility class for storing strings and objects.
- *
- * When using MedplumClient in the browser, it will be backed by browser localStorage.
- *
- * When Using MedplumClient in the server, it will be backed by the MemoryStorage class.  For example, the Medplum CLI uses `FileSystemStorage`.
- */
-export declare class ClientStorage {
-    private readonly storage;
-    constructor();
-    clear(): void;
-    getString(key: string): string | undefined;
-    setString(key: string, value: string | undefined): void;
-    getObject<T>(key: string): T | undefined;
-    setObject<T>(key: string, value: T): void;
-}
-/**
- * The MemoryStorage class is a minimal in-memory implementation of the Storage interface.
- */
-export declare class MemoryStorage implements Storage {
-    private data;
-    constructor();
-    /**
-     * Returns the number of key/value pairs.
-     * @returns The number of key/value pairs.
-     */
-    get length(): number;
-    /**
-     * Removes all key/value pairs, if there are any.
-     */
-    clear(): void;
-    /**
-     * Returns the current value associated with the given key, or null if the given key does not exist.
-     * @param key The specified storage key.
-     * @returns The current value associated with the given key, or null if the given key does not exist.
-     */
-    getItem(key: string): string | null;
-    /**
-     * Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.
-     * @param key The storage key.
-     * @param value The new value.
-     */
-    setItem(key: string, value: string | null): void;
-    /**
-     * Removes the key/value pair with the given key, if a key/value pair with the given key exists.
-     * @param key The storage key.
-     */
-    removeItem(key: string): void;
-    /**
-     * Returns the name of the nth key, or null if n is greater than or equal to the number of key/value pairs.
-     * @param index The numeric index.
-     * @returns The nth key.
-     */
-    key(index: number): string | null;
-}

package/dist/types/types.d.ts

@@ -1,203 +0,0 @@
-import { Bundle, ElementDefinition, Reference, Resource, ResourceType, SearchParameter } from '@medplum/fhirtypes';
-import { SearchParameterDetails } from './search/details';
-import { InternalSchemaElement, InternalTypeSchema } from './typeschema/types';
-export type TypeName<T> = T extends string ? 'string' : T extends number ? 'number' : T extends boolean ? 'boolean' : T extends undefined ? 'undefined' : 'object';
-export interface TypedValue {
-    readonly type: string;
-    readonly value: any;
-}
-/**
- * List of property types.
- * http://www.hl7.org/fhir/valueset-defined-types.html
- * The list here includes additions found from StructureDefinition resources.
- */
-export declare const PropertyType: {
-    Address: string;
-    Age: string;
-    Annotation: string;
-    Attachment: string;
-    BackboneElement: string;
-    CodeableConcept: string;
-    Coding: string;
-    ContactDetail: string;
-    ContactPoint: string;
-    Contributor: string;
-    Count: string;
-    DataRequirement: string;
-    Distance: string;
-    Dosage: string;
-    Duration: string;
-    Expression: string;
-    Extension: string;
-    HumanName: string;
-    Identifier: string;
-    MarketingStatus: string;
-    Meta: string;
-    Money: string;
-    Narrative: string;
-    ParameterDefinition: string;
-    Period: string;
-    Population: string;
-    ProdCharacteristic: string;
-    ProductShelfLife: string;
-    Quantity: string;
-    Range: string;
-    Ratio: string;
-    Reference: string;
-    RelatedArtifact: string;
-    SampledData: string;
-    Signature: string;
-    SubstanceAmount: string;
-    SystemString: string;
-    Timing: string;
-    TriggerDefinition: string;
-    UsageContext: string;
-    base64Binary: string;
-    boolean: string;
-    canonical: string;
-    code: string;
-    date: string;
-    dateTime: string;
-    decimal: string;
-    id: string;
-    instant: string;
-    integer: string;
-    markdown: string;
-    oid: string;
-    positiveInt: string;
-    string: string;
-    time: string;
-    unsignedInt: string;
-    uri: string;
-    url: string;
-    uuid: string;
-};
-/**
- * An IndexedStructureDefinition is a lookup-optimized version of a StructureDefinition.
- *
- * StructureDefinition resources contain schema information for other resource types.
- * These schemas can be used to automatically generate user interface elements for
- * resources.
- *
- * However, a StructureDefinition resource is not optimized for realtime lookups.  All
- * resource types, sub types, and property definitions are stored in a flat array of
- * ElementDefinition objects.  Therefore, to lookup the schema for a property (i.e., "Patient.name")
- * requires a linear scan of all ElementDefinition objects
- *
- * A StructureDefinition resource contains information about one or more types.
- * For example, the "Patient" StructureDefinition includes "Patient", "Patient_Contact",
- * "Patient_Communication", and "Patient_Link".  This is inefficient.
- *
- * Instead, we create an indexed version of the StructureDefinition, called IndexedStructureDefinition.
- * In an IndexedStructureDefinition, retrieving a property definition is a hashtable lookup.
- *
- * The hierarchy is:
- *   IndexedStructureDefinition - top level for one resource type
- *   TypeSchema - one per resource type and all contained BackboneElements
- *   PropertySchema - one per property/field
- */
-export interface IndexedStructureDefinition {
-    types: {
-        [resourceType: string]: TypeInfo;
-    };
-}
-/**
- * An indexed TypeSchema.
- *
- * Example:  The IndexedStructureDefinition for "Patient" would include the following TypeSchemas:
- *   1) Patient
- *   2) Patient_Contact
- *   3) Patient_Communication
- *   4) Patient_Link
- */
-export interface TypeInfo {
-    searchParams?: {
-        [code: string]: SearchParameter;
-    };
-    searchParamsDetails?: {
-        [code: string]: SearchParameterDetails;
-    };
-}
-/**
- * Indexes a bundle of SearchParameter resources for faster lookup.
- * @param bundle A FHIR bundle SearchParameter resources.
- * @see {@link IndexedStructureDefinition} for more details on indexed StructureDefinitions.
- */
-export declare function indexSearchParameterBundle(bundle: Bundle<SearchParameter>): void;
-/**
- * Indexes a SearchParameter resource for fast lookup.
- * Indexes by SearchParameter.code, which is the query string parameter name.
- * @param searchParam The SearchParameter resource.
- * @see {@link IndexedStructureDefinition} for more details on indexed StructureDefinitions.
- */
-export declare function indexSearchParameter(searchParam: SearchParameter): void;
-/**
- * Returns the type name for an ElementDefinition.
- * @param elementDefinition The element definition.
- * @returns The Medplum type name.
- */
-export declare function getElementDefinitionTypeName(elementDefinition: ElementDefinition): string;
-export declare function buildTypeName(components: string[]): string;
-/**
- * Returns true if the type schema is a non-abstract FHIR resource.
- * @param typeSchema The type schema to check.
- * @returns True if the type schema is a non-abstract FHIR resource.
- */
-export declare function isResourceTypeSchema(typeSchema: InternalTypeSchema): boolean;
-/**
- * Returns an array of all resource types.
- * Note that this is based on globalSchema, and will only return resource types that are currently in memory.
- * @returns An array of all resource types.
- */
-export declare function getResourceTypes(): ResourceType[];
-/**
- * Returns the search parameters for the resource type indexed by search code.
- * @param resourceType The resource type.
- * @returns The search parameters for the resource type indexed by search code.
- */
-export declare function getSearchParameters(resourceType: string): Record<string, SearchParameter> | undefined;
-/**
- * Returns a search parameter for a resource type by search code.
- * @param resourceType The FHIR resource type.
- * @param code The search parameter code.
- * @returns The search parameter if found, otherwise undefined.
- */
-export declare function getSearchParameter(resourceType: string, code: string): SearchParameter | undefined;
-/**
- * Returns a human friendly display name for a FHIR element definition path.
- * @param path The FHIR element definition path.
- * @returns The best guess of the display name.
- */
-export declare function getPropertyDisplayName(path: string): string;
-/**
- * Returns an element definition by type and property name.
- * Handles content references.
- * @param typeName The type name.
- * @param propertyName The property name.
- * @returns The element definition if found.
- */
-export declare function getElementDefinition(typeName: string, propertyName: string): InternalSchemaElement | undefined;
-/**
- * Typeguard to validate that an object is a FHIR resource
- * @param value The object to check
- * @returns True if the input is of type 'object' and contains property 'resourceType'
- */
-export declare function isResource(value: unknown): value is Resource;
-/**
- * Typeguard to validate that an object is a FHIR resource
- * @param value The object to check
- * @returns True if the input is of type 'object' and contains property 'reference'
- */
-export declare function isReference(value: unknown): value is Reference & {
-    reference: string;
-};
-/**
- * Global schema singleton.
- */
-export declare const globalSchema: IndexedStructureDefinition;
-/**
- * Output the string representation of a value, suitable for use as part of a search query.
- * @param v The value to format as a string
- * @returns The stringified value
- */
-export declare function stringifyTypedValue(v: TypedValue): string;

package/dist/types/typeschema/crawler.d.ts

@@ -1,12 +0,0 @@
-import { Resource } from '@medplum/fhirtypes';
-import { TypedValue } from '../types';
-import { InternalTypeSchema } from './types';
-export interface ResourceVisitor {
-    onEnterObject?: (path: string, value: TypedValue, schema: InternalTypeSchema) => void;
-    onExitObject?: (path: string, value: TypedValue, schema: InternalTypeSchema) => void;
-    onEnterResource?: (path: string, value: TypedValue, schema: InternalTypeSchema) => void;
-    onExitResource?: (path: string, value: TypedValue, schema: InternalTypeSchema) => void;
-    visitProperty?: (parent: TypedValue, key: string, path: string, propertyValues: (TypedValue | TypedValue[] | undefined)[], schema: InternalTypeSchema) => void;
-}
-export declare function crawlResource(resource: Resource, visitor: ResourceVisitor, schema?: InternalTypeSchema, initialPath?: string): void;
-export declare function getNestedProperty(value: TypedValue, key: string): (TypedValue | TypedValue[] | undefined)[];

package/dist/types/typeschema/types.d.ts

@@ -1,92 +0,0 @@
-import { Bundle, ElementDefinitionBinding, Resource, StructureDefinition } from '@medplum/fhirtypes';
-import { TypedValue } from '../types';
-/**
- * Internal representation of a non-primitive FHIR type, suitable for use in resource validation
- */
-export interface InternalTypeSchema {
-    name: string;
-    url?: string;
-    kind?: string;
-    description?: string;
-    elements: Record<string, InternalSchemaElement>;
-    constraints?: Constraint[];
-    parentType?: InternalTypeSchema;
-    innerTypes: InternalTypeSchema[];
-    summaryProperties?: Set<string>;
-    mandatoryProperties?: Set<string>;
-}
-export interface InternalSchemaElement {
-    description: string;
-    path: string;
-    min: number;
-    max: number;
-    isArray?: boolean;
-    constraints?: Constraint[];
-    type: ElementType[];
-    slicing?: SlicingRules;
-    fixed?: TypedValue;
-    pattern?: TypedValue;
-    binding?: ElementDefinitionBinding;
-}
-export interface ElementType {
-    code: string;
-    targetProfile?: string[];
-}
-export interface Constraint {
-    key: string;
-    severity: 'error' | 'warning';
-    expression: string;
-    description: string;
-}
-export interface SlicingRules {
-    discriminator: SliceDiscriminator[];
-    ordered: boolean;
-    rule?: 'open' | 'closed' | 'openAtEnd';
-    slices: SliceDefinition[];
-}
-export interface SliceDefinition {
-    name: string;
-    type?: ElementType[];
-    elements: Record<string, InternalSchemaElement>;
-    min: number;
-    max: number;
-}
-export interface SliceDiscriminator {
-    path: string;
-    type: string;
-}
-/**
- * Parses a StructureDefinition resource into an internal schema better suited for
- * programmatic validation and usage in internal systems
- * @param sd The StructureDefinition resource to parse
- * @returns The parsed schema for the given resource type
- * @experimental
- */
-export declare function parseStructureDefinition(sd: StructureDefinition): InternalTypeSchema;
-export declare function indexStructureDefinitionBundle(bundle: StructureDefinition[] | Bundle): void;
-export declare function loadDataType(sd: StructureDefinition): void;
-export declare function getAllDataTypes(): Record<string, InternalTypeSchema>;
-export declare function isDataTypeLoaded(type: string): boolean;
-export declare function tryGetDataType(type: string): InternalTypeSchema | undefined;
-export declare function getDataType(type: string): InternalTypeSchema;
-/**
- * Returns true if the given string is a valid FHIR resource type.
- *
- * ```ts
- * isResourceType('Patient'); // true
- * isResourceType('XYZ'); // false
- * ```
- *
- * @param resourceType The candidate resource type string.
- * @returns True if the resource type is a valid FHIR resource type.
- */
-export declare function isResourceType(resourceType: string): boolean;
-/**
- * Construct the subset of a resource containing a minimum set of fields.  The returned resource is not guaranteed
- * to contain only the provided properties, and may contain others (e.g. `resourceType` and `id`)
- *
- * @param resource The resource to subset
- * @param properties The minimum properties to include in the subset
- * @returns The modified resource, containing the listed properties and possibly other mandatory ones
- */
-export declare function subsetResource<T extends Resource>(resource: T | undefined, properties: string[]): T | undefined;

package/dist/types/typeschema/validation.d.ts

@@ -1,25 +0,0 @@
-import { Resource, StructureDefinition } from '@medplum/fhirtypes';
-export declare const fhirTypeToJsType: {
-    readonly base64Binary: "string";
-    readonly boolean: "boolean";
-    readonly canonical: "string";
-    readonly code: "string";
-    readonly date: "string";
-    readonly dateTime: "string";
-    readonly decimal: "number";
-    readonly id: "string";
-    readonly instant: "string";
-    readonly integer: "number";
-    readonly markdown: "string";
-    readonly oid: "string";
-    readonly positiveInt: "number";
-    readonly string: "string";
-    readonly time: "string";
-    readonly unsignedInt: "number";
-    readonly uri: "string";
-    readonly url: "string";
-    readonly uuid: "string";
-    readonly xhtml: "string";
-    readonly 'http://hl7.org/fhirpath/System.String': "string";
-};
-export declare function validateResource(resource: Resource, profile?: StructureDefinition): void;