@medplum/core 5.1.37 → 5.1.38

package/dist/cjs/index.d.ts

@@ -1364,6 +1364,20 @@ export declare const DEFAULT_MAX_SEARCH_COUNT = 1000;
 
 export declare const DEFAULT_SEARCH_COUNT = 20;
 
+/**
+ * Given a type `Reference<X>`, extracts `X`
+ *
+ * The input is constrained to references, so passing anything else is a compile error
+ * rather than a silently unhelpful type. `null` and `undefined` are allowed and pass
+ * through, so an optional reference field dereferences to an optional resource.
+ *
+ * The check is structural, though: this accepts anything assignable to `Reference`, an
+ * interface whose fields are all optional. Object types that are not true references are
+ * therefore accepted, and with no `resource` property to infer from, resolve to
+ * `Resource`, the default type argument of `Reference`.
+ */
+export declare type Dereference<T extends Reference | null | undefined> = T extends Reference<infer R> ? R : T;
+
 /**
  * Derives an "identifier" search parameter from a reference search parameter.
  *
@@ -2707,6 +2721,14 @@ export declare function getResourceTypes(): ResourceType[];
  */
 export declare function getScheduleParameters(schedule: Schedule, service: WithId<HealthcareService>, url: string): Extension[];
 
+/**
+ * Returns what a visit type must be given before it can be booked, from its
+ * `HealthcareService.eligibility` codes.
+ * @param service - The visit type being booked, if one has been chosen yet.
+ * @returns The requirements it names, empty until a visit type is chosen or when it names none.
+ */
+export declare function getSchedulingRequirements(service: HealthcareService | undefined): Set<SchedulingRequirement>;
+
 /**
  * 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.
@@ -3765,6 +3787,13 @@ export declare function isResourceTypeSchema(typeSchema: InternalTypeSchema): bo
 
 export declare function isResourceWithId<T extends Resource>(resource: unknown, resourceType?: T['resourceType']): resource is WithId<T>;
 
+/**
+ * Returns whether a code names a scheduling requirement.
+ * @param value - The `Coding.code` to test, which a resource need not carry.
+ * @returns True when it is one of the requirements a booking honours.
+ */
+export declare function isSchedulingRequirement(value: string | undefined): value is SchedulingRequirement;
+
 export declare function isSliceDefinitionWithTypes(slice: SliceDefinition): slice is SliceDefinitionWithTypes;
 
 /**
@@ -8239,6 +8268,15 @@ export declare class ParserBuilder {
      expandProfile?: boolean;
  }
 
+ /** The eligibility code marking a visit type that cannot be booked without diagnosis codes. */
+ export declare const REQUIRES_DIAGNOSIS_CODE = "requires-diagnosis";
+
+ /** The eligibility code marking a visit type that cannot be booked without confirming medical necessity. */
+ export declare const REQUIRES_MEDICAL_NECESSITY_CODE = "requires-medical-necessity";
+
+ /** The eligibility code marking a visit type that cannot be booked without procedure codes. */
+ export declare const REQUIRES_PROCEDURE_CODE = "requires-procedure";
+
  /**
   * Returns the ID portion of a reference.
   * @param input - A FHIR reference or resource.
@@ -8319,6 +8357,12 @@ export declare class ParserBuilder {
   */
  export declare function satisfiedAccessPolicy(resource: Resource, interaction: AccessPolicyInteraction, accessPolicy: AccessPolicy | undefined): AccessPolicyResource | undefined;
 
+ /** Code system for scheduling requirements, recorded on `HealthcareService.eligibility.code`. */
+ export declare const SCHEDULING_ELIGIBILITY_SYSTEM = "https://medplum.com/fhir/CodeSystem/scheduling-eligibility";
+
+ /** Every eligibility code naming something a booking must carry. */
+ export declare const SCHEDULING_REQUIREMENT_CODES: readonly ["requires-procedure", "requires-diagnosis", "requires-medical-necessity"];
+
  /**
   * Converts a SchedulingParameters duration to minutes.
   *
@@ -8330,12 +8374,27 @@ export declare class ParserBuilder {
 
  export declare const SchedulingEncounterCodingURI = "https://medplum.com/fhir/StructureDefinition/SchedulingEncounterCoding";
 
+ /** Extension on an Appointment recording that medical necessity was confirmed when it was booked. */
+ export declare const SchedulingMedicalNecessityURI = "https://medplum.com/fhir/StructureDefinition/SchedulingMedicalNecessity";
+
  export declare const SchedulingParametersURI = "https://medplum.com/fhir/StructureDefinition/SchedulingParameters";
 
  export declare const SchedulingPlanDefinitionURI = "https://medplum.com/fhir/StructureDefinition/SchedulingPlanDefinition";
 
+ export declare type SchedulingRequirement = (typeof SCHEDULING_REQUIREMENT_CODES)[number];
+
  export declare const SchedulingScheduleColorURI = "https://medplum.com/fhir/StructureDefinition/SchedulingColor";
 
+ /**
+  * This extension is set on `Slot` resources created through scheduling APIs.
+  * Its value is a positive integer recording the slotCapacity for the service
+  * and schedule at the time the booking was created. Omitted when the
+  * slotCapacity is `1`.
+  *
+  * @see https://www.medplum.com/docs/scheduling/defining-availability#overbooking
+  */
+ export declare const SchedulingSlotCapacityURI = "https://medplum.com/fhir/StructureDefinition/SchedulingSlotCapacity";
+
  export declare interface SearchableToken {
      readonly system: string | undefined;
      readonly value: string | undefined;

package/dist/esm/index.d.ts

@@ -1364,6 +1364,20 @@ export declare const DEFAULT_MAX_SEARCH_COUNT = 1000;
 
 export declare const DEFAULT_SEARCH_COUNT = 20;
 
+/**
+ * Given a type `Reference<X>`, extracts `X`
+ *
+ * The input is constrained to references, so passing anything else is a compile error
+ * rather than a silently unhelpful type. `null` and `undefined` are allowed and pass
+ * through, so an optional reference field dereferences to an optional resource.
+ *
+ * The check is structural, though: this accepts anything assignable to `Reference`, an
+ * interface whose fields are all optional. Object types that are not true references are
+ * therefore accepted, and with no `resource` property to infer from, resolve to
+ * `Resource`, the default type argument of `Reference`.
+ */
+export declare type Dereference<T extends Reference | null | undefined> = T extends Reference<infer R> ? R : T;
+
 /**
  * Derives an "identifier" search parameter from a reference search parameter.
  *
@@ -2707,6 +2721,14 @@ export declare function getResourceTypes(): ResourceType[];
  */
 export declare function getScheduleParameters(schedule: Schedule, service: WithId<HealthcareService>, url: string): Extension[];
 
+/**
+ * Returns what a visit type must be given before it can be booked, from its
+ * `HealthcareService.eligibility` codes.
+ * @param service - The visit type being booked, if one has been chosen yet.
+ * @returns The requirements it names, empty until a visit type is chosen or when it names none.
+ */
+export declare function getSchedulingRequirements(service: HealthcareService | undefined): Set<SchedulingRequirement>;
+
 /**
  * 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.
@@ -3765,6 +3787,13 @@ export declare function isResourceTypeSchema(typeSchema: InternalTypeSchema): bo
 
 export declare function isResourceWithId<T extends Resource>(resource: unknown, resourceType?: T['resourceType']): resource is WithId<T>;
 
+/**
+ * Returns whether a code names a scheduling requirement.
+ * @param value - The `Coding.code` to test, which a resource need not carry.
+ * @returns True when it is one of the requirements a booking honours.
+ */
+export declare function isSchedulingRequirement(value: string | undefined): value is SchedulingRequirement;
+
 export declare function isSliceDefinitionWithTypes(slice: SliceDefinition): slice is SliceDefinitionWithTypes;
 
 /**
@@ -8239,6 +8268,15 @@ export declare class ParserBuilder {
      expandProfile?: boolean;
  }
 
+ /** The eligibility code marking a visit type that cannot be booked without diagnosis codes. */
+ export declare const REQUIRES_DIAGNOSIS_CODE = "requires-diagnosis";
+
+ /** The eligibility code marking a visit type that cannot be booked without confirming medical necessity. */
+ export declare const REQUIRES_MEDICAL_NECESSITY_CODE = "requires-medical-necessity";
+
+ /** The eligibility code marking a visit type that cannot be booked without procedure codes. */
+ export declare const REQUIRES_PROCEDURE_CODE = "requires-procedure";
+
  /**
   * Returns the ID portion of a reference.
   * @param input - A FHIR reference or resource.
@@ -8319,6 +8357,12 @@ export declare class ParserBuilder {
   */
  export declare function satisfiedAccessPolicy(resource: Resource, interaction: AccessPolicyInteraction, accessPolicy: AccessPolicy | undefined): AccessPolicyResource | undefined;
 
+ /** Code system for scheduling requirements, recorded on `HealthcareService.eligibility.code`. */
+ export declare const SCHEDULING_ELIGIBILITY_SYSTEM = "https://medplum.com/fhir/CodeSystem/scheduling-eligibility";
+
+ /** Every eligibility code naming something a booking must carry. */
+ export declare const SCHEDULING_REQUIREMENT_CODES: readonly ["requires-procedure", "requires-diagnosis", "requires-medical-necessity"];
+
  /**
   * Converts a SchedulingParameters duration to minutes.
   *
@@ -8330,12 +8374,27 @@ export declare class ParserBuilder {
 
  export declare const SchedulingEncounterCodingURI = "https://medplum.com/fhir/StructureDefinition/SchedulingEncounterCoding";
 
+ /** Extension on an Appointment recording that medical necessity was confirmed when it was booked. */
+ export declare const SchedulingMedicalNecessityURI = "https://medplum.com/fhir/StructureDefinition/SchedulingMedicalNecessity";
+
  export declare const SchedulingParametersURI = "https://medplum.com/fhir/StructureDefinition/SchedulingParameters";
 
  export declare const SchedulingPlanDefinitionURI = "https://medplum.com/fhir/StructureDefinition/SchedulingPlanDefinition";
 
+ export declare type SchedulingRequirement = (typeof SCHEDULING_REQUIREMENT_CODES)[number];
+
  export declare const SchedulingScheduleColorURI = "https://medplum.com/fhir/StructureDefinition/SchedulingColor";
 
+ /**
+  * This extension is set on `Slot` resources created through scheduling APIs.
+  * Its value is a positive integer recording the slotCapacity for the service
+  * and schedule at the time the booking was created. Omitted when the
+  * slotCapacity is `1`.
+  *
+  * @see https://www.medplum.com/docs/scheduling/defining-availability#overbooking
+  */
+ export declare const SchedulingSlotCapacityURI = "https://medplum.com/fhir/StructureDefinition/SchedulingSlotCapacity";
+
  export declare interface SearchableToken {
      readonly system: string | undefined;
      readonly value: string | undefined;