Identifier

DatatypeDraftv1.0.0-rc.2

An id a record has in another system: a licence number, a register id or a producer's own key. The record's own id stays the one that references use.

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

Fields

  • schemeRequired
    Codesnake_case

    The system or register that the value belongs to, as a code: lower snake_case, with dots between the parts of a namespace, such as ca.ab.aer_licence or au.nsw.epl.

  • valueRequired
    textnot empty

    The id in that scheme, exactly as the scheme writes it.

  • issuer
    Id ofStakeholder

    The id of the Stakeholder that issues ids in this scheme, when the document holds one.

Links

Points at Records whose ids this record holds, with the field that holds each.

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

Examples

An id that another example defines opens that record.

Example 2

{
  "scheme": "ca.ab.aer_licence",
  "value": "0512345",
  "issuer": "stakeholder-aer"
}
Show 1 more example

Example 1

{
  "scheme": "ca.ab.aer_licence",
  "value": "0512345"
}

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/Identifier.json",
  "title": "Identifier",
  "description": "An id a record has in another system: a licence number, a register id or a producer's own key. The record's own `id` stays the one that references use.",
  "type": "object",
  "properties": {
    "scheme": {
      "type": "string",
      "pattern": "^[a-z0-9]+(_[a-z0-9]+)*(\\.[a-z0-9]+(_[a-z0-9]+)*)*$",
      "description": "The system or register that the value belongs to, as a code: lower snake_case, with dots between the parts of a namespace, such as `ca.ab.aer_licence` or `au.nsw.epl`."
    },
    "value": {
      "type": "string",
      "minLength": 1,
      "description": "The id in that scheme, exactly as the scheme writes it."
    },
    "issuer": {
      "type": "string",
      "minLength": 1,
      "x-ods-ref": "Stakeholder",
      "description": "The id of the Stakeholder that issues ids in this scheme, when the document holds one."
    }
  },
  "required": [
    "scheme",
    "value"
  ],
  "patternProperties": {
    "^x-": {}
  },
  "unevaluatedProperties": false,
  "examples": [
    {
      "scheme": "ca.ab.aer_licence",
      "value": "0512345"
    },
    {
      "scheme": "ca.ab.aer_licence",
      "value": "0512345",
      "issuer": "stakeholder-aer"
    }
  ],
  "x-ods-status": "draft",
  "x-ods-kind": "datatype",
  "x-ods-module": "core",
  "x-ods-changes": {
    "0.1.0": "First version."
  }
}