@medplum/core 5.1.28 → 5.1.29

package/dist/cjs/index.d.ts

@@ -831,6 +831,17 @@ export declare function checkIfValidMedplumVersion(appName: string, version: str
  */
 export declare function clearReleaseCache(): void;
 
+/**
+ * Immutably clears one scheduling parameter a Schedule sets for a HealthcareService, dropping that
+ * calendar back to the service-level parameter of the same name. Pairs with `setScheduleParameter`
+ * and `getScheduleParameters`.
+ * @param schedule - Schedule to update
+ * @param service - HealthcareService referenced by the parameters
+ * @param url - Url of the SchedulingParameters sub-extension to remove, for example `availability`
+ * @returns A cloned Schedule without the matching parameter
+ */
+export declare function clearScheduleParameter(schedule: Schedule, service: WithId<HealthcareService>, url: string): Schedule;
+
 /**
  * Log level for MedplumClient requests and responses.
  * - 'none': No logging
@@ -1632,6 +1643,15 @@ export declare interface ExtendedInternalSchemaElement extends InternalSchemaEle
     readonly?: boolean;
 }
 
+/**
+ * Anything that can carry FHIR extensions: resources such as `Patient`, data types such as
+ * `CodeableConcept`, and extensions themselves. Structural, so any of those is accepted, while a
+ * type that cannot hold extensions, `Binary` being the notable example, is rejected.
+ */
+export declare interface Extensible {
+    extension?: Extension[];
+}
+
 export declare type ExternalSecret<T extends ExternalSecretPrimitive = ExternalSecretPrimitive> = {
     system: ExternalSecretSystem;
     key: string;
@@ -2466,6 +2486,18 @@ export declare function getExpressionsForResourceType(resourceType: string, expr
  */
 export declare function getExtension(resource: any, ...urls: string[]): Extension | undefined;
 
+/**
+ * Returns every extension reachable by the given extension URLs.
+ *
+ * Like `getExtension`, but does not stop at the first match: extensions that repeat under one URL are
+ * all returned, at every level. Use it for extensions defined with a cardinality above one, where
+ * `getExtension` would silently read only the first.
+ * @param extensible - The base resource, data type, or extension. Anything that may hold an `extension` array.
+ * @param urlOrUrls - One extension URL, or an array of them where each entry represents descending a level in a nested extension.
+ * @returns Every matching extension, in document order. Empty if none match or no URL is given.
+ */
+export declare function getExtensions(extensible: Extensible | undefined, urlOrUrls: string | string[]): Extension[];
+
 /**
  * Returns an extension value by extension URLs.
  * @param resource - The base resource.
@@ -2608,6 +2640,30 @@ export declare function getReferenceString(input: Reference | Resource): string
  */
 export declare function getResourceTypes(): ResourceType[];
 
+/**
+ * Reads one scheduling parameter a Schedule sets for a HealthcareService, taking precedence over the
+ * service-level parameter of the same name. Pairs with `setScheduleParameter` and `clearScheduleParameter`.
+ *
+ * The result is a list rather than a single extension because a Schedule may carry more than one
+ * SchedulingParameters extension matching the service, and because a parameter may legitimately repeat.
+ * @param schedule - Schedule to inspect
+ * @param service - HealthcareService referenced by the parameters
+ * @param url - Url of the SchedulingParameters sub-extension to read, for example `availability`
+ * @returns Every matching sub-extension, in document order
+ */
+export declare function getScheduleParameters(schedule: Schedule, service: WithId<HealthcareService>, url: string): Extension[];
+
+/**
+ * Resolves the timezone used by scheduling in server priority order: the Schedule's parameters for the
+ * service, then the service's own parameters, then the actor's standard FHIR timezone extension.
+ * @param service - HealthcareService whose parameters may define a timezone
+ * @param schedule - Schedule whose parameters may define a timezone. Omit to resolve the service's own timezone,
+ * as when the service default hours are being read on their own rather than through a particular calendar.
+ * @param actor - Optional Schedule actor used as a timezone fallback
+ * @returns The resolved IANA timezone identifier, if present
+ */
+export declare function getSchedulingTimezone(service: WithId<HealthcareService>, schedule?: Schedule, actor?: Resource): string | undefined;
+
 /**
  * Returns a search parameter for a resource type by search code.
  * @param resourceType - The FHIR resource type.
@@ -2720,6 +2776,9 @@ export declare interface GoogleLoginRequest extends BaseLoginRequest {
 
 /**
  * Returns whether a Schedule or HealthcareService has a SchedulingParameters extension.
+ *
+ * Unscoped: on a Schedule, where the extension repeats once per service, this reports that some
+ * service is configured rather than any particular one. Ask `getScheduleParameters` about a service.
  * @param resource - Schedule or HealthcareService to inspect
  * @returns True if the resource has a SchedulingParameters extension
  */
@@ -3668,7 +3727,7 @@ export declare function isStringArray(arr: any[]): arr is string[];
 
 export declare type IssueSeverity = 'error' | 'fatal' | 'warning' | 'information';
 
-export declare type IssueType = 'structure' | 'invariant' | 'processing';
+export declare type IssueType = 'structure' | 'invariant' | 'processing' | 'required';
 
 /**
  * Returns true if the input value is an object with a string text property.
@@ -4223,6 +4282,25 @@ export declare interface MedicationOrderDrugInput {
     readonly ndc?: string;
     readonly rxNorm?: string;
     readonly routedMedId?: number;
+    /**
+     * Vendor formulation key, paired with {@link 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
+     * 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). */
+    readonly drugName?: string;
+    /**
+     * Dose text for a {@link 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
+     * 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.
+     */
+    readonly line1?: string;
     readonly quantity: number;
     readonly quantityQualifier?: string;
     readonly refill?: number;
@@ -4378,6 +4456,13 @@ export declare interface MedicationSearchParams {
     readonly ndc?: string;
     readonly rxNorm?: string;
     readonly routedMedId?: number;
+    /**
+     * Vendor formulation keys under {@link 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.
+     */
+    readonly gcnSeqnos?: number[];
     readonly searchOtc?: boolean;
     readonly searchSupply?: boolean;
     readonly searchBrand?: boolean;
@@ -8322,6 +8407,23 @@ export declare class ParserBuilder {
      use?: Identifier['use'];
  }
 
+ /**
+  * 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
+  * sub-extension's url is replaced, and the SchedulingParameters extension is created if the Schedule has
+  * none for the service yet.
+  *
+  * Untyped by design, taking any sub-extension of the shape the parameter calls for, for example
+  * `{ url: 'bufferBefore', valueDuration: { value: 10, unit: 'min' } }`. A parameter whose value is a nested
+  * structure rather than a single `value[x]` is worth a typed wrapper over this; `availability` has one in
+  * `@medplum/react-scheduling`. Pairs with `clearScheduleParameter` and `getScheduleParameters`.
+  * @param schedule - Schedule to update
+  * @param service - HealthcareService referenced by the parameters
+  * @param subextension - SchedulingParameters sub-extension to set
+  * @returns A cloned Schedule containing the parameter
+  */
+ export declare function setScheduleParameter(schedule: Schedule, service: WithId<HealthcareService>, subextension: Extension): Schedule;
+
  export declare function singleton(collection: TypedValue[], type?: string): TypedValue | undefined;
 
  export declare function singularize<T>(value: T | T[] | undefined): T | undefined;

package/dist/esm/index.d.ts

@@ -831,6 +831,17 @@ export declare function checkIfValidMedplumVersion(appName: string, version: str
  */
 export declare function clearReleaseCache(): void;
 
+/**
+ * Immutably clears one scheduling parameter a Schedule sets for a HealthcareService, dropping that
+ * calendar back to the service-level parameter of the same name. Pairs with `setScheduleParameter`
+ * and `getScheduleParameters`.
+ * @param schedule - Schedule to update
+ * @param service - HealthcareService referenced by the parameters
+ * @param url - Url of the SchedulingParameters sub-extension to remove, for example `availability`
+ * @returns A cloned Schedule without the matching parameter
+ */
+export declare function clearScheduleParameter(schedule: Schedule, service: WithId<HealthcareService>, url: string): Schedule;
+
 /**
  * Log level for MedplumClient requests and responses.
  * - 'none': No logging
@@ -1632,6 +1643,15 @@ export declare interface ExtendedInternalSchemaElement extends InternalSchemaEle
     readonly?: boolean;
 }
 
+/**
+ * Anything that can carry FHIR extensions: resources such as `Patient`, data types such as
+ * `CodeableConcept`, and extensions themselves. Structural, so any of those is accepted, while a
+ * type that cannot hold extensions, `Binary` being the notable example, is rejected.
+ */
+export declare interface Extensible {
+    extension?: Extension[];
+}
+
 export declare type ExternalSecret<T extends ExternalSecretPrimitive = ExternalSecretPrimitive> = {
     system: ExternalSecretSystem;
     key: string;
@@ -2466,6 +2486,18 @@ export declare function getExpressionsForResourceType(resourceType: string, expr
  */
 export declare function getExtension(resource: any, ...urls: string[]): Extension | undefined;
 
+/**
+ * Returns every extension reachable by the given extension URLs.
+ *
+ * Like `getExtension`, but does not stop at the first match: extensions that repeat under one URL are
+ * all returned, at every level. Use it for extensions defined with a cardinality above one, where
+ * `getExtension` would silently read only the first.
+ * @param extensible - The base resource, data type, or extension. Anything that may hold an `extension` array.
+ * @param urlOrUrls - One extension URL, or an array of them where each entry represents descending a level in a nested extension.
+ * @returns Every matching extension, in document order. Empty if none match or no URL is given.
+ */
+export declare function getExtensions(extensible: Extensible | undefined, urlOrUrls: string | string[]): Extension[];
+
 /**
  * Returns an extension value by extension URLs.
  * @param resource - The base resource.
@@ -2608,6 +2640,30 @@ export declare function getReferenceString(input: Reference | Resource): string
  */
 export declare function getResourceTypes(): ResourceType[];
 
+/**
+ * Reads one scheduling parameter a Schedule sets for a HealthcareService, taking precedence over the
+ * service-level parameter of the same name. Pairs with `setScheduleParameter` and `clearScheduleParameter`.
+ *
+ * The result is a list rather than a single extension because a Schedule may carry more than one
+ * SchedulingParameters extension matching the service, and because a parameter may legitimately repeat.
+ * @param schedule - Schedule to inspect
+ * @param service - HealthcareService referenced by the parameters
+ * @param url - Url of the SchedulingParameters sub-extension to read, for example `availability`
+ * @returns Every matching sub-extension, in document order
+ */
+export declare function getScheduleParameters(schedule: Schedule, service: WithId<HealthcareService>, url: string): Extension[];
+
+/**
+ * Resolves the timezone used by scheduling in server priority order: the Schedule's parameters for the
+ * service, then the service's own parameters, then the actor's standard FHIR timezone extension.
+ * @param service - HealthcareService whose parameters may define a timezone
+ * @param schedule - Schedule whose parameters may define a timezone. Omit to resolve the service's own timezone,
+ * as when the service default hours are being read on their own rather than through a particular calendar.
+ * @param actor - Optional Schedule actor used as a timezone fallback
+ * @returns The resolved IANA timezone identifier, if present
+ */
+export declare function getSchedulingTimezone(service: WithId<HealthcareService>, schedule?: Schedule, actor?: Resource): string | undefined;
+
 /**
  * Returns a search parameter for a resource type by search code.
  * @param resourceType - The FHIR resource type.
@@ -2720,6 +2776,9 @@ export declare interface GoogleLoginRequest extends BaseLoginRequest {
 
 /**
  * Returns whether a Schedule or HealthcareService has a SchedulingParameters extension.
+ *
+ * Unscoped: on a Schedule, where the extension repeats once per service, this reports that some
+ * service is configured rather than any particular one. Ask `getScheduleParameters` about a service.
  * @param resource - Schedule or HealthcareService to inspect
  * @returns True if the resource has a SchedulingParameters extension
  */
@@ -3668,7 +3727,7 @@ export declare function isStringArray(arr: any[]): arr is string[];
 
 export declare type IssueSeverity = 'error' | 'fatal' | 'warning' | 'information';
 
-export declare type IssueType = 'structure' | 'invariant' | 'processing';
+export declare type IssueType = 'structure' | 'invariant' | 'processing' | 'required';
 
 /**
  * Returns true if the input value is an object with a string text property.
@@ -4223,6 +4282,25 @@ export declare interface MedicationOrderDrugInput {
     readonly ndc?: string;
     readonly rxNorm?: string;
     readonly routedMedId?: number;
+    /**
+     * Vendor formulation key, paired with {@link 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
+     * 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). */
+    readonly drugName?: string;
+    /**
+     * Dose text for a {@link 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
+     * 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.
+     */
+    readonly line1?: string;
     readonly quantity: number;
     readonly quantityQualifier?: string;
     readonly refill?: number;
@@ -4378,6 +4456,13 @@ export declare interface MedicationSearchParams {
     readonly ndc?: string;
     readonly rxNorm?: string;
     readonly routedMedId?: number;
+    /**
+     * Vendor formulation keys under {@link 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.
+     */
+    readonly gcnSeqnos?: number[];
     readonly searchOtc?: boolean;
     readonly searchSupply?: boolean;
     readonly searchBrand?: boolean;
@@ -8322,6 +8407,23 @@ export declare class ParserBuilder {
      use?: Identifier['use'];
  }
 
+ /**
+  * 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
+  * sub-extension's url is replaced, and the SchedulingParameters extension is created if the Schedule has
+  * none for the service yet.
+  *
+  * Untyped by design, taking any sub-extension of the shape the parameter calls for, for example
+  * `{ url: 'bufferBefore', valueDuration: { value: 10, unit: 'min' } }`. A parameter whose value is a nested
+  * structure rather than a single `value[x]` is worth a typed wrapper over this; `availability` has one in
+  * `@medplum/react-scheduling`. Pairs with `clearScheduleParameter` and `getScheduleParameters`.
+  * @param schedule - Schedule to update
+  * @param service - HealthcareService referenced by the parameters
+  * @param subextension - SchedulingParameters sub-extension to set
+  * @returns A cloned Schedule containing the parameter
+  */
+ export declare function setScheduleParameter(schedule: Schedule, service: WithId<HealthcareService>, subextension: Extension): Schedule;
+
  export declare function singleton(collection: TypedValue[], type?: string): TypedValue | undefined;
 
  export declare function singularize<T>(value: T | T[] | undefined): T | undefined;