Model

Base

Base classes for health data models.

Provides HK_GROUPS registry to public API .

class src.model.base.BodyMeasurements[source]

Bases: HKGroup

group: str = 'body_measurements'
class src.model.base.Diving[source]

Bases: HKGroup

group: str = 'diving'
class src.model.base.Fitness[source]

Bases: HKGroup

group: str = 'body_measurements'
class src.model.base.HKCategoryTypeIdentifier[source]

Bases: HKIdentifier

Sentinel category identifier values.

class Values[source]

Bases: object

HK category identifier values Enum template.

Subclasses overwrite this class as Enum with their associated values.

classmethod category_values()[source]

Return name: value dict of HKCategoryTypeIdentifier values.

Return type:

dict[str, int]

identifier_type: str = 'category'
class src.model.base.HKDataTypeSleepDurationGoal[source]

Bases: HKMiscTypeIdentifier, Fitness

class src.model.base.HKGroup[source]

Bases: object

group: str
class src.model.base.HKIdentifier[source]

Bases: object

Sentinel identifier base class.

group: str
identifier_type: str
class src.model.base.HKMiscTypeIdentifier[source]

Bases: HKIdentifier

Sentinel miscellaneous identifier values.

identifier_type: str = 'miscellaneous'
class src.model.base.HKQuantityTypeIdentifier[source]

Bases: HKIdentifier

Sentinel quantity identifier values.

identifier_type: str = 'quantity'
class src.model.base.Hearing[source]

Bases: HKGroup

group: str = 'hearing'
class src.model.base.LabTestResults[source]

Bases: HKGroup

group: str = 'lab_test_results'
class src.model.base.Mindfulness[source]

Bases: HKGroup

group: str = 'mindfulness'
class src.model.base.MissingUnit(*values)[source]

Bases: Enum

Sentinel unit value assigned to categorical (non-numeric) records.

Example:

df.loc[mask, "unit"] = MissingUnit.CATEGORICAL.value  # → "Categorical"
CATEGORICAL = 'Categorical'
class src.model.base.Mobility[source]

Bases: HKGroup

group: str = 'mobility'
class src.model.base.Nutrition[source]

Bases: HKGroup

group: str = 'nutrition'
class src.model.base.Other[source]

Bases: HKGroup

group: str = 'other'
class src.model.base.ReproductiveHealth[source]

Bases: HKGroup

group: str = 'reproductive_health'
class src.model.base.Symptoms[source]

Bases: HKGroup

group: str = 'symptoms'
class src.model.base.UVExposure[source]

Bases: HKGroup

group: str = 'uv_exposure'
class src.model.base.VitalSigns[source]

Bases: HKGroup

group: str = 'vital_signs'

Category Types

Category Type model classes.

Provides HKCategoryTypeIdentifierRegistry to public API.

class src.model.category_types.HKCategoryTypeIdentifierAbdominalCramps[source]

Bases: HKCategoryTypeIdentifier, Symptoms

class Values(*values)[source]

Bases: Enum

HKCategoryValueSeverityMild = 2
HKCategoryValueSeverityModerate = 3
HKCategoryValueSeverityNotPresent = 1
HKCategoryValueSeveritySevere = 4
HKCategoryValueSeverityUnspecified = 0
class src.model.category_types.HKCategoryTypeIdentifierAcne[source]

Bases: HKCategoryTypeIdentifier, Symptoms

class Values(*values)[source]

Bases: Enum

HKCategoryValueSeverityMild = 2
HKCategoryValueSeverityModerate = 3
HKCategoryValueSeverityNotPresent = 1
HKCategoryValueSeveritySevere = 4
HKCategoryValueSeverityUnspecified = 0
class src.model.category_types.HKCategoryTypeIdentifierAppetiteChanges[source]

Bases: HKCategoryTypeIdentifier, Symptoms

class Values(*values)[source]

Bases: Enum

HKCategoryValueAppetiteChangesDecreased = 2
HKCategoryValueAppetiteChangesIncreased = 3
HKCategoryValueAppetiteChangesNoChange = 1
HKCategoryValueAppetiteChangesUnspecified = 0
class src.model.category_types.HKCategoryTypeIdentifierAppleStandHour[source]

Bases: HKCategoryTypeIdentifier, Fitness

class Values(*values)[source]

Bases: Enum

HKCategoryValueAppleStandHourIdle = 0
HKCategoryValueAppleStandHourStood = 1
class src.model.category_types.HKCategoryTypeIdentifierAppleWalkingSteadinessEvent[source]

Bases: HKCategoryTypeIdentifier, Fitness

class Values(*values)[source]

Bases: Enum

HKCategoryValueAppleWalkingSteadinessEventInitialLow = 0
HKCategoryValueAppleWalkingSteadinessEventInitialVeryLow = 1
HKCategoryValueAppleWalkingSteadinessEventRepeatLow = 2
HKCategoryValueAppleWalkingSteadinessEventRepeatVeryLow = 3
class src.model.category_types.HKCategoryTypeIdentifierAudioExposureEvent[source]

Bases: HKCategoryTypeIdentifier, Hearing

class Values(*values)[source]

Bases: Enum

HKCategoryValueAudioExposureEventLoudEnvironment = 0
class src.model.category_types.HKCategoryTypeIdentifierBladderIncontinence[source]

Bases: HKCategoryTypeIdentifier, Symptoms

class Values(*values)[source]

Bases: Enum

HKCategoryValueSeverityMild = 2
HKCategoryValueSeverityModerate = 3
HKCategoryValueSeverityNotPresent = 1
HKCategoryValueSeveritySevere = 4
HKCategoryValueSeverityUnspecified = 0
class src.model.category_types.HKCategoryTypeIdentifierBleedingAfterPregnancy[source]

Bases: HKCategoryTypeIdentifier, ReproductiveHealth

class Values(*values)[source]

Bases: Enum

HKCategoryValueNotApplicable = 0
class src.model.category_types.HKCategoryTypeIdentifierBleedingDuringPregnancy[source]

Bases: HKCategoryTypeIdentifier, ReproductiveHealth

class Values(*values)[source]

Bases: Enum

HKCategoryValueNotApplicable = 0
class src.model.category_types.HKCategoryTypeIdentifierBloating[source]

Bases: HKCategoryTypeIdentifier, Symptoms

class Values(*values)[source]

Bases: Enum

HKCategoryValueSeverityMild = 2
HKCategoryValueSeverityModerate = 3
HKCategoryValueSeverityNotPresent = 1
HKCategoryValueSeveritySevere = 4
HKCategoryValueSeverityUnspecified = 0
class src.model.category_types.HKCategoryTypeIdentifierBreastPain[source]

Bases: HKCategoryTypeIdentifier, Symptoms

class Values(*values)[source]

Bases: Enum

HKCategoryValueSeverityMild = 2
HKCategoryValueSeverityModerate = 3
HKCategoryValueSeverityNotPresent = 1
HKCategoryValueSeveritySevere = 4
HKCategoryValueSeverityUnspecified = 0
class src.model.category_types.HKCategoryTypeIdentifierCervicalMucusQuality[source]

Bases: HKCategoryTypeIdentifier, ReproductiveHealth

class Values(*values)[source]

Bases: Enum

HKCategoryValueCervicalMucusQualityCreamy = 2
HKCategoryValueCervicalMucusQualityDry = 0
HKCategoryValueCervicalMucusQualityEggWhite = 4
HKCategoryValueCervicalMucusQualitySticky = 1
HKCategoryValueCervicalMucusQualityWatery = 3
class src.model.category_types.HKCategoryTypeIdentifierChestTightnessOrPain[source]

Bases: HKCategoryTypeIdentifier, Symptoms

class Values(*values)[source]

Bases: Enum

HKCategoryValueSeverityMild = 2
HKCategoryValueSeverityModerate = 3
HKCategoryValueSeverityNotPresent = 1
HKCategoryValueSeveritySevere = 4
HKCategoryValueSeverityUnspecified = 0
class src.model.category_types.HKCategoryTypeIdentifierChills[source]

Bases: HKCategoryTypeIdentifier, Symptoms

class Values(*values)[source]

Bases: Enum

HKCategoryValueSeverityMild = 2
HKCategoryValueSeverityModerate = 3
HKCategoryValueSeverityNotPresent = 1
HKCategoryValueSeveritySevere = 4
HKCategoryValueSeverityUnspecified = 0
class src.model.category_types.HKCategoryTypeIdentifierConstipation[source]

Bases: HKCategoryTypeIdentifier, Symptoms

class Values(*values)[source]

Bases: Enum

HKCategoryValueSeverityMild = 2
HKCategoryValueSeverityModerate = 3
HKCategoryValueSeverityNotPresent = 1
HKCategoryValueSeveritySevere = 4
HKCategoryValueSeverityUnspecified = 0
class src.model.category_types.HKCategoryTypeIdentifierContraceptive[source]

Bases: HKCategoryTypeIdentifier, ReproductiveHealth

class Values(*values)[source]

Bases: Enum

HKCategoryValueContraceptiveImplant = 1
HKCategoryValueContraceptiveInjection = 2
HKCategoryValueContraceptiveIntrauterineDevice = 3
HKCategoryValueContraceptiveIntravaginalRingOrPatch = 4
HKCategoryValueContraceptiveOral = 5
HKCategoryValueContraceptivePatch = 6
HKCategoryValueContraceptiveUnspecified = 0
class src.model.category_types.HKCategoryTypeIdentifierCoughing[source]

Bases: HKCategoryTypeIdentifier, Symptoms

class Values(*values)[source]

Bases: Enum

HKCategoryValueSeverityMild = 2
HKCategoryValueSeverityModerate = 3
HKCategoryValueSeverityNotPresent = 1
HKCategoryValueSeveritySevere = 4
HKCategoryValueSeverityUnspecified = 0
class src.model.category_types.HKCategoryTypeIdentifierDiarrhea[source]

Bases: HKCategoryTypeIdentifier, Symptoms

class Values(*values)[source]

Bases: Enum

HKCategoryValueSeverityMild = 2
HKCategoryValueSeverityModerate = 3
HKCategoryValueSeverityNotPresent = 1
HKCategoryValueSeveritySevere = 4
HKCategoryValueSeverityUnspecified = 0
class src.model.category_types.HKCategoryTypeIdentifierDizziness[source]

Bases: HKCategoryTypeIdentifier, Symptoms

class Values(*values)[source]

Bases: Enum

HKCategoryValueSeverityMild = 2
HKCategoryValueSeverityModerate = 3
HKCategoryValueSeverityNotPresent = 1
HKCategoryValueSeveritySevere = 4
HKCategoryValueSeverityUnspecified = 0
class src.model.category_types.HKCategoryTypeIdentifierDrySkin[source]

Bases: HKCategoryTypeIdentifier, Symptoms

class Values(*values)[source]

Bases: Enum

HKCategoryValueSeverityMild = 2
HKCategoryValueSeverityModerate = 3
HKCategoryValueSeverityNotPresent = 1
HKCategoryValueSeveritySevere = 4
HKCategoryValueSeverityUnspecified = 0
class src.model.category_types.HKCategoryTypeIdentifierEnvironmentalAudioExposureEvent[source]

Bases: HKCategoryTypeIdentifier, Hearing

class Values(*values)[source]

Bases: Enum

HKCategoryValueEnvironmentalAudioExposureEventMomentaryLimit = 0
class src.model.category_types.HKCategoryTypeIdentifierFainting[source]

Bases: HKCategoryTypeIdentifier, Symptoms

class Values(*values)[source]

Bases: Enum

HKCategoryValueSeverityMild = 2
HKCategoryValueSeverityModerate = 3
HKCategoryValueSeverityNotPresent = 1
HKCategoryValueSeveritySevere = 4
HKCategoryValueSeverityUnspecified = 0
class src.model.category_types.HKCategoryTypeIdentifierFatigue[source]

Bases: HKCategoryTypeIdentifier, Symptoms

class Values(*values)[source]

Bases: Enum

HKCategoryValueSeverityMild = 2
HKCategoryValueSeverityModerate = 3
HKCategoryValueSeverityNotPresent = 1
HKCategoryValueSeveritySevere = 4
HKCategoryValueSeverityUnspecified = 0
class src.model.category_types.HKCategoryTypeIdentifierFever[source]

Bases: HKCategoryTypeIdentifier, Symptoms

class Values(*values)[source]

Bases: Enum

HKCategoryValueSeverityMild = 2
HKCategoryValueSeverityModerate = 3
HKCategoryValueSeverityNotPresent = 1
HKCategoryValueSeveritySevere = 4
HKCategoryValueSeverityUnspecified = 0
class src.model.category_types.HKCategoryTypeIdentifierGeneralizedBodyAche[source]

Bases: HKCategoryTypeIdentifier, Symptoms

class Values(*values)[source]

Bases: Enum

HKCategoryValueSeverityMild = 2
HKCategoryValueSeverityModerate = 3
HKCategoryValueSeverityNotPresent = 1
HKCategoryValueSeveritySevere = 4
HKCategoryValueSeverityUnspecified = 0
class src.model.category_types.HKCategoryTypeIdentifierHairLoss[source]

Bases: HKCategoryTypeIdentifier, Symptoms

class Values(*values)[source]

Bases: Enum

HKCategoryValueSeverityMild = 2
HKCategoryValueSeverityModerate = 3
HKCategoryValueSeverityNotPresent = 1
HKCategoryValueSeveritySevere = 4
HKCategoryValueSeverityUnspecified = 0
class src.model.category_types.HKCategoryTypeIdentifierHandwashingEvent[source]

Bases: HKCategoryTypeIdentifier, Other

class Values(*values)[source]

Bases: Enum

HKCategoryValueNotApplicable = 0
class src.model.category_types.HKCategoryTypeIdentifierHeadache[source]

Bases: HKCategoryTypeIdentifier, Symptoms

class Values(*values)[source]

Bases: Enum

HKCategoryValueSeverityMild = 2
HKCategoryValueSeverityModerate = 3
HKCategoryValueSeverityNotPresent = 1
HKCategoryValueSeveritySevere = 4
HKCategoryValueSeverityUnspecified = 0
class src.model.category_types.HKCategoryTypeIdentifierHeadphoneAudioExposureEvent[source]

Bases: HKCategoryTypeIdentifier, Hearing

class Values(*values)[source]

Bases: Enum

HKCategoryValueHeadphoneAudioExposureEventSevenDayLimit = 0
class src.model.category_types.HKCategoryTypeIdentifierHeartburn[source]

Bases: HKCategoryTypeIdentifier, Symptoms

class Values(*values)[source]

Bases: Enum

HKCategoryValueSeverityMild = 2
HKCategoryValueSeverityModerate = 3
HKCategoryValueSeverityNotPresent = 1
HKCategoryValueSeveritySevere = 4
HKCategoryValueSeverityUnspecified = 0
class src.model.category_types.HKCategoryTypeIdentifierHighHeartRateEvent[source]

Bases: HKCategoryTypeIdentifier, VitalSigns

class Values(*values)[source]

Bases: Enum

HKCategoryValueNotApplicable = 0
class src.model.category_types.HKCategoryTypeIdentifierHotFlashes[source]

Bases: HKCategoryTypeIdentifier, Symptoms

class Values(*values)[source]

Bases: Enum

HKCategoryValueSeverityMild = 2
HKCategoryValueSeverityModerate = 3
HKCategoryValueSeverityNotPresent = 1
HKCategoryValueSeveritySevere = 4
HKCategoryValueSeverityUnspecified = 0
class src.model.category_types.HKCategoryTypeIdentifierHypertensionEvent[source]

Bases: HKCategoryTypeIdentifier, VitalSigns

class Values(*values)[source]

Bases: Enum

HKCategoryValueNotApplicable = 0
class src.model.category_types.HKCategoryTypeIdentifierInfrequentMenstrualCycles[source]

Bases: HKCategoryTypeIdentifier, ReproductiveHealth

class Values(*values)[source]

Bases: Enum

HKCategoryValueNotApplicable = 0
class src.model.category_types.HKCategoryTypeIdentifierIntermenstrualBleeding[source]

Bases: HKCategoryTypeIdentifier, ReproductiveHealth

class Values(*values)[source]

Bases: Enum

HKCategoryValueNotApplicable = 0
class src.model.category_types.HKCategoryTypeIdentifierIrregularHeartRhythmEvent[source]

Bases: HKCategoryTypeIdentifier, VitalSigns

class Values(*values)[source]

Bases: Enum

HKCategoryValueNotApplicable = 0
class src.model.category_types.HKCategoryTypeIdentifierIrregularMenstrualCycles[source]

Bases: HKCategoryTypeIdentifier, ReproductiveHealth

class Values(*values)[source]

Bases: Enum

HKCategoryValueNotApplicable = 0
class src.model.category_types.HKCategoryTypeIdentifierLactation[source]

Bases: HKCategoryTypeIdentifier, ReproductiveHealth

class Values(*values)[source]

Bases: Enum

HKCategoryValueNotApplicable = 0
class src.model.category_types.HKCategoryTypeIdentifierLossOfSmell[source]

Bases: HKCategoryTypeIdentifier, Symptoms

class Values(*values)[source]

Bases: Enum

HKCategoryValueSeverityMild = 2
HKCategoryValueSeverityModerate = 3
HKCategoryValueSeverityNotPresent = 1
HKCategoryValueSeveritySevere = 4
HKCategoryValueSeverityUnspecified = 0
class src.model.category_types.HKCategoryTypeIdentifierLossOfTaste[source]

Bases: HKCategoryTypeIdentifier, Symptoms

class Values(*values)[source]

Bases: Enum

HKCategoryValueSeverityMild = 2
HKCategoryValueSeverityModerate = 3
HKCategoryValueSeverityNotPresent = 1
HKCategoryValueSeveritySevere = 4
HKCategoryValueSeverityUnspecified = 0
class src.model.category_types.HKCategoryTypeIdentifierLowCardioFitnessEvent[source]

Bases: HKCategoryTypeIdentifier, Fitness

class Values(*values)[source]

Bases: Enum

HKCategoryValueLowCardioFitnessEventLowFitness = 0
class src.model.category_types.HKCategoryTypeIdentifierLowHeartRateEvent[source]

Bases: HKCategoryTypeIdentifier, VitalSigns

class Values(*values)[source]

Bases: Enum

HKCategoryValueNotApplicable = 0
class src.model.category_types.HKCategoryTypeIdentifierLowerBackPain[source]

Bases: HKCategoryTypeIdentifier, Symptoms

class Values(*values)[source]

Bases: Enum

HKCategoryValueSeverityMild = 2
HKCategoryValueSeverityModerate = 3
HKCategoryValueSeverityNotPresent = 1
HKCategoryValueSeveritySevere = 4
HKCategoryValueSeverityUnspecified = 0
class src.model.category_types.HKCategoryTypeIdentifierMemoryLapse[source]

Bases: HKCategoryTypeIdentifier, Symptoms

class Values(*values)[source]

Bases: Enum

HKCategoryValueSeverityMild = 2
HKCategoryValueSeverityModerate = 3
HKCategoryValueSeverityNotPresent = 1
HKCategoryValueSeveritySevere = 4
HKCategoryValueSeverityUnspecified = 0
class src.model.category_types.HKCategoryTypeIdentifierMenstrualFlow[source]

Bases: HKCategoryTypeIdentifier, ReproductiveHealth

class Values(*values)[source]

Bases: Enum

HKCategoryValueMenstrualFlowHeavy = 3
HKCategoryValueMenstrualFlowLight = 1
HKCategoryValueMenstrualFlowMedium = 2
HKCategoryValueMenstrualFlowNone = 4
HKCategoryValueMenstrualFlowUnspecified = 0
class src.model.category_types.HKCategoryTypeIdentifierMindfulSession[source]

Bases: HKCategoryTypeIdentifier, Fitness

class Values(*values)[source]

Bases: Enum

HKCategoryValueNotApplicable = 0
class src.model.category_types.HKCategoryTypeIdentifierMoodChanges[source]

Bases: HKCategoryTypeIdentifier, Symptoms

class Values(*values)[source]

Bases: Enum

HKCategoryValuePresenceNotPresent = 1
HKCategoryValuePresencePresent = 0
class src.model.category_types.HKCategoryTypeIdentifierNausea[source]

Bases: HKCategoryTypeIdentifier, Symptoms

class Values(*values)[source]

Bases: Enum

HKCategoryValueSeverityMild = 2
HKCategoryValueSeverityModerate = 3
HKCategoryValueSeverityNotPresent = 1
HKCategoryValueSeveritySevere = 4
HKCategoryValueSeverityUnspecified = 0
class src.model.category_types.HKCategoryTypeIdentifierNightSweats[source]

Bases: HKCategoryTypeIdentifier, Symptoms

class Values(*values)[source]

Bases: Enum

HKCategoryValueSeverityMild = 2
HKCategoryValueSeverityModerate = 3
HKCategoryValueSeverityNotPresent = 1
HKCategoryValueSeveritySevere = 4
HKCategoryValueSeverityUnspecified = 0
class src.model.category_types.HKCategoryTypeIdentifierOvulationTestResult[source]

Bases: HKCategoryTypeIdentifier, ReproductiveHealth

class Values(*values)[source]

Bases: Enum

HKCategoryValueOvulationTestResultEstrogenSurge = 3
HKCategoryValueOvulationTestResultIndeterminate = 2
HKCategoryValueOvulationTestResultLuteinizingHormoneSurge = 1
HKCategoryValueOvulationTestResultNegative = 0
class src.model.category_types.HKCategoryTypeIdentifierPelvicPain[source]

Bases: HKCategoryTypeIdentifier, Symptoms

class Values(*values)[source]

Bases: Enum

HKCategoryValueSeverityMild = 2
HKCategoryValueSeverityModerate = 3
HKCategoryValueSeverityNotPresent = 1
HKCategoryValueSeveritySevere = 4
HKCategoryValueSeverityUnspecified = 0
class src.model.category_types.HKCategoryTypeIdentifierPersistentIntermenstrualBleeding[source]

Bases: HKCategoryTypeIdentifier, ReproductiveHealth

class Values(*values)[source]

Bases: Enum

HKCategoryValueNotApplicable = 0
class src.model.category_types.HKCategoryTypeIdentifierPregnancy[source]

Bases: HKCategoryTypeIdentifier, ReproductiveHealth

class Values(*values)[source]

Bases: Enum

HKCategoryValueNotApplicable = 0
class src.model.category_types.HKCategoryTypeIdentifierPregnancyTestResult[source]

Bases: HKCategoryTypeIdentifier, ReproductiveHealth

class Values(*values)[source]

Bases: Enum

HKCategoryValuePregnancyTestResultIndeterminate = 2
HKCategoryValuePregnancyTestResultNegative = 0
HKCategoryValuePregnancyTestResultPositive = 1
class src.model.category_types.HKCategoryTypeIdentifierProgesteroneTestResult[source]

Bases: HKCategoryTypeIdentifier, ReproductiveHealth

class Values(*values)[source]

Bases: Enum

HKCategoryValueProgesteroneTestResultIndeterminate = 2
HKCategoryValueProgesteroneTestResultNegative = 0
HKCategoryValueProgesteroneTestResultPositive = 1
class src.model.category_types.HKCategoryTypeIdentifierProlongedMenstrualPeriods[source]

Bases: HKCategoryTypeIdentifier, ReproductiveHealth

class Values(*values)[source]

Bases: Enum

HKCategoryValueNotApplicable = 0
class src.model.category_types.HKCategoryTypeIdentifierRapidPoundingOrFlutteringHeartbeat[source]

Bases: HKCategoryTypeIdentifier, Symptoms

class Values(*values)[source]

Bases: Enum

HKCategoryValueSeverityMild = 2
HKCategoryValueSeverityModerate = 3
HKCategoryValueSeverityNotPresent = 1
HKCategoryValueSeveritySevere = 4
HKCategoryValueSeverityUnspecified = 0
class src.model.category_types.HKCategoryTypeIdentifierRunnyNose[source]

Bases: HKCategoryTypeIdentifier, Symptoms

class Values(*values)[source]

Bases: Enum

HKCategoryValueSeverityMild = 2
HKCategoryValueSeverityModerate = 3
HKCategoryValueSeverityNotPresent = 1
HKCategoryValueSeveritySevere = 4
HKCategoryValueSeverityUnspecified = 0
class src.model.category_types.HKCategoryTypeIdentifierSexualActivity[source]

Bases: HKCategoryTypeIdentifier, ReproductiveHealth

class Values(*values)[source]

Bases: Enum

HKCategoryValueNotApplicable = 0
class src.model.category_types.HKCategoryTypeIdentifierShortnessOfBreath[source]

Bases: HKCategoryTypeIdentifier, Symptoms

class Values(*values)[source]

Bases: Enum

HKCategoryValueSeverityMild = 2
HKCategoryValueSeverityModerate = 3
HKCategoryValueSeverityNotPresent = 1
HKCategoryValueSeveritySevere = 4
HKCategoryValueSeverityUnspecified = 0
class src.model.category_types.HKCategoryTypeIdentifierSinusCongestion[source]

Bases: HKCategoryTypeIdentifier, Symptoms

class Values(*values)[source]

Bases: Enum

HKCategoryValueSeverityMild = 2
HKCategoryValueSeverityModerate = 3
HKCategoryValueSeverityNotPresent = 1
HKCategoryValueSeveritySevere = 4
HKCategoryValueSeverityUnspecified = 0
class src.model.category_types.HKCategoryTypeIdentifierSkippedHeartbeat[source]

Bases: HKCategoryTypeIdentifier, Symptoms

class Values(*values)[source]

Bases: Enum

HKCategoryValueSeverityMild = 2
HKCategoryValueSeverityModerate = 3
HKCategoryValueSeverityNotPresent = 1
HKCategoryValueSeveritySevere = 4
HKCategoryValueSeverityUnspecified = 0
class src.model.category_types.HKCategoryTypeIdentifierSleepAnalysis[source]

Bases: HKCategoryTypeIdentifier, Fitness

class Values(*values)[source]

Bases: Enum

HKCategoryValueSleepAnalysisAsleepCore = 3
HKCategoryValueSleepAnalysisAsleepDeep = 4
HKCategoryValueSleepAnalysisAsleepREM = 5
HKCategoryValueSleepAnalysisAsleepUnspecified = 1
HKCategoryValueSleepAnalysisAwake = 2
HKCategoryValueSleepAnalysisInBed = 0
class src.model.category_types.HKCategoryTypeIdentifierSleepApneaEvent[source]

Bases: HKCategoryTypeIdentifier, VitalSigns

class Values(*values)[source]

Bases: Enum

HKCategoryValueNotApplicable = 0
class src.model.category_types.HKCategoryTypeIdentifierSleepChanges[source]

Bases: HKCategoryTypeIdentifier, Symptoms

class Values(*values)[source]

Bases: Enum

HKCategoryValuePresenceNotPresent = 1
HKCategoryValuePresencePresent = 0
class src.model.category_types.HKCategoryTypeIdentifierSoreThroat[source]

Bases: HKCategoryTypeIdentifier, Symptoms

class Values(*values)[source]

Bases: Enum

HKCategoryValueSeverityMild = 2
HKCategoryValueSeverityModerate = 3
HKCategoryValueSeverityNotPresent = 1
HKCategoryValueSeveritySevere = 4
HKCategoryValueSeverityUnspecified = 0
class src.model.category_types.HKCategoryTypeIdentifierToothbrushingEvent[source]

Bases: HKCategoryTypeIdentifier, Other

class Values(*values)[source]

Bases: Enum

HKCategoryValueNotApplicable = 0
class src.model.category_types.HKCategoryTypeIdentifierVaginalDryness[source]

Bases: HKCategoryTypeIdentifier, Symptoms

class Values(*values)[source]

Bases: Enum

HKCategoryValueSeverityMild = 2
HKCategoryValueSeverityModerate = 3
HKCategoryValueSeverityNotPresent = 1
HKCategoryValueSeveritySevere = 4
HKCategoryValueSeverityUnspecified = 0
class src.model.category_types.HKCategoryTypeIdentifierVomiting[source]

Bases: HKCategoryTypeIdentifier, Symptoms

class Values(*values)[source]

Bases: Enum

HKCategoryValueSeverityMild = 2
HKCategoryValueSeverityModerate = 3
HKCategoryValueSeverityNotPresent = 1
HKCategoryValueSeveritySevere = 4
HKCategoryValueSeverityUnspecified = 0
class src.model.category_types.HKCategoryTypeIdentifierWheezing[source]

Bases: HKCategoryTypeIdentifier, Symptoms

class Values(*values)[source]

Bases: Enum

HKCategoryValueSeverityMild = 2
HKCategoryValueSeverityModerate = 3
HKCategoryValueSeverityNotPresent = 1
HKCategoryValueSeveritySevere = 4
HKCategoryValueSeverityUnspecified = 0

Quantity Types

Quantity Type model classes.

Provides HKQuantityTypeIdentifierRegistry to public API.

class src.model.quantity_types.HKQuantityTypeIdentifierActiveEnergyBurned[source]

Bases: HKQuantityTypeIdentifier, Fitness

class src.model.quantity_types.HKQuantityTypeIdentifierAppleExerciseTime[source]

Bases: HKQuantityTypeIdentifier, Fitness

class src.model.quantity_types.HKQuantityTypeIdentifierAppleMoveTime[source]

Bases: HKQuantityTypeIdentifier, Fitness

class src.model.quantity_types.HKQuantityTypeIdentifierAppleSleepingBreathingDisturbances[source]

Bases: HKQuantityTypeIdentifier, VitalSigns

class src.model.quantity_types.HKQuantityTypeIdentifierAppleSleepingWristTemperature[source]

Bases: HKQuantityTypeIdentifier, VitalSigns

class src.model.quantity_types.HKQuantityTypeIdentifierAppleStandTime[source]

Bases: HKQuantityTypeIdentifier, Fitness

class src.model.quantity_types.HKQuantityTypeIdentifierAppleWalkingSteadiness[source]

Bases: HKQuantityTypeIdentifier, Mobility

class src.model.quantity_types.HKQuantityTypeIdentifierAtrialFibrillationBurden[source]

Bases: HKQuantityTypeIdentifier, VitalSigns

class src.model.quantity_types.HKQuantityTypeIdentifierBasalBodyTemperature[source]

Bases: HKQuantityTypeIdentifier, ReproductiveHealth

class src.model.quantity_types.HKQuantityTypeIdentifierBasalEnergyBurned[source]

Bases: HKQuantityTypeIdentifier, Fitness

class src.model.quantity_types.HKQuantityTypeIdentifierBloodAlcoholContent[source]

Bases: HKQuantityTypeIdentifier, LabTestResults

class src.model.quantity_types.HKQuantityTypeIdentifierBloodGlucose[source]

Bases: HKQuantityTypeIdentifier, LabTestResults

class src.model.quantity_types.HKQuantityTypeIdentifierBloodPressureDiastolic[source]

Bases: HKQuantityTypeIdentifier, VitalSigns

class src.model.quantity_types.HKQuantityTypeIdentifierBloodPressureSystolic[source]

Bases: HKQuantityTypeIdentifier, VitalSigns

class src.model.quantity_types.HKQuantityTypeIdentifierBodyFatPercentage[source]

Bases: HKQuantityTypeIdentifier, BodyMeasurements

class src.model.quantity_types.HKQuantityTypeIdentifierBodyMass[source]

Bases: HKQuantityTypeIdentifier, BodyMeasurements

class src.model.quantity_types.HKQuantityTypeIdentifierBodyMassIndex[source]

Bases: HKQuantityTypeIdentifier, BodyMeasurements

class src.model.quantity_types.HKQuantityTypeIdentifierBodyTemperature[source]

Bases: HKQuantityTypeIdentifier, VitalSigns

class src.model.quantity_types.HKQuantityTypeIdentifierCrossCountrySkiingSpeed[source]

Bases: HKQuantityTypeIdentifier, Fitness

class src.model.quantity_types.HKQuantityTypeIdentifierCyclingCadence[source]

Bases: HKQuantityTypeIdentifier, Fitness

class src.model.quantity_types.HKQuantityTypeIdentifierCyclingFunctionalThresholdPower[source]

Bases: HKQuantityTypeIdentifier, Fitness

class src.model.quantity_types.HKQuantityTypeIdentifierCyclingPower[source]

Bases: HKQuantityTypeIdentifier, Fitness

class src.model.quantity_types.HKQuantityTypeIdentifierCyclingSpeed[source]

Bases: HKQuantityTypeIdentifier, Fitness

class src.model.quantity_types.HKQuantityTypeIdentifierDietaryBiotin[source]

Bases: HKQuantityTypeIdentifier, Nutrition

class src.model.quantity_types.HKQuantityTypeIdentifierDietaryCaffeine[source]

Bases: HKQuantityTypeIdentifier, Nutrition

class src.model.quantity_types.HKQuantityTypeIdentifierDietaryCalcium[source]

Bases: HKQuantityTypeIdentifier, Nutrition

class src.model.quantity_types.HKQuantityTypeIdentifierDietaryCarbohydrates[source]

Bases: HKQuantityTypeIdentifier, Nutrition

class src.model.quantity_types.HKQuantityTypeIdentifierDietaryChloride[source]

Bases: HKQuantityTypeIdentifier, Nutrition

class src.model.quantity_types.HKQuantityTypeIdentifierDietaryCholesterol[source]

Bases: HKQuantityTypeIdentifier, Nutrition

class src.model.quantity_types.HKQuantityTypeIdentifierDietaryChromium[source]

Bases: HKQuantityTypeIdentifier, Nutrition

class src.model.quantity_types.HKQuantityTypeIdentifierDietaryCopper[source]

Bases: HKQuantityTypeIdentifier, Nutrition

class src.model.quantity_types.HKQuantityTypeIdentifierDietaryEnergyConsumed[source]

Bases: HKQuantityTypeIdentifier, Nutrition

class src.model.quantity_types.HKQuantityTypeIdentifierDietaryFatMonounsaturated[source]

Bases: HKQuantityTypeIdentifier, Nutrition

class src.model.quantity_types.HKQuantityTypeIdentifierDietaryFatPolyunsaturated[source]

Bases: HKQuantityTypeIdentifier, Nutrition

class src.model.quantity_types.HKQuantityTypeIdentifierDietaryFatSaturated[source]

Bases: HKQuantityTypeIdentifier, Nutrition

class src.model.quantity_types.HKQuantityTypeIdentifierDietaryFatTotal[source]

Bases: HKQuantityTypeIdentifier, Nutrition

class src.model.quantity_types.HKQuantityTypeIdentifierDietaryFiber[source]

Bases: HKQuantityTypeIdentifier, Nutrition

class src.model.quantity_types.HKQuantityTypeIdentifierDietaryFolate[source]

Bases: HKQuantityTypeIdentifier, Nutrition

class src.model.quantity_types.HKQuantityTypeIdentifierDietaryIodine[source]

Bases: HKQuantityTypeIdentifier, Nutrition

class src.model.quantity_types.HKQuantityTypeIdentifierDietaryIron[source]

Bases: HKQuantityTypeIdentifier, Nutrition

class src.model.quantity_types.HKQuantityTypeIdentifierDietaryMagnesium[source]

Bases: HKQuantityTypeIdentifier, Nutrition

class src.model.quantity_types.HKQuantityTypeIdentifierDietaryManganese[source]

Bases: HKQuantityTypeIdentifier, Nutrition

class src.model.quantity_types.HKQuantityTypeIdentifierDietaryMolybdenum[source]

Bases: HKQuantityTypeIdentifier, Nutrition

class src.model.quantity_types.HKQuantityTypeIdentifierDietaryNiacin[source]

Bases: HKQuantityTypeIdentifier, Nutrition

class src.model.quantity_types.HKQuantityTypeIdentifierDietaryPantothenicAcid[source]

Bases: HKQuantityTypeIdentifier, Nutrition

class src.model.quantity_types.HKQuantityTypeIdentifierDietaryPhosphorus[source]

Bases: HKQuantityTypeIdentifier, Nutrition

class src.model.quantity_types.HKQuantityTypeIdentifierDietaryPotassium[source]

Bases: HKQuantityTypeIdentifier, Nutrition

class src.model.quantity_types.HKQuantityTypeIdentifierDietaryProtein[source]

Bases: HKQuantityTypeIdentifier, Nutrition

class src.model.quantity_types.HKQuantityTypeIdentifierDietaryRiboflavin[source]

Bases: HKQuantityTypeIdentifier, Nutrition

class src.model.quantity_types.HKQuantityTypeIdentifierDietarySelenium[source]

Bases: HKQuantityTypeIdentifier, Nutrition

class src.model.quantity_types.HKQuantityTypeIdentifierDietarySodium[source]

Bases: HKQuantityTypeIdentifier, Nutrition

class src.model.quantity_types.HKQuantityTypeIdentifierDietarySugar[source]

Bases: HKQuantityTypeIdentifier, Nutrition

class src.model.quantity_types.HKQuantityTypeIdentifierDietaryThiamin[source]

Bases: HKQuantityTypeIdentifier, Nutrition

class src.model.quantity_types.HKQuantityTypeIdentifierDietaryVitaminA[source]

Bases: HKQuantityTypeIdentifier, Nutrition

class src.model.quantity_types.HKQuantityTypeIdentifierDietaryVitaminB12[source]

Bases: HKQuantityTypeIdentifier, Nutrition

class src.model.quantity_types.HKQuantityTypeIdentifierDietaryVitaminB6[source]

Bases: HKQuantityTypeIdentifier, Nutrition

class src.model.quantity_types.HKQuantityTypeIdentifierDietaryVitaminC[source]

Bases: HKQuantityTypeIdentifier, Nutrition

class src.model.quantity_types.HKQuantityTypeIdentifierDietaryVitaminD[source]

Bases: HKQuantityTypeIdentifier, Nutrition

class src.model.quantity_types.HKQuantityTypeIdentifierDietaryVitaminE[source]

Bases: HKQuantityTypeIdentifier, Nutrition

class src.model.quantity_types.HKQuantityTypeIdentifierDietaryVitaminK[source]

Bases: HKQuantityTypeIdentifier, Nutrition

class src.model.quantity_types.HKQuantityTypeIdentifierDietaryWater[source]

Bases: HKQuantityTypeIdentifier, Nutrition

class src.model.quantity_types.HKQuantityTypeIdentifierDietaryZinc[source]

Bases: HKQuantityTypeIdentifier, Nutrition

class src.model.quantity_types.HKQuantityTypeIdentifierDistanceCrossCountrySkiing[source]

Bases: HKQuantityTypeIdentifier, Fitness

class src.model.quantity_types.HKQuantityTypeIdentifierDistanceCycling[source]

Bases: HKQuantityTypeIdentifier, Fitness

class src.model.quantity_types.HKQuantityTypeIdentifierDistanceDownhillSnowSports[source]

Bases: HKQuantityTypeIdentifier, Fitness

class src.model.quantity_types.HKQuantityTypeIdentifierDistancePaddleSports[source]

Bases: HKQuantityTypeIdentifier, Fitness

class src.model.quantity_types.HKQuantityTypeIdentifierDistanceRowing[source]

Bases: HKQuantityTypeIdentifier, Fitness

class src.model.quantity_types.HKQuantityTypeIdentifierDistanceSkatingSports[source]

Bases: HKQuantityTypeIdentifier, Fitness

class src.model.quantity_types.HKQuantityTypeIdentifierDistanceSwimming[source]

Bases: HKQuantityTypeIdentifier, Fitness

class src.model.quantity_types.HKQuantityTypeIdentifierDistanceWalkingRunning[source]

Bases: HKQuantityTypeIdentifier, Fitness

class src.model.quantity_types.HKQuantityTypeIdentifierDistanceWheelchair[source]

Bases: HKQuantityTypeIdentifier, Fitness

class src.model.quantity_types.HKQuantityTypeIdentifierElectrodermalActivity[source]

Bases: HKQuantityTypeIdentifier, LabTestResults

class src.model.quantity_types.HKQuantityTypeIdentifierEnvironmentalAudioExposure[source]

Bases: HKQuantityTypeIdentifier, Hearing

class src.model.quantity_types.HKQuantityTypeIdentifierEnvironmentalSoundReduction[source]

Bases: HKQuantityTypeIdentifier, Hearing

class src.model.quantity_types.HKQuantityTypeIdentifierEstimatedWorkoutEffortScore[source]

Bases: HKQuantityTypeIdentifier, Fitness

class src.model.quantity_types.HKQuantityTypeIdentifierFlightsClimbed[source]

Bases: HKQuantityTypeIdentifier, Fitness

class src.model.quantity_types.HKQuantityTypeIdentifierForcedExpiratoryVolume1[source]

Bases: HKQuantityTypeIdentifier, LabTestResults

class src.model.quantity_types.HKQuantityTypeIdentifierForcedVitalCapacity[source]

Bases: HKQuantityTypeIdentifier, LabTestResults

class src.model.quantity_types.HKQuantityTypeIdentifierHeadphoneAudioExposure[source]

Bases: HKQuantityTypeIdentifier, Hearing

class src.model.quantity_types.HKQuantityTypeIdentifierHeartRate[source]

Bases: HKQuantityTypeIdentifier, VitalSigns

class src.model.quantity_types.HKQuantityTypeIdentifierHeartRateRecoveryOneMinute[source]

Bases: HKQuantityTypeIdentifier, VitalSigns

class src.model.quantity_types.HKQuantityTypeIdentifierHeartRateVariabilitySDNN[source]

Bases: HKQuantityTypeIdentifier, VitalSigns

class src.model.quantity_types.HKQuantityTypeIdentifierHeartRateVariabilitySdnn[source]

Bases: HKQuantityTypeIdentifier, VitalSigns

class src.model.quantity_types.HKQuantityTypeIdentifierHeight[source]

Bases: HKQuantityTypeIdentifier, BodyMeasurements

class src.model.quantity_types.HKQuantityTypeIdentifierInhalerUsage[source]

Bases: HKQuantityTypeIdentifier, LabTestResults

class src.model.quantity_types.HKQuantityTypeIdentifierInsulinDelivery[source]

Bases: HKQuantityTypeIdentifier, LabTestResults

class src.model.quantity_types.HKQuantityTypeIdentifierLeanBodyMass[source]

Bases: HKQuantityTypeIdentifier, BodyMeasurements

class src.model.quantity_types.HKQuantityTypeIdentifierNikeFuel[source]

Bases: HKQuantityTypeIdentifier, Fitness

class src.model.quantity_types.HKQuantityTypeIdentifierNumberOfAlcoholicBeverages[source]

Bases: HKQuantityTypeIdentifier, LabTestResults

class src.model.quantity_types.HKQuantityTypeIdentifierNumberOfTimesFallen[source]

Bases: HKQuantityTypeIdentifier, LabTestResults

class src.model.quantity_types.HKQuantityTypeIdentifierOxygenSaturation[source]

Bases: HKQuantityTypeIdentifier, VitalSigns

class src.model.quantity_types.HKQuantityTypeIdentifierPaddleSportsSpeed[source]

Bases: HKQuantityTypeIdentifier, Fitness

class src.model.quantity_types.HKQuantityTypeIdentifierPeakExpiratoryFlowRate[source]

Bases: HKQuantityTypeIdentifier, LabTestResults

class src.model.quantity_types.HKQuantityTypeIdentifierPeripheralPerfusionIndex[source]

Bases: HKQuantityTypeIdentifier, LabTestResults

class src.model.quantity_types.HKQuantityTypeIdentifierPhysicalEffort[source]

Bases: HKQuantityTypeIdentifier, Fitness

class src.model.quantity_types.HKQuantityTypeIdentifierPushCount[source]

Bases: HKQuantityTypeIdentifier, Fitness

class src.model.quantity_types.HKQuantityTypeIdentifierRespiratoryRate[source]

Bases: HKQuantityTypeIdentifier, VitalSigns

class src.model.quantity_types.HKQuantityTypeIdentifierRestingHeartRate[source]

Bases: HKQuantityTypeIdentifier, VitalSigns

class src.model.quantity_types.HKQuantityTypeIdentifierRowingSpeed[source]

Bases: HKQuantityTypeIdentifier, Fitness

class src.model.quantity_types.HKQuantityTypeIdentifierRunningGroundContactTime[source]

Bases: HKQuantityTypeIdentifier, Fitness

class src.model.quantity_types.HKQuantityTypeIdentifierRunningPower[source]

Bases: HKQuantityTypeIdentifier, Fitness

class src.model.quantity_types.HKQuantityTypeIdentifierRunningSpeed[source]

Bases: HKQuantityTypeIdentifier, Fitness

class src.model.quantity_types.HKQuantityTypeIdentifierRunningStrideLength[source]

Bases: HKQuantityTypeIdentifier, Fitness

class src.model.quantity_types.HKQuantityTypeIdentifierRunningVerticalOscillation[source]

Bases: HKQuantityTypeIdentifier, Fitness

class src.model.quantity_types.HKQuantityTypeIdentifierSixMinuteWalkTestDistance[source]

Bases: HKQuantityTypeIdentifier, Mobility

class src.model.quantity_types.HKQuantityTypeIdentifierStairAscentSpeed[source]

Bases: HKQuantityTypeIdentifier, Mobility

class src.model.quantity_types.HKQuantityTypeIdentifierStairDescentSpeed[source]

Bases: HKQuantityTypeIdentifier, Mobility

class src.model.quantity_types.HKQuantityTypeIdentifierStepCount[source]

Bases: HKQuantityTypeIdentifier, Fitness

class src.model.quantity_types.HKQuantityTypeIdentifierSwimmingStrokeCount[source]

Bases: HKQuantityTypeIdentifier, Fitness

class src.model.quantity_types.HKQuantityTypeIdentifierTimeInDaylight[source]

Bases: HKQuantityTypeIdentifier, Mindfulness

class src.model.quantity_types.HKQuantityTypeIdentifierUVExposure[source]

Bases: HKQuantityTypeIdentifier, UVExposure

class src.model.quantity_types.HKQuantityTypeIdentifierUnderwaterDepth[source]

Bases: HKQuantityTypeIdentifier, Diving

class src.model.quantity_types.HKQuantityTypeIdentifierVO2Max[source]

Bases: HKQuantityTypeIdentifier, Fitness

class src.model.quantity_types.HKQuantityTypeIdentifierWaistCircumference[source]

Bases: HKQuantityTypeIdentifier, BodyMeasurements

class src.model.quantity_types.HKQuantityTypeIdentifierWalkingAsymmetryPercentage[source]

Bases: HKQuantityTypeIdentifier, Mobility

class src.model.quantity_types.HKQuantityTypeIdentifierWalkingDoubleSupportPercentage[source]

Bases: HKQuantityTypeIdentifier, Mobility

class src.model.quantity_types.HKQuantityTypeIdentifierWalkingHeartRateAverage[source]

Bases: HKQuantityTypeIdentifier, VitalSigns

class src.model.quantity_types.HKQuantityTypeIdentifierWalkingSpeed[source]

Bases: HKQuantityTypeIdentifier, Mobility

class src.model.quantity_types.HKQuantityTypeIdentifierWalkingStepLength[source]

Bases: HKQuantityTypeIdentifier, Mobility

class src.model.quantity_types.HKQuantityTypeIdentifierWaterTemperature[source]

Bases: HKQuantityTypeIdentifier, Diving

class src.model.quantity_types.HKQuantityTypeIdentifierWorkoutEffortScore[source]

Bases: HKQuantityTypeIdentifier, Fitness