Instrument

EntityDraftv1.0.0-rc.2

An instrument: a device that measures, such as a sound level meter, a microphone or a weather station, with its calibrations.

https://opendevelopmentstandards.org/schema/1.0.0-rc.2/core/Instrument.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
    List ofDatatypeIdentifier

    Ids the record has in other systems.

  • links
    List ofDatatypeLink

    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.

  • type
    Code fromcore/instrument_types

    What sort of instrument it is, such as sound_level_meter.

  • manufacturer
    text

    Who made it.

  • model
    text

    Its model, as the manufacturer names it.

  • serialNumber
    text

    Its serial number.

  • properties
    List ofPartProperty

    Facts about the instrument, such as its class or its firmware.

  • calibrations
    List ofPartCalibration

    Its calibrations and field checks.

  • components
    List ofId ofInstrument

    The instruments it is made of, such as a meter's microphone.

Links

Holds Parts this record embeds, with the field that holds each.

Held by Records that embed this one, with their field that holds it.

Pointed at by Records that hold this one's id, with their field that holds it.

Examples

An id that another example defines opens that record.

Full example

{
  "id": "instrument-slm",
  "name": "Sound level meter 1",
  "type": "sound_level_meter",
  "manufacturer": "Example Instruments",
  "model": "SLM-1",
  "serialNumber": "A2-10442",
  "properties": [
    {
      "type": "instrument_class",
      "value": {
        "amount": "class_1"
      }
    }
  ],
  "calibrations": [
    {
      "id": "calibration-2026",
      "type": "laboratory",
      "performedAt": "2026-03-02T15:00:00Z",
      "certificate": "file-certificate"
    }
  ],
  "components": [
    "instrument-microphone"
  ]
}
Show 1 more example

Minimal example: the required fields only

{
  "id": "instrument-slm"
}

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/Instrument.json",
  "title": "Instrument",
  "description": "An instrument: a device that measures, such as a sound level meter, a microphone or a weather station, with its calibrations.",
  "$ref": "Entity.json",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "pattern": "^[a-z0-9]+(_[a-z0-9]+)*(\\.[a-z0-9]+(_[a-z0-9]+)*)*$",
      "x-ods-vocabulary": "core/instrument_types",
      "description": "What sort of instrument it is, such as `sound_level_meter`."
    },
    "manufacturer": {
      "type": "string",
      "description": "Who made it."
    },
    "model": {
      "type": "string",
      "description": "Its model, as the manufacturer names it."
    },
    "serialNumber": {
      "type": "string",
      "description": "Its serial number."
    },
    "properties": {
      "type": "array",
      "items": {
        "$ref": "Property.json"
      },
      "description": "Facts about the instrument, such as its class or its firmware."
    },
    "calibrations": {
      "type": "array",
      "items": {
        "$ref": "Calibration.json"
      },
      "description": "Its calibrations and field checks."
    },
    "components": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "x-ods-ref": "Instrument"
      },
      "description": "The instruments it is made of, such as a meter's microphone."
    }
  },
  "patternProperties": {
    "^x-": {}
  },
  "unevaluatedProperties": false,
  "examples": [
    {
      "id": "instrument-slm"
    },
    {
      "id": "instrument-slm",
      "name": "Sound level meter 1",
      "type": "sound_level_meter",
      "manufacturer": "Example Instruments",
      "model": "SLM-1",
      "serialNumber": "A2-10442",
      "properties": [
        {
          "type": "instrument_class",
          "value": {
            "amount": "class_1"
          }
        }
      ],
      "calibrations": [
        {
          "id": "calibration-2026",
          "type": "laboratory",
          "performedAt": "2026-03-02T15:00:00Z",
          "certificate": "file-certificate"
        }
      ],
      "components": [
        "instrument-microphone"
      ]
    }
  ],
  "x-ods-status": "draft",
  "x-ods-kind": "entity",
  "x-ods-module": "core",
  "x-ods-changes": {
    "0.1.0": "First version."
  }
}