Personal Health Records
1.0.0-ballot2 - STU 1 ballot International flag

Personal Health Records, published by HL7 International / Patient Empowerment. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot2 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: Environmental Observation - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 1

Definitions for the Environmental logical model

Guidance on how to interpret the contents of this table can be foundhere

0. Environmental
Definition

A logical model representing environmental conditions relevant to patient health, such as air quality, temperature, noise, and UV exposure. These factors may be collected by consumer weather stations, smartphone sensors, or wearable devices.

ShortEnvironmental Observation
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. Environmental.subject
Definition

The patient whose environment is being observed

ShortThe patient whose environment is being observed
Control1..1
TypeReference(Patient)
4. Environmental.effectiveDateTime
Definition

When the observation was made

ShortWhen the observation was made
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. Environmental.effectivePeriod
Definition

Time period over which the observation applies

ShortTime period over which the observation applies
Control0..1
TypePeriod
8. Environmental.location
Definition

Location of measurement

ShortLocation of measurement
Control0..1
TypeAddress
10. Environmental.gpsCoordinates
Definition

GPS coordinates of the observation

ShortGPS coordinates of the observation
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Environmental.gpsCoordinates.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
14. Environmental.gpsCoordinates.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Environmental.gpsCoordinates.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 16. Environmental.gpsCoordinates.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    18. Environmental.gpsCoordinates.latitude
    Definition

    Latitude in decimal degrees

    ShortLatitude in decimal degrees
    Control1..1
    Typedecimal
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    20. Environmental.gpsCoordinates.longitude
    Definition

    Longitude in decimal degrees

    ShortLongitude in decimal degrees
    Control1..1
    Typedecimal
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    22. Environmental.gpsCoordinates.altitude
    Definition

    Altitude above sea level

    ShortAltitude above sea level
    Control0..1
    TypeQuantity
    24. Environmental.temperature
    Definition

    Ambient temperature

    ShortAmbient temperature
    Control0..1
    TypeQuantity
    26. Environmental.humidity
    Definition

    Ambient relative humidity percentage

    ShortAmbient relative humidity percentage
    Control0..1
    TypeQuantity
    28. Environmental.barometricPressure
    Definition

    Barometric pressure

    ShortBarometric pressure
    Control0..1
    TypeQuantity
    30. Environmental.airQualityIndex
    Definition

    Air quality index (AQI)

    ShortAir quality index (AQI)
    Control0..1
    Typeinteger
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    32. Environmental.uvIndex
    Definition

    UV exposure index

    ShortUV exposure index
    Control0..1
    Typedecimal
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    34. Environmental.noiseLevel
    Definition

    Environmental noise level in decibels

    ShortEnvironmental noise level in decibels
    Control0..1
    TypeQuantity
    36. Environmental.pollenCount
    Definition

    Pollen count

    ShortPollen count
    Control0..1
    TypeQuantity
    38. Environmental.substance
    Definition

    Substances detected in the environment

    ShortSubstances detected in the environment
    Control0..*
    TypeBackboneElement
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    40. Environmental.substance.id
    Definition

    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

    ShortUnique id for inter-element referencing
    Control0..1
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    42. Environmental.substance.extension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

    ShortAdditional content defined by implementations
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    SlicingThis element introduces a set of slices on Environmental.substance.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 44. Environmental.substance.modifierExtension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

      ShortExtensions that cannot be ignored even if unrecognized
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Summarytrue
      Requirements

      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

      Alternate Namesextensions, user content, modifiers
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      46. Environmental.substance.code
      Definition

      Substance identity (e.g. lead, PFAS, asbestos, mold, radon)

      ShortSubstance identity (e.g. lead, PFAS, asbestos, mold, radon)
      Control1..1
      TypeCodeableConcept
      48. Environmental.substance.category
      Definition

      Category of substance (e.g. contaminant, toxin, irritant, allergen)

      ShortCategory of substance (e.g. contaminant, toxin, irritant, allergen)
      Control0..1
      TypeCodeableConcept
      50. Environmental.substance.concentration
      Definition

      Measured concentration of the substance

      ShortMeasured concentration of the substance
      Control0..1
      TypeQuantity
      52. Environmental.substance.source
      Definition

      Source or medium (e.g. groundwater, soil, air, surface)

      ShortSource or medium (e.g. groundwater, soil, air, surface)
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

      Guidance on how to interpret the contents of this table can be foundhere

      0. Environmental
      Definition

      A logical model representing environmental conditions relevant to patient health, such as air quality, temperature, noise, and UV exposure. These factors may be collected by consumer weather stations, smartphone sensors, or wearable devices.

      ShortEnvironmental Observation
      Logical ModelInstances of this logical model are not marked to be the target of a Reference
      2. Environmental.subject
      Definition

      The patient whose environment is being observed

      ShortThe patient whose environment is being observed
      Control1..1
      TypeReference(Patient)
      4. Environmental.effectiveDateTime
      Definition

      When the observation was made

      ShortWhen the observation was made
      Control0..1
      TypedateTime
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      6. Environmental.effectivePeriod
      Definition

      Time period over which the observation applies

      ShortTime period over which the observation applies
      Control0..1
      TypePeriod
      8. Environmental.location
      Definition

      Location of measurement

      ShortLocation of measurement
      Control0..1
      TypeAddress
      10. Environmental.gpsCoordinates
      Definition

      GPS coordinates of the observation

      ShortGPS coordinates of the observation
      Control0..1
      TypeBackboneElement
      12. Environmental.gpsCoordinates.latitude
      Definition

      Latitude in decimal degrees

      ShortLatitude in decimal degrees
      Control1..1
      Typedecimal
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      14. Environmental.gpsCoordinates.longitude
      Definition

      Longitude in decimal degrees

      ShortLongitude in decimal degrees
      Control1..1
      Typedecimal
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      16. Environmental.gpsCoordinates.altitude
      Definition

      Altitude above sea level

      ShortAltitude above sea level
      Control0..1
      TypeQuantity
      18. Environmental.temperature
      Definition

      Ambient temperature

      ShortAmbient temperature
      Control0..1
      TypeQuantity
      20. Environmental.humidity
      Definition

      Ambient relative humidity percentage

      ShortAmbient relative humidity percentage
      Control0..1
      TypeQuantity
      22. Environmental.barometricPressure
      Definition

      Barometric pressure

      ShortBarometric pressure
      Control0..1
      TypeQuantity
      24. Environmental.airQualityIndex
      Definition

      Air quality index (AQI)

      ShortAir quality index (AQI)
      Control0..1
      Typeinteger
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      26. Environmental.uvIndex
      Definition

      UV exposure index

      ShortUV exposure index
      Control0..1
      Typedecimal
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      28. Environmental.noiseLevel
      Definition

      Environmental noise level in decibels

      ShortEnvironmental noise level in decibels
      Control0..1
      TypeQuantity
      30. Environmental.pollenCount
      Definition

      Pollen count

      ShortPollen count
      Control0..1
      TypeQuantity
      32. Environmental.substance
      Definition

      Substances detected in the environment

      ShortSubstances detected in the environment
      Control0..*
      TypeBackboneElement
      34. Environmental.substance.code
      Definition

      Substance identity (e.g. lead, PFAS, asbestos, mold, radon)

      ShortSubstance identity (e.g. lead, PFAS, asbestos, mold, radon)
      Control1..1
      TypeCodeableConcept
      36. Environmental.substance.category
      Definition

      Category of substance (e.g. contaminant, toxin, irritant, allergen)

      ShortCategory of substance (e.g. contaminant, toxin, irritant, allergen)
      Control0..1
      TypeCodeableConcept
      38. Environmental.substance.concentration
      Definition

      Measured concentration of the substance

      ShortMeasured concentration of the substance
      Control0..1
      TypeQuantity
      40. Environmental.substance.source
      Definition

      Source or medium (e.g. groundwater, soil, air, surface)

      ShortSource or medium (e.g. groundwater, soil, air, surface)
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

      Guidance on how to interpret the contents of this table can be foundhere

      0. Environmental
      Definition

      A logical model representing environmental conditions relevant to patient health, such as air quality, temperature, noise, and UV exposure. These factors may be collected by consumer weather stations, smartphone sensors, or wearable devices.

      ShortEnvironmental Observation
      Control0..*
      Is Modifierfalse
      Logical ModelInstances of this logical model are not marked to be the target of a Reference
      2. Environmental.subject
      Definition

      The patient whose environment is being observed

      ShortThe patient whose environment is being observed
      Control1..1
      TypeReference(Patient)
      4. Environmental.effectiveDateTime
      Definition

      When the observation was made

      ShortWhen the observation was made
      Control0..1
      TypedateTime
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      6. Environmental.effectivePeriod
      Definition

      Time period over which the observation applies

      ShortTime period over which the observation applies
      Control0..1
      TypePeriod
      8. Environmental.location
      Definition

      Location of measurement

      ShortLocation of measurement
      Control0..1
      TypeAddress
      10. Environmental.gpsCoordinates
      Definition

      GPS coordinates of the observation

      ShortGPS coordinates of the observation
      Control0..1
      TypeBackboneElement
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      12. Environmental.gpsCoordinates.id
      Definition

      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

      ShortUnique id for inter-element referencing
      Control0..1
      Typestring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      14. Environmental.gpsCoordinates.extension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

      ShortAdditional content defined by implementations
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Alternate Namesextensions, user content
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      SlicingThis element introduces a set of slices on Environmental.gpsCoordinates.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 16. Environmental.gpsCoordinates.modifierExtension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        ShortExtensions that cannot be ignored even if unrecognized
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Summarytrue
        Requirements

        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

        Alternate Namesextensions, user content, modifiers
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        18. Environmental.gpsCoordinates.latitude
        Definition

        Latitude in decimal degrees

        ShortLatitude in decimal degrees
        Control1..1
        Typedecimal
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        20. Environmental.gpsCoordinates.longitude
        Definition

        Longitude in decimal degrees

        ShortLongitude in decimal degrees
        Control1..1
        Typedecimal
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        22. Environmental.gpsCoordinates.altitude
        Definition

        Altitude above sea level

        ShortAltitude above sea level
        Control0..1
        TypeQuantity
        24. Environmental.temperature
        Definition

        Ambient temperature

        ShortAmbient temperature
        Control0..1
        TypeQuantity
        26. Environmental.humidity
        Definition

        Ambient relative humidity percentage

        ShortAmbient relative humidity percentage
        Control0..1
        TypeQuantity
        28. Environmental.barometricPressure
        Definition

        Barometric pressure

        ShortBarometric pressure
        Control0..1
        TypeQuantity
        30. Environmental.airQualityIndex
        Definition

        Air quality index (AQI)

        ShortAir quality index (AQI)
        Control0..1
        Typeinteger
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        32. Environmental.uvIndex
        Definition

        UV exposure index

        ShortUV exposure index
        Control0..1
        Typedecimal
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        34. Environmental.noiseLevel
        Definition

        Environmental noise level in decibels

        ShortEnvironmental noise level in decibels
        Control0..1
        TypeQuantity
        36. Environmental.pollenCount
        Definition

        Pollen count

        ShortPollen count
        Control0..1
        TypeQuantity
        38. Environmental.substance
        Definition

        Substances detected in the environment

        ShortSubstances detected in the environment
        Control0..*
        TypeBackboneElement
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        40. Environmental.substance.id
        Definition

        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        ShortUnique id for inter-element referencing
        Control0..1
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        42. Environmental.substance.extension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        ShortAdditional content defined by implementations
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        SlicingThis element introduces a set of slices on Environmental.substance.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 44. Environmental.substance.modifierExtension
          Definition

          May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

          Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

          ShortExtensions that cannot be ignored even if unrecognized
          Comments

          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

          Control0..*
          TypeExtension
          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
          Summarytrue
          Requirements

          Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

          Alternate Namesextensions, user content, modifiers
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          46. Environmental.substance.code
          Definition

          Substance identity (e.g. lead, PFAS, asbestos, mold, radon)

          ShortSubstance identity (e.g. lead, PFAS, asbestos, mold, radon)
          Control1..1
          TypeCodeableConcept
          48. Environmental.substance.category
          Definition

          Category of substance (e.g. contaminant, toxin, irritant, allergen)

          ShortCategory of substance (e.g. contaminant, toxin, irritant, allergen)
          Control0..1
          TypeCodeableConcept
          50. Environmental.substance.concentration
          Definition

          Measured concentration of the substance

          ShortMeasured concentration of the substance
          Control0..1
          TypeQuantity
          52. Environmental.substance.source
          Definition

          Source or medium (e.g. groundwater, soil, air, surface)

          ShortSource or medium (e.g. groundwater, soil, air, surface)
          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension