Specification reference

FormalParameter

View this specification's source

A prospective parameter slot in a recipe. Parameter-value annotations can refer to this definition through instanceOf.

#Properties

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.
typeText1MUSTFormalParameter
additionalTypesText0..*MAYAdditional classifications or specializations of the parameter slot.
nameText0..1SHOULDHuman-readable name of the parameter slot
nameTANURL0..1SHOULDURL of the ontology term used for the parameter's key. TAN stands for term accession number.
defaultValueAnnotation0..1MAYDefault value for the parameter, represented as an annotation with an optional unit and ontology term references

#Relationships

Diagram source
flowchart TD

    additionalTypes@{ shape: stadium, label: "string" }

    na@{ shape: stadium, label: "string" }
    nt@{ shape: stadium, label: "URL" }

    Recipe --parameters--> FormalParameter
    Annotation --instanceOf--> FormalParameter
    FormalParameter --name--> na
    FormalParameter --additionalTypes--> additionalTypes
    FormalParameter --nameTAN--> nt
    FormalParameter --defaultValue--> Annotation