@icanbwell/bwell-sdk-ts 2.0.0-alpha.0-rc.1754330797 → 2.0.0-alpha.0-rc.1754488327

package/dist/api/base/health-data/health-data-request.js

@@ -83,6 +83,9 @@ export class BinaryRequestValidator extends PagedRequestValidator {
 }
 /**
  * Base request object for fetching health data.
+ * @category Requests
+ * @title HealthDataRequest
+ * @excerpt Base request object for fetching health data
  */
 export class HealthDataRequest extends PagedRequest {
     constructor() {
@@ -92,96 +95,153 @@ export class HealthDataRequest extends PagedRequest {
 }
 /**
  * Request object for fetching allergy intolerance data.
+ * @category Requests
+ * @title AllergyIntolerancesRequest
+ * @excerpt Request object for fetching allergy intolerance data
  */
 export class AllergyIntolerancesRequest extends HealthDataRequest {
 }
 /**
  * Request object for fetching allergy intolerance group data.
+ * @category Requests
+ * @title AllergyIntoleranceGroupsRequest
+ * @excerpt Request object for fetching allergy intolerance group data
  */
 export class AllergyIntoleranceGroupsRequest extends PagedRequest {
 }
 /**
  * Request object for fetching conditions data.
+ * @category Requests
+ * @title ConditionsRequest
+ * @excerpt Request object for fetching conditions data
  */
 export class ConditionsRequest extends HealthDataRequest {
 }
 /**
  * Request object for fetching condition groups data.
+ * @category Requests
+ * @title ConditionGroupsRequest
+ * @excerpt Request object for fetching condition groups data
  */
 export class ConditionGroupsRequest extends PagedRequest {
 }
 /**
  * Request object for fetching document references data.
+ * @category Requests
+ * @title DocumentReferencesRequest
+ * @excerpt Request object for fetching document references data
  */
 export class DocumentReferencesRequest extends HealthDataRequest {
 }
 /**
  * Request object for fetching labs data.
+ * @category Requests
+ * @title LabsRequest
+ * @excerpt Request object for fetching labs data
  */
 export class LabsRequest extends HealthDataRequest {
 }
 /**
  * Request object for fetching lab groups data.
+ * @category Requests
+ * @title LabGroupsRequest
+ * @excerpt Request object for fetching lab groups data
  */
 export class LabGroupsRequest extends PagedRequest {
 }
 /**
  * Request object for fetching care plan data.
+ * @category Requests
+ * @title CarePlansRequest
+ * @excerpt Request object for fetching care plan data
  */
 export class CarePlansRequest extends HealthDataRequest {
 }
 /**
  * Request object for fetching care team data.
+ * @category Requests
+ * @title CareTeamsRequest
+ * @excerpt Request object for fetching care team data
  */
 export class CareTeamsRequest extends PagedRequest {
 }
 /**
  * Request object for fetching care plan groups data.
+ * @category Requests
+ * @title CarePlanGroupsRequest
+ * @excerpt Request object for fetching care plan groups data
  */
 export class CarePlanGroupsRequest extends PagedRequest {
 }
 /**
  * Request object for fetching encounters data.
+ * @category Requests
+ * @title EncountersRequest
+ * @excerpt Request object for fetching encounters data
  */
 export class EncountersRequest extends HealthDataRequest {
 }
 /**
  * Request object for fetching encounter groups data.
+ * @category Requests
+ * @title EncounterGroupsRequest
+ * @excerpt Request object for fetching encounter groups data
  */
 export class EncounterGroupsRequest extends PagedRequest {
 }
 /**
  * Request object for fetching immunization data.
+ * @category Requests
+ * @title ImmunizationsRequest
+ * @excerpt Request object for fetching immunization data
  */
 export class ImmunizationsRequest extends HealthDataRequest {
 }
 /**
  * Request object for fetching immunization groups data.
+ * @category Requests
+ * @title ImmunizationGroupsRequest
+ * @excerpt Request object for fetching immunization groups data
  */
 export class ImmunizationGroupsRequest extends PagedRequest {
 }
 /**
  * Request object for fetching procedure data.
+ * @category Requests
+ * @title ProceduresRequest
+ * @excerpt Request object for fetching procedure data
  */
 export class ProceduresRequest extends HealthDataRequest {
 }
 /**
  * Request object for fetching procedure groups data.
+ * @category Requests
+ * @title ProcedureGroupsRequest
+ * @excerpt Request object for fetching procedure groups data
  */
 export class ProcedureGroupsRequest extends PagedRequest {
 }
 /**
  * Request object for fetching vital signs data.
+ * @category Requests
+ * @title VitalSignsRequest
+ * @excerpt Request object for fetching vital signs data
  */
 export class VitalSignsRequest extends HealthDataRequest {
 }
 /**
  * Request object for fetching vital sign groups data.
+ * @category Requests
+ * @title VitalSignGroupsRequest
+ * @excerpt Request object for fetching vital sign groups data
  */
 export class VitalSignGroupsRequest extends PagedRequest {
 }
 /**
  * Request object for fetching DiagnosticReport Lab Groups
+ * @category Requests
+ * @title DiagnosticReportLabGroupsRequest
+ * @excerpt Request object for fetching DiagnosticReport Lab Groups
  */
 export class DiagnosticReportLabGroupsRequest extends PagedRequest {
 }
@@ -205,6 +265,9 @@ export class MedicationRequestRequestValidator extends MedicationDispenseRequest
 _MedicationRequestRequestValidator_medicationCodeValidator = new WeakMap();
 /**
  * Request object for fetching medication dispense data.
+ * @category Requests
+ * @title MedicationDispenseRequest
+ * @excerpt Request object for fetching medication dispense data
  */
 export class MedicationDispenseRequest extends PagedRequest {
     constructor() {
@@ -214,6 +277,9 @@ export class MedicationDispenseRequest extends PagedRequest {
 }
 /**
  * Request object for fetching medication request data.
+ * @category Requests
+ * @title MedicationRequestRequest
+ * @excerpt Request object for fetching medication request data
  */
 export class MedicationRequestRequest extends PagedRequest {
     constructor() {
@@ -242,6 +308,9 @@ export class MedicationStatementRequestValidator extends HealthDataRequestValida
 _MedicationStatementRequestValidator_medicationCodeValidator = new WeakMap();
 /**
  * Request object for fetching medication statement data.
+ * @category Requests
+ * @title MedicationStatementsRequest
+ * @excerpt Request object for fetching medication statement data
  */
 export class MedicationStatementsRequest extends HealthDataRequest {
     constructor() {
@@ -251,11 +320,17 @@ export class MedicationStatementsRequest extends HealthDataRequest {
 }
 /**
  * Request object for fetching medication groups data.
+ * @category Requests
+ * @title MedicationGroupsRequest
+ * @excerpt Request object for fetching medication groups data
  */
 export class MedicationGroupsRequest extends PagedRequest {
 }
 /**
  * Request object for fetching Binary data.
+ * @category Requests
+ * @title BinaryRequest
+ * @excerpt Request object for fetching Binary data
  */
 export class BinaryRequest extends PagedRequest {
     constructor() {
@@ -263,5 +338,11 @@ export class BinaryRequest extends PagedRequest {
         this.validator = new BinaryRequestValidator();
     }
 }
+/**
+ * Request object for fetching diagnostic reports data.
+ * @category Requests
+ * @title DiagnosticReportsRequest
+ * @excerpt Request object for fetching diagnostic reports data
+ */
 export class DiagnosticReportsRequest extends HealthDataRequest {
 }

package/dist/api/base/health-data/health-manager.d.ts

@@ -1,132 +1,172 @@
-import type { GetAllergyIntoleranceGroupsQueryResults, GetAllergyIntolerancesQueryResults, GetCarePlanGroupsQueryResults, GetConditionGroupsQueryResults, GetDiagnosticReportLabGroupsQueryResults, GetEncountersGroupQueryResults, GetHealthSummaryQueryResults, GetImmunizationGroupsQueryResults, GetLabGroupsQueryResults, GetMedicationGroupsQueryResults, GetProcedureGroupsQueryResults, GetVitalSignGroupsQueryResults } from "../../../graphql/operations/types.js";
+import type { AllergyIntoleranceBundle, AllergyIntoleranceGroupBundle, CarePlanGroupBundle, ConditionGroupBundle, DiagnosticReportLabGroupBundle, EncounterGroupBundle, HealthSummary, ImmunizationGroupBundle, LabGroupBundle, MedicationGroupBundle, ProcedureGroupBundle, VitalSignGroupBundle } from "../../../models/health-data/index.js";
 import type { BWellQueryResult } from "../../../results/index.js";
 import type { BaseManagerError } from "../errors.js";
 import type { AllergyIntoleranceGroupsRequest, CarePlanGroupsRequest, ConditionGroupsRequest, DiagnosticReportLabGroupsRequest, EncounterGroupsRequest, HealthDataRequest, ImmunizationGroupsRequest, LabGroupsRequest, MedicationGroupsRequest, ProcedureGroupsRequest, VitalSignGroupsRequest } from "./health-data-request.js";
-type HealthSummaryResultsType = GetHealthSummaryQueryResults["getHealthSummary"];
-export interface HealthSummaryResults extends HealthSummaryResultsType {
-}
-export type AllergyIntolerancesResults = GetAllergyIntolerancesQueryResults["allergyIntolerances"];
-type AllergyIntolerancesGroupsResultsType = GetAllergyIntoleranceGroupsQueryResults["getAllergyIntoleranceGroups"];
-export interface AllergyIntolerancesGroupsResults extends AllergyIntolerancesGroupsResultsType {
-}
-type ConditionGroupsResultsType = GetConditionGroupsQueryResults["getConditionGroups"];
-export interface ConditionGroupsResults extends ConditionGroupsResultsType {
-}
-type LabGroupsResultsType = GetLabGroupsQueryResults["getLabGroups"];
-export interface LabGroupsResults extends LabGroupsResultsType {
-}
-type CarePlanGroupsResultsType = GetCarePlanGroupsQueryResults["getCarePlanGroups"];
-export interface CarePlanGroupsResults extends CarePlanGroupsResultsType {
-}
-type EncounterGroupsResultsType = GetEncountersGroupQueryResults["getEncounterGroups"];
-export interface EncounterGroupsResults extends EncounterGroupsResultsType {
-}
-type ImmunizationGroupsResultsType = GetImmunizationGroupsQueryResults["getImmunizationGroups"];
-export interface ImmunizationGroupsResults extends ImmunizationGroupsResultsType {
-}
-type ProcedureGroupsResultsType = GetProcedureGroupsQueryResults["getProcedureGroups"];
-export interface ProcedureGroupsResults extends ProcedureGroupsResultsType {
-}
-type VitalSignGroupsResultsType = GetVitalSignGroupsQueryResults["getVitalSignGroups"];
-export interface VitalSignGroupsResults extends VitalSignGroupsResultsType {
-}
-type DiagnosticReportLabGroupsResultsType = GetDiagnosticReportLabGroupsQueryResults["getDiagnosticReportLabGroups"];
-export interface DiagnosticReportLabGroupsResults extends DiagnosticReportLabGroupsResultsType {
-}
-type MedicationGroupsResultsType = GetMedicationGroupsQueryResults["getMedicationGroups"];
-export interface MedicationGroupsResults extends MedicationGroupsResultsType {
-}
 /**
- * The HealthManager interface provides methods for retrieving health care records.
+ * Health Manager for patient health records and clinical data access.
+ * Provides methods for retrieving health care records including conditions, medications,
+ * labs, procedures, and other clinical data organized by groups.
+ * @see https://build.fhir.org/patient.html
+ * @title HealthManager
+ * @excerpt Health Manager for patient health records and clinical data access
+ * @category Managers
  */
 export interface HealthManager {
     /**
      * Retrieve a summary view of current health care records by category. This view includes counts for AllergyIntolerance, CarePlan, Condition, Encounter, Immunization, Procedure, Vital Sign, Medication Statement, and Lab resources.
      *
-     * @returns {Promise<BWellQueryResult<HealthSummaryResults>>} A promise resolving to An object which based off of generated ResourceGroups representing an aggregation of AllergyIntolerance, CarePlan, Condition, Encounter, Immunization, Procedure, MedicationStatement, Observation (Vital Sign and Lab) resources.
+     * @returns {Promise<BWellQueryResult<HealthSummary>>} A promise resolving to An object which based off of generated ResourceGroups representing an aggregation of AllergyIntolerance, CarePlan, Condition, Encounter, Immunization, Procedure, MedicationStatement, Observation (Vital Sign and Lab) resources.
+     */
+    getHealthSummary(): Promise<BWellQueryResult<HealthSummary, BaseManagerError>>;
+    /**
+     * Retrieves a list of allergy intolerance resources.
+     * Gets individual allergy intolerance records for the authenticated user.
+     *
+     * @param {HealthDataRequest} request An optional request class for specifying the search criteria.
+     *
+     * @returns {Promise<BWellQueryResult<AllergyIntoleranceBundle>>} A promise resolving to an object representing the list of allergy intolerances retrieved.
+     *
+     * @example
+     * ```typescript
+     * const allergies = await sdk.health.getAllergyIntolerances();
+     * ```
      */
-    getHealthSummary(): Promise<BWellQueryResult<HealthSummaryResults, BaseManagerError>>;
-    getAllergyIntolerances(request?: HealthDataRequest): Promise<BWellQueryResult<AllergyIntolerancesResults, BaseManagerError>>;
+    getAllergyIntolerances(request?: HealthDataRequest): Promise<BWellQueryResult<AllergyIntoleranceBundle, BaseManagerError>>;
     /**
      * Retrieves a list of AllergyIntoleranceGroup resources.
      * The method accepts a AllergyIntoleranceGroupsRequest object to specify the search criteria.
      *
      * @param {AllergyIntoleranceGroupsRequest} request An object specifying the search criteria for retrieving the AllergyIntoleranceGroup resources.
      *
-     * @returns {Promise<BWellQueryResult<AllergyIntolerancesGroupsResults>>} A promise resolving to an object representing the list of Allergy Intolerance Groups retrieved, along with potential validation or GraphQL errors.
+     * @returns {Promise<BWellQueryResult<AllergyIntoleranceGroupBundle>>} A promise resolving to an object representing the list of Allergy Intolerance Groups retrieved, along with potential validation or GraphQL errors.
+     *
+     * @example
+     * ```typescript
+     * const allergyGroups = await sdk.health.getAllergyIntoleranceGroups();
+     * ```
      */
-    getAllergyIntoleranceGroups(request?: AllergyIntoleranceGroupsRequest): Promise<BWellQueryResult<AllergyIntolerancesGroupsResults, BaseManagerError>>;
+    getAllergyIntoleranceGroups(request?: AllergyIntoleranceGroupsRequest): Promise<BWellQueryResult<AllergyIntoleranceGroupBundle, BaseManagerError>>;
     /**
      * Retrieves a list of condition groups resources.
      *
      * @param {ConditionGroupsRequest} request An optional request class for specifying the search criteria, for the retrieval of condition groups resources.
      *
-     * @returns {Promise<BWellQueryResult<ConditionGroupsResults>>} A promise resolving to an object representing he list of condition groups retrieved.
+     * @returns {Promise<BWellQueryResult<ConditionGroupBundle>>} A promise resolving to an object representing he list of condition groups retrieved.
+     *
+     * @example
+     * ```typescript
+     * const conditions = await sdk.health.getConditionGroups();
+     * ```
      */
-    getConditionGroups(request?: ConditionGroupsRequest): Promise<BWellQueryResult<ConditionGroupsResults>>;
+    getConditionGroups(request?: ConditionGroupsRequest): Promise<BWellQueryResult<ConditionGroupBundle, BaseManagerError>>;
     /**
-     * Retrieves a list of labratory groups results.
+     * Retrieves a list of laboratory groups results.
+     *
+     * @param {LabGroupsRequest} request An optional request class for specifying the search criteria, for accessing lab groups resources.
      *
-     * @param {LabGroupsRequest} request A simplified request class for accessing lab groups resources.
+     * @returns {Promise<BWellQueryResult<LabGroupBundle>>} A promise resolving to an object representing a list of laboratory groups, along with potential errors.
      *
-     * @returns {Promise<BWellQueryResult<LabGroupsResults>>} A promise resolving to an object representing a list of labratory groups, along with potential errors.
+     * @example
+     * ```typescript
+     * const labGroups = await sdk.health.getLabGroups();
+     * ```
      */
-    getLabGroups(request?: LabGroupsRequest): Promise<BWellQueryResult<LabGroupsResults, BaseManagerError>>;
+    getLabGroups(request?: LabGroupsRequest): Promise<BWellQueryResult<LabGroupBundle, BaseManagerError>>;
     /**
      * Retrieves a list of care plan groups resources.
      *
      * @param {CarePlanGroupsRequest} request An optional request class for specifying the search criteria, for the retrieval of care plan groups resources.
      *
-     * @returns {Promise<BWellQueryResult<CarePlanGroupsResults>>} A promise resolving to an object representing the list of care plan groups retrieved.
+     * @returns {Promise<BWellQueryResult<CarePlanGroupBundle>>} A promise resolving to an object representing the list of care plan groups retrieved.
+     *
+     * @example
+     * ```typescript
+     * const carePlanGroups = await sdk.health.getCarePlanGroups();
+     * ```
      */
-    getCarePlanGroups(request?: CarePlanGroupsRequest): Promise<BWellQueryResult<CarePlanGroupsResults>>;
+    getCarePlanGroups(request?: CarePlanGroupsRequest): Promise<BWellQueryResult<CarePlanGroupBundle, BaseManagerError>>;
     /**
      * Retrieves a list of encounter groups resources.
      *
      * @param {EncounterGroupsRequest} request An optional request class for specifying the search criteria, for the retrieval of encounter groups resources.
      *
-     * @returns {Promise<BWellQueryResult<EncounterGroupsResults>>} A promise resolving to an object representing the list of encounter groups retrieved.
+     * @returns {Promise<BWellQueryResult<EncounterGroupBundle>>} A promise resolving to an object representing the list of encounter groups retrieved.
+     *
+     * @example
+     * ```typescript
+     * const encounterGroups = await sdk.health.getEncounterGroups();
+     * ```
      */
-    getEncounterGroups(request?: EncounterGroupsRequest): Promise<BWellQueryResult<EncounterGroupsResults>>;
+    getEncounterGroups(request?: EncounterGroupsRequest): Promise<BWellQueryResult<EncounterGroupBundle, BaseManagerError>>;
     /**
      * Retrieves a list of immunization groups resources.
      *
      * @param {ImmunizationGroupsRequest} request An optional request class for specifying the search criteria, for the retrieval of immunization groups resources.
      *
-     * @returns {Promise<BWellQueryResult<ImmunizationGroupsResults>>} A promise resolving to an object representing the list of immunization groups retrieved.
+     * @returns {Promise<BWellQueryResult<ImmunizationGroupBundle>>} A promise resolving to an object representing the list of immunization groups retrieved.
+     *
+     * @example
+     * ```typescript
+     * const immunizationGroups = await sdk.health.getImmunizationGroups();
+     * ```
      */
-    getImmunizationGroups(request?: ImmunizationGroupsRequest): Promise<BWellQueryResult<ImmunizationGroupsResults>>;
+    getImmunizationGroups(request?: ImmunizationGroupsRequest): Promise<BWellQueryResult<ImmunizationGroupBundle, BaseManagerError>>;
     /**
      * Retrieves a list of procedure groups resources.
      *
      * @param {ProcedureGroupsRequest} request An optional request class for specifying the search criteria, for the retrieval of procedure groups resources.
      *
-     * @returns {Promise<BWellQueryResult<ProcedureGroupsResults>>} A promise resolving to an object representing the list of procedure groups retrieved.
+     * @returns {Promise<BWellQueryResult<ProcedureGroupBundle>>} A promise resolving to an object representing the list of procedure groups retrieved.
+     *
+     * @example
+     * ```typescript
+     * const procedureGroups = await sdk.health.getProcedureGroups();
+     * ```
      */
-    getProcedureGroups(request?: ProcedureGroupsRequest): Promise<BWellQueryResult<ProcedureGroupsResults>>;
+    getProcedureGroups(request?: ProcedureGroupsRequest): Promise<BWellQueryResult<ProcedureGroupBundle, BaseManagerError>>;
     /**
      * Retrieves a list of vital sign groups resources.
      *
      * @param {VitalSignGroupsRequest} request An optional request class for specifying the search criteria, for the retrieval of vital sign groups resources.
      *
-     * @returns {Promise<BWellQueryResult<VitalSignGroupsResults>>} A promise resolving to an object representing the list of vital sign groups retrieved.
+     * @returns {Promise<BWellQueryResult<VitalSignGroupBundle>>} A promise resolving to an object representing the list of vital sign groups retrieved.
+     *
+     * @example
+     * ```typescript
+     * const vitalSignGroups = await sdk.health.getVitalSignGroups();
+     * ```
      */
-    getVitalSignGroups(request?: VitalSignGroupsRequest): Promise<BWellQueryResult<VitalSignGroupsResults>>;
+    getVitalSignGroups(request?: VitalSignGroupsRequest): Promise<BWellQueryResult<VitalSignGroupBundle, BaseManagerError>>;
     /**
      * Retrieves a list of medication groups resources.
      *
-     * @param {MedicationGroupsRequest} request An optional request class for specifying the search criteria, for the retrieval of medication groups resources.
+     * @param {MedicationGroupsRequest} request A request class for specifying the search criteria, for the retrieval of medication groups resources.
+     *
+     * @returns {Promise<BWellQueryResult<MedicationGroupBundle>>} A promise resolving to an object representing the list of medication groups retrieved.
      *
-     * @returns {Promise<BWellQueryResult<MedicationGroupsResults>>} A promise resolving to an object representing the list of medication groups retrieved.
+     * @example
+     * ```typescript
+     * const medications = await sdk.health.getMedicationGroups({
+     *   page: 1,
+     *   pageSize: 10
+     * });
+     * ```
      */
-    getMedicationGroups(request: MedicationGroupsRequest): Promise<BWellQueryResult<MedicationGroupsResults>>;
+    getMedicationGroups(request: MedicationGroupsRequest): Promise<BWellQueryResult<MedicationGroupBundle, BaseManagerError>>;
     /**
      * Retrieves a list of diagnostic report lab groups resources.
      *
-     * @param {DiagnosticReportLabGroupsRequest} request An optional request class for specifying the search criteria, for the retrieval of diagnostic report lab groups resources.
+     * @param {DiagnosticReportLabGroupsRequest} request A request class for specifying the search criteria, for the retrieval of diagnostic report lab groups resources.
+     *
+     * @returns {Promise<BWellQueryResult<DiagnosticReportLabGroupBundle>>} A promise resolving to an object representing the list of diagnostic report lab groups retrieved.
      *
-     * @returns {Promise<BWellQueryResult<DiagnosticReportLabGroupsResults>>} A promise resolving to an object representing the list of diagnostic report lab groups retrieved.
+     * @example
+     * ```typescript
+     * const diagnosticReportLabGroups = await sdk.health.getDiagnosticReportLabGroups({
+     *   page: 1,
+     *   pageSize: 10
+     * });
+     * ```
      */
-    getDiagnosticReportLabGroups(request: DiagnosticReportLabGroupsRequest): Promise<BWellQueryResult<DiagnosticReportLabGroupsResults>>;
+    getDiagnosticReportLabGroups(request: DiagnosticReportLabGroupsRequest): Promise<BWellQueryResult<DiagnosticReportLabGroupBundle, BaseManagerError>>;
 }
-export {};

package/dist/api/base/health-data/index.d.ts

@@ -2,4 +2,4 @@ export { HealthDataRequestInput, AllergyIntolerancesRequest, AllergyIntoleranceG
 export { MedicationPricingRequest, MedicationPricingRequestInput, } from "./medication-pricing-request.js";
 export { MedicationKnowledgeRequest, MedicationKnowledgeRequestInput, } from "./medication-knowledge-request.js";
 export { LabKnowledgeRequest, LabKnowledgeRequestInput, } from "./lab-knowledge-request.js";
-export { HealthSummaryResults, AllergyIntolerancesResults, AllergyIntolerancesGroupsResults, ConditionGroupsResults, LabGroupsResults, CarePlanGroupsResults, EncounterGroupsResults, ImmunizationGroupsResults, ProcedureGroupsResults, VitalSignGroupsResults, MedicationGroupsResults, HealthManager, DiagnosticReportLabGroupsResults, } from "./health-manager.js";
+export { HealthManager } from "./health-manager.js";

package/dist/api/base/health-data/lab-knowledge-request.d.ts

@@ -1,4 +1,10 @@
 import { ErrorsCollector, PagedRequest, PagedRequestInput, PagedRequestValidator } from "../../../requests/index.js";
+/**
+ * Input type for lab knowledge requests. Used to fetch knowledge about specific labs.
+ * @category Inputs
+ * @title LabKnowledgeRequestInput
+ * @excerpt Input for fetching lab knowledge by lab ID
+ */
 export type LabKnowledgeRequestInput = PagedRequestInput & {
     labId: string;
 };
@@ -15,6 +21,9 @@ export declare class LabKnowledgeRequestValidator extends PagedRequestValidator<
 }
 /**
  * Request object for fetching lab knowledge data.
+ * @category Requests
+ * @title LabKnowledgeRequest
+ * @excerpt Request object for fetching lab knowledge data
  */
 export declare class LabKnowledgeRequest extends PagedRequest<LabKnowledgeRequestInput> {
     protected validator: LabKnowledgeRequestValidator;

package/dist/api/base/health-data/lab-knowledge-request.js

@@ -18,6 +18,9 @@ export class LabKnowledgeRequestValidator extends PagedRequestValidator {
 }
 /**
  * Request object for fetching lab knowledge data.
+ * @category Requests
+ * @title LabKnowledgeRequest
+ * @excerpt Request object for fetching lab knowledge data
  */
 export class LabKnowledgeRequest extends PagedRequest {
     constructor() {

package/dist/api/base/health-data/medication-knowledge-request.d.ts

@@ -1,4 +1,10 @@
 import { ErrorsCollector, PagedRequest, PagedRequestInput, PagedRequestValidator } from "../../../requests/index.js";
+/**
+ * Input type for medication knowledge requests. Used to fetch knowledge about specific medications.
+ * @category Inputs
+ * @title MedicationKnowledgeRequestInput
+ * @excerpt Input for fetching medication knowledge by statement ID
+ */
 export type MedicationKnowledgeRequestInput = PagedRequestInput & {
     medicationStatementId: string;
 };
@@ -15,6 +21,9 @@ export declare class MedicationKnowledgeRequestValidator extends PagedRequestVal
 }
 /**
  * Request object for fetching medication knowledge data.
+ * @category Requests
+ * @title MedicationKnowledgeRequest
+ * @excerpt Request object for fetching medication knowledge data
  */
 export declare class MedicationKnowledgeRequest extends PagedRequest<MedicationKnowledgeRequestInput> {
     protected validator: MedicationKnowledgeRequestValidator;

package/dist/api/base/health-data/medication-knowledge-request.js

@@ -18,6 +18,9 @@ export class MedicationKnowledgeRequestValidator extends PagedRequestValidator {
 }
 /**
  * Request object for fetching medication knowledge data.
+ * @category Requests
+ * @title MedicationKnowledgeRequest
+ * @excerpt Request object for fetching medication knowledge data
  */
 export class MedicationKnowledgeRequest extends PagedRequest {
     constructor() {

package/dist/api/base/health-data/medication-pricing-request.d.ts

@@ -1,4 +1,10 @@
 import { ErrorsCollector, ValidationRequest, Validator } from "../../../requests/index.js";
+/**
+ * Input type for medication pricing requests. Used to fetch pricing information for medications.
+ * @category Inputs
+ * @title MedicationPricingRequestInput
+ * @excerpt Input for fetching medication pricing information
+ */
 export type MedicationPricingRequestInput = {
     medicationStatementId: string;
 };
@@ -15,6 +21,9 @@ export declare class MedicationPricingRequestValidator implements Validator<Medi
 }
 /**
  * Request object for fetching medication pricing data.
+ * @category Requests
+ * @title MedicationPricingRequest
+ * @excerpt Request object for fetching medication pricing data
  */
 export declare class MedicationPricingRequest extends ValidationRequest<MedicationPricingRequestInput> {
     protected validator: MedicationPricingRequestValidator;

package/dist/api/base/health-data/medication-pricing-request.js

@@ -17,6 +17,9 @@ export class MedicationPricingRequestValidator {
 }
 /**
  * Request object for fetching medication pricing data.
+ * @category Requests
+ * @title MedicationPricingRequest
+ * @excerpt Request object for fetching medication pricing data
  */
 export class MedicationPricingRequest extends ValidationRequest {
     constructor() {

package/dist/api/base/health-space/appointments-request.d.ts

@@ -1,6 +1,12 @@
 import { SearchReference } from "../../../graphql/schema.js";
 import { ErrorsCollector, ValidationRequest } from "../../../requests/index.js";
 import { SearchDate, SearchString, SearchToken } from "../requests/index.js";
+/**
+ * Input type for appointment requests. Used to specify filters and search criteria for appointments.
+ * @category Inputs
+ * @title AppointmentsRequestInput
+ * @excerpt Input for appointment searches with filters
+ */
 export type AppointmentsRequestInput = {
     /**
      * The source[s] of the appointments to search for
@@ -67,6 +73,9 @@ declare class AppointmentsRequestValidator {
  * for appointment-related input data.
  *
  * @extends ValidationRequest<AppointmentsRequestInput>
+ * @category Requests
+ * @title AppointmentsRequest
+ * @excerpt Represents a request for appointments within the health space
  */
 export declare class AppointmentsRequest extends ValidationRequest<AppointmentsRequestInput> {
     protected validator: AppointmentsRequestValidator;

package/dist/api/base/health-space/appointments-request.js

@@ -69,6 +69,9 @@ _AppointmentsRequestValidator_searchDateValidator = new WeakMap(), _Appointments
  * for appointment-related input data.
  *
  * @extends ValidationRequest<AppointmentsRequestInput>
+ * @category Requests
+ * @title AppointmentsRequest
+ * @excerpt Represents a request for appointments within the health space
  */
 export class AppointmentsRequest extends ValidationRequest {
     constructor() {

package/dist/api/base/health-space/cancel-appointment-request.d.ts

@@ -1,7 +1,10 @@
 import { CodeableConcept, Scalars } from "../../../graphql/schema.js";
 import { ErrorsCollector, ValidationRequest, Validator } from "../../../requests/index.js";
 /**
- * Input type for canceling an appointment.
+ * Input type for canceling an appointment. Requires the appointment ID and optionally a cancellation reason.
+ * @category Inputs
+ * @title CancelAppointmentRequestInput
+ * @excerpt Input for canceling appointments with optional reason
  * @property id - The unique identifier of the appointment to be canceled.
  * @property cancelationReason - The reason for canceling the appointment (optional, FHIR CodeableConcept).
  */
@@ -42,6 +45,10 @@ declare class CancelAppointmentRequestValidator implements Validator<CancelAppoi
  * Usage:
  *   const req = new CancelAppointmentRequest(input);
  *   const validation = req.validate();
+ *
+ * @category Requests
+ * @title CancelAppointmentRequest
+ * @excerpt Represents a request for canceling an appointment within the health space
  */
 export declare class CancelAppointmentRequest extends ValidationRequest<CancelAppointmentRequestInput> {
     /**

package/dist/api/base/health-space/cancel-appointment-request.js

@@ -45,6 +45,10 @@ class CancelAppointmentRequestValidator {
  * Usage:
  *   const req = new CancelAppointmentRequest(input);
  *   const validation = req.validate();
+ *
+ * @category Requests
+ * @title CancelAppointmentRequest
+ * @excerpt Represents a request for canceling an appointment within the health space
  */
 export class CancelAppointmentRequest extends ValidationRequest {
     constructor() {