@icanbwell/bwell-sdk-ts 1.54.0-rc.1766515022 → 1.55.0

package/dist/models/health-data/medication-request.d.ts

@@ -0,0 +1,107 @@
+import type { CodeableConcept, DispenseRequest, Dosage, EntryBundle, HealthDataResponse, Identifier, Medication, Meta, Narrative, Patient, Practitioner, Reference } from "../common/index.js";
+import type { Encounter } from "./index.js";
+/**
+ * Represents a medication request resource.
+ * An order or request for both supply of the medication and the instructions for
+ * administration of the medication to a patient.
+ *
+ * @category Models
+ * @title MedicationRequest
+ * @excerpt Represents a medication request resource.
+ */
+export type MedicationRequest = {
+    /** Resource type */
+    resourceType: string | null;
+    /**
+     * The logical id of the resource.
+     */
+    id: string;
+    /**
+     * The metadata about the resource.
+     */
+    meta: Meta | null;
+    /**
+     * A code specifying the current state of the order.
+     */
+    status: string | null;
+    /**
+     * Indicates the type of medication request (for example, where the medication is expected to be consumed or administered).
+     */
+    category: (CodeableConcept | null)[] | null;
+    /**
+     * Identifiers associated with this medication request.
+     */
+    identifier: (Identifier | null)[] | null;
+    /**
+     * Whether the request is a proposal, plan, or an original order.
+     */
+    intent: string | null;
+    /**
+     * The base language in which the resource is written.
+     */
+    language: string | null;
+    /**
+     * Identifies the medication being requested.
+     */
+    medicationCodeableConcept: CodeableConcept | null;
+    /**
+     * Identifies the medication being requested.
+     */
+    medicationReference: Reference<Medication> | null;
+    /**
+     * A human-readable narrative that contains a summary of the resource.
+     */
+    text: Narrative | null;
+    /**
+     * A link to a resource representing the person or group to whom the medication will be given.
+     */
+    subject: Reference<Patient> | null;
+    /**
+     * The individual, organization, or device that initiated the request and has responsibility for its activation.
+     */
+    requester: Reference<Practitioner> | null;
+    /**
+     * The person who entered the order on behalf of another individual.
+     */
+    recorder: Reference<Practitioner> | null;
+    /**
+     * The encounter or episode of care that provides additional context for this request.
+     */
+    encounter: Reference<Encounter> | null;
+    /**
+     * The date (and perhaps time) when the prescription was initially written or authored on.
+     */
+    authoredOn: string | null;
+    /**
+     * Indicates how the medication is to be used by the patient.
+     */
+    dosageInstruction: (Dosage | null)[] | null;
+    /**
+     * Indicates the specific details for the dispense or medication supply part of a medication request.
+     */
+    dispenseRequest: DispenseRequest | null;
+    /**
+     * The reason or the indication for ordering or not ordering the medication.
+     */
+    reasonCode: (CodeableConcept | null)[] | null;
+    /**
+     * The description of the overall pattern of the administration of the medication to the patient.
+     */
+    courseOfTherapyType: CodeableConcept | null;
+};
+/**
+ * Bundle of medication request results.
+ *
+ * @category Models
+ * @title MedicationRequestBundle
+ * @excerpt Bundle of medication request results.
+ */
+export type MedicationRequestBundle = EntryBundle<MedicationRequest>;
+/**
+ * Response for medication request search results with paging info.
+ *
+ * @category Models
+ * @title MedicationRequestResponse
+ * @excerpt Response for medication request search results with paging info.
+ */
+export type MedicationRequestResponse = HealthDataResponse<MedicationRequest>;

package/dist/models/health-data/medication-request.js

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

package/dist/models/health-data/medication-statement.d.ts

@@ -0,0 +1,68 @@
+import type { CodeableConcept, Dosage, EntryBundle, HealthDataResponse, Meta, Period, Reference } from "../common/index.js";
+/**
+ * Represents a medication statement resource.
+ * A record of a medication that is being consumed by a patient.
+ * A MedicationStatement may indicate that the patient may be taking the medication now
+ * or has taken the medication in the past or will be taking the medication in the future.
+ *
+ * @category Models
+ * @title MedicationStatement
+ * @excerpt Represents a medication statement resource indicating a patient's medication usage.
+ */
+export type MedicationStatement = {
+    /** Resource type */
+    resourceType: string | null;
+    /**
+     * The logical id of the resource.
+     */
+    id: string;
+    /**
+     * The metadata about the resource.
+     */
+    meta: Meta | null;
+    /**
+     * A code representing the patient or other source's judgment about the state of
+     * the medication used that this statement is about. Generally, this will be
+     * active or completed.
+     */
+    status: string | null;
+    /**
+     * Identifies the medication being consumed.
+     */
+    medicationCodeableConcept: CodeableConcept | null;
+    /**
+     * A reason for why the medication is being/was taken.
+     */
+    reasonCode: (CodeableConcept | null)[] | null;
+    /**
+     * The interval of time during which it is being asserted that the patient
+     * is/was/will be taking the medication (or was not taking, when the
+     * MedicationStatement.taken element is No).
+     */
+    effectivePeriod: Period | null;
+    /**
+     * Indicates how the medication is/was or should be taken by the patient.
+     */
+    dosage: (Dosage | null)[] | null;
+    /**
+     * Allows linking the MedicationStatement to the underlying MedicationRequest,
+     * or to other information that supports or is used to derive the MedicationStatement.
+     */
+    derivedFrom: (Reference | null)[] | null;
+};
+/**
+ * Bundle of medication statement results.
+ *
+ * @category Models
+ * @title MedicationStatementBundle
+ * @excerpt Bundle of medication statement results.
+ */
+export type MedicationStatementBundle = EntryBundle<MedicationStatement>;
+/**
+ * Response for medication statement search results with paging info.
+ *
+ * @category Models
+ * @title MedicationStatementResponse
+ * @excerpt Response for medication statement search results with paging info.
+ */
+export type MedicationStatementResponse = HealthDataResponse<MedicationStatement>;

package/dist/models/health-data/medication-statement.js

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

package/dist/models/health-data/observation.d.ts

@@ -0,0 +1,102 @@
+import { Organization, Patient, Practitioner } from "../common/index.js";
+import { Value } from "../common/value.js";
+import { Annotation, CodeableConcept, Component, Encounter, HumanName, Identifier, Meta, Narrative, Period, Reference, ReferenceRange, ServiceRequest, Specimen } from "../index.js";
+/**
+ * Represents a observation resource.
+ *
+ * @category Models
+ * @title Observation
+ * @excerpt Represents an observation resource.
+ */
+export type Observation = Value & {
+    /** A set of rules under which this content was created */
+    resourceType: string | null;
+    /** Logical id of this artifact */
+    id: string;
+    /** Business identifiers for this observation */
+    identifier: (Identifier | null)[] | null;
+    /** Metadata about the resource */
+    meta: Meta | null;
+    /** Text summary of the resource, for human interpretation */
+    text: Narrative | null;
+    /** Status of the observation */
+    status: string | null;
+    /** Category of the observation */
+    category: (CodeableConcept | null)[] | null;
+    /** The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation. */
+    subject: Reference<ObservationSubject> | null;
+    /** The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. */
+    issued: string | null;
+    /** A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed. */
+    basedOn: (Reference<ObservationBasedOn> | null)[] | null;
+    /** Describes what was observed. Sometimes this is called the observation "name". */
+    code: CodeableConcept | null;
+    /** Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. */
+    referenceRange: (ReferenceRange | null)[] | null;
+    /** A categorical assessment of an observation value. For example, high, low, normal. */
+    interpretation: (CodeableConcept | null)[] | null;
+    /** Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations */
+    component: (ObservationComponent | null)[] | null;
+    /** The date and time the observation was made */
+    effectiveDateTime: string | null;
+    /** The period over which the observation was made */
+    effectivePeriod: Period | null;
+    /** Comments about the observation or the results. */
+    note: (Annotation | null)[] | null;
+    /** Who was responsible for asserting the observed value as "true". */
+    performer: (Reference<ObservationPerformer> | null)[] | null;
+    /** This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group. */
+    hasMember: (Reference<ObservationHasMember> | null)[] | null;
+    /** The specimen that was used when this observation was made. */
+    specimen: Reference<Specimen> | null;
+    /** Provides a reason why the expected value in the element Observation.value[x] is missing. */
+    dataAbsentReason: CodeableConcept | null;
+    /** The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.  */
+    encounter: Reference<Encounter> | null;
+};
+export type ObservationBasedOn = ServiceRequest;
+export type ObservationHasMember = ObservationHasMemberObservation;
+/**
+ * Represents an Observation that is a member of a group observation.
+ *
+ * @category Models
+ * @type ObservationHasMemberObservation
+ * @excerpt Member Observation in Group
+ */
+type ObservationHasMemberObservation = {
+    /** Logical id of the member observation. */
+    id: string | null;
+    /** Code describing the member observation. */
+    code: CodeableConcept | null;
+};
+/**
+ * Represents the performer of the observation, which can be a practitioner, patient, or organization.
+ *
+ * @category Models
+ * @type ObservationPerformer
+ * @excerpt Performer of Observation
+ */
+export type ObservationPerformer = Patient | Practitioner | Organization;
+/**
+ * Represents a component observation, combining Value and Component properties.
+ *
+ * @category Models
+ * @type ObservationComponent
+ * @excerpt Component Observation
+ */
+type ObservationComponent = Value & Component;
+type ObservationSubject = ObservationSubjectPatient;
+/**
+ * Represents a patient who is the subject of the observation.
+ *
+ * @category Models
+ * @type ObservationSubjectPatient
+ * @excerpt Subject Patient for Observation
+ */
+type ObservationSubjectPatient = {
+    /** The GraphQL typename for the patient. */
+    __typename: "Patient";
+    /** Name(s) of the patient. */
+    name: (HumanName | null)[] | null;
+};
+export {};

package/dist/models/health-data/observation.js

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

package/dist/models/health-data/procedure-group.d.ts

@@ -0,0 +1,43 @@
+import type { Coding, GroupedHealthDataResponse, ResourceBundle } from "../common/index.js";
+/**
+ * Bundle containing procedure group data with paging information.
+ * Maps exactly to GraphQL GetProcedureGroupsQueryResults structure.
+ *
+ * @category Models
+ * @title ProcedureGroupBundle
+ * @excerpt Bundle containing procedure group data with paging information
+ */
+export type ProcedureGroupBundle = ResourceBundle<ProcedureGroup>;
+/**
+ * Response for grouped procedure data with paging information.
+ *
+ * @category Models
+ * @title ProcedureGroupsResponse
+ * @excerpt Response for grouped procedure data with paging information
+ */
+export type ProcedureGroupsResponse = GroupedHealthDataResponse<ProcedureGroup>;
+/**
+ * Represents a procedure group resource matching GraphQL structure.
+ *
+ * @category Models
+ * @title ProcedureGroup
+ * @excerpt Represents a procedure group resource matching GraphQL structure
+ */
+export interface ProcedureGroup {
+    /** Resource identifier */
+    id: string;
+    /** Group name */
+    name: string;
+    /** References to underlying resources */
+    references: string[];
+    /** Performer information */
+    performer: string[];
+    /** Performed date */
+    performedDate: string;
+    /** Source information */
+    source: string[];
+    /** Source display names */
+    sourceDisplay: string[];
+    /** Coding information */
+    coding: Coding;
+}

package/dist/models/health-data/procedure-group.js

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

package/dist/models/health-data/procedure.d.ts

@@ -0,0 +1,84 @@
+import { EntryBundle, HealthDataResponse } from "../common/bundle.js";
+import { Annotation, CodeableConcept, Identifier, Location, Meta, Narrative, Organization, Patient, Period, Practitioner, Reference } from "../common/index.js";
+import { Encounter } from "../index.js";
+/**
+ * Represents a clinical procedure performed on a patient.
+ *
+ * @category Models
+ * @title Procedure
+ * @excerpt Represents a clinical procedure performed on a patient.
+ */
+export type Procedure = {
+    /** The type of resource. */
+    resourceType: "Procedure";
+    /** Logical id of the procedure resource. */
+    id: string;
+    /** Identifiers for the procedure. */
+    identifier: (Identifier | null)[] | null;
+    /** Metadata about the resource. */
+    meta: Meta | null;
+    /** Text summary of the resource, for human interpretation. */
+    text: Narrative | null;
+    /** Additional notes or comments about the procedure. */
+    note: (Annotation | null)[] | null;
+    /** The status of the procedure (e.g., completed, in-progress). */
+    status: string | null;
+    /** Classification of the procedure (e.g., surgical, diagnostic). */
+    category: CodeableConcept | null;
+    /** Specific procedure code (e.g., CPT, SNOMED). */
+    code: CodeableConcept | null;
+    /** Location where the procedure was performed. */
+    location: Reference<Location> | null;
+    /** Date and time when the procedure was performed. */
+    performedDateTime: string | null;
+    /** Period during which the procedure was performed. */
+    performedPeriod: Period | null;
+    /** Free-text description of when the procedure was performed. */
+    performedString: string | null;
+    /** List of people and organizations who performed the procedure. */
+    performer: (ProcedurePerformer | null)[] | null;
+    /** Reason codes for why the procedure was performed. */
+    reasonCode: (CodeableConcept | null)[] | null;
+    /** Anatomical site(s) on the patient where the procedure was performed. */
+    bodySite: (CodeableConcept | null)[] | null;
+    /** The result or outcome of the procedure. */
+    outcome: CodeableConcept | null;
+    /** Instructions or follow-up actions after the procedure. */
+    followUp: (CodeableConcept | null)[] | null;
+    /** Complications that occurred during or after the procedure. */
+    complication: (CodeableConcept | null)[] | null;
+    /** The patient on whom the procedure was performed. */
+    subject: Reference<Patient> | null;
+    /** The person who recorded the procedure. */
+    recorder: Reference<Patient | Practitioner> | null;
+    /** The person who asserted the procedure as having been performed. */
+    asserter: Reference<Patient | Practitioner> | null;
+    /** The encounter during which this procedure was performed or created.  */
+    encounter: Reference<Encounter> | null;
+};
+/**
+ * Indicates who performed the procedure.
+ *
+ * @category Models
+ * @title ProcedurePerformer
+ * @excerpt Indicates organization/practitioner who performed the procedure.
+ */
+export type ProcedurePerformer = {
+    actor: Reference<Practitioner | Organization> | null;
+};
+/**
+ * Bundle of procedure search results.
+ *
+ * @category Models
+ * @title ProcedureBundle
+ * @excerpt Bundle of procedure search results
+ */
+export type ProcedureBundle = EntryBundle<Procedure>;
+/**
+ * Response for procedure search results with paging info.
+ *
+ * @category Models
+ * @title ProcedureResponse
+ * @excerpt Response for procedure search results with paging info.
+ */
+export type ProcedureResponse = HealthDataResponse<Procedure>;

package/dist/models/health-data/procedure.js

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

package/dist/models/health-data/vital-sign-bundle.d.ts

@@ -0,0 +1,18 @@
+import { EntryBundle, HealthDataResponse } from "../common/bundle.js";
+import { Observation } from "../index.js";
+/**
+ * Bundle of vital sign search results.
+ *
+ * @category Models
+ * @title VitalSignBundle
+ * @excerpt Bundle of vital sign search results
+ */
+export type VitalSignBundle = EntryBundle<Observation>;
+/**
+ * Response for vital sign search results with paging info.
+ *
+ * @category Models
+ * @title VitalSignResponse
+ * @excerpt Response for vital sign search results with paging info.
+ */
+export type VitalSignResponse = HealthDataResponse<Observation>;

package/dist/models/health-data/vital-sign-bundle.js

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

package/dist/models/health-data/vital-sign-group.d.ts

@@ -0,0 +1,51 @@
+import type { CodeableConcept, Coding, Component, Extension, GroupedHealthDataResponse, ReferenceRange, ResourceBundle } from "../common/index.js";
+/**
+ * Bundle containing vital sign group data with paging information.
+ * Maps exactly to GraphQL GetVitalSignGroupsQueryResults structure.
+ *
+ * @category Models
+ * @title VitalSignGroupBundle
+ * @excerpt Bundle containing vital sign group data with paging...
+ */
+export type VitalSignGroupBundle = ResourceBundle<VitalSignGroup>;
+/**
+ * Response for grouped vital sign data with paging information.
+ *
+ * @category Models
+ * @title VitalSignGroupsResponse
+ * @excerpt Response for grouped vital sign data with paging information
+ */
+export type VitalSignGroupsResponse = GroupedHealthDataResponse<VitalSignGroup>;
+/**
+ * Represents a vital sign group resource matching GraphQL structure.
+ *
+ * @category Models
+ * @title VitalSignGroup
+ * @excerpt Represents a vital sign group resource matching GraphQL...
+ */
+export interface VitalSignGroup {
+    /** Resource identifier */
+    id: string;
+    /** Group name */
+    name: string;
+    /** Source information */
+    source: string[];
+    /** Source display names */
+    sourceDisplay: string[];
+    /** Effective date time */
+    effectiveDateTime: string;
+    /** References to underlying resources */
+    references: string[];
+    /** Category information */
+    category: CodeableConcept[];
+    /** Coding information */
+    coding: Coding;
+    /** Interpretation information */
+    interpretation: CodeableConcept[];
+    /** Value information */
+    value: Extension;
+    /** Reference range */
+    referenceRange: ReferenceRange[];
+    /** Component information */
+    component: Component[];
+}

package/dist/models/health-data/vital-sign-group.js

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

package/dist/models/health-space/appointment-bundle.d.ts

@@ -0,0 +1,11 @@
+import type { EntryBundle } from "../common/index.js";
+import { Appointment } from "./appointment.js";
+/**
+ * Bundle containing appointment search results.
+ * Used for paginated appointment queries with entries.
+ *
+ * @category Models
+ * @title AppointmentBundle
+ * @excerpt Bundle containing appointment search results
+ */
+export type AppointmentBundle = EntryBundle<Appointment>;

package/dist/models/health-space/appointment-bundle.js

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

package/dist/models/health-space/appointment-participant.d.ts

@@ -0,0 +1,17 @@
+import { CodeableConcept, Location, Reference } from "../common/index.js";
+/**
+ * Participant in an appointment.
+ * Represents individuals or entities involved in the scheduled appointment.
+ *
+ * @category Models
+ * @title AppointmentParticipant
+ * @excerpt Participant in an appointment
+ */
+export type AppointmentParticipant = {
+    /** Unique participant identifier */
+    id: string | null;
+    /** Type of participant (patient, provider, etc.) */
+    type: (CodeableConcept | null)[] | null;
+    /** Reference to the actual participant */
+    actor: Reference<Location> | null;
+};

package/dist/models/health-space/appointment-participant.js

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

package/dist/models/health-space/appointment-update.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Appointment update result.
+ * Returned when an appointment is successfully updated (e.g., cancelled).
+ *
+ * @category Models
+ * @title AppointmentUpdate
+ * @excerpt Appointment update result
+ */
+export type AppointmentUpdate = {
+    /** Unique appointment identifier */
+    id: string;
+    /** Current appointment status */
+    status: string | null;
+};

package/dist/models/health-space/appointment-update.js

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

package/dist/models/health-space/appointment.d.ts

@@ -0,0 +1,30 @@
+import { CodeableConcept, Extension, Reference } from "../common/index.js";
+import type { AppointmentParticipant } from "./appointment-participant.js";
+/**
+ * Healthcare appointment resource.
+ * Represents a scheduled meeting between patients and healthcare providers.
+ *
+ * @category Models
+ * @title Appointment
+ * @excerpt Healthcare appointment resource
+ */
+export type Appointment = {
+    /** Unique appointment identifier */
+    id: string;
+    /** Current appointment status */
+    status: string | null;
+    /** Appointment start time */
+    start: string | null;
+    /** Appointment end time */
+    end: string | null;
+    /** Reason for cancellation (if applicable) */
+    cancelationReason: CodeableConcept | null;
+    /** Additional appointment extensions */
+    extension: (Extension | null)[] | null;
+    /** Type of service being performed */
+    serviceType: (CodeableConcept | null)[] | null;
+    /** Supporting information references */
+    supportingInformation: (Reference | null)[] | null;
+    /** Appointment participants */
+    participant: (AppointmentParticipant | null)[] | null;
+};

package/dist/models/health-space/appointment.js

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

package/dist/models/health-space/cancellation-reasons.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Concept within cancellation reason code system.
+ * Represents individual cancellation reason codes and descriptions.
+ *
+ * @category Models
+ * @title CancellationReasonConcept
+ * @excerpt Concept within cancellation reason code system
+ */
+export type CancellationReasonConcept = {
+    /** Cancellation reason code */
+    code: string | null;
+    /** Human-readable display text */
+    display: string | null;
+};
+/**
+ * Code system containing cancellation reasons.
+ * Provides standardized reasons for appointment cancellation.
+ *
+ * @category Models
+ * @title CancellationReasons
+ * @excerpt Code system containing cancellation reasons
+ */
+export type CancellationReasons = {
+    /** Unique code system identifier */
+    id: string;
+    /** Code system title */
+    title: string | null;
+    /** Code system URL */
+    url: string | null;
+    /** List of cancellation reason concepts */
+    concept: (CancellationReasonConcept | null)[] | null;
+};

package/dist/models/health-space/cancellation-reasons.js

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

package/dist/models/health-space/index.d.ts

@@ -0,0 +1,5 @@
+export type { Appointment } from "./appointment.js";
+export type { AppointmentUpdate } from "./appointment-update.js";
+export type { AppointmentBundle } from "./appointment-bundle.js";
+export type { AppointmentParticipant } from "./appointment-participant.js";
+export type { CancellationReasons, CancellationReasonConcept, } from "./cancellation-reasons.js";

package/dist/models/health-space/index.js

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

package/dist/models/identity/auth-tokens.d.ts

@@ -0,0 +1,25 @@
+/**
+ * AuthTokens model representing the set of authentication tokens required
+ * for secure API access and user authentication.
+ *
+ * @category Models
+ * @title AuthTokens
+ * @excerpt Authentication tokens for API access
+ */
+export type AuthTokens = {
+    /**
+     * The access token used to authenticate API requests. This token provides
+     * the necessary authorization to access protected resources.
+     */
+    accessToken: string;
+    /**
+     * The identity token containing user identity information and claims.
+     * This token is typically used for user identification and authentication.
+     */
+    idToken: string;
+    /**
+     * The refresh token used to obtain new access tokens when the current
+     * access token expires, enabling seamless token renewal.
+     */
+    refreshToken: string;
+};

package/dist/models/identity/auth-tokens.js

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