Data Model Libraries
    Preparing search index...

    Class ExampleScenarioProcessStepAlternativeComponent

    ExampleScenarioProcessStepAlternativeComponent Class

    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.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    title: null | StringType

    ExampleScenario.process.step.alternative.title Element

    FHIR Specification

    • Short: Label for alternative
    • Definition: The label to display for the alternative that gives a sense of the circumstance in which the alternative should be invoked.
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    description?: MarkdownType

    ExampleScenario.process.step.alternative.description Element

    FHIR Specification

    • Short: A human-readable description of each option
    • Definition: A human-readable description of the alternative explaining when the alternative should occur rather than the base step.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    ExampleScenario.process.step.alternative.step Element

    FHIR Specification

    • Short: What happens in each alternative option
    • Definition: What happens in each alternative option.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ExampleScenarioProcessStepAlternativeComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ExampleScenarioProcessStepAlternativeComponent

      ExampleScenarioProcessStepAlternativeComponent data model or undefined for ExampleScenarioProcessStepAlternativeComponent

      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 the instance is a FHIR complex or primitive datatype; false otherwise