Data Model Libraries
    Preparing search index...

    Class ExampleScenarioProcessStepOperationComponent

    ExampleScenarioProcessStepOperationComponent Class

    FHIR Specification

    • Short: Step is simple action
    • Definition: The step represents a single operation invoked on receiver by sender.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    type_?: Coding

    ExampleScenario.process.step.operation.type Element

    FHIR Specification

    • Short: Kind of action
    • Definition: The standardized type of action (FHIR or otherwise).
    • FHIR Type: Coding
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    title: null | StringType

    ExampleScenario.process.step.operation.title Element

    FHIR Specification

    • Short: Label for step
    • Definition: A short descriptive label the step to be used in tables or diagrams.
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    initiator?: StringType

    ExampleScenario.process.step.operation.initiator Element

    FHIR Specification

    • Short: Who starts the operation
    • Definition: The system that invokes the action/transmits the data.
    • Comment: This must either be the 'key' of one of the actors defined in this scenario or the special keyword 'OTHER' if the initiator is not one of the actors defined for the scenario. (Multiple references to 'OTHER' don't necessarily indicate the same actor.)
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    receiver?: StringType

    ExampleScenario.process.step.operation.receiver Element

    FHIR Specification

    • Short: Who receives the operation
    • Definition: The system on which the action is invoked/receives the data.
    • Comment: This must either be the 'key' of one of the actors defined in this scenario or the special keyword 'OTHER' if the receiver is not one of the actors defined for the scenario. (Multiple references to 'OTHER' don't necessarily indicate the same actor.) In some cases, receiver could be same as sender if representing a local operation
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    description?: MarkdownType

    ExampleScenario.process.step.operation.description Element

    FHIR Specification

    • Short: Human-friendly description of the operation
    • Definition: An explanation of what the operation represents and what it does.
    • Comment: This should contain information not already present in the process step. It's more of a description of what the operation in general does - if not already evident from the operation.type
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    initiatorActive?: BooleanType

    ExampleScenario.process.step.operation.initiatorActive Element

    FHIR Specification

    • Short: Initiator stays active?
    • Definition: If false, the initiator is deactivated right after the operation.
    • Comment: De-activation of an actor means they have no further role until such time as they are the recipient of an operation.
    • Requirements: The notion of 'activation' in a flow diagram is used to indicate 'who has responsibility/is still doing work'.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    receiverActive?: BooleanType

    ExampleScenario.process.step.operation.receiverActive Element

    FHIR Specification

    • Short: Receiver stays active?
    • Definition: If false, the receiver is deactivated right after the operation.
    • Comment: De-activation of an actor means they have no further role until such time as they are the recipient of an operation.
    • Requirements: The notion of 'activation' in a flow diagram is used to indicate 'who has responsibility/is still doing work'.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    ExampleScenario.process.step.operation.request Element

    FHIR Specification

    • Short: Instance transmitted on invocation
    • Definition: A reference to the instance that is transmitted from requester to receiver as part of the invocation of the operation.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    ExampleScenario.process.step.operation.response Element

    FHIR Specification

    • Short: Instance transmitted on invocation response
    • Definition: A reference to the instance that is transmitted from receiver to requester as part of the operation's synchronous response (if any).
    • 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