@icanbwell/bwell-sdk-ts 1.54.0 → 1.55.0

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

@@ -0,0 +1,41 @@
+/**
+ * Address model representing an address expressed using postal conventions
+ * (as opposed to GPS or other location definition formats).
+ *
+ * @category Models
+ * @title Address
+ * @excerpt Address model representing an address expressed using postal...
+ */
+export interface Address {
+    /** Address use (home, work, etc.) */
+    use: string | null;
+    /** Address type */
+    type: string | null;
+    /** Full address as text */
+    text: string | null;
+    /**
+     * This component contains the house number, apartment number, street name,
+     * street direction, P.O. Box number, delivery hints, and similar address
+     * information.
+     */
+    line: (string | null)[] | null;
+    /**
+     * The name of the city, town, suburb, village or other community or delivery
+     * center.
+     */
+    city: string | null;
+    /** District/county */
+    district: string | null;
+    /**
+     * Sub-unit of a country with limited sovereignty in a federally organized
+     * country. A code may be used if codes are in common use (e.g. US 2 letter state
+     * codes).
+     */
+    state: string | null;
+    /**
+     * A postal code designating a region defined by the postal service.
+     */
+    postalCode: string | null;
+    /** Country */
+    country: string | null;
+}

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

@@ -0,0 +1,18 @@
+/**
+ * Represents an annotation or note with author and time information.
+ * Used in FHIR resources to add notes and comments.
+ *
+ * @category Models
+ * @title Annotation
+ * @excerpt Represents an annotation or note with author and...
+ */
+export type Annotation = {
+    /** Unique identifier for the annotation */
+    id: string | null;
+    /** Author of the annotation as string */
+    authorString: string | null;
+    /** When the annotation was made */
+    time: string | null;
+    /** The annotation text */
+    text: string | null;
+};

package/dist/models/common/annotation.js

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

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

@@ -0,0 +1,18 @@
+/**
+ * Represents a file attachment or binary data.
+ * Used for documents, images, or other file content.
+ *
+ * @category Models
+ * @title Attachment
+ * @excerpt Represents a file attachment or binary data
+ */
+export type Attachment = {
+    /** MIME type of the attachment */
+    contentType: string | null;
+    /** The actual data content */
+    data: string | null;
+    /** URL where the data can be found */
+    url: string | null;
+    /** Label to display in place of the data */
+    title: string | null;
+};

package/dist/models/common/attachment.js

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

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

@@ -0,0 +1,83 @@
+import type { PagingInfo } from "./paging-info.js";
+/**
+ * Generic bundle type for resources with paging information.
+ * Used for paginated results from GraphQL queries.
+ *
+ * @typeParam T The type of resource contained in the bundle
+ * @category Models
+ * @title ResourceBundle
+ * @excerpt Generic bundle type for resources with paging information
+ */
+export type ResourceBundle<T> = {
+    /** Resource array */
+    resources: T[];
+    /** Paging information */
+    paging_info: PagingInfo | null;
+};
+/**
+ * Generic simple bundle type for entry-based bundles.
+ * Used for search result bundles that contain entries.
+ *
+ * @typeParam T The type of entry contained in the bundle
+ * @category Models
+ * @title EntryBundle
+ * @excerpt Generic simple bundle type for entry-based bundles
+ */
+export type EntryBundle<T> = {
+    /** Unique identifier */
+    id: string | null;
+    /** Entry array */
+    entry: (IdentifiedResourceEntry<T> | null)[] | null;
+    /** Total result count available on server (for paging) */
+    total: number | null;
+};
+/**
+ * Generic entry wrapper type for bundle entries with identifiers.
+ * Used to wrap resources within bundle entries that need tracking IDs.
+ *
+ * @typeParam T The type of resource being wrapped
+ * @category Models
+ * @title IdentifiedResourceEntry
+ * @excerpt Generic entry wrapper type for bundle entries with...
+ */
+export type IdentifiedResourceEntry<T> = {
+    /** Entry identifier */
+    id: string | null;
+    /** The wrapped resource */
+    resource: T | null;
+};
+/**
+ * The SDK result type for health data queries that include paging information
+ * at the top level.
+ *
+ * @category Models
+ * @title HealthDataResponse
+ * @excerpt The SDK result type for health data queries that include paging information at the top level
+ */
+export type HealthDataResponse<T> = EntryBundle<T> & {
+    pagingInfo: SDKPagingInfo | null;
+};
+/**
+ * The SDK result type for grouped health data queries that include paging information
+ * at the top level.
+ *
+ * @category Models
+ * @title GroupedHealthDataResponse
+ * @excerpt The SDK result type for grouped health data queries that include paging information at the top level
+ */
+export type GroupedHealthDataResponse<T> = Omit<ResourceBundle<T>, "paging_info"> & {
+    pagingInfo: SDKPagingInfo | null;
+};
+/**
+ * Common interface used to return paging information.
+ *
+ * @category Models
+ * @title PaginatedBundle
+ * @excerpt Common interface used to return paging information
+ */
+export type SDKPagingInfo = {
+    pageNumber: number | null;
+    pageSize: number | null;
+    totalItems: number | null;
+    totalPages: number | null;
+};

package/dist/models/common/bundle.js

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

package/dist/models/common/codeable-concept.d.ts

@@ -0,0 +1,17 @@
+import type { Coding } from "./coding.js";
+/**
+ * Represents a CodeableConcept with text and coded values.
+ * Used to represent concepts that can be coded in multiple systems.
+ *
+ * @category Models
+ * @title CodeableConcept
+ * @excerpt Represents a CodeableConcept with text and coded values
+ */
+export type CodeableConcept = {
+    /** Code identifier */
+    id: string | null;
+    /** Plain text representation */
+    text: string | null;
+    /** Coded representation */
+    coding: (Coding | null)[] | null;
+};

package/dist/models/common/codeable-concept.js

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

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

@@ -0,0 +1,18 @@
+/**
+ * Represents a coding in FHIR/GraphQL-compatible format.
+ * Used within CodeableConcepts for coded concepts.
+ *
+ * @category Models
+ * @title Coding
+ * @excerpt Represents a coding in FHIR/GraphQL-compatible format
+ */
+export type Coding = {
+    /** Coding identifier */
+    id: string | null;
+    /** Code system URI */
+    system: string | null;
+    /** Display name */
+    display: string | null;
+    /** Code value */
+    code: string | null;
+};

package/dist/models/common/coding.js

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

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

@@ -0,0 +1,23 @@
+import type { CodeableConcept } from "./codeable-concept.js";
+import type { Extension } from "./extension.js";
+import type { ReferenceRange } from "./reference-range.js";
+/**
+ * Represents a component with code, value, reference range, interpretation, and data absent reason.
+ * Used in vital sign groups and other health data structures.
+ *
+ * @category Models
+ * @title Component
+ * @excerpt Represents a component with code, value, reference range,...
+ */
+export type Component = {
+    /** Code identifying the component */
+    code: CodeableConcept;
+    /** Value of the component */
+    value: Extension;
+    /** Reference range for the component */
+    referenceRange: ReferenceRange[];
+    /** Interpretation of the component value */
+    interpretation: CodeableConcept[];
+    /** Reason why data is absent */
+    dataAbsentReason: CodeableConcept;
+};

package/dist/models/common/component.js

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

package/dist/models/common/contact-point.d.ts

@@ -0,0 +1,32 @@
+/**
+ * ContactPoint model representing details for all kinds of technology mediated
+ * contact points for a person or organization, including telephone, email, etc.
+ *
+ * @category Models
+ * @title ContactPoint
+ * @excerpt ContactPoint model representing details for all kinds of...
+ */
+export interface ContactPoint {
+    /** Unique identifier */
+    id: string | null;
+    /**
+     * Telecommunications form for contact point - what communications system is
+     * required to make use of the contact.
+     * Uses the Code scalar type from the GraphQL schema.
+     */
+    system: string | null;
+    /**
+     * The actual contact point details, in a form that is meaningful to the
+     * designated communication system (i.e. phone number or email address).
+     */
+    value: string | null;
+    /**
+     * Specifies a preferred order in which to use a set of contacts. ContactPoints
+     * with lower rank values are more preferred than those with higher rank values. */
+    rank: number | null;
+    /**
+     * Identifies the purpose for the contact point.
+     * Uses the Code scalar type from the GraphQL schema.
+     */
+    use: string | null;
+}

package/dist/models/common/contact-point.js

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

package/dist/models/common/dispense-request.d.ts

@@ -0,0 +1,67 @@
+import type { Organization, Period, Quantity, Reference } from "./index.js";
+/**
+ * Represents the initial fill component of a dispense request.
+ *
+ * @category Models
+ * @title InitialFill
+ * @excerpt Represents the initial fill component of a dispense request.
+ */
+export type InitialFill = {
+    /**
+     * Unique id for the element.
+     */
+    id: string | null;
+    /**
+     * The amount or quantity to provide as part of the first dispense.
+     */
+    quantity: Quantity | null;
+    /**
+     * The length of time that the first dispense is expected to last.
+     */
+    duration: Quantity | null;
+};
+/**
+ * Represents a medication request dispense request.
+ * Indicates the specific details for the dispense or medication supply part of a
+ * medication request (also known as a Medication Prescription or Medication Order).
+ *
+ * @category Models
+ * @title DispenseRequest
+ * @excerpt Represents a medication request dispense request.
+ */
+export type DispenseRequest = {
+    /**
+     * Unique id for the element.
+     */
+    id: string | null;
+    /**
+     * Indicates the quantity or duration for the first dispense of the medication.
+     */
+    initialFill: InitialFill | null;
+    /**
+     * The minimum period of time that must occur between dispenses of the medication.
+     */
+    dispenseInterval: Quantity | null;
+    /**
+     * This indicates the validity period of a prescription (stale dating the Prescription).
+     */
+    validityPeriod: Period | null;
+    /**
+     * An integer indicating the number of times, in addition to the original dispense,
+     * (aka refills or repeats) that the patient can receive the prescribed medication.
+     */
+    numberOfRepeatsAllowed: number | null;
+    /**
+     * The amount that is to be dispensed for one fill.
+     */
+    quantity: Quantity | null;
+    /**
+     * Identifies the period time over which the supplied product is expected to be used,
+     * or the length of time the dispense is expected to last.
+     */
+    expectedSupplyDuration: Quantity | null;
+    /**
+     * Indicates the intended dispensing Organization specified by the prescriber.
+     */
+    performer: Reference<Organization> | null;
+};

package/dist/models/common/dispense-request.js

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

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

@@ -0,0 +1,68 @@
+import type { CodeableConcept } from "./codeable-concept.js";
+import type { Quantity } from "./quantity.js";
+import type { Range } from "./range.js";
+import type { Ratio } from "./ratio.js";
+import type { Timing } from "./timing.js";
+/**
+ * Represents dose and rate information for medication dosage.
+ *
+ * @category Models
+ * @title DoseAndRate
+ * @excerpt Dose and rate information for medication dosage
+ */
+export type DoseAndRate = {
+    /** Unique identifier for this dose and rate element */
+    id: string | null;
+    /** The kind of dose or rate specified */
+    type: CodeableConcept | null;
+    /** Amount of medication per dose as a range */
+    doseRange: Range | null;
+    /** Amount of medication per dose as a quantity */
+    doseQuantity: Quantity | null;
+    /** Amount of medication per unit of time as a quantity */
+    rateQuantity: Quantity | null;
+    /** Amount of medication per unit of time as a range */
+    rateRange: Range | null;
+    /** Amount of medication per unit of time as a ratio */
+    rateRatio: Ratio | null;
+};
+/**
+ * Represents dosage instruction for medication.
+ * Indicates how the medication is/was taken or should be taken by the patient.
+ *
+ * @category Models
+ * @title Dosage
+ * @excerpt Dosage instruction for medication
+ */
+export type Dosage = {
+    /** Unique identifier for this dosage element */
+    id: string | null;
+    /** Supplemental instruction or warnings to the patient */
+    additionalInstruction: (CodeableConcept | null)[] | null;
+    /** Take "as needed" (boolean) */
+    asNeededBoolean: boolean | null;
+    /** Take "as needed" for condition */
+    asNeededCodeableConcept: CodeableConcept | null;
+    /** Amount of medication administered */
+    doseAndRate: (DoseAndRate | null)[] | null;
+    /** Upper limit on medication per administration */
+    maxDosePerAdministration: Quantity | null;
+    /** Upper limit on medication per lifetime of the patient */
+    maxDosePerLifetime: Quantity | null;
+    /** Upper limit on medication per unit of time */
+    maxDosePerPeriod: Ratio | null;
+    /** Technique for administering medication */
+    method: CodeableConcept | null;
+    /** Patient or consumer oriented instructions */
+    patientInstruction: string | null;
+    /** How drug should enter body */
+    route: CodeableConcept | null;
+    /** The order of the dosage instructions */
+    sequence: number | null;
+    /** Body site to administer to */
+    site: CodeableConcept | null;
+    /** Free text dosage instructions */
+    text: string | null;
+    /** When medication should be administered */
+    timing: Timing | null;
+};

package/dist/models/common/dosage.js

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

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

@@ -0,0 +1,23 @@
+import { EndpointStatus } from "../enums/endpoint-status.js";
+import { Coding } from "./coding.js";
+import { Identifier } from "./identifier.js";
+/**
+ * Represents a technical endpoint for communication.
+ * Contains connection details for accessing external systems or services.
+ *
+ * @category Models
+ * @title Endpoint
+ * @excerpt Technical endpoint for external system communication
+ */
+export type Endpoint = {
+    /** Human-readable name for the endpoint */
+    name: string | null;
+    /** Current operational status of the endpoint */
+    status: EndpointStatus | null;
+    /** Network address or URL for the endpoint */
+    address: string | null;
+    /** Business identifiers for the endpoint */
+    identifier: Identifier[] | null;
+    /** Type of connection (e.g., HL7-FHIR-REST, DICOM-WADO-RS) */
+    connectionType: Coding | null;
+};

package/dist/models/common/endpoint.js

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

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

@@ -0,0 +1,20 @@
+/**
+ * Represents an expression used in FHIR resources.
+ * Used for computed values and conditional logic.
+ *
+ * @category Models
+ * @title Expression
+ * @excerpt Represents an expression used in FHIR resources
+ */
+export type Expression = {
+    /** Natural language description */
+    description: string | null;
+    /** Short name assigned to expression */
+    name: string | null;
+    /** Expression language */
+    language: string | null;
+    /** Expression content */
+    expression: string | null;
+    /** Reference to expression definition */
+    reference: string | null;
+};

package/dist/models/common/expression.js

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

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

@@ -0,0 +1,49 @@
+import { CodeableConcept } from "./codeable-concept.js";
+import { Expression } from "./expression.js";
+import { Period } from "./period.js";
+import { Quantity } from "./quantity.js";
+import { Range } from "./range.js";
+import { Ratio } from "./ratio.js";
+import { Reference } from "./reference.js";
+/**
+ * Represents an extension to FHIR resources.
+ * Used to add additional data elements beyond the base resource definition.
+ *
+ * @category Models
+ * @title Extension
+ * @excerpt Represents an extension to FHIR resources
+ */
+export type Extension = {
+    /** Extension identifier */
+    id: string | null;
+    /** Extension URL */
+    url: string | null;
+    /** Boolean extension value */
+    valueBoolean: boolean | null;
+    /** Integer extension value */
+    valueInteger: number | null;
+    /** String extension value */
+    valueString: string | null;
+    /** DateTime extension value */
+    valueDateTime: string | null;
+    /** Code extension value */
+    valueCode: string | null;
+    /** URI extension value */
+    valueUri: string | null;
+    /** Expression extension value */
+    valueExpression: Expression | null;
+    /** CodeableConcept extension value */
+    valueCodeableConcept: CodeableConcept | null;
+    /** Reference extension value */
+    valueReference: Reference | null;
+    /** Quantity extension value */
+    valueQuantity: Quantity | null;
+    /** Ratio extension value */
+    valueRatio: Ratio | null;
+    /** Range extension value */
+    valueRange: Range | null;
+    /** Period extension value */
+    valuePeriod: Period | null;
+    /** Time extension value */
+    valueTime: string | null;
+};

package/dist/models/common/extension.js

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

package/dist/models/common/fhir-error.d.ts

@@ -0,0 +1,23 @@
+import { OperationOutcomeIssue } from "../../graphql/schema.js";
+/**
+ * FhirError model for the b.well SDK
+ *
+ * @category Models
+ * @title FhirError
+ * @excerpt FhirError model
+ */
+export type FhirError = {
+    code: string;
+    resource: FhirErrorResource;
+};
+/**
+ * FhirErrorResource model for the b.well SDK
+ *
+ * @category Models
+ * @title FhirErrorResource
+ * @excerpt FhirErrorResource model
+ */
+export type FhirErrorResource = {
+    resourceType: string;
+    issue: OperationOutcomeIssue[];
+};

package/dist/models/common/fhir-error.js

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

package/dist/models/common/human-name.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Represents a human name with various components.
+ * Used across all models to represent person names with full FHIR compatibility.
+ *
+ * @category Models
+ * @title HumanName
+ * @excerpt Represents a human name with various components
+ */
+export type HumanName = {
+    /** Full name as text */
+    text: string | null;
+    /** Family name (surname) */
+    family: string | null;
+    /** Given names (first name, middle names) */
+    given: (string | null)[] | null;
+    /** Name prefixes (titles) */
+    prefix: (string | null)[] | null;
+    /** Name suffixes */
+    suffix: (string | null)[] | null;
+};

package/dist/models/common/human-name.js

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

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

@@ -0,0 +1,19 @@
+import { CodeableConcept } from "./codeable-concept.js";
+/**
+ * Represents an identifier for uniquely identifying resources.
+ * Used to provide business identifiers for FHIR resources.
+ *
+ * @category Models
+ * @title Identifier
+ * @excerpt Represents an identifier for uniquely identifying resources
+ */
+export type Identifier = {
+    /** Unique id for the identifier */
+    id: string | null;
+    /** The namespace for the identifier value */
+    system: string | null;
+    /** The value that is unique within the system */
+    value: string | null;
+    /** Type of identifier */
+    type: CodeableConcept | null;
+};

package/dist/models/common/identifier.js

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

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

@@ -0,0 +1,38 @@
+export * from "./fhir-error.js";
+export * from "./coding.js";
+export type { OperationOutcome } from "./operation-outcome.js";
+export type { Meta } from "./meta.js";
+export type { Identifier } from "./identifier.js";
+export type { CodeableConcept } from "./codeable-concept.js";
+export type { Quantity } from "./quantity.js";
+export type { Money } from "./money.js";
+export type { Attachment } from "./attachment.js";
+export type { Reference } from "./reference.js";
+export type { Extension } from "./extension.js";
+export type { Expression } from "./expression.js";
+export type { PagingInfo } from "./paging-info.js";
+export type { Period } from "./period.js";
+export type { HumanName } from "./human-name.js";
+export type { Narrative } from "./narrative.js";
+export type { Annotation } from "./annotation.js";
+export type { Address } from "./address.js";
+export type { ContactPoint } from "./contact-point.js";
+export type { ResourceBundle, EntryBundle, IdentifiedResourceEntry, SDKPagingInfo, HealthDataResponse, GroupedHealthDataResponse, } from "./bundle.js";
+export type { Location } from "./location.js";
+export type { Range } from "./range.js";
+export type { Ratio } from "./ratio.js";
+export type { Dosage, DoseAndRate } from "./dosage.js";
+export type { ReferenceRange } from "./reference-range.js";
+export type { Component } from "./component.js";
+export type { Score } from "./score.js";
+export type { Endpoint } from "./endpoint.js";
+export type { Organization, SearchResponseOrganization, } from "./organization.js";
+export type { Timing } from "./timing.js";
+export type { Specimen } from "./specimen.js";
+export type { ServiceRequest } from "./service-request.js";
+export type { Practitioner } from "./practitioner.js";
+export type { Patient } from "./patient.js";
+export type { PractitionerRole } from "./practitioner-role.js";
+export type { RelatedPerson } from "./related-person.js";
+export type { Medication } from "./medication.js";
+export type { DispenseRequest, InitialFill } from "./dispense-request.js";

package/dist/models/common/index.js

@@ -0,0 +1,2 @@
+export * from "./fhir-error.js";
+export * from "./coding.js";