Document Type and DocumentDefinition

latest update 2023-04-13  


This topic explains the relation between an instance of ClassOfInformationObject ("document type") and an instance of DocumentDefinition


The applicable Part 2 definitions are:

Unfortunately there is no direct relationship between the two. Instead this link is indirect: A ClassOfInformationObject is a subClassOf a ClassOfInformationRepresentation, which is classified with a DocumentDefinition

For example:

A typical example of DocumentDefinition is the definition of the API 610 Data Sheet for Centrifugal Pumps.

We can use the template DefinitionOfDocumentByContentsType to make that link:

Code Example

For the case of the Line List to XYZ Corp. standard the following code could apply, reflecting the use of above template:

    rdf:type tpl:DefinitionOfDocumentByContentsType ;
    tpl:hasDocument rdl:RDS2228081 ; # POWER SYSTEM ANALYSIS DATASHEET (can also be a UUID of an actual datasheet) - See note below
    tpl:hasContentsType cfihos:71000281 ; # a (yet) fake CFIHOS ID for the applicable instance of DocumentDefinition, 
		made by CFIHOS representing their rules
    meta:valEffectiveDate "2019-04-01T17:23:00Z"^^xsd:dateTime .

where cfihos:71000281 is an instance of dm:DocumentDefinition

Particular requirements in a local RDL extension

In case a company or an organization wants to define what they want the contents of a particular document type to be, they can do that by defining an instance of DocumentDefinition and store that in their own local RDL extension. It is possible to combine the RDL with one or more RDL extensions by "federating" them. The result is that it seems one RDL. Federation is possible for any project or other exercise.

NOTE - All templates about representing information have an instance of, mostly user-defined, DocumentDefinition in one of its Roles.
In case you are not interested in defining it, use rdl:RDS2227659 - UNDEFINED DEFINITION OF DOCUMENT. Later you can change that, if so required.