Assessment

EntityDraftv1.0.0-rc.2

An assessment: an evaluation of a development and its result, such as a noise impact assessment. It names its authors, scope and framework, the traces and evidence it rests on, and its conclusions. A trace is one run; an assessment can rest on many.

https://opendevelopmentstandards.org/schema/1.0.0-rc.2/core/Assessment.json

Fields

Every entity also has the fields of the Entity base. The first row lists them.

From the Entity baseidnamedescriptionidentifierslinkscreatedAtupdatedAt
  • idRequired
    textnot empty

    The record's id: unique within the document. Fields that point at the record hold this id.

  • name
    text

    The name people use for the record.

  • description
    text

    What the record is, in words.

  • identifiers

    Ids the record has in other systems.

  • links

    Open-ended links to other records.

  • createdAt
    date-time (RFC 3339)

    When the record was created, in its producer's system.

  • updatedAt
    date-time (RFC 3339)

    When the record last changed, in its producer's system.

  • status
    One ofthe codes below

    Where the assessment stands.

    draft
    Not issued.
    issued
    Issued to its readers.
    superseded
    Replaced by a later assessment.
  • authors

    Who wrote the assessment.

  • issuedAt
    date-time (RFC 3339)

    When it was issued.

  • scope
    text

    What the assessment covers and what it leaves out, in words.

  • features

    The features it assesses.

  • frameworks

    The frameworks it judges against.

  • traces
    List ofId ofTrace

    The runs it rests on.

  • evidence

    The evidence it rests on.

  • conclusions
    List ofConclusion

    What it concludes.

Conclusion

One conclusion of an assessment.

  • statementRequired
    textnot empty

    The conclusion, in words.

  • verdict
    One ofthe codes below

    The verdict it states, when it states one.

    pass
    Every criterion is met.
    partial
    No criterion failed, and at least one is met only in part, such as with a warning or a condition.
    fail
    At least one criterion is not met.
    not_judged
    The assessment does not judge this.
  • criterion

    The criterion it judges against.

  • records
    List ofId ofany record

    The ids of the records it is about.

Links

Examples

An id that another example defines opens that record.

Full example

{
  "id": "assessment-0412",
  "name": "Noise impact assessment, Wellsite 04-12",
  "status": "issued",
  "authors": [
    "stakeholder-consultant"
  ],
  "issuedAt": "2026-07-24T18:00:00Z",
  "features": [
    "feature-wellsite",
    "feature-dwelling"
  ],
  "frameworks": [
    "framework-d038"
  ],
  "traces": [
    "trace-0412-night"
  ],
  "evidence": [
    "evidence-night-survey"
  ],
  "conclusions": [
    {
      "statement": "The compressor meets the night-time permissible sound level at the dwelling.",
      "verdict": "pass",
      "records": [
        "feature-dwelling"
      ]
    }
  ]
}
Show 1 more example

Minimal example: the required fields only

{
  "id": "assessment-1"
}

Changes and file

Changes

  1. 0.1.0 First version.

Schema file

Show the JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://opendevelopmentstandards.org/schema/1.0.0-rc.2/core/Assessment.json",
  "title": "Assessment",
  "description": "An assessment: an evaluation of a development and its result, such as a noise impact assessment. It names its authors, scope and framework, the traces and evidence it rests on, and its conclusions. A trace is one run; an assessment can rest on many.",
  "$ref": "Entity.json",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "draft",
        "issued",
        "superseded"
      ],
      "description": "Where the assessment stands.",
      "x-ods-options": [
        {
          "value": "draft",
          "title": "Draft",
          "description": "Not issued."
        },
        {
          "value": "issued",
          "title": "Issued",
          "description": "Issued to its readers."
        },
        {
          "value": "superseded",
          "title": "Superseded",
          "description": "Replaced by a later assessment."
        }
      ]
    },
    "authors": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "x-ods-ref": "Stakeholder"
      },
      "description": "Who wrote the assessment."
    },
    "issuedAt": {
      "type": "string",
      "format": "date-time",
      "description": "When it was issued."
    },
    "scope": {
      "type": "string",
      "description": "What the assessment covers and what it leaves out, in words."
    },
    "features": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "x-ods-ref": "Feature"
      },
      "description": "The features it assesses."
    },
    "frameworks": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "x-ods-ref": "Framework"
      },
      "description": "The frameworks it judges against."
    },
    "traces": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "x-ods-ref": "Trace"
      },
      "description": "The runs it rests on."
    },
    "evidence": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "x-ods-ref": "Evidence"
      },
      "description": "The evidence it rests on."
    },
    "conclusions": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Conclusion"
      },
      "description": "What it concludes."
    }
  },
  "patternProperties": {
    "^x-": {}
  },
  "unevaluatedProperties": false,
  "$defs": {
    "Conclusion": {
      "type": "object",
      "properties": {
        "statement": {
          "type": "string",
          "description": "The conclusion, in words.",
          "minLength": 1
        },
        "verdict": {
          "type": "string",
          "enum": [
            "pass",
            "partial",
            "fail",
            "not_judged"
          ],
          "description": "The verdict it states, when it states one.",
          "x-ods-options": [
            {
              "value": "pass",
              "title": "Pass",
              "description": "Every criterion is met."
            },
            {
              "value": "partial",
              "title": "Partial",
              "description": "No criterion failed, and at least one is met only in part, such as with a warning or a condition."
            },
            {
              "value": "fail",
              "title": "Fail",
              "description": "At least one criterion is not met."
            },
            {
              "value": "not_judged",
              "title": "Not judged",
              "description": "The assessment does not judge this."
            }
          ]
        },
        "criterion": {
          "type": "string",
          "minLength": 1,
          "x-ods-ref": "Criterion",
          "description": "The criterion it judges against."
        },
        "records": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "x-ods-ref": "*"
          },
          "description": "The ids of the records it is about."
        }
      },
      "required": [
        "statement"
      ],
      "description": "One conclusion of an assessment.",
      "patternProperties": {
        "^x-": {}
      },
      "unevaluatedProperties": false
    }
  },
  "examples": [
    {
      "id": "assessment-1"
    },
    {
      "id": "assessment-0412",
      "name": "Noise impact assessment, Wellsite 04-12",
      "status": "issued",
      "authors": [
        "stakeholder-consultant"
      ],
      "issuedAt": "2026-07-24T18:00:00Z",
      "features": [
        "feature-wellsite",
        "feature-dwelling"
      ],
      "frameworks": [
        "framework-d038"
      ],
      "traces": [
        "trace-0412-night"
      ],
      "evidence": [
        "evidence-night-survey"
      ],
      "conclusions": [
        {
          "statement": "The compressor meets the night-time permissible sound level at the dwelling.",
          "verdict": "pass",
          "records": [
            "feature-dwelling"
          ]
        }
      ]
    }
  ],
  "x-ods-status": "draft",
  "x-ods-kind": "entity",
  "x-ods-module": "core",
  "x-ods-changes": {
    "0.1.0": "First version."
  }
}