Skip to main content

PlanDefinitionAction

This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical and non-clinical artifacts such as clinical decision support rules, order sets, protocols, and drug quality specifications.

type PlanDefinitionAction implements Element {
  prefix: String
  title: String
  description: String
  textEquivalent: String
  priority: String
  code: [CodeableConcept]
  reason: [CodeableConcept]
  documentation: [RelatedArtifact]
  goalId: [String]
  subjectCodeableConcept: CodeableConcept
  subjectReference: Reference
  subjectCanonical: Uri
  trigger: [TriggerDefinition]
  condition: [PlanDefinitionCondition]
  input: [DataRequirement]
  output: [DataRequirement]
  relatedAction: [PlanDefinitionRelatedAction]
  timingDateTime: Date
  timingAge: Age
  timingPeriod: Period
  timingDuration: Duration
  timingRange: Range
  timingTiming: Timing
  participant: [PlanDefinitionParticipant]
  type: CodeableConcept
  groupingBehavior: String
  selectionBehavior: String
  requiredBehavior: String
  precheckBehavior: String
  cardinalityBehavior: String
  definitionCanonical: Uri
  definitionUri: Uri
  transform: Uri
  dynamicValue: [PlanDefinitionDynamicValue]
  action: [PlanDefinitionAction]
  modifierExtension: [Extension]
  extension: [Extension]
  id: String
}

Fields​

PlanDefinitionAction.prefix ● String scalar​

A user-visible prefix for the action.

PlanDefinitionAction.title ● String scalar​

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.

PlanDefinitionAction.description ● String scalar​

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

PlanDefinitionAction.textEquivalent ● String scalar​

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.

PlanDefinitionAction.priority ● String scalar​

Indicates how quickly the action should be addressed with respect to other actions.

PlanDefinitionAction.code ● [CodeableConcept] list object​

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.

PlanDefinitionAction.reason ● [CodeableConcept] list object​

A description of why this action is necessary or appropriate.

PlanDefinitionAction.documentation ● [RelatedArtifact] list object​

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.

PlanDefinitionAction.goalId ● [String] list scalar​

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.

PlanDefinitionAction.subjectCodeableConcept ● CodeableConcept object​

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. (choose any one of subject*, but only one)

PlanDefinitionAction.subjectReference ● Reference object​

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. (choose any one of subject*, but only one)

PlanDefinitionAction.subjectCanonical ● Uri scalar​

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. (choose any one of subject*, but only one)

PlanDefinitionAction.trigger ● [TriggerDefinition] list object​

A description of when the action should be triggered.

PlanDefinitionAction.condition ● [PlanDefinitionCondition] list object​

An expression that describes applicability criteria or start/stop conditions for the action.

PlanDefinitionAction.input ● [DataRequirement] list object​

Defines input data requirements for the action.

PlanDefinitionAction.output ● [DataRequirement] list object​

Defines the outputs of the action, if any.

PlanDefinitionAction.relatedAction ● [PlanDefinitionRelatedAction] list object​

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

PlanDefinitionAction.timingDateTime ● Date scalar​

An optional value describing when the action should be performed. (choose any one of timing*, but only one)

PlanDefinitionAction.timingAge ● Age object​

An optional value describing when the action should be performed. (choose any one of timing*, but only one)

PlanDefinitionAction.timingPeriod ● Period object​

An optional value describing when the action should be performed. (choose any one of timing*, but only one)

PlanDefinitionAction.timingDuration ● Duration object​

An optional value describing when the action should be performed. (choose any one of timing*, but only one)

PlanDefinitionAction.timingRange ● Range object​

An optional value describing when the action should be performed. (choose any one of timing*, but only one)

PlanDefinitionAction.timingTiming ● Timing object​

An optional value describing when the action should be performed. (choose any one of timing*, but only one)

PlanDefinitionAction.participant ● [PlanDefinitionParticipant] list object​

Indicates who should participate in performing the action described.

PlanDefinitionAction.type ● CodeableConcept object​

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

PlanDefinitionAction.groupingBehavior ● String scalar​

Defines the grouping behavior for the action and its children.

PlanDefinitionAction.selectionBehavior ● String scalar​

Defines the selection behavior for the action and its children.

PlanDefinitionAction.requiredBehavior ● String scalar​

Defines the required behavior for the action.

PlanDefinitionAction.precheckBehavior ● String scalar​

Defines whether the action should usually be preselected.

PlanDefinitionAction.cardinalityBehavior ● String scalar​

Defines whether the action can be selected multiple times.

PlanDefinitionAction.definitionCanonical ● Uri scalar​

A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken. (choose any one of definition*, but only one)

PlanDefinitionAction.definitionUri ● Uri scalar​

A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken. (choose any one of definition*, but only one)

PlanDefinitionAction.transform ● Uri scalar​

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.

PlanDefinitionAction.dynamicValue ● [PlanDefinitionDynamicValue] list object​

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.

PlanDefinitionAction.action ● [PlanDefinitionAction] list object​

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.

PlanDefinitionAction.modifierExtension ● [Extension] list object​

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

PlanDefinitionAction.extension ● [Extension] list object​

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

PlanDefinitionAction.id ● String scalar​

Interfaces​

Element interface​

Base definition for all elements in a resource. If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions

Member Of​

PlanDefinition object ● PlanDefinitionAction object