ARCHETYPE Sensor-recorded sleep (openEHR-EHR-OBSERVATION.wearable_sensor_sleep.v0)

ARCHETYPE IDopenEHR-EHR-OBSERVATION.wearable_sensor_sleep.v0
ConceptSensor-recorded sleep
DescriptionTo record a person's sleep data measured with a wearable sensor over a defined period of time.
UseThe archetype was created to collect sleep data from a person in the home environment, measured with a wearable sensor, such as a smartwatch, fitness band or similar models. However, it can also be used for other sleep trackers or non-wearable sensors if suitable. The archetype records each measured episode of sleep as a separate event. The corresponding time information can be recorded as a duration, interval or point in time.
MisuseNot for recording polysomnography data, a hypnogram or other clinically prescribed (sleep) studies and examinations.
PurposeTo record a person's sleep data measured with a wearable sensor over a defined period of time.
References
Copyright© openEHR Foundation, HiGHmed
AuthorsAuthor name: Maximilian Meixner
Organisation: BIH @ Charité - Berlin Institute of Health
Email: maximilian.meixner@bih-charite.de
Date originally authored: 2024-10-09
Other Details LanguageAuthor name: Maximilian Meixner
Organisation: BIH @ Charité - Berlin Institute of Health
Email: maximilian.meixner@bih-charite.de
Date originally authored: 2024-10-09
OtherDetails Language Independent{licence=This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/3.0/., custodian_organisation=HiGHmed, original_namespace=org.highmed, original_publisher=HiGHmed, custodian_namespace=org.highmed, MD5-CAM-1.0.1=91DB1F8F2CD068B159918FAF31469DE5, build_uid=71eedb71-8c1d-420a-b626-88003e507833, revision=0.0.1-alpha}
Keywordssleep, wearable, sensor, smartwatch, sleep monitoring, sleep tracking, light sleep, deep sleep, REM sleep, waking up, falling asleep, sleep phase, sleep latency
Lifecyclein_development
UIDd887a15d-0f22-497d-84c8-fb668ccc2cdc
Language useden
Citeable Identifier1246.145.2370
Revision Number0.0.1-alpha
AllArchetype [runtimeNameConstraintForConceptName=null, archetypeConceptBinding=null, archetypeConceptDescription=To record a person's sleep data measured with a wearable sensor over a defined period of time., archetypeConceptComment=null, otherContributors=, originalLanguage=de, translators=
  • English: Maximilian Meixner, BIH @ Charité - Berlin Institute of Health, maximilian.meixner@bih-charite.de

    • , subjectOfData=unconstrained, archetypeTranslationTree=null, topLevelToAshis={relationships=[], source=[], capabilities=[], activities=[], details=[], context=[], ism_transition=[], other_participations=[], data=[ResourceSimplifiedHierarchyItem [path=/data[at0001]/events[at0002]/data[at0003]/items[at0023], code=at0023, itemType=ELEMENT, level=4, text=Timeframe, description=The measured period of a sleep episode., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=CHOICE, bindings=null, values=Choice of:
    •  Duration
    •  Interval of Duration

    •  Interval of Date/Time

    •  Interval of Time

    •  Date/Time
    , extendedValues=null]], credentials=[], target=[], items=[], content=[], description=[], contacts=[], state=[ResourceSimplifiedHierarchyItem [path=/data[at0001]/events[at0002]/state[at0008]/items[at0009], code=at0009, itemType=ELEMENT, level=4, text=Recorded phase, description=The sleep episode detected by the wearable., comment=The sleep phase or episode can also describe a waking state before, during or after sleep., uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=CHOICE, bindings=null, values=Choice of:
    •  Coded Text
      • Sleep [Overall sleep duration without wake times.
        Indicates only that the person is sleeping. For example, if the sleep phase could not be specified or as a parent category if several sleep phases are to be represented together.]
        [LOINC::93832-4 | Sleep duration]
      • Light sleep [Overall time spent in light sleep.]
        [LOINC::93830-8 | Light sleep duration]
      • Deep sleep [Overall time spent in deep sleep.]
        [LOINC::93831-6 | Deep sleep duration]
      • REM sleep [Overall time spent in REM sleep.]
        [LOINC::93829-0 | REM sleep duration]
      • Sleep interruption [Overall time awake during sleep periods.]
        [LOINC::93828-2 | Nighttime awakening duration]
      • Sleep latency [The duration of falling asleep or sleep latency from bedtime to the onset of sleep.]
        [LOINC::103212-7 | Duration of falling asleep]
      • Wake up [The time spent in bed after waking up in the morning.]
        [LOINC::103210-1 | Awakening duration]
      • Sleep with wake times [Overall sleep duration with wake times during the night.]
        [LOINC::103213-5 | Duration in bed]
    •  Text
    , extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/events[at0002]/state[at0008]/items[at0017], code=at0017, itemType=ELEMENT, level=4, text=Comment, description=More information about the measurement or the sleep episode., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_TEXT, bindings=null, values=, extendedValues=null]], events=[ResourceSimplifiedHierarchyItem [path=/data[at0001]/events[at0002], code=at0002, itemType=EVENT, level=2, text=Any event, description=A specified point in time or interval event that can be explicitly defined in a template or at runtime., comment=null, uncommonOntologyItems=null, occurencesFormal=0..*, occurencesText=Optional, repeating, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=EVENT, bindings=null, values=null, extendedValues=null]], provider=[], identities=[], protocol=[ResourceSimplifiedHierarchyItem [path=/protocol[at0006]/items[at0018], code=at0018, itemType=SLOT, level=2, text=Device, description=Details about the sensor used to record sleep., comment=null, uncommonOntologyItems=null, occurencesFormal=0..*, occurencesText=Optional, repeating, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=CLUSTER, bindings=null, values=Include:
    openEHR-EHR-CLUSTER.device.v1, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/protocol[at0006]/items[at0019], code=at0019, itemType=ELEMENT, level=2, text=Body site, description=Part of the body where the sensor that records sleep is attached., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=CHOICE, bindings=null, values=Choice of:
    •  Coded Text
    •  Text
    , extendedValues=null], ResourceSimplifiedHierarchyItem [path=/protocol[at0006]/items[at0020], code=at0020, itemType=ELEMENT, level=2, text=Comment, description=More information on sleep monitoring framework., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_TEXT, bindings=null, values=, extendedValues=null]]}, topLevelItems={data=ResourceSimplifiedHierarchyItem [path=ROOT_/data[at0001]/events[at0002]/data[at0003], code=at0003, itemType=ITEM_TREE, level=2, text=null, description=null, comment=null, uncommonOntologyItems=null, occurencesFormal=1..1, occurencesText=Mandatory, cardinalityFormal=0..1, cardinalityText=optional, subCardinalityFormal=0..*, subCardinalityText=Minimum of 0 items, dataType=ITEM_TREE, bindings=null, values=null, extendedValues=null], state=ResourceSimplifiedHierarchyItem [path=ROOT_/data[at0001]/events[at0002]/state[at0008], code=at0008, itemType=ITEM_TREE, level=2, text=null, description=null, comment=null, uncommonOntologyItems=null, occurencesFormal=1..1, occurencesText=Mandatory, cardinalityFormal=0..1, cardinalityText=optional, subCardinalityFormal=0..*, subCardinalityText=Minimum of 0 items, dataType=ITEM_TREE, bindings=null, values=null, extendedValues=null], protocol=ResourceSimplifiedHierarchyItem [path=ROOT_/protocol[at0006], code=at0006, itemType=ITEM_TREE, level=0, text=null, description=null, comment=null, uncommonOntologyItems=null, occurencesFormal=1..1, occurencesText=Mandatory, cardinalityFormal=0..1, cardinalityText=optional, subCardinalityFormal=0..*, subCardinalityText=Minimum of 0 items, dataType=ITEM_TREE, bindings=null, values=null, extendedValues=null]}, addHierarchyItemsTo=protocol, currentHierarchyItemsForAdding=[ResourceSimplifiedHierarchyItem [path=/protocol[at0006]/items[at0018], code=at0018, itemType=SLOT, level=2, text=Device, description=Details about the sensor used to record sleep., comment=null, uncommonOntologyItems=null, occurencesFormal=0..*, occurencesText=Optional, repeating, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=CLUSTER, bindings=null, values=Include:
    openEHR-EHR-CLUSTER.device.v1, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/protocol[at0006]/items[at0019], code=at0019, itemType=ELEMENT, level=2, text=Body site, description=Part of the body where the sensor that records sleep is attached., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=CHOICE, bindings=null, values=Choice of:
    •  Coded Text
    •  Text
    , extendedValues=null], ResourceSimplifiedHierarchyItem [path=/protocol[at0006]/items[at0020], code=at0020, itemType=ELEMENT, level=2, text=Comment, description=More information on sleep monitoring framework., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_TEXT, bindings=null, values=, extendedValues=null]], minIndents={}, termBindingRetrievalErrorMessage=null]