Skip to content
AF
Health Connect reference

MenstruationFlowRecord: Health Connect menstruation data

Read from Google’s documentation on 2026-10-03 · Google’s reference page last updated 2026-06-24

MenstruationFlowRecord is Health Connect's menstruation record — an Instantaneous record in Google's Cycle Tracking category. Its read permission is android.permission.health.READ_MENSTRUATION; its write permission is android.permission.health.WRITE_MENSTRUATION. Google's reference defines no aggregate metrics on it, so it is read with readRecords rather than aggregate. Mandatory fields per Google's table: flow, metadata and time.

What Google says MenstruationFlowRecord is

Captures a description of how heavy a user's menstrual flow was (light, medium, or heavy). Each record represents a description of how heavy the user's menstrual bleeding was.

Quoted from Google’s MenstruationFlowRecord Jetpack reference, last updated 2026-06-24, read 2026-10-03.

Class
androidx.health.connect.client.records.MenstruationFlowRecord
Google's category
Cycle Tracking
Record type
Instantaneous
Unit class
none named in Google's table
Mandatory fields
flowmetadatatime
Added in (Jetpack)
1.1.0
Same table row as
MenstruationPeriodRecord

Permissions

The exact strings Google’s data-types table declares for MenstruationFlowRecord. Google’s page: “Before requesting any permissions, your app must declare them in the manifest.”

AccessPermission stringFramework reference
Readandroid.permission.health.READ_MENSTRUATIONAPI 34 · U Ext 7
Writeandroid.permission.health.WRITE_MENSTRUATIONAPI 34 · U Ext 7
AndroidManifest.xml
<uses-permission android:name="android.permission.health.READ_MENSTRUATION" />
<uses-permission android:name="android.permission.health.WRITE_MENSTRUATION" />
Kotlin — the same strings from the Jetpack helper
import androidx.health.connect.client.permission.HealthPermission
import androidx.health.connect.client.records.MenstruationFlowRecord

val permissions = setOf(
    HealthPermission.getReadPermission(MenstruationFlowRecord::class),
    HealthPermission.getWritePermission(MenstruationFlowRecord::class),
)

The 4 fields of MenstruationFlowRecord

Types and descriptions as Google’s reference prints them. The range column quotes Google’s own range annotation or sentence; a dash means Google states none, which is not the same as no validation.

FieldTypeAllowed rangeGoogle’s description
flowmandatory= FLOW_UNKNOWNInt—How heavy the user's menstrual flow was. Optional field.
metadatamandatoryMetadata—Set of common metadata associated with the written record.
timemandatoryInstant—Time the record happened.
zoneOffsetZoneOffset?—User experienced zone offset at time, or null if unknown. Providing these will help history aggregations results stay consistent should user travel. Queries with user experienced time filters will assume system current zone offset if the information is absent.

Constants

The 4 const val values Google’s reference lists on MenstruationFlowRecord, with the integer each maps to.

ConstantValueGoogle’s description
MenstruationFlowRecord.FLOW_HEAVY3—
MenstruationFlowRecord.FLOW_LIGHT1—
MenstruationFlowRecord.FLOW_MEDIUM2—
MenstruationFlowRecord.FLOW_UNKNOWN0—

Read MenstruationFlowRecord in Kotlin

The shape of Google’s own read example, with MenstruationFlowRecord and its names filled in. Get the client with HealthConnectClient.getOrCreate(context) after checking getSdkStatus.

readRecords
import androidx.health.connect.client.HealthConnectClient
import androidx.health.connect.client.records.MenstruationFlowRecord
import androidx.health.connect.client.request.ReadRecordsRequest
import androidx.health.connect.client.time.TimeRangeFilter
import java.time.Instant

suspend fun readMenstruationFlow(
    client: HealthConnectClient,
    startTime: Instant,
    endTime: Instant,
): List<MenstruationFlowRecord> {
    val response = client.readRecords(
        ReadRecordsRequest(
            MenstruationFlowRecord::class,
            timeRangeFilter = TimeRangeFilter.between(startTime, endTime),
        )
    )
    // One page of up to pageSize records (default 1000); follow
    // response.pageToken for the rest.
    return response.records
}

Setting up the client, the permission flow and Play Console declaration: integrating Health Connect step by step.

HealthKit counterpart

No verified HealthKit counterpart. The cross-platform matrix only pairs metrics checked against both Apple’s and Google’s documentation, and MenstruationFlowRecord is not among them yet. A similarly named Apple type may exist on the HealthKit reference, but a name match is not a verified mapping.

The metric on other platforms

This guide lists MenstruationFlowRecord beside the types on the other platforms this site covers whose own descriptions name the same metric, each quoted, with how each one is read.

Questions

What permission does MenstruationFlowRecord need?
Google's Health Connect data-types table (read 2026-10-03) declares android.permission.health.READ_MENSTRUATION for reading MenstruationFlowRecord and android.permission.health.WRITE_MENSTRUATION for writing it, and says apps must declare permissions in the manifest before requesting them. READ_MENSTRUATION and WRITE_MENSTRUATION are also declared for MenstruationPeriodRecord.
Can you aggregate MenstruationFlowRecord with AggregateRequest?
Not directly. As read on 2026-10-03, Google's Jetpack reference defines no AggregateMetric constants on MenstruationFlowRecord, so there is no metric to put in an AggregateRequest. Read the records with readRecords and a ReadRecordsRequest, and compute any summary yourself.
Which constants does MenstruationFlowRecord define?
Google's reference lists 4 constants on MenstruationFlowRecord, including FLOW_HEAVY = 3, FLOW_LIGHT = 1, FLOW_MEDIUM = 2 and FLOW_UNKNOWN = 0. Store the constant name or the value it maps to, and treat values you do not recognise as unknown.
Is MenstruationFlowRecord an interval, instantaneous or series record?
Google's data-types table lists MenstruationFlowRecord as Instantaneous, and defines that column as indicating "whether the data is recorded at an instant in time or over an interval". Its mandatory fields are flow, metadata and time.

Other Cycle Tracking records

All Cycle Tracking records →

Sources checked

Google’s descriptions are quoted for identification; the page layout, the capsule and the cross-platform pairing are AIFitnessAPI’s. Generated from Google’s pages by a script, not typed by hand — the same data is behind every page in the Health Connect reference.

← All Health Connect records · Every permission string