@medplum/core 2.0.20 → 2.0.22

package/dist/types/schema.d.ts

@@ -27,7 +27,6 @@ import { OperationOutcomeIssue, Resource } from '@medplum/fhirtypes';
  * const medplum = new MedplumClient();
  * await medplum.requestSchema('Patient');
  * ```
- *
  * @param resourceType The candidate resource type string.
  * @returns True if the resource type is a valid FHIR resource type.
  */
@@ -62,9 +61,7 @@ export declare function isResourceType(resourceType: string): boolean;
  * const medplum = new MedplumClient();
  * await medplum.requestSchema('Patient');
  * ```
- *
  * @param resourceType The candidate resource type string.
- * @returns True if the resource type is a valid FHIR resource type.
  */
 export declare function validateResourceType(resourceType: string): void;
 /**
@@ -97,9 +94,7 @@ export declare function validateResourceType(resourceType: string): void;
  * const medplum = new MedplumClient();
  * await medplum.requestSchema('Patient');
  * ```
- *
- * @param resourceType The candidate resource type string.
- * @returns True if the resource type is a valid FHIR resource type.
+ * @param resource The candidate resource.
  */
 export declare function validateResource<T extends Resource>(resource: T): void;
 export declare class FhirSchemaValidator<T extends Resource> {
@@ -131,10 +126,10 @@ export declare class FhirSchemaValidator<T extends Resource> {
      *   2) a JSON property with _ prepended to the name of the element, which, if present, contains the value's id and/or extensions
      *
      * See: https://hl7.org/fhir/json.html#primitive
-     *
      * @param path The path to the property
-     * @param key
-     * @param typedValue
+     * @param key The key in the current typed value.
+     * @param typedValue The current typed value.
+     * @returns True if the primitive element is valid.
      */
     private checkPrimitiveElement;
     private createIssue;
@@ -143,7 +138,6 @@ export declare class FhirSchemaValidator<T extends Resource> {
  * 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.

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

@@ -26,7 +26,6 @@ export interface SearchParameterDetails {
  *   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.

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

@@ -79,7 +79,7 @@ export declare function parseSearchDefinition<T extends Resource = Resource>(url
 /**
  * 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.
+ * @param definition The search definition.
  * @returns Formatted URL.
  */
 export declare function formatSearchQuery(definition: SearchRequest): string;

package/dist/types/storage.d.ts

@@ -22,6 +22,7 @@ export declare class MemoryStorage implements Storage {
     constructor();
     /**
      * Returns the number of key/value pairs.
+     * @returns The number of key/value pairs.
      */
     get length(): number;
     /**
@@ -30,18 +31,25 @@ export declare class MemoryStorage implements Storage {
     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/typeschema/types.d.ts

@@ -0,0 +1,55 @@
+import { ResourceType, 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: ResourceType;
+    fields: Record<string, ElementValidator>;
+    constraints: Constraint[];
+}
+export interface ElementValidator {
+    min: number;
+    max: number;
+    isArray: boolean;
+    constraints: Constraint[];
+    type: ElementType[];
+    slicing?: SlicingRules;
+    fixed?: TypedValue;
+    pattern?: TypedValue;
+    binding?: string;
+}
+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;
+    fields: Record<string, ElementValidator>;
+    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;

package/dist/types/utils.d.ts

@@ -44,7 +44,7 @@ export declare function isProfileResource(resource: Resource): resource is Profi
 /**
  * Returns a display string for the resource.
  * @param resource The input resource.
- * @return Human friendly display string.
+ * @returns Human friendly display string.
  */
 export declare function getDisplayString(resource: Resource): string;
 /**
@@ -94,7 +94,6 @@ export declare function getQuestionnaireAnswers(response: QuestionnaireResponse)
  * If multiple identifiers exist with the same system, the first one is returned.
  *
  * If the system is not found, then returns undefined.
- *
  * @param resource The resource to check.
  * @param system The identifier system.
  * @returns The identifier value if found; otherwise undefined.
@@ -135,6 +134,7 @@ export declare function isEmpty(v: any): boolean;
  * Ignores meta.versionId and meta.lastUpdated.
  * @param object1 The first object.
  * @param object2 The second object.
+ * @param path Optional path string.
  * @returns True if the objects are equal.
  */
 export declare function deepEquals(object1: unknown, object2: unknown, path?: string): boolean;
@@ -148,7 +148,6 @@ export declare function deepEquals(object1: unknown, object2: unknown, path?: st
  *
  * See: https://web.dev/structured-clone/
  * See: https://stackoverflow.com/questions/40488190/how-is-structured-clone-algorithm-different-from-deep-copy
- *
  * @param input The input to clone.
  * @returns A deep clone of the input.
  */
@@ -161,7 +160,7 @@ export declare function deepClone<T>(input: T): T;
 export declare function isUUID(input: string): boolean;
 /**
  * Returns true if the input is an object.
- * @param object The candidate object.
+ * @param obj The candidate object.
  * @returns True if the input is a non-null non-undefined object.
  */
 export declare function isObject(obj: unknown): obj is Record<string, unknown>;
@@ -205,6 +204,7 @@ export declare function setCodeBySystem(concept: CodeableConcept, system: string
  * @param definition The observation definition.
  * @param patient The patient.
  * @param value The observation value.
+ * @param category Optional interval category restriction.
  * @returns The observation interval if found; otherwise undefined.
  */
 export declare function findObservationInterval(definition: ObservationDefinition, patient: Patient, value: number, category?: 'reference' | 'critical' | 'absolute'): ObservationDefinitionQualifiedInterval | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@medplum/core",
-  "version": "2.0.20",
+  "version": "2.0.22",
   "description": "Medplum TS/JS Library",
   "author": "Medplum <hello@medplum.com>",
   "license": "Apache-2.0",