Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PlanDefinitionAction

Action defined by a plan definition

Hierarchy

Index

Properties

Optional action

A sub-action

Optional cardinalityBehavior

cardinalityBehavior: "single" | "multiple"

Optional code

Code representing the meaning of the action or sub-actions

Optional condition

Whether or not the action is applicable

Optional definitionCanonical

definitionCanonical: canonical

Description of the activity to be performed as a canonical Only one of definitionCanonical or definitionUri are allowed simultaneously

Optional definitionUri

definitionUri: uri

Description of the activity to be performed as a uri Only one of definitionCanonical or definitionUri are allowed simultaneously

Optional description

description: undefined | string

Brief description of the action

Optional documentation

documentation: RelatedArtifact[]

Supporting documentation for the intended performer of the action

Optional dynamicValue

Dynamic aspects of the definition

Optional extension

extension: Extension[]

Additional Content defined by implementations

Optional goalId

goalId: id[]

What goals this action supports

Optional groupingBehavior

groupingBehavior: "visual-group" | "logical-group" | "sentence-group"

visual-group | logical-group | sentence-group (http://hl7.org/fhir/R4/valueset-action-grouping-behavior.html)

Optional id

id: undefined | string

xml:id (or equivalent in JSON)

Optional input

Input data requirements

Optional modifierExtension

modifierExtension: Extension[]

Extensions that cannot be ignored if unrecognized

Optional output

output: DataRequirement[]

Output data definition

Optional participant

Who should participate in the action

Optional precheckBehavior

precheckBehavior: "yes" | "no"

Optional prefix

prefix: undefined | string

User-visible prefix for the action (e.g. 1. or A.)

Optional priority

priority: "routine" | "urgent" | "asap" | "stat"

Optional reason

reason: CodeableConcept[]

Why the action should be performed

Optional relatedAction

Relationship to another action

Optional requiredBehavior

requiredBehavior: "must" | "could" | "must-unless-documented"

must | could | must-unless-documented (http://hl7.org/fhir/R4/valueset-action-required-behavior.html)

Optional selectionBehavior

selectionBehavior: "any" | "all" | "all-or-none" | "exactly-one" | "at-most-one" | "one-or-more"

any | all | all-or-none | exactly-one | at-most-one | one-or-more (http://hl7.org/fhir/R4/valueset-action-selection-behavior.html)

Optional subjectCodeableConcept

subjectCodeableConcept: CodeableConcept

Type of individual the action is focused on as CodeableConcept Only one of subjectCodeableConcept or subjectReference are allowed simultaneously

Optional subjectReference

subjectReference: Reference

Type of individual the action is focused on as Reference Only one of subjectCodeableConcept or subjectReference are allowed simultaneously

Optional textEquivalent

textEquivalent: undefined | string

Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system

Optional timingAge

timingAge: Age

When the action should take place as Age Only one of timingDateTime, timingAge, timingPeriod, timingDuration, timingRange or timingTiming are allowed simultaneously

Optional timingDateTime

timingDateTime: dateTime

When the action should take place as dateTime Only one of timingDateTime, timingAge, timingPeriod, timingDuration, timingRange or timingTiming are allowed simultaneously

Optional timingDuration

timingDuration: Duration

When the action should take place as Duration Only one of timingDateTime, timingAge, timingPeriod, timingDuration, timingRange or timingTiming are allowed simultaneously

Optional timingPeriod

timingPeriod: Period

When the action should take place as Period Only one of timingDateTime, timingAge, timingPeriod, timingDuration, timingRange or timingTiming are allowed simultaneously

Optional timingRange

timingRange: Range

When the action should take place as Range Only one of timingDateTime, timingAge, timingPeriod, timingDuration, timingRange or timingTiming are allowed simultaneously

Optional timingTiming

timingTiming: Timing

When the action should take place as Timing Only one of timingDateTime, timingAge, timingPeriod, timingDuration, timingRange or timingTiming are allowed simultaneously

Optional title

title: undefined | string

User-visible title

Optional transform

transform: canonical

Transform to apply the template

Optional trigger

When the action should be triggered

Optional type

create | update | remove | fire-event (http://hl7.org/fhir/R4/valueset-action-type.html)

Generated using TypeDoc