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

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Logical Model: Apple HealthKit Sample Logical Model ( Abstract Experimental )

Data elements for the Apple HealthKit HKSample.

Usage:

• Derived from this Logical Model Profile: Apple HealthKit Category Sample Logical Model, Apple HealthKit Correlation Sample Logical Model, Apple HealthKit Quantity Sample Logical Model and Apple HealthKit Workout Sample Logical Model

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from AppleHealthKitObject

Name	Flags	Card.	Type	Description & Constraints
AppleHealthKitSample		0..*	AppleHealthKitObject	This is an abstracttype. Childtypes: AppleHealthKitCategorySample, AppleHealthKitCorrelationSample, AppleHealthKitQuantitySample, AppleHealthKitWorkoutSample Elements defined in Ancestors:uuid, metadata, device, sourceRevision Apple HealthKit Sample Logical Model Instances of this logical model are not marked to be the target of a Reference
startDate		0..1	dateTime	The sample's start date.
endDate		0..1	dateTime	The sample's end date.
hasUndeterminedDuration		0..1	boolean	Indicates whether the sample has an unknown duration.
sampleType		1..1	code	The sample type. Binding: Apple HealthKit Sample Type Value Set (extensible)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
AppleHealthKitSample.sampleType	extensible	AppleHealthKitSampleTypeValueSet (a valid code from Apple HealthKit Sample Type Code System) http://hl7.org/fhir/uv/phr/ValueSet/apple-health-kit-sample-type-value-set from this IG

Name	Flags	Card.	Type	Description & Constraints
AppleHealthKitSample		0..*	AppleHealthKitObject	This is an abstracttype. Childtypes: AppleHealthKitCategorySample, AppleHealthKitCorrelationSample, AppleHealthKitQuantitySample, AppleHealthKitWorkoutSample Elements defined in Ancestors:uuid, metadata, device, sourceRevision Apple HealthKit Sample Logical Model Instances of this logical model are not marked to be the target of a Reference
uuid		1..1	string	The universally unique identifier (UUID) for this HealthKit object.
metadata		0..*	BackboneElement	The metadata for this HealthKit object. ele-1: All FHIR elements must have a @value or children
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
key		1..1	string	Constants used to add metadata to objects stored in HealthKit.
value[x]		1..1		The metadata dictionary value.
valueString			string
valueDateTime			dateTime
valueInteger			integer
valueDecimal			decimal
valueBoolean			boolean
valuePositiveInt			positiveInt
valueUnsignedInt			unsignedInt
device		0..1	BackboneElement	The device that generated the data for this object. ele-1: All FHIR elements must have a @value or children
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
udiDeviceIdentifier		0..1	string	The device identifier portion of the US Food and Drug Administration’s Unique Device Identifier (UDI).
firmwareVersion		0..1	string	An arbitrary string representing the current version of the firmware running on the device.
hardwareVersion		0..1	string	An arbitrary string representing the hardware version of the device.
localIdentifier		0..1	string	An identifier that uniquely identifies the device object on the hardware running this code.
manufacturer		0..1	string	A string representing the device’s manufacturer.
model		0..1	string	A string representing the device’s model.
name		0..1	string	The user-facing name for the device.
softwareVersion		0..1	string	An arbitrary string representing the version of the software running on the device.
sourceRevision		1..1	BackboneElement	The app or device that created this object. ele-1: All FHIR elements must have a @value or children
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
source		1..1	BackboneElement	The source for a sample. ele-1: All FHIR elements must have a @value or children
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
bundleIdentifier		1..1	string	The source’s bundle identifier.
name		1..1	string	The source’s name.
version		0..1	string	A string that identifies a particular version of the source.
operatingSystemVersion		1..1	BackboneElement	A string that identifies the operating system used to save a sample. ele-1: All FHIR elements must have a @value or children
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
majorVersion		1..1	integer	The major release number, such as 10 in version 10.9.3.
minorVersion		1..1	integer	The minor release number, such as 9 in version 10.9.3.
patchVersion		1..1	integer	The update release number, such as 3 in version 10.9.3.
productType		0..1	string	A string that identifies the device used to save a sample.
startDate		0..1	dateTime	The sample's start date.
endDate		0..1	dateTime	The sample's end date.
hasUndeterminedDuration		0..1	boolean	Indicates whether the sample has an unknown duration.
sampleType		1..1	code	The sample type. Binding: Apple HealthKit Sample Type Value Set (extensible)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AppleHealthKitSample.sampleType	extensible	AppleHealthKitSampleTypeValueSet (a valid code from Apple HealthKit Sample Type Code System) http://hl7.org/fhir/uv/phr/ValueSet/apple-health-kit-sample-type-value-set from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Name	Flags	Card.	Type	Description & Constraints
AppleHealthKitSample		0..*	AppleHealthKitObject	This is an abstracttype. Childtypes: AppleHealthKitCategorySample, AppleHealthKitCorrelationSample, AppleHealthKitQuantitySample, AppleHealthKitWorkoutSample Elements defined in Ancestors:uuid, metadata, device, sourceRevision Apple HealthKit Sample Logical Model Instances of this logical model are not marked to be the target of a Reference
uuid		1..1	string	The universally unique identifier (UUID) for this HealthKit object.
metadata		0..*	BackboneElement	The metadata for this HealthKit object.
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
key		1..1	string	Constants used to add metadata to objects stored in HealthKit.
value[x]		1..1		The metadata dictionary value.
valueString			string
valueDateTime			dateTime
valueInteger			integer
valueDecimal			decimal
valueBoolean			boolean
valuePositiveInt			positiveInt
valueUnsignedInt			unsignedInt
device		0..1	BackboneElement	The device that generated the data for this object.
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
udiDeviceIdentifier		0..1	string	The device identifier portion of the US Food and Drug Administration’s Unique Device Identifier (UDI).
firmwareVersion		0..1	string	An arbitrary string representing the current version of the firmware running on the device.
hardwareVersion		0..1	string	An arbitrary string representing the hardware version of the device.
localIdentifier		0..1	string	An identifier that uniquely identifies the device object on the hardware running this code.
manufacturer		0..1	string	A string representing the device’s manufacturer.
model		0..1	string	A string representing the device’s model.
name		0..1	string	The user-facing name for the device.
softwareVersion		0..1	string	An arbitrary string representing the version of the software running on the device.
sourceRevision		1..1	BackboneElement	The app or device that created this object.
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
source		1..1	BackboneElement	The source for a sample.
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
bundleIdentifier		1..1	string	The source’s bundle identifier.
name		1..1	string	The source’s name.
version		0..1	string	A string that identifies a particular version of the source.
operatingSystemVersion		1..1	BackboneElement	A string that identifies the operating system used to save a sample.
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
majorVersion		1..1	integer	The major release number, such as 10 in version 10.9.3.
minorVersion		1..1	integer	The minor release number, such as 9 in version 10.9.3.
patchVersion		1..1	integer	The update release number, such as 3 in version 10.9.3.
productType		0..1	string	A string that identifies the device used to save a sample.
startDate		0..1	dateTime	The sample's start date.
endDate		0..1	dateTime	The sample's end date.
hasUndeterminedDuration		0..1	boolean	Indicates whether the sample has an unknown duration.
sampleType		1..1	code	The sample type. Binding: Apple HealthKit Sample Type Value Set (extensible)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AppleHealthKitSample.sampleType	extensible	AppleHealthKitSampleTypeValueSet (a valid code from Apple HealthKit Sample Type Code System) http://hl7.org/fhir/uv/phr/ValueSet/apple-health-kit-sample-type-value-set from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from AppleHealthKitObject

Summary

Mandatory: 0 element(1 nested mandatory element)

Differential View

This structure is derived from AppleHealthKitObject

Name	Flags	Card.	Type	Description & Constraints
AppleHealthKitSample		0..*	AppleHealthKitObject	This is an abstracttype. Childtypes: AppleHealthKitCategorySample, AppleHealthKitCorrelationSample, AppleHealthKitQuantitySample, AppleHealthKitWorkoutSample Elements defined in Ancestors:uuid, metadata, device, sourceRevision Apple HealthKit Sample Logical Model Instances of this logical model are not marked to be the target of a Reference
startDate		0..1	dateTime	The sample's start date.
endDate		0..1	dateTime	The sample's end date.
hasUndeterminedDuration		0..1	boolean	Indicates whether the sample has an unknown duration.
sampleType		1..1	code	The sample type. Binding: Apple HealthKit Sample Type Value Set (extensible)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
AppleHealthKitSample.sampleType	extensible	AppleHealthKitSampleTypeValueSet (a valid code from Apple HealthKit Sample Type Code System) http://hl7.org/fhir/uv/phr/ValueSet/apple-health-kit-sample-type-value-set from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
AppleHealthKitSample		0..*	AppleHealthKitObject	This is an abstracttype. Childtypes: AppleHealthKitCategorySample, AppleHealthKitCorrelationSample, AppleHealthKitQuantitySample, AppleHealthKitWorkoutSample Elements defined in Ancestors:uuid, metadata, device, sourceRevision Apple HealthKit Sample Logical Model Instances of this logical model are not marked to be the target of a Reference
uuid		1..1	string	The universally unique identifier (UUID) for this HealthKit object.
metadata		0..*	BackboneElement	The metadata for this HealthKit object. ele-1: All FHIR elements must have a @value or children
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
key		1..1	string	Constants used to add metadata to objects stored in HealthKit.
value[x]		1..1		The metadata dictionary value.
valueString			string
valueDateTime			dateTime
valueInteger			integer
valueDecimal			decimal
valueBoolean			boolean
valuePositiveInt			positiveInt
valueUnsignedInt			unsignedInt
device		0..1	BackboneElement	The device that generated the data for this object. ele-1: All FHIR elements must have a @value or children
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
udiDeviceIdentifier		0..1	string	The device identifier portion of the US Food and Drug Administration’s Unique Device Identifier (UDI).
firmwareVersion		0..1	string	An arbitrary string representing the current version of the firmware running on the device.
hardwareVersion		0..1	string	An arbitrary string representing the hardware version of the device.
localIdentifier		0..1	string	An identifier that uniquely identifies the device object on the hardware running this code.
manufacturer		0..1	string	A string representing the device’s manufacturer.
model		0..1	string	A string representing the device’s model.
name		0..1	string	The user-facing name for the device.
softwareVersion		0..1	string	An arbitrary string representing the version of the software running on the device.
sourceRevision		1..1	BackboneElement	The app or device that created this object. ele-1: All FHIR elements must have a @value or children
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
source		1..1	BackboneElement	The source for a sample. ele-1: All FHIR elements must have a @value or children
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
bundleIdentifier		1..1	string	The source’s bundle identifier.
name		1..1	string	The source’s name.
version		0..1	string	A string that identifies a particular version of the source.
operatingSystemVersion		1..1	BackboneElement	A string that identifies the operating system used to save a sample. ele-1: All FHIR elements must have a @value or children
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
majorVersion		1..1	integer	The major release number, such as 10 in version 10.9.3.
minorVersion		1..1	integer	The minor release number, such as 9 in version 10.9.3.
patchVersion		1..1	integer	The update release number, such as 3 in version 10.9.3.
productType		0..1	string	A string that identifies the device used to save a sample.
startDate		0..1	dateTime	The sample's start date.
endDate		0..1	dateTime	The sample's end date.
hasUndeterminedDuration		0..1	boolean	Indicates whether the sample has an unknown duration.
sampleType		1..1	code	The sample type. Binding: Apple HealthKit Sample Type Value Set (extensible)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AppleHealthKitSample.sampleType	extensible	AppleHealthKitSampleTypeValueSet (a valid code from Apple HealthKit Sample Type Code System) http://hl7.org/fhir/uv/phr/ValueSet/apple-health-kit-sample-type-value-set from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
AppleHealthKitSample		0..*	AppleHealthKitObject	This is an abstracttype. Childtypes: AppleHealthKitCategorySample, AppleHealthKitCorrelationSample, AppleHealthKitQuantitySample, AppleHealthKitWorkoutSample Elements defined in Ancestors:uuid, metadata, device, sourceRevision Apple HealthKit Sample Logical Model Instances of this logical model are not marked to be the target of a Reference
uuid		1..1	string	The universally unique identifier (UUID) for this HealthKit object.
metadata		0..*	BackboneElement	The metadata for this HealthKit object.
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
key		1..1	string	Constants used to add metadata to objects stored in HealthKit.
value[x]		1..1		The metadata dictionary value.
valueString			string
valueDateTime			dateTime
valueInteger			integer
valueDecimal			decimal
valueBoolean			boolean
valuePositiveInt			positiveInt
valueUnsignedInt			unsignedInt
device		0..1	BackboneElement	The device that generated the data for this object.
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
udiDeviceIdentifier		0..1	string	The device identifier portion of the US Food and Drug Administration’s Unique Device Identifier (UDI).
firmwareVersion		0..1	string	An arbitrary string representing the current version of the firmware running on the device.
hardwareVersion		0..1	string	An arbitrary string representing the hardware version of the device.
localIdentifier		0..1	string	An identifier that uniquely identifies the device object on the hardware running this code.
manufacturer		0..1	string	A string representing the device’s manufacturer.
model		0..1	string	A string representing the device’s model.
name		0..1	string	The user-facing name for the device.
softwareVersion		0..1	string	An arbitrary string representing the version of the software running on the device.
sourceRevision		1..1	BackboneElement	The app or device that created this object.
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
source		1..1	BackboneElement	The source for a sample.
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
bundleIdentifier		1..1	string	The source’s bundle identifier.
name		1..1	string	The source’s name.
version		0..1	string	A string that identifies a particular version of the source.
operatingSystemVersion		1..1	BackboneElement	A string that identifies the operating system used to save a sample.
@id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
majorVersion		1..1	integer	The major release number, such as 10 in version 10.9.3.
minorVersion		1..1	integer	The minor release number, such as 9 in version 10.9.3.
patchVersion		1..1	integer	The update release number, such as 3 in version 10.9.3.
productType		0..1	string	A string that identifies the device used to save a sample.
startDate		0..1	dateTime	The sample's start date.
endDate		0..1	dateTime	The sample's end date.
hasUndeterminedDuration		0..1	boolean	Indicates whether the sample has an unknown duration.
sampleType		1..1	code	The sample type. Binding: Apple HealthKit Sample Type Value Set (extensible)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AppleHealthKitSample.sampleType	extensible	AppleHealthKitSampleTypeValueSet (a valid code from Apple HealthKit Sample Type Code System) http://hl7.org/fhir/uv/phr/ValueSet/apple-health-kit-sample-type-value-set from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from AppleHealthKitObject

Summary

Mandatory: 0 element(1 nested mandatory element)

Other representations of profile: CSV, Excel