Requisitos de los metadatos

Esta guía es compatible con la versión 1.2.0-alpha05 o posterior de Health Connect.

Se realizaron cambios en los metadatos de Health Connect para los desarrolladores que se actualicen a la versión 1.1.0-alpha12 o una posterior.

Información de la biblioteca

El ID del artefacto del complemento de Android para Gradle de Google Maven identifica la biblioteca de Health Connect a la que te deberás actualizar. Agrega esta dependencia del SDK de Health Connect a tu archivo build.gradle del módulo:

dependencies {
  implementation "androidx.health.connect:connect-client:1.1.0-alpha12"
}

Cambios de metadatos

Se introdujeron dos cambios de metadatos en el SDK de Jetpack de Health Connect a partir de la versión 1.1.0-alpha12 para ayudar a verificar que existan metadatos útiles adicionales en el ecosistema. Si no se incluye metadata en tu constructor Record, es posible que veas un error Constructor internal.

Cómo especificar el método de registro

Debes especificar los detalles de los metadatos cada vez que se crea una instancia de un objeto de tipo Record().

Cuando escribas datos en Health Connect, debes especificar uno de los cuatro métodos de registro con uno de los métodos de fábrica correspondientes para crear una instancia de Metadata:

Por ejemplo:

 StepsRecord(
    startTime = Instant.ofEpochMilli(1234L),
    startZoneOffset = null,
    endTime = Instant.ofEpochMilli(1236L),
    endZoneOffset = null,
    metadata = Metadata.activelyRecorded(device = Device(type = Device.TYPE_WATCH)),
    count = 10
)
HealthConnectManager.kt

Tipo de dispositivo

Debes especificar un tipo de dispositivo para todos los datos registrados de forma automática y activa. Para obtener más detalles, consulta la clase Device en la documentación de Jetpack. Entre los tipos de dispositivos actuales, se incluyen los siguientes:

Algunos valores de Device.type solo están disponibles en versiones posteriores de Health Connect. Cuando la función de tipos de dispositivos extendidos no está disponible, estos tipos se tratan como Device.TYPE_UNKNOWN.

if (healthConnectClient
     .features
     .getFeatureStatus(
       HealthConnectFeatures.FEATURE_EXTENDED_DEVICE_TYPES
     ) == HealthConnectFeatures.FEATURE_STATUS_AVAILABLE) {

  // Feature is available
} else {
  // Feature isn't available
}

Por ejemplo:

 val WATCH_DEVICE = Device(
    manufacturer = "Google",
    model = "Pixel Watch",
    type = Device.TYPE_WATCH
)

// Phone
 val PHONE_DEVICE = Device(
    manufacturer = "Google",
    model = "Pixel 8",
    type = Device.TYPE_PHONE
)

// Ring
 val RING_DEVICE = Device(
    manufacturer = "Oura",
    model = "Ring Gen3",
    type = Device.TYPE_RING
)

// Scale
 val SCALE_DEVICE = Device(
    manufacturer = "Withings",
    model = "Body Comp",
    type = Device.TYPE_SCALE
)
HealthConnectManager.kt

Identificador único de dispositivo (UDI)

En Health Connect para Android 17 (nivel de API 37.1) o la extensión U 23 o versiones posteriores, la clase Device incluye compatibilidad con el identificador único de dispositivo (UDI). Asociar los detalles del modelo de UDI registrado de un dispositivo médico con tus registros escritos permite que las aplicaciones posteriores (como las plataformas de telemedicina o los portales clínicos) identifiquen las lecturas de grado clínico y las distingan de los datos generales de los wearables de consumo.

Declara el permiso

Para escribir detalles del UDI en Health Connect, debes declarar el permiso WRITE_DEVICE_UDI en el archivo AndroidManifest.xml de tu app:

<uses-permission android:name="android.permission.health.WRITE_DEVICE_UDI" />

Ten en cuenta que WRITE_DEVICE_UDI es un permiso normal. Debes declararlo en tu manifiesto, pero no es necesario que se lo solicites al usuario durante el tiempo de ejecución. Se otorga automáticamente a tu app en el momento de la instalación.

Escribe solo la parte del identificador del dispositivo (DI).

Un UDI completo contiene dos partes:

• Identificador del dispositivo (UDI-DI): Es un identificador reconocido a nivel mundial que una agencia emisora (por ejemplo, GS1) asigna a un modelo de dispositivo específico.
• Identificador de producción (UDI-PI): Atributos específicos de la unidad, como números de serie, números de lote, fechas de fabricación o fechas de vencimiento.

Para proteger la privacidad del usuario, solo completa la parte del UDI-DI del código en Health Connect. No incluyas ningún atributo de identificador de producción (como números de serie o de lote).

Ejemplo de código

Nota: Puedes establecer el UDI cuando construyas una instancia de Device.

val device = Device(
    type = Device.TYPE_CONSUMER_MEDICAL_DEVICE,
    manufacturer = "Omron",
    model = "HEM-7121",
    udi = "04015674011832" // Device Identifier (UDI-DI) portion only
)

val device = Device.Builder()
    .setType(Device.DEVICE_TYPE_CONSUMER_MEDICAL_DEVICE)
    .setManufacturer("Omron")
    .setModel("HEM-7121")
    .setUdi("04015674011832") // Device Identifier (UDI-DI) portion only
    .build()

Si escribes datos con un UDI sin declarar el permiso WRITE_DEVICE_UDI, Health Connect arrojará un SecurityException en el momento de la escritura.

Usa el UDI para verificar la autorización del dispositivo

Health Connect funciona como una capa de transporte y no valida la autenticidad ni el estado de registro del UDI.

Para los lectores de datos, la presencia de un UDI indica que los datos provienen de un dispositivo médico registrado. Las apps de lectura deben consultar bases de datos regulatorias, como la Base de Datos de Identificación Única de Dispositivos Global (GUDID) de la FDA o la EUDAMED de la UE, para verificar las clasificaciones de los dispositivos, el estado de autorización regulatoria (por ejemplo, Clase I, II o III) o el uso previsto específico.

Se actualizaron los fragmentos

Se actualizaron las guías de Health Connect en todos los casos en que se necesitaban fragmentos nuevos para cumplir con los nuevos requisitos de metadatos. Para ver algunos ejemplos, consulta la página sobre cómo escribir datos.

Nuevos métodos de metadatos

Ya no se puede crear una instancia de los metadatos directamente, por lo que debes usar uno de los métodos de fábrica para obtener una instancia nueva de los metadatos. Los métodos de fábrica verifican que se proporcione información del dispositivo cuando se usó un dispositivo o sensor para registrar los datos. Para los datos ingresados de forma manual, proporcionar información del dispositivo sigue siendo opcional. Cada función tiene tres variantes de firma:

• activelyRecorded

  • fun activelyRecorded(device: Device): Metadata.
  • fun activelyRecorded(clientRecordId: String, clientRecordVersion: Long = 0, device: Device): Metadata
  • fun activelyRecordedWithId(id: String, device: Device): Metadata

• autoRecorded

  • fun autoRecorded(device: Device): Metadata
  • fun autoRecorded(clientRecordId: String, clientRecordVersion: Long = 0, device: Device): Metadata
  • fun autoRecordedWithId(id: String, device: Device): Metadata

• manualEntry

  • fun manualEntry(device: Device? = null): Metadata
  • fun manualEntry(clientRecordId: String, clientRecordVersion: Long = 0, device: Device? = null): Metadata
  • fun manualEntryWithId(id: String, device: Device? = null): Metadata

• unknownRecordingMethod

  • fun unknownRecordingMethod(device: Device? = null): Metadata
  • fun unknownRecordingMethod(clientRecordId: String, clientRecordVersion: Long = 0, device: Device? = null): Metadata
  • fun unknownRecordingMethodWithId(id: String, device: Device? = null): Metadata

Para obtener más información, consulta el Proyecto de código abierto de Android.

Datos de prueba

Usa la biblioteca de pruebas y MetadataTestHelper para simular los valores de metadatos esperados:

private val TEST_METADATA =
    Metadata.unknownRecordingMethod(
        clientRecordId = "clientId",
        clientRecordVersion = 1L,
        device = Device(type = Device.TYPE_UNKNOWN),
    ).populatedWithTestValues(id = "test")

Esto simula el comportamiento de la implementación de Health Connect, que propaga automáticamente estos valores durante la inserción de registros.

Para la biblioteca de pruebas, debes agregar esta dependencia del SDK de Health Connect a tu archivo build.gradle del módulo:

dependencies {
  testImplementation "androidx.health.connect:connect-testing:1.0.0-alpha02"
}

Actualiza la biblioteca

Los pasos principales que debes seguir son los siguientes:

1. Actualiza tu biblioteca a la versión 1.1.0-alpha12.

2. Cuando compiles la biblioteca, se arrojarán errores de compilación en los que se necesiten metadatos nuevos. Para resolver estos errores y completar la migración, verifica que realices los siguientes cambios:

   • Es obligatorio especificar un método de registro cuando se construye un Record. Para ello, usa uno de los métodos de fábrica proporcionados en Metadata, como Metadata.manualEntry() o Metadata.activelyRecorded(device = Device(...)).
   • En el caso de los datos que registra un dispositivo, es obligatorio especificar un tipo de dispositivo, como Device.TYPE_WATCH o Device.TYPE_PHONE.

3. Si tu app escribe tipos de dispositivos extendidos, protégelos con FEATURE_EXTENTED_DEVICE_TYPES para evitar TYPE_UNKNOWN inesperados en los dispositivos en los que la función no está disponible.