Jump to Content
Home
Guides
API Reference
Changelog
Log In
API Reference
Log In
API Reference
User
All
Pages
Start typing to search…
JUMP TO
bwell User Data Operations
/users/{id}/data-exports
Initiate user data export
post
/users/{id}
Initiate user data deletion
del
Client Webhook API
Webhooks
/webhook
Receive a bwell webhook event
post
TypeScript SDK Overview
API Reference Overview
TypeScript SDK Core
TypeScript SDK Core
TypeScript SDK Managers
ConnectionManager
DeviceManager
FinancialManager
HealthManager
HealthSpaceManager
LanguageManager
QuestionnaireManager
SearchManager
UserManager
TypeScript SDK Requests
AllergyIntoleranceGroupsRequest
AllergyIntolerancesRequest
AppointmentsRequest
BinaryRequest
CancelAppointmentRequest
CancellationReasonsRequest
CarePlanGroupsRequest
CarePlansRequest
CareTeamsRequest
ConditionGroupsRequest
ConditionsRequest
ConnectionRequest
CoveragesRequest
CreateConsentRequest
CreateDataExportDirectDownloadUrlRequest
CreateVerificationUrlRequest
DataSourceRequest
DeregisterDeviceRequest
DiagnosticReportLabGroupsRequest
DiagnosticReportsRequest
DocumentReferencesRequest
EncounterGroupsRequest
EncountersRequest
ExplanationOfBenefitsRequest
GetConsentsRequest
HealthDataRequest
ImmunizationGroupsRequest
ImmunizationsRequest
LabGroupsRequest
LabKnowledgeRequest
LabsRequest
MedicationDispenseRequest
MedicationGroupsRequest
MedicationKnowledgeRequest
MedicationRequestRequest
MedicationStatementsRequest
NextQuestionRequest
PagedRequest
ProcedureGroupsRequest
ProceduresRequest
RegisterDeviceRequest
SearchHealthResourcesRequest
SubmitProviderForReviewRequest
UpdateProfileRequest
VitalSignGroupsRequest
VitalSignsRequest
TypeScript SDK Models
Address
AllergyIntolerance
AllergyIntoleranceBundle
AllergyIntoleranceGroup
AllergyIntoleranceGroupBundle
AllergyIntoleranceGroupsResponse
AllergyIntoleranceReaction
AllergyIntoleranceResponse
Annotation
Appointment
AppointmentBundle
AppointmentParticipant
AppointmentUpdate
Attachment
BaseConnection
Bookable
CancellationReasonConcept
CancellationReasons
CarePlan
CarePlanBundle
CarePlanGroup
CarePlanGroupBundle
CarePlanGroupResponse
CarePlanResponse
CareTeam
CareTeamBundle
CareTeamResponse
CodeableConcept
Coding
Component
Condition
ConditionBundle
ConditionGroup
ConditionGroupBundle
ConditionGroupsResponse
ConditionResponse
Connection
ConnectionStatus
Consent
ConsentBundle
ContactPoint
Coverage
CoverageBundle
CoverageClass
CoverageEntry
CoveragePayor
DataSource
DeviceRegistrationResults
DiagnosticReport
DiagnosticReportBundle
DiagnosticReportLabGroup
DiagnosticReportLabGroupBundle
DiagnosticReportLabGroupsResponse
DiagnosticReportResponse
DispenseRequest
Dosage
DoseAndRate
Encounter
EncounterBundle
EncounterGroup
EncounterGroupBundle
EncounterGroupsResponse
EncounterResponse
Endpoint
EntryBundle
ExplanationOfBenefit
ExplanationOfBenefitAdjudication
ExplanationOfBenefitBundle
ExplanationOfBenefitCareTeam
ExplanationOfBenefitDiagnosis
ExplanationOfBenefitEntry
ExplanationOfBenefitInsurance
ExplanationOfBenefitItem
ExplanationOfBenefitPayee
ExplanationOfBenefitPayment
ExplanationOfBenefitProcessNote
ExplanationOfBenefitRelated
ExplanationOfBenefitResponse
ExplanationOfBenefitSupportingInfo
ExplanationOfBenefitTotal
Expression
Extension
FhirError
FhirErrorResource
FilterValue
FilterValueMeta
GroupedHealthDataResponse
HealthDataResponse
HealthResource
HealthResourceLocation
HealthResourcesBundle
HealthSummary
HumanName
IdentifiedResourceEntry
Identifier
Immunization
ImmunizationBundle
ImmunizationGroup
ImmunizationGroupBundle
ImmunizationGroupsResponse
ImmunizationResponse
InitialFill
LabBundle
LabGroup
LabGroupBundle
LabGroupsResponse
LabKnowledge
LabKnowledgeResourceBundle
LabKnowledgeResponse
LabResponse
Location
Medication
MedicationDispense
MedicationDispenseBundle
MedicationDispenseResponse
MedicationGroup
MedicationGroupBundle
MedicationGroupsResponse
MedicationKnowledge
MedicationKnowledgeResourceBundle
MedicationGroupsResponse
MedicationPricing
MedicationPricingResponse
MedicationRequest
MedicationRequestBundle
MedicationRequestResponse
MedicationStatement
MedicationStatementBundle
MedicationStatementResponse
MemberConnection
Meta
Money
Narrative
OAuthUrl
Observation
OperationOutcome
Organization
PagingInfo
Patient
Period
Person
PractitionerRole
Procedure
ProcedureBundle
ProcedureGroup
ProcedureGroupBundle
ProcedureGroupsResponse
ProcedureResponse
ProviderReviewResult
Quantity
Questionnaire
QuestionnaireItem
QuestionnaireResponse
QuestionnaireResponseAnswer
QuestionnaireResponseItem
Range
Ratio
Reference
ReferenceRange
RelatedPerson
ResourceBundle
PaginatedBundle
Scheduling
Score
SearchResponseOrganization
ServiceRequest
Specimen
Timing
User
VerificationResult
VitalSignBundle
VitalSignGroup
VitalSignGroupBundle
VitalSignGroupsResponse
VitalSignResponse
Practitioner
TypeScript SDK Enums
CategoryCode
ConnectionCategory
ConsentProvisionType
ConsentStatus
DataConnectionStatus
DataConnectionType
DevicePlatform
EndpointStatus
FilterField
Gender
LogLevel
PersonGender
SearchContext
SearchResultType
SortField
SortOrder
SyncStatus
TypeScript SDK Inputs
AppointmentsRequestInput
CancelAppointmentRequestInput
CancellationReasonsRequestInput
ConnectionRequestInput
CoverageRequestInput
CreateConsentRequestInput
CreateDataExportDirectDownloadUrlRequestInput
CreateVerificationUrlRequestInput
DataSourceRequestInput
DeregisterDeviceRequestInput
ExplanationOfBenefitRequestInput
FieldSortOrder
GetConsentsRequestInput
HealthDataRequestInput
LabKnowledgeRequestInput
MedicationKnowledgeRequestInput
NextQuestionRequestInput
OrderBy
PagedRequestInput
RegisterDeviceRequestInput
SearchDate
SearchDateValue
SearchHealthResourcesRequestInput
SearchPosition
SearchString
SearchToken
SearchTokenValue
SubmitProviderForReviewRequestInput
UpdateProfileRequestInput
TypeScript SDK Errors
AuthenticationError
BWellError
BWellErrorOptions
IllegalArgumentError
IllegalStateError
InvalidClientKeyError
InvalidCredentialsTypeError
InvalidTokenError
NetworkError
OperationOutcomeError
UnknownError
ValidationError
TypeScript SDK Other
BWellConfig
BWellQueryResult
BWellTransactionFailure
BWellTransactionResult
BWellTransactionSuccess
InMemoryTokenStorage
TokenStorage
User
Ask AI
User identity mapping between bWell and client systems
