Document

Note

This data class is at a trial use maturity level and may change in future releases. Maturity levels are described in the maturity-model.

Computational Definition

A collection of information, usually in a text-based or graphic human-readable form, intended to be read and understood together as a whole.

Information Model

Some Document attributes are inherited from Entity.

Field

Flags

Type

Limits

Description

id

string

0..1

The ‘logical’ identifier of the Entity in the system of record, e.g. a UUID. This ‘id’ is unique within a given system, but may or may not be globally unique outside the system. It is used within a system to reference an object from another.

name

string

0..1

A primary name for the entity.

description

string

0..1

A free-text description of the Entity.

aliases

string

0..m

Alternative name(s) for the Entity.

extensions

Extension

0..m

A list of extensions to the Entity, that allow for capture of information not directly supported by elements defined in the model.

type

string

1..1

Must be “Document”

documentType

D

string

0..1

A specific type of document that a Document instance represents (e.g. ‘publication’, ‘patent’, ‘pathology report’)

title

string

0..1

The official title given to the document by its authors.

urls

string

0..m

One or more URLs from which the content of the Document can be retrieved.

doi

string

0..1

A Digital Object Identifier for the document.

pmid

string

0..1

A PubMed unique identifier for the document.