0.4.4 - ci-build

StandardPatientHealthRecordIG, published by MITRE. This is not an authorized publication; it is the continuous build for version 0.4.4). This version is based on the current content of https://github.com/HL7/standard-patient-health-record-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.4
Draft as of 2023-09-13 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..*AppleHealthKitSampleApple HealthKit Quantity Sample Logical Model
This logical model cannot be the target of a reference
... quantity 1..1BackboneElementThe quantity for this sample.
.... unit 0..1stringThe unit string.
.... doubleValue 0..1decimalReturns the quantity’s value in the provided unit.
... count 0..1integerThe number of quantities contained in this sample.
... quantityType 1..1codeThe quantity type for this sample.
Binding: Apple HealthKit Quantity Type Value Set (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
apple-health-kit-quantity-sample.quantityTypeextensibleAppleHealthKitQuantityTypeValueSet (a valid code from Apple HealthKit Quantity Type Code System)
NameFlagsCard.TypeDescription & Constraintsdoco
.. apple-health-kit-quantity-sample 0..*AppleHealthKitSampleApple HealthKit Quantity Sample Logical Model
This logical model cannot be the target of a reference
... uuid 1..1stringThe universally unique identifier (UUID) for this HealthKit object.
... sourceRevision 1..1BackboneElementThe app or device that created this object.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... source 1..1BackboneElementThe source for a sample.
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... bundleIdentifier 1..1stringThe source’s bundle identifier.
..... name 1..1stringThe source’s name.
.... operatingSystemVersion 1..1BackboneElementA string that identifies the operating system used to save a sample.
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... majorVersion 1..1integerThe major release number, such as 10 in version 10.9.3.
..... minorVersion 1..1integerThe minor release number, such as 9 in version 10.9.3.
..... patchVersion 1..1integerThe update release number, such as 3 in version 10.9.3.
... sampleType 1..1codeThe sample type.
Binding: Apple HealthKit Sample Type Value Set (extensible)
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... unit 0..1stringThe unit string.
.... doubleValue 0..1decimalReturns the quantity’s value in the provided unit.
... count 0..1integerThe number of quantities contained in this sample.
... quantityType 1..1codeThe quantity type for this sample.
Binding: Apple HealthKit Quantity Type Value Set (extensible)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
apple-health-kit-quantity-sample.sampleTypeextensibleAppleHealthKitSampleTypeValueSet (a valid code from Apple HealthKit Sample Type Code System)
apple-health-kit-quantity-sample.quantityTypeextensibleAppleHealthKitQuantityTypeValueSet (a valid code from Apple HealthKit Quantity Type Code System)

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..*AppleHealthKitSampleApple HealthKit Quantity Sample Logical Model
This logical model cannot be the target of a reference
... uuid 1..1stringThe universally unique identifier (UUID) for this HealthKit object.
... metadata 0..*BackboneElementThe metadata for this HealthKit object.
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... key 1..1stringConstants used to add metadata to objects stored in HealthKit.
.... value[x] 1..1The metadata dictionary value.
..... valueStringstring
..... valueDateTimedateTime
..... valueIntegerinteger
..... valueDecimaldecimal
..... valueBooleanboolean
..... valuePositiveIntpositiveInt
..... valueUnsignedIntunsignedInt
... device 0..1BackboneElementThe device that generated the data for this object.
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... udiDeviceIdentifier 0..1stringThe device identifier portion of the US Food and Drug Administration’s Unique Device Identifier (UDI).
.... firmwareVersion 0..1stringAn arbitrary string representing the current version of the firmware running on the device.
.... hardwareVersion 0..1stringAn arbitrary string representing the hardware version of the device.
.... localIdentifier 0..1stringAn identifier that uniquely identifies the device object on the hardware running this code.
.... manufacturer 0..1stringA string representing the device’s manufacturer.
.... model 0..1stringA string representing the device’s model.
.... name 0..1stringThe user-facing name for the device.
.... softwareVersion 0..1stringAn arbitrary string representing the version of the software running on the device.
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... source 1..1BackboneElementThe source for a sample.
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... bundleIdentifier 1..1stringThe source’s bundle identifier.
..... name 1..1stringThe source’s name.
.... version 0..1stringA string that identifies a particular version of the source.
.... operatingSystemVersion 1..1BackboneElementA string that identifies the operating system used to save a sample.
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... majorVersion 1..1integerThe major release number, such as 10 in version 10.9.3.
..... minorVersion 1..1integerThe minor release number, such as 9 in version 10.9.3.
..... patchVersion 1..1integerThe update release number, such as 3 in version 10.9.3.
.... productType 0..1stringA string that identifies the device used to save a sample.
... startDate 0..1dateTimeThe sample's start date.
... endDate 0..1dateTimeThe sample's end date.
... hasUndeterminedDuration 0..1booleanIndicates whether the sample has an unknown duration.
... sampleType 1..1codeThe sample type.
Binding: Apple HealthKit Sample Type Value Set (extensible)
... quantity 1..1BackboneElementThe quantity for this sample.
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... unit 0..1stringThe unit string.
.... doubleValue 0..1decimalReturns the quantity’s value in the provided unit.
... count 0..1integerThe number of quantities contained in this sample.
... quantityType 1..1codeThe quantity type for this sample.
Binding: Apple HealthKit Quantity Type Value Set (extensible)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
apple-health-kit-quantity-sample.sampleTypeextensibleAppleHealthKitSampleTypeValueSet (a valid code from Apple HealthKit Sample Type Code System)
apple-health-kit-quantity-sample.quantityTypeextensibleAppleHealthKitQuantityTypeValueSet (a valid code from Apple HealthKit Quantity Type Code System)

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..*AppleHealthKitSampleApple HealthKit Quantity Sample Logical Model
This logical model cannot be the target of a reference
... quantity 1..1BackboneElementThe quantity for this sample.
.... unit 0..1stringThe unit string.
.... doubleValue 0..1decimalReturns the quantity’s value in the provided unit.
... count 0..1integerThe number of quantities contained in this sample.
... quantityType 1..1codeThe quantity type for this sample.
Binding: Apple HealthKit Quantity Type Value Set (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
apple-health-kit-quantity-sample.quantityTypeextensibleAppleHealthKitQuantityTypeValueSet (a valid code from Apple HealthKit Quantity Type Code System)

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. apple-health-kit-quantity-sample 0..*AppleHealthKitSampleApple HealthKit Quantity Sample Logical Model
This logical model cannot be the target of a reference
... uuid 1..1stringThe universally unique identifier (UUID) for this HealthKit object.
... sourceRevision 1..1BackboneElementThe app or device that created this object.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... source 1..1BackboneElementThe source for a sample.
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... bundleIdentifier 1..1stringThe source’s bundle identifier.
..... name 1..1stringThe source’s name.
.... operatingSystemVersion 1..1BackboneElementA string that identifies the operating system used to save a sample.
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... majorVersion 1..1integerThe major release number, such as 10 in version 10.9.3.
..... minorVersion 1..1integerThe minor release number, such as 9 in version 10.9.3.
..... patchVersion 1..1integerThe update release number, such as 3 in version 10.9.3.
... sampleType 1..1codeThe sample type.
Binding: Apple HealthKit Sample Type Value Set (extensible)
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... unit 0..1stringThe unit string.
.... doubleValue 0..1decimalReturns the quantity’s value in the provided unit.
... count 0..1integerThe number of quantities contained in this sample.
... quantityType 1..1codeThe quantity type for this sample.
Binding: Apple HealthKit Quantity Type Value Set (extensible)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
apple-health-kit-quantity-sample.sampleTypeextensibleAppleHealthKitSampleTypeValueSet (a valid code from Apple HealthKit Sample Type Code System)
apple-health-kit-quantity-sample.quantityTypeextensibleAppleHealthKitQuantityTypeValueSet (a valid code from Apple HealthKit Quantity Type Code System)

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..*AppleHealthKitSampleApple HealthKit Quantity Sample Logical Model
This logical model cannot be the target of a reference
... uuid 1..1stringThe universally unique identifier (UUID) for this HealthKit object.
... metadata 0..*BackboneElementThe metadata for this HealthKit object.
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... key 1..1stringConstants used to add metadata to objects stored in HealthKit.
.... value[x] 1..1The metadata dictionary value.
..... valueStringstring
..... valueDateTimedateTime
..... valueIntegerinteger
..... valueDecimaldecimal
..... valueBooleanboolean
..... valuePositiveIntpositiveInt
..... valueUnsignedIntunsignedInt
... device 0..1BackboneElementThe device that generated the data for this object.
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... udiDeviceIdentifier 0..1stringThe device identifier portion of the US Food and Drug Administration’s Unique Device Identifier (UDI).
.... firmwareVersion 0..1stringAn arbitrary string representing the current version of the firmware running on the device.
.... hardwareVersion 0..1stringAn arbitrary string representing the hardware version of the device.
.... localIdentifier 0..1stringAn identifier that uniquely identifies the device object on the hardware running this code.
.... manufacturer 0..1stringA string representing the device’s manufacturer.
.... model 0..1stringA string representing the device’s model.
.... name 0..1stringThe user-facing name for the device.
.... softwareVersion 0..1stringAn arbitrary string representing the version of the software running on the device.
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... source 1..1BackboneElementThe source for a sample.
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... bundleIdentifier 1..1stringThe source’s bundle identifier.
..... name 1..1stringThe source’s name.
.... version 0..1stringA string that identifies a particular version of the source.
.... operatingSystemVersion 1..1BackboneElementA string that identifies the operating system used to save a sample.
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... majorVersion 1..1integerThe major release number, such as 10 in version 10.9.3.
..... minorVersion 1..1integerThe minor release number, such as 9 in version 10.9.3.
..... patchVersion 1..1integerThe update release number, such as 3 in version 10.9.3.
.... productType 0..1stringA string that identifies the device used to save a sample.
... startDate 0..1dateTimeThe sample's start date.
... endDate 0..1dateTimeThe sample's end date.
... hasUndeterminedDuration 0..1booleanIndicates whether the sample has an unknown duration.
... sampleType 1..1codeThe sample type.
Binding: Apple HealthKit Sample Type Value Set (extensible)
... quantity 1..1BackboneElementThe quantity for this sample.
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... unit 0..1stringThe unit string.
.... doubleValue 0..1decimalReturns the quantity’s value in the provided unit.
... count 0..1integerThe number of quantities contained in this sample.
... quantityType 1..1codeThe quantity type for this sample.
Binding: Apple HealthKit Quantity Type Value Set (extensible)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
apple-health-kit-quantity-sample.sampleTypeextensibleAppleHealthKitSampleTypeValueSet (a valid code from Apple HealthKit Sample Type Code System)
apple-health-kit-quantity-sample.quantityTypeextensibleAppleHealthKitQuantityTypeValueSet (a valid code from Apple HealthKit Quantity Type Code System)

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