Specification reference

Annotation

View this specification's source

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.

PropertyTypeCardinalityRequiredDescription
idText0..1MAYOptional identifier within an application-defined scope. Implementations that require an internal identifier SHOULD use this field. The domain model does not automatically assign identifiers.
typeText1MUSTAnnotation
additionalTypesText0..*SHOULDAdditional classifications or specializations of the annotation.
nameText1MUSTHuman-readable name of the annotation's key
valueText, Number0..1SHOULDTextual or numeric value of the annotation
unitText0..1MAYHuman-readable name of the unit associated with the annotation's value
nameTANURL0..1SHOULDURL of the ontology term used for the annotation's key
valueTANURL0..1MAYURL of the ontology term used for the annotation's value
unitTANURL0..1MAYURL of the ontology term used for the annotation's unit
instanceOfFormalParameter0..1MAYLinks a parameter value to its formal parameter definition

#Relationships

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