Data Model Libraries
    Preparing search index...

    Class ExampleScenarioProcessStepOperationComponent

    ExampleScenarioProcessStepOperationComponent Class

    FHIR Specification

    • Short: Each interaction or action
    • Definition: Each interaction or action.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    number: null | StringType

    ExampleScenario.process.step.operation.number Element

    FHIR Specification

    • Short: The sequential number of the interaction
    • Definition: The sequential number of the interaction, e.g. 1.2.5.
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    type_?: StringType

    ExampleScenario.process.step.operation.type Element

    FHIR Specification

    • Short: The type of operation - CRUD
    • Definition: The type of operation - CRUD.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    name?: StringType

    FHIR Specification

    • Short: The human-friendly name of the interaction
    • Definition: The human-friendly name of the interaction.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    initiator?: StringType

    ExampleScenario.process.step.operation.initiator Element

    FHIR Specification

    • Short: Who starts the transaction
    • Definition: Who starts the transaction.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    receiver?: StringType

    ExampleScenario.process.step.operation.receiver Element

    FHIR Specification

    • Short: Who receives the transaction
    • Definition: Who receives the transaction.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    description?: MarkdownType

    ExampleScenario.process.step.operation.description Element

    FHIR Specification

    • Short: A comment to be inserted in the diagram
    • Definition: A comment to be inserted in the diagram.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    initiatorActive?: BooleanType

    ExampleScenario.process.step.operation.initiatorActive Element

    FHIR Specification

    • Short: Whether the initiator is deactivated right after the transaction
    • Definition: Whether the initiator is deactivated right after the transaction.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    receiverActive?: BooleanType

    ExampleScenario.process.step.operation.receiverActive Element

    FHIR Specification

    • Short: Whether the receiver is deactivated right after the transaction
    • Definition: Whether the receiver is deactivated right after the transaction.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    ExampleScenario.process.step.operation.request Element

    FHIR Specification

    • Short: Each resource instance used by the initiator
    • Definition: Each resource instance used by the initiator.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    ExampleScenario.process.step.operation.response Element

    FHIR Specification

    • Short: Each resource instance used by the responder
    • Definition: Each resource instance used by the responder.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ExampleScenarioProcessStepOperationComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ExampleScenarioProcessStepOperationComponent

      ExampleScenarioProcessStepOperationComponent data model or undefined for ExampleScenarioProcessStepOperationComponent

      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