Health Record Retrieval

Workflow Guide

This guide demonstrates how to retrieve a user’s associated health records.

Prerequisites

• Competed Authentication and Account Creation
• Established one or more connections

Concepts to Know Before Proceeding

Codings in Health Data Request Objects

In the b.well SDK, Coding plays a crucial role in representing standardized healthcare codes and identifiers from various terminologies. It ensures structured and consistent health data representation. Coding is essential in request objects, like AllergyIntolerancesRequest for example, for detailed and relevant search criteria.

See Codings in Health Data Request Objects

Summary of Resource Categories

The getHealthSummary method in the b.well SDK enables the retrieval of a comprehensive summary of current healthcare records by category. This summary includes a count of various health resources.

Allergy Intolerances

The getAllergyIntolerances method in the b.well SDK is designed to retrieve a comprehensive list of allergies and adverse reactions, adhering to the FHIR standard. This method provides access to clinical data about substances or conditions that cause hypersensitivity reactions, including medications, foods, environmental factors, and other allergens. Use getAllergyIntoleranceGroups to retrieve a list of grouped Allergy Intolerances.

Care Plans

The getCarePlans method in the b.well SDK is designed to retrieve a comprehensive list of care plans and treatment protocols, adhering to the FHIR standard. This method provides access to clinical data about coordinated healthcare activities, goals, and interventions designed to address specific health conditions or achieve desired health outcomes. Use getCarePlanGroups to retrieve a list of grouped Care Plans.

Care Teams

The getCareTeams method in the b.well SDK is designed to retrieve a comprehensive list of care teams and their members, adhering to the FHIR standard. This method provides access to clinical data about the healthcare professionals, organizations, and individuals involved in coordinating and delivering care for a patient, including their roles and responsibilities.

Conditions

The getConditions method in the b.well SDK is designed to retrieve a comprehensive list of medical conditions and diagnoses, adhering to the FHIR standard. This method provides access to clinical data about various health issues, ailments, or diseases. Use getConditionGroups to retrieve a list of grouped Conditions.

Diagnostic Reports

The getDiagnosticReports method in the b.well SDK is designed to retrieve a comprehensive list of diagnostic reports and their findings, adhering to the FHIR standard. This method provides access to clinical data about laboratory tests, imaging studies, pathology results, and other diagnostic investigations, including interpretations and conclusions. Use getDiagnosticReportLabGroups to retrieve a list of grouped Diagnostic Reports.

Encounters

The getEncounters method in the b.well SDK is designed to retrieve a comprehensive list of healthcare encounters and visits, adhering to the FHIR standard. This method provides access to clinical data about interactions between patients and healthcare providers, including office visits, hospital admissions, emergency room visits, and virtual consultations. Use getEncounterGroups to retrieve a list of grouped Encounters.

Immunizations

The getImmunizations method in the b.well SDK is designed to retrieve a comprehensive list of immunizations and vaccinations, adhering to the FHIR standard. This method provides access to clinical data about vaccines administered to a patient, including vaccination history, dates, dosages, and immunization status. Use getImmunizationGroups to retrieve a list of grouped Immunizations.

Labs

The getLabs method in the b.well SDK is designed to retrieve a comprehensive list of laboratory results and observations, adhering to the FHIR standard. This method provides access to clinical data about laboratory tests, measurements, and findings, including blood work, urinalysis, microbiology cultures, and other diagnostic laboratory services. Use getLabGroups to retrieve a list of grouped Labs.

Medications

🚧

getMedicationStatements is currently only available in v1 of the Typescript SDK, but will be available in v2 in Oct 2025.

The getMedicationStatements method in the b.well SDK is designed to retrieve a comprehensive list of medications a patient is taking or has taken, adhering to the FHIR standard. This method provides access to clinical data about a patient's medication usage, including self-reported medications, historical medication records, and current medication regimens.

The getMedicationRequests method in the b.well SDK is designed to retrieve a comprehensive list of medication orders and prescriptions, adhering to the FHIR standard. This method provides access to clinical data about medications that have been prescribed or requested for a patient, including dosage instructions, refill information, and prescriber details.

The getMedicationDispenses method in the b.well SDK is designed to retrieve a comprehensive list of medications that have been dispensed to a patient, adhering to the FHIR standard. This method provides access to pharmacy data about when and how medications were provided to the patient, including dispensing dates, quantities, and pharmacy details.

Use getMedicationGroups to retrieve a list of grouped Medications.

Procedures

The getProcedures method in the b.well SDK is designed to retrieve a comprehensive list of medical procedures and interventions performed on or for a patient, adhering to the FHIR standard. This method provides access to clinical data about surgical operations, diagnostic tests, therapeutic treatments, and other healthcare activities that have been completed, are in progress, or are planned. Use getProcedureGroups to retrieve a list of grouped Procedures.

Vital Signs

The getVitalSigns method in the b.well SDK is designed to retrieve a comprehensive list of vital sign measurements and observations, adhering to the FHIR standard. This method provides access to clinical data about key physiological indicators, including blood pressure, heart rate, temperature, respiratory rate, oxygen saturation, and body measurements. Use getVitalSignGroups to retrieve a list of grouped Vital Signs.

For complete request and response schema, see HealthManager documentation.