Termini

CodeSystemsConceptSystemsStructureDefinitionsValueSetsPackagesConflicts
StructureDefinitionsPlanDefinition

http://hl7.org/fhir/StructureDefinition/PlanDefinition|4.0.1

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.
StructureJSONDependenciesFHIRSchemaOther VersionsDependant (0)ElementsSummary
NameFlagsCardTypeDescription & Constraints
PlanDefinition
0..*The definition of a plan for a series of actions, independent of any specific patient or context
 
url
Σ
0..1uriCanonical identifier for this plan definition, represented as a URI (globally unique)
 
identifier
Σ
0..*IdentifierAdditional identifier for the plan definition
 
version
Σ
0..1stringBusiness version of the plan definition
 
name
Σ
0..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 PlanDefinitionType (extensible)
 
status *
?!Σ
1..1codedraft | active | retired | unknown PublicationStatus (required)
 
experimental
Σ
0..1booleanFor testing purposes, not real usage
 
subject[x]
0..1Type of individual the plan definition is focused on SubjectType (extensible)
 
 
subjectCodeableConcept
0..1CodeableConcept SubjectType (extensible)
 
 
subjectReference
0..1Reference SubjectType (extensible)
 
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) Jurisdiction (extensible)
 
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 DefinitionTopic (example)
 
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..*canonicalLogic used by the plan definition
 
goal
0..*BackboneElementWhat the plan is trying to accomplish
 
 
category
0..1CodeableConceptE.g. Treatment, dietary, behavioral GoalCategory (example)
 
 
description *
1..1CodeableConceptCode or text describing the goal GoalDescription (example)
 
 
priority
0..1CodeableConcepthigh-priority | medium-priority | low-priority GoalPriority (preferred)
 
 
start
0..1CodeableConceptWhen goal pursuit begins GoalStartEvent (example)
 
 
addresses
0..*CodeableConceptWhat does the goal address GoalAddresses (example)
 
 
documentation
0..*RelatedArtifactSupporting documentation for the goal
 
 
target
0..*BackboneElementTarget outcome for the goal
 
 
 
measure
0..1CodeableConceptThe parameter whose value is to be tracked GoalTargetMeasure (example)
 
 
 
detail[x]
0..1The target value to be achieved
 
 
 
 
detailQuantity
0..1Quantity
 
 
 
 
detailRange
0..1Range
 
 
 
 
detailCodeableConcept
0..1CodeableConcept
 
 
 
due
0..1DurationReach goal within
 
action
0..*BackboneElementAction defined by the plan
 
 
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 RequestPriority (required)
 
 
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 SubjectType (extensible)
 
 
 
subjectCodeableConcept
0..1CodeableConcept SubjectType (extensible)
 
 
 
subjectReference
0..1Reference SubjectType (extensible)
 
 
trigger
0..*TriggerDefinitionWhen the action should be triggered
 
 
condition
0..*BackboneElementWhether or not the action is applicable
 
 
 
kind *
1..1codeapplicability | start | stop ActionConditionKind (required)
 
 
 
expression
0..1ExpressionBoolean-valued expression
 
 
input
0..*DataRequirementInput data requirements
 
 
output
0..*DataRequirementOutput data definition
 
 
relatedAction
0..*BackboneElementRelationship to another action
 
 
 
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 ActionRelationshipType (required)
 
 
 
offset[x]
0..1Time offset for the relationship
 
 
 
 
offsetDuration
0..1Duration
 
 
 
 
offsetRange
0..1Range
 
 
timing[x]
0..1When the action should take place
 
 
 
timingDateTime
0..1dateTime
 
 
 
timingAge
0..1Age
 
 
 
timingPeriod
0..1Period
 
 
 
timingDuration
0..1Duration
 
 
 
timingRange
0..1Range
 
 
 
timingTiming
0..1Timing
 
 
participant
0..*BackboneElementWho should participate in the action
 
 
 
type *
1..1codepatient | practitioner | related-person | device ActionParticipantType (required)
 
 
 
role
0..1CodeableConceptE.g. Nurse, Surgeon, Parent ActionParticipantRole (example)
 
 
type
0..1CodeableConceptcreate | update | remove | fire-event ActionType (extensible)
 
 
groupingBehavior
0..1codevisual-group | logical-group | sentence-group ActionGroupingBehavior (required)
 
 
selectionBehavior
0..1codeany | all | all-or-none | exactly-one | at-most-one | one-or-more ActionSelectionBehavior (required)
 
 
requiredBehavior
0..1codemust | could | must-unless-documented ActionRequiredBehavior (required)
 
 
precheckBehavior
0..1codeyes | no ActionPrecheckBehavior (required)
 
 
cardinalityBehavior
0..1codesingle | multiple ActionCardinalityBehavior (required)
 
 
definition[x]
0..1Description of the activity to be performed
 
 
 
definitionCanonical
0..1canonical
 
 
 
definitionUri
0..1uri
 
 
transform
0..1canonicalTransform to apply the template
 
 
dynamicValue
0..*BackboneElementDynamic aspects of the definition
 
 
 
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..*A sub-action