Specification reference

Recipe

View this specification's source

Description of a planned procedure. Recipes define what a Process executes, including intended use, equipment, reagents, and software.

#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.
typeText1MUSTRecipe
additionalTypesText0..*MAYDiscriminator for decoration types.
nameText0..1SHOULDHuman-readable title of the recipe
parametersFormalParameter0..*MAYProspective parameter slots for values supplied when executing the recipe
descriptionText0..1SHOULDShort description or abstract of the planned procedure
intendedUseDefinedTerm, Text0..1SHOULDRecipe classification, expressed as a controlled vocabulary term or plain text
additionalPropertiesAnnotation0..*MAYExtensible recipe metadata not covered by the Abstract Model properties
componentsAnnotation0..*MAYAnnotations describing equipment, software, reagents, materials, or other components used in the recipe
versionText0..1MAYVersion identifier of the recipe
urlURL0..1MAYURL of an external resource describing the recipe

#Relationships

Diagram source
flowchart TD

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

    na@{ shape: stadium, label: "string" }
    de@{ shape: stadium, label: "string" }
    ve@{ shape: stadium, label: "string" }
    ur@{ shape: stadium, label: "URL" }
    av[Annotation]
    co[Annotation]
    iu["DefinedTerm or Text"]

    Process --executesRecipe--> Recipe
    Recipe --intendedUse--> iu
    Recipe --additionalTypes--> additionalTypes
    Recipe --additionalProperties--> av
    Recipe --components--> co
    Recipe --parameters--> FormalParameter
    Recipe --name--> na
    Recipe --description--> de
    Recipe --version--> ve
    Recipe --url--> ur