@icanbwell/bwell-sdk-ts 2.0.0-alpha.0-rc.1757362315 → 2.0.0-alpha.0-rc.1757691388

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

@@ -20,6 +20,10 @@ export interface ContactPoint {
      * 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.

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

@@ -14,6 +14,8 @@ import { Reference } from "./reference.js";
  * @excerpt Represents an extension to FHIR resources
  */
 export type Extension = {
+    /** Extension identifier */
+    id: string | null;
     /** Extension URL */
     url: string | null;
     /** Boolean extension value */

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

@@ -23,4 +23,9 @@ 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 } from "./organization.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";

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

@@ -1,4 +1,5 @@
 import { Address } from "./address.js";
+import { CodeableConcept } from "./codeable-concept.js";
 import { ContactPoint } from "./contact-point.js";
 import { Identifier } from "./identifier.js";
 import { Reference } from "./reference.js";
@@ -29,6 +30,8 @@ export type Location = {
     id: string;
     /** Display name */
     name: string | null;
+    /** Alternate names */
+    alias: (string | null)[] | null;
     /** Resource description */
     description: string | null;
     /** Business identifiers */
@@ -41,4 +44,6 @@ export type Location = {
     position: LocationPosition | null;
     /** Managing organization reference */
     managingOrganization: Reference;
+    /** Indicates the type of function performed at the location. */
+    type: (CodeableConcept | null)[] | null;
 };

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

@@ -1,4 +1,5 @@
 import { Endpoint } from "./endpoint.js";
+import { Address, ContactPoint, Identifier, Reference } from "./index.js";
 /**
  * Represents a healthcare organization.
  *
@@ -7,6 +8,27 @@ import { Endpoint } from "./endpoint.js";
  * @excerpt Healthcare organization with name and endpoints
  */
 export type Organization = {
+    /** Resource type */
+    resourceType: string | null;
+    /** Organization identifiers */
+    identifier: (Identifier | null)[] | null;
+    /** Organization name */
+    name: string | null;
+    /** Organization endpoints */
+    endpoint: (Reference<Endpoint> | null)[] | null;
+    /** Organization address */
+    address: (Address | null)[] | null;
+    /** Contact information */
+    telecom: (ContactPoint | null)[] | null;
+};
+/**
+ * Represents a healthcare organization.
+ *
+ * @category Models
+ * @title SearchResponseOrganization
+ * @excerpt Healthcare organization with name and endpoints
+ */
+export type SearchResponseOrganization = {
     /** Organization name */
     name: string | null;
     /** Organization endpoints */

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

@@ -0,0 +1,13 @@
+import { HumanName } from "./index.js";
+/**
+ * Represents a patient resource.
+ * @category Models
+ * @type Patient
+ * @excerpt Patient Resource
+ */
+export type Patient = {
+    /** The GraphQL typename for the patient. */
+    __typename: "Patient";
+    /** Name(s) of the patient. */
+    name: (HumanName | null)[] | null;
+};

package/dist/models/common/patient.js

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

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

@@ -0,0 +1,15 @@
+import { HumanName, Identifier } from "./index.js";
+/**
+ * Represents a practitioner resource.
+ * @category Models
+ * @type Practitioner
+ * @excerpt Practitioner Resource
+ */
+export type Practitioner = {
+    /** The GraphQL typename for the practitioner. */
+    __typename: "Practitioner";
+    /** Name(s) of the practitioner. */
+    name: (HumanName | null)[] | null;
+    /** Identifiers for the practitioner. */
+    identifier: (Identifier | null)[] | null;
+};

package/dist/models/common/practitioner.js

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

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

@@ -0,0 +1,21 @@
+import { CodeableConcept } from "./index.js";
+/**
+ * A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.
+ * @category Models
+ * @title ServiceRequest
+ * @excerpt A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.
+ */
+export type ServiceRequest = {
+    /**
+     * The type of the FHIR resource. Should be 'ServiceRequest'.
+     */
+    resourceType: string | null;
+    /**
+     * The id of the resource.
+     */
+    id: string | null;
+    /**
+     * An explanation or justification for why this service is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in `supportingInfo`.
+     */
+    reasonCode: (CodeableConcept | null)[] | null;
+};

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

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

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

@@ -0,0 +1,13 @@
+import { CodeableConcept, Identifier } from "./index.js";
+/**
+ * A sample to be used for analysis
+ *
+ * @category Models
+ * @title Specimen
+ * @excerpt A sample to be used for analysis
+ */
+export type Specimen = {
+    identifier: (Identifier | null)[] | null;
+    accessionIdentifier: Identifier | null;
+    type: CodeableConcept | null;
+};

package/dist/models/common/specimen.js

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

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/health-data/care-plan.d.ts

@@ -0,0 +1,134 @@
+import type { Annotation, CodeableConcept, EntryBundle, IdentifiedResourceEntry, Identifier, Meta, Narrative, Period, Reference } from "../common/index.js";
+import { Timing } from "../common/timing.js";
+import { Condition } from "./condition.js";
+/**
+ * Represents a care plan resource.
+ *
+ * @category Models
+ * @title CarePlan
+ * @excerpt Represents a care plan resource.
+ */
+export type CarePlan = {
+    /** A set of rules under which this content was created */
+    resourceType: string | null;
+    /** Logical id of this artifact */
+    id: string;
+    /** Identifiers for this care plan */
+    identifier: (Identifier | null)[] | null;
+    /** Metadata about the resource */
+    meta: Meta | null;
+    /** Text summary of the resource, for human interpretation */
+    text: Narrative | null;
+    /** Human-readable description of the care plan */
+    description: string | null;
+    /** Human-friendly name for the care plan.*/
+    title: string | null;
+    /**
+     * Identifies what "kind" of plan this is to support differentiation between
+     * multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma",
+     * "disease management", "wellness plan", etc.
+     */
+    category: (CodeableConcept | null)[] | null;
+    /** Indicates when the plan did (or is intended to) come into effect and end. */
+    period: Period | null;
+    /**
+     * Represents when this particular CarePlan record was created in the system,
+     * which is often a system-generated date.
+     */
+    created: string | null;
+    /** General notes about the care plan not covered elsewhere. */
+    note: (Annotation | null)[] | null;
+    /**
+     * Indicates whether the plan is currently being acted upon,
+     * represents future intentions or is now a historical record.
+     */
+    status: string | null;
+    /**
+     * Indicates the level of authority/intentionality associated
+     * with the care plan and where the care plan fits into the workflow chain.
+     */
+    intent: string | null;
+    /**
+     * Identifies a planned action to occur as part of the plan. For example,
+     * a medication to be used, lab tests to perform, self-monitoring,
+     * education, etc.
+     */
+    activity: (CarePlanActivity | null)[] | null;
+    /**
+     * Identifies the conditions/problems/concerns/diagnoses/etc. whose
+     * management and/or mitigation are handled by this plan.
+     */
+    addresses: (Reference<Condition> | null)[] | null;
+    /**
+     * Identifies the patient or group whose intended care is described by the plan.
+     */
+    subject: Reference | null;
+};
+/**
+ * Represents a planned activity within a care plan.
+ *
+ * @category Models
+ * @title CarePlanActivity
+ * @excerpt Represents a planned activity within a care plan
+ */
+export type CarePlanActivity = {
+    /**
+     * A simple summary of a planned activity suitable for a general care plan
+     * system (e.g. form driven) that doesn't know about specific resources such
+     * as procedure etc.
+     */
+    detail: CarePlanDetail | null;
+};
+/**
+ * A simple summary of a planned activity suitable for a general care plan
+ * system (e.g. form driven) that doesn't know about specific resources such
+ * as procedure etc.
+ *
+ * @category Models
+ * @title CarePlanDetail
+ * @excerpt A simple summary of a planned activity suitable for a general care plan system.
+ */
+export type CarePlanDetail = {
+    /**
+     * A description of the kind of resource the in-line definition of a care plan
+     * activity is representing. The CarePlan.activity.detail is an in-line definition
+     * when a resource is not referenced using CarePlan.activity.reference. For example,
+     * a MedicationRequest, a ServiceRequest, or a CommunicationRequest.
+     */
+    kind: string | null;
+    /**
+     * Detailed description of the type of planned activity; e.g. what lab test,
+     * what procedure, what kind of encounter.
+     */
+    code: CodeableConcept | null;
+    /** Identifies what progress is being made for the specific activity. */
+    status: string | null;
+    /**
+     * Indicates when the activity is scheduled to occur.
+     */
+    scheduledPeriod: Period | null;
+    /**
+     * Indicates when the activity is scheduled to occur (as a string).
+     */
+    scheduledString: string | null;
+    /** Indicates when the activity is scheduled to occur (as a timing). */
+    scheduledTiming: Timing | null;
+};
+/**
+ * Represents an entry in a care plan bundle.
+ * Contains a care plan resource and metadata.
+ *
+ * @category Models
+ * @title CarePlanEntry
+ * @excerpt Represents an entry in a care plan bundle
+ */
+export type CarePlanEntry = IdentifiedResourceEntry<CarePlan>;
+/**
+ * Bundle of care plan search results.
+ * Contains multiple care plan entries from search operations.
+ *
+ * @category Models
+ * @title CarePlanBundle
+ * @excerpt Bundle of care plan search results
+ */
+export type CarePlanBundle = EntryBundle<CarePlanEntry>;

package/dist/models/health-data/care-plan.js

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

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

@@ -0,0 +1,102 @@
+import type { Annotation, CodeableConcept, EntryBundle, Extension, IdentifiedResourceEntry, Identifier, Meta, Narrative, Patient, Period, Practitioner, Reference } from "../common/index.js";
+/**
+ * Represents a condition resource.
+ *
+ * @category Models
+ * @title Condition
+ * @excerpt Represents a condition resource.
+ */
+export type Condition = {
+    /** Resource type */
+    resourceType: string | null;
+    /**
+     * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
+     */
+    id: string;
+    /** Identifiers for this condition */
+    identifier: (Identifier | null)[] | null;
+    /**
+     * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
+     */
+    meta: Meta | null;
+    /** Text summary of the resource, for human interpretation. */
+    text: Narrative | null;
+    /** Additional condition extensions. */
+    extension: (Extension | null)[] | null;
+    /**
+     * Identification of the condition, problem or diagnosis.
+     */
+    code: CodeableConcept | null;
+    /**
+     * The clinical status of the condition.
+     */
+    clinicalStatus: CodeableConcept | null;
+    /**
+     * None
+     */
+    onsetDateTime: string | null;
+    /**
+     * The recordedDate represents when this particular Condition record was created in the system, which is often a system-generated date.
+     */
+    recordedDate: string | null;
+    /**
+     * Individual who recorded the record and takes responsibility for its content.
+     */
+    recorder: Reference<Patient | Practitioner> | null;
+    /**
+     * Additional information about the Condition. This is a general notes/comments entry  for description of the Condition, its diagnosis and prognosis.
+     */
+    note: (Annotation | null)[] | null;
+    /**
+     * None
+     */
+    onsetPeriod: Period | null;
+    /**
+     * None
+     */
+    abatementDateTime: string | null;
+    /**
+     * None
+     */
+    abatementPeriod: Period | null;
+    /**
+     * The patient the condition record is associated with.
+     */
+    subject: Reference<Patient> | null;
+    /**
+     * A category assigned to the condition.
+     */
+    category: CodeableConcept[] | null;
+    /**
+     * A subjective assessment of the severity of the condition as evaluated by the clinician.
+     */
+    severity: CodeableConcept | null;
+    /**
+     * The verification status to support the clinical status of the condition.
+     */
+    verificationStatus: CodeableConcept | null;
+    /**
+     * The anatomical location where this condition manifests itself.
+     */
+    bodySite: CodeableConcept[] | null;
+    /** Individual who is making the condition statement. */
+    asserter: Reference<Patient> | null;
+};
+/**
+ * Represents an entry in a condition bundle.
+ * Contains a condition resource and metadata.
+ *
+ * @category Models
+ * @title ConditionEntry
+ * @excerpt Represents an entry in a condition bundle
+ */
+export type ConditionEntry = IdentifiedResourceEntry<Condition>;
+/**
+ * Bundle of condition search results.
+ * Contains multiple conditions from search operations.
+ *
+ * @category Models
+ * @title ConditionBundle
+ * @excerpt Bundle of condition search results
+ */
+export type ConditionBundle = EntryBundle<ConditionEntry>;

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

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