Требования к метаданным

Это руководство совместимо с платформой "Здоровье и спорт" версии 1.2.0-alpha05 или более поздней.

В метаданных платформы "Здоровье и спорт" произошли изменения, которые затронут разработчиков, обновивших приложение до версии 1.1.0-alpha12 или более поздней.

Информация о библиотеке

Идентификатор артефакта плагина Google Maven Android Gradle определяет библиотеку приложения "Здоровье и спорт", до которой вам нужно обновиться. Добавьте зависимость Health Connect SDK в файл build.gradle на уровне модуля:

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

Изменения метаданных

В Jetpack SDK платформы "Здоровье и спорт" версии 1.1.0-alpha12 были добавлены два изменения метаданных, которые помогают проверять наличие дополнительных полезных метаданных в экосистеме. Если в конструкторе Record не указан параметр metadata, может возникнуть ошибка Constructor internal.

Укажите способ записи

При создании экземпляра объекта типа Record() необходимо указать метаданные.

При записи данных в Здоровье и спорт необходимо указать один из четырех методов записи, используя один из соответствующих фабричных методов для создания экземпляра Metadata:

Пример:

 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

Тип устройства

Для всех автоматически и активно записываемых данных необходимо указать тип устройства. Подробную информацию можно найти в документации по классу Device в Jetpack. В настоящее время поддерживаются следующие типы устройств:

Некоторые значения Device.type доступны только в более поздних версиях платформы "Здоровье и спорт". Если функция расширенных типов устройств недоступна, эти типы обрабатываются как Device.TYPE_UNKNOWN.

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

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

Пример:

 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

Уникальный идентификатор устройства (UDI)

В приложении "Здоровье и спорт" в Android 17 (уровень API 37.1) или U extension 23 и более поздних версиях класс Device поддерживает уникальный идентификатор устройства (UDI). Связывание зарегистрированных сведений о модели UDI медицинского изделия с вашими записями позволяет последующим приложениям (например, платформам телемедицины или клиническим порталам) идентифицировать показания клинического уровня и отличать их от общих данных потребительских носимых устройств.

Объявите разрешение

Чтобы записывать сведения об UDI в сервис "Здоровье и спорт", необходимо объявить разрешение WRITE_DEVICE_UDI в файле AndroidManifest.xml приложения:

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

Обратите внимание, что WRITE_DEVICE_UDI – это обычное разрешение. Его нужно объявить в манифесте, но запрашивать у пользователя во время выполнения не требуется. Оно автоматически предоставляется приложению при установке.

Укажите только идентификатор устройства (DI)

Полный UDI состоит из двух частей:

• Идентификатор устройства (UDI-DI). Общепринятый идентификатор, который присваивается определенной модели устройства уполномоченным агентством, например GS1.
• Идентификатор производства (UDI-PI) – атрибуты, относящиеся к конкретному устройству, например серийный номер, номер партии, дата производства или срок годности.

Чтобы защитить конфиденциальность пользователя, указывайте в Здоровье и спорте только идентификатор устройства. Не включайте атрибуты идентификаторов товара (например, серийные номера или номера партий).

Пример кода

Примечание. Вы можете задать UDI при создании экземпляра 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()

Если вы попытаетесь записать данные с UDI, не объявив разрешение WRITE_DEVICE_UDI, Здоровье и спорт выдаст ошибку SecurityException.

Используйте UDI, чтобы проверить разрешение на использование устройства

Платформа "Здоровье и спорт" служит транспортным уровнем и не проверяет подлинность или статус регистрации UDI.

Для средств чтения данных наличие UDI указывает на то, что данные поступают от зарегистрированного медицинского изделия. Приложения для считывания должны запрашивать информацию из баз данных регулирующих органов, таких как Глобальная база данных уникальных идентификаторов устройств (GUDID) Управления по санитарному надзору за качеством пищевых продуктов и медикаментов США (FDA) или Европейская база данных по медицинским изделиям (EUDAMED), чтобы проверять классификацию устройств, статус разрешения регулирующих органов (например, класс I, II или III) или конкретное назначение.

Фрагменты обновлены.

Руководства по платформе "Здоровье и спорт" были обновлены, чтобы соответствовать новым требованиям к метаданным. Примеры приведены на странице Запись данных.

Новые методы метаданных

Метаданные больше нельзя создавать напрямую, поэтому используйте один из фабричных методов, чтобы получить новый экземпляр метаданных. Фабричные методы проверяют, предоставлена ли информация об устройстве, когда для записи данных использовалось устройство или датчик. Для данных, введенных вручную, предоставление информации об устройстве остается необязательным. У каждой функции есть три варианта сигнатуры:

• 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

Дополнительную информацию можно найти на сайте Android Open Source Project.

Тестовые данные

Используйте Testing Library и MetadataTestHelper, чтобы имитировать ожидаемые значения метаданных:

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

Это имитирует поведение реализации Здоровье и спорт, которая автоматически заполняет эти значения во время вставки записи.

Чтобы использовать библиотеку тестирования, добавьте в файл build.gradle на уровне модуля следующую зависимость SDK Здоровья и спорта:

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

Обновление библиотеки

Основные этапы:

1. Обновите библиотеку до версии 1.1.0-alpha12.

2. При сборке библиотеки будут возникать ошибки компиляции, указывающие на необходимость добавления новых метаданных. Чтобы устранить эти ошибки и завершить перенос, внесите следующие изменения:

   • При создании объекта Record необходимо указать метод записи. Для этого используется один из фабричных методов, доступных в Metadata, например Metadata.manualEntry() или Metadata.activelyRecorded(device = Device(...)).
   • Для данных, записанных устройством, необходимо указать тип устройства, например Device.TYPE_WATCH или Device.TYPE_PHONE.

3. Если ваше приложение записывает данные о дополнительных типах устройств, ограничьте их с помощью FEATURE_EXTENTED_DEVICE_TYPES, чтобы избежать непредвиденных ошибок TYPE_UNKNOWN на устройствах, где эта функция недоступна.