Data Model Libraries
    Preparing search index...

    Class ExampleScenarioProcessStepComponent

    ExampleScenarioProcessStepComponent Class

    FHIR Specification

    • Short: Each step of the process
    • Definition: Each step of the process.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    ExampleScenario.process.step.process Element

    FHIR Specification

    • Short: Nested process
    • Definition: Nested process.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    pause?: BooleanType

    ExampleScenario.process.step.pause Element

    FHIR Specification

    • Short: If there is a pause in the flow
    • Definition: If there is a pause in the flow.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    ExampleScenario.process.step.operation Element

    FHIR Specification

    • Short: Each interaction or action
    • Definition: Each interaction or action.
    • 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 operations on the base step in exceptional/atypical circumstances.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • 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