@medplum/core 2.1.3 → 2.1.5

package/dist/types/types.d.ts

@@ -1,5 +1,6 @@
-import { Bundle, ElementDefinition, Reference, Resource, ResourceType, SearchParameter, StructureDefinition } from '@medplum/fhirtypes';
+import { Bundle, ElementDefinition, Reference, Resource, ResourceType, SearchParameter } from '@medplum/fhirtypes';
 import { SearchParameterDetails } from './search/details';
+import { InternalSchemaElement, InternalTypeSchema } from './typeschema/types';
 export interface TypedValue {
     readonly type: string;
     readonly value: any;
@@ -9,67 +10,67 @@ export interface TypedValue {
  * http://www.hl7.org/fhir/valueset-defined-types.html
  * The list here includes additions found from StructureDefinition resources.
  */
-export declare enum PropertyType {
-    Address = "Address",
-    Age = "Age",
-    Annotation = "Annotation",
-    Attachment = "Attachment",
-    BackboneElement = "BackboneElement",
-    CodeableConcept = "CodeableConcept",
-    Coding = "Coding",
-    ContactDetail = "ContactDetail",
-    ContactPoint = "ContactPoint",
-    Contributor = "Contributor",
-    Count = "Count",
-    DataRequirement = "DataRequirement",
-    Distance = "Distance",
-    Dosage = "Dosage",
-    Duration = "Duration",
-    Expression = "Expression",
-    Extension = "Extension",
-    HumanName = "HumanName",
-    Identifier = "Identifier",
-    MarketingStatus = "MarketingStatus",
-    Meta = "Meta",
-    Money = "Money",
-    Narrative = "Narrative",
-    ParameterDefinition = "ParameterDefinition",
-    Period = "Period",
-    Population = "Population",
-    ProdCharacteristic = "ProdCharacteristic",
-    ProductShelfLife = "ProductShelfLife",
-    Quantity = "Quantity",
-    Range = "Range",
-    Ratio = "Ratio",
-    Reference = "Reference",
-    RelatedArtifact = "RelatedArtifact",
-    SampledData = "SampledData",
-    Signature = "Signature",
-    SubstanceAmount = "SubstanceAmount",
-    SystemString = "http://hl7.org/fhirpath/System.String",
-    Timing = "Timing",
-    TriggerDefinition = "TriggerDefinition",
-    UsageContext = "UsageContext",
-    base64Binary = "base64Binary",
-    boolean = "boolean",
-    canonical = "canonical",
-    code = "code",
-    date = "date",
-    dateTime = "dateTime",
-    decimal = "decimal",
-    id = "id",
-    instant = "instant",
-    integer = "integer",
-    markdown = "markdown",
-    oid = "oid",
-    positiveInt = "positiveInt",
-    string = "string",
-    time = "time",
-    unsignedInt = "unsignedInt",
-    uri = "uri",
-    url = "url",
-    uuid = "uuid"
-}
+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.
  *
@@ -96,7 +97,7 @@ export declare enum PropertyType {
  */
 export interface IndexedStructureDefinition {
     types: {
-        [resourceType: string]: TypeSchema;
+        [resourceType: string]: TypeInfo;
     };
 }
 /**
@@ -108,34 +109,14 @@ export interface IndexedStructureDefinition {
  *   3) Patient_Communication
  *   4) Patient_Link
  */
-export interface TypeSchema {
-    structureDefinition: StructureDefinition;
-    elementDefinition: ElementDefinition;
-    display: string;
-    properties: {
-        [name: string]: ElementDefinition;
-    };
+export interface TypeInfo {
     searchParams?: {
         [code: string]: SearchParameter;
     };
     searchParamsDetails?: {
         [code: string]: SearchParameterDetails;
     };
-    description?: string;
-    parentType?: string;
 }
-/**
- * Indexes a bundle of StructureDefinitions for faster lookup.
- * @param bundle A FHIR bundle StructureDefinition resources.
- * @see {@link IndexedStructureDefinition} for more details on indexed StructureDefinitions.
- */
-export declare function indexStructureDefinitionBundle(bundle: Bundle): void;
-/**
- * Indexes a StructureDefinition for fast lookup.
- * @param structureDefinition The original StructureDefinition.
- * @see {@link IndexedStructureDefinition} for more details on indexed StructureDefinitions.
- */
-export declare function indexStructureDefinition(structureDefinition: StructureDefinition): void;
 /**
  * Indexes a bundle of SearchParameter resources for faster lookup.
  * @param bundle A FHIR bundle SearchParameter resources.
@@ -161,25 +142,26 @@ export declare function buildTypeName(components: string[]): string;
  * @param typeSchema The type schema to check.
  * @returns True if the type schema is a non-abstract FHIR resource.
  */
-export declare function isResourceTypeSchema(typeSchema: TypeSchema): boolean;
+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 type schema for the resource type.
- * @param resourceType The resource type.
- * @returns The type schema for the resource type.
- */
-export declare function getResourceTypeSchema(resourceType: string): TypeSchema;
 /**
  * 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.
@@ -193,7 +175,7 @@ export declare function getPropertyDisplayName(path: string): string;
  * @param propertyName The property name.
  * @returns The element definition if found.
  */
-export declare function getElementDefinition(typeName: string, propertyName: string): ElementDefinition | undefined;
+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
@@ -212,3 +194,9 @@ export declare function isReference(value: unknown): value is Reference & {
  * 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/types.d.ts

@@ -1,30 +1,36 @@
-import { Bundle, Resource, StructureDefinition } from '@medplum/fhirtypes';
+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;
-    fields: Record<string, ElementValidator>;
-    constraints: Constraint[];
+    url?: string;
+    kind?: string;
+    description?: string;
+    elements: Record<string, InternalSchemaElement>;
+    constraints?: Constraint[];
+    parentType?: InternalTypeSchema;
     innerTypes: InternalTypeSchema[];
     summaryProperties?: Set<string>;
     mandatoryProperties?: Set<string>;
 }
-export interface ElementValidator {
+export interface InternalSchemaElement {
+    description: string;
+    path: string;
     min: number;
     max: number;
-    isArray: boolean;
-    constraints: Constraint[];
+    isArray?: boolean;
+    constraints?: Constraint[];
     type: ElementType[];
     slicing?: SlicingRules;
     fixed?: TypedValue;
     pattern?: TypedValue;
-    binding?: string;
+    binding?: ElementDefinitionBinding;
 }
 export interface ElementType {
     code: string;
-    targetProfile: string[];
+    targetProfile?: string[];
 }
 export interface Constraint {
     key: string;
@@ -41,7 +47,7 @@ export interface SlicingRules {
 export interface SliceDefinition {
     name: string;
     type?: ElementType[];
-    fields: Record<string, ElementValidator>;
+    elements: Record<string, InternalSchemaElement>;
     min: number;
     max: number;
 }
@@ -57,8 +63,24 @@ export interface SliceDiscriminator {
  * @experimental
  */
 export declare function parseStructureDefinition(sd: StructureDefinition): InternalTypeSchema;
-export declare function loadDataTypes(bundle: Bundle<StructureDefinition>): void;
+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`)

package/dist/types/utils.d.ts

@@ -1,4 +1,4 @@
-import { CodeableConcept, Extension, ObservationDefinition, ObservationDefinitionQualifiedInterval, Patient, Practitioner, QuestionnaireResponse, QuestionnaireResponseItemAnswer, Range, Reference, RelatedPerson, Resource, ResourceType } from '@medplum/fhirtypes';
+import { CodeableConcept, Extension, Identifier, ObservationDefinition, ObservationDefinitionQualifiedInterval, Patient, Practitioner, QuestionnaireResponse, QuestionnaireResponseItemAnswer, Range, Reference, RelatedPerson, Resource, ResourceType } from '@medplum/fhirtypes';
 /**
  * @internal
  */
@@ -110,6 +110,24 @@ export declare function getAllQuestionnaireAnswers(response: QuestionnaireRespon
  * @returns The identifier value if found; otherwise undefined.
  */
 export declare function getIdentifier(resource: Resource, system: string): string | undefined;
+/**
+ * Sets a resource identifier for the given system.
+ *
+ * Note that this method is only available on resources that have an "identifier" property,
+ * and that property must be an array of Identifier objects,
+ * which is not true for all FHIR resources.
+ *
+ * If the identifier already exists, then the value is updated.
+ *
+ * Otherwise a new identifier is added.
+ *
+ * @param resource The resource to add the identifier to.
+ * @param system The identifier system.
+ * @param value The identifier value.
+ */
+export declare function setIdentifier(resource: Resource & {
+    identifier?: Identifier[];
+}, system: string, value: string): void;
 /**
  * Returns an extension value by extension URLs.
  * @param resource The base resource.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@medplum/core",
-  "version": "2.1.3",
+  "version": "2.1.5",
   "description": "Medplum TS/JS Library",
   "author": "Medplum <hello@medplum.com>",
   "license": "Apache-2.0",
@@ -20,7 +20,8 @@
   },
   "devDependencies": {
     "@medplum/definitions": "*",
-    "@medplum/fhirtypes": "*"
+    "@medplum/fhirtypes": "*",
+    "jest-websocket-mock": "2.5.0"
   },
   "peerDependencies": {
     "pdfmake": "^0.2.5"

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

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

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

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

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

@@ -1,4 +0,0 @@
-export * from './atoms';
-export * from './parse';
-export * from './tokenize';
-export * from './utils';

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

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