@medplum/core 0.9.3 → 0.9.6

package/dist/types/types.d.ts

@@ -1,139 +1,139 @@
-import { ElementDefinition, SearchParameter, StructureDefinition } from '@medplum/fhirtypes';
-/**
- * List of property types.
- * 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",
-    Resource = "Resource",
-    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"
-}
-/**
- * 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]: TypeSchema;
-    };
-}
-/**
- * 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 TypeSchema {
-    display: string;
-    properties: {
-        [name: string]: ElementDefinition;
-    };
-    searchParams?: {
-        [code: string]: SearchParameter;
-    };
-    description?: string;
-    parentType?: string;
-}
-/**
- * Creates a new empty IndexedStructureDefinition.
- * @returns The empty IndexedStructureDefinition.
- */
-export declare function createSchema(): IndexedStructureDefinition;
-export declare function createTypeSchema(typeName: string, description: string | undefined): TypeSchema;
-/**
- * Indexes a StructureDefinition for fast lookup.
- * See comments on IndexedStructureDefinition for more details.
- * @param schema The output IndexedStructureDefinition.
- * @param structureDefinition The original StructureDefinition.
- */
-export declare function indexStructureDefinition(schema: IndexedStructureDefinition, structureDefinition: StructureDefinition): void;
-/**
- * Indexes a SearchParameter resource for fast lookup.
- * Indexes by SearchParameter.code, which is the query string parameter name.
- * @param schema The output IndexedStructureDefinition.
- * @param searchParam The SearchParameter resource.
- */
-export declare function indexSearchParameter(schema: IndexedStructureDefinition, searchParam: SearchParameter): void;
-export declare function buildTypeName(components: string[]): string;
-export declare function getPropertyDisplayName(property: ElementDefinition): string;
+import { ElementDefinition, SearchParameter, StructureDefinition } from '@medplum/fhirtypes';
+/**
+ * List of property types.
+ * 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",
+    Resource = "Resource",
+    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"
+}
+/**
+ * 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]: TypeSchema;
+    };
+}
+/**
+ * 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 TypeSchema {
+    display: string;
+    properties: {
+        [name: string]: ElementDefinition;
+    };
+    searchParams?: {
+        [code: string]: SearchParameter;
+    };
+    description?: string;
+    parentType?: string;
+}
+/**
+ * Creates a new empty IndexedStructureDefinition.
+ * @returns The empty IndexedStructureDefinition.
+ */
+export declare function createSchema(): IndexedStructureDefinition;
+export declare function createTypeSchema(typeName: string, description: string | undefined): TypeSchema;
+/**
+ * Indexes a StructureDefinition for fast lookup.
+ * See comments on IndexedStructureDefinition for more details.
+ * @param schema The output IndexedStructureDefinition.
+ * @param structureDefinition The original StructureDefinition.
+ */
+export declare function indexStructureDefinition(schema: IndexedStructureDefinition, structureDefinition: StructureDefinition): void;
+/**
+ * Indexes a SearchParameter resource for fast lookup.
+ * Indexes by SearchParameter.code, which is the query string parameter name.
+ * @param schema The output IndexedStructureDefinition.
+ * @param searchParam The SearchParameter resource.
+ */
+export declare function indexSearchParameter(schema: IndexedStructureDefinition, searchParam: SearchParameter): void;
+export declare function buildTypeName(components: string[]): string;
+export declare function getPropertyDisplayName(property: ElementDefinition): string;

package/dist/types/utils.d.ts

@@ -1,131 +1,131 @@
-import { Patient, Practitioner, QuestionnaireResponse, QuestionnaireResponseItemAnswer, Reference, RelatedPerson, Resource } from '@medplum/fhirtypes';
-export declare type ProfileResource = Patient | Practitioner | RelatedPerson;
-/**
- * Creates a reference resource.
- * @param resource The FHIR reesource.
- * @returns A reference resource.
- */
-export declare function createReference<T extends Resource>(resource: T): Reference<T>;
-/**
- * Returns a reference string for a resource.
- * @param resource The FHIR resource.
- * @returns A reference string of the form resourceType/id.
- */
-export declare function getReferenceString(resource: Resource): string;
-/**
- * Returns the ID portion of a reference.
- * @param reference A FHIR reference.
- * @returns The ID portion of a reference.
- */
-export declare function resolveId(reference: Reference | undefined): string | undefined;
-/**
- * Returns true if the resource is a "ProfileResource".
- * @param resource The FHIR resource.
- * @returns True if the resource is a "ProfileResource".
- */
-export declare function isProfileResource(resource: Resource): boolean;
-/**
- * Returns a display string for the resource.
- * @param resource The input resource.
- * @return Human friendly display string.
- */
-export declare function getDisplayString(resource: Resource): string;
-/**
- * Returns an image URL for the resource, if one is available.
- * @param resource The input resource.
- * @returns The image URL for the resource or undefined.
- */
-export declare function getImageSrc(resource: Resource): string | undefined;
-/**
- * Returns a Date property as a Date.
- * When working with JSON objects, Dates are often serialized as ISO-8601 strings.
- * When that happens, we need to safely convert to a proper Date object.
- * @param date The date property value, which could be a string or a Date object.
- * @returns A Date object.
- */
-export declare function getDateProperty(date: string | undefined): Date | undefined;
-/**
- * Calculates the age in years from the birth date.
- * @param birthDateStr The birth date or start date in ISO-8601 format YYYY-MM-DD.
- * @param endDateStr Optional end date in ISO-8601 format YYYY-MM-DD. Default value is today.
- * @returns The age in years, months, and days.
- */
-export declare function calculateAge(birthDateStr: string, endDateStr?: string): {
-    years: number;
-    months: number;
-    days: number;
-};
-/**
- * Calculates the age string for display using the age appropriate units.
- * If the age is greater than or equal to 2 years, then the age is displayed in years.
- * If the age is greater than or equal to 1 month, then the age is displayed in months.
- * Otherwise, the age is displayed in days.
- * @param birthDateStr The birth date or start date in ISO-8601 format YYYY-MM-DD.
- * @param endDateStr Optional end date in ISO-8601 format YYYY-MM-DD. Default value is today.
- * @returns The age string.
- */
-export declare function calculateAgeString(birthDateStr: string, endDateStr?: string): string | undefined;
-/**
- * Returns all questionnaire answers as a map by link ID.
- * @param response The questionnaire response resource.
- * @returns Questionnaire answers mapped by link ID.
- */
-export declare function getQuestionnaireAnswers(response: QuestionnaireResponse): Record<string, QuestionnaireResponseItemAnswer>;
-/**
- * Returns an extension value by extension URLs.
- * @param resource The base resource.
- * @param urls Array of extension URLs.  Each entry represents a nested extension.
- * @returns The extension value if found; undefined otherwise.
- */
-export declare function getExtensionValue(resource: Resource, ...urls: string[]): string | undefined;
-/**
- * FHIR JSON stringify.
- * Removes properties with empty string values.
- * Removes objects with zero properties.
- * See: https://www.hl7.org/fhir/json.html
- * @param value The input value.
- * @param pretty Optional flag to pretty-print the JSON.
- * @returns The resulting JSON string.
- */
-export declare function stringify(value: any, pretty?: boolean): string;
-/**
- * Resource equality.
- * Ignores meta.versionId and meta.lastUpdated.
- * @param object1 The first object.
- * @param object2 The second object.
- * @returns True if the objects are equal.
- */
-export declare function deepEquals(object1: unknown, object2: unknown, path?: string): boolean;
-/**
- * Returns true if the input string is a UUID.
- * @param input The input string.
- * @returns True if the input string matches the UUID format.
- */
-export declare function isUUID(input: string): boolean;
-/**
- * Returns true if the input is an object.
- * @param object 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>;
-/**
- * Returns true if the input array is an array of strings.
- * @param arr Input array.
- * @returns True if the input array is an array of strings.
- */
-export declare function isStringArray(arr: any[]): arr is string[];
-/**
- * Converts an ArrayBuffer to hex string.
- * See: https://stackoverflow.com/a/55200387
- * @param arrayBuffer The input array buffer.
- * @returns The resulting hex string.
- */
-export declare function arrayBufferToHex(arrayBuffer: ArrayBuffer): string;
-/**
- * Converts an ArrayBuffer to a base-64 encoded string.
- * @param arrayBuffer The input array buffer.
- * @returns The base-64 encoded string.
- */
-export declare function arrayBufferToBase64(arrayBuffer: ArrayBuffer): string;
-export declare function capitalize(word: string): string;
-export declare function isLowerCase(c: string): boolean;
+import { Patient, Practitioner, QuestionnaireResponse, QuestionnaireResponseItemAnswer, Reference, RelatedPerson, Resource } from '@medplum/fhirtypes';
+export declare type ProfileResource = Patient | Practitioner | RelatedPerson;
+/**
+ * Creates a reference resource.
+ * @param resource The FHIR reesource.
+ * @returns A reference resource.
+ */
+export declare function createReference<T extends Resource>(resource: T): Reference<T>;
+/**
+ * Returns a reference string for a resource.
+ * @param resource The FHIR resource.
+ * @returns A reference string of the form resourceType/id.
+ */
+export declare function getReferenceString(resource: Resource): string;
+/**
+ * Returns the ID portion of a reference.
+ * @param reference A FHIR reference.
+ * @returns The ID portion of a reference.
+ */
+export declare function resolveId(reference: Reference | undefined): string | undefined;
+/**
+ * Returns true if the resource is a "ProfileResource".
+ * @param resource The FHIR resource.
+ * @returns True if the resource is a "ProfileResource".
+ */
+export declare function isProfileResource(resource: Resource): boolean;
+/**
+ * Returns a display string for the resource.
+ * @param resource The input resource.
+ * @return Human friendly display string.
+ */
+export declare function getDisplayString(resource: Resource): string;
+/**
+ * Returns an image URL for the resource, if one is available.
+ * @param resource The input resource.
+ * @returns The image URL for the resource or undefined.
+ */
+export declare function getImageSrc(resource: Resource): string | undefined;
+/**
+ * Returns a Date property as a Date.
+ * When working with JSON objects, Dates are often serialized as ISO-8601 strings.
+ * When that happens, we need to safely convert to a proper Date object.
+ * @param date The date property value, which could be a string or a Date object.
+ * @returns A Date object.
+ */
+export declare function getDateProperty(date: string | undefined): Date | undefined;
+/**
+ * Calculates the age in years from the birth date.
+ * @param birthDateStr The birth date or start date in ISO-8601 format YYYY-MM-DD.
+ * @param endDateStr Optional end date in ISO-8601 format YYYY-MM-DD. Default value is today.
+ * @returns The age in years, months, and days.
+ */
+export declare function calculateAge(birthDateStr: string, endDateStr?: string): {
+    years: number;
+    months: number;
+    days: number;
+};
+/**
+ * Calculates the age string for display using the age appropriate units.
+ * If the age is greater than or equal to 2 years, then the age is displayed in years.
+ * If the age is greater than or equal to 1 month, then the age is displayed in months.
+ * Otherwise, the age is displayed in days.
+ * @param birthDateStr The birth date or start date in ISO-8601 format YYYY-MM-DD.
+ * @param endDateStr Optional end date in ISO-8601 format YYYY-MM-DD. Default value is today.
+ * @returns The age string.
+ */
+export declare function calculateAgeString(birthDateStr: string, endDateStr?: string): string | undefined;
+/**
+ * Returns all questionnaire answers as a map by link ID.
+ * @param response The questionnaire response resource.
+ * @returns Questionnaire answers mapped by link ID.
+ */
+export declare function getQuestionnaireAnswers(response: QuestionnaireResponse): Record<string, QuestionnaireResponseItemAnswer>;
+/**
+ * Returns an extension value by extension URLs.
+ * @param resource The base resource.
+ * @param urls Array of extension URLs.  Each entry represents a nested extension.
+ * @returns The extension value if found; undefined otherwise.
+ */
+export declare function getExtensionValue(resource: Resource, ...urls: string[]): string | undefined;
+/**
+ * FHIR JSON stringify.
+ * Removes properties with empty string values.
+ * Removes objects with zero properties.
+ * See: https://www.hl7.org/fhir/json.html
+ * @param value The input value.
+ * @param pretty Optional flag to pretty-print the JSON.
+ * @returns The resulting JSON string.
+ */
+export declare function stringify(value: any, pretty?: boolean): string;
+/**
+ * Resource equality.
+ * Ignores meta.versionId and meta.lastUpdated.
+ * @param object1 The first object.
+ * @param object2 The second object.
+ * @returns True if the objects are equal.
+ */
+export declare function deepEquals(object1: unknown, object2: unknown, path?: string): boolean;
+/**
+ * Returns true if the input string is a UUID.
+ * @param input The input string.
+ * @returns True if the input string matches the UUID format.
+ */
+export declare function isUUID(input: string): boolean;
+/**
+ * Returns true if the input is an object.
+ * @param object 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>;
+/**
+ * Returns true if the input array is an array of strings.
+ * @param arr Input array.
+ * @returns True if the input array is an array of strings.
+ */
+export declare function isStringArray(arr: any[]): arr is string[];
+/**
+ * Converts an ArrayBuffer to hex string.
+ * See: https://stackoverflow.com/a/55200387
+ * @param arrayBuffer The input array buffer.
+ * @returns The resulting hex string.
+ */
+export declare function arrayBufferToHex(arrayBuffer: ArrayBuffer): string;
+/**
+ * Converts an ArrayBuffer to a base-64 encoded string.
+ * @param arrayBuffer The input array buffer.
+ * @returns The base-64 encoded string.
+ */
+export declare function arrayBufferToBase64(arrayBuffer: ArrayBuffer): string;
+export declare function capitalize(word: string): string;
+export declare function isLowerCase(c: string): boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@medplum/core",
-  "version": "0.9.3",
+  "version": "0.9.6",
   "description": "Medplum TS/JS Library",
   "author": "Medplum <hello@medplum.com>",
   "license": "Apache-2.0",
@@ -17,7 +17,8 @@
     "test": "jest"
   },
   "devDependencies": {
-    "@medplum/fhirtypes": "0.9.3",
+    "@medplum/fhirtypes": "0.9.6",
+    "@types/nodemailer": "6.4.4",
     "fast-json-patch": "3.1.1"
   },
   "main": "dist/cjs/index.js",