@medplum/core 5.1.27 → 5.1.29

package/dist/cjs/index.d.ts

@@ -22,6 +22,7 @@ import type { Encounter } from '@medplum/fhirtypes';
 import type { Extension } from '@medplum/fhirtypes';
 import type { ExtensionValue } from '@medplum/fhirtypes';
 import type { ExtractResource } from '@medplum/fhirtypes';
+import type { HealthcareService } from '@medplum/fhirtypes';
 import type { HumanName } from '@medplum/fhirtypes';
 import type { Identifier } from '@medplum/fhirtypes';
 import type { ImagingStudy } from '@medplum/fhirtypes';
@@ -56,6 +57,7 @@ import type { RelatedPerson } from '@medplum/fhirtypes';
 import type { Resource } from '@medplum/fhirtypes';
 import type { ResourceType } from '@medplum/fhirtypes';
 import type { SampledData } from '@medplum/fhirtypes';
+import type { Schedule } from '@medplum/fhirtypes';
 import type { SearchParameter } from '@medplum/fhirtypes';
 import type { StructureDefinition } from '@medplum/fhirtypes';
 import type { StructureMap } from '@medplum/fhirtypes';
@@ -431,6 +433,24 @@ export { assert_2 as assert }
 
 export declare function assertContextVersionOptional(event: string): asserts event is FhircastEventVersionOptional;
 
+/**
+ * Checks that a value has type `never`. Useful for ensuring exhaustive
+ * matches.
+ *
+ * @example
+ * ```typescript
+ *   type MyUnion = 'a' | 'b' | 'c'
+ *   function f(arg: MyUnion) {
+ *     if (arg === 'a') { return 1; }
+ *     if (arg === 'b') { return 2; }
+ *     assertNever(arg); // Type error: 'c' is unhandled
+ *   }
+ * ```
+ *
+ * @param value - The value that should never be present
+ */
+export declare function assertNever(value: never): never;
+
 /**
  * Asserts that the operation completed successfully and that the resource is defined.
  * @param outcome - The operation outcome.
@@ -811,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
@@ -954,6 +985,7 @@ export declare function contentTooLarge(text: string): OperationOutcome;
 export declare const ContentType: {
     readonly CSS: "text/css";
     readonly DICOM: "application/dicom";
+    readonly DICOM_JSON: "application/dicom+json";
     readonly EVENT_STREAM: "text/event-stream";
     readonly FAVICON: "image/vnd.microsoft.icon";
     readonly FHIR_JSON: "application/fhir+json";
@@ -1254,6 +1286,10 @@ export declare type DataTypesMap = {
     [type: string]: InternalTypeSchema;
 };
 
+export declare type DayOfWeek = (typeof DAYS_OF_WEEK)[number];
+
+export declare const DAYS_OF_WEEK: readonly ["mon", "tue", "wed", "thu", "fri", "sat", "sun"];
+
 /**
  * Decodes a base64 string.
  * Handles both browser and Node environments.
@@ -1607,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;
@@ -1630,6 +1675,13 @@ export declare const ExternalSecretSystems: {
  */
 export declare function extractAccountReferences(meta: Meta | undefined): Reference[] | undefined;
 
+/**
+ * Extracts HealthcareService references from serviceType concepts.
+ * @param serviceType - CodeableConcept values to inspect
+ * @returns HealthcareService references embedded in the concepts
+ */
+export declare function extractServiceTypeReferences(serviceType: CodeableConcept[] | undefined): Reference<HealthcareService>[];
+
 /**
  * Fetches the version strings for all published Medplum releases.
  * @param appName - The name of the app to fetch the release list for.
@@ -2434,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.
@@ -2576,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.
@@ -2686,6 +2774,16 @@ export declare interface GoogleLoginRequest extends BaseLoginRequest {
     readonly createUser?: boolean;
 }
 
+/**
+ * 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
+ */
+export declare function hasSchedulingParameters(resource: Schedule | HealthcareService): boolean;
+
 export declare interface Hl7AckOptions {
     ackCode: AckCode;
     errSegment?: Hl7Segment;
@@ -3397,6 +3495,8 @@ export declare function isDateString(input: unknown): input is string;
  */
 export declare function isDateTimeString(input: unknown): input is string;
 
+export declare function isDayOfWeek(value: string | undefined): value is DayOfWeek;
+
 /**
  * Helper function to narrow a type by excluding undefined/null values.
  * @param value - The value to refine
@@ -3627,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.
@@ -4182,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;
@@ -4337,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;
@@ -7318,6 +7444,16 @@ export declare function parametersToOrderSetSyncResponse(params: Parameters_2):
  */
 export declare function parseFhirPath(input: string): FhirPathAtom;
 
+/**
+ * Parses a FHIRPath Patch `Parameters` resource into the array of operations consumed by
+ * {@link fhirpathPatchTypedValue}. Each repeating `operation` parameter is decoded from its
+ * `part` entries (`type`, `path`, `name`, `value`, `index`, `source`, `destination`), where
+ * the polymorphic `value[x]` part becomes a {@link TypedValue}.
+ * @param parameters - The FHIRPath Patch Parameters resource.
+ * @returns The parsed FHIRPath Patch operations.
+ */
+export declare function parseFhirPathPatchParameters(parameters: Parameters_2): FhirPathPatch[];
+
 /**
  * Parses a FHIR _filter parameter expression into an AST.
  * @param input - The FHIR _filter parameter expression.
@@ -8114,6 +8250,12 @@ export declare class ParserBuilder {
   */
  export declare function satisfiedAccessPolicy(resource: Resource, interaction: AccessPolicyInteraction, accessPolicy: AccessPolicy | undefined): AccessPolicyResource | undefined;
 
+ export declare const SchedulingEncounterCodingURI = "https://medplum.com/fhir/StructureDefinition/SchedulingEncounterCoding";
+
+ export declare const SchedulingParametersURI = "https://medplum.com/fhir/StructureDefinition/SchedulingParameters";
+
+ export declare const SchedulingPlanDefinitionURI = "https://medplum.com/fhir/StructureDefinition/SchedulingPlanDefinition";
+
  export declare interface SearchableToken {
      readonly system: string | undefined;
      readonly value: string | undefined;
@@ -8196,6 +8338,42 @@ export declare class ParserBuilder {
 
  export declare function serverTimeout(msg?: string): OperationOutcome;
 
+ /**
+  * Returns whether any serviceType concept refers to the given HealthcareService.
+  * @param serviceType - CodeableConcept values to inspect
+  * @param service - HealthcareService or reference to match
+  * @returns True if any concept references the service
+  */
+ export declare function serviceTypeIncludesService(serviceType: CodeableConcept[] | undefined, service: WithId<HealthcareService> | (Reference<HealthcareService> & {
+     reference: string;
+ })): boolean;
+
+ /**
+  * Extension URI holding a `Reference<HealthcareService>` on a `serviceType` CodeableConcept.
+  *
+  * In R5/R6, `serviceType` attributes change from `CodeableConcept[]` to
+  * `CodeableReference<HealthcareService>`. We approximate that in R4 with this extension.
+  *
+  * Example: a Schedule whose serviceType refers to a HealthcareService:
+  * ```json
+  * {
+  *   "resourceType": "Schedule",
+  *   "actor": [{ "reference": "Practitioner/abc" }],
+  *   "serviceType": [
+  *     {
+  *       "extension": [
+  *         {
+  *           "url": "https://medplum.com/fhir/service-type-reference",
+  *           "valueReference": { "reference": "HealthcareService/123" }
+  *         }
+  *       ]
+  *     }
+  *   ]
+  * }
+  * ```
+  */
+ export declare const ServiceTypeReferenceURI = "https://medplum.com/fhir/service-type-reference";
+
  /**
   * Sets a code for a given system within a given codeable concept.
   * @param concept - The codeable concept.
@@ -8229,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;
@@ -8585,6 +8780,8 @@ export declare class ParserBuilder {
      value: any;
  }
 
+ export declare const TimezoneExtensionURI = "http://hl7.org/fhir/StructureDefinition/timezone";
+
  /**
   * Converts unknown object into a JavaScript boolean.
   * Note that this is different than the FHIRPath "toBoolean",
@@ -8621,6 +8818,19 @@ export declare class ParserBuilder {
      private consumeQuotedSymbol;
      private consumeDateTime;
      private consumeNumber;
+     /**
+      * Consumes an unquoted string value that begins with digits, such as a UUID in a `_filter`
+      * expression, starting over from the beginning of the value.
+      *
+      * The value ends at the first character that cannot be part of a token, per `symbolRegex`. For the
+      * `_filter` tokenizer that is whitespace, ")", and "]", so a value at the end of a nested
+      * expression such as "(_id eq 12345678-1234-4123-8123-123456789abc)" does not swallow the closing
+      * parenthesis.
+      *
+      * @param start - The index of the first character of the value.
+      * @returns The string token.
+      */
+     private consumeUnquotedString;
      private consumeSymbol;
      private consumeOperator;
      private consumeWhile;
@@ -8661,6 +8871,15 @@ export declare class ParserBuilder {
   */
  export declare function toPeriod(input: unknown): Period | undefined;
 
+ /**
+  * Converts a HealthcareService into the CodeableConcept values used by
+  * `Schedule.serviceType` and `Appointment.serviceType`, which encode an R4
+  * approximation of `CodeableReference<HealthcareService>`.
+  * @param service - HealthcareService to represent
+  * @returns CodeableConcept values containing a reference to the service
+  */
+ export declare function toServiceTypeCodeableConcepts(service: WithId<HealthcareService>): CodeableConcept[];
+
  /**
   * Returns a "best guess" TypedValue for a given value.
   * @param value - The unknown value to check.