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: AppleHealthKitSample - Detailed Descriptions

Draft as of 2024-12-18

Definitions for the AppleHealthKitSample logical model.

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

0. AppleHealthKitSample
Definition

Data elements for the Apple HealthKit HKSample.

ShortApple HealthKit Sample Logical Model
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. AppleHealthKitSample.startDate
Definition

The sample's start date.

ShortThe sample's start date.
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. AppleHealthKitSample.endDate
Definition

The sample's end date.

ShortThe sample's end date.
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. AppleHealthKitSample.hasUndeterminedDuration
Definition

Indicates whether the sample has an unknown duration.

ShortIndicates whether the sample has an unknown duration.
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. AppleHealthKitSample.sampleType
Definition

The sample type.

ShortThe sample type.
Control1..1
BindingUnless not suitable, these codes SHALL be taken from Apple HealthKit Sample Type Value Set
(extensible to http://hl7.org/fhir/uv/phr/ValueSet/apple-health-kit-sample-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. AppleHealthKitSample
Definition

Data elements for the Apple HealthKit HKSample.

ShortApple HealthKit Sample Logical Model
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. AppleHealthKitSample.uuid
Definition

The universally unique identifier (UUID) for this HealthKit object.

ShortThe universally unique identifier (UUID) for this HealthKit object.
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. AppleHealthKitSample.metadata
Definition

The metadata for this HealthKit object.

ShortThe metadata for this HealthKit object.
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. AppleHealthKitSample.metadata.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. AppleHealthKitSample.metadata.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 AppleHealthKitSample.metadata.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 10. AppleHealthKitSample.metadata.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. AppleHealthKitSample.metadata.key
    Definition

    Constants used to add metadata to objects stored in HealthKit.

    ShortConstants used to add metadata to objects stored in HealthKit.
    Control1..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    14. AppleHealthKitSample.metadata.value[x]
    Definition

    The metadata dictionary value.

    ShortThe metadata dictionary value.
    Control1..1
    TypeChoice of: string, dateTime, integer, decimal, boolean, positiveInt, unsignedInt
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    16. AppleHealthKitSample.device
    Definition

    The device that generated the data for this object.

    ShortThe device that generated the data for this object.
    Control0..1
    TypeBackboneElement
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    18. AppleHealthKitSample.device.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
    20. AppleHealthKitSample.device.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 AppleHealthKitSample.device.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 22. AppleHealthKitSample.device.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())
      24. AppleHealthKitSample.device.udiDeviceIdentifier
      Definition

      The device identifier portion of the US Food and Drug Administration’s Unique Device Identifier (UDI).

      ShortThe device identifier portion of the US Food and Drug Administration’s Unique Device Identifier (UDI).
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      26. AppleHealthKitSample.device.firmwareVersion
      Definition

      An arbitrary string representing the current version of the firmware running on the device.

      ShortAn arbitrary string representing the current version of the firmware running on the device.
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      28. AppleHealthKitSample.device.hardwareVersion
      Definition

      An arbitrary string representing the hardware version of the device.

      ShortAn arbitrary string representing the hardware version of the device.
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      30. AppleHealthKitSample.device.localIdentifier
      Definition

      An identifier that uniquely identifies the device object on the hardware running this code.

      ShortAn identifier that uniquely identifies the device object on the hardware running this code.
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      32. AppleHealthKitSample.device.manufacturer
      Definition

      A string representing the device’s manufacturer.

      ShortA string representing the device’s manufacturer.
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      34. AppleHealthKitSample.device.model
      Definition

      A string representing the device’s model.

      ShortA string representing the device’s model.
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      36. AppleHealthKitSample.device.name
      Definition

      The user-facing name for the device.

      ShortThe user-facing name for the device.
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      38. AppleHealthKitSample.device.softwareVersion
      Definition

      An arbitrary string representing the version of the software running on the device.

      ShortAn arbitrary string representing the version of the software running on the device.
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      40. AppleHealthKitSample.sourceRevision
      Definition

      The app or device that created this object.

      ShortThe app or device that created this object.
      Control1..1
      TypeBackboneElement
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      42. AppleHealthKitSample.sourceRevision.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
      44. AppleHealthKitSample.sourceRevision.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 AppleHealthKitSample.sourceRevision.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 46. AppleHealthKitSample.sourceRevision.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())
        48. AppleHealthKitSample.sourceRevision.source
        Definition

        The source for a sample.

        ShortThe source for a sample.
        Control1..1
        TypeBackboneElement
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        50. AppleHealthKitSample.sourceRevision.source.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
        52. AppleHealthKitSample.sourceRevision.source.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 AppleHealthKitSample.sourceRevision.source.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 54. AppleHealthKitSample.sourceRevision.source.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())
          56. AppleHealthKitSample.sourceRevision.source.bundleIdentifier
          Definition

          The source’s bundle identifier.

          ShortThe source’s bundle identifier.
          Control1..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          58. AppleHealthKitSample.sourceRevision.source.name
          Definition

          The source’s name.

          ShortThe source’s name.
          Control1..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          60. AppleHealthKitSample.sourceRevision.version
          Definition

          A string that identifies a particular version of the source.

          ShortA string that identifies a particular version of the source.
          NoteThis is a business version Id, not a resource version Id (see discussion)
          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          62. AppleHealthKitSample.sourceRevision.operatingSystemVersion
          Definition

          A string that identifies the operating system used to save a sample.

          ShortA string that identifies the operating system used to save a sample.
          Control1..1
          TypeBackboneElement
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          64. AppleHealthKitSample.sourceRevision.operatingSystemVersion.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
          66. AppleHealthKitSample.sourceRevision.operatingSystemVersion.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 AppleHealthKitSample.sourceRevision.operatingSystemVersion.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 68. AppleHealthKitSample.sourceRevision.operatingSystemVersion.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())
            70. AppleHealthKitSample.sourceRevision.operatingSystemVersion.majorVersion
            Definition

            The major release number, such as 10 in version 10.9.3.

            ShortThe major release number, such as 10 in version 10.9.3.
            Control1..1
            Typeinteger
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            72. AppleHealthKitSample.sourceRevision.operatingSystemVersion.minorVersion
            Definition

            The minor release number, such as 9 in version 10.9.3.

            ShortThe minor release number, such as 9 in version 10.9.3.
            Control1..1
            Typeinteger
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            74. AppleHealthKitSample.sourceRevision.operatingSystemVersion.patchVersion
            Definition

            The update release number, such as 3 in version 10.9.3.

            ShortThe update release number, such as 3 in version 10.9.3.
            Control1..1
            Typeinteger
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            76. AppleHealthKitSample.sourceRevision.productType
            Definition

            A string that identifies the device used to save a sample.

            ShortA string that identifies the device used to save a sample.
            Control0..1
            Typestring
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            78. AppleHealthKitSample.startDate
            Definition

            The sample's start date.

            ShortThe sample's start date.
            Control0..1
            TypedateTime
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            80. AppleHealthKitSample.endDate
            Definition

            The sample's end date.

            ShortThe sample's end date.
            Control0..1
            TypedateTime
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            82. AppleHealthKitSample.hasUndeterminedDuration
            Definition

            Indicates whether the sample has an unknown duration.

            ShortIndicates whether the sample has an unknown duration.
            Control0..1
            Typeboolean
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            84. AppleHealthKitSample.sampleType
            Definition

            The sample type.

            ShortThe sample type.
            Control1..1
            BindingUnless not suitable, these codes SHALL be taken from Apple HealthKit Sample Type Value Set
            (extensible to http://hl7.org/fhir/uv/phr/ValueSet/apple-health-kit-sample-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. AppleHealthKitSample
            Definition

            Data elements for the Apple HealthKit HKSample.

            ShortApple HealthKit Sample Logical Model
            Control0..*
            Is Modifierfalse
            Logical ModelInstances of this logical model are not marked to be the target of a Reference
            2. AppleHealthKitSample.uuid
            Definition

            The universally unique identifier (UUID) for this HealthKit object.

            ShortThe universally unique identifier (UUID) for this HealthKit object.
            Control1..1
            Typestring
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            4. AppleHealthKitSample.metadata
            Definition

            The metadata for this HealthKit object.

            ShortThe metadata for this HealthKit object.
            Control0..*
            TypeBackboneElement
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            6. AppleHealthKitSample.metadata.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. AppleHealthKitSample.metadata.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 AppleHealthKitSample.metadata.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 10. AppleHealthKitSample.metadata.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. AppleHealthKitSample.metadata.key
              Definition

              Constants used to add metadata to objects stored in HealthKit.

              ShortConstants used to add metadata to objects stored in HealthKit.
              Control1..1
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              14. AppleHealthKitSample.metadata.value[x]
              Definition

              The metadata dictionary value.

              ShortThe metadata dictionary value.
              Control1..1
              TypeChoice of: string, dateTime, integer, decimal, boolean, positiveInt, unsignedInt
              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              16. AppleHealthKitSample.device
              Definition

              The device that generated the data for this object.

              ShortThe device that generated the data for this object.
              Control0..1
              TypeBackboneElement
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              18. AppleHealthKitSample.device.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
              20. AppleHealthKitSample.device.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 AppleHealthKitSample.device.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 22. AppleHealthKitSample.device.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())
                24. AppleHealthKitSample.device.udiDeviceIdentifier
                Definition

                The device identifier portion of the US Food and Drug Administration’s Unique Device Identifier (UDI).

                ShortThe device identifier portion of the US Food and Drug Administration’s Unique Device Identifier (UDI).
                Control0..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                26. AppleHealthKitSample.device.firmwareVersion
                Definition

                An arbitrary string representing the current version of the firmware running on the device.

                ShortAn arbitrary string representing the current version of the firmware running on the device.
                Control0..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                28. AppleHealthKitSample.device.hardwareVersion
                Definition

                An arbitrary string representing the hardware version of the device.

                ShortAn arbitrary string representing the hardware version of the device.
                Control0..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                30. AppleHealthKitSample.device.localIdentifier
                Definition

                An identifier that uniquely identifies the device object on the hardware running this code.

                ShortAn identifier that uniquely identifies the device object on the hardware running this code.
                Control0..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                32. AppleHealthKitSample.device.manufacturer
                Definition

                A string representing the device’s manufacturer.

                ShortA string representing the device’s manufacturer.
                Control0..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                34. AppleHealthKitSample.device.model
                Definition

                A string representing the device’s model.

                ShortA string representing the device’s model.
                Control0..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                36. AppleHealthKitSample.device.name
                Definition

                The user-facing name for the device.

                ShortThe user-facing name for the device.
                Control0..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                38. AppleHealthKitSample.device.softwareVersion
                Definition

                An arbitrary string representing the version of the software running on the device.

                ShortAn arbitrary string representing the version of the software running on the device.
                Control0..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                40. AppleHealthKitSample.sourceRevision
                Definition

                The app or device that created this object.

                ShortThe app or device that created this object.
                Control1..1
                TypeBackboneElement
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                42. AppleHealthKitSample.sourceRevision.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
                44. AppleHealthKitSample.sourceRevision.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 AppleHealthKitSample.sourceRevision.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 46. AppleHealthKitSample.sourceRevision.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())
                  48. AppleHealthKitSample.sourceRevision.source
                  Definition

                  The source for a sample.

                  ShortThe source for a sample.
                  Control1..1
                  TypeBackboneElement
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  50. AppleHealthKitSample.sourceRevision.source.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
                  52. AppleHealthKitSample.sourceRevision.source.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 AppleHealthKitSample.sourceRevision.source.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 54. AppleHealthKitSample.sourceRevision.source.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())
                    56. AppleHealthKitSample.sourceRevision.source.bundleIdentifier
                    Definition

                    The source’s bundle identifier.

                    ShortThe source’s bundle identifier.
                    Control1..1
                    Typestring
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    58. AppleHealthKitSample.sourceRevision.source.name
                    Definition

                    The source’s name.

                    ShortThe source’s name.
                    Control1..1
                    Typestring
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    60. AppleHealthKitSample.sourceRevision.version
                    Definition

                    A string that identifies a particular version of the source.

                    ShortA string that identifies a particular version of the source.
                    NoteThis is a business version Id, not a resource version Id (see discussion)
                    Control0..1
                    Typestring
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    62. AppleHealthKitSample.sourceRevision.operatingSystemVersion
                    Definition

                    A string that identifies the operating system used to save a sample.

                    ShortA string that identifies the operating system used to save a sample.
                    Control1..1
                    TypeBackboneElement
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    64. AppleHealthKitSample.sourceRevision.operatingSystemVersion.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
                    66. AppleHealthKitSample.sourceRevision.operatingSystemVersion.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 AppleHealthKitSample.sourceRevision.operatingSystemVersion.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 68. AppleHealthKitSample.sourceRevision.operatingSystemVersion.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())
                      70. AppleHealthKitSample.sourceRevision.operatingSystemVersion.majorVersion
                      Definition

                      The major release number, such as 10 in version 10.9.3.

                      ShortThe major release number, such as 10 in version 10.9.3.
                      Control1..1
                      Typeinteger
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      72. AppleHealthKitSample.sourceRevision.operatingSystemVersion.minorVersion
                      Definition

                      The minor release number, such as 9 in version 10.9.3.

                      ShortThe minor release number, such as 9 in version 10.9.3.
                      Control1..1
                      Typeinteger
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      74. AppleHealthKitSample.sourceRevision.operatingSystemVersion.patchVersion
                      Definition

                      The update release number, such as 3 in version 10.9.3.

                      ShortThe update release number, such as 3 in version 10.9.3.
                      Control1..1
                      Typeinteger
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      76. AppleHealthKitSample.sourceRevision.productType
                      Definition

                      A string that identifies the device used to save a sample.

                      ShortA string that identifies the device used to save a sample.
                      Control0..1
                      Typestring
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      78. AppleHealthKitSample.startDate
                      Definition

                      The sample's start date.

                      ShortThe sample's start date.
                      Control0..1
                      TypedateTime
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      80. AppleHealthKitSample.endDate
                      Definition

                      The sample's end date.

                      ShortThe sample's end date.
                      Control0..1
                      TypedateTime
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      82. AppleHealthKitSample.hasUndeterminedDuration
                      Definition

                      Indicates whether the sample has an unknown duration.

                      ShortIndicates whether the sample has an unknown duration.
                      Control0..1
                      Typeboolean
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      84. AppleHealthKitSample.sampleType
                      Definition

                      The sample type.

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