eHealth Infrastructure
3.0.0 - release

eHealth Infrastructure - Local Development build (v3.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: ehealth-plandefinition

Official URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-plandefinition Version: 3.0.0
Active as of 2024-05-16 Computable Name: ehealth-plandefinition

Introduction

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.

Scope and Usage

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.

Governance principles

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:

  • Each plan has a version and a status
  • While a plan version is being worked on it shall be in status: draft
  • When a plan version is approved it changes status to active and is now ready to be used by CarePlans or as a subplan in another plan.
  • A plan with status: active can be retired, but cannot otherwise change. Status retired means that new references to the plan cannot be created. Existing plans may still continue to use the retired version.
  • If a plan needs to be updated, a new version must be created with status: draft. The new version will be a separate resource with a new id and version, but the same name as the previous version.
  • References to plans in FHIR are always to a specific resource id. In practice this means that a reference will identify a specific (Name, Version) combination.
  • If a subplan is available in a new active version, that the parent plan wants to use, then a new version of the parent plan must be created and then the reference can be updated to the new subplan.

Example: A new ActivityDefinition should be added to an existing PlanDefinition.

  1. Read the existing PlanDefinition (Version: 1)
  2. Bump the version to 2, change the status to draft, remove the id.
  3. Add a reference to the new ActivityDefinition in action.definition
  4. Call Create with the modified plan. This will create a new version of the plan in the database with the new ActivityDefinition added.

Update restrictions

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 Organization
  • ehealth-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.

Setting up an action trigger

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 met
  • offset 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.

Referencing information material

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.

Title and description

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.

Actions and Timing

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:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from PlanDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition 0..*PlanDefinitionThe definition of a plan for a series of actions, independent of any specific patient or context
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... recommendation 0..1CodeableConceptRecommendation state of the plan definition
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-recommendation
Binding: PlanDefinition Recommendation (required)
... intendedAudience 0..*Reference(ehealth-organization) {r}The intended audience of the resource
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience
... employeeTitle 0..1stringTitle for clinicians
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-employee-title
... predecessor 0..1IdentifierPredecessor
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-predecessor
... base 0..1IdentifierBase
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-base
... baseEnvironment 0..1IdentifierBase environment
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-base-environment
... version 1..1stringBusiness version of the plan definition
... jurisdiction 0..*CodeableConceptIntended jurisdiction for plan definition (if applicable)
Binding: Jurisdiction (required)
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment
Binding: Topic Type (required)
... library 0..*canonical(ehealth-library)Logic used by the plan definition
... action
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... overviewUsageMode 0..*CodeableConceptIdentifies 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
.... definition[x] 0..1canonical(ehealth-activitydefinition | ehealth-plandefinition)Description of the activity to be performed

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
PlanDefinition.jurisdictionrequiredJurisdiction
http://ehealth.sundhed.dk/vs/jurisdiction
from this IG
PlanDefinition.topicrequiredTopicType
http://ehealth.sundhed.dk/vs/topic-type
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition C0..*PlanDefinitionThe definition of a plan for a series of actions, independent of any specific patient or context
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... recommendation 0..1CodeableConceptRecommendation state of the plan definition
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-recommendation
Binding: PlanDefinition Recommendation (required)
... modifierRole 1..*(Complex)Modifier role
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role
... employeeTitle 0..1stringTitle for clinicians
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-employee-title
... predecessor 0..1IdentifierPredecessor
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-predecessor
... base 0..1IdentifierBase
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-base
... baseEnvironment 0..1IdentifierBase environment
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-base-environment
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... version Σ1..1stringBusiness version of the plan definition
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for plan definition (if applicable)
Binding: Jurisdiction (required)
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment
Binding: Topic Type (required)
... library 0..*canonical(ehealth-library)Logic used by the plan definition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PlanDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
PlanDefinition.jurisdictionrequiredJurisdiction
http://ehealth.sundhed.dk/vs/jurisdiction
from this IG
PlanDefinition.topicrequiredTopicType
http://ehealth.sundhed.dk/vs/topic-type
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition C0..*PlanDefinitionThe definition of a plan for a series of actions, independent of any specific patient or context
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... recommendation 0..1CodeableConceptRecommendation state of the plan definition
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-recommendation
Binding: PlanDefinition Recommendation (required)
... intendedAudience 0..*Reference(ehealth-organization) {r}The intended audience of the resource
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience
... modifierRole 1..*(Complex)Modifier role
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role
... employeeTitle 0..1stringTitle for clinicians
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-employee-title
... predecessor 0..1IdentifierPredecessor
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-predecessor
... base 0..1IdentifierBase
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-base
... baseEnvironment 0..1IdentifierBase environment
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-base-environment
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ0..1uriCanonical identifier for this plan definition, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the plan definition
... version Σ1..1stringBusiness version of the plan definition
... name ΣC0..1stringName for this plan definition (computer friendly)
... title Σ0..1stringName for this plan definition (human friendly)
... subtitle 0..1stringSubordinate title of the plan definition
... type Σ0..1CodeableConceptorder-set | clinical-protocol | eca-rule | workflow-definition
Binding: PlanDefinitionType (extensible): The type of PlanDefinition.

... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ0..1booleanFor testing purposes, not real usage
... subject[x] 0..1Type 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.).

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description Σ0..1markdownNatural language description of the plan definition
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for plan definition (if applicable)
Binding: Jurisdiction (required)
... purpose 0..1markdownWhy this plan definition is defined
... usage 0..1stringDescribes the clinical usage of the plan
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the plan definition was approved by publisher
... lastReviewDate 0..1dateWhen the plan definition was last reviewed
... effectivePeriod Σ0..1PeriodWhen the plan definition is expected to be used
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment
Binding: Topic Type (required)
... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations
... library 0..*canonical(ehealth-library)Logic used by the plan definition
... goal 0..*BackboneElementWhat the plan is trying to accomplish
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... category 0..1CodeableConceptE.g. Treatment, dietary, behavioral
Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation.

.... description 1..1CodeableConceptCode or text describing the goal
Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved.

.... priority 0..1CodeableConcepthigh-priority | medium-priority | low-priority
Binding: GoalPriority (preferred): Indicates the level of importance associated with reaching or sustaining a goal.

.... start 0..1CodeableConceptWhen goal pursuit begins
Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of a goal.

.... addresses 0..*CodeableConceptWhat does the goal address
Binding: Condition/Problem/DiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address.


.... documentation 0..*RelatedArtifactSupporting documentation for the goal
.... target 0..*BackboneElementTarget outcome for the goal
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... measure 0..1CodeableConceptThe 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..1The target value to be achieved
...... detailQuantityQuantity
...... detailRangeRange
...... detailCodeableConceptCodeableConcept
..... due 0..1DurationReach goal within
... action 0..*BackboneElementAction defined by the plan
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... overviewUsageMode 0..*CodeableConceptIdentifies 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..*ExtensionExtensions that cannot be ignored even if unrecognized
.... prefix 0..1stringUser-visible prefix for the action (e.g. 1. or A.)
.... title 0..1stringUser-visible title
.... description 0..1stringBrief description of the action
.... textEquivalent 0..1stringStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
.... priority 0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

.... code 0..*CodeableConceptCode representing the meaning of the action or sub-actions
.... reason 0..*CodeableConceptWhy the action should be performed
.... documentation 0..*RelatedArtifactSupporting documentation for the intended performer of the action
.... goalId 0..*idWhat goals this action supports
.... subject[x] 0..1Type 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.).

..... subjectCodeableConceptCodeableConcept
..... subjectReferenceReference(Group)
.... trigger 0..*TriggerDefinitionWhen the action should be triggered
.... condition 0..*BackboneElementWhether or not the action is applicable
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... kind 1..1codeapplicability | start | stop
Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.

..... expression 0..1ExpressionBoolean-valued expression
.... input 0..*DataRequirementInput data requirements
.... output 0..*DataRequirementOutput data definition
.... relatedAction 0..*BackboneElementRelationship to another action
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... actionId 1..1idWhat action is this related to
..... relationship 1..1codebefore-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..1Time offset for the relationship
...... offsetDurationDuration
...... offsetRangeRange
.... timing[x] 0..1When the action should take place
..... timingDateTimedateTime
..... timingAgeAge
..... timingPeriodPeriod
..... timingDurationDuration
..... timingRangeRange
..... timingTimingTiming
.... participant 0..*BackboneElementWho should participate in the action
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1codepatient | practitioner | related-person | device
Binding: ActionParticipantType (required): The type of participant for the action.

..... role 0..1CodeableConceptE.g. Nurse, Surgeon, Parent
Binding: ActionParticipantRole (example): Defines roles played by participants for the action.

.... type 0..1CodeableConceptcreate | update | remove | fire-event
Binding: ActionType (extensible): The type of action to be performed.

.... groupingBehavior 0..1codevisual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.

.... selectionBehavior 0..1codeany | all | all-or-none | exactly-one | at-most-one | one-or-more
Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.

.... requiredBehavior 0..1codemust | could | must-unless-documented
Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.

.... precheckBehavior 0..1codeyes | no
Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.

.... cardinalityBehavior 0..1codesingle | multiple
Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.

.... definition[x] 0..1canonical(ehealth-activitydefinition | ehealth-plandefinition)Description of the activity to be performed
.... transform 0..1canonical(StructureMap)Transform to apply the template
.... dynamicValue 0..*BackboneElementDynamic aspects of the definition
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... path 0..1stringThe path to the element to be set dynamically
..... expression 0..1ExpressionAn expression that provides the dynamic value for the customization
.... action 0..*See action (PlanDefinition)A sub-action

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PlanDefinition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
PlanDefinition.typeextensiblePlanDefinitionType
http://hl7.org/fhir/ValueSet/plan-definition-type
from the FHIR Standard
PlanDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
PlanDefinition.subject[x]extensibleSubjectType
http://hl7.org/fhir/ValueSet/subject-type
from the FHIR Standard
PlanDefinition.jurisdictionrequiredJurisdiction
http://ehealth.sundhed.dk/vs/jurisdiction
from this IG
PlanDefinition.topicrequiredTopicType
http://ehealth.sundhed.dk/vs/topic-type
from this IG
PlanDefinition.goal.categoryexampleGoalCategory
http://hl7.org/fhir/ValueSet/goal-category
from the FHIR Standard
PlanDefinition.goal.descriptionexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
PlanDefinition.goal.prioritypreferredGoalPriority
http://hl7.org/fhir/ValueSet/goal-priority
from the FHIR Standard
PlanDefinition.goal.startexampleGoalStartEvent
http://hl7.org/fhir/ValueSet/goal-start-event
from the FHIR Standard
PlanDefinition.goal.addressesexampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
from the FHIR Standard
PlanDefinition.goal.target.measureexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
PlanDefinition.action.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
PlanDefinition.action.subject[x]extensibleSubjectType
http://hl7.org/fhir/ValueSet/subject-type
from the FHIR Standard
PlanDefinition.action.condition.kindrequiredActionConditionKind
http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1
from the FHIR Standard
PlanDefinition.action.relatedAction.relationshiprequiredActionRelationshipType
http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1
from the FHIR Standard
PlanDefinition.action.participant.typerequiredActionParticipantType
http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1
from the FHIR Standard
PlanDefinition.action.participant.roleexampleActionParticipantRole
http://hl7.org/fhir/ValueSet/action-participant-role
from the FHIR Standard
PlanDefinition.action.typeextensibleActionType
http://hl7.org/fhir/ValueSet/action-type
from the FHIR Standard
PlanDefinition.action.groupingBehaviorrequiredActionGroupingBehavior
http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1
from the FHIR Standard
PlanDefinition.action.selectionBehaviorrequiredActionSelectionBehavior
http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1
from the FHIR Standard
PlanDefinition.action.requiredBehaviorrequiredActionRequiredBehavior
http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1
from the FHIR Standard
PlanDefinition.action.precheckBehaviorrequiredActionPrecheckBehavior
http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1
from the FHIR Standard
PlanDefinition.action.cardinalityBehaviorrequiredActionCardinalityBehavior
http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1
from the FHIR Standard

Differential View

This structure is derived from PlanDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition 0..*PlanDefinitionThe definition of a plan for a series of actions, independent of any specific patient or context
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... recommendation 0..1CodeableConceptRecommendation state of the plan definition
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-recommendation
Binding: PlanDefinition Recommendation (required)
... intendedAudience 0..*Reference(ehealth-organization) {r}The intended audience of the resource
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience
... employeeTitle 0..1stringTitle for clinicians
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-employee-title
... predecessor 0..1IdentifierPredecessor
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-predecessor
... base 0..1IdentifierBase
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-base
... baseEnvironment 0..1IdentifierBase environment
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-base-environment
... version 1..1stringBusiness version of the plan definition
... jurisdiction 0..*CodeableConceptIntended jurisdiction for plan definition (if applicable)
Binding: Jurisdiction (required)
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment
Binding: Topic Type (required)
... library 0..*canonical(ehealth-library)Logic used by the plan definition
... action
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... overviewUsageMode 0..*CodeableConceptIdentifies 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
.... definition[x] 0..1canonical(ehealth-activitydefinition | ehealth-plandefinition)Description of the activity to be performed

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
PlanDefinition.jurisdictionrequiredJurisdiction
http://ehealth.sundhed.dk/vs/jurisdiction
from this IG
PlanDefinition.topicrequiredTopicType
http://ehealth.sundhed.dk/vs/topic-type
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition C0..*PlanDefinitionThe definition of a plan for a series of actions, independent of any specific patient or context
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... recommendation 0..1CodeableConceptRecommendation state of the plan definition
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-recommendation
Binding: PlanDefinition Recommendation (required)
... modifierRole 1..*(Complex)Modifier role
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role
... employeeTitle 0..1stringTitle for clinicians
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-employee-title
... predecessor 0..1IdentifierPredecessor
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-predecessor
... base 0..1IdentifierBase
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-base
... baseEnvironment 0..1IdentifierBase environment
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-base-environment
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... version Σ1..1stringBusiness version of the plan definition
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for plan definition (if applicable)
Binding: Jurisdiction (required)
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment
Binding: Topic Type (required)
... library 0..*canonical(ehealth-library)Logic used by the plan definition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PlanDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
PlanDefinition.jurisdictionrequiredJurisdiction
http://ehealth.sundhed.dk/vs/jurisdiction
from this IG
PlanDefinition.topicrequiredTopicType
http://ehealth.sundhed.dk/vs/topic-type
from this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition C0..*PlanDefinitionThe definition of a plan for a series of actions, independent of any specific patient or context
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... recommendation 0..1CodeableConceptRecommendation state of the plan definition
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-recommendation
Binding: PlanDefinition Recommendation (required)
... intendedAudience 0..*Reference(ehealth-organization) {r}The intended audience of the resource
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience
... modifierRole 1..*(Complex)Modifier role
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role
... employeeTitle 0..1stringTitle for clinicians
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-employee-title
... predecessor 0..1IdentifierPredecessor
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-predecessor
... base 0..1IdentifierBase
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-base
... baseEnvironment 0..1IdentifierBase environment
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-base-environment
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ0..1uriCanonical identifier for this plan definition, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the plan definition
... version Σ1..1stringBusiness version of the plan definition
... name ΣC0..1stringName for this plan definition (computer friendly)
... title Σ0..1stringName for this plan definition (human friendly)
... subtitle 0..1stringSubordinate title of the plan definition
... type Σ0..1CodeableConceptorder-set | clinical-protocol | eca-rule | workflow-definition
Binding: PlanDefinitionType (extensible): The type of PlanDefinition.

... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ0..1booleanFor testing purposes, not real usage
... subject[x] 0..1Type 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.).

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description Σ0..1markdownNatural language description of the plan definition
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for plan definition (if applicable)
Binding: Jurisdiction (required)
... purpose 0..1markdownWhy this plan definition is defined
... usage 0..1stringDescribes the clinical usage of the plan
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the plan definition was approved by publisher
... lastReviewDate 0..1dateWhen the plan definition was last reviewed
... effectivePeriod Σ0..1PeriodWhen the plan definition is expected to be used
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment
Binding: Topic Type (required)
... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations
... library 0..*canonical(ehealth-library)Logic used by the plan definition
... goal 0..*BackboneElementWhat the plan is trying to accomplish
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... category 0..1CodeableConceptE.g. Treatment, dietary, behavioral
Binding: GoalCategory (example): Example codes for grouping goals for filtering or presentation.

.... description 1..1CodeableConceptCode or text describing the goal
Binding: SNOMEDCTClinicalFindings (example): Describes goals that can be achieved.

.... priority 0..1CodeableConcepthigh-priority | medium-priority | low-priority
Binding: GoalPriority (preferred): Indicates the level of importance associated with reaching or sustaining a goal.

.... start 0..1CodeableConceptWhen goal pursuit begins
Binding: GoalStartEvent (example): Identifies the types of events that might trigger the start of a goal.

.... addresses 0..*CodeableConceptWhat does the goal address
Binding: Condition/Problem/DiagnosisCodes (example): Identifies problems, conditions, issues, or concerns that goals may address.


.... documentation 0..*RelatedArtifactSupporting documentation for the goal
.... target 0..*BackboneElementTarget outcome for the goal
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... measure 0..1CodeableConceptThe 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..1The target value to be achieved
...... detailQuantityQuantity
...... detailRangeRange
...... detailCodeableConceptCodeableConcept
..... due 0..1DurationReach goal within
... action 0..*BackboneElementAction defined by the plan
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... overviewUsageMode 0..*CodeableConceptIdentifies 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..*ExtensionExtensions that cannot be ignored even if unrecognized
.... prefix 0..1stringUser-visible prefix for the action (e.g. 1. or A.)
.... title 0..1stringUser-visible title
.... description 0..1stringBrief description of the action
.... textEquivalent 0..1stringStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
.... priority 0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

.... code 0..*CodeableConceptCode representing the meaning of the action or sub-actions
.... reason 0..*CodeableConceptWhy the action should be performed
.... documentation 0..*RelatedArtifactSupporting documentation for the intended performer of the action
.... goalId 0..*idWhat goals this action supports
.... subject[x] 0..1Type 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.).

..... subjectCodeableConceptCodeableConcept
..... subjectReferenceReference(Group)
.... trigger 0..*TriggerDefinitionWhen the action should be triggered
.... condition 0..*BackboneElementWhether or not the action is applicable
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... kind 1..1codeapplicability | start | stop
Binding: ActionConditionKind (required): Defines the kinds of conditions that can appear on actions.

..... expression 0..1ExpressionBoolean-valued expression
.... input 0..*DataRequirementInput data requirements
.... output 0..*DataRequirementOutput data definition
.... relatedAction 0..*BackboneElementRelationship to another action
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... actionId 1..1idWhat action is this related to
..... relationship 1..1codebefore-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..1Time offset for the relationship
...... offsetDurationDuration
...... offsetRangeRange
.... timing[x] 0..1When the action should take place
..... timingDateTimedateTime
..... timingAgeAge
..... timingPeriodPeriod
..... timingDurationDuration
..... timingRangeRange
..... timingTimingTiming
.... participant 0..*BackboneElementWho should participate in the action
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1codepatient | practitioner | related-person | device
Binding: ActionParticipantType (required): The type of participant for the action.

..... role 0..1CodeableConceptE.g. Nurse, Surgeon, Parent
Binding: ActionParticipantRole (example): Defines roles played by participants for the action.

.... type 0..1CodeableConceptcreate | update | remove | fire-event
Binding: ActionType (extensible): The type of action to be performed.

.... groupingBehavior 0..1codevisual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.

.... selectionBehavior 0..1codeany | all | all-or-none | exactly-one | at-most-one | one-or-more
Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.

.... requiredBehavior 0..1codemust | could | must-unless-documented
Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.

.... precheckBehavior 0..1codeyes | no
Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.

.... cardinalityBehavior 0..1codesingle | multiple
Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.

.... definition[x] 0..1canonical(ehealth-activitydefinition | ehealth-plandefinition)Description of the activity to be performed
.... transform 0..1canonical(StructureMap)Transform to apply the template
.... dynamicValue 0..*BackboneElementDynamic aspects of the definition
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... path 0..1stringThe path to the element to be set dynamically
..... expression 0..1ExpressionAn expression that provides the dynamic value for the customization
.... action 0..*See action (PlanDefinition)A sub-action

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PlanDefinition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
PlanDefinition.typeextensiblePlanDefinitionType
http://hl7.org/fhir/ValueSet/plan-definition-type
from the FHIR Standard
PlanDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
PlanDefinition.subject[x]extensibleSubjectType
http://hl7.org/fhir/ValueSet/subject-type
from the FHIR Standard
PlanDefinition.jurisdictionrequiredJurisdiction
http://ehealth.sundhed.dk/vs/jurisdiction
from this IG
PlanDefinition.topicrequiredTopicType
http://ehealth.sundhed.dk/vs/topic-type
from this IG
PlanDefinition.goal.categoryexampleGoalCategory
http://hl7.org/fhir/ValueSet/goal-category
from the FHIR Standard
PlanDefinition.goal.descriptionexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
PlanDefinition.goal.prioritypreferredGoalPriority
http://hl7.org/fhir/ValueSet/goal-priority
from the FHIR Standard
PlanDefinition.goal.startexampleGoalStartEvent
http://hl7.org/fhir/ValueSet/goal-start-event
from the FHIR Standard
PlanDefinition.goal.addressesexampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
from the FHIR Standard
PlanDefinition.goal.target.measureexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
PlanDefinition.action.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
PlanDefinition.action.subject[x]extensibleSubjectType
http://hl7.org/fhir/ValueSet/subject-type
from the FHIR Standard
PlanDefinition.action.condition.kindrequiredActionConditionKind
http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1
from the FHIR Standard
PlanDefinition.action.relatedAction.relationshiprequiredActionRelationshipType
http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1
from the FHIR Standard
PlanDefinition.action.participant.typerequiredActionParticipantType
http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1
from the FHIR Standard
PlanDefinition.action.participant.roleexampleActionParticipantRole
http://hl7.org/fhir/ValueSet/action-participant-role
from the FHIR Standard
PlanDefinition.action.typeextensibleActionType
http://hl7.org/fhir/ValueSet/action-type
from the FHIR Standard
PlanDefinition.action.groupingBehaviorrequiredActionGroupingBehavior
http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1
from the FHIR Standard
PlanDefinition.action.selectionBehaviorrequiredActionSelectionBehavior
http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1
from the FHIR Standard
PlanDefinition.action.requiredBehaviorrequiredActionRequiredBehavior
http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1
from the FHIR Standard
PlanDefinition.action.precheckBehaviorrequiredActionPrecheckBehavior
http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1
from the FHIR Standard
PlanDefinition.action.cardinalityBehaviorrequiredActionCardinalityBehavior
http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1
from the FHIR Standard

 

Other representations of profile: CSV, Excel, Schematron