Indivo Document

From OpenIndivo Documentation Wiki

Contents 1 Schema 2 Detailed Schema Description 2.1 IndivoDocumentType 2.2 DocumentVersionType 2.3 DocumentHeaderType 2.4 DocumentClassificationType 2.5 VersionHeaderType 2.6 VersionBodyType 2.7 ContentDescriptionType 2.8 FilteredDocumentType

Schema

• Syntax-Highlighted Schema
• Raw Schema

Detailed Schema Description

IndivoDocumentType

The main element defined in the document schema.

DocumentHeader

DocumentHeaderType (required)

The document's header.

DocumentVersion

DocumentVersionType (required, multiple)

The document's list of versions.

DocumentVersionType

A single version of a document.

VersionHeader

VersionHeaderType (required)

The versions's header.

VersionBody

VersionBodyType (required)

The versions's body contains the payload.

DocumentHeaderType

The header of the document. Contains meta-data describing the payload.

CreationDateTime

dateTime (optional)

The date and time that the document was added to the Indivo Record.

LastModifiedDateTime

dateTime (optional)

The date and time that the document was last updated within the Indivo Record. If the document has only one version, this will be the same as the CreationDateTime.

Author

AuthorType (required)

The original author (creator) of the document.

DocumentIndex

string (optional)

The index of the document. Indices are typically UUIDs.

DocumentClassification

DocumentClassificationType (optional)

The document's classification (how the document is grouped with other documents) within the record.

ContentDescription

ContentDescriptionType (optional)

Describes the payload of the document and how to process it.

Active

boolean (optional)

Indicates if the document is active or inactive. If true, the document is active. Inactive documents may be marked as such if they are out of date, invalid, or the record holder wishes to the suppress the information within them. By default, the reference user interface will not display inactive documents.

DocumentClassificationType

Element for encapsulating the classification URN of the document.

Classification

anyURI (required)

URN that signifies how a document is classified (grouped within a record).

» See Document Classification URNs for URNs that are currently in use.

VersionHeaderType

Meta-data for a version.

Classification

dateTime (optional)

The date and time that the document was modified with this version.

VersionAuthor

AuthorType (required)

The author of the version.

VersionBodyType

The Version Body is an XML "any" element whose contents will be skipped during validation. This means that any well-formatted XML can be placed here. We often refer to this "any" element as the payload.

ContentDescriptionType

Describes the content of the payload and how to process it.

SchemaLocation

anyURI (optional)

URL for the schema that defines the XML in the VersionBody.

ContentType

QName (required)

QName for the element in the VersionBody.

Description

string (required)

Text-based description of the element in the VersionBody. This SHOULD be a meaningful summary of the payload contents.

FilteredDocumentType

This feature of Indivo is tested and supported but not currently in use. Primarily for use with genomic data.

This section is not yet complete.