Data Model Libraries
    Preparing search index...

    RequestGroupActionComponent 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 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 getCondition setCondition addCondition hasCondition getRelatedAction setRelatedAction addRelatedAction hasRelatedAction getTiming setTiming hasTiming getTimingDateTimeType hasTimingDateTimeType getTimingAge hasTimingAge getTimingPeriod hasTimingPeriod getTimingDuration hasTimingDuration getTimingRange hasTimingRange getTimingTiming hasTimingTiming 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 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 initCondition initRelatedAction initParticipant initAction

    Constructors

    Properties

    prefix?: StringType

    RequestGroup.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.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    title?: StringType

    RequestGroup.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?: StringType

    RequestGroup.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: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    textEquivalent?: StringType

    RequestGroup.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: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    requestPriorityEnum: RequestPriorityEnum

    FHIR CodeSystem: RequestPriority

    priority?: EnumCodeType

    RequestGroup.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

    RequestGroup.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[]

    RequestGroup.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

    RequestGroup.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

    RequestGroup.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

    RequestGroup.action.timing[x] Element

    @ChoiceDataTypesMeta('RequestGroup.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.
    • FHIR Types: 'dateTime', 'Age', 'Period', 'Duration', 'Range', 'Timing',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    participant?: Reference[]

    RequestGroup.action.participant Element

    FHIR Specification

    RequestGroup.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

    RequestGroup.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

    RequestGroup.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

    RequestGroup.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

    RequestGroup.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

    RequestGroup.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

    RequestGroup.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

    RequestGroup.action.action Element

    FHIR Specification

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

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR RequestGroupActionComponent

      • OptionaloptSourceField: string

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

      Returns undefined | RequestGroupActionComponent

      RequestGroupActionComponent data model or undefined for RequestGroupActionComponent

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Reference array value to the participant property.

      Parameters

      • value: undefined | Reference[]

        the participant array value

      Returns this

      this

      @ReferenceTargets('RequestGroup.action.participant', ['Patient','Practitioner','PractitionerRole','RelatedPerson','Device',])

      InvalidTypeError for invalid data type or reference value

    • Add the provided Reference value to the participant array property.

      Parameters

      • value: undefined | Reference

        the participant value

      Returns this

      this

      @ReferenceTargets('RequestGroup.action.participant', ['Patient','Practitioner','PractitionerRole','RelatedPerson','Device',])

      InvalidTypeError for invalid data type or reference value

    • 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