0.4.6 - ci-build

StandardPatientHealthRecordIG, published by MITRE. This guide is not an authorized publication; it is the continuous build for version 0.4.6 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/personal-health-record-format-ig/ and changes regularly. See the Directory of published versions

Logical Model: Apple HealthKit Quantity Sample Logical Model

Official URL: https://open-health-manager.github.io/standard-patient-health-record-ig/StructureDefinition/apple-health-kit-quantity-sample Version: 0.4.6
Draft as of 2024-07-12 Computable Name: AppleHealthKitQuantitySample

Data elements for the Apple HealthKit HKQuantitySample.

Usage:

  • This Logical Model Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from AppleHealthKitSample

NameFlagsCard.TypeDescription & Constraintsdoco
.. apple-health-kit-quantity-sample 0..* AppleHealthKitSample
Elements defined in Ancestors:uuid, metadata, device, sourceRevision, startDate, endDate, hasUndeterminedDuration, sampleType
Apple HealthKit Quantity Sample Logical Model
Instances of this logical model are not marked to be the target of a Reference
... quantity 1..1 BackboneElement The quantity for this sample.
.... unit 0..1 string The unit string.
.... doubleValue 0..1 decimal Returns the quantity’s value in the provided unit.
... count 0..1 integer The number of quantities contained in this sample.
... quantityType 1..1 code The quantity type for this sample.
Binding: Apple HealthKit Quantity Type Value Set (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
apple-health-kit-quantity-sample.quantityTypeextensibleAppleHealthKitQuantityTypeValueSet (a valid code from Apple HealthKit Quantity Type Code System)
https://open-health-manager.github.io/standard-patient-health-record-ig/ValueSet/apple-health-kit-quantity-type-value-set
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. apple-health-kit-quantity-sample 0..* AppleHealthKitSample
Elements defined in Ancestors:uuid, metadata, device, sourceRevision, startDate, endDate, hasUndeterminedDuration, sampleType
Apple HealthKit Quantity 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.
... sourceRevision 1..1 BackboneElement The app or device that created this object.
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... source 1..1 BackboneElement The source for a sample.
..... 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.
.... operatingSystemVersion 1..1 BackboneElement A string that identifies the operating system used to save a sample.
..... 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.
... sampleType 1..1 code The sample type.
Binding: Apple HealthKit Sample Type Value Set (extensible)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... unit 0..1 string The unit string.
.... doubleValue 0..1 decimal Returns the quantity’s value in the provided unit.
... count 0..1 integer The number of quantities contained in this sample.
... quantityType 1..1 code The quantity type for this sample.
Binding: Apple HealthKit Quantity Type Value Set (extensible)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
apple-health-kit-quantity-sample.sampleTypeextensibleAppleHealthKitSampleTypeValueSet (a valid code from Apple HealthKit Sample Type Code System)
https://open-health-manager.github.io/standard-patient-health-record-ig/ValueSet/apple-health-kit-sample-type-value-set
from this IG
apple-health-kit-quantity-sample.quantityTypeextensibleAppleHealthKitQuantityTypeValueSet (a valid code from Apple HealthKit Quantity Type Code System)
https://open-health-manager.github.io/standard-patient-health-record-ig/ValueSet/apple-health-kit-quantity-type-value-set
from this IG

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. apple-health-kit-quantity-sample 0..* AppleHealthKitSample
Elements defined in Ancestors:uuid, metadata, device, sourceRevision, startDate, endDate, hasUndeterminedDuration, sampleType
Apple HealthKit Quantity 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.
.... @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)
... quantity 1..1 BackboneElement The quantity for this 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
.... unit 0..1 string The unit string.
.... doubleValue 0..1 decimal Returns the quantity’s value in the provided unit.
... count 0..1 integer The number of quantities contained in this sample.
... quantityType 1..1 code The quantity type for this sample.
Binding: Apple HealthKit Quantity Type Value Set (extensible)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
apple-health-kit-quantity-sample.sampleTypeextensibleAppleHealthKitSampleTypeValueSet (a valid code from Apple HealthKit Sample Type Code System)
https://open-health-manager.github.io/standard-patient-health-record-ig/ValueSet/apple-health-kit-sample-type-value-set
from this IG
apple-health-kit-quantity-sample.quantityTypeextensibleAppleHealthKitQuantityTypeValueSet (a valid code from Apple HealthKit Quantity Type Code System)
https://open-health-manager.github.io/standard-patient-health-record-ig/ValueSet/apple-health-kit-quantity-type-value-set
from this IG

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from AppleHealthKitSample

Summary

Mandatory: 0 element(2 nested mandatory elements)

Differential View

This structure is derived from AppleHealthKitSample

NameFlagsCard.TypeDescription & Constraintsdoco
.. apple-health-kit-quantity-sample 0..* AppleHealthKitSample
Elements defined in Ancestors:uuid, metadata, device, sourceRevision, startDate, endDate, hasUndeterminedDuration, sampleType
Apple HealthKit Quantity Sample Logical Model
Instances of this logical model are not marked to be the target of a Reference
... quantity 1..1 BackboneElement The quantity for this sample.
.... unit 0..1 string The unit string.
.... doubleValue 0..1 decimal Returns the quantity’s value in the provided unit.
... count 0..1 integer The number of quantities contained in this sample.
... quantityType 1..1 code The quantity type for this sample.
Binding: Apple HealthKit Quantity Type Value Set (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
apple-health-kit-quantity-sample.quantityTypeextensibleAppleHealthKitQuantityTypeValueSet (a valid code from Apple HealthKit Quantity Type Code System)
https://open-health-manager.github.io/standard-patient-health-record-ig/ValueSet/apple-health-kit-quantity-type-value-set
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. apple-health-kit-quantity-sample 0..* AppleHealthKitSample
Elements defined in Ancestors:uuid, metadata, device, sourceRevision, startDate, endDate, hasUndeterminedDuration, sampleType
Apple HealthKit Quantity 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.
... sourceRevision 1..1 BackboneElement The app or device that created this object.
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... source 1..1 BackboneElement The source for a sample.
..... 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.
.... operatingSystemVersion 1..1 BackboneElement A string that identifies the operating system used to save a sample.
..... 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.
... sampleType 1..1 code The sample type.
Binding: Apple HealthKit Sample Type Value Set (extensible)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... unit 0..1 string The unit string.
.... doubleValue 0..1 decimal Returns the quantity’s value in the provided unit.
... count 0..1 integer The number of quantities contained in this sample.
... quantityType 1..1 code The quantity type for this sample.
Binding: Apple HealthKit Quantity Type Value Set (extensible)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
apple-health-kit-quantity-sample.sampleTypeextensibleAppleHealthKitSampleTypeValueSet (a valid code from Apple HealthKit Sample Type Code System)
https://open-health-manager.github.io/standard-patient-health-record-ig/ValueSet/apple-health-kit-sample-type-value-set
from this IG
apple-health-kit-quantity-sample.quantityTypeextensibleAppleHealthKitQuantityTypeValueSet (a valid code from Apple HealthKit Quantity Type Code System)
https://open-health-manager.github.io/standard-patient-health-record-ig/ValueSet/apple-health-kit-quantity-type-value-set
from this IG

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. apple-health-kit-quantity-sample 0..* AppleHealthKitSample
Elements defined in Ancestors:uuid, metadata, device, sourceRevision, startDate, endDate, hasUndeterminedDuration, sampleType
Apple HealthKit Quantity 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.
.... @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)
... quantity 1..1 BackboneElement The quantity for this 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
.... unit 0..1 string The unit string.
.... doubleValue 0..1 decimal Returns the quantity’s value in the provided unit.
... count 0..1 integer The number of quantities contained in this sample.
... quantityType 1..1 code The quantity type for this sample.
Binding: Apple HealthKit Quantity Type Value Set (extensible)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
apple-health-kit-quantity-sample.sampleTypeextensibleAppleHealthKitSampleTypeValueSet (a valid code from Apple HealthKit Sample Type Code System)
https://open-health-manager.github.io/standard-patient-health-record-ig/ValueSet/apple-health-kit-sample-type-value-set
from this IG
apple-health-kit-quantity-sample.quantityTypeextensibleAppleHealthKitQuantityTypeValueSet (a valid code from Apple HealthKit Quantity Type Code System)
https://open-health-manager.github.io/standard-patient-health-record-ig/ValueSet/apple-health-kit-quantity-type-value-set
from this IG

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from AppleHealthKitSample

Summary

Mandatory: 0 element(2 nested mandatory elements)

 

Other representations of profile: CSV, Excel