@icanbwell/bwell-sdk-ts 1.54.0 → 1.55.0

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

@@ -1,14 +1,35 @@
 import { ErrorsCollector, PagedRequest, PagedRequestInput, PagedRequestValidator, Validator } from "../../../requests/index.js";
+import { FieldSortOrder } from "../requests/field-sort-order.js";
 import { SearchDate } from "../requests/search-date.js";
 import { SearchToken } from "../requests/search-token.js";
+/**
+ * Input type for health data requests. Used to specify filters and pagination for health data queries.
+ * @category Inputs
+ * @title HealthDataRequestInput
+ * @excerpt Input for health data queries with filters and pagination
+ */
 export type HealthDataRequestInput = PagedRequestInput & {
     ids?: string[];
     groupCode?: SearchToken;
     lastUpdated?: SearchDate;
+    status?: SearchToken;
+    sort?: FieldSortOrder[];
 };
+/**
+ * Input type for care team requests. Used to filter care teams by category.
+ * @category Inputs
+ * @title CareTeamRequestInput
+ * @excerpt Input for filtering care teams by category
+ */
 export type CareTeamRequestInput = PagedRequestInput & {
     category?: string;
 };
+/**
+ * Input type for binary data requests. Requires specific IDs to fetch binary resources.
+ * @category Inputs
+ * @title BinaryRequestInput
+ * @excerpt Input for fetching binary resources by IDs
+ */
 export type BinaryRequestInput = PagedRequestInput & {
     ids: string[];
 };
@@ -52,111 +73,180 @@ export declare class BinaryRequestValidator extends PagedRequestValidator<Binary
 }
 /**
  * Base request object for fetching health data.
+ * @category Requests
+ * @title HealthDataRequest
+ * @excerpt Base request object for fetching health data
  */
 export declare class HealthDataRequest extends PagedRequest<HealthDataRequestInput> {
     protected validator: HealthDataRequestValidator;
 }
 /**
  * Request object for fetching allergy intolerance data.
+ * @category Requests
+ * @title AllergyIntolerancesRequest
+ * @excerpt Request object for fetching allergy intolerance data
  */
 export declare 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 declare class AllergyIntoleranceGroupsRequest extends PagedRequest {
 }
 /**
  * Request object for fetching conditions data.
+ * @category Requests
+ * @title ConditionsRequest
+ * @excerpt Request object for fetching conditions data
  */
 export declare class ConditionsRequest extends HealthDataRequest {
 }
 /**
  * Request object for fetching condition groups data.
+ * @category Requests
+ * @title ConditionGroupsRequest
+ * @excerpt Request object for fetching condition groups data
  */
 export declare class ConditionGroupsRequest extends PagedRequest {
 }
 /**
  * Request object for fetching document references data.
+ * @category Requests
+ * @title DocumentReferencesRequest
+ * @excerpt Request object for fetching document references data
  */
 export declare class DocumentReferencesRequest extends HealthDataRequest {
 }
 /**
  * Request object for fetching labs data.
+ * @category Requests
+ * @title LabsRequest
+ * @excerpt Request object for fetching labs data
  */
 export declare class LabsRequest extends HealthDataRequest {
 }
 /**
  * Request object for fetching lab groups data.
+ * @category Requests
+ * @title LabGroupsRequest
+ * @excerpt Request object for fetching lab groups data
  */
 export declare class LabGroupsRequest extends PagedRequest {
 }
 /**
  * Request object for fetching care plan data.
+ * @category Requests
+ * @title CarePlansRequest
+ * @excerpt Request object for fetching care plan data
  */
 export declare class CarePlansRequest extends HealthDataRequest {
 }
 /**
  * Request object for fetching care team data.
+ * @category Requests
+ * @title CareTeamsRequest
+ * @excerpt Request object for fetching care team data
  */
 export declare class CareTeamsRequest extends PagedRequest<CareTeamRequestInput> {
 }
 /**
  * Request object for fetching care plan groups data.
+ * @category Requests
+ * @title CarePlanGroupsRequest
+ * @excerpt Request object for fetching care plan groups data
  */
 export declare class CarePlanGroupsRequest extends PagedRequest {
 }
 /**
  * Request object for fetching encounters data.
+ * @category Requests
+ * @title EncountersRequest
+ * @excerpt Request object for fetching encounters data
  */
 export declare class EncountersRequest extends HealthDataRequest {
 }
 /**
  * Request object for fetching encounter groups data.
+ * @category Requests
+ * @title EncounterGroupsRequest
+ * @excerpt Request object for fetching encounter groups data
  */
 export declare class EncounterGroupsRequest extends PagedRequest {
 }
 /**
  * Request object for fetching immunization data.
+ * @category Requests
+ * @title ImmunizationsRequest
+ * @excerpt Request object for fetching immunization data
  */
 export declare class ImmunizationsRequest extends HealthDataRequest {
 }
 /**
  * Request object for fetching immunization groups data.
+ * @category Requests
+ * @title ImmunizationGroupsRequest
+ * @excerpt Request object for fetching immunization groups data
  */
 export declare class ImmunizationGroupsRequest extends PagedRequest {
 }
 /**
  * Request object for fetching procedure data.
+ * @category Requests
+ * @title ProceduresRequest
+ * @excerpt Request object for fetching procedure data
  */
 export declare class ProceduresRequest extends HealthDataRequest {
 }
 /**
  * Request object for fetching procedure groups data.
+ * @category Requests
+ * @title ProcedureGroupsRequest
+ * @excerpt Request object for fetching procedure groups data
  */
 export declare class ProcedureGroupsRequest extends PagedRequest {
 }
 /**
  * Request object for fetching vital signs data.
+ * @category Requests
+ * @title VitalSignsRequest
+ * @excerpt Request object for fetching vital signs data
  */
 export declare 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 declare class VitalSignGroupsRequest extends PagedRequest {
 }
 /**
  * Request object for fetching DiagnosticReport Lab Groups
+ * @category Requests
+ * @title DiagnosticReportLabGroupsRequest
+ * @excerpt Request object for fetching DiagnosticReport Lab Groups
  */
 export declare class DiagnosticReportLabGroupsRequest extends PagedRequest {
 }
+/**
+ * Request object for fetching MedicationDispense data.
+ * @category Requests
+ * @title MedicationDispenseRequest
+ * @excerpt Request object for fetching MedicationDispense data
+ */
 type MedicationDispenseRequestInput = PagedRequestInput & {
     prescription?: string[];
     ids?: string[];
     lastUpdated?: SearchDate;
-    sort?: string[];
+    status?: SearchToken;
+    sort?: FieldSortOrder[];
 };
+/**
+ */
 type MedicationRequestRequestInput = MedicationDispenseRequestInput & {
     medicationCode?: SearchToken;
 };
@@ -171,16 +261,24 @@ export declare class MedicationRequestRequestValidator extends MedicationDispens
 }
 /**
  * Request object for fetching medication dispense data.
+ * @category Requests
+ * @title MedicationDispenseRequest
+ * @excerpt Request object for fetching medication dispense data
  */
 export declare class MedicationDispenseRequest extends PagedRequest<MedicationDispenseRequestInput> {
     protected validator: MedicationDispenseRequestValidator;
 }
 /**
  * Request object for fetching medication request data.
+ * @category Requests
+ * @title MedicationRequestRequest
+ * @excerpt Request object for fetching medication request data
  */
 export declare class MedicationRequestRequest extends PagedRequest<MedicationRequestRequestInput> {
     protected validator: MedicationRequestRequestValidator;
 }
+/**
+ */
 type MedicationStatementRequestInput = HealthDataRequestInput & {
     medicationCode?: SearchToken;
 };
@@ -195,26 +293,36 @@ export declare class MedicationStatementRequestValidator extends HealthDataReque
 }
 /**
  * Request object for fetching medication statement data.
+ * @category Requests
+ * @title MedicationStatementsRequest
+ * @excerpt Request object for fetching medication statement data
  */
 export declare class MedicationStatementsRequest extends HealthDataRequest {
     protected validator: MedicationStatementRequestValidator;
 }
 /**
  * Request object for fetching medication groups data.
+ * @category Requests
+ * @title MedicationGroupsRequest
+ * @excerpt Request object for fetching medication groups data
  */
 export declare class MedicationGroupsRequest extends PagedRequest {
 }
-export type DiagnosticReportsRequestInput = PagedRequestInput & {
-    id?: string[];
-    lastUpdated?: SearchDate;
-    sort?: string[];
-};
-export declare class DiagnosticReportsRequest extends PagedRequest<DiagnosticReportsRequestInput> {
-}
 /**
  * Request object for fetching Binary data.
+ * @category Requests
+ * @title BinaryRequest
+ * @excerpt Request object for fetching Binary data
  */
 export declare class BinaryRequest extends PagedRequest<BinaryRequestInput> {
     protected validator: BinaryRequestValidator;
 }
+/**
+ * Request object for fetching diagnostic reports data.
+ * @category Requests
+ * @title DiagnosticReportsRequest
+ * @excerpt Request object for fetching diagnostic reports data
+ */
+export declare class DiagnosticReportsRequest extends HealthDataRequest {
+}
 export {};

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,13 +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 {
 }
-export class DiagnosticReportsRequest 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() {
@@ -265,3 +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-data-response-factory.d.ts

@@ -0,0 +1,27 @@
+import { EntryBundle, GroupedHealthDataResponse, HealthDataResponse, ResourceBundle } from "../../../models/common/bundle.js";
+import { HealthDataRequest } from "./health-data-request.js";
+/**
+ * Interface for creating paginated responses for health queries.
+ *
+ * @private
+ * @category Health Data
+ * @title HealthDataResponseFactory
+ * @excerpt Interface for creating paginated response bundles from GraphQL responses
+ */
+export interface HealthDataResponseFactory {
+    /**
+     * Creates a paginated SDK response from an raw FHIR bundle response.
+     *
+     * @param bundle - The raw GraphQL response data containing entries
+     * @param request - Optional request containing pagination parameters
+     * @returns Paginated bundle with type-safe data
+     */
+    transformHealthDataResult<T>(bundle: EntryBundle<T>, request: HealthDataRequest): HealthDataResponse<T>;
+    /**
+     * Creates a paginated SDK response from a raw grouped health data response.
+     *
+     * @param bundle - The GraphQL response data containing resources and paging_info
+     * @returns Paginated bundle with type-safe data
+     */
+    transformGroupQueryResult<T>(bundle: ResourceBundle<T>): GroupedHealthDataResponse<T>;
+}