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 Object Logical Model ( Abstract )

Official URL: https://open-health-manager.github.io/standard-patient-health-record-ig/StructureDefinition/apple-health-kit-object Version: 0.4.4
Draft as of 2023-09-13 Computable Name: AppleHealthKitObject

Data elements for the Apple HealthKit HKObject.

Usage:

Formal Views of Profile Content

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

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. apple-health-kit-object 0..*BaseThis is an abstract type. Child types: apple-health-kit-sample, apple-health-kit-workout-activity
Apple HealthKit Object 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.
.... 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.
.... 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.
.... source 1..1BackboneElementThe source for a sample.
..... 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.
..... 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.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. apple-health-kit-object 0..*BaseThis is an abstract type. Child types: apple-health-kit-sample, apple-health-kit-workout-activity
Apple HealthKit Object 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.
.... 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.
.... 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.
.... 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.
.... 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.
..... 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.

doco Documentation for this format

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-object 0..*BaseThis is an abstract type. Child types: apple-health-kit-sample, apple-health-kit-workout-activity
Apple HealthKit Object 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.

doco Documentation for this format

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 Base

Summary

Mandatory: 0 element (11 nested mandatory elements)

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. apple-health-kit-object 0..*BaseThis is an abstract type. Child types: apple-health-kit-sample, apple-health-kit-workout-activity
Apple HealthKit Object 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.
.... 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.
.... 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.
.... source 1..1BackboneElementThe source for a sample.
..... 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.
..... 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.

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. apple-health-kit-object 0..*BaseThis is an abstract type. Child types: apple-health-kit-sample, apple-health-kit-workout-activity
Apple HealthKit Object 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.
.... 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.
.... 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.
.... 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.
.... 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.
..... 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.

doco Documentation for this format

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-object 0..*BaseThis is an abstract type. Child types: apple-health-kit-sample, apple-health-kit-workout-activity
Apple HealthKit Object 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.

doco Documentation for this format

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 Base

Summary

Mandatory: 0 element (11 nested mandatory elements)

 

Other representations of profile: CSV, Excel