@medplum/core 5.1.27 → 5.1.28

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.
@@ -954,6 +974,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 +1275,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.
@@ -1630,6 +1655,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.
@@ -2686,6 +2718,13 @@ export declare interface GoogleLoginRequest extends BaseLoginRequest {
     readonly createUser?: boolean;
 }
 
+/**
+ * Returns whether a Schedule or HealthcareService has a SchedulingParameters extension.
+ * @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 +3436,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
@@ -7318,6 +7359,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 +8165,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 +8253,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.
@@ -8585,6 +8678,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 +8716,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 +8769,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.

package/dist/esm/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.
@@ -954,6 +974,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 +1275,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.
@@ -1630,6 +1655,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.
@@ -2686,6 +2718,13 @@ export declare interface GoogleLoginRequest extends BaseLoginRequest {
     readonly createUser?: boolean;
 }
 
+/**
+ * Returns whether a Schedule or HealthcareService has a SchedulingParameters extension.
+ * @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 +3436,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
@@ -7318,6 +7359,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 +8165,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 +8253,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.
@@ -8585,6 +8678,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 +8716,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 +8769,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.