Skip to content

Api reference

components.medical_profile.public.commands

app_group

medical_profile_commands module-attribute

medical_profile_commands = AppGroup('medical_profile')

register_medical_profile_commands

register_medical_profile_commands()
Source code in components/medical_profile/public/commands/app_group.py
def register_medical_profile_commands() -> None:  # noqa: D103
    from components.medical_profile.public.commands.load_medical_profile_trait_definitions import (  # noqa: F401
        load_medical_profile_trait_definitions,
    )
    from components.medical_profile.public.commands.update_medical_profile_inferences import (  # noqa: F401
        update_medical_profile_inferences,
    )

load_medical_profile_trait_definitions

load_medical_profile_trait_definitions

load_medical_profile_trait_definitions(dry_run)
Source code in components/medical_profile/public/commands/load_medical_profile_trait_definitions.py
@medical_profile_commands.command(requires_authentication=False)
@command_with_dry_run
def load_medical_profile_trait_definitions(dry_run: bool) -> None:  # noqa: D103
    data_loader.load_medical_profile_trait_definitions(commit=not dry_run)

update_medical_profile_inferences

update_medical_profile_inferences

update_medical_profile_inferences(dry_run)
Source code in components/medical_profile/public/commands/update_medical_profile_inferences.py
@medical_profile_commands.command(requires_authentication=False)
@command_with_dry_run
def update_medical_profile_inferences(dry_run: bool) -> None:  # noqa: D103
    update_clinic_profile_inferences(commit=not dry_run)

components.medical_profile.public.entities

CollectedTraitWithProperties dataclass

CollectedTraitWithProperties(
    created_at, trait, source_type, properties
)

Bases: DataClassJsonMixin

created_at instance-attribute

created_at

properties instance-attribute

properties

source_type instance-attribute

source_type

trait instance-attribute

trait

TraitProperty dataclass

TraitProperty(value, extra_data=None)

Bases: DataClassJsonMixin

This class is used throughout the codebase wherever access to the medical profile survey data is needed.

extra_data class-attribute instance-attribute

extra_data = None

value instance-attribute

value

TraitValue module-attribute

TraitValue = Union[int, float, str, bool, date]

TraitWithProperties dataclass

TraitWithProperties(trait, properties)

Bases: DataClassJsonMixin

properties instance-attribute

properties

trait instance-attribute

trait

components.medical_profile.public.enums

MedicalProfileCollectedTraitSourceType

Bases: AlanBaseEnum

acuity_test_survey class-attribute instance-attribute

acuity_test_survey = 'acuity_test_survey'

alan_baby_program_survey class-attribute instance-attribute

alan_baby_program_survey = 'alan_baby_program_survey'

alan_baby_sleep_program_survey class-attribute instance-attribute

alan_baby_sleep_program_survey = (
    "alan_baby_sleep_program_survey"
)

baby_sleep_diagnosis_survey class-attribute instance-attribute

baby_sleep_diagnosis_survey = 'baby_sleep_diagnosis_survey'

back_pain_daily_tracking class-attribute instance-attribute

back_pain_daily_tracking = 'back_pain_daily_tracking'

back_pain_daily_tracking_v2 class-attribute instance-attribute

back_pain_daily_tracking_v2 = 'back_pain_daily_tracking_v2'

back_pain_diagnosis_survey class-attribute instance-attribute

back_pain_diagnosis_survey = 'back_pain_diagnosis_survey'

back_pain_space_entry_survey class-attribute instance-attribute

back_pain_space_entry_survey = (
    "back_pain_space_entry_survey"
)

generalist_consultation_survey class-attribute instance-attribute

generalist_consultation_survey = (
    "generalist_consultation_survey"
)

lifestyle_screening_survey class-attribute instance-attribute

lifestyle_screening_survey = 'lifestyle_screening_survey'

mental_wellbeing class-attribute instance-attribute

mental_wellbeing = 'mental_wellbeing'

proactive_care_ophthalmologist_setup_survey class-attribute instance-attribute

proactive_care_ophthalmologist_setup_survey = (
    "proactive_care_ophthalmologist_setup_survey"
)

proactive_care_ophthalmologist_setup_survey_v2 class-attribute instance-attribute

proactive_care_ophthalmologist_setup_survey_v2 = (
    "proactive_care_ophthalmologist_setup_survey_v2"
)

stress_at_work_diagnosis_survey class-attribute instance-attribute

stress_at_work_diagnosis_survey = (
    "stress_at_work_diagnosis_survey"
)

stress_diagnosis_survey class-attribute instance-attribute

stress_diagnosis_survey = 'stress_diagnosis_survey'

stress_management_daily_tracking class-attribute instance-attribute

stress_management_daily_tracking = (
    "stress_management_daily_tracking"
)

stress_management_diagnosis_survey class-attribute instance-attribute

stress_management_diagnosis_survey = (
    "stress_management_diagnosis_survey"
)

components.medical_profile.public.logic

get_medical_profile_logic

get_medical_profile_logic(app_id)
Source code in components/medical_profile/internal/business_logic/get_medical_profile_logic.py
def get_medical_profile_logic(app_id: str) -> "MedicalProfileLogic":
    # Late imports to avoid slowing down app startup
    from components.medical_profile.internal.business_logic.medical_profile_logic import (
        MedicalProfileLogic,
    )

    return MedicalProfileLogic(app_id=app_id)