eHealth Infrastructure - Local Development build (v2022.2). See the Directory of published versions
Official URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-plandefinition | Version: 2022.2 | |||
Active as of 2022-06-20 | Computable Name: ehealth-plandefinition |
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 artifacts such as clinical decision support rules, order sets and protocols.
In scope of the eHealth infrastructure, PlanDefinitions are used for defining tele-medicine plans. A PlanDefinition is comprised by potentially a number of subplans (each also represented as a PlanDefinition), and a number of activities each represented by an ActivityDefinition instance. These in turn can specify an activity to be performed, for instance measuring of a measure or answering of a Questionnaire.
Once a PlanDefinition and all the PlanDefinition, ActivityDefinition, and Questionnaire instances comprising it has a status set to other than draft, it can be itself be set to active. With that status it can be used as a template for applying it into a CarePlan bound to a specific Patient. The CarePlan then references the PlanDefinition as its definition.
PlanDefinitions (subplans), Questionnaires and ActivityDefinitions can be modified independently. Often by people in different organisations. PlanDefinitions (subplans), Questionnaires and ActivityDefinitions, can all be reused in different top level PlanDefinitions.
The following principles ensures that the owner of a resource can make controlled updates when resources maintained by other organisations are updated.
These principles are valid for PlanDefinitions, ActivityDefinitions, and Questionnaires. Plan is used as an example in the following principles:
Example: A new ActivityDefinition should be added to an existing PlanDefinition.
The element ehealth-modifier-role
specifies one or more Organization and each Organization’s role in maintaining
the PlanDefinition:
ehealth-modifier-role.reference
references the Organizationehealth-modifier-role.role
set to owner
means that the referenced Organization can update the resource
and alter the entities referenced by ehealth-modifier-role
, for instance, by adding more co-authors.ehealth-modifier-role.role
set to co-author
means that the referenced Organization can update the resource
but not alter the element ehealth-modifier-role
.An action in the plan can be set up with an action trigger that depend on one or more other actions in the plan. Although set up in the PlanDefinition and ActivityDefinition plane, the conditions are event driven and take place in the CarePlan and ServiceRequest plane, that is in the Patient specific use of the PlanDefinition.
An example use is a PlanDefinition with two actions: answering of an initial Questionnaire and answering of a follow-up Questionnaire. The PlanDefinition.action
specifying answering of the follow-up Questionnaire can be set up with an action trigger with a trigger condition specifying a number of measurement submissions (in this case, submission of QuestionnaireResponse) of the first action, answering of the initial Questionnaire. In the action trigger, it is also specified what reaction is to be performed on the depending action once the conditions are met. An example reaction is activation. This way, an action trigger defined in a PlanDefinition can be used such that submitted measurements on one or more activities can trigger activation of another activity in the Patient specific CarePlan.
An action trigger is defined in the element action.ehealth-actionTrigger
with contents as follows:
ehealth-triggerCondition
is a list of the conditions. Each trigger condition has contents:
actionID
contains the actionID of the triggering action which shall be another action in the same PlanDefinition. It follows that actions intended to be used as trigger conditions must be given an actionID for the triggerCondition
and the actionTrigger
to function.count
specifies the number of measurements that must be submitted before the particular trigger condition is fulfilled.triggerBehavior
specifies whether all or at least one of the trigger conditions must be metoffset
the offset applied to timing bounds of the depending action when trigger conditions are met and the reaction is performed.action
specifies what reaction shall be performed when trigger conditions are met. For now, activation of paused activity, that is change of ServiceRequest status
from on-hold
to active
, is the only reaction defined.PlanDefinitions can reference information material intended for Practitioner, Patient or RelatedPerson. The material can be in the form of embedded material (of reasonable size) or referenced videos, PDF-files or printed material. Information material is contained or referenced using a DocumentReference resource and referenced from the PlanDefinition using the relatedArtifact
element.
A PlanDefinition has two sets of titles and desriptions. title
and description
are intended for the citizens and should be of a natural language. Whereas ehealth-employee-title
and usage
are intended for clinicians and should be of a specific and professional language.
Each action
element must either have sub-actions or an action.definition
. This makes it possible to create top-level group-actions that functions as containers for a number of related sub-actions.
It is possible to specify timing for each action in the action.timing[x]
element. When the PlanDefiniton is applied to a Patient this will override any timing specified on the related ActivityDefinition.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from PlanDefinition
Summary
Mandatory: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
This structure is derived from PlanDefinition
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PlanDefinition | I | 0..* | PlanDefinition | The definition of a plan for a series of actions, independent of any specific patient or context |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-recommendation | 0..1 | CodeableConcept | Recommendation state of the plan definition URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-recommendation Binding: PlanDefinition Recommendation (required) | |
ehealth-intendedAudience | 0..* | Reference() | The intended audience of the resource URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience | |
ehealth-modifier-role | 1..* | (Complex) | Modifier role URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role | |
ehealth-employee-title | 0..1 | string | Title for clinicians URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-employee-title | |
ehealth-predecessor | 0..1 | Identifier | Predecessor URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-predecessor | |
ehealth-base | 0..1 | Identifier | Base URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-base | |
ehealth-base-environment | 0..1 | Identifier | Base environment URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-base-environment | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | Σ | 0..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique) |
identifier | Σ | 0..* | Identifier | Additional identifier for the plan definition |
version | Σ | 1..1 | string | Business version of the plan definition |
name | ΣI | 0..1 | string | Name for this plan definition (computer friendly) |
title | Σ | 0..1 | string | Name for this plan definition (human friendly) |
subtitle | 0..1 | string | Subordinate title of the plan definition | |
type | Σ | 0..1 | CodeableConcept | order-set | clinical-protocol | eca-rule | workflow-definition Binding: PlanDefinitionType (extensible): The type of PlanDefinition. |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage |
subject[x] | 0..1 | Type of individual the plan definition is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | ||
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
date | Σ | 0..1 | dateTime | Date last changed |
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
description | Σ | 0..1 | markdown | Natural language description of the plan definition |
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for plan definition (if applicable) Binding: Jurisdiction (required) |
purpose | 0..1 | markdown | Why this plan definition is defined | |
usage | 0..1 | string | Describes the clinical usage of the plan | |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
approvalDate | 0..1 | date | When the plan definition was approved by publisher | |
lastReviewDate | 0..1 | date | When the plan definition was last reviewed | |
effectivePeriod | Σ | 0..1 | Period | When the plan definition is expected to be used |
topic | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment Binding: Topic Type (required) | |
author | 0..* | ContactDetail | Who authored the content | |
editor | 0..* | ContactDetail | Who edited the content | |
reviewer | 0..* | ContactDetail | Who reviewed the content | |
endorser | 0..* | ContactDetail | Who endorsed the content | |
relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations | |
library | 0..* | canonical(ehealth-library) | Logic used by the plan definition | |
goal | 0..* | BackboneElement | What the plan is trying to accomplish | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
category | 0..1 | CodeableConcept | E.g. Treatment, dietary, behavioral Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation. | |
description | 1..1 | CodeableConcept | Code or text describing the goal Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved. | |
priority | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred): Indicates the level of importance associated with reaching or sustaining a goal. | |
start | 0..1 | CodeableConcept | When goal pursuit begins Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of a goal. | |
addresses | 0..* | CodeableConcept | What does the goal address Binding: Condition/Problem/DiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address. | |
documentation | 0..* | RelatedArtifact | Supporting documentation for the goal | |
target | 0..* | BackboneElement | Target outcome for the goal | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
measure | 0..1 | CodeableConcept | The parameter whose value is to be tracked Binding: LOINCCodes (example): Identifies types of parameters that can be tracked to determine goal achievement. | |
detail[x] | 0..1 | The target value to be achieved | ||
detailQuantity | Quantity | |||
detailRange | Range | |||
detailCodeableConcept | CodeableConcept | |||
due | 0..1 | Duration | Reach goal within | |
action | 0..* | BackboneElement | Action defined by the plan | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-overviewUsageMode | 0..* | CodeableConcept | Identifies whether the specified element and/or results of the element should appear in overview or table presentation. URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-overviewUsageMode Binding: Overview Usage Mode (required) | |
ehealth-actionTrigger | 0..1 | (Complex) | Reaction and trigger conditions URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-actionTrigger | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
prefix | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) | |
title | 0..1 | string | User-visible title | |
description | 0..1 | string | Brief description of the action | |
textEquivalent | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system | |
priority | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |
code | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions | |
reason | 0..* | CodeableConcept | Why the action should be performed | |
documentation | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action | |
goalId | 0..* | id | What goals this action supports | |
subject[x] | 0..1 | Type of individual the action is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | ||
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
trigger | 0..* | TriggerDefinition | When the action should be triggered | |
condition | 0..* | BackboneElement | Whether or not the action is applicable | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
kind | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. | |
expression | 0..1 | Expression | Boolean-valued expression | |
input | 0..* | DataRequirement | Input data requirements | |
output | 0..* | DataRequirement | Output data definition | |
relatedAction | 0..* | BackboneElement | Relationship to another action | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
actionId | 1..1 | id | What action is this related to | |
relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions. | |
offset[x] | 0..1 | Time offset for the relationship | ||
offsetDuration | Duration | |||
offsetRange | Range | |||
timing[x] | 0..1 | When the action should take place | ||
timingDateTime | dateTime | |||
timingAge | Age | |||
timingPeriod | Period | |||
timingDuration | Duration | |||
timingRange | Range | |||
timingTiming | Timing | |||
participant | 0..* | BackboneElement | Who should participate in the action | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action. | |
role | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action. | |
type | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed. | |
groupingBehavior | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group. | |
selectionBehavior | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group. | |
requiredBehavior | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required. | |
precheckBehavior | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group. | |
cardinalityBehavior | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated. | |
definition[x] | 0..1 | canonical(ehealth-activitydefinition | ehealth-plandefinition) | Description of the activity to be performed | |
transform | 0..1 | canonical(StructureMap) | Transform to apply the template | |
dynamicValue | 0..* | BackboneElement | Dynamic aspects of the definition | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
path | 0..1 | string | The path to the element to be set dynamically | |
expression | 0..1 | Expression | An expression that provides the dynamic value for the customization | |
action | 0..* | See action (PlanDefinition) | A sub-action | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PlanDefinition | I | 0..* | PlanDefinition | The definition of a plan for a series of actions, independent of any specific patient or context |
Documentation for this format |
This structure is derived from PlanDefinition
Summary
Mandatory: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from PlanDefinition
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PlanDefinition | I | 0..* | PlanDefinition | The definition of a plan for a series of actions, independent of any specific patient or context |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-recommendation | 0..1 | CodeableConcept | Recommendation state of the plan definition URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-recommendation Binding: PlanDefinition Recommendation (required) | |
ehealth-intendedAudience | 0..* | Reference() | The intended audience of the resource URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience | |
ehealth-modifier-role | 1..* | (Complex) | Modifier role URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role | |
ehealth-employee-title | 0..1 | string | Title for clinicians URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-employee-title | |
ehealth-predecessor | 0..1 | Identifier | Predecessor URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-predecessor | |
ehealth-base | 0..1 | Identifier | Base URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-base | |
ehealth-base-environment | 0..1 | Identifier | Base environment URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-base-environment | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | Σ | 0..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique) |
identifier | Σ | 0..* | Identifier | Additional identifier for the plan definition |
version | Σ | 1..1 | string | Business version of the plan definition |
name | ΣI | 0..1 | string | Name for this plan definition (computer friendly) |
title | Σ | 0..1 | string | Name for this plan definition (human friendly) |
subtitle | 0..1 | string | Subordinate title of the plan definition | |
type | Σ | 0..1 | CodeableConcept | order-set | clinical-protocol | eca-rule | workflow-definition Binding: PlanDefinitionType (extensible): The type of PlanDefinition. |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage |
subject[x] | 0..1 | Type of individual the plan definition is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | ||
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
date | Σ | 0..1 | dateTime | Date last changed |
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
description | Σ | 0..1 | markdown | Natural language description of the plan definition |
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for plan definition (if applicable) Binding: Jurisdiction (required) |
purpose | 0..1 | markdown | Why this plan definition is defined | |
usage | 0..1 | string | Describes the clinical usage of the plan | |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
approvalDate | 0..1 | date | When the plan definition was approved by publisher | |
lastReviewDate | 0..1 | date | When the plan definition was last reviewed | |
effectivePeriod | Σ | 0..1 | Period | When the plan definition is expected to be used |
topic | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment Binding: Topic Type (required) | |
author | 0..* | ContactDetail | Who authored the content | |
editor | 0..* | ContactDetail | Who edited the content | |
reviewer | 0..* | ContactDetail | Who reviewed the content | |
endorser | 0..* | ContactDetail | Who endorsed the content | |
relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations | |
library | 0..* | canonical(ehealth-library) | Logic used by the plan definition | |
goal | 0..* | BackboneElement | What the plan is trying to accomplish | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
category | 0..1 | CodeableConcept | E.g. Treatment, dietary, behavioral Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation. | |
description | 1..1 | CodeableConcept | Code or text describing the goal Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved. | |
priority | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred): Indicates the level of importance associated with reaching or sustaining a goal. | |
start | 0..1 | CodeableConcept | When goal pursuit begins Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of a goal. | |
addresses | 0..* | CodeableConcept | What does the goal address Binding: Condition/Problem/DiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address. | |
documentation | 0..* | RelatedArtifact | Supporting documentation for the goal | |
target | 0..* | BackboneElement | Target outcome for the goal | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
measure | 0..1 | CodeableConcept | The parameter whose value is to be tracked Binding: LOINCCodes (example): Identifies types of parameters that can be tracked to determine goal achievement. | |
detail[x] | 0..1 | The target value to be achieved | ||
detailQuantity | Quantity | |||
detailRange | Range | |||
detailCodeableConcept | CodeableConcept | |||
due | 0..1 | Duration | Reach goal within | |
action | 0..* | BackboneElement | Action defined by the plan | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-overviewUsageMode | 0..* | CodeableConcept | Identifies whether the specified element and/or results of the element should appear in overview or table presentation. URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-overviewUsageMode Binding: Overview Usage Mode (required) | |
ehealth-actionTrigger | 0..1 | (Complex) | Reaction and trigger conditions URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-actionTrigger | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
prefix | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) | |
title | 0..1 | string | User-visible title | |
description | 0..1 | string | Brief description of the action | |
textEquivalent | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system | |
priority | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |
code | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions | |
reason | 0..* | CodeableConcept | Why the action should be performed | |
documentation | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action | |
goalId | 0..* | id | What goals this action supports | |
subject[x] | 0..1 | Type of individual the action is focused on Binding: SubjectType (extensible): The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | ||
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
trigger | 0..* | TriggerDefinition | When the action should be triggered | |
condition | 0..* | BackboneElement | Whether or not the action is applicable | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
kind | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions. | |
expression | 0..1 | Expression | Boolean-valued expression | |
input | 0..* | DataRequirement | Input data requirements | |
output | 0..* | DataRequirement | Output data definition | |
relatedAction | 0..* | BackboneElement | Relationship to another action | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
actionId | 1..1 | id | What action is this related to | |
relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions. | |
offset[x] | 0..1 | Time offset for the relationship | ||
offsetDuration | Duration | |||
offsetRange | Range | |||
timing[x] | 0..1 | When the action should take place | ||
timingDateTime | dateTime | |||
timingAge | Age | |||
timingPeriod | Period | |||
timingDuration | Duration | |||
timingRange | Range | |||
timingTiming | Timing | |||
participant | 0..* | BackboneElement | Who should participate in the action | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant for the action. | |
role | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Binding: ActionParticipantRole (example): Defines roles played by participants for the action. | |
type | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed. | |
groupingBehavior | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group. | |
selectionBehavior | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group. | |
requiredBehavior | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required. | |
precheckBehavior | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group. | |
cardinalityBehavior | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated. | |
definition[x] | 0..1 | canonical(ehealth-activitydefinition | ehealth-plandefinition) | Description of the activity to be performed | |
transform | 0..1 | canonical(StructureMap) | Transform to apply the template | |
dynamicValue | 0..* | BackboneElement | Dynamic aspects of the definition | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
path | 0..1 | string | The path to the element to be set dynamically | |
expression | 0..1 | Expression | An expression that provides the dynamic value for the customization | |
action | 0..* | See action (PlanDefinition) | A sub-action | |
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet |
PlanDefinition.language | preferred | CommonLanguages Max Binding: AllLanguages |
PlanDefinition.type | extensible | PlanDefinitionType |
PlanDefinition.status | required | PublicationStatus |
PlanDefinition.subject[x] | extensible | SubjectType |
PlanDefinition.jurisdiction | required | Jurisdiction |
PlanDefinition.topic | required | TopicType |
PlanDefinition.goal.category | example | GoalCategory |
PlanDefinition.goal.description | example | SNOMEDCTClinicalFindings |
PlanDefinition.goal.priority | preferred | GoalPriority |
PlanDefinition.goal.start | example | GoalStartEvent |
PlanDefinition.goal.addresses | example | Condition/Problem/DiagnosisCodes |
PlanDefinition.goal.target.measure | example | LOINCCodes |
PlanDefinition.action.priority | required | RequestPriority |
PlanDefinition.action.subject[x] | extensible | SubjectType |
PlanDefinition.action.condition.kind | required | ActionConditionKind |
PlanDefinition.action.relatedAction.relationship | required | ActionRelationshipType |
PlanDefinition.action.participant.type | required | ActionParticipantType |
PlanDefinition.action.participant.role | example | ActionParticipantRole |
PlanDefinition.action.type | extensible | ActionType |
PlanDefinition.action.groupingBehavior | required | ActionGroupingBehavior |
PlanDefinition.action.selectionBehavior | required | ActionSelectionBehavior |
PlanDefinition.action.requiredBehavior | required | ActionRequiredBehavior |
PlanDefinition.action.precheckBehavior | required | ActionPrecheckBehavior |
PlanDefinition.action.cardinalityBehavior | required | ActionCardinalityBehavior |