Data Model Libraries
    Preparing search index...

    Class RequestOrchestrationActionComponent

    RequestOrchestrationActionComponent Class

    FHIR Specification

    • Short: Proposed actions, if any
    • Definition: The actions, if any, produced by the evaluation of the artifact.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Methods

    parse getLinkIdElement setLinkIdElement hasLinkIdElement getLinkId setLinkId hasLinkId getPrefixElement setPrefixElement hasPrefixElement getPrefix setPrefix hasPrefix getTitleElement setTitleElement hasTitleElement getTitle setTitle hasTitle getDescriptionElement setDescriptionElement hasDescriptionElement getDescription setDescription hasDescription getTextEquivalentElement setTextEquivalentElement hasTextEquivalentElement getTextEquivalent setTextEquivalent hasTextEquivalent getPriorityEnumType setPriorityEnumType hasPriorityEnumType getPriorityElement setPriorityElement hasPriorityElement getPriority setPriority hasPriority getCode setCode addCode hasCode getDocumentation setDocumentation addDocumentation hasDocumentation getGoal setGoal addGoal hasGoal getCondition setCondition addCondition hasCondition getInput setInput addInput hasInput getOutput setOutput addOutput hasOutput getRelatedAction setRelatedAction addRelatedAction hasRelatedAction getTiming setTiming hasTiming getTimingDateTimeType hasTimingDateTimeType getTimingAge hasTimingAge getTimingPeriod hasTimingPeriod getTimingDuration hasTimingDuration getTimingRange hasTimingRange getTimingTiming hasTimingTiming getLocation setLocation hasLocation getParticipant setParticipant addParticipant hasParticipant getType setType hasType getGroupingBehaviorEnumType setGroupingBehaviorEnumType hasGroupingBehaviorEnumType getGroupingBehaviorElement setGroupingBehaviorElement hasGroupingBehaviorElement getGroupingBehavior setGroupingBehavior hasGroupingBehavior getSelectionBehaviorEnumType setSelectionBehaviorEnumType hasSelectionBehaviorEnumType getSelectionBehaviorElement setSelectionBehaviorElement hasSelectionBehaviorElement getSelectionBehavior setSelectionBehavior hasSelectionBehavior getRequiredBehaviorEnumType setRequiredBehaviorEnumType hasRequiredBehaviorEnumType getRequiredBehaviorElement setRequiredBehaviorElement hasRequiredBehaviorElement getRequiredBehavior setRequiredBehavior hasRequiredBehavior getPrecheckBehaviorEnumType setPrecheckBehaviorEnumType hasPrecheckBehaviorEnumType getPrecheckBehaviorElement setPrecheckBehaviorElement hasPrecheckBehaviorElement getPrecheckBehavior setPrecheckBehavior hasPrecheckBehavior getCardinalityBehaviorEnumType setCardinalityBehaviorEnumType hasCardinalityBehaviorEnumType getCardinalityBehaviorElement setCardinalityBehaviorElement hasCardinalityBehaviorElement getCardinalityBehavior setCardinalityBehavior hasCardinalityBehavior getResource setResource hasResource getDefinition setDefinition hasDefinition getDefinitionCanonicalType hasDefinitionCanonicalType getDefinitionUriType hasDefinitionUriType getTransformElement setTransformElement hasTransformElement getTransform setTransform hasTransform getDynamicValue setDynamicValue addDynamicValue hasDynamicValue getAction setAction addAction hasAction fhirType isEmpty copy toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isRequiredFieldsEmpty isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initCode initDocumentation initGoal initCondition initInput initOutput initRelatedAction initParticipant initDynamicValue initAction

    Constructors

    Properties

    linkId?: StringType

    RequestOrchestration.action.linkId Element

    FHIR Specification

    • Short: Pointer to specific item from the PlanDefinition
    • Definition: The linkId of the action from the PlanDefinition that corresponds to this action in the RequestOrchestration resource.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    prefix?: StringType

    RequestOrchestration.action.prefix Element

    FHIR Specification

    • Short: User-visible prefix for the action (e.g. 1. or A.)
    • Definition: A user-visible prefix for the action. For example a section or item numbering such as 1. or A.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    title?: StringType

    RequestOrchestration.action.title Element

    FHIR Specification

    • Short: User-visible title
    • Definition: The title of the action displayed to a user.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    description?: MarkdownType

    RequestOrchestration.action.description Element

    FHIR Specification

    • Short: Short description of the action
    • Definition: A short description of the action used to provide a summary to display to the user.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    textEquivalent?: MarkdownType

    RequestOrchestration.action.textEquivalent Element

    FHIR Specification

    • Short: Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
    • Definition: A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    requestPriorityEnum: RequestPriorityEnum

    FHIR CodeSystem: RequestPriority

    priority?: EnumCodeType

    RequestOrchestration.action.priority Element

    FHIR Specification

    • Short: routine | urgent | asap | stat
    • Definition: Indicates how quickly the action should be addressed with respect to other actions.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: RequestPriorityEnum

    RequestOrchestration.action.code Element

    FHIR Specification

    • Short: Code representing the meaning of the action or sub-actions
    • Definition: A code that provides meaning for the action or action group. For example, a section may have a LOINC code for a section of a documentation template.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    documentation?: RelatedArtifact[]

    RequestOrchestration.action.documentation Element

    FHIR Specification

    • Short: Supporting documentation for the intended performer of the action
    • Definition: Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.
    • FHIR Type: RelatedArtifact
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    goal?: Reference[]

    RequestOrchestration.action.goal Element

    FHIR Specification

    • Short: What goals
    • Definition: Goals that are intended to be achieved by following the requests in this action.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    RequestOrchestration.action.condition Element

    FHIR Specification

    • Short: Whether or not the action is applicable
    • Definition: An expression that describes applicability criteria, or start/stop conditions for the action.
    • Comment: When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all of the conditions are true.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    RequestOrchestration.action.input Element

    FHIR Specification

    • Short: Input data requirements
    • Definition: Defines input data requirements for the action.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    RequestOrchestration.action.output Element

    FHIR Specification

    • Short: Output data definition
    • Definition: Defines the outputs of the action, if any.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    RequestOrchestration.action.relatedAction Element

    FHIR Specification

    • Short: Relationship to another action
    • Definition: A relationship to another action such as "before" or "30-60 minutes after start of".
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    timing?: IDataType

    RequestOrchestration.action.timing[x] Element

    @ChoiceDataTypesMeta('RequestOrchestration.action.timing[x]', ['dateTime','Age','Period','Duration','Range','Timing',]

    FHIR Specification

    • Short: When the action should take place
    • Definition: An optional value describing when the action should be performed.
    • Comment: The intent of the timing element is to provide timing for when the action should be performed. The timing may be absolute (specified as a dateTime or Period) or relative (specified as an Age, Duration, or Range), or it may be a more complex, potentially repeating timing specified using Timing.
    • Requirements: Allows prompting for activities and detection of missed planned activities.
    • FHIR Types: 'dateTime', 'Age', 'Period', 'Duration', 'Range', 'Timing',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    RequestOrchestration.action.location Element

    FHIR Specification

    • Short: Where it should happen
    • Definition: Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etc.
    • Comment: May reference a specific clinical location or may just identify a type of location.
    • Requirements: Helps in planning of activity.
    • FHIR Type: CodeableReference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    RequestOrchestration.action.participant Element

    FHIR Specification

    • Short: Who should perform the action
    • Definition: The participant that should perform or be responsible for this action.
    • Comment: Because request orchestrations represent potential options for performing activities, some specific participants may still be unknown, so this element allows for both definitional participants (in the same way they are specified in ActivityDefinition and PlanDefinition resources) as well as identifying specific participants when they are known.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    RequestOrchestration.action.type Element

    FHIR Specification

    • Short: create | update | remove | fire-event
    • Definition: The type of action to perform (create, update, remove).
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    actionGroupingBehaviorEnum: ActionGroupingBehaviorEnum

    FHIR CodeSystem: ActionGroupingBehavior

    groupingBehavior?: EnumCodeType

    RequestOrchestration.action.groupingBehavior Element

    FHIR Specification

    • Short: visual-group | logical-group | sentence-group
    • Definition: Defines the grouping behavior for the action and its children.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: ActionGroupingBehaviorEnum

    actionSelectionBehaviorEnum: ActionSelectionBehaviorEnum

    FHIR CodeSystem: ActionSelectionBehavior

    selectionBehavior?: EnumCodeType

    RequestOrchestration.action.selectionBehavior Element

    FHIR Specification

    • Short: any | all | all-or-none | exactly-one | at-most-one | one-or-more
    • Definition: Defines the selection behavior for the action and its children.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: ActionSelectionBehaviorEnum

    actionRequiredBehaviorEnum: ActionRequiredBehaviorEnum

    FHIR CodeSystem: ActionRequiredBehavior

    requiredBehavior?: EnumCodeType

    RequestOrchestration.action.requiredBehavior Element

    FHIR Specification

    • Short: must | could | must-unless-documented
    • Definition: Defines expectations around whether an action is required.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: ActionRequiredBehaviorEnum

    actionPrecheckBehaviorEnum: ActionPrecheckBehaviorEnum

    FHIR CodeSystem: ActionPrecheckBehavior

    precheckBehavior?: EnumCodeType

    RequestOrchestration.action.precheckBehavior Element

    FHIR Specification

    • Short: yes | no
    • Definition: Defines whether the action should usually be preselected.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: ActionPrecheckBehaviorEnum

    actionCardinalityBehaviorEnum: ActionCardinalityBehaviorEnum

    FHIR CodeSystem: ActionCardinalityBehavior

    cardinalityBehavior?: EnumCodeType

    RequestOrchestration.action.cardinalityBehavior Element

    FHIR Specification

    • Short: single | multiple
    • Definition: Defines whether the action can be selected multiple times.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: ActionCardinalityBehaviorEnum

    resource?: Reference

    RequestOrchestration.action.resource Element

    FHIR Specification

    • Short: The target of the action
    • Definition: The resource that is the target of the action (e.g. CommunicationRequest).
    • Comment: The target resource SHALL be a Request resource with a Request.intent set to "option".
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    definition?: IDataType

    RequestOrchestration.action.definition[x] Element

    @ChoiceDataTypesMeta('RequestOrchestration.action.definition[x]', ['canonical','uri',]

    FHIR Specification

    • Short: Description of the activity to be performed
    • Definition: A reference to an ActivityDefinition that describes the action to be taken in detail, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured.
    • Comment: Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically.
    • FHIR Types: 'canonical', 'uri',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    transform?: CanonicalType

    RequestOrchestration.action.transform Element

    FHIR Specification

    • Short: Transform to apply the template
    • Definition: A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.
    • Comment: Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.
    • FHIR Type: canonical
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    RequestOrchestration.action.dynamicValue Element

    FHIR Specification

    • Short: Dynamic aspects of the definition
    • Definition: Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result.
    • Comment: Dynamic values are applied in the order in which they are defined in the RequestOrchestration resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    RequestOrchestration.action.action Element

    FHIR Specification

    • Short: Sub action
    • Definition: Sub actions.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR RequestOrchestrationActionComponent

      • OptionaloptSourceField: string

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

      Returns undefined | RequestOrchestrationActionComponent

      RequestOrchestrationActionComponent data model or undefined for RequestOrchestrationActionComponent

      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