-
Notifications
You must be signed in to change notification settings - Fork 549
HealthKit iOS xcode26.1 b1
Alex Soto edited this page Sep 22, 2025
·
2 revisions
#HealthKit.framework
diff -ruN /Applications/Xcode_26.0.1.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk/System/Library/Frameworks/HealthKit.framework/Headers/HKClinicalCoding.h /Applications/Xcode_26.1.0-beta.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk/System/Library/Frameworks/HealthKit.framework/Headers/HKClinicalCoding.h
--- /Applications/Xcode_26.0.1.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk/System/Library/Frameworks/HealthKit.framework/Headers/HKClinicalCoding.h 2025-08-26 23:34:10
+++ /Applications/Xcode_26.1.0-beta.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk/System/Library/Frameworks/HealthKit.framework/Headers/HKClinicalCoding.h 2025-09-17 02:45:42
@@ -10,45 +10,42 @@
NS_ASSUME_NONNULL_BEGIN
-/*!
- @class HKClinicalCoding
- @abstract A coding embedded within a system.
- @discussion Typically represents a single abstract concept within a coding system. This model is closely related to the FHIR model for codings. (https://build.fhir.org/datatypes.html#Coding)
- */
+/// A clinical coding that represents a medical concept using a standardized coding system.
+///
+/// A clinical coding pairs a ``system``, an optional ``version``,
+/// and a ``code`` which identify a medical concept.
+///
+/// This model is closely related to the [FHIR Coding model](https://build.fhir.org/datatypes.html#Coding).
HK_EXTERN
NS_SWIFT_SENDABLE
API_AVAILABLE(ios(26.0), watchos(26.0), macCatalyst(26.0), macos(26.0), visionos(26.0))
@interface HKClinicalCoding : NSObject <NSCopying, NSSecureCoding>
-/*!
- @property system
- @abstract A string identifier that uniquely represents a system.
- @discussion In most cases, it will be the canonical reference URL for the coding system with respect to the HL7 Terminology. For the system RxNorm, for example, this would be "http://www.nlm.nih.gov/research/umls/rxnorm", according to https://terminology.hl7.org/CodeSystem-v3-rxNorm.html.
- */
+
+/// The string that identifies the coding system that defines this clinical code.
+///
+/// The system is usually expressed as a URL from the [HL7 Terminology](https://terminology.hl7.org/).
+/// For example, the RxNorm, a coding system for medications uses:
+/// `http://www.nlm.nih.gov/research/umls/rxnorm`.
@property (nonatomic, copy, readonly) NSString *system;
-/*!
- @property version
- @abstract The version of the coding system, if it is relevant.
- */
+/// The version of the coding system.
@property (nonatomic, copy, readonly, nullable) NSString *version;
-/*!
- @property code
- @abstract The code for this concept.
- @discussion The format of this code varies within each system.
- */
+/// The clinical code that represents a medical concept inside the coding system.
+///
+/// The format depends on the coding system. For example, RxNorm codes are numeric.
@property (nonatomic, copy, readonly) NSString *code;
- (instancetype)init NS_UNAVAILABLE;
-/*!
- @method initWithSystem:version:code:
- @abstract Initializer for a clinical coding.
-
- @param system The system for this clinical coding.
- @param version A version, if applicable.
- @param code The actual code.
- */
+/// Creates a clinical coding with the specified system, version, and code.
+///
+/// @param system The string that identifies the coding system, typically a HL7 URL.
+/// @param version The version of the system, if applicable.
+/// @param code The clinical code string that represents the medical concept.
+///
+/// Use when you need to explicitly construct a coding object to associate
+/// a HealthKit concept with a standardized medical code.
- (instancetype)initWithSystem:(NSString *)system
version:(nullable NSString *)version
code:(NSString *)code;
diff -ruN /Applications/Xcode_26.0.1.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk/System/Library/Frameworks/HealthKit.framework/Headers/HKHealthConceptIdentifier.h /Applications/Xcode_26.1.0-beta.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk/System/Library/Frameworks/HealthKit.framework/Headers/HKHealthConceptIdentifier.h
--- /Applications/Xcode_26.0.1.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk/System/Library/Frameworks/HealthKit.framework/Headers/HKHealthConceptIdentifier.h 2025-08-26 23:34:10
+++ /Applications/Xcode_26.1.0-beta.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk/System/Library/Frameworks/HealthKit.framework/Headers/HKHealthConceptIdentifier.h 2025-09-17 02:45:43
@@ -13,27 +13,30 @@
#pragma mark - Concepts
-/// Represents the domain of a HKHealthConceptIdentifier
+/// A domain that represents a health concept.
+///
+/// A health concept describes what type of medical information a concept belongs to.
+/// For example, the medication domain groups all medication concepts together.
typedef NSString * HKHealthConceptDomain NS_TYPED_ENUM API_AVAILABLE(ios(26.0), watchos(26.0), macCatalyst(26.0), macos(26.0), visionos(26.0));
-/// The domain that represents medication concept identifiers
+/// The domain that represents medication concepts.
+///
+/// Use with identifiers for medications, such as ibuprofen or insulin.
HK_EXTERN HKHealthConceptDomain const HKHealthConceptDomainMedication API_AVAILABLE(ios(26.0), watchos(26.0), macCatalyst(26.0), macos(26.0), visionos(26.0));
-/*!
- @class HKHealthConceptIdentifier
- @abstract The identifier that differentiates concepts from each other.
- @discussion This identifier is internally unique to each concept within a domain.
- */
+/// A unique identifier for a specific health concept within a domain.
+///
+/// Each identifier points to one concept inside a domain. For example, within the medication
+/// domain, one identifier might represent ibuprofen while another represents insulin.
HK_EXTERN
NS_SWIFT_SENDABLE
API_AVAILABLE(ios(26.0), watchos(26.0), macCatalyst(26.0), macos(26.0), visionos(26.0))
@interface HKHealthConceptIdentifier : NSObject <NSSecureCoding, NSCopying>
-/*!
- @property domain
- @abstract The domain of this identifier.
- @discussion A string that represents the domain this identifier is understood within.
- */
+/// The domain this identifier belongs to.
+///
+/// This value identifies the group of concepts the identifier comes from. For example,
+/// if the identifier represents a medication, the category will be the medication domain.
@property (nonatomic, copy, readonly) HKHealthConceptDomain domain;
- (instancetype)init NS_UNAVAILABLE;
diff -ruN /Applications/Xcode_26.0.1.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk/System/Library/Frameworks/HealthKit.framework/Headers/HKMedicationConcept.h /Applications/Xcode_26.1.0-beta.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk/System/Library/Frameworks/HealthKit.framework/Headers/HKMedicationConcept.h
--- /Applications/Xcode_26.0.1.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk/System/Library/Frameworks/HealthKit.framework/Headers/HKMedicationConcept.h 2025-08-26 23:34:08
+++ /Applications/Xcode_26.1.0-beta.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk/System/Library/Frameworks/HealthKit.framework/Headers/HKMedicationConcept.h 2025-09-08 03:17:47
@@ -14,64 +14,78 @@
NS_ASSUME_NONNULL_BEGIN
-/// Represents a medications general form.
+/// The manufactured form of a medication.
typedef NSString * NS_TYPED_ENUM HKMedicationGeneralForm;
+/// The medication comes in capsule form, such as a hard-shell capsule or softgel.
HK_EXTERN HKMedicationGeneralForm const HKMedicationGeneralFormCapsule;
+/// The medication is applied as a cream.
HK_EXTERN HKMedicationGeneralForm const HKMedicationGeneralFormCream;
+/// The medication is administered through a device, such as an infusion pump for controlled fluid delivery.
HK_EXTERN HKMedicationGeneralForm const HKMedicationGeneralFormDevice;
+/// The medication is taken as drops, for example eye drops or ear drops.
HK_EXTERN HKMedicationGeneralForm const HKMedicationGeneralFormDrops;
+/// The medication is applied as a foam.
HK_EXTERN HKMedicationGeneralForm const HKMedicationGeneralFormFoam;
+/// The medication is applied as a gel.
HK_EXTERN HKMedicationGeneralForm const HKMedicationGeneralFormGel;
+/// The medication is delivered through an inhaler.
HK_EXTERN HKMedicationGeneralForm const HKMedicationGeneralFormInhaler;
+/// The medication is given as an injection.
HK_EXTERN HKMedicationGeneralForm const HKMedicationGeneralFormInjection;
+/// The medication is taken as a liquid, such as a syrup.
HK_EXTERN HKMedicationGeneralForm const HKMedicationGeneralFormLiquid;
+/// The medication is applied as a lotion.
HK_EXTERN HKMedicationGeneralForm const HKMedicationGeneralFormLotion;
+/// The medication is applied as an ointment.
HK_EXTERN HKMedicationGeneralForm const HKMedicationGeneralFormOintment;
+/// The medication is applied as a patch worn on the skin.
HK_EXTERN HKMedicationGeneralForm const HKMedicationGeneralFormPatch;
+/// The medication is taken as a powder.
HK_EXTERN HKMedicationGeneralForm const HKMedicationGeneralFormPowder;
+/// The medication is delivered as a spray, for example a nasal spray or throat spray.
HK_EXTERN HKMedicationGeneralForm const HKMedicationGeneralFormSpray;
+/// The medication is delivered as a suppository.
HK_EXTERN HKMedicationGeneralForm const HKMedicationGeneralFormSuppository;
+/// The medication comes in tablet form, such as a pill or caplet.
HK_EXTERN HKMedicationGeneralForm const HKMedicationGeneralFormTablet;
+/// The medication is applied topically in a form that wasn't specified.
HK_EXTERN HKMedicationGeneralForm const HKMedicationGeneralFormTopical;
+/// The system doesn't know the general form of the medication.
HK_EXTERN HKMedicationGeneralForm const HKMedicationGeneralFormUnknown;
-/*!
- @class HKMedicationConcept
- @abstract An object that represents the concept of a medication.
- @discussion Medications can have clinical significance, or can be created by the user.
- */
+/// An object that describes a specific medication concept.
+///
+/// A medication concept represents the idea of a medication, like ibuprofen or insulin.
+/// It can have clinical significance, or can be created by the person using your app.
HK_EXTERN
NS_SWIFT_SENDABLE
API_AVAILABLE(ios(26.0), watchos(26.0), macCatalyst(26.0), macos(26.0), visionos(26.0))
@interface HKMedicationConcept : NSObject <NSSecureCoding, NSCopying>
-/*!
- @property identifier
- @abstract A unique identifier that differentiates concepts from each other.
- @discussion One medication concept will have a stable identifier across multiple devices, and can be used for direct comparison.
- */
+/// The unique identifier for the specific medication concept.
+///
+/// Each concept has one stable identifier that stays the same across devices.
+/// You can use this identifier to directly compare medications, for example,
+/// to check whether two objects represent the same medication.
@property (nonatomic, copy, readonly) HKHealthConceptIdentifier *identifier;
-/*!
- @property displayText
- @abstract An unlocalized string suitable for display.
- @discussion The name of the medication entered or selected during medication onboarding.
- */
+/// The display name for this medication.
+///
+/// The name of the medication a person enters or selects during medication onboarding.
@property (nonatomic, copy, readonly) NSString *displayText;
-/*!
- @property generalForm
- @abstract The general form this medication is manufactured in.
- @discussion A general manufactured dose form for this medication.
- */
+/// The general form the medication is manufactured in.
+///
+/// A general manufactured dose form for the specific medication.
+/// This value tells you the manufactured form of the medication,
+/// such as tablet, capsule, cream, injection, or inhaler.
@property (nonatomic, copy, readonly) HKMedicationGeneralForm generalForm;
-/*!
- @property relatedCodings
- @abstract A list of potentially related codings.
- @discussion Contains a set of relevant codes for this particular medication.
- */
+/// The set of related clinical codings for the medication.
+///
+/// Each coding links the medication to an external medical terminology system,
+/// such as RxNorm.
@property (nonatomic, copy, readonly) NSSet<HKClinicalCoding *> *relatedCodings;
- (instancetype)init NS_UNAVAILABLE;
diff -ruN /Applications/Xcode_26.0.1.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk/System/Library/Frameworks/HealthKit.framework/Headers/HKMedicationDoseEvent.h /Applications/Xcode_26.1.0-beta.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk/System/Library/Frameworks/HealthKit.framework/Headers/HKMedicationDoseEvent.h
--- /Applications/Xcode_26.0.1.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk/System/Library/Frameworks/HealthKit.framework/Headers/HKMedicationDoseEvent.h 2025-08-12 23:33:35
+++ /Applications/Xcode_26.1.0-beta.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk/System/Library/Frameworks/HealthKit.framework/Headers/HKMedicationDoseEvent.h 2025-09-09 00:09:37
@@ -15,36 +15,37 @@
NS_ASSUME_NONNULL_BEGIN
-/*!
- @enum HKMedicationDoseEventLogStatus
- @abstract The possible statuses of a logged HKMedicationDoseEvent
-
- @constant HKMedicationDoseEventLogStatusNotInteracted User has not logged information for a scheduled medication. System generated status.
- @constant HKMedicationDoseEventLogStatusNotificationNotSent Could not deliver a notification for a scheduled medication. System generated status.
- @constant HKMedicationDoseEventLogStatusSnoozed User snoozed the notification.
- @constant HKMedicationDoseEventLogStatusTaken Logged the medication dose as taken.
- @constant HKMedicationDoseEventLogStatusSkipped Logged the medication dose as skipped.
- @constant HKMedicationDoseEventLogStatusNotLogged User has undone logging.
- */
-
+/// The statuses the system assigns to a logged medication dose event.
typedef NS_ENUM(NSInteger, HKMedicationDoseEventLogStatus) {
+ /// The person doesn't interact with a scheduled medication reminder.
+ ///
+ /// The system generates this to represent an untouched reminder slot.
HKMedicationDoseEventLogStatusNotInteracted = 1,
+ /// The system assigns this status when it fails to deliver a scheduled medication notification.
+ ///
+ /// The system can generate this status because of a person's notification
+ /// restrictions or issues with notification delivery.
HKMedicationDoseEventLogStatusNotificationNotSent,
+ /// The person snoozes a scheduled medication notification.
HKMedicationDoseEventLogStatusSnoozed,
+ /// The person logs that they took the medication dose.
HKMedicationDoseEventLogStatusTaken,
+ /// The person logs that they skipped the medication dose.
HKMedicationDoseEventLogStatusSkipped,
+ /// The person undoes a previously logged medication status.
+ ///
+ /// The system clears the prior status.
HKMedicationDoseEventLogStatusNotLogged,
} API_AVAILABLE(ios(26.0), watchos(26.0), macCatalyst(26.0), macos(26.0), visionos(26.0)) NS_SWIFT_NAME(HKMedicationDoseEvent.LogStatus);
-/*!
- @enum HKMedicationDoseEventScheduleType
- @abstract The kind of schedule used to log this dose event.
-
- @constant HKMedicationDoseEventScheduleTypeAsNeeded The dose event was created while logging a medication as needed.
- @constant HKMedicationDoseEventScheduleTypeSchedule The dose event was created while logging a medication from a scheduled event.
- */
+/// The kind of schedule the system associates with a logged medication dose event.
+///
+/// Each value tells you whether the person logged the dose ad-hoc or
+/// in response to a scheduled medication reminder.
typedef NS_ENUM(NSInteger, HKMedicationDoseEventScheduleType) {
+ /// The person logged this dose event ad-hoc, outside of any scheduled reminder.
HKMedicationDoseEventScheduleTypeAsNeeded = 1,
+ /// The person logged this dose event in response to a scheduled medication reminder.
HKMedicationDoseEventScheduleTypeSchedule
} API_AVAILABLE(ios(26.0), watchos(26.0), macCatalyst(26.0), macos(26.0), visionos(26.0)) NS_SWIFT_NAME(HKMedicationDoseEvent.ScheduleType);
@@ -53,57 +54,45 @@
API_AVAILABLE(ios(26.0), watchos(26.0), macCatalyst(26.0), macos(26.0), visionos(26.0))
@interface HKMedicationDoseEvent : HKSample <NSSecureCoding, NSCopying>
-/*!
-@property medicationDoseEventType
-@abstract The data type of the HKMedicationDoseEvent object.
-*/
+/// The data type that identified the samples that store medication dose event data.
+///
+/// You use this type when creating queries or filtering results by sample type.
@property (readonly, copy) HKMedicationDoseEventType *medicationDoseEventType;
-/*!
-@property scheduleType
-@abstract The impetus behind the dose event.
-@discussion HKMedicationDoseEventScheduleTypeAsNeeded for doses logged as needed, and HKMedicationDoseEventScheduleTypeSchedule for doses logged from a scheduled event.
-*/
+/// The scheduling context for this logged dose event.
+///
+/// The system sets this to ``HKMedicationDoseEvent/ScheduleType/asNeeded`` when the person
+/// logs a dose without a schedule and ``HKMedicationDoseEvent/ScheduleType/schedule`` when a person logs a dose
+/// from a scheduled medication reminder.
@property (nonatomic, assign, readonly) HKMedicationDoseEventScheduleType scheduleType;
-/*!
-@property medicationConceptIdentifier
-@abstract A unique identifier of the medication concept for which the dose event was created for, used to relate the dose event to the backing HKMedicationConcept object.
-*/
+/// The identifier of the medication concept the system associates with this dose event.
+///
+/// The system uses this identifier to link the dose event back to its ``HKMedicationConcept`` object.
@property (nonatomic, copy, readonly) HKHealthConceptIdentifier *medicationConceptIdentifier;
-/*!
-@property scheduledDate
-@abstract The time that the medication dose was supposed to be taken.
-@discussion Always non-null for scheduled medication dose events, always null for as needed dose events.
-*/
+/// The date and time the person takes the medication, if scheduled.
+///
+/// The value is always non-null for ``HKMedicationDoseEvent/ScheduleType/schedule`` and always null for ``HKMedicationDoseEvent/ScheduleType/asNeeded``.
@property (nonatomic, copy, readonly, nullable) NSDate *scheduledDate;
-/*!
-@property scheduledDoseQuantity
-@abstract The dose quantity a user is expected to take per the user's schedule.
-@discussion Always non-null for scheduled medication dose events, always null for as needed dose events.
-*/
+/// The dose quantity a person is expected to take based on their medication schedule.
+///
+/// The value is always non-null for ``HKMedicationDoseEvent/ScheduleType/schedule``, and always null for ``HKMedicationDoseEvent/ScheduleType/asNeeded``.
@property (nonatomic, copy, readonly, nullable) NSNumber *scheduledDoseQuantity NS_REFINED_FOR_SWIFT;
-/*!
-@property doseQuantity
-@abstract The dose quantity the user indicates has actually been taken.
-@discussion For scheduled dose events, defaults to the scheduledDoseQuantity, when logged from a reminder. For as needed dose events, defaults to 1 in the medication tracking experience, but can be edited by the user at any time.
-*/
+/// The dose quantity the person reports as taken.
+///
+/// For scheduled dose events, the value defaults to the ``HKMedicationDoseEvent/scheduledDoseQuantity-477ge``, when logged from a
+/// reminder. For as needed dose events, the value defaults to `1` in the medication tracking experience, but can always be edited by the person logging.
@property (nonatomic, copy, readonly, nullable) NSNumber *doseQuantity NS_REFINED_FOR_SWIFT;
-/*!
-@property logStatus
-@abstract The log status of HKMedicationDoseEvent sample.
-*/
+/// The log status the system assigns to this dose event.
@property (nonatomic, assign, readonly) HKMedicationDoseEventLogStatus logStatus;
-
-/*!
-@property unit
-@abstract The unit that the associated medication had associated at time the user logged the dose event.
-*/
+/// The unit that the system associates with the medication when the person logs the dose.
+///
+/// This ensures that the dose quantity is recorded with the correct measurement unit.
@property (nonatomic, copy, readonly, nonnull) HKUnit *unit;
- (instancetype)init NS_UNAVAILABLE;
@@ -111,10 +100,13 @@
@end
-// Predicate Key Paths
+/// The key path you use to create predicates that query by a dose event’s log status.
HK_EXTERN NSString * const HKPredicateKeyPathStatus API_AVAILABLE(ios(26.0), watchos(26.0), macCatalyst(26.0), macos(26.0), visionos(26.0));
+/// The key path you use to create predicates that query by the dose event's medication log origin.
HK_EXTERN NSString * const HKPredicateKeyPathLogOrigin API_AVAILABLE(ios(26.0), watchos(26.0), macCatalyst(26.0), macos(26.0), visionos(26.0));
+/// The key path you use to create predicates that query by the dose event's scheduled date.
HK_EXTERN NSString * const HKPredicateKeyPathScheduledDate API_AVAILABLE(ios(26.0), watchos(26.0), macCatalyst(26.0), macos(26.0), visionos(26.0));
+/// The key path you use to create predicates that query by the dose event's medication concept identifier.
HK_EXTERN NSString * const HKPredicateKeyPathMedicationConceptIdentifier API_AVAILABLE(ios(26.0), watchos(26.0), macCatalyst(26.0), macos(26.0), visionos(26.0));
NS_ASSUME_NONNULL_END
diff -ruN /Applications/Xcode_26.0.1.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk/System/Library/Frameworks/HealthKit.framework/Headers/HKUserAnnotatedMedication.h /Applications/Xcode_26.1.0-beta.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk/System/Library/Frameworks/HealthKit.framework/Headers/HKUserAnnotatedMedication.h
--- /Applications/Xcode_26.0.1.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk/System/Library/Frameworks/HealthKit.framework/Headers/HKUserAnnotatedMedication.h 2025-08-26 23:34:09
+++ /Applications/Xcode_26.1.0-beta.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk/System/Library/Frameworks/HealthKit.framework/Headers/HKUserAnnotatedMedication.h 2025-09-17 02:45:42
@@ -14,49 +14,47 @@
NS_ASSUME_NONNULL_BEGIN
-/*!
- @class HKUserAnnotatedMedication
- @abstract An object that contains all of the user-customizable details relevant to the medication tracking experience and a reference to a medication being tracked.
- */
+/// A reference to the tracked medication and the details a person can customize.
+///
+/// The details are relevant to the medication tracking experience.
HK_EXTERN
NS_SWIFT_SENDABLE
API_AVAILABLE(ios(26.0), watchos(26.0), macCatalyst(26.0), macos(26.0), visionos(26.0))
@interface HKUserAnnotatedMedication : NSObject <NSSecureCoding, NSCopying>
-/*!
- @property nickname
- @abstract The nickname a added to a medication during the entry experience.
- @discussion This can be edited at any point.
- */
+/// The nickname that a person added to a medication during the entry experience.
+///
+/// This can be edited at any point.
@property (nonatomic, copy, readonly, nullable) NSString *nickname;
-/*!
- @property isArchived
- @abstract A boolean value indicating if a medication is archived.
- @discussion True if a user moves a medication to the archived section in the medication tracking experience. False if a medication is not in the archived section.
- */
+/// A Boolean value that indicates whether a medication is archived.
+///
+/// The value is `true` if a person moves a medication to the archived section in the Health App.
+/// The value is `false` if a medication isn't in the archived section.
@property (nonatomic, assign, readonly) BOOL isArchived;
-/*!
- @property hasSchedule
- @abstract A boolean value indicating if a medication has a schedule set up.
- @discussion True if a user has set up reminders for a medication. False for "As Needed" medications.
- */
+/// A Boolean value that indicates whether a medication has a schedule set up.
+///
+/// The value is `true` for medications for which a person has set up reminders and `false` for medications that are only taken as needed.
+/// > Note: Scheduled medications can still be taken as needed.
@property (nonatomic, assign, readonly) BOOL hasSchedule;
-/*!
- @property medication
- @abstract A reference to the specific medication a user is tracking.
- @discussion This concept's identifier is directly associated with the logged dose events.
- */
+/// A reference to the specific medication a person is tracking.
+///
+/// This concept's identifier is directly associated with the logged dose events.
@property (nonatomic, copy, readonly) HKMedicationConcept *medication;
- (instancetype)init NS_UNAVAILABLE;
@end
-// Predicate Key Paths
+/// The key path you use to create predicates for the medication's archived status.
+///
+/// Use to predicate against the ``HKUserAnnotatedMedication/isArchived`` property of a medication.
HK_EXTERN NSString * const HKUserAnnotatedMedicationPredicateKeyPathIsArchived API_AVAILABLE(ios(26.0), watchos(26.0), macCatalyst(26.0), macos(26.0), visionos(26.0));
+/// The key path you use to create predicates for whether or not a medication has a schedule.
+///
+/// Use to predicate against the ``HKUserAnnotatedMedication/hasSchedule`` property of a medication.
HK_EXTERN NSString * const HKUserAnnotatedMedicationPredicateKeyPathHasSchedule API_AVAILABLE(ios(26.0), watchos(26.0), macCatalyst(26.0), macos(26.0), visionos(26.0));
NS_ASSUME_NONNULL_END