ComplianceDocument

Type: object

A digitised form of a document containing construction industry, regulations, requirements, standards and guidance. A compliance document contains both human readable text, figures/tables and machine-readable structure and logic to enable automated compliance checking.

root dcterms:title
Type: string

The title of the Compliance Document

root ckterms:projectStage
Type: array of enum (of string)

The stage of the project life cycle the compliance document is relevant to. Values selected from the RIBA 2020 / CIC Plan of Work. Value should be One of more from the CIC Plan of Work: of i.e. CIC3: Concept design

Each item of this array must be:

root ckterms:projectStage ckterms:projectStage items
Type: enum (of string)

Must be one of:

  • "0: Strategic definition"
  • "1: Preparation and briefing"
  • "2: Concept design"
  • "3: Spatial coordination"
  • "4: Technical design"
  • "5: Manufacturing and construction"
  • "6: Handover"
  • "C7: Use"

root dcterms:subject
Type: array of string

The building types in scope of the document. Values selected from Uniclass 2015 Entities Tables. One or more of i.e. Primary schools Hospital complexes

Each item of this array must be:

root dcterms:subject dcterms:subject items
Type: string

root dcterms:coverage.temporal
Type: array of date-time

The time period the document is applicable to. ISO Date/Time i.e. 2020-12-25T19:20:30

Each item of this array must be:

root dcterms:coverage.temporal dcterms:coverage.temporal items
Type: date-time

root dcterms:coverage.spatial
Type: array of string

The geographical area the document is relevant to. Specified using terms from ISO 3166-2. One or more of i.e. GB-ENG GB-WLS GB-TWH

Each item of this array must be:

root dcterms:coverage.spatial dcterms:coverage.spatial items
Type: string

root dcterms:dateCreated
Type: date-time

The date the document was created. ISO Date/Time

root dcterms:modified
Type: date-time

The date the document was modified. ISO Date/Time

root dcterms:accessRights
Type: array of enum (of string)

Information about who can access the document or any indication of its security status. Must use one of the following: Open Access Registration Required Subscription Required Membership Required Purchase Required Limited Access Internal. Ordinarily all construction regulations will be open access.

Each item of this array must be:

root dcterms:accessRights dcterms:accessRights items
Type: enum (of string)

Must be one of:

  • "Open Access"
  • "Registration Required"
  • "Subscription Required"
  • "Membership Required"
  • "Purchase Required"
  • "Limited Access"
  • "Internal"

root dcterms:format
Type: string

The format of the document.

root ckterms:accessLocation
Type: string

The URL at which to access this element of the document.

root dcterms:identifier
Type: string

An unambiguous reference to the document (or its subcomponent) within a given context.

root dcterms:language
Type: string

The language of the document. One value from ISO 639.

root dcterms:relation
Type: array of string

A related resource that is a dependency to this document.

Each item of this array must be:

root dcterms:relation dcterms:relation items
Type: string

root ckterms:version
Type: string

The version number for the specific version of the document. i.e. 1.01

root dcterms:replaces
Type: string

A related document that is supplanted, displaced, or superseded by the document. The URL of the document being replaced.

root dcterms:isReplacedBy
Type: string

A related document that supersedes the described document. The URL of the document this was replaced by.

root dcterms:rights
Type: string

Information about rights held in and over the document. The name of the license that applies to the document or a copyright notice.

root dcterms:publisher
Type: string

The person or organisation responsible for making the document.

root dcterms:description
Type: string

Ann abstract or summary of the contents of the document.

root ckterms:sector
Type: array of string

The market sector(s) the document specified by one of the top-level group terms of Uniclass 2015 Entites table .i.e. Residential complexes Waste disposal complexes Piped supply complexes

Each item of this array must be:

root ckterms:sector ckterms:sector items
Type: string

root dcom:startSectionNumber
Type: number

The starting value to be used in numbering of sections. Default is 1.

root dcom:startParagraphNumber
Type: number

The starting value to be used in numbering of paragraphs. Default is 1.

root dcterms:type
Type: enum (of string)

The type of the document. One or more values from Policy, Legislation, Regulations, Guidance, Standards, Products, Testing/Simulating, Certificates of Conformity, Requirements, Specification

Must be one of:

  • "Policy"
  • "Legislation"
  • "Regulations"
  • "Guidance"
  • "Standards"
  • "Products"
  • "Testing/Simulating"
  • "Certificates of Conformity"
  • "Requirements"
  • "Specification"

root sections
Type: array

The top level sections that make up the document

Each item of this array must be:

root sections Section
Type: object

root sections sections items numbered
Type: enum (of string)

If the section should be numbered

Must be one of:

  • "None"
  • "Global"

root sections sections items numberedstyle
Type: enum (of string)

The style of the numbering - default numeric

Must be one of:

  • "A"
  • "a"
  • "i"
  • "I"
  • "1"

root sections sections items ckterms:accessLocation
Type: string

The URL at which to access this element of the document.

root sections sections items dcterms:title
Type: string

The title of the Section

root sections sections items dcterms:identifier
Type: string

An unambiguous reference to the section within a given context.

root sections sections items dcterms:relation
Type: array of string

A related resource that is a dependency of this section.

Each item of this array must be:

root sections sections items dcterms:relation dcterms:relation items
Type: string

root sections sections items dcterms:replaces
Type: string

The section that is supplanted, displaced, or superseded by this section. The URL of the section being replaced.

root sections sections items dcterms:isReplacedBy
Type: string

The section that supersedes this section. The URL the section this was replaced by.

root sections sections items sections
Type: array

The sub sections that make up the section

Each item of this array must be:

root sections sections items sections Section
Type: object
Same definition as sections_items

root sections sections items paragraphs
Type: array

The paragraphs that make up the section

Each item of this array must be:

root sections sections items paragraphs Paragraph
Type: object

root sections sections items paragraphs paragraphs items numbered
Type: enum (of string)

If the paragraph should be numbered

Must be one of:

  • "None"
  • "Global"

root sections sections items paragraphs paragraphs items numberedstyle
Type: enum (of string)

The style of the numbering - default numeric

Must be one of:

  • "A"
  • "a"
  • "i"
  • "I"
  • "1"

root sections sections items paragraphs paragraphs items paragraphs
Type: array

The sub-paragraphs that make up this paragraph

Each item of this array must be:

root sections sections items paragraphs paragraphs items paragraphs Paragraph
Type: object
Same definition as sections_items_paragraphs_items

root sections sections items paragraphs paragraphs items ckterms:accessLocation
Type: string

The URL at which to access this element of the document.

root sections sections items paragraphs paragraphs items dcterms:identifier
Type: string

An unambiguous reference to the document (or its subcomponent) within a given context.

root sections sections items paragraphs paragraphs items dcterms:relation
Type: array of string

A related resource that is a dependency of this paragraph.

Each item of this array must be:

root sections sections items paragraphs paragraphs items dcterms:relation dcterms:relation items
Type: string

root sections sections items paragraphs paragraphs items dcterms:replaces
Type: string

The paragraph that is supplanted, displaced, or superseded by this paragraph. The URL of the paragraph being replaced.

root sections sections items paragraphs paragraphs items dcterms:isReplacedBy
Type: string

The paragraph that supersedes this paragraph. The URL of the paragraph this was replaced by.

root sections sections items paragraphs paragraphs items body
Type: string

The body text for this paragraph.

root sections sections items paragraphs paragraphs items inserts
Type: array

The inserts used in this paragraph

Each item of this array must be:

root sections sections items paragraphs paragraphs items inserts inserts items

root sections sections items paragraphs paragraphs items inserts inserts items oneOf Table
Type: object

root sections sections items paragraphs paragraphs items inserts inserts items oneOf item 0 header
Type: object

root sections sections items paragraphs paragraphs items inserts inserts items oneOf item 0 header rows
Type: array of object

The rows in the table group

Each item of this array must be:

root sections sections items paragraphs paragraphs items inserts inserts items oneOf item 0 header rows rows items
Type: object

root sections sections items paragraphs paragraphs items inserts inserts items oneOf item 0 header rows rows items cells
Type: array of object

The Cells in this Row

Each item of this array must be:

root sections sections items paragraphs paragraphs items inserts inserts items oneOf item 0 header rows rows items cells cells items
Type: object

root sections sections items paragraphs paragraphs items inserts inserts items oneOf item 0 header rows rows items cells cells items cellType
Type: enum (of string)

The type of this cell

Must be one of:

  • "TitleCell"
  • "DataCell"

root sections sections items paragraphs paragraphs items inserts inserts items oneOf item 0 body
Type: object
Same definition as header
root sections sections items paragraphs paragraphs items inserts inserts items oneOf Figure
Type: object

root sections sections items paragraphs paragraphs items inserts inserts items oneOf item 1 alternativeText
Type: string

The alternative text for this figure

root sections sections items paragraphs paragraphs items inserts inserts items oneOf item 1 imageData
Type: string

The imageData encoding as a data URL