WIP consolidated hazards profiles, started pairing and sources

IFRCGo · Nov 5, 2024 · dd9c9bf · dd9c9bf
1 parent fc608da
commit dd9c9bf
Show file tree

Hide file tree

Showing 13 changed files with 1,049,203 additions and 517 deletions.
diff --git a/README.md b/README.md
@@ -25,7 +25,7 @@ The specification is organized as follows
 - [Data](#data): Describes the mandatory fields for all data objects.
   - [Hazard](#hazard): Describes the mandatory fields for the hazard object.
   - [Impact](#impact): Describes the mandatory fields for the impact object.
-
+  - [Response](#response): Describes the mandatory fields for the response object.
 
 The specifications of the fields and the objects are grouped by the data types of the
 
@@ -44,15 +44,30 @@ The fields in the sections below can be used in these parts of STAC documents:
 
 | Field Name          | Type                                        | Description                                                                                                                                                                                                                                                                                                 |
 | ------------------- | ------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| monty:country_codes | \[string]                                   | **REQUIRED**. The country codes of the countries affected by the event. The country code follows [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) standard format.                                                                                                                    |
-| monty:corr_id       | string                                      | **REQUIRED**. The unique identifier assigned by the Monty system to the reference event used to "pair" all the items of the same event.                                                                                                                                                                     |
+| monty:country_codes | \[string]                                   | **REQUIRED**. The country codes of the countries affected by the event, hazard, impact or response. The country code follows [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) standard format.                                                                                        |
+| monty:corr_id       | string                                      | **REQUIRED**. The unique identifier assigned by the Monty system to the reference event used to "pair" all the items of the same event. The correlation identifier follows a specific convention described in the [event correlation](./model/event_paring.md) page.                                        |
 | monty:hazard_codes  | \[string]                                   | The hazard codes of the hazards affecting the event. The hazard code follows the [UNDRR-ISC 2020 Hazard Information Profiles](https://www.preventionweb.net/drr-glossary/hips) identifier. The possible values are defined in [this table](./model/taxonomy.md#undrr-isc-2020-hazard-information-profiles). |
 | monty:hazard_detail | [Hazard Detail object](#montyhazard_detail) | The details of the hazard.                                                                                                                                                                                                                                                                                  |
 | monty:impact_detail | [Impact Detail object](#montyimpact_detail) | The details of the impact.                                                                                                                                                                                                                                                                                  |
 
 > [!NOTE]  
 > Either `monty:hazard_codes` OR `monty:hazard_detail` MUST be present in the item.
 
+### Roles
+
+A set of roles are defined to describe the type of the data. The following roles are defined:
+
+| Role      | Description                    |
+| --------- | ------------------------------ |
+| event     | The data is an event.          |
+| reference | The data is a reference event. |
+| source    | The data is a source event.    |
+| hazard    | The data is a hazard.          |
+| impact    | The data is an impact.         |
+| response  | The data is a response.        |
+
+The roles are used at the item level in the `roles` field to characterize the data. It is also used in the link object to characterize the linked item. This is useful to find exactly the item needed. For instance, to find the reference event of a data, a link with both `event` and `reference` roles is needed.
+
 ### Link Attributes
 
 | Field Name  | Type   | Description                                                                                                         |
@@ -120,6 +135,8 @@ The following types should be used as applicable `rel` types in the
 | ------------------- | ------------------------------------------------------------------------------------------------------------------ |
 | reference-event     | This link points to the reference event                                                                            |
 | source-event        | This link points to the source event                                                                               |
+| related-hazard      | This link points to a related hazard. For example, a flood related to the event.                                   |
+| related-impact      | This link points to a related impact. For example, a flood related to the impact.                                  |
 | triggers-hazard     | This link points to a triggered hazard. For example, an earthquake triggers a landslide.                           |
 | triggered-by-hazard | This link points to a triggered hazard. For example, a landslide triggered by an earthquake.                       |
 | concurrent-hazard   | This link points to a concurrent hazard. For example, thunderstorms can occur together with windstorms or cyclones |
@@ -154,7 +171,10 @@ The event class is the core of the Monty model. It represents a disaster event t
 The global crisis data bank records multiple instances of events that are related to a single event:
 
 - One **unique reference** event that is used to "pair" all the instances of the event
-- Multiple instances of the event that are recorded for different sources
+- Multiple instances of the event that are recorded for different sources. Each source event **MUST** have the following:
+  - A link to the reference event with the [relationship](#relation-types) type `reference-event`
+  - A link to the resource from which the event was sourced with 
+    the [relationship]([#relation-types](https://github.com/radiantearth/stac-spec/blob/master/best-practices.md#using-relation-types)) type `via`.
 
 ## Data
 

diff --git a/examples/glide-events/EQ-2008-000062-CHN.json b/examples/glide-events/EQ-2008-000062-CHN.json
@@ -0,0 +1,63 @@
+{
+  "stac_version": "1.0.0",
+  "stac_extensions": [
+    "https://IFRCGo.github.io/monty/v1.0.0/schema.json"
+  ],
+  "type": "Feature",
+  "id": "EQ-2008-000062-CHN",
+  "collection": "reference-events",
+  "bbox": [
+    103.279,
+    31.0992,
+    103.279,
+    31.0992
+  ],
+  "geometry": {
+    "type": "Point",
+    "coordinates": [
+      103.279,
+      31.0992
+    ]
+  },
+  "properties": {
+    "datetime": "2008-05-12T06:28:00Z",
+    "monty:country_codes": [
+      "CHN"
+    ],
+    "monty:hazard_codes": [
+      "GH0001",
+      "GH0002",
+      "GH0004"
+    ],
+    "monty:corr_id": "20080512T062800Z-CHN-GEO-SEIS-001-GCDB",
+    "roles": [
+      "event",
+      "reference"
+    ],
+    "keywords": [
+      "earthquake",
+      "china",
+      "Ground Shaking (Earthquake)",
+      "Earthquake Surface Rupture, Fissures, and Tectonic Uplift/Subsidence"
+    ]
+  },
+  "links": [
+    {
+      "href": "20080512T062800Z-CHN-GEO-SEIS-001-GCDB.json",
+      "rel": "self"
+    },
+    {
+      "href": "https://monty-api.ifrc.org/stac/glide-events/EQ-2008-000062-CHN",
+      "rel": "via"
+    },
+    {
+      "href": "20080512T062800Z-CHN-GEO-SEIS-001-GCDB.json",
+      "rel": "related",
+      "roles": [
+        "hazard"
+      ],
+      "type": "application/json"
+    }
+  ],
+  "assets": {}
+}
diff --git a/examples/item-hazard-eq-CHN.json b/examples/item-hazard-eq-CHN.json
diff --git a/examples/item-ref-event-flood-PAR.json b/examples/item-ref-event-flood-PAR.json
diff --git a/examples/item-source-event-eq-CHN-glide.json b/examples/item-source-event-eq-CHN-glide.json
@@ -0,0 +1,54 @@
+{
+  "stac_version": "1.0.0",
+  "stac_extensions": [
+    "https://IFRCGo.github.io/monty/v1.0.0/schema.json"
+  ],
+  "type": "Feature",
+  "id": "EQ-2008-000062-CHN",
+  "bbox": [
+    103.279,
+    31.0992,
+    103.279,
+    31.0992
+  ],
+  "geometry": {
+    "type": "Point",
+    "coordinates": [
+      103.279,
+      31.0992
+    ]
+  },
+  "properties": {
+    "datetime": "2008-05-12T06:28:00Z",
+    "monty:country_codes": [
+      "CHN"
+    ],
+    "monty:hazard_codes": [
+      "GH0001"
+    ],
+    "monty:corr_id": "EQ-2008-05-12-CHN-GCDB_V1",
+    "roles": [
+      "event",
+      "source"
+    ],
+    "keywords": [
+      "earthquake",
+      "china"
+    ]
+  },
+  "links": [
+    {
+      "href": "https://monty-api.ifrc.org/stac/reference-events/EQ-2008-05-12-CHN-GCDB_V1",
+      "rel": "reference-event"
+    },
+    {
+      "href": "https://monty-api.ifrc.org/stac/glide-events/EQ-2008-000062-CHN",
+      "rel": "self"
+    },
+    {
+      "href": "https://glidenumber.net/glide/public/search/details.jsp?glide=18190&record=46&last=78",
+      "rel": "via"
+    }
+  ],
+  "assets": {}
+}
diff --git a/examples/item-source-event-flood-PAR-GLIDE.json b/examples/item-source-event-flood-PAR-GLIDE.json