An annotation is a key, value, unit triple, represented by name, value, and unit. Each of the three can optionally be associated with an ontology term through nameTAN, valueTAN, and unitTAN, respectively. Annotation is shared by all three profiles and carries no required profile discriminator.
Annotations can be attached through additionalProperties for cross-cutting metadata, bundled in a Descriptor through annotations, or used through dedicated relationships such as parameterValues, components, and defaultValue. A parameter-value annotation can optionally link to its formal parameter definition through instanceOf.
#Properties
TAN stands for term accession number. The nameTAN, valueTAN, and unitTAN fields contain the URLs of the ontology terms used for the key, value, and unit. The name and unit fields hold human-readable names.
| Property | Type | Cardinality | Required | Description |
|---|---|---|---|---|
id | Text | 0..1 | MAY | Optional identifier within an application-defined scope. Implementations that require an internal identifier SHOULD use this field. The domain model does not automatically assign identifiers. |
type | Text | 1 | MUST | Annotation |
additionalTypes | Text | 0..* | SHOULD | Additional classifications or specializations of the annotation. |
name | Text | 1 | MUST | Human-readable name of the annotation's key |
value | Text, Number | 0..1 | SHOULD | Textual or numeric value of the annotation |
unit | Text | 0..1 | MAY | Human-readable name of the unit associated with the annotation's value |
nameTAN | URL | 0..1 | SHOULD | URL of the ontology term used for the annotation's key |
valueTAN | URL | 0..1 | MAY | URL of the ontology term used for the annotation's value |
unitTAN | URL | 0..1 | MAY | URL of the ontology term used for the annotation's unit |
instanceOf | FormalParameter | 0..1 | MAY | Links a parameter value to its formal parameter definition |
#Relationships
The diagram could not be displayed. Its source is available below.
Diagram source
flowchart TD
additionalTypes@{ shape: stadium, label: "string" }
na@{ shape: stadium, label: "string" }
va@{ shape: stadium, label: "string or number" }
un@{ shape: stadium, label: "string" }
nt@{ shape: stadium, label: "URL" }
vt@{ shape: stadium, label: "URL" }
ut@{ shape: stadium, label: "URL" }
Dataset --additionalProperties--> Annotation
Agent --additionalProperties--> Annotation
Publication --additionalProperties--> Annotation
Descriptor --annotations--> Annotation
Process --parameterValues--> Annotation
Sample --additionalProperties--> Annotation
Data --additionalProperties--> Annotation
Recipe --additionalProperties--> Annotation
Recipe --components--> Annotation
FormalParameter --defaultValue--> Annotation
Annotation --name--> na
Annotation --additionalTypes--> additionalTypes
Annotation --value--> va
Annotation --unit--> un
Annotation --nameTAN--> nt
Annotation --valueTAN--> vt
Annotation --unitTAN--> ut
Annotation --instanceOf--> FormalParameter