menopausalState
An identifier for samples that record a person’s menopausal state.
Declaration
static let menopausalState: HKCategoryTypeIdentifierMentioned in
Discussion
Use this category type to record which menopausal state applies at a specific point in time. Each sample is a point-in-time entry where the start date equals the end date, and the value is one of the HKCategoryValueMenopausalState cases: HKCategoryValueMenopausalState.menopause, HKCategoryValueMenopausalState.perimenopause, or HKCategoryValueMenopausalState.none.
Apps can interpret these point-in-time samples as state changes, confirmations that a state applied at a particular date, or both. When creating a menopausal state sample, the framework requires that the start date and end date be identical. Attempting to save a sample where these dates differ results in an error.