physical-data-model.yml

$schema: 'https://json-schema.org/draft/2020-12/schema'
$id: 'https://raw.githubusercontent.com/opencdms/opencdms-data-layer/main/physical-data-model.yml'
title: 'OpenCDMS schema for observations database'
description: 'OpenCDMS schema for observations database'
properties:
  observation_type:
    type: object
    description: 
    properties:
      id:
        type: integer
        description: ID / primary key
      name:
        type: string
        description: Short name for observation type
      description:
        type: string
        description: Description of observation type
      link:
        type: string
        description: Link to definition of observation type

  feature_type:
    type: object
    description: 
    properties:
      id:
        type: integer
        description: ID / primary key
      name:
        type: string
        description: Short name for feature type
      description:
        type: string
        description: Description of feature type
      link:
        type: string
        description: Link to definition of feature type

  observed_property:
    type: object
    description: 
    properties:
      id:
        type: integer
        description: ID / primary key
      short_name:
        type: string
        description: Short name representation of observed property, e.g. 'at'
      standard_name:
        type: string
        description: CF standard name (if applicable), e.g. 'air_temperature'
      units:
        type: string
        description: Canonical units, e.g. 'Kelvin'
      description:
        type: string
        description: Description of observed property
      link:
        type: string
        description: Link to definition / source of observed property

  observing_procedure:
    type: object
    description: 
    properties:
      id:
        type: integer
        description: ID / primary key
      name:
        type: string
        description: Name of observing procedure
      description:
        type: string
        description: Description of observing procedure
      link:
        type: string
        description: Link to further information

  record_status:
    type: object
    description: 
    properties:
      id:
        type: integer
        description: ID / primary key
      name:
        type: string
        description: Short name for status
      description:
        type: string
        description: Description of the status

  stations:
    type: object
    description: 
    properties:
      id:
        type: string
        description: ID / primary key
      name:
        type: string
        description: Preferred name of station
      description:
        type: string
        description: Station description
      link:
        type: string
        description: URI to station, e.g. to OSCAR/Surface
      location:
        type: object
        properties:
          type:
            type: string
            enum: [Point, Polygon]
          coordinates:
            type: array
            minItems: 2
            maxItems: 2
            items:
              type: number
        description: Location of station
      elevation:
        type: number
        description: Elevation of station above mean sea level
      wigos_station_identifier:
        type: string
        description: WIGOS station identifier
      facility_type:
        type: string
        description: Type of observing facility, fixed land, mobile sea, etc
      date_established:
        type: string
        description: Date station was first established
      wmo_region:
        type: string
        description: WMO region in which the station is located
      territory:
        type: string
        description: Territory the station is located in
      valid_from:
        type: string
        format: date-time
        description: Date from which the details for this record are valid
      valid_to:
        type: string
        format: date-time
        description: Date after which the details for this record are no longer valid
      version:
        type: integer
        description: Version number of this record
      change_date:
        type: string
        format: date-time
        description: Date this record was changed
      status:
        type: integer
        description: Whether this is the latest version or an archived version of the record
      comments:
        type: string
        description: Free text comments on this record, for example description of changes made etc

  sensors:
    type: object
    description: 
    properties:
      id:
        type: string
        description: ID / primary key
      name:
        type: string
        description: Name of sensor
      description:
        type: string
        description: Description of sensor
      link:
        type: string
        description: Link to further information

  observations:
    type: object
    description: 
    properties:
      id:
        type: string
        description: ID / primary key
      location:
        type: object
        properties:
          type:
            type: string
            enum: [Point, Polygon]
          coordinates:
            type: array
            minItems: 2
            maxItems: 2
            items:
              type: number
        description: location of observation
      observation_type:
        type: integer
        description: Type of observation
      phenomenon_start:
        type: string
        format: date-time
        description: Start time of the phenomenon being observed or observing period, if missing assumed instantaneous with time given by phenomenon_end
      phenomenon_end:
        type: string
        format: date-time
        description: End time of the phenomenon being observed or observing period
      result_value:
        type: number
        description: The value of the result in numeric representation
      result_uom:
        type: string
        description: Units used to represent the value being observed
      result_description:
        type: string
        description: String representation of the result if applicable
      result_quality:
        type: object
        description: JSON representation of the result quality, key / value pairs
      result_time:
        type: string
        format: date-time
        description: Time that the result became available
      valid_from:
        type: string
        format: date-time
        description: Time that the result starts to be valid
      valid_to:
        type: string
        format: date-time
        description: Time after which the result is no longer valid
      station:
        type: string
        description: Station associated with making the observation, equivalent to OGC OMS 'host'
      sensor:
        type: string
        description: Sensor associated with making the observation, equivalent to OGC OMS 'observer'
      observed_property:
        type: integer
        description: The phenomenon, or thing, being observed
      observing_procedure:
        type: integer
        description: Procedure used to make the observation
      report_id:
        type: string
        description: Parent report ID, used to link coincident observations together
      collection:
        type: string
        description: Primary collection or dataset that this observation belongs to
      parameter:
        type: object
        description: List of key/ value pairs in JSONB
      feature_of_interest:
        type: string
        description: Feature that this observation is associated with
      version:
        type: integer
        description: Version number of this record
      change_date:
        type: string
        format: date-time
        description: Date this record was changed
      status:
        type: integer
        description: Whether this is the latest version or an archived version of the record
      comments:
        type: string
        description: Free text comments on this record, for example description of changes made etc

  collections:
    type: object
    description: 
    properties:
      id:
        type: string
        description: ID / primary key
      name:
        type: string
        description: Name of collection
      link:
        type: string
        description: Link to further information on collection

  features:
    type: object
    description: table to contain definition of different geographic features
    properties:
      id:
        type: string
        description: ID / primary key
      type:
        type: integer
        description: enumerated feature type
      geometry:
        type: object
        properties:
          type:
            type: string
            enum: [Point, Polygon]
          coordinates:
            type: array
            minItems: 2
            maxItems: 2
            items:
              type: number
        description: 
      parent:
        type: string
        description: Parent feature for this feature if nested