RegulatorProfile

EntityDraftv1.0.0-rc.2

A regulator profile: a framework written so that a program can run it. It names the framework, the flows that check it, who publishes it and its version. Its flows have no sealed steps, so any reader can run every rule.

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

  • version
    text

    The profile's version, as its publisher names it. A change to a rule makes a new version.

  • status
    One ofthe codes below

    Where the profile stands.

    draft
    The publisher has not released it. Its rules can change.
    published
    The publisher has released this version.
    superseded
    A later version replaces it.
    withdrawn
    The publisher took it back. Do not use it for new work.
  • publisher
    Id ofStakeholder

    Who wrote the profile and publishes it. It is the framework's issuer only when the issuer publishes the profile itself.

  • framework
    Id ofFramework

    The framework the profile states.

  • flows
    List ofId ofFlow

    The flows that check the framework, one for each purpose, such as an assessment before construction and the investigation of a complaint.

  • scope
    text

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

  • assumptions
    List ofId ofAssumption

    The readings the publisher chose where the framework leaves a choice open, each with its basis.

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.

Full example

{
  "id": "profile-d038",
  "name": "AER Directive 038 regulator profile",
  "version": "0.1.0",
  "status": "draft",
  "publisher": "stakeholder-consultant",
  "framework": "framework-d038",
  "flows": [
    "flow-d038"
  ],
  "scope": "Noise from energy facilities at dwellings. It leaves out areas that the regulator designates as special.",
  "assumptions": [
    "assumption-downwind"
  ],
  "identifiers": [
    {
      "scheme": "ods.profile",
      "value": "ca.ab.aer.directive_038"
    }
  ]
}
Show 1 more example

Minimal example: the required fields only

{
  "id": "profile-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/RegulatorProfile.json",
  "title": "RegulatorProfile",
  "description": "A regulator profile: a framework written so that a program can run it. It names the framework, the flows that check it, who publishes it and its version. Its flows have no sealed steps, so any reader can run every rule.",
  "$ref": "Entity.json",
  "type": "object",
  "properties": {
    "version": {
      "type": "string",
      "description": "The profile's version, as its publisher names it. A change to a rule makes a new version."
    },
    "status": {
      "type": "string",
      "enum": [
        "draft",
        "published",
        "superseded",
        "withdrawn"
      ],
      "description": "Where the profile stands.",
      "x-ods-options": [
        {
          "value": "draft",
          "title": "Draft",
          "description": "The publisher has not released it. Its rules can change."
        },
        {
          "value": "published",
          "title": "Published",
          "description": "The publisher has released this version."
        },
        {
          "value": "superseded",
          "title": "Superseded",
          "description": "A later version replaces it."
        },
        {
          "value": "withdrawn",
          "title": "Withdrawn",
          "description": "The publisher took it back. Do not use it for new work."
        }
      ]
    },
    "publisher": {
      "type": "string",
      "minLength": 1,
      "x-ods-ref": "Stakeholder",
      "description": "Who wrote the profile and publishes it. It is the framework's issuer only when the issuer publishes the profile itself."
    },
    "framework": {
      "type": "string",
      "minLength": 1,
      "x-ods-ref": "Framework",
      "description": "The framework the profile states."
    },
    "flows": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "x-ods-ref": "Flow"
      },
      "description": "The flows that check the framework, one for each purpose, such as an assessment before construction and the investigation of a complaint."
    },
    "scope": {
      "type": "string",
      "description": "What the profile covers and what it leaves out, in words."
    },
    "assumptions": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "x-ods-ref": "Assumption"
      },
      "description": "The readings the publisher chose where the framework leaves a choice open, each with its basis."
    }
  },
  "patternProperties": {
    "^x-": {}
  },
  "unevaluatedProperties": false,
  "examples": [
    {
      "id": "profile-1"
    },
    {
      "id": "profile-d038",
      "name": "AER Directive 038 regulator profile",
      "version": "0.1.0",
      "status": "draft",
      "publisher": "stakeholder-consultant",
      "framework": "framework-d038",
      "flows": [
        "flow-d038"
      ],
      "scope": "Noise from energy facilities at dwellings. It leaves out areas that the regulator designates as special.",
      "assumptions": [
        "assumption-downwind"
      ],
      "identifiers": [
        {
          "scheme": "ods.profile",
          "value": "ca.ab.aer.directive_038"
        }
      ]
    }
  ],
  "x-ods-status": "draft",
  "x-ods-kind": "entity",
  "x-ods-module": "core",
  "x-ods-changes": {
    "0.1.0": "First version."
  }
}