STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

1.25.2 Action Definition Detailed Descriptions

Clinical Decision Support Work GroupMaturity Level: N/ABallot Status: DSTU 2

1.25.2.1 ActionDefinition

ActionDefinition
Definition

The definition of an action to be performed. Some aspects of the definition are specified statically, and some aspects can be specified dynamically by referencing logic defined in a library.

Control1..1
Summarytrue
ActionDefinition.actionIdentifier
Definition

A unique identifier for the action. The identifier SHALL be unique within the container in which it appears, and MAY be universally unique.

Control0..1
TypeIdentifier
Summarytrue
ActionDefinition.label
Definition

A user-visible label for the action.

Control0..1
Typestring
Summarytrue
ActionDefinition.title
Definition

The title of the action displayed to a user.

Control0..1
Typestring
Summarytrue
ActionDefinition.description
Definition

A short description of the action used to provide a summary to display to the user.

Control0..1
Typestring
Summarytrue
ActionDefinition.textEquivalent
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 may not be capable of interpreting it dynamically.

Control0..1
Typestring
Summarytrue
ActionDefinition.concept
Definition

The concept represented by this action or its sub-actions.

Control0..*
TypeCodeableConcept
Summarytrue
ActionDefinition.supportingEvidence
Definition

The evidence grade and the sources of evidence for this action.

Control0..*
TypeAttachment
Summarytrue
ActionDefinition.documentation
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.

Control0..*
TypeAttachment
Summarytrue
ActionDefinition.relatedAction
Definition

A relationship to another action such as "before" or "30-60 minutes after start of".

Control0..1
Summarytrue
ActionDefinition.relatedAction.actionIdentifier
Definition

The unique identifier of the related action.

Control1..1
TypeIdentifier
Summarytrue
ActionDefinition.relatedAction.relationship
Definition

The relationship of this action to the related action.

Control1..1
BindingActionRelationshipType: Defines the types of relationships between actions (Required)
Typecode
Summarytrue
ActionDefinition.relatedAction.offset[x]
Definition

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

Control0..1
TypeDuration|Range
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
ActionDefinition.relatedAction.anchor
Definition

An optional indicator for how the relationship is anchored to the related action. For example "before the start" or "before the end" of the related action.

Control0..1
BindingActionRelationshipAnchor: Defines possible anchors for the relationship between actions (Required)
Typecode
Summarytrue
ActionDefinition.participantType
Definition

The type of participant in the action.

Control0..*
BindingParticipantType: The type of participant for the action (Required)
Typecode
Summarytrue
ActionDefinition.type
Definition

The type of action to perform (create, update, remove).

Control0..1
BindingActionType: The type of action to be performed (Extensible)
Typecode
Summarytrue
ActionDefinition.behavior
Definition

A behavior associated with the action. Behaviors define how the action is to be presented and/or executed within the receiving environment.

Control0..*
Summarytrue
ActionDefinition.behavior.type
Definition

The type of the behavior to be described, such as grouping, visual, or selection behaviors.

Control1..1
BindingActionBehaviorType: The type of behavior to be defined (Extensible)
TypeCoding
Summarytrue
ActionDefinition.behavior.value
Definition

The specific behavior. The code used here is determined by the type of behavior being described. For example, the grouping behavior uses the grouping-behavior-type valueset.

Control1..1
TypeCoding
Summarytrue
ActionDefinition.resource
Definition

The resource that is the target of the action (e.g. CommunicationRequest). The resource described here defines any aspects of the action that can be specified statically (i.e. are known at the time of definition).

Control0..1
TypeReference(Any)
Summarytrue
Comments

Note that the resource is optional, and if no resource is specified, a customization with a root (/) path can be used to define the entire resource dynamically.

ActionDefinition.customization
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.

Control0..*
Summarytrue
ActionDefinition.customization.path
Definition

The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression.

Control1..1
Typestring
Summarytrue
ActionDefinition.customization.expression
Definition

An expression specifying the value of the customized element.

Control1..1
Typestring
Summarytrue
ActionDefinition.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.

Control0..*
TypeActionDefinition
Summarytrue