id: https://modellen.netbeheernederland.nl/capaciteitskaart/1.0
name: capaciteitskaart
description: |-
  Information model of data product Capaciteitskaart
title: Capaciteitskaart
license: https://www.apache.org/licenses/LICENSE-2.0.txt
imports:
  - linkml:types
prefixes:
  cim: https://cim.ucaiug.io/ns#
  dct: http://purl.org/dc/terms/
  linkml: https://w3id.org/linkml/
  nbnl: https://begrippen.netbeheernederland.nl/id/
  nl: http://iec.ch/TC57/CIM100-Netherlands#
  owl: http://www.w3.org/2002/07/owl#
  this: http://data.netbeheernederland.nl/dp-capaciteitskaart/def#
  unit: http://qudt.org/vocab/unit/
annotations:
  model_uri: https://modellen.netbeheernederland.nl/capaciteitskaart
  exchange_format: application/json
  model_type: data-product
  environment: https://ghcr.io/netbeheer-nederland/build-dp:0.35
types:
  MegaW:
    typeof: float
    uri: unit:MegaW
  KiloA:
    typeof: float
    uri: unit:KiloA
  KiloV:
    typeof: float
    uri: unit:KiloV
enums:
  EnergyAreaKind:
    description: Kind of EnergyAdea. Defines the energy area as a regular energy area, or congestion area.
    enum_uri: this:EnergyAreaKind
    permissible_values:
      energy_area:
        description: Energy area.
        meaning: this:EnergyAreaKind.energyArea
      congestion_area:
        description: Congestion area.
        meaning: this:EnergyAreaKind.congestionArea
  UpdateInfoKind:
    description: Type of information that has been updated as part of this dataset.
    enum_uri: this:UpdateInfoKind
    permissible_values:
      KI:
        description: Kleurinformatie.
        meaning: this:UpdateInfoKind.KI
      ATC:
        description: Aanwezige transportcapaciteit.
        meaning: this:UpdateInfoKind.ATC
      BTC:
        description: Benodigde transportcapaciteit.
        meaning: this:UpdateInfoKind.BTC
      WR:
        description: Wachtrij.
        meaning: this:UpdateInfoKind.WR
      NU:
        description: Netuitbreidingen.
        meaning: this:UpdateInfoKind.NU
      JC:
        description: Jaartal congestie opgelost.
        meaning: this:UpdateInfoKind.JC
  RAGKind:
    description: Traffic light colors coding scheme for categorising status.
    enum_uri: this:RAGKind
    permissible_values:
      transparant:
        description: Transport capacity is available, without queue (*Transportcapaciteit beschikbaar zonder wachtrij*).
        meaning: this:RAGKind.Transparant
      red:
        description: Shortage of transport capacity, with queue (Tekort aan Transportcapaciteit met wachtrij).
        meaning: this:RAGKind.Red
      amber:
        description: Energy Area is being investigated, with queue (Voedingsgebied is in onderzoek met wachtrij).
        meaning: this:RAGKind.Amber
      yellow:
        description: Limited availability of transport capacity, without queue (Transportcapaciteit beperkt beschikbaar zonder wachtrij).
        meaning: this:RAGKind.Yellow
  WorkStatusKind:
    description: Kind of status, specific to work.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968
    enum_uri: cim:WorkStatusKind
    permissible_values:
      cancelled:
        meaning: cim:WorkStatusKind.cancelled
      completed:
        meaning: cim:WorkStatusKind.completed
      inProgress:
        meaning: cim:WorkStatusKind.inProgress
      scheduled:
        meaning: cim:WorkStatusKind.scheduled
  WorkTimeScheduleKind:
    description: Kind of work schedule.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968
    enum_uri: cim:WorkTimeScheduleKind
    permissible_values:
      actual:
        meaning: cim:WorkTimeScheduleKind.actual
      earliest:
        meaning: cim:WorkTimeScheduleKind.earliest
      estimate:
        meaning: cim:WorkTimeScheduleKind.estimate
      immediate:
        meaning: cim:WorkTimeScheduleKind.immediate
      latest:
        meaning: cim:WorkTimeScheduleKind.latest
      request:
        meaning: cim:WorkTimeScheduleKind.request
classes:
  HeatmapDataSet:
    description: A single instance of a published dataset. The descriptions of these fields are taken from the Dublin Core Standard.
    attributes:
      conforms_to:
        description: ID for the schema used to create the instance data.
        slot_uri: dct:conformsTo
        required: true
      contributor:
        description: An entity responsible for making contributions to the resource.
        slot_uri: dct:contributor
        required: false
      coverage:
        description: The spatial or temporal topic of the resource, spatial applicability of the resource, or jurisdiction under which the resource is relevant.
        slot_uri: dct:coverage
        required: false
      creator:
        description: An entity responsible for making the resource.
        slot_uri: dct:creator
        required: true
      date:
        description: A point of time associated with an event in the lifecycle of the resource. For this implementation this will represent the date the data set is valid from.
        slot_uri: dct:date
        range: date
        required: false
      description:
        description: An account of the resource.
        slot_uri: dct:description
        required: false
      format:
        description: The file format of the resource.
        slot_uri: dct:format
        required: false
      identifier:
        description: An unambiguous reference to the resource within a given context.
        slot_uri: dct:identifier
        required: true
      issued:
        description: Date of formal issuance of the resource.
        slot_uri: dct:issued
        range: date
        required: true
      language:
        description: A language of the resource.
        slot_uri: dct:language
        required: false
      publisher:
        description: An entity responsible for making the resource available.
        slot_uri: dct:publisher
        required: false
      rights:
        description: Information about rights held in and over the resource.
        slot_uri: dct:rights
        required: false
      title:
        description: A name given to the resource.
        slot_uri: dct:title
        required: false
      updated:
        description: Type of information that was updated for this dataset.
        slot_uri: this:HeatmapDataSet.updated
        range: UpdateInfo
        multivalued: true
        required: false
      valid:
        description: A date range for the validity of a resource. This should be two dates, start & end. The first date is inclusive and the second date exclusive.
        slot_uri: dct:valid
        range: DateTimeInterval
        required: false
      energy_areas:
        description: A list of energy areas with heatmap data.
        slot_uri: this:HeatmapDataSet.EnergyAreas
        multivalued: true
        range: EnergyArea
        required: true
    class_uri: this:HeatmapDataSet
    tree_root: true
  EnergyArea:
    description: Describes an area having energy production or consumption. Specializations are intended to support the load allocation function as typically required in energy management systems or planning studies to allocate hypothesized load levels to individual load points for power flow analysis. Often the energy area can be linked to both measured and forecast load levels.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.LoadModel
    exact_mappings:
      - nbnl:8eytm
    is_a: IdentifiedObject
    attributes:
      short_code:
        description: Short code name for EnergyArea. This is the *Uniek ID voedingsgebied* in the previous implementation.
        slot_uri: this:EnergyArea.shortCode
        required: true
      type:
        description: Type of EnergyArea, either a regular energy area, or congestion area. Only the TSO dataset can define congestion areas.
        slot_uri: this:EnergyArea.type
        range: EnergyAreaKind
        required: false
      demand_requests_in_queue:
        description: Number of demand requests for new grid connections and capacity increases in queue. This is the *Aantal unieke transportverzoeken in een wachtrij - afname* in the previous implementation.
        slot_uri: this:EnergyArea.demandRequestsInQueue
        range: integer
        required: false
        minimum_value: 0
      demand_capacity_in_queue:
        description: The contract value of demand requests not yet granted. This is the *Wachtrij in capaciteit - afname* in the previous implementation.
        slot_uri: this:EnergyArea.demandCapacityInQueue
        range: MegaW
        required: false
        minimum_value: 0
      demand_quoted_capacity:
        description: Sum of all demand (in MW) currently quoted at the EnergyArea.  This is the *Benodigde transportcapaciteit (in MW) afname* in the previous implementation.
        slot_uri: this:EnergyArea.demandQuotedCapacity
        range: MegaW
        required: false
        minimum_value: 0
      demand_available_capacity:
        description: The available demand capacity (in MW) at the EnergyArea. The value should reflect the capacity a network operator would make available to a connecting party. This is the *Aanwezige transportcapaciteit (in MW) afname huidige jaar* in the previous implementation.
        slot_uri: this:EnergyArea.demandAvailableCapacity
        range: MegaW
        required: false
        minimum_value: 0
      demand_forecast_capacity:
        description: Sum of all demand (in MW) forecast for the current year at the EnergyArea.
        slot_uri: this:EnergyArea.demandForecastCapacity
        range: MegaW
        required: false
        minimum_value: 0
      demand_alleviation_year:
        description: Year (e.g. *2028*) from which any capacity issues have been alleviated for the EnergyArea.
        slot_uri: this:EnergyArea.demandAlleviationYear
        range: integer
        required: false
      demand_constraint:
        description: A RAG definition of the demand constraints at the EnergyArea. A utility should provide details on how this RAG status is calculated as part of the accompanying documentation. Only specify this attribute if no PostcodeArea-s are provided.
        slot_uri: this:EnergyArea.demandConstraint
        range: RAGKind
        required: false
      demand_energy_area_short_code:
        description: Reference to a TenneT EnergyArea which is defined as a congestion area. Used specifically in the TSO dataset.
        slot_uri: this:EnergyArea.demandEnergyAreaShortCode
        range: string
        required: false
      generation_requests_in_queue:
        description: Number of generation requests for new grid connections and capacity increases in queue. This is the *Aantal unieke transportverzoeken in een wachtrij - invoeding* in the previous implementation.
        slot_uri: this:EnergyArea.generationRequestsInQueue
        range: integer
        required: false
        minimum_value: 0
      generation_capacity_in_queue:
        description: The contract value of generation requests not yet granted. This is the *Wachtrij in capaciteit - invoeding* in the previous implementation.
        slot_uri: this:EnergyArea.generationCapacityInQueue
        range: MegaW
        required: false
        minimum_value: 0
      generation_quoted_capacity:
        description: Sum of all currently quoted generation (in MW) at the EnergyArea. This is the *Benodigde transportcapaciteit (in MW) invoeding* in the previous implementation.
        slot_uri: this:EnergyArea.generationQuotedCapacity
        range: MegaW
        required: false
        minimum_value: 0
      generation_available_capacity:
        description: Available generation capacity (in MW) at the EnergyArea. This is the *Aanwezige transportcapaciteit (in MW) invoeding huidige jaar* in the previous implementation.
        slot_uri: this:EnergyArea.generationAvailableCapacity
        range: MegaW
        required: false
        minimum_value: 0
      generation_forecast_capacity:
        description: Sum of all forecast generation (in MW) for the current year at the EnergyArea.
        slot_uri: this:EnergyArea.generationForecastCapacity
        range: MegaW
        required: false
        minimum_value: 0
      generation_alleviation_year:
        description: Year (e.g. *2028*) from which any capacity issues have been alleviated for the EnergyArea.
        slot_uri: this:EnergyArea.generationAlleviationYear
        range: integer
        required: false
      generation_constraint:
        description: A RAG definition of the generation constraints at the EnergyArea. A utility should provide details on how this RAG status is calculated as part of the accompanying documentation. Only specify this attribute if no PostcodeArea-s are provided.
        slot_uri: this:EnergyArea.generationConstraint
        range: RAGKind
        required: false
      generation_energy_area_short_code:
        description: Reference to a TenneT EnergyArea which is defined as a congestion area. Used specifically in the TSO dataset.
        slot_uri: this:EnergyArea.generationEnergyAreaShortCode
        range: string
        required: false
      works:
        description: All the works performed for this EnergyArea.
        slot_uri: this:EnergyArea.Works
        multivalued: true
        range: Work
        required: true
      postcode_areas:
        description: Postcode Areas serviced by this EnergyArea.
        slot_uri: this:EnergyArea.PostcodeAreas
        multivalued: true
        range: PostcodeArea
        required: false
    class_uri: cim:EnergyArea
  PostcodeArea:
    description: A geographic region that is defined by the initial letters or digits of a postcode.
    is_a: IdentifiedObject
    attributes:
      postcode:
        description: Identifier for the postcode area. Contain four (4) numbers, followed by two (2) letters, uppercase. No spaces between the numbers and letters, i.e. "1234AB".
        slot_uri: this:PostcodeArea.postcode
        required: true
      substation_short_code:
        description: TenneT substation (*Onderstation*) which feeds this PostcodeArea. Use the *ck.EnergyArea.short_code* from the TenneT dataset to relate the PostcodeArea.
        slot_uri: this:PostcodeArea.substationShortCode
        required: false
      demand_constraint:
        description: A RAG definition of the demand constraints at the EnergyArea. A utility should provide details on how this RAG status is calculated as part of the accompanying documentation. This is the *Kleurcodering van het postcodegebied voor afname* in the previous implementation.
        slot_uri: this:PostcodeArea.demandConstraint
        range: RAGKind
        required: true
      generation_constraint:
        description: A RAG definition of the generation constraints at the EnergyArea. A utility should provide details on how this RAG status is calculated as part of the accompanying documentation. This is the *Kleurcodering van het postcodegebied voor opwek* in the previous implementation.
        slot_uri: this:PostcodeArea.generationConstraint
        range: RAGKind
        required: true
    class_uri: this:PostcodeArea
  Work:
    description: Document used to request, initiate, track and record work. Use the *description* attribute to add additional information about this *Work*. This is *Toelichting bijzonderheden rondom planning* in the previous implementation.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Work
    is_a: BaseWork
    attributes:
      project_name:
        description: Name of the project this work belongs to. This is the *Projectnaam* in the previous implementation.
        slot_uri: this:Work.projectName
        required: true
    class_uri: cim:Work
  BaseWork:
    description: Common representation for work and work tasks.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Work
    is_a: Document
    attributes:
      status_kind:
        description: Kind of work status.
        slot_uri: cim:BaseWork.statusKind
        range: WorkStatusKind
        required: false
      time_schedules:
        description: All time schedules for this work or work task.
        slot_uri: cim:BaseWork.TimeSchedules
        multivalued: true
        range: WorkTimeSchedule
        required: true
    class_uri: cim:BaseWork
  WorkTimeSchedule:
    description: Time schedule specific to work.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Work
    is_a: TimeSchedule
    class_uri: cim:WorkTimeSchedule
  Document:
    description: Parent class for different groupings of information collected and managed as a part of a business process. It will frequently contain references to other objects, such as assets, people and power system resources.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
    is_a: IdentifiedObject
    attributes:
      type:
        description: Utility-specific classification of this document, according to its corporate standards, practices, and existing IT systems (e.g., for management of assets, maintenance, work, outage, customers, etc.).
        slot_uri: cim:Document.type
        range: string
        required: false
    class_uri: cim:Document
  TimeSchedule:
    description: Description of anything that changes through time. Time schedule is used to perform a single-valued function of time. Use inherited 'type' attribute to give additional information on this schedule, such as periodic (hourly, daily, weekly, monthly, etc.), day of the month, by date, calendar (specific times and dates).
    from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61968.Common
    is_a: Document
    attributes:
      schedule_interval:
        description: Schedule date and time interval.
        slot_uri: cim:TimeSchedule.scheduleInterval
        range: DateTimeInterval
        required: true
    class_uri: cim:TimeSchedule
  DateTimeInterval:
    description: Interval between two date and time points, where the interval includes the start time but excludes end time.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Domain
    attributes:
      end:
        description: End date and time of this interval. The end date and time where the interval is defined up to, but excluded. Follows the international date format of YYYY-MM-DD, i.e. 2024-12-31. When only a specific month is known, use *01* as day. This is the *Beoogde in bedrijfsname* in the previous implementation.
        slot_uri: cim:DateTimeInterval.end
        range: date
        required: false
      start:
        description: Start date and time of this interval. The start date and time is included in the defined interval. Follows the international date format of YYYY-MM-DD, i.e. 2024-12-31. When only a specific month is known, use *01* as day. This is the *Startdatum* in the previous implementation.
        slot_uri: cim:DateTimeInterval.start
        range: date
        required: false
      quarter:
        description: Quarter indicator for when this Work is completed. Use in combination with this:DateTimeInterval.year.
        slot_uri: this:DateTimeInterval.quarter
        range: integer
        minimum_value: 1
        maximum_value: 4
        required: false
      year:
        description: Year indicator for when this Work is completed. Use in combination with this:DateTimeInterval.quarter.
        slot_uri: this:DateTimeInterval.year
        range: integer
        required: false
    class_uri: cim:DateTimeInterval
  UpdateInfo:
    description: Specific type of information that was updated for this dataset.
    attributes:
      date:
        description: Date of the update.
        slot_uri: cim:UpdateInfo.date
        range: date
        required: true
      type:
        description: Type of the update.
        slot_uri: this:UpdateInfo.type
        range: UpdateInfoKind
        required: true
    class_uri: this:UpdateInfo
  IdentifiedObject:
    description: This is a root class to provide common identification for all classes needing identification and naming attributes.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
    attributes:
      description:
        description: The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy. This is the *Herkenbare naam voedingsgebied* in the previous implementation.
        slot_uri: cim:IdentifiedObject.description
        range: string
      m_rid:
        description: Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended. For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.
        slot_uri: cim:IdentifiedObject.mRID
        range: string
      names:
        description: All names of this identified object.
        slot_uri: cim:IdentifiedObject.Names
        multivalued: true
        range: Name
    class_uri: cim:IdentifiedObject
  Name:
    description: The Name class provides the means to define any number of human readable names for an object. A name is <b>not</b> to be used for defining inter-object relationships. For inter-object relationships instead use the object identification 'mRID'
    from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
    attributes:
      name:
        slot_uri: cim:Name.name
        range: string
        required: false
        multivalued: false
        description: "Any free text that name the object.\r\n"
      name_type:
        description: Type of this name.
        slot_uri: cim:Name.NameType
        range: NameType
        required: true
    class_uri: cim:Name
  NameType:
    description: Type of name. Possible values for attribute 'name' are implementation dependent but standard profiles may specify types. An enterprise may have multiple IT systems each having its own local name for the same object, e.g.  a planning system may have different names from an EMS. An object may also have different names within the same IT system, e.g. localName as defined in CIM version 14. The definition from CIM14 is The localName is a human readable name of the object. It is a free text name local to a node in a naming hierarchy similar to a file directory structure. A power system related naming hierarchy may be Substation, VoltageLevel, Equipment etc. Children of the same parent in such a hierarchy have names that typically are unique among them.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
    attributes:
      description:
        description: Description of the name type.
        slot_uri: cim:NameType.description
      name_type_authority:
        description: Authority responsible for managing names of this type.
        slot_uri: cim:NameType.NameTypeAuthority
        range: NameTypeAuthority
    class_uri: cim:NameType
  NameTypeAuthority:
    description: Authority responsible for creation and management of names of a given type; typically an organization or an enterprise system.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM.IEC61970.Base.Core
    attributes:
      description:
        description: Description of the name type authority.
        slot_uri: cim:NameTypeAuthority.description
        range: string
    class_uri: cim:NameTypeAuthority
version: "1.0"
generation_date: "2026-04-10"
