Aero Allergen Observed

Note: The latest version of this Data Model can be found at https://github.com/smart-data-models/dataModel.Environment

Description

This entity models aero allergens observed at a given location and related overall allergen risk.

This data model has been developed based on GSMA. Aero allergens strictly depends on the geographical location. Common Aero allergens in Europe may be quite different from the ones in US due to the different biological species. A list of commonly used aero allergens in Europe can be found on polleninfo.org a web site maintained by the European Aeroallergen Network. A World Health Organization (WHO) Allergen Nomenclature (covering not only aero transported allergens) is available at http://www.allergen.org.

Data Model

A JSON Schema corresponding to this data model can be found here.

  • id : Unique identifier.

  • type : Entity type. It must be equal to AeroAllergenObserved.

  • dataProvider : Specifies the URL to information about the provider of this information

    • Attribute type: Property. URL
    • Optional
  • dateModified : Last update timestamp of this entity.

    • Attribute type: Property. DateTime
    • Read-Only. Automatically generated.
  • dateCreated : Entity's creation timestamp.

    • Attribute type: Property. DateTime
    • Read-Only. Automatically generated.
  • location : Location of the aero allergens observation represented by a GeoJSON geometry.

  • address : Civic address of the aero allergens observation. Sometimes it corresponds to the aero allergens station address.
  • dateObserved : The date and time of this observation in ISO8601 UTCformat. It can be represented by a specific time instant or by an ISO8601 interval.
    • Attribute type: Property. DateTime or an ISO8601 interval represented as Text.
    • Mandatory
  • source : A sequence of characters giving the source of the entity data.
    • Attribute type: Property. Text or URL
    • Optional
  • allergenRisk : Overall allergen risk corresponding to the aero allergens observed.

    • Attribute type: Property. Text
    • Example values defined by the European Aeroallergen Network: (none, low, moderate, high, veryHigh). As this can be different between countries, regulations or implementations, the set of allowed values will depend on the reference specification used. It is recommended that implementations use the same naming conventions as exemplified above (lower case starting words, camel case when compound terms are used)
    • Attribute metadata:
      • referenceSpecification : Specification that must be taken as reference when interpreting the supplied qualitative value.
      • Type: Text or URL
      • Mandatory
    • Optional
  • refDevice : A reference to the device(s) which captured this observation.

    • Attribute type: Relationship. Reference to an entity of type Device
    • Optional

Representing aero allergens concentration

To describe the different aero allergens concentrations, for each aero allergens we use an attribute that MUST refers exactly to the conventional name of the allergen (usually the latin name of the associated plant) to measure the concentration (usually in grains per cubic meter gr/m3). e.g. alnus to measure the concentration of alnus pollen (Alder is the common english name for Alnus).

The structure of such an attribute will be as follows:

  • Attribute name: Equal to the name of the allergen, for instance alnus. A list of commonly used aero allergens in Europe can be found on polleninfo.org a site maintained by the European Aeroallergen Network. A World Health Organization (WHO) Allergen Nomenclature (covering not only aero transported allergens) is available at http://www.allergen.org.

  • Attribute type: Property. Number

  • Attribute value: corresponds to the concentration of the allergen as a number.

  • Attribute metadata:

    • timestamp : optional timestamp for the observed value in ISO8601 format. It can be omitted if the observation time is the same as the one captured by the dateObserved attribute at entity level.
    • unitCode : The unit code (text) of measured concentration (usually the unit adopted is grains per cubic meter: gr/m3).
      • Type: Text
      • Optional
    • description : short description of the allergen
      • Attribute type: Property. Text
      • Normative References: https://uri.etsi.org/ngsi-ld/description equivalent to description
      • Optional

Representing qualitative levels of aero allergens

To describe the aero allergens qualitative levels, for each aero allergens we use an attribute that MUST refers exactly to the conventional name of the allergen (usually the latin name of the associated plant) concatenated with the string _Level, e.g. alnus_Level to measure the qualitative level for a given concentration of alnus pollen.

  • Attribute name: Equal to the name of the allergen plus the suffix Level, for instance alnus_Level.
  • Attribute type: Property. Text
  • Attribute value: Example values defined by the European Aeroallergen Network: (none, low, moderate, high, veryHigh). As this can be different between countries, regulations or implementations, the set of allowed values will depend on the reference specification used. It is recommended that implementations use the same naming conventions as exemplified above (lower case starting words, camel case when compound terms are used)
  • Attribute metadata:
    • description : short description of the measurand and its related qualitative level
      • Attribute type: Property. Text
      • Normative References: https://uri.etsi.org/ngsi-ld/description equivalent to description
      • Optional
    • referenceSpecification : Specification that must be taken as reference when interpreting the supplied qualitative value.

Representing allergenicity category of aero allergens

To describe the allergenicity category of aero allergens, for each aero allergens we use an attribute that MUST refers exactly to the conventional name of the allergen (usually the latin name of the associated plant) concatenated with the string _Allergenicity, e.g. alnus_Allergenicity to describe the allergenicity level of alnus pollen.

  • Attribute name: Equal to the name of the allergen plus the suffix _Allergenicity, for instance alnus_Allergenicity.
  • Attribute type: Property. Text
  • Attribute value: Example values defined by the Spanish Network for Aerobiology: (1, 2, 3, 4). As this can be different between countries, regulations or implementations, the set of allowed values will depend on the reference specification used. It is recommended that implementations use the same naming conventions as exemplified above (lower case starting words, camel case when compound terms are used)
  • Attribute metadata:
    • description : short description of the measurand and its related qualitative level
      • Attribute type: Property. Text
      • Normative References: https://uri.etsi.org/ngsi-ld/description equivalent to description
      • Optional
    • referenceSpecification : Specification that must be taken as reference when interpreting the supplied qualitative value.

Note: JSON Schemas are intended to capture the data type and associated constraints of the different Attributes, regardless their final representation format in NGSI(v2, LD).

Examples

Normalized Example

Normalized NGSI response

{
    "id": "AeroAllergenObserved-CDMX-Pollen-Cuajimalpa",
    "type": "AeroAllergenObserved",
    "dateObserved": {
        "type": "DateTime",
        "value": "2018-02-11T00:00:00.00Z"
    },
    "alnus": {
        "value": 40
    },
    "alnus_Allergenicity": {
        "value": "3"
    },
    "allergenRisk": {
        "value": "moderate"
    },
    "casuarina": {
        "value": 1
    },
    "casuarina_Level": {
        "value": "low"
    },
    "casuarina_Allergenicity": {
        "value": "3"
    },
    "source": {
        "value": "http://rema.atmosfera.unam.mx/rema/"
    },
    "location": {
        "type": "geo:json",
        "value": {
            "type": "Point",
            "coordinates": [-99.276977, 19.381877]
        }
    },
    "address": {
        "type": "PostalAddress",
        "value": {
            "addressCountry": "MX",
            "addressLocality": "Ciudad de M\u00e9xico",
            "streetAddress": "Colegio Franco-Ingl\u00e9s"
        }
    },
    "dateModified": {
        "type": "DateTime",
        "value": "2018-02-16T17:24:39.00Z"
    },
    "alnus_Level": {
        "value": "moderate"
    }
}

key-value pairs Example

Sample uses simplified representation for data consumers ?options=keyValues

{
    "id": "AeroAllergenObserved-CDMX-Pollen-Cuajimalpa",
    "type": "AeroAllergenObserved",
    "alnus_Level": "moderate",
    "alnus": 40,
    "alnus_Allergenicity": "3",
    "casuarina_Level": "low",
    "casuarina": 1,
    "casuarina_Allergenicity": "3",
    "allergenRisk": "moderate",
    "address": {
        "addressCountry": "MX",
        "addressLocality": "Ciudad de México",
        "streetAddress": "Colegio Franco-Inglés"
    },
    "dateModified": "2018-02-16T17:24:39.00Z",
    "dateObserved": "2018-02-11T00:00:00.00Z",
    "location": {
        "type": "Point",
        "coordinates": [-99.276977, 19.381877]
    },
    "source": "http://rema.atmosfera.unam.mx/rema/"
}

LD Example

Sample uses the NGSI-LD representation

{
    "id": "urn:ngsi-ld:AeroAllergenObserved:AeroAllergenObserved-CDMX-Pollen-Cuajimalpa",
    "type": "AeroAllergenObserved",
    "modifiedAt": "2018-02-16T17:24:39.00Z",
    "dateObserved": {
        "type": "Property",
        "value": {
            "@type": "DateTime",
            "@value": "2018-02-11T00:00:00.00Z"
        }
    },
    "alnus": {
        "type": "Property",
        "value": 40
    },
    "alnus_Allergenicity": {
        "type": "Property",
        "value": "3"
    },
    "allergenRisk": {
        "type": "Property",
        "value": "moderate"
    },
    "casuarina": {
        "type": "Property",
        "value": 1
    },
    "casuarina_Level": {
        "type": "Property",
        "value": "low"
    },
    "casuarina_Allergenicity": {
        "type": "Property",
        "value": "3"
    },
    "source": {
        "type": "Property",
        "value": "http://rema.atmosfera.unam.mx/rema/"
    },
    "location": {
        "type": "GeoProperty",
        "value": {
            "type": "Point",
            "coordinates": [-99.276977, 19.381877]
        }
    },
    "address": {
        "type": "Property",
        "value": {
            "addressCountry": "MX",
            "addressLocality": "Ciudad de M\u00e9xico",
            "streetAddress": "Colegio Franco-Ingl\u00e9s",
            "type": "PostalAddress"
        }
    },
    "alnus_Level": {
        "type": "Property",
        "value": "moderate"
    },
    "@context": [
        "https://schema.lab.fiware.org/ld/context",
        "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld"
    ]
}

Use it with a real service

TBD