@icanbwell/bwell-sdk-ts 1.54.0 → 1.55.0

package/dist/models/common/timing.d.ts

@@ -0,0 +1,107 @@
+import { CodeableConcept } from "./codeable-concept.js";
+import { Period } from "./period.js";
+import { Quantity } from "./quantity.js";
+import { Range } from "./range.js";
+/**
+ * Specifies an event that may occur multiple times.
+ *
+ * @category Models
+ * @title TimingRepeat
+ * @excerpt Specifies an event that may occur multiple times.
+ */
+export type TimingRepeat = {
+    id: string | null;
+    /**
+     * A duration for the length of the timing schedule.
+     */
+    boundsDuration: Quantity | null;
+    /**
+     * Start/End range of timing schedule.
+     */
+    boundsPeriod: Period | null;
+    /**
+     * Range of possible length of the timing schedule.
+     */
+    boundsRange: Range | null;
+    /**
+     * A total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values.
+     */
+    count: number | null;
+    /**
+     * If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.
+     */
+    countMax: number | null;
+    /**
+     * If one or more days of week is provided, then the action happens only on the specified day(s).
+     */
+    dayOfWeek: (string | null)[] | null;
+    /**
+     * How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration.
+     */
+    duration: number | null;
+    /**
+     * If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length.
+     */
+    durationMax: number | null;
+    /**
+     * The units of time for the duration, in UCUM units.
+     */
+    durationUnit: string | null;
+    /**
+     * The number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency.
+     */
+    frequency: number | null;
+    /**
+     * If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.
+     */
+    frequencyMax: number | null;
+    /**
+     * The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event.
+     */
+    offset: number | null;
+    /**
+     * Indicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length.
+     */
+    period: number | null;
+    /**
+     * If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days.
+     */
+    periodMax: number | null;
+    /**
+     * The units of time for the period in UCUM units.
+     */
+    periodUnit: string | null;
+    /**
+     * Specified time of day for action to take place.
+     */
+    timeOfDay: (string | null)[] | null;
+    /**
+     * An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.
+     */
+    when: (string | null)[] | null;
+};
+/**
+ * Specifies an event that may occur multiple times.
+ *
+ * @category Models
+ * @title Timing
+ * @excerpt Specifies an event that may occur multiple times
+ */
+export type Timing = {
+    id: string | null;
+    /** Identifies specific times when the event occurs. */
+    event: (string | null)[] | null;
+    /**
+     * A code for the timing schedule (or just text in code.text).
+     * Some codes such as BID are ubiquitous, but many institutions
+     * define their own additional codes. If a code is provided, the
+     * code is understood to be a complete statement of whatever is
+     * specified in the structured timing data, and either the code
+     * or the data may be used to interpret the Timing, with the exception
+     * that .repeat.bounds still applies over the code (and is not
+     * contained in the code).
+     */
+    code: CodeableConcept | null;
+    /** A set of rules that describe when the event is scheduled. */
+    repeat: TimingRepeat | null;
+};

package/dist/models/common/timing.js

@@ -0,0 +1 @@
+export {};

package/dist/models/common/value.d.ts

@@ -0,0 +1,22 @@
+import { CodeableConcept, Period, Ratio } from "./index.js";
+import { Quantity } from "./quantity.js";
+import { Range } from "./range.js";
+/**
+ * Represents a value that can be one of several types.
+ *
+ * @category Models
+ * @title Value
+ * @excerpt Represents a value that can be one of several types
+ */
+export type Value = {
+    valueQuantity: Quantity | null;
+    valueCodeableConcept: CodeableConcept | null;
+    valueString: string | null;
+    valueBoolean: boolean | null;
+    valueDateTime: string | null;
+    valueTime: string | null;
+    valueInteger: number | null;
+    valueRatio: Ratio | null;
+    valueRange: Range | null;
+    valuePeriod: Period | null;
+};

package/dist/models/common/value.js

@@ -0,0 +1 @@
+export {};

package/dist/models/connection/base-connection.d.ts

@@ -0,0 +1,27 @@
+import type { ConnectionCategory, DataConnectionType } from "../enums/index.js";
+/**
+ * Base connection interface containing common fields shared by all connection types.
+ * This interface provides the foundational properties that all connection models inherit.
+ *
+ * @category Models
+ * @title BaseConnection
+ * @excerpt Base connection interface containing common fields shared by...
+ */
+export interface BaseConnection {
+    /**
+     * The unique identifier for the connection.
+     */
+    id: string;
+    /**
+     * The display name of the connection.
+     */
+    name: string;
+    /**
+     * The category of the connection (Basic or OAuth).
+     */
+    category: ConnectionCategory;
+    /**
+     * The type of data source connection.
+     */
+    type: DataConnectionType;
+}

package/dist/models/connection/base-connection.js

@@ -0,0 +1 @@
+export {};

package/dist/models/connection/connection-status.d.ts

@@ -0,0 +1,15 @@
+import type { DataConnectionStatus } from "../enums/index.js";
+/**
+ * Connection status result model.
+ * Represents the status of a connection operation (disconnect/delete).
+ *
+ * @category Models
+ * @title ConnectionStatus
+ * @excerpt Connection status result model
+ */
+export interface ConnectionStatus {
+    /** Current status of the connection */
+    status: DataConnectionStatus | null;
+    /** Timestamp when the status was last updated */
+    statusUpdated: string;
+}

package/dist/models/connection/connection-status.js

@@ -0,0 +1 @@
+export {};

package/dist/models/connection/connection.d.ts

@@ -0,0 +1,32 @@
+import type { DataConnectionStatus, SyncStatus } from "../enums/index.js";
+import type { BaseConnection } from "./base-connection.js";
+/**
+ * Connection model representing a healthcare provider connection with full status information.
+ * Contains comprehensive information about connection state and synchronization status.
+ *
+ * @category Models
+ * @title Connection
+ * @excerpt Connection model representing a healthcare provider connection with...
+ */
+export type Connection = BaseConnection & {
+    /**
+     * The current authentication status of the connection.
+     */
+    status: DataConnectionStatus | null;
+    /**
+     * The current synchronization status of the data pipeline.
+     */
+    syncStatus: SyncStatus | null;
+    /**
+     * The timestamp when the status was last updated.
+     */
+    statusUpdated: string | null;
+    /**
+     * The timestamp of the last successful data synchronization.
+     */
+    lastSynced: string | null;
+    /**
+     * The timestamp when the connection was created.
+     */
+    created: string;
+};

package/dist/models/connection/connection.js

@@ -0,0 +1 @@
+export {};

package/dist/models/connection/data-source.d.ts

@@ -0,0 +1,27 @@
+import type { ConnectionCategory, DataConnectionType } from "../enums/index.js";
+/**
+ * DataSource model representing information about a healthcare provider connection.
+ * Contains basic metadata about available data sources for connection.
+ *
+ * @category Models
+ * @title DataSource
+ * @excerpt DataSource model representing information about a healthcare provider...
+ */
+export type DataSource = {
+    /**
+     * The unique identifier for the data source.
+     */
+    id: string;
+    /**
+     * The display name of the data source.
+     */
+    name: string;
+    /**
+     * The category of the connection (Basic or OAuth).
+     */
+    category: ConnectionCategory;
+    /**
+     * The type of data source connection.
+     */
+    type: DataConnectionType;
+};

package/dist/models/connection/data-source.js

@@ -0,0 +1 @@
+export {};

package/dist/models/connection/index.d.ts

@@ -0,0 +1,6 @@
+export type { BaseConnection } from "./base-connection.js";
+export type { Connection } from "./connection.js";
+export type { ConnectionStatus } from "./connection-status.js";
+export type { DataSource } from "./data-source.js";
+export type { MemberConnection } from "./member-connection.js";
+export type { OAuthUrl } from "./oauth-url.js";

package/dist/models/connection/index.js

@@ -0,0 +1 @@
+export {};

package/dist/models/connection/member-connection.d.ts

@@ -0,0 +1,37 @@
+import { CodeableConcept } from "../common/codeable-concept.js";
+import type { DataConnectionStatus, SyncStatus } from "../enums/index.js";
+import type { BaseConnection } from "./base-connection.js";
+/**
+ * MemberConnection model representing a member's healthcare provider connection.
+ * Contains connection metadata including authentication and synchronization status.
+ *
+ * @category Models
+ * @title MemberConnection
+ * @excerpt MemberConnection model representing a member's healthcare provider connection
+ */
+export type MemberConnection = BaseConnection & {
+    /**
+     * The authentication token status.
+     */
+    status: DataConnectionStatus;
+    /**
+     * The status of the data ingest pipeline.
+     */
+    syncStatus: SyncStatus;
+    /**
+     * Errors from the data ingest pipeline.
+     */
+    syncError: (CodeableConcept | null)[] | null;
+    /**
+     * The timestamp when connection was created.
+     */
+    created: string;
+    /**
+     * The timestamp when connection was last updated.
+     */
+    statusUpdated: string | null;
+    /**
+     * The timestamp when data was last synchronized.
+     */
+    lastSynced: string | null;
+};

package/dist/models/connection/member-connection.js

@@ -0,0 +1 @@
+export {};

package/dist/models/connection/oauth-url.d.ts

@@ -0,0 +1,12 @@
+/**
+ * OAuth authorization URL result model.
+ * Contains the redirect URL for OAuth-based healthcare provider connections.
+ *
+ * @category Models
+ * @title OAuthUrl
+ * @excerpt OAuth authorization URL result model
+ */
+export interface OAuthUrl {
+    /** OAuth authorization redirect URL */
+    redirectUrl: string;
+}

package/dist/models/connection/oauth-url.js

@@ -0,0 +1 @@
+export {};

package/dist/models/device/device-registration-results.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Device registration result.
+ * Returned when a device is successfully registered in the system.
+ *
+ * @category Models
+ * @title DeviceRegistrationResults
+ * @excerpt Device registration result with unique identifier
+ */
+export type DeviceRegistrationResults = {
+    /** Unique device identifier assigned during registration */
+    id: string;
+};

package/dist/models/device/device-registration-results.js

@@ -0,0 +1 @@
+export {};

package/dist/models/device/index.d.ts

@@ -0,0 +1 @@
+export type { DeviceRegistrationResults } from "./device-registration-results.js";

package/dist/models/device/index.js

@@ -0,0 +1 @@
+export {};

package/dist/models/enums/category-code.d.ts

@@ -0,0 +1,11 @@
+/**
+ * CategoryCode enum representing the category code for consents or data.
+ * Defines the possible category codes used in the system.
+ *
+ * @category Enums
+ * @title CategoryCode
+ * @excerpt CategoryCode enum representing the category code for consents or data.
+ */
+export type CategoryCode = "communicationPreferences:includePHI" | "dataSharing" | "healthCircleAdolescent" | "healthCircleMinor" | "healthMatch" | "ias:import:records" | "mobileCommunicationPreferences" | "personalizedHealthOffersAndAds" | "proaAttestation" | "tos";
+/** @internal */
+export declare const categoryCodeValues: readonly ["communicationPreferences:includePHI", "dataSharing", "healthCircleAdolescent", "healthCircleMinor", "healthMatch", "ias:import:records", "mobileCommunicationPreferences", "personalizedHealthOffersAndAds", "proaAttestation", "tos"];

package/dist/models/enums/category-code.js

@@ -0,0 +1,13 @@
+/** @internal */
+export const categoryCodeValues = [
+    "communicationPreferences:includePHI",
+    "dataSharing",
+    "healthCircleAdolescent",
+    "healthCircleMinor",
+    "healthMatch",
+    "ias:import:records",
+    "mobileCommunicationPreferences",
+    "personalizedHealthOffersAndAds",
+    "proaAttestation",
+    "tos",
+];

package/dist/models/enums/connection-category.d.ts

@@ -0,0 +1,9 @@
+/**
+ * ConnectionCategory enum representing the type of connection authentication.
+ * Defines whether a connection uses basic authentication or OAuth-based authentication.
+ *
+ * @category Enums
+ * @title ConnectionCategory
+ * @excerpt ConnectionCategory enum representing the type of connection authentication...
+ */
+export type ConnectionCategory = "BASIC" | "OAUTH";

package/dist/models/enums/connection-category.js

@@ -0,0 +1 @@
+export {};

package/dist/models/enums/consent-provision-type.d.ts

@@ -0,0 +1,11 @@
+/**
+ * ConsentProvisionType enum representing the type of consent provision.
+ * Defines whether a consent provision is a denial or a permit.
+ *
+ * @category Enums
+ * @title ConsentProvisionType
+ * @excerpt ConsentProvisionType enum representing the type of consent provision.
+ */
+export type ConsentProvisionType = "DENY" | "PERMIT";
+/** @internal */
+export declare const consentProvisionTypeValues: readonly ["DENY", "PERMIT"];

package/dist/models/enums/consent-provision-type.js

@@ -0,0 +1,2 @@
+/** @internal */
+export const consentProvisionTypeValues = ["DENY", "PERMIT"];

package/dist/models/enums/consent-status.d.ts

@@ -0,0 +1,11 @@
+/**
+ * ConsentStatus enum representing the status of a consent.
+ * Defines the possible status values for a consent.
+ *
+ * @category Enums
+ * @title ConsentStatus
+ * @excerpt ConsentStatus enum representing the status of a consent.
+ */
+export type ConsentStatus = "ACTIVE" | "DRAFT" | "ENTERED_IN_ERROR" | "INACTIVE" | "PROPOSED" | "REJECTED";
+/** @internal */
+export declare const consentStatusValues: readonly ["ACTIVE", "DRAFT", "ENTERED_IN_ERROR", "INACTIVE", "PROPOSED", "REJECTED"];

package/dist/models/enums/consent-status.js

@@ -0,0 +1,9 @@
+/** @internal */
+export const consentStatusValues = [
+    "ACTIVE",
+    "DRAFT",
+    "ENTERED_IN_ERROR",
+    "INACTIVE",
+    "PROPOSED",
+    "REJECTED",
+];

package/dist/models/enums/data-connection-status.d.ts

@@ -0,0 +1,9 @@
+/**
+ * DataConnectionStatus enum representing the current status of a data connection.
+ * Defines the various states a connection can be in during its lifecycle.
+ *
+ * @category Enums
+ * @title DataConnectionStatus
+ * @excerpt DataConnectionStatus enum representing the current status of a data connection...
+ */
+export type DataConnectionStatus = "CONNECTED" | "DELETED" | "DISCONNECTED" | "ERROR" | "EXPIRED" | "ACCESS_ENDED";

package/dist/models/enums/data-connection-status.js

@@ -0,0 +1 @@
+export {};

package/dist/models/enums/data-connection-type.d.ts

@@ -0,0 +1,9 @@
+/**
+ * DataConnectionType enum representing the type of data source connection.
+ * Defines the specific connection type for different healthcare data providers.
+ *
+ * @category Enums
+ * @title DataConnectionType
+ * @excerpt DataConnectionType enum representing the type of data source connection.
+ */
+export type DataConnectionType = "CLINICAL" | "INSURANCE" | "LAB" | "PHARMACY" | "PRACTITIONER";

package/dist/models/enums/data-connection-type.js

@@ -0,0 +1 @@
+export {};

package/dist/models/enums/data-set.d.ts

@@ -0,0 +1,10 @@
+/**
+ * DataSets enum representing the type of data source connection.
+ * Used to filter health resources searches.
+ *
+ * @deprecated Internal bwell use only
+ * @category Enums
+ * @title DataSets
+ * @excerpt DataSets enum representing the type of data source connection.
+ */
+export type DataSet = "NPPES" | "CONNECTHUB";

package/dist/models/enums/data-set.js

@@ -0,0 +1 @@
+export {};

package/dist/models/enums/device-platform.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Enum representing the mobile device platforms.
+ * Ex: For push notification registration.
+ *
+ * @category Enums
+ * @title DevicePlatform
+ * @excerpt DevicePlatform enum representing the mobile device platforms.
+ */
+export type DevicePlatform = "IOS" | "ANDROID";
+/** @internal */
+export declare const devicePlatformValues: readonly ["IOS", "ANDROID"];

package/dist/models/enums/device-platform.js

@@ -0,0 +1,2 @@
+/** @internal */
+export const devicePlatformValues = ["IOS", "ANDROID"];

package/dist/models/enums/endpoint-status.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Operational status of a technical endpoint.
+ * Indicates whether the endpoint is available for communication.
+ *
+ * @category Enums
+ * @title EndpointStatus
+ * @excerpt Operational status values for technical endpoints
+ */
+export type EndpointStatus = "ACTIVE" | "ENTERED_IN_ERROR" | "ERROR" | "OFF" | "SUSPENDED" | "TEST";

package/dist/models/enums/endpoint-status.js

@@ -0,0 +1 @@
+export {};

package/dist/models/enums/filter-field.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Filter field types available for health resource searches.
+ * Used to specify which fields can be filtered on in search queries.
+ *
+ * @category Enums
+ * @title FilterField
+ * @excerpt Available filter fields for health resource searches
+ */
+export type FilterField = "CHARACTERISTIC" | "COMMUNICATION" | "GENDER" | "SPECIALTY";

package/dist/models/enums/filter-field.js

@@ -0,0 +1 @@
+export {};

package/dist/models/enums/gender.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Gender values for healthcare providers and patients.
+ * Standard gender classifications used in healthcare contexts.
+ *
+ * @category Enums
+ * @title Gender
+ * @excerpt Gender classification values for healthcare contexts
+ */
+export type Gender = "FEMALE" | "MALE" | "OTHER" | "UNKNOWN";

package/dist/models/enums/gender.js

@@ -0,0 +1 @@
+export {};

package/dist/models/enums/index.d.ts

@@ -0,0 +1,18 @@
+export { PersonGender, personGenderValues } from "./person-gender.js";
+export { ConsentStatus, consentStatusValues } from "./consent-status.js";
+export { CategoryCode, categoryCodeValues } from "./category-code.js";
+export { ConsentProvisionType, consentProvisionTypeValues, } from "./consent-provision-type.js";
+export { ConnectionCategory } from "./connection-category.js";
+export { DataConnectionStatus } from "./data-connection-status.js";
+export { DataConnectionType } from "./data-connection-type.js";
+export { SyncStatus } from "./sync-status.js";
+export { LogLevel } from "./log-level.js";
+export { Gender } from "./gender.js";
+export { FilterField } from "./filter-field.js";
+export { SearchResultType } from "./search-result-type.js";
+export { SearchContext } from "./search-context.js";
+export { SortField } from "./sort-field.js";
+export { SortOrder } from "./sort-order.js";
+export { EndpointStatus } from "./endpoint-status.js";
+export { DevicePlatform, devicePlatformValues } from "./device-platform.js";
+export { DataSet } from "./data-set.js";

package/dist/models/enums/index.js

@@ -0,0 +1,5 @@
+export { personGenderValues } from "./person-gender.js";
+export { consentStatusValues } from "./consent-status.js";
+export { categoryCodeValues } from "./category-code.js";
+export { consentProvisionTypeValues, } from "./consent-provision-type.js";
+export { devicePlatformValues } from "./device-platform.js";

package/dist/models/enums/log-level.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Log level string union for SDK logging
+ *
+ * @category Enums
+ * @title LogLevel
+ * @excerpt Log level string union for SDK logging
+ */
+export type LogLevel = "DEBUG" | "ERROR" | "INFO" | "VERBOSE" | "WARN";

package/dist/models/enums/log-level.js

@@ -0,0 +1 @@
+export {};

package/dist/models/enums/person-gender.d.ts

@@ -0,0 +1,11 @@
+/**
+ * PersonGender enum representing a person's gender.
+ * Defines the possible gender values for a person.
+ *
+ * @category Enums
+ * @title PersonGender
+ * @excerpt PersonGender enum representing a person's gender.
+ */
+export type PersonGender = "female" | "male" | "other" | "unknown";
+/** @internal */
+export declare const personGenderValues: readonly ["female", "male", "other", "unknown"];

package/dist/models/enums/person-gender.js

@@ -0,0 +1,7 @@
+/** @internal */
+export const personGenderValues = [
+    "female",
+    "male",
+    "other",
+    "unknown",
+];

package/dist/models/enums/search-context.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Search context options for health resource searches.
+ * Defines the context in which a search is being performed, which determines
+ * which configurations and filters are applied to the search results.
+ *
+ * @category Enums
+ * @title SearchContext
+ * @excerpt Available search contexts for health resource searches
+ */
+export type SearchContext = "DATA_CONNECTIONS" | "FIND_CARE";

package/dist/models/enums/search-context.js

@@ -0,0 +1 @@
+export {};

package/dist/models/enums/search-result-type.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Types of search results returned by health resource searches.
+ * Categorizes different kinds of healthcare entities and services.
+ *
+ * @category Enums
+ * @title SearchResultType
+ * @excerpt Categories of health resource search results
+ */
+export type SearchResultType = "INSURANCE" | "LABORATORY" | "PHARMACY" | "PRACTICE" | "PRACTITIONER";

package/dist/models/enums/search-result-type.js

@@ -0,0 +1 @@
+export {};

package/dist/models/enums/sort-field.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Sort field options for health resource searches.
+ * Defines the available fields that can be used to sort search results.
+ *
+ * @experimental
+ * @category Enums
+ * @title SortField
+ * @excerpt Available sort fields for health resource searches
+ */
+export type SortField = "content" | "distance" | "relevance";

package/dist/models/enums/sort-field.js

@@ -0,0 +1 @@
+export {};