StandardPatientHealthRecordIG - Local Development build (v0.4.4). See the Directory of published versions
Logical Model: Apple HealthKit Correlation Sample Logical Model
| Official URL: https://open-health-manager.github.io/standard-patient-health-record-ig/StructureDefinition/apple-health-kit-correlation-sample | Version: 0.4.4 | |||
| Draft as of 2023-03-03 | Computable Name: AppleHealthKitCorrelationSample | |||
Data elements for the Apple HealthKit HKCorrelation.
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
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  apple-health-kit-correlation-sample | 0..* | AppleHealthKitSample | Apple HealthKit Correlation Sample Logical Model | |
  correlationType | 1..1 | code | The type for this correlation. Binding: Apple HealthKit Correlation Type Value Set (extensible) | |
  objects | 1..* | Resource | The set of sample objects that make up the correlation. | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet |
| apple-health-kit-correlation-sample.correlationType | extensible | AppleHealthKitCorrelationTypeValueSet (a valid code from Apple HealthKit Correlation Type Code System) |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| apple-health-kit-correlation-sample | 0..* | AppleHealthKitSample | Apple HealthKit Correlation Sample Logical Model | |
| 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) | |
| correlationType | 1..1 | code | The type for this correlation. Binding: Apple HealthKit Correlation Type Value Set (extensible) | |
| objects | 1..* | Resource | The set of sample objects that make up the correlation. | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| apple-health-kit-correlation-sample.sampleType | extensible | AppleHealthKitSampleTypeValueSet (a valid code from Apple HealthKit Sample Type Code System) |
| apple-health-kit-correlation-sample.correlationType | extensible | AppleHealthKitCorrelationTypeValueSet (a valid code from Apple HealthKit Correlation Type Code System) |
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 |
|---|---|---|---|---|
| apple-health-kit-correlation-sample | 0..* | AppleHealthKitSample | Apple HealthKit Correlation Sample Logical Model | |
| uuid | 1..1 | string | The universally unique identifier (UUID) for this HealthKit object. | |
| metadata | 0..* | BackboneElement | The metadata for this HealthKit object. | |
 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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) | |
| correlationType | 1..1 | code | The type for this correlation. Binding: Apple HealthKit Correlation Type Value Set (extensible) | |
| objects | 1..* | Resource | The set of sample objects that make up the correlation. | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| apple-health-kit-correlation-sample.sampleType | extensible | AppleHealthKitSampleTypeValueSet (a valid code from Apple HealthKit Sample Type Code System) |
| apple-health-kit-correlation-sample.correlationType | extensible | AppleHealthKitCorrelationTypeValueSet (a valid code from Apple HealthKit Correlation Type Code System) |
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 AppleHealthKitSample
Differential View
This structure is derived from AppleHealthKitSample
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| apple-health-kit-correlation-sample | 0..* | AppleHealthKitSample | Apple HealthKit Correlation Sample Logical Model | |
| correlationType | 1..1 | code | The type for this correlation. Binding: Apple HealthKit Correlation Type Value Set (extensible) | |
| objects | 1..* | Resource | The set of sample objects that make up the correlation. | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet |
| apple-health-kit-correlation-sample.correlationType | extensible | AppleHealthKitCorrelationTypeValueSet (a valid code from Apple HealthKit Correlation Type Code System) |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| apple-health-kit-correlation-sample | 0..* | AppleHealthKitSample | Apple HealthKit Correlation Sample Logical Model | |
| 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) | |
| correlationType | 1..1 | code | The type for this correlation. Binding: Apple HealthKit Correlation Type Value Set (extensible) | |
| objects | 1..* | Resource | The set of sample objects that make up the correlation. | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| apple-health-kit-correlation-sample.sampleType | extensible | AppleHealthKitSampleTypeValueSet (a valid code from Apple HealthKit Sample Type Code System) |
| apple-health-kit-correlation-sample.correlationType | extensible | AppleHealthKitCorrelationTypeValueSet (a valid code from Apple HealthKit Correlation Type Code System) |
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 |
|---|---|---|---|---|
| apple-health-kit-correlation-sample | 0..* | AppleHealthKitSample | Apple HealthKit Correlation Sample Logical Model | |
| uuid | 1..1 | string | The universally unique identifier (UUID) for this HealthKit object. | |
| metadata | 0..* | BackboneElement | The metadata for this HealthKit object. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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) | |
| correlationType | 1..1 | code | The type for this correlation. Binding: Apple HealthKit Correlation Type Value Set (extensible) | |
| objects | 1..* | Resource | The set of sample objects that make up the correlation. | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| apple-health-kit-correlation-sample.sampleType | extensible | AppleHealthKitSampleTypeValueSet (a valid code from Apple HealthKit Sample Type Code System) |
| apple-health-kit-correlation-sample.correlationType | extensible | AppleHealthKitCorrelationTypeValueSet (a valid code from Apple HealthKit Correlation Type Code System) |
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 AppleHealthKitSample