Data Model Libraries
    Preparing search index...

    PlanDefinitionActionComponent Class

    FHIR Specification

    • Short: Action defined by the plan
    • Definition: An action or group of actions to be taken as part of the plan. For example, in clinical care, an action would be to prescribe a particular indicated medication, or perform a particular test as appropriate. In pharmaceutical quality, an action would be the test that needs to be performed on a drug product as defined in the quality specification.
    • Comment: Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.

    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 hasCode getReason setReason addReason hasReason getDocumentation setDocumentation addDocumentation hasDocumentation getGoalIdElement setGoalIdElement addGoalIdElement hasGoalIdElement getGoalId setGoalId addGoalId hasGoalId getSubject setSubject hasSubject getSubjectCodeableConcept hasSubjectCodeableConcept getSubjectReference hasSubjectReference getSubjectCanonicalType hasSubjectCanonicalType getTrigger setTrigger addTrigger hasTrigger getCondition setCondition addCondition hasCondition getInput setInput addInput hasInput getOutput setOutput addOutput hasOutput getRelatedAction setRelatedAction addRelatedAction hasRelatedAction getTiming setTiming hasTiming getTimingAge hasTimingAge 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 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 initReason initDocumentation initGoalId initTrigger initCondition initInput initOutput initRelatedAction initParticipant initDynamicValue initAction

    Constructors

    Properties

    linkId?: StringType

    PlanDefinition.action.linkId Element

    FHIR Specification

    • Short: Unique id for the action in the PlanDefinition
    • Definition: An identifier that is unique within the PlanDefinition to allow linkage within the realized CarePlan and/or RequestOrchestration.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    prefix?: StringType

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

    PlanDefinition.action.title Element

    FHIR Specification

    • Short: User-visible title
    • Definition: The textual description of the action displayed to a user. For example, when the action is a test to be performed, the title would be the title of the test such as Assay by HPLC.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    description?: MarkdownType

    PlanDefinition.action.description Element

    FHIR Specification

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

    PlanDefinition.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: false
    requestPriorityEnum: RequestPriorityEnum

    FHIR CodeSystem: RequestPriority

    priority?: EnumCodeType

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

    PlanDefinition.action.code Element

    FHIR Specification

    • Short: Code representing the meaning of the action or sub-actions
    • Definition: A code that provides a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical property.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    reason?: CodeableConcept[]

    PlanDefinition.action.reason Element

    FHIR Specification

    • Short: Why the action should be performed
    • Definition: A description of why this action is necessary or appropriate.
    • Comment: This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    documentation?: RelatedArtifact[]

    PlanDefinition.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
    goalId?: IdType[]

    PlanDefinition.action.goalId Element

    FHIR Specification

    • Short: What goals this action supports
    • Definition: Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action.
    • FHIR Type: id
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    subject?: IDataType

    PlanDefinition.action.subject[x] Element

    @ChoiceDataTypesMeta('PlanDefinition.action.subject[x]', ['CodeableConcept','Reference','canonical',]

    FHIR Specification

    • Short: Type of individual the action is focused on
    • Definition: A code, group definition, or canonical reference that describes the intended subject of the action and its children, if any. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.
    • Comment: The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified. In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).
    • Requirements: Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.
    • FHIR Types: 'CodeableConcept', 'Reference', 'canonical',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    trigger?: TriggerDefinition[]

    PlanDefinition.action.trigger Element

    FHIR Specification

    • Short: When the action should be triggered
    • Definition: A description of when the action should be triggered. When multiple triggers are specified on an action, any triggering event invokes the action.
    • FHIR Type: TriggerDefinition
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    PlanDefinition.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 the conditions are true.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

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

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

    PlanDefinition.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".
    • Comment: When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    timing?: IDataType

    PlanDefinition.action.timing[x] Element

    @ChoiceDataTypesMeta('PlanDefinition.action.timing[x]', ['Age','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 when the action should be performed. As a definitional resource, this timing is interpreted as part of an apply operation so that the timing of the result actions in a CarePlan or RequestOrchestration, for example, would be specified by evaluating the timing definition in the context of the apply and setting the resulting timing on the appropriate elements of the target resource. If the timing is an Age, the activity is expected to be performed when the subject is the given Age. When the timing is a Duration, the activity is expected to be performed within the specified duration from the apply. When the timing is a Range, it may be a range of Ages or Durations, providing a range for the expected timing of the resulting activity. When the timing is a Timing, it is establishing a schedule for the timing of the resulting activity.
    • Requirements: Allows prompting for activities and detection of missed planned activities.
    • FHIR Types: 'Age', 'Duration', 'Range', 'Timing',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

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

    PlanDefinition.action.participant Element

    FHIR Specification

    • Short: Who should participate in the action
    • Definition: Indicates who should participate in performing the action described.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

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

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

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

    PlanDefinition.action.requiredBehavior Element

    FHIR Specification

    • Short: must | could | must-unless-documented
    • Definition: Defines the required behavior for the action.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: ActionRequiredBehaviorEnum

    actionPrecheckBehaviorEnum: ActionPrecheckBehaviorEnum

    FHIR CodeSystem: ActionPrecheckBehavior

    precheckBehavior?: EnumCodeType

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

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

    definition?: IDataType

    PlanDefinition.action.definition[x] Element

    @ChoiceDataTypesMeta('PlanDefinition.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 MessageDefinition describing a message to be snet, 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

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

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

    PlanDefinition.action.action Element

    FHIR Specification

    • Short: A sub-action
    • Definition: Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR PlanDefinitionActionComponent

      • OptionaloptSourceField: string

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

      Returns undefined | PlanDefinitionActionComponent

      PlanDefinitionActionComponent data model or undefined for PlanDefinitionActionComponent

      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