Personal Health Records
1.0.0-ballot - ballot International flag

This page is part of the Standard Personal Health Record (v1.0.0-ballot: STU1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions

Logical Model: AppleHealthKitWorkoutEvent - Detailed Descriptions

Draft as of 2024-12-18

Definitions for the AppleHealthKitWorkoutEvent logical model.

Guidance on how to interpret the contents of this table can be found here

0. AppleHealthKitWorkoutEvent
Definition

Data elements for the Apple HealthKit HKWorkoutEvent.

ShortApple HealthKit Workout Event Logical Model
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. AppleHealthKitWorkoutEvent.metadata
Definition

The metadata.

ShortThe metadata.
Control0..1
TypeBackboneElement
4. AppleHealthKitWorkoutEvent.dateInterval
Definition

The event's time and duration.

ShortThe event's time and duration.
Control0..1
TypeBackboneElement
6. AppleHealthKitWorkoutEvent.dateInterval.start
Definition

The dateInterval's start date.

ShortThe dateInterval's start date.
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. AppleHealthKitWorkoutEvent.dateInterval.end
Definition

The dateInterval's end date.

ShortThe dateInterval's end date.
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. AppleHealthKitWorkoutEvent.dateInterval.duration
Definition

The dateInterval's duration.

ShortThe dateInterval's duration.
Control0..1
TypeExtension(Organization Period) (Extension Type: Period)
12. AppleHealthKitWorkoutEvent.type
Definition

The workout event type.

ShortThe workout event type.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from Apple HealthKit Workout Event Type Value Set
(extensible to http://hl7.org/fhir/uv/phr/ValueSet/apple-health-kit-workout-event-type-value-set)
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. AppleHealthKitWorkoutEvent
Definition

Data elements for the Apple HealthKit HKWorkoutEvent.

ShortApple HealthKit Workout Event Logical Model
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. AppleHealthKitWorkoutEvent.metadata
Definition

The metadata.

ShortThe metadata.
Control0..1
TypeBackboneElement
4. AppleHealthKitWorkoutEvent.dateInterval
Definition

The event's time and duration.

ShortThe event's time and duration.
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. AppleHealthKitWorkoutEvent.dateInterval.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
8. AppleHealthKitWorkoutEvent.dateInterval.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on AppleHealthKitWorkoutEvent.dateInterval.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 10. AppleHealthKitWorkoutEvent.dateInterval.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    12. AppleHealthKitWorkoutEvent.dateInterval.start
    Definition

    The dateInterval's start date.

    ShortThe dateInterval's start date.
    Control1..1
    TypedateTime
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    14. AppleHealthKitWorkoutEvent.dateInterval.end
    Definition

    The dateInterval's end date.

    ShortThe dateInterval's end date.
    Control0..1
    TypedateTime
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    16. AppleHealthKitWorkoutEvent.dateInterval.duration
    Definition

    The dateInterval's duration.

    ShortThe dateInterval's duration.
    Control0..1
    TypeExtension(Organization Period) (Extension Type: Period)
    18. AppleHealthKitWorkoutEvent.type
    Definition

    The workout event type.

    ShortThe workout event type.
    Control1..1
    BindingUnless not suitable, these codes SHALL be taken from Apple HealthKit Workout Event Type Value Set
    (extensible to http://hl7.org/fhir/uv/phr/ValueSet/apple-health-kit-workout-event-type-value-set)
    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

    Guidance on how to interpret the contents of this table can be found here

    0. AppleHealthKitWorkoutEvent
    Definition

    Data elements for the Apple HealthKit HKWorkoutEvent.

    ShortApple HealthKit Workout Event Logical Model
    Control0..*
    Is Modifierfalse
    Logical ModelInstances of this logical model are not marked to be the target of a Reference
    2. AppleHealthKitWorkoutEvent.metadata
    Definition

    The metadata.

    ShortThe metadata.
    Control0..1
    TypeBackboneElement
    4. AppleHealthKitWorkoutEvent.dateInterval
    Definition

    The event's time and duration.

    ShortThe event's time and duration.
    Control0..1
    TypeBackboneElement
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    6. AppleHealthKitWorkoutEvent.dateInterval.id
    Definition

    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

    ShortUnique id for inter-element referencing
    Control0..1
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    8. AppleHealthKitWorkoutEvent.dateInterval.extension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

    ShortAdditional content defined by implementations
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    SlicingThis element introduces a set of slices on AppleHealthKitWorkoutEvent.dateInterval.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 10. AppleHealthKitWorkoutEvent.dateInterval.modifierExtension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

      ShortExtensions that cannot be ignored even if unrecognized
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Summarytrue
      Requirements

      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

      Alternate Namesextensions, user content, modifiers
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      12. AppleHealthKitWorkoutEvent.dateInterval.start
      Definition

      The dateInterval's start date.

      ShortThe dateInterval's start date.
      Control1..1
      TypedateTime
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      14. AppleHealthKitWorkoutEvent.dateInterval.end
      Definition

      The dateInterval's end date.

      ShortThe dateInterval's end date.
      Control0..1
      TypedateTime
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      16. AppleHealthKitWorkoutEvent.dateInterval.duration
      Definition

      The dateInterval's duration.

      ShortThe dateInterval's duration.
      Control0..1
      TypeExtension(Organization Period) (Extension Type: Period)
      18. AppleHealthKitWorkoutEvent.type
      Definition

      The workout event type.

      ShortThe workout event type.
      Control1..1
      BindingUnless not suitable, these codes SHALL be taken from Apple HealthKit Workout Event Type Value Set
      (extensible to http://hl7.org/fhir/uv/phr/ValueSet/apple-health-kit-workout-event-type-value-set)
      Typecode
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension