{
  "$schema": "http://json-schema.org/schema",
  "$schemaVersion": "0.0.1",
  "$id": "https://smart-data-models.github.io/SDMX/Observation/schema.json",
  "title": "Smart Data models - SDMX Observation schema",
  "modelTags": "Interstat",
  "description": "A single observation in the SDMX Cube, may have one or more associated measured values",
  "type": "object",
  "derivedFrom": "https://raw.githubusercontent.com/UKGovLD/publishing-statistical-data/master/specs/src/main/vocab/cube.ttl",
  "license": "http://www.opendatacommons.org/licenses/pddl/1.0",
  "allOf": [
    {
      "$ref": "https://smart-data-models.github.io/data-models/common-schema.json#/definitions/GSMA-Commons"
    },
    {
      "$ref": "https://smart-data-models.github.io/data-models/common-schema.json#/definitions/Location-Commons"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "Observation"
          ],
          "description": "Property. NGSI entity type. It has to be Observation"
        },
        "title": {
          "type": "string",
          "description": "Property. Model:'dct:title'. This property contains the main identifier for the Observation, the URI.",
          "format": "uri"
        },
        "identifier": {
          "type": "string",
          "description": "Property. Model:'dct:identifier'. This property contains a name given to the Dataset."
        },
        "dimensions": {
          "type": "array",
          "description": "Property. Model:'https://schema.org/StructuredValue'. This property contains the list of dimensions identified by its key and value.",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "value": {
                "type": "string"
              }
            }
          }
        },
        "dataset": {
          "type": "string",
          "description": "Relationship. Model:'http://purl.org/linked-data/cube#Dataset'. Represents a collection of observations, conforming to some common dimensional structure.",
          "anyOf": [
            {
              "type": "string",
              "minLength": 1,
              "maxLength": 256,
              "pattern": "^[\\w\\-\\.\\{\\}\\$\\+\\*\\[\\]`|~^@!,:\\\\]+$",
              "description": "Property. Identifier format of any NGSI entity"
            },
            {
              "type": "string",
              "format": "uri",
              "description": "Property. Identifier format of any NGSI entity"
            }
          ]
        },
        "confStatus": {
          "type": "string",
          "enum": [
            "F",
            "N",
            "C",
            "D",
            "S",
            "A",
            "O",
            "T",
            "G",
            "M",
            "E",
            "P"
          ],
          "description": "Property. Model:'http://purl.org/linked-data/sdmx/2009/code#confStatus'. Confidentiality Status (CONF_STATUS). This code list provides coded information about the sensitivity and confidentiality status of the data. The different values are defined based in Code List Confidentially Status v1.3 (https://sdmx.org/wp-content/uploads/CL_CONF_STATUS_1_3_2022.docx)"
        },
        "decimals": {
          "type": "number",
          "minimum": 0,
          "maximum": 15,
          "description": "Property. Model:'http://purl.org/linked-data/sdmx/2009/code#decimals'. Provide a list of values showing the number of decimal digits used in the data. The different values are defined based in Code List Decimals v1.3 (https://sdmx.org/wp-content/uploads/CL_CONF_STATUS_1_3_2022.docx)"
        },
        "obsStatus": {
          "type": "string",
          "enum": [
            "A",
            "B",
            "D",
            "E",
            "F",
            "G",
            "I",
            "K",
            "W",
            "O",
            "M",
            "P",
            "S",
            "L",
            "H",
            "Q",
            "J",
            "N",
            "U",
            "V"
          ],
          "description": "Property. Model:'http://purl.org/linked-data/sdmx/2009/code#obsStatus'. This code list provides coded information about the \"status\" of an observation (with respect events such as the ones reflected in the codes composing the code list). The different values are defined based in Code List Observation Status v2.2 (https://sdmx.org/wp-content/uploads/CL_OBS_STATUS_v2_2.docx)"
        },
        "unitMult": {
          "type": "number",
          "minimum": 0,
          "maximum": 13,
          "description": "Property. Model:'http://purl.org/linked-data/sdmx/2009/code#unitMult'. Provide code values for indicating the magnitude in the units of measurements. In scientific notation, expressed as ten raised to the power of the number. The different values are defined based in Unit Multiplier v1.1 (https://sdmx.org/wp-content/uploads/CL_UNIT_MULT_v1.1.docx)"
        },
        "freq": {
          "type": "string",
          "description": "Property. Model:'http://purl.org/linked-data/sdmx/2009/dimension#freq'. This code list provides a set of values indicating the 'frequency' of the data (e.g. weekly, monthly, quarterly). The concept “frequency” may refer to various stages in the production process, e.g. data collection or data dissemination. For example, a time series could be disseminated at annual frequency, but the underlying data are compiled monthly. The code list is applicable for all different uses of “frequency”. The different values are defined based in Unit Multiplier v1.1 (https://sdmx.org/wp-content/uploads/CL_FREQ-2.1_February_2021.docx)",
          "pattern": "^_[OUZ]|[SQBNI]|OA|OM|[AMWDH]_*[0-9]*$"
        },
        "refArea": {
          "type": "string",
          "description": "Property. Model:'http://purl.org/linked-data/sdmx/2009/dimension#refArea'. The country or geographic area to which the measured statistical phenomenon relates. The different values are defined based in Reference Area v2.0 (https://sdmx.org/wp-content/uploads/CL_AREA_2_0_March_2019.docx)"
        },
        "timePeriod": {
          "type": "string",
          "description": "Property. Model:'http://purl.org/linked-data/sdmx/2009/dimension#timePeriod'. The period of time or point in time to which the measured observation refers. The measurement represented by each observation corresponds to a specific point in time (e.g. a single day) or a period (e.g. a month, a fiscal year, or a calendar year). This is used as a time stamp and is of particular importance for time series data. In cases where the actual time period of the data differs from the target reference period, “time period” refers to the actual period."
        },
        "obsValue": {
          "description": "Property. Model:'http://purl.org/linked-data/sdmx/2009/measure#obsValue'. The value of a particular variable at a particular period.",
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "number"
            }
          ]
        }
      }
    }
  ],
  "required": [
    "id",
    "type"
  ]
}