Data Model Libraries
    Preparing search index...

    ExampleScenarioProcessComponent Class

    FHIR Specification

    • Short: Major process within scenario
    • Definition: A group of operations that represents a significant step within a scenario.
    • Comment: Some scenarios might describe only one process.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    title: null | StringType

    ExampleScenario.process.title Element

    FHIR Specification

    • Short: Label for procss
    • Definition: A short descriptive label the process to be used in tables or diagrams.
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    description?: MarkdownType

    ExampleScenario.process.description Element

    FHIR Specification

    • Short: Human-friendly description of the process
    • Definition: An explanation of what the process represents and what it does.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    preConditions?: MarkdownType

    ExampleScenario.process.preConditions Element

    FHIR Specification

    • Short: Status before process starts
    • Definition: Description of the initial state of the actors, environment and data before the process starts.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    postConditions?: MarkdownType

    ExampleScenario.process.postConditions Element

    FHIR Specification

    • Short: Status after successful completion
    • Definition: Description of the final state of the actors, environment and data after the process has been successfully completed.
    • Comment: Alternate steps might not result in all post conditions holding
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    ExampleScenario.process.step Element

    FHIR Specification

    • Short: Event within of the process
    • Definition: A significant action that occurs as part of the process.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ExampleScenarioProcessComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ExampleScenarioProcessComponent

      ExampleScenarioProcessComponent data model or undefined for ExampleScenarioProcessComponent

      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