Data Model Libraries
    Preparing search index...

    Class ExampleScenarioProcessStepComponent

    ExampleScenarioProcessStepComponent Class

    FHIR Specification

    • Short: Event within of the process
    • Definition: A significant action that occurs as part of the process.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    number?: StringType

    ExampleScenario.process.step.number Element

    FHIR Specification

    • Short: Sequential number of the step
    • Definition: The sequential number of the step, e.g. 1.2.5.
    • Comment: If step numbers are simultaneous, they will be the same. Numbers don't have to be numeric. E.g. '2c)' is a valid step number
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    ExampleScenario.process.step.process Element

    FHIR Specification

    • Short: Step is nested process
    • Definition: Indicates that the step is a complex sub-process with its own steps.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    workflow?: CanonicalType

    ExampleScenario.process.step.workflow Element

    FHIR Specification

    ExampleScenario.process.step.operation Element

    FHIR Specification

    • Short: Step is simple action
    • Definition: The step represents a single operation invoked on receiver by sender.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    ExampleScenario.process.step.alternative Element

    FHIR Specification

    • Short: Alternate non-typical step action
    • Definition: Indicates an alternative step that can be taken instead of the sub-process, scenario or operation. E.g. to represent non-happy-path/exceptional/atypical circumstances.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    pause?: BooleanType

    ExampleScenario.process.step.pause Element

    FHIR Specification

    • Short: Pause in the flow?
    • Definition: If true, indicates that, following this step, there is a pause in the flow and the subsequent step will occur at some later time (triggered by some event).
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided ExampleScenarioProcessStepComponent JSON to instantiate the ExampleScenarioProcessStepComponent data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR ExampleScenarioProcessStepComponent

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to ExampleScenarioProcessStepComponent

      Returns undefined | ExampleScenarioProcessStepComponent

      ExampleScenarioProcessStepComponent data model or undefined for ExampleScenarioProcessStepComponent

      JsonError if the provided JSON is not a valid JSON object

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Returns boolean

      true if and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise