A category sample type for representing menstrual cycles.
- iOS 9.0+
- Mac Catalyst 13.0+
- watchOS 2.0+
When recording data about the user’s menstrual cycle, you can either use a single sample for the entire period, or multiple samples to record changes over the cycle. When using single samples, pass the start of the menstrual period to the
start parameter. Pass the end of the period to the
end parameter, and set the
HKMetadata value to
When using multiple samples to record a single period, the
end parameters should mark the beginning and ending of each individual sample. Set the
HKMetadata value for the first sample in the period to
false for any additional samples. Different samples can use different
menstrual values to record the changes in flow over time.