@medplum/core 2.2.2 → 2.2.4

package/dist/cjs/index.d.ts

@@ -425,6 +425,10 @@ export declare type CurrentContext<EventName extends FhircastResourceEventName =
     context: FhircastEventContext<EventName>[];
 };
 
+export declare type DataTypesMap = {
+    [type: string]: InternalTypeSchema;
+};
+
 /**
  * Decodes a base64 string.
  * Handles both browser and Node environments.
@@ -486,6 +490,7 @@ export declare class DotAtom extends InfixOperatorAtom {
 export declare interface ElementType {
     code: string;
     targetProfile?: string[];
+    profile?: string[];
 }
 
 export declare interface EmailPasswordLoginRequest extends BaseLoginRequest {
@@ -1121,7 +1126,7 @@ export declare class FunctionAtom implements Atom {
  */
 export declare function generateId(): string;
 
-export declare function getAllDataTypes(): Record<string, InternalTypeSchema>;
+export declare function getAllDataTypes(): DataTypesMap;
 
 /**
  * Returns an array of  questionnaire answers as a map by link ID.
@@ -1138,7 +1143,7 @@ export declare function getAllQuestionnaireAnswers(response: QuestionnaireRespon
  */
 export declare function getCodeBySystem(concept: CodeableConcept, system: string): string | undefined;
 
-export declare function getDataType(type: string): InternalTypeSchema;
+export declare function getDataType(type: string, profileUrl?: string): InternalTypeSchema;
 
 /**
  * Returns a Date property as a Date.
@@ -1158,13 +1163,20 @@ export declare function getDisplayString(resource: Resource): 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;
 
+/**
+ * Returns an element definition from mapping of elements by property name.
+ * @param elements  - A mapping of property names to element definitions
+ * @param propertyName - The property name of interest
+ * @returns The element definition if found.
+ */
+export declare function getElementDefinitionFromElements(elements: InternalTypeSchema['elements'], propertyName: string): InternalSchemaElement | undefined;
+
 /**
  * Returns the type name for an ElementDefinition.
  * @param elementDefinition - The element definition.
@@ -1218,7 +1230,14 @@ export declare function getNestedProperty(value: TypedValue, key: string): (Type
  * @param path - The FHIR element definition path.
  * @returns The best guess of the display name.
  */
-export declare function getPropertyDisplayName(path: string): string;
+export declare function getPathDisplayName(path: string): string;
+
+/**
+ * Return s a human friendly display name for a FHIR element property or slice name
+ * @param propertyName - The FHIR element property or slice name
+ * @returns The best guess of the display name.
+ */
+export declare function getPropertyDisplayName(propertyName: string): string;
 
 /**
  * Returns all questionnaire answers as a map by link ID.
@@ -1291,6 +1310,15 @@ export declare function getStatus(outcome: OperationOutcome): number;
  */
 export declare function getTypedPropertyValue(input: TypedValue, path: string): TypedValue[] | TypedValue | undefined;
 
+/**
+ * Returns the value of the property and the property type using a type schema.
+ * @param value - The base context (FHIR resource or backbone element).
+ * @param path - The property path.
+ * @param element - The property element definition.
+ * @returns The value of the property and the property type.
+ */
+export declare function getTypedPropertyValueWithSchema(value: TypedValue['value'], path: string, element: InternalSchemaElement): TypedValue[] | TypedValue | undefined;
+
 /**
  * Global schema singleton.
  */
@@ -1624,7 +1652,12 @@ export declare function indexSearchParameter(searchParam: SearchParameter): void
  */
 export declare function indexSearchParameterBundle(bundle: Bundle<SearchParameter>): void;
 
-export declare function indexStructureDefinitionBundle(bundle: StructureDefinition[] | Bundle): void;
+/**
+ * Parses and indexes structure definitions
+ * @param bundle - Bundle or array of structure definitions to be parsed and indexed
+ * @param profileUrl - (optional) URL of the profile the SDs are related to
+ */
+export declare function indexStructureDefinitionBundle(bundle: StructureDefinition[] | Bundle, profileUrl?: string | undefined): void;
 
 export declare abstract class InfixOperatorAtom implements Atom {
     readonly operator: string;
@@ -1640,9 +1673,9 @@ export declare interface InfixParselet {
     parse?(parser: Parser, left: Atom, token: Token): Atom;
 }
 
-export declare function inflateBaseSchema(base: BaseSchema): Record<string, InternalTypeSchema>;
+export declare function inflateBaseSchema(base: BaseSchema): DataTypesMap;
 
-export declare function inflateElement(partial: Partial<InternalSchemaElement>): InternalSchemaElement;
+export declare function inflateElement(path: string, partial: Partial<InternalSchemaElement>): InternalSchemaElement;
 
 export declare function initFhirPathParserBuilder(): ParserBuilder;
 
@@ -1665,8 +1698,10 @@ export declare interface InternalSchemaElement {
  */
 export declare interface InternalTypeSchema {
     name: string;
+    title?: string;
     url?: string;
     kind?: string;
+    type?: string;
     description?: string;
     elements: Record<string, InternalSchemaElement>;
     constraints?: Constraint[];
@@ -1762,6 +1797,8 @@ export declare function isOperationOutcome(value: unknown): value is OperationOu
  */
 export declare function isPeriod(input: unknown): input is Period;
 
+export declare function isProfileLoaded(profileUrl: string): boolean;
+
 /**
  * Returns true if the resource is a "ProfileResource".
  * @param resource - The FHIR resource.
@@ -1845,7 +1882,7 @@ export declare class LiteralAtom implements Atom {
     toString(): string;
 }
 
-export declare function loadDataType(sd: StructureDefinition): void;
+export declare function loadDataType(sd: StructureDefinition, profileUrl?: string | undefined): void;
 
 export declare interface LoginAuthenticationResponse {
     readonly login: string;
@@ -1972,6 +2009,8 @@ export declare interface Marker {
     column: number;
 }
 
+export declare function matchDiscriminant(value: TypedValue | TypedValue[] | undefined, discriminator: SliceDiscriminator, slice: SliceDefinition, elements?: Record<string, InternalSchemaElement>): boolean;
+
 /**
  * Returns true if the resource satisfies the current access policy.
  * @param accessPolicy - The access policy.
@@ -2537,6 +2576,14 @@ export declare class MedplumClient extends EventTarget_2 {
      * @returns Promise to a schema with the requested resource type.
      */
     requestSchema(resourceType: string): Promise<void>;
+    /**
+     * Requests the schema for a profile.
+     * If the schema is already cached, the promise is resolved immediately.
+     * @category Schema
+     * @param profileUrl - The FHIR URL of the profile
+     * @returns Promise to a schema with the requested profile.
+     */
+    requestProfileSchema(profileUrl: string): Promise<void>;
     /**
      * Reads resource history by resource type and ID.
      *
@@ -3600,6 +3647,7 @@ export declare interface MedplumInfraConfig {
     clamscanLoggingBucket: string;
     clamscanLoggingPrefix: string;
     skipDns?: boolean;
+    hostedZoneName?: string;
     additionalContainers?: {
         name: string;
         image: string;
@@ -3659,6 +3707,7 @@ export declare interface MedplumSourceInfraConfig {
     clamscanLoggingBucket: ValueOrExternalSecret<string>;
     clamscanLoggingPrefix: ValueOrExternalSecret<string>;
     skipDns?: ValueOrExternalSecret<boolean>;
+    hostedZoneName?: ValueOrExternalSecret<string>;
     additionalContainers?: {
         name: ValueOrExternalSecret<string>;
         image: ValueOrExternalSecret<string>;
@@ -4416,6 +4465,8 @@ export declare const sleep: (ms: number) => Promise<void>;
 
 export declare interface SliceDefinition {
     name: string;
+    path: string;
+    definition?: string;
     type?: ElementType[];
     elements: Record<string, InternalSchemaElement>;
     min: number;
@@ -4570,7 +4621,9 @@ export declare const tooManyRequests: OperationOutcome;
  */
 export declare function toTypedValue(value: unknown): TypedValue;
 
-export declare function tryGetDataType(type: string): InternalTypeSchema | undefined;
+export declare function tryGetDataType(type: string, profileUrl?: string): InternalTypeSchema | undefined;
+
+export declare function tryGetProfile(profileUrl: string): InternalTypeSchema | undefined;
 
 export declare class TypedEventTarget<TEvents extends Record<string, Event_2>> {
     private emitter;

package/dist/esm/index.d.ts

@@ -425,6 +425,10 @@ export declare type CurrentContext<EventName extends FhircastResourceEventName =
     context: FhircastEventContext<EventName>[];
 };
 
+export declare type DataTypesMap = {
+    [type: string]: InternalTypeSchema;
+};
+
 /**
  * Decodes a base64 string.
  * Handles both browser and Node environments.
@@ -486,6 +490,7 @@ export declare class DotAtom extends InfixOperatorAtom {
 export declare interface ElementType {
     code: string;
     targetProfile?: string[];
+    profile?: string[];
 }
 
 export declare interface EmailPasswordLoginRequest extends BaseLoginRequest {
@@ -1121,7 +1126,7 @@ export declare class FunctionAtom implements Atom {
  */
 export declare function generateId(): string;
 
-export declare function getAllDataTypes(): Record<string, InternalTypeSchema>;
+export declare function getAllDataTypes(): DataTypesMap;
 
 /**
  * Returns an array of  questionnaire answers as a map by link ID.
@@ -1138,7 +1143,7 @@ export declare function getAllQuestionnaireAnswers(response: QuestionnaireRespon
  */
 export declare function getCodeBySystem(concept: CodeableConcept, system: string): string | undefined;
 
-export declare function getDataType(type: string): InternalTypeSchema;
+export declare function getDataType(type: string, profileUrl?: string): InternalTypeSchema;
 
 /**
  * Returns a Date property as a Date.
@@ -1158,13 +1163,20 @@ export declare function getDisplayString(resource: Resource): 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;
 
+/**
+ * Returns an element definition from mapping of elements by property name.
+ * @param elements  - A mapping of property names to element definitions
+ * @param propertyName - The property name of interest
+ * @returns The element definition if found.
+ */
+export declare function getElementDefinitionFromElements(elements: InternalTypeSchema['elements'], propertyName: string): InternalSchemaElement | undefined;
+
 /**
  * Returns the type name for an ElementDefinition.
  * @param elementDefinition - The element definition.
@@ -1218,7 +1230,14 @@ export declare function getNestedProperty(value: TypedValue, key: string): (Type
  * @param path - The FHIR element definition path.
  * @returns The best guess of the display name.
  */
-export declare function getPropertyDisplayName(path: string): string;
+export declare function getPathDisplayName(path: string): string;
+
+/**
+ * Return s a human friendly display name for a FHIR element property or slice name
+ * @param propertyName - The FHIR element property or slice name
+ * @returns The best guess of the display name.
+ */
+export declare function getPropertyDisplayName(propertyName: string): string;
 
 /**
  * Returns all questionnaire answers as a map by link ID.
@@ -1291,6 +1310,15 @@ export declare function getStatus(outcome: OperationOutcome): number;
  */
 export declare function getTypedPropertyValue(input: TypedValue, path: string): TypedValue[] | TypedValue | undefined;
 
+/**
+ * Returns the value of the property and the property type using a type schema.
+ * @param value - The base context (FHIR resource or backbone element).
+ * @param path - The property path.
+ * @param element - The property element definition.
+ * @returns The value of the property and the property type.
+ */
+export declare function getTypedPropertyValueWithSchema(value: TypedValue['value'], path: string, element: InternalSchemaElement): TypedValue[] | TypedValue | undefined;
+
 /**
  * Global schema singleton.
  */
@@ -1624,7 +1652,12 @@ export declare function indexSearchParameter(searchParam: SearchParameter): void
  */
 export declare function indexSearchParameterBundle(bundle: Bundle<SearchParameter>): void;
 
-export declare function indexStructureDefinitionBundle(bundle: StructureDefinition[] | Bundle): void;
+/**
+ * Parses and indexes structure definitions
+ * @param bundle - Bundle or array of structure definitions to be parsed and indexed
+ * @param profileUrl - (optional) URL of the profile the SDs are related to
+ */
+export declare function indexStructureDefinitionBundle(bundle: StructureDefinition[] | Bundle, profileUrl?: string | undefined): void;
 
 export declare abstract class InfixOperatorAtom implements Atom {
     readonly operator: string;
@@ -1640,9 +1673,9 @@ export declare interface InfixParselet {
     parse?(parser: Parser, left: Atom, token: Token): Atom;
 }
 
-export declare function inflateBaseSchema(base: BaseSchema): Record<string, InternalTypeSchema>;
+export declare function inflateBaseSchema(base: BaseSchema): DataTypesMap;
 
-export declare function inflateElement(partial: Partial<InternalSchemaElement>): InternalSchemaElement;
+export declare function inflateElement(path: string, partial: Partial<InternalSchemaElement>): InternalSchemaElement;
 
 export declare function initFhirPathParserBuilder(): ParserBuilder;
 
@@ -1665,8 +1698,10 @@ export declare interface InternalSchemaElement {
  */
 export declare interface InternalTypeSchema {
     name: string;
+    title?: string;
     url?: string;
     kind?: string;
+    type?: string;
     description?: string;
     elements: Record<string, InternalSchemaElement>;
     constraints?: Constraint[];
@@ -1762,6 +1797,8 @@ export declare function isOperationOutcome(value: unknown): value is OperationOu
  */
 export declare function isPeriod(input: unknown): input is Period;
 
+export declare function isProfileLoaded(profileUrl: string): boolean;
+
 /**
  * Returns true if the resource is a "ProfileResource".
  * @param resource - The FHIR resource.
@@ -1845,7 +1882,7 @@ export declare class LiteralAtom implements Atom {
     toString(): string;
 }
 
-export declare function loadDataType(sd: StructureDefinition): void;
+export declare function loadDataType(sd: StructureDefinition, profileUrl?: string | undefined): void;
 
 export declare interface LoginAuthenticationResponse {
     readonly login: string;
@@ -1972,6 +2009,8 @@ export declare interface Marker {
     column: number;
 }
 
+export declare function matchDiscriminant(value: TypedValue | TypedValue[] | undefined, discriminator: SliceDiscriminator, slice: SliceDefinition, elements?: Record<string, InternalSchemaElement>): boolean;
+
 /**
  * Returns true if the resource satisfies the current access policy.
  * @param accessPolicy - The access policy.
@@ -2537,6 +2576,14 @@ export declare class MedplumClient extends EventTarget_2 {
      * @returns Promise to a schema with the requested resource type.
      */
     requestSchema(resourceType: string): Promise<void>;
+    /**
+     * Requests the schema for a profile.
+     * If the schema is already cached, the promise is resolved immediately.
+     * @category Schema
+     * @param profileUrl - The FHIR URL of the profile
+     * @returns Promise to a schema with the requested profile.
+     */
+    requestProfileSchema(profileUrl: string): Promise<void>;
     /**
      * Reads resource history by resource type and ID.
      *
@@ -3600,6 +3647,7 @@ export declare interface MedplumInfraConfig {
     clamscanLoggingBucket: string;
     clamscanLoggingPrefix: string;
     skipDns?: boolean;
+    hostedZoneName?: string;
     additionalContainers?: {
         name: string;
         image: string;
@@ -3659,6 +3707,7 @@ export declare interface MedplumSourceInfraConfig {
     clamscanLoggingBucket: ValueOrExternalSecret<string>;
     clamscanLoggingPrefix: ValueOrExternalSecret<string>;
     skipDns?: ValueOrExternalSecret<boolean>;
+    hostedZoneName?: ValueOrExternalSecret<string>;
     additionalContainers?: {
         name: ValueOrExternalSecret<string>;
         image: ValueOrExternalSecret<string>;
@@ -4416,6 +4465,8 @@ export declare const sleep: (ms: number) => Promise<void>;
 
 export declare interface SliceDefinition {
     name: string;
+    path: string;
+    definition?: string;
     type?: ElementType[];
     elements: Record<string, InternalSchemaElement>;
     min: number;
@@ -4570,7 +4621,9 @@ export declare const tooManyRequests: OperationOutcome;
  */
 export declare function toTypedValue(value: unknown): TypedValue;
 
-export declare function tryGetDataType(type: string): InternalTypeSchema | undefined;
+export declare function tryGetDataType(type: string, profileUrl?: string): InternalTypeSchema | undefined;
+
+export declare function tryGetProfile(profileUrl: string): InternalTypeSchema | undefined;
 
 export declare class TypedEventTarget<TEvents extends Record<string, Event_2>> {
     private emitter;