# org.hypercerts.context.measurement

> Published by [hypercerts.org](https://lexicon.garden/identity/did:plc:s4puetfspot742ai7y4otuel)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:s4puetfspot742ai7y4otuel/org.hypercerts.context.measurement)
- [Documentation](https://lexicon.garden/lexicon/did:plc:s4puetfspot742ai7y4otuel/org.hypercerts.context.measurement/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:s4puetfspot742ai7y4otuel/org.hypercerts.context.measurement/examples)

## Definitions

### `org.hypercerts.context.measurement`

**Type**: `record`

Measurement data related to one or more records (e.g. activities, projects, etc.).

**Key**: `tid`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `unit` | `string` | Yes | The unit of the measured value (e.g. kg CO₂e, hectares, %, index score). |
| `value` | `string` | Yes | The measured value as a numeric string (e.g. '1234.56') |
| `metric` | `string` | Yes | The metric being measured, e.g. forest area restored, number of users, etc. |
| `comment` | `string` | No | Short comment of this measurement, suitable for previews and list views. Rich text annotations may be provided via `commentFacets`. |
| `endDate` | `string` (datetime) | No | The end date and time when the measurement ended. For one-time measurements, this should equal the start date. |
| `subjects` | `array` | No | Strong references to the records this measurement refers to (e.g. activities, projects, or claims). |
| `createdAt` | `string` (datetime) | Yes | Client-declared timestamp when this record was originally created |
| `locations` | `array` | No | Optional geographic references related to where the measurement was taken. Each referenced record must conform with the app.certified.location lexicon. |
| `measurers` | `array` | No | DIDs of the entities that performed this measurement |
| `methodURI` | `string` (uri) | No | URI to methodology documentation, standard protocol, or measurement procedure |
| `startDate` | `string` (datetime) | No | The start date and time when the measurement began. |
| `methodType` | `string` | No | Short identifier for the measurement methodology |
| `evidenceURI` | `array` | No | URIs to related evidence or underlying data (e.g. org.hypercerts.claim.evidence records or raw datasets) |
| `commentFacets` | `array` | No | Rich text annotations for `comment` (mentions, URLs, hashtags, etc). |

## Raw Schema

```json
{
  "id": "org.hypercerts.context.measurement",
  "defs": {
    "main": {
      "key": "tid",
      "type": "record",
      "record": {
        "type": "object",
        "required": [
          "metric",
          "unit",
          "value",
          "createdAt"
        ],
        "properties": {
          "unit": {
            "type": "string",
            "maxLength": 50,
            "description": "The unit of the measured value (e.g. kg CO₂e, hectares, %, index score)."
          },
          "value": {
            "type": "string",
            "maxLength": 500,
            "description": "The measured value as a numeric string (e.g. '1234.56')"
          },
          "metric": {
            "type": "string",
            "maxLength": 500,
            "description": "The metric being measured, e.g. forest area restored, number of users, etc."
          },
          "comment": {
            "type": "string",
            "maxLength": 3000,
            "description": "Short comment of this measurement, suitable for previews and list views. Rich text annotations may be provided via `commentFacets`.",
            "maxGraphemes": 300
          },
          "endDate": {
            "type": "string",
            "format": "datetime",
            "description": "The end date and time when the measurement ended. For one-time measurements, this should equal the start date."
          },
          "subjects": {
            "type": "array",
            "items": {
              "ref": "com.atproto.repo.strongRef",
              "type": "ref"
            },
            "maxLength": 100,
            "description": "Strong references to the records this measurement refers to (e.g. activities, projects, or claims)."
          },
          "createdAt": {
            "type": "string",
            "format": "datetime",
            "description": "Client-declared timestamp when this record was originally created"
          },
          "locations": {
            "type": "array",
            "items": {
              "ref": "com.atproto.repo.strongRef",
              "type": "ref"
            },
            "maxLength": 100,
            "description": "Optional geographic references related to where the measurement was taken. Each referenced record must conform with the app.certified.location lexicon."
          },
          "measurers": {
            "type": "array",
            "items": {
              "ref": "app.certified.defs#did",
              "type": "ref"
            },
            "maxLength": 100,
            "description": "DIDs of the entities that performed this measurement"
          },
          "methodURI": {
            "type": "string",
            "format": "uri",
            "description": "URI to methodology documentation, standard protocol, or measurement procedure"
          },
          "startDate": {
            "type": "string",
            "format": "datetime",
            "description": "The start date and time when the measurement began."
          },
          "methodType": {
            "type": "string",
            "maxLength": 30,
            "description": "Short identifier for the measurement methodology"
          },
          "evidenceURI": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "uri"
            },
            "maxLength": 50,
            "description": "URIs to related evidence or underlying data (e.g. org.hypercerts.claim.evidence records or raw datasets)"
          },
          "commentFacets": {
            "type": "array",
            "items": {
              "ref": "app.bsky.richtext.facet",
              "type": "ref"
            },
            "description": "Rich text annotations for `comment` (mentions, URLs, hashtags, etc)."
          }
        }
      },
      "description": "Measurement data related to one or more records (e.g. activities, projects, etc.)."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```
