@medplum/core 5.1.30 → 5.1.32

package/dist/cjs/index.d.ts

@@ -2545,6 +2545,25 @@ export declare function getExtensionValue(resource: any, ...urls: string[]): Ext
  */
 export declare function getIdentifier(resource: Resource, system: string): string | undefined;
 
+/**
+ * Returns the resource identifier for the given identifier type.
+ *
+ * Whereas {@link getIdentifier} matches on `Identifier.system`, i.e. who assigned the identifier,
+ * this matches on `Identifier.type`, i.e. what kind of identifier it is. For example,
+ * {@link MRN_IDENTIFIER_TYPE} finds the medical record number no matter which organization issued it.
+ *
+ * Both the system and the code of the type coding must match. Matching on code alone would be
+ * ambiguous, because the same code means different things in different code systems.
+ *
+ * If multiple identifiers exist with the same type, the first one is returned.
+ *
+ * If the type is not found, then returns undefined.
+ * @param resource - The resource to check.
+ * @param type - The identifier type coding, such as {@link MRN_IDENTIFIER_TYPE}.
+ * @returns The identifier value if found; otherwise undefined.
+ */
+export declare function getIdentifierByType(resource: Resource, type: Coding): string | undefined;
+
 /**
  * Returns an image URL for the resource, if one is available.
  * @param resource - The input resource.
@@ -2649,6 +2668,13 @@ export declare function getQuestionnaireAnswers(response: QuestionnaireResponse)
  */
 export declare function getRandomString(): string;
 
+/**
+ * Returns the number of milliseconds until a rate limit resets.
+ * @param outcome - The rate limit outcome.
+ * @returns Milliseconds until reset, or undefined if not present.
+ */
+export declare function getRateLimitReset(outcome: OperationOutcome): number | undefined;
+
 /**
  * Returns a reference string for a resource.
  * @param input - The FHIR resource or reference.
@@ -2811,6 +2837,8 @@ export declare interface GoogleLoginRequest extends BaseLoginRequest {
  */
 export declare function hasSchedulingParameters(resource: Schedule | HealthcareService): boolean;
 
+export declare const HL7_V2_0203 = "http://terminology.hl7.org/CodeSystem/v2-0203";
+
 export declare interface Hl7AckOptions {
     ackCode: AckCode;
     errSegment?: Hl7Segment;
@@ -4310,20 +4338,20 @@ export declare interface MedicationOrderDrugInput {
     readonly rxNorm?: string;
     readonly routedMedId?: number;
     /**
-     * Vendor formulation key, paired with {@link routedMedId} to order a drug that
+     * Vendor formulation key, paired with {@link MedicationOrderDrugInput.routedMedId} to order a drug that
      * has no dose-level product to resolve an NDC from — OTC / topical /
      * wide-multi-strength generics for which the vendor's dose-format lookup
-     * returns nothing. Supply {@link drugName} alongside it, since there is no
+     * returns nothing. Supply {@link MedicationOrderDrugInput.drugName} alongside it, since there is no
      * catalog row to derive a name from.
      */
     readonly gcnSeqno?: number;
-    /** Drug name, required for a {@link gcnSeqno}-keyed line (no catalog row to name it). */
+    /** Drug name, required for a {@link MedicationOrderDrugInput.gcnSeqno}-keyed line (no catalog row to name it). */
     readonly drugName?: string;
     /**
-     * Dose text for a {@link gcnSeqno}-keyed line, e.g. `"solution"`.
+     * Dose text for a {@link MedicationOrderDrugInput.gcnSeqno}-keyed line, e.g. `"solution"`.
      *
      * Optional, and only worth sending when the caller holds dose text *separate*
-     * from {@link drugName} — a hand-entered form, say. Passing a full product
+     * from {@link MedicationOrderDrugInput.drugName} — a hand-entered form, say. Passing a full product
      * label duplicates it in the description the vendor renders. When omitted, the
      * vendor derives the dose from the formulation key or falls back to the sig.
      */
@@ -4484,7 +4512,7 @@ export declare interface MedicationSearchParams {
     readonly rxNorm?: string;
     readonly routedMedId?: number;
     /**
-     * Vendor formulation keys under {@link routedMedId}, from the name-search hit.
+     * Vendor formulation keys under {@link MedicationSearchParams.routedMedId}, from the name-search hit.
      * Only used when the drug has no dose-level products: each key is resolved to
      * its marketed strength so the caller still gets selectable formulations
      * instead of an empty result. Ignored otherwise.
@@ -5943,6 +5971,12 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * Adds default options to the fetch options.
      * @param options - The options to add defaults to.
      */
+    /**
+     * Determines if a URL is internal and should receive authentication credentials.
+     * @param url - The URL to check
+     * @returns True if the URL should receive credentials
+     */
+    private isInternalUrl;
     private addFetchOptionsDefaults;
     /**
      * Sets the "Content-Type" header on fetch options.
@@ -7084,6 +7118,9 @@ export declare interface MoveOperation {
     path: string;
 }
 
+/** The HL7 v2 Table 0203 coding for a medical record number. */
+export declare const MRN_IDENTIFIER_TYPE: Coding;
+
 export declare const multipleMatches: OperationOutcome;
 
 export declare const NDC = "http://hl7.org/fhir/sid/ndc";
@@ -7894,6 +7931,8 @@ export declare class ParserBuilder {
   */
  export declare type QueryTypes = URLSearchParams | string[][] | Record<string, string | number | boolean | undefined> | string | undefined;
 
+ export declare const RATE_LIMIT_RESET_EXTENSION_URL = "https://medplum.com/fhir/StructureDefinition/rate-limit-reset";
+
  export declare type RateLimitInfo = {
      /** Name of the rate limiter. */
      name: string;
@@ -8240,8 +8279,9 @@ export declare class ParserBuilder {
   * Conditional methods (`createResourceIfNoneExist`, `upsertResource`) emit
   * even when the server made no change, except on HTTP 304 "Not Modified".
   *
-  * @template T - The type of the modified resource. Defaults to `Resource`; narrow it (e.g. via
-  * `useResourceModified('Slot', ...)`) to get a typed `resource` payload without extra guards.
+  * The generic type parameter `T` specifies the type of the modified resource.
+  * It defaults to `Resource`; narrow it (e.g. via `useResourceModified('Slot', ...)`)
+  * to get a typed `resource` payload without extra guards.
   */
  export declare interface ResourceModifiedEvent<T extends Resource = Resource> {
      /** The type of the modified resource. */
@@ -8293,6 +8333,8 @@ export declare class ParserBuilder {
 
  export declare const SchedulingPlanDefinitionURI = "https://medplum.com/fhir/StructureDefinition/SchedulingPlanDefinition";
 
+ export declare const SchedulingScheduleColorURI = "https://medplum.com/fhir/StructureDefinition/SchedulingColor";
+
  export declare interface SearchableToken {
      readonly system: string | undefined;
      readonly value: string | undefined;
@@ -8444,6 +8486,13 @@ export declare class ParserBuilder {
      use?: Identifier['use'];
  }
 
+ /**
+  * Adds the rate limit reset delay to an OperationOutcome.
+  * @param outcome - The rate limit outcome.
+  * @param msBeforeNext - Milliseconds until the rate limit resets.
+  */
+ export declare function setRateLimitReset(outcome: OperationOutcome, msBeforeNext: number): void;
+
  /**
   * Immutably sets one scheduling parameter on a Schedule for a HealthcareService, so that calendar keeps
   * it in place of the service-level parameter of the same name. Whatever the Schedule already holds at the

package/dist/esm/index.d.ts

@@ -2545,6 +2545,25 @@ export declare function getExtensionValue(resource: any, ...urls: string[]): Ext
  */
 export declare function getIdentifier(resource: Resource, system: string): string | undefined;
 
+/**
+ * Returns the resource identifier for the given identifier type.
+ *
+ * Whereas {@link getIdentifier} matches on `Identifier.system`, i.e. who assigned the identifier,
+ * this matches on `Identifier.type`, i.e. what kind of identifier it is. For example,
+ * {@link MRN_IDENTIFIER_TYPE} finds the medical record number no matter which organization issued it.
+ *
+ * Both the system and the code of the type coding must match. Matching on code alone would be
+ * ambiguous, because the same code means different things in different code systems.
+ *
+ * If multiple identifiers exist with the same type, the first one is returned.
+ *
+ * If the type is not found, then returns undefined.
+ * @param resource - The resource to check.
+ * @param type - The identifier type coding, such as {@link MRN_IDENTIFIER_TYPE}.
+ * @returns The identifier value if found; otherwise undefined.
+ */
+export declare function getIdentifierByType(resource: Resource, type: Coding): string | undefined;
+
 /**
  * Returns an image URL for the resource, if one is available.
  * @param resource - The input resource.
@@ -2649,6 +2668,13 @@ export declare function getQuestionnaireAnswers(response: QuestionnaireResponse)
  */
 export declare function getRandomString(): string;
 
+/**
+ * Returns the number of milliseconds until a rate limit resets.
+ * @param outcome - The rate limit outcome.
+ * @returns Milliseconds until reset, or undefined if not present.
+ */
+export declare function getRateLimitReset(outcome: OperationOutcome): number | undefined;
+
 /**
  * Returns a reference string for a resource.
  * @param input - The FHIR resource or reference.
@@ -2811,6 +2837,8 @@ export declare interface GoogleLoginRequest extends BaseLoginRequest {
  */
 export declare function hasSchedulingParameters(resource: Schedule | HealthcareService): boolean;
 
+export declare const HL7_V2_0203 = "http://terminology.hl7.org/CodeSystem/v2-0203";
+
 export declare interface Hl7AckOptions {
     ackCode: AckCode;
     errSegment?: Hl7Segment;
@@ -4310,20 +4338,20 @@ export declare interface MedicationOrderDrugInput {
     readonly rxNorm?: string;
     readonly routedMedId?: number;
     /**
-     * Vendor formulation key, paired with {@link routedMedId} to order a drug that
+     * Vendor formulation key, paired with {@link MedicationOrderDrugInput.routedMedId} to order a drug that
      * has no dose-level product to resolve an NDC from — OTC / topical /
      * wide-multi-strength generics for which the vendor's dose-format lookup
-     * returns nothing. Supply {@link drugName} alongside it, since there is no
+     * returns nothing. Supply {@link MedicationOrderDrugInput.drugName} alongside it, since there is no
      * catalog row to derive a name from.
      */
     readonly gcnSeqno?: number;
-    /** Drug name, required for a {@link gcnSeqno}-keyed line (no catalog row to name it). */
+    /** Drug name, required for a {@link MedicationOrderDrugInput.gcnSeqno}-keyed line (no catalog row to name it). */
     readonly drugName?: string;
     /**
-     * Dose text for a {@link gcnSeqno}-keyed line, e.g. `"solution"`.
+     * Dose text for a {@link MedicationOrderDrugInput.gcnSeqno}-keyed line, e.g. `"solution"`.
      *
      * Optional, and only worth sending when the caller holds dose text *separate*
-     * from {@link drugName} — a hand-entered form, say. Passing a full product
+     * from {@link MedicationOrderDrugInput.drugName} — a hand-entered form, say. Passing a full product
      * label duplicates it in the description the vendor renders. When omitted, the
      * vendor derives the dose from the formulation key or falls back to the sig.
      */
@@ -4484,7 +4512,7 @@ export declare interface MedicationSearchParams {
     readonly rxNorm?: string;
     readonly routedMedId?: number;
     /**
-     * Vendor formulation keys under {@link routedMedId}, from the name-search hit.
+     * Vendor formulation keys under {@link MedicationSearchParams.routedMedId}, from the name-search hit.
      * Only used when the drug has no dose-level products: each key is resolved to
      * its marketed strength so the caller still gets selectable formulations
      * instead of an empty result. Ignored otherwise.
@@ -5943,6 +5971,12 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * Adds default options to the fetch options.
      * @param options - The options to add defaults to.
      */
+    /**
+     * Determines if a URL is internal and should receive authentication credentials.
+     * @param url - The URL to check
+     * @returns True if the URL should receive credentials
+     */
+    private isInternalUrl;
     private addFetchOptionsDefaults;
     /**
      * Sets the "Content-Type" header on fetch options.
@@ -7084,6 +7118,9 @@ export declare interface MoveOperation {
     path: string;
 }
 
+/** The HL7 v2 Table 0203 coding for a medical record number. */
+export declare const MRN_IDENTIFIER_TYPE: Coding;
+
 export declare const multipleMatches: OperationOutcome;
 
 export declare const NDC = "http://hl7.org/fhir/sid/ndc";
@@ -7894,6 +7931,8 @@ export declare class ParserBuilder {
   */
  export declare type QueryTypes = URLSearchParams | string[][] | Record<string, string | number | boolean | undefined> | string | undefined;
 
+ export declare const RATE_LIMIT_RESET_EXTENSION_URL = "https://medplum.com/fhir/StructureDefinition/rate-limit-reset";
+
  export declare type RateLimitInfo = {
      /** Name of the rate limiter. */
      name: string;
@@ -8240,8 +8279,9 @@ export declare class ParserBuilder {
   * Conditional methods (`createResourceIfNoneExist`, `upsertResource`) emit
   * even when the server made no change, except on HTTP 304 "Not Modified".
   *
-  * @template T - The type of the modified resource. Defaults to `Resource`; narrow it (e.g. via
-  * `useResourceModified('Slot', ...)`) to get a typed `resource` payload without extra guards.
+  * The generic type parameter `T` specifies the type of the modified resource.
+  * It defaults to `Resource`; narrow it (e.g. via `useResourceModified('Slot', ...)`)
+  * to get a typed `resource` payload without extra guards.
   */
  export declare interface ResourceModifiedEvent<T extends Resource = Resource> {
      /** The type of the modified resource. */
@@ -8293,6 +8333,8 @@ export declare class ParserBuilder {
 
  export declare const SchedulingPlanDefinitionURI = "https://medplum.com/fhir/StructureDefinition/SchedulingPlanDefinition";
 
+ export declare const SchedulingScheduleColorURI = "https://medplum.com/fhir/StructureDefinition/SchedulingColor";
+
  export declare interface SearchableToken {
      readonly system: string | undefined;
      readonly value: string | undefined;
@@ -8444,6 +8486,13 @@ export declare class ParserBuilder {
      use?: Identifier['use'];
  }
 
+ /**
+  * Adds the rate limit reset delay to an OperationOutcome.
+  * @param outcome - The rate limit outcome.
+  * @param msBeforeNext - Milliseconds until the rate limit resets.
+  */
+ export declare function setRateLimitReset(outcome: OperationOutcome, msBeforeNext: number): void;
+
  /**
   * Immutably sets one scheduling parameter on a Schedule for a HealthcareService, so that calendar keeps
   * it in place of the service-level parameter of the same name. Whatever the Schedule already holds at the