# Vulnerability metadata

```{contents} On this page
---
local:
depth: 1
---
```

The `vulnerability` component is described as:

```{jsoninclude-quote} ../../../docs/_readthedocs/html/rdls_schema_processed.json
---
jsonpointer: /properties/vulnerability/description
---
```

The vulnerability component describes metadata for datasets that detail relationships between hazard intensity and expected losses over exposed items, or spatial indexes associated with socio-economic vulnerability.

The function component uses hazard type, process type and intensity measure consistent with the hazard and loss components, exposure information consistent with the exposure and loss components. It contains key information including the type of function, intensity and impact metrics used, which asset types or population groups it applies to, how it was developed and for what locations.
The spatial indices component uses indicator id, description and thresholds. Spatial reference and location information are described using existing external standards.

## Overview

```{mermaid}
    erDiagram
        Direction LR

        "Vulnerability metadata" {
        }

        Dataset ||--o{ "Vulnerability metadata": ""
        "Vulnerability metadata" o|--o{ "Vulnerability function": "Used to calculate impact"
        "Vulnerability metadata" o|--o{ "Fragility function": "Used to calculate impact"
        "Vulnerability metadata" o|--o{ "Damage-to-loss function": "Used to calculate impact"
        "Vulnerability metadata" o|--o{ "Engineering demand function": "Used to calculate impact"
        "Vulnerability metadata" o|--o{ "Socio-economic indicator": "Used to calculate impact"

```

## Examples

``````{dropdown} Example: Global flood depth-damage functions
---
open:
---
The following example shows RDLS metadata for the [Global flood depth-damage functions](https://publications.jrc.ec.europa.eu/repository/handle/JRC105688) in tabular format and JSON format.

`````{tab-set}

````{tab-item} Figure

```{figure} ../../../examples/vulnerability/flood_jrc/figure.png
```
````

````{tab-item} Metadata (JSON)

```{eval-rst}
.. jsoninclude:: ../../../examples/vulnerability/flood_jrc/example.json
   :jsonpointer:
   :title: Example
```

`````

``````

``````{dropdown} Example: Relative Wealth Index

The following example shows RDLS metadata for the [Relative Wealth Index](https://data.humdata.org/dataset/relative-wealth-index) in JSON format.

`````{tab-set}

````{tab-item} Figure

```{figure} ../../../examples/vulnerability/wealth/figure.png
```

````

````{tab-item} Metadata (JSON)

```{eval-rst}
.. jsoninclude:: ../../../examples/vulnerability/wealth/example.json
   :jsonpointer:
   :title: Example
```

````

`````
``````

## Properties

```{jsonschema} ../../../docs/_readthedocs/html/rdls_schema_processed.json
:pointer: /properties/vulnerability
:collapse: functions/vulnerability,functions/fragility,functions/damage_to_loss,functions/engineering_demand,socio_economic
:externallinks: >
:   {
:       "functions/vulnerability":{"url":"#vulnerability-function","text":"Vulnerability function"},
:       "functions/fragility":{"url":"#fragility-function","text":"Fragility function"},
:       "functions/damage_to_loss":{"url":"#damage_to_loss-function","text":"Damage-to-loss function"},
:       "functions/engineering_demand":{"url":"#engineering-demand-function","text":"Engineering demand function"},
:       "socio_economic":{"url":"#socio-economic-indicator","text":"Socio-economic indicator"}
:   }
```

## Vulnerability function

```{jsonschema} ../../../docs/_readthedocs/html/rdls_schema_processed.json
:pointer: /properties/vulnerability/properties/functions/properties/vulnerability/items
:collapse: hazard_primary,hazard_secondary
:externallinks: >
:   {
:       "hazard_primary":{"url":"#hazard","text":"Hazard"},
:       "hazard_secondary":{"url":"#hazard","text":"Hazard"}
:   }
```

## Fragility function

```{jsonschema} ../../../docs/_readthedocs/html/rdls_schema_processed.json
:pointer: /properties/vulnerability/properties/functions/properties/fragility/items
:collapse: hazard_primary,hazard_secondary
:externallinks: >
:   {
:       "hazard_primary":{"url":"#hazard","text":"Hazard"},
:       "hazard_secondary":{"url":"#hazard","text":"Hazard"}
:   }
```

## Damage-to-loss function

```{jsonschema} ../../../docs/_readthedocs/html/rdls_schema_processed.json
:pointer: /properties/vulnerability/properties/functions/properties/damage_to_loss/items
:collapse: hazard_primary,hazard_secondary
:externallinks: >
:   {
:       "hazard_primary":{"url":"#hazard","text":"Hazard"},
:       "hazard_secondary":{"url":"#hazard","text":"Hazard"}
:   }
```

## Engineering demand function

```{jsonschema} ../../../docs/_readthedocs/html/rdls_schema_processed.json
:pointer: /properties/vulnerability/properties/functions/properties/engineering_demand/items
:collapse: hazard_primary,hazard_secondary
:externallinks: >
:   {
:       "hazard_primary":{"url":"#hazard","text":"Hazard"},
:       "hazard_secondary":{"url":"#hazard","text":"Hazard"}
:   }
```

## Socio-economic indicator

```{jsonschema} ../../../docs/_readthedocs/html/rdls_schema_processed.json
:pointer: /properties/vulnerability/properties/socio_economic/items
```

## Hazard

```{jsonschema} ../../../docs/_readthedocs/html/rdls_schema_processed.json
:pointer: /properties/vulnerability/properties/functions/properties/vulnerability/items/properties/hazard_primary
```