FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

12.23 Resource PlanDefinition - Content

Clinical Decision Support icon Work GroupMaturity Level: 4 Trial UseSecurity Category: Business Compartments: No defined compartments

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

12.23.1 Scope and Usage

This resource is a definition resource from a FHIR workflow perspective - see Workflow, specifically Definition.

A plan definition is a pre-defined group of actions to be taken in particular circumstances, often including conditional elements, options, and other decision points. The resource is flexible enough to be used to represent a variety of workflows, as well as clinical decision support and quality improvement assets, including order sets, protocols, and decision support rules.

PlanDefinitions can contain hierarchical groups of action definitions, where each action definition describes an activity to be performed (often in terms of an ActivityDefinition resource), and each group defines additional behavior, relationships, and applicable conditions between the actions in the overall definition.

In addition to describing what should take place, each action in a plan definition can specify when and whether the action should take place. For when the action should be taken, the trigger element specifies the action should be taken in response to some trigger occurring (such as a particular point in a workflow being reached, or as the result of a prescription being ordered). For whether the action should be taken, the condition element can be used to provide an expression that evaluates to true or false to indicate the applicability of the action to the specific context.

The process of applying a PlanDefinition to a particular context typically produces request resources representing the actions that should be performed, grouped within a RequestOrchestration to capture relationships between the resulting request resources.

Each ActivityDefinition is used to construct a specific resource, based on the definition of the activity and combined with contextual information for the particular patient that the plan definition is being applied to.

As with the ActivityDefinition, a PlanDefinition may provide information about how to transform the activity to a specific intent resource, either by specifying a StructureMap that can be used to perform the transformation completely, or by specifying values for specific elements of the resulting resource using dynamicValue elements in the action.

Note that these mechanisms are provided on both the ActivityDefinition and the PlanDefinition to allow both reusable transformation descriptions, as well as customization of those descriptions within specific contexts. As such, the transform descriptions specified on the PlanDefinition override transform descriptions defined on the ActivityDefinition.

Dynamic values within the definitions can be provided by specifying the expression directly, or by referencing an expression defined within a library. For more information on how to reference expressions within resources, refer to the Using Expressions topic.

As an example, the Low Suicide Risk example order set from the Clinical Decision Support Knowledge Artifact Specification can be represented using the PlanDefinition and ActivityDefinition structures: Low Suicide Risk Example Order Set.

In addition to the representation of PlanDefinitions, the $apply operation allows PlanDefinitions to be applied to a specific context such as a patient, practitioner, or institution. For Order Sets specifically, this operation is expected to place the orders defined by the order set, consistent with the service functional requirements defined by the Order Set specification icon.

Plan definitions also allow for the definition of goals. Actions in the plan definition can then reference these goals in order to indicate that the action should be taken in fulfillment of the goal. Note that the goal-relationship extension can be used to describe relationships between goal definitions, and the satisfies-requirement extension can be used to indicate that the goal satisfies a particular requirement.

12.23.2 Boundaries and Relationships

The PlanDefinition resource is used to describe series, sequences, or groups of actions to be taken, while the ActivityDefinition resource is used to define each specific step or activity to be performed.

As the name implies, the PlanDefinition resource is strictly definitional. It does not represent the intention to take any action, nor does it represent that any actions have been taken. Rather, the resource provides a definition that can be applied in the appropriate circumstances. When the plan definition is applied, the result will in general be a set of actions that should be (or potentially even have been) performed.

Note that the PlanDefinition still has action-level information, as well as a reference to an ActivityDefinition. The action-level information defined in the PlanDefinition itself is used to describe how the actions are related to each other within the plan, where the ActivityDefinition contains only information about the activity itself. In addition, there is some overlapping information that allows the resources to be used independently, or in combination. See the Applying a PlanDefinition section for more information.

12.23.3 References to this Resource

12.23.4 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition TU DomainResource The definition of a plan for a series of actions, independent of any specific patient or context
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
+ Warning: goalid should reference the id of a goal definition
+ Warning: targetId should reference the id of an action

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
Interfaces Implemented: MetadataResource
... url ΣC 0..1 uri Canonical identifier for this plan definition, represented as a URI (globally unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic
... identifier Σ 0..* Identifier Additional identifier for the plan definition

... version Σ 0..1 string Business version of the plan definition
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: Version Algorithm (Extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name ΣC 0..1 string Name for this plan definition (computer friendly)
... title ΣT 0..1 string Name for this plan definition (human friendly)
... subtitle T 0..1 string Subordinate title of the plan definition
... type Σ 0..1 CodeableConcept order-set | clinical-protocol | eca-rule | workflow-definition
Binding: Plan Definition Type (Extensible)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (Required)
... experimental Σ 0..1 boolean For testing purposes, not real usage
... subject[x] 0..1 Type of individual the plan definition is focused on
Binding: Participant Resource Types (Extensible)
.... subjectCodeableConcept CodeableConcept
.... subjectReference Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition)
.... subjectCanonical canonical(EvidenceVariable)
... date Σ 0..1 dateTime Date last changed
... publisher ΣT 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher

... description ΣT 0..1 markdown Natural language description of the plan definition
... useContext Σ 0..* UsageContext The context that the content is intended to support

... jurisdiction ΣXD 0..* CodeableConcept Intended jurisdiction for plan definition (if applicable)
Binding: Jurisdiction ValueSet (Extensible)

... purpose T 0..1 markdown Why this plan definition is defined
... usage T 0..1 markdown Describes the clinical usage of the plan
... copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel T 0..1 string Copyright holder and year(s)
... approvalDate 0..1 date When the plan definition was approved by publisher
... lastReviewDate 0..1 date When the plan definition was last reviewed by the publisher
... effectivePeriod Σ 0..1 Period When the plan definition is expected to be used
... topic XD 0..* CodeableConcept E.g. Education, Treatment, Assessment
Binding: Definition Topic (Example)

... 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(Library) Logic used by the plan definition

... goal C 0..* BackboneElement What the plan is trying to accomplish

.... category 0..1 CodeableConcept E.g. Treatment, dietary, behavioral
Binding: Goal Category (Example)
.... description 1..1 CodeableConcept Code or text describing the goal
Binding: SNOMED CT Clinical Findings (Example)
.... priority 0..1 CodeableConcept high-priority | medium-priority | low-priority
Binding: Goal Priority (Preferred)
.... start 0..1 CodeableConcept When goal pursuit begins
Binding: Goal Start Event (Example)
.... addresses 0..* CodeableConcept What does the goal address
Binding: Condition/Problem/Diagnosis Codes (Example)

.... documentation 0..* RelatedArtifact Supporting documentation for the goal

.... target 0..* BackboneElement Target outcome for the goal

..... measure 0..1 CodeableConcept The parameter whose value is to be tracked
Binding: LOINC Codes (Example)
..... detail[x] 0..1 The target value to be achieved
...... detailQuantity Quantity
...... detailRange Range
...... detailCodeableConcept CodeableConcept
...... detailString string
...... detailBoolean boolean
...... detailInteger integer
...... detailRatio Ratio
..... due 0..1 Duration Reach goal within
... actor 0..* BackboneElement Actors within the plan

.... title T 0..1 string User-visible title
.... description T 0..1 markdown Describes the actor
.... option 1..* BackboneElement Who or what can be this actor

..... type 0..1 code careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: Action Participant Type (Required)
..... typeCanonical 0..1 canonical(CapabilityStatement) Who or what can participate
..... typeReference 0..1 Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) Who or what can participate
..... role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent
Binding: Action Participant Role icon (Example)
... action C 0..* BackboneElement Action defined by the plan

.... linkId 0..1 string Unique id for the action in the PlanDefinition
.... prefix 0..1 string User-visible prefix for the action (e.g. 1. or A.)
.... title T 0..1 string User-visible title
.... description T 0..1 markdown Brief description of the action
.... textEquivalent T 0..1 markdown 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)
.... code 0..1 CodeableConcept Code representing the meaning of the action or sub-actions
Binding: Action Code (Example)
.... reason 0..* CodeableConcept Why the action should be performed
Binding: Action Reason Code (Example)

.... documentation 0..* RelatedArtifact Supporting documentation for the intended performer of the action

.... goalId C 0..* id What goals this action supports

.... subject[x] 0..1 Type of individual the action is focused on
Binding: Participant Resource Types (Extensible)
..... subjectCodeableConcept CodeableConcept
..... subjectReference Reference(Group)
..... subjectCanonical canonical()
.... trigger 0..* TriggerDefinition When the action should be triggered

.... condition 0..* BackboneElement Whether or not the action is applicable

..... kind 1..1 code applicability | start | stop
Binding: Action Condition Kind (Required)
..... expression 0..1 Expression Boolean-valued expression
.... input C 0..* BackboneElement Input data requirements
+ Rule: Input data elements must have a requirement or a relatedData, but not both

..... title T 0..1 string User-visible title
..... requirement C 0..1 DataRequirement What data is provided
..... relatedData C 0..1 id What data is provided
.... output C 0..* BackboneElement Output data definition
+ Rule: Output data element must have a requirement or a relatedData, but not both

..... title T 0..1 string User-visible title
..... requirement C 0..1 DataRequirement What data is provided
..... relatedData C 0..1 string What data is provided
.... relatedAction C 0..* BackboneElement Relationship to another action

..... targetId C 1..1 id What action is this related to
..... relationship 1..1 code before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Binding: Action Relationship Type (Required)
..... endRelationship 0..1 code before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Binding: Action Relationship Type (Required)
..... offset[x] 0..1 Time offset for the relationship
...... offsetDuration Duration
...... offsetRange Range
.... timing[x] 0..1 When the action should take place
..... timingAge Age
..... timingDuration Duration
..... timingRange Range
..... timingTiming Timing
.... location 0..1 CodeableReference(Location) Where it should happen
.... participant 0..* BackboneElement Who should participate in the action

..... actorId 0..1 string What actor
..... type 0..1 code careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: Action Participant Type (Required)
..... typeCanonical 0..1 canonical(CapabilityStatement) Who or what can participate
..... typeReference 0..1 Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) Who or what can participate
..... role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent
Binding: Action Participant Role icon (Example)
..... function 0..1 CodeableConcept E.g. Author, Reviewer, Witness, etc
Binding: Action Participant Function (Example)
.... type 0..1 CodeableConcept create | update | remove | fire-event
Binding: Action Type (Extensible)
.... groupingBehavior 0..1 code visual-group | logical-group | sentence-group
Binding: Action Grouping Behavior (Required)
.... selectionBehavior 0..1 code any | all | all-or-none | exactly-one | at-most-one | one-or-more
Binding: Action Selection Behavior (Required)
.... requiredBehavior 0..1 code must | could | must-unless-documented
Binding: Action Required Behavior (Required)
.... precheckBehavior 0..1 code yes | no
Binding: Action Precheck Behavior (Required)
.... cardinalityBehavior 0..1 code single | multiple
Binding: Action Cardinality Behavior (Required)
.... definition[x] 0..1 Description of the activity to be performed
..... definitionCanonical canonical(ActivityDefinition | MessageDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition)
..... definitionUri uri
.... transform 0..1 canonical(StructureMap) Transform to apply the template
.... dynamicValue 0..* BackboneElement Dynamic aspects of the definition

..... 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 A sub-action

... asNeeded[x] Σ 0..1 Preconditions for service
Binding: SNOMED CT Medication As Needed Reason Codes (Example)
.... asNeededBoolean boolean
.... asNeededCodeableConcept CodeableConcept

doco Documentation for this format icon

See the Extensions for this resource

UML Diagram (Legend)

PlanDefinition (DomainResource) +MetadataResourceAn absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different serversurl : uri [0..1]A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instanceidentifier : Identifier [0..*]The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifactsversion : string [0..1]Indicates the mechanism used to compare versions to determine which is more currentversionAlgorithm[x] : DataType [0..1] « string|Coding; null (Strength=Extensible) VersionAlgorithm+ »A natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generationname : string [0..1] « This element has or is affected by some invariantsC »A short, descriptive, user-friendly title for the plan definitiontitle : string [0..1]An explanatory or alternate title for the plan definition giving additional information about its contentsubtitle : string [0..1]A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definitiontype : CodeableConcept [0..1] « null (Strength=Extensible)PlanDefinitionType+ »The status of this plan definition. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « null (Strength=Required)PublicationStatus! »A Boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usageexperimental : boolean [0..1]A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resourcesubject[x] : DataType [0..1] « CodeableConcept|Reference(Group| MedicinalProductDefinition|SubstanceDefinition| AdministrableProductDefinition|ManufacturedItemDefinition| PackagedProductDefinition)|canonical(EvidenceVariable); null (Strength=Extensible) ParticipantResourceTypes+ »The date (and optionally time) when the plan definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changesdate : dateTime [0..1]The name of the organization or individual responsible for the release and ongoing maintenance of the plan definitionpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the plan definition from a consumer's perspectivedescription : markdown [0..1]The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instancesuseContext : UsageContext [0..*]A legal or geographic region in which the plan definition is intended to be usedjurisdiction : CodeableConcept [0..*] « null (Strength=Extensible)JurisdictionValueSet+ »Explanation of why this plan definition is needed and why it has been designed as it haspurpose : markdown [0..1]A detailed description of how the plan definition is used from a clinical perspectiveusage : markdown [0..1]A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definitioncopyright : markdown [0..1]A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved')copyrightLabel : string [0..1]The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usageapprovalDate : date [0..1]The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval datelastReviewDate : date [0..1]The period during which the plan definition content was or is planned to be in active useeffectivePeriod : Period [0..1]Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searchingtopic : CodeableConcept [0..*] « null (Strength=Example)DefinitionTopic?? »An individiual or organization primarily involved in the creation and maintenance of the contentauthor : ContactDetail [0..*]An individual or organization primarily responsible for internal coherence of the contenteditor : ContactDetail [0..*]An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the contentreviewer : ContactDetail [0..*]An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some settingendorser : ContactDetail [0..*]Related artifacts such as additional documentation, justification, or bibliographic referencesrelatedArtifact : RelatedArtifact [0..*]A reference to a Library resource containing any formal logic used by the plan definitionlibrary : canonical [0..*] « Library »If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etcasNeeded[x] : DataType [0..1] « boolean|CodeableConcept; null (Strength=Example) SNOMEDCTMedicationAsNeededRea...?? »GoalIndicates a category the goal falls withincategory : CodeableConcept [0..1] « null (Strength=Example)GoalCategory?? »Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding"description : CodeableConcept [1..1] « null (Strength=Example)SNOMEDCTClinicalFindings?? »Identifies the expected level of importance associated with reaching/sustaining the defined goalpriority : CodeableConcept [0..1] « null (Strength=Preferred)GoalPriority? »The event after which the goal should begin being pursuedstart : CodeableConcept [0..1] « null (Strength=Example)GoalStartEvent?? »Identifies problems, conditions, issues, or concerns the goal is intended to addressaddresses : CodeableConcept [0..*] « null (Strength=Example)ConditionProblemDiagnosisCodes?? »Didactic or other informational resources associated with the goal that provide further supporting information about the goal. Information resources can include inline text commentary and links to web resourcesdocumentation : RelatedArtifact [0..*]TargetThe parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c levelmeasure : CodeableConcept [0..1] « null (Strength=Example)LOINCCodes?? »The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low valuedetail[x] : DataType [0..1] « Quantity|Range|CodeableConcept|string| boolean|integer|Ratio »Indicates the timeframe after the start of the goal in which the goal should be metdue : Duration [0..1]ActorA descriptive label for the actortitle : string [0..1]A description of how the actor fits into the overall actions of the plan definitiondescription : markdown [0..1]OptionThe type of participant in the actiontype : code [0..1] « null (Strength=Required)ActionParticipantType! »The type of participant in the actiontypeCanonical : canonical [0..1] « CapabilityStatement »The type of participant in the actiontypeReference : Reference [0..1] « CareTeam|Device|DeviceDefinition| Endpoint|Group|HealthcareService|Location|Organization|Patient| Practitioner|PractitionerRole|RelatedPerson »The role the participant should play in performing the described actionrole : CodeableConcept [0..1] « null (Strength=Example)ActionParticipantRole?? »ActionAn identifier that is unique within the PlanDefinition to allow linkage within the realized CarePlan and/or RequestOrchestrationlinkId : string [0..1]A user-visible prefix for the action. For example a section or item numbering such as 1. or Aprefix : string [0..1]The textual description of the action displayed to a user. For example, when the action is a test to be performed, the title would be the title of the test such as Assay by HPLCtitle : string [0..1]A brief description of the action used to provide a summary to display to the userdescription : markdown [0..1]A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamicallytextEquivalent : markdown [0..1]Indicates how quickly the action should be addressed with respect to other actionspriority : code [0..1] « null (Strength=Required)RequestPriority! »A code that provides a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical propertycode : CodeableConcept [0..1] « null (Strength=Example)ActionCode?? »A description of why this action is necessary or appropriatereason : CodeableConcept [0..*] « null (Strength=Example)ActionReasonCode?? »Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resourcesdocumentation : RelatedArtifact [0..*]Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the actiongoalId : id [0..*] « This element has or is affected by some invariantsC »A code, group definition, or canonical reference that describes the intended subject of the action and its children, if any. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resourcesubject[x] : DataType [0..1] « CodeableConcept|Reference(Group)| canonical; null (Strength=Extensible)ParticipantResourceTypes+ »A description of when the action should be triggered. When multiple triggers are specified on an action, any triggering event invokes the actiontrigger : TriggerDefinition [0..*]An optional value describing when the action should be performedtiming[x] : DataType [0..1] « Age|Duration|Range|Timing »Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etclocation : CodeableReference [0..1] « Location »The type of action to perform (create, update, remove)type : CodeableConcept [0..1] « null (Strength=Extensible)ActionType+ »Defines the grouping behavior for the action and its childrengroupingBehavior : code [0..1] « null (Strength=Required)ActionGroupingBehavior! »Defines the selection behavior for the action and its childrenselectionBehavior : code [0..1] « null (Strength=Required)ActionSelectionBehavior! »Defines the required behavior for the actionrequiredBehavior : code [0..1] « null (Strength=Required)ActionRequiredBehavior! »Defines whether the action should usually be preselectedprecheckBehavior : code [0..1] « null (Strength=Required)ActionPrecheckBehavior! »Defines whether the action can be selected multiple timescardinalityBehavior : code [0..1] « null (Strength=Required)ActionCardinalityBehavior! »A reference to an ActivityDefinition that describes the action to be taken in detail, a MessageDefinition describing a message to be snet, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captureddefinition[x] : PrimitiveType [0..1] « canonical(ActivityDefinition| MessageDefinition|ObservationDefinition|PlanDefinition| Questionnaire|SpecimenDefinition)|uri »A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the inputtransform : canonical [0..1] « StructureMap »ConditionThe kind of conditionkind : code [1..1] « null (Strength=Required)ActionConditionKind! »An expression that returns true or false, indicating whether the condition is satisfiedexpression : Expression [0..1]InputA human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readerstitle : string [0..1]Defines the data that is to be provided as input to the actionrequirement : DataRequirement [0..1] « This element has or is affected by some invariantsC »Points to an existing input or output element that provides data to this inputrelatedData : id [0..1] « This element has or is affected by some invariantsC »OutputA human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readerstitle : string [0..1]Defines the data that results as output from the actionrequirement : DataRequirement [0..1] « This element has or is affected by some invariantsC »Points to an existing input or output element that is results as output from the actionrelatedData : string [0..1] « This element has or is affected by some invariantsC »RelatedActionThe element id of the target related actiontargetId : id [1..1] « This element has or is affected by some invariantsC »The relationship of the start of this action to the related actionrelationship : code [1..1] « null (Strength=Required)ActionRelationshipType! »The relationship of the end of this action to the related actionendRelationship : code [0..1] « null (Strength=Required)ActionRelationshipType! »A duration or range of durations to apply to the relationship. For example, 30-60 minutes beforeoffset[x] : DataType [0..1] « Duration|Range »ParticipantA reference to the id element of the actor who will participate in this actionactorId : string [0..1]The type of participant in the actiontype : code [0..1] « null (Strength=Required)ActionParticipantType! »The type of participant in the actiontypeCanonical : canonical [0..1] « CapabilityStatement »The type of participant in the actiontypeReference : Reference [0..1] « CareTeam|Device|DeviceDefinition| Endpoint|Group|HealthcareService|Location|Organization|Patient| Practitioner|PractitionerRole|RelatedPerson »The role the participant should play in performing the described actionrole : CodeableConcept [0..1] « null (Strength=Example)ActionParticipantRole?? »Indicates how the actor will be involved in the action - author, reviewer, witness, etcfunction : CodeableConcept [0..1] « null (Strength=Example)ActionParticipantFunction?? »DynamicValueThe path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolvable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details)path : string [0..1]An expression specifying the value of the customized elementexpression : Expression [0..1]Indicates what should be done and within what timeframetarget[0..*]A goal describes an expected outcome that activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, meeting the acceptance criteria for a test as specified by a quality specification, etcgoal[0..*]The characteristics of the candidates that could serve as the actoroption[1..*]Actors represent the individuals or groups involved in the execution of the defined set of activitiesactor[0..*]An expression that describes applicability criteria or start/stop conditions for the actioncondition[0..*]Defines input data requirements for the actioninput[0..*]Defines the outputs of the action, if anyoutput[0..*]A relationship to another action such as "before" or "30-60 minutes after start of"relatedAction[0..*]Indicates who should participate in performing the action describedparticipant[0..*]Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the resultdynamicValue[0..*]Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definitionaction[0..*]An action or group of actions to be taken as part of the plan. For example, in clinical care, an action would be to prescribe a particular indicated medication, or perform a particular test as appropriate. In pharmaceutical quality, an action would be the test that needs to be performed on a drug product as defined in the quality specificationaction[0..*]

XML Template

<PlanDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this plan definition, represented as a URI (globally unique) -->
 <identifier><!-- 0..* Identifier Additional identifier for the plan definition --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the plan definition -->
 <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]>
 <name value="[string]"/><!-- I 0..1 Name for this plan definition (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this plan definition (human friendly) -->
 <subtitle value="[string]"/><!-- 0..1 Subordinate title of the plan definition -->
 <type><!-- 0..1 CodeableConcept order-set | clinical-protocol | eca-rule | workflow-definition --></type>
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <subject[x]><!-- 0..1 CodeableConcept|Reference(AdministrableProductDefinition|
   Group|ManufacturedItemDefinition|MedicinalProductDefinition|
   PackagedProductDefinition|SubstanceDefinition)|canonical(EvidenceVariable) Type of individual the plan definition is focused on --></subject[x]>
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the plan definition -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for plan definition (if applicable) --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this plan definition is defined -->
 <usage value="[markdown]"/><!-- 0..1 Describes the clinical usage of the plan -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) -->
 <approvalDate value="[date]"/><!-- 0..1 When the plan definition was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the plan definition was last reviewed by the publisher -->
 <effectivePeriod><!-- 0..1 Period When the plan definition is expected to be used --></effectivePeriod>
 <topic><!-- 0..* CodeableConcept E.g. Education, Treatment, Assessment --></topic>
 <author><!-- 0..* ContactDetail Who authored the content --></author>
 <editor><!-- 0..* ContactDetail Who edited the content --></editor>
 <reviewer><!-- 0..* ContactDetail Who reviewed the content --></reviewer>
 <endorser><!-- 0..* ContactDetail Who endorsed the content --></endorser>
 <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations --></relatedArtifact>
 <library><!-- 0..* canonical(Library) Logic used by the plan definition --></library>
 <goal>  <!-- I 0..* What the plan is trying to accomplish -->
  <category><!-- 0..1 CodeableConcept E.g. Treatment, dietary, behavioral --></category>
  <description><!-- 1..1 CodeableConcept Code or text describing the goal --></description>
  <priority><!-- 0..1 CodeableConcept high-priority | medium-priority | low-priority --></priority>
  <start><!-- 0..1 CodeableConcept When goal pursuit begins --></start>
  <addresses><!-- 0..* CodeableConcept What does the goal address --></addresses>
  <documentation><!-- 0..* RelatedArtifact Supporting documentation for the goal --></documentation>
  <target>  <!-- 0..* Target outcome for the goal -->
   <measure><!-- 0..1 CodeableConcept The parameter whose value is to be tracked --></measure>
   <detail[x]><!-- 0..1 Quantity|Range|CodeableConcept|string|boolean|integer|
     Ratio The target value to be achieved --></detail[x]>
   <due><!-- 0..1 Duration Reach goal within --></due>
  </target>
 </goal>
 <actor>  <!-- 0..* Actors within the plan -->
  <title value="[string]"/><!-- 0..1 User-visible title -->
  <description value="[markdown]"/><!-- 0..1 Describes the actor -->
  <option>  <!-- 1..* Who or what can be this actor -->
   <type value="[code]"/><!-- 0..1 careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson -->
   <typeCanonical><!-- 0..1 canonical(CapabilityStatement) Who or what can participate --></typeCanonical>
   <typeReference><!-- 0..1 Reference(CareTeam|Device|DeviceDefinition|Endpoint|
     Group|HealthcareService|Location|Organization|Patient|Practitioner|
     PractitionerRole|RelatedPerson) Who or what can participate --></typeReference>
   <role><!-- 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent icon --></role>
  </option>
 </actor>
 <action>  <!-- I 0..* Action defined by the plan -->
  <linkId value="[string]"/><!-- 0..1 Unique id for the action in the PlanDefinition -->
  <prefix value="[string]"/><!-- 0..1 User-visible prefix for the action (e.g. 1. or A.) -->
  <title value="[string]"/><!-- 0..1 User-visible title -->
  <description value="[markdown]"/><!-- 0..1 Brief description of the action -->
  <textEquivalent value="[markdown]"/><!-- 0..1 Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system -->
  <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat -->
  <code><!-- 0..1 CodeableConcept Code representing the meaning of the action or sub-actions --></code>
  <reason><!-- 0..* CodeableConcept Why the action should be performed --></reason>
  <documentation><!-- 0..* RelatedArtifact Supporting documentation for the intended performer of the action --></documentation>
  <goalId value="[id]"/><!-- I 0..* What goals this action supports -->
  <subject[x]><!-- 0..1 CodeableConcept|Reference(Group)|canonical Type of individual the action is focused on --></subject[x]>
  <trigger><!-- 0..* TriggerDefinition When the action should be triggered --></trigger>
  <condition>  <!-- 0..* Whether or not the action is applicable -->
   <kind value="[code]"/><!-- 1..1 applicability | start | stop -->
   <expression><!-- 0..1 Expression Boolean-valued expression --></expression>
  </condition>
  <input>  <!-- 0..* Input data requirements -->
   <title value="[string]"/><!-- 0..1 User-visible title -->
   <requirement><!-- I 0..1 DataRequirement What data is provided --></requirement>
   <relatedData value="[id]"/><!-- I 0..1 What data is provided -->
  </input>
  <output>  <!-- 0..* Output data definition -->
   <title value="[string]"/><!-- 0..1 User-visible title -->
   <requirement><!-- I 0..1 DataRequirement What data is provided --></requirement>
   <relatedData value="[string]"/><!-- I 0..1 What data is provided -->
  </output>
  <relatedAction>  <!-- I 0..* Relationship to another action -->
   <targetId value="[id]"/><!-- I 1..1 What action is this related to -->
   <relationship value="[code]"/><!-- 1..1 before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end -->
   <endRelationship value="[code]"/><!-- 0..1 before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end -->
   <offset[x]><!-- 0..1 Duration|Range Time offset for the relationship --></offset[x]>
  </relatedAction>
  <timing[x]><!-- 0..1 Age|Duration|Range|Timing When the action should take place --></timing[x]>
  <location><!-- 0..1 CodeableReference(Location) Where it should happen --></location>
  <participant>  <!-- 0..* Who should participate in the action -->
   <actorId value="[string]"/><!-- 0..1 What actor -->
   <type value="[code]"/><!-- 0..1 careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson -->
   <typeCanonical><!-- 0..1 canonical(CapabilityStatement) Who or what can participate --></typeCanonical>
   <typeReference><!-- 0..1 Reference(CareTeam|Device|DeviceDefinition|Endpoint|
     Group|HealthcareService|Location|Organization|Patient|Practitioner|
     PractitionerRole|RelatedPerson) Who or what can participate --></typeReference>
   <role><!-- 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent icon --></role>
   <function><!-- 0..1 CodeableConcept E.g. Author, Reviewer, Witness, etc --></function>
  </participant>
  <type><!-- 0..1 CodeableConcept create | update | remove | fire-event --></type>
  <groupingBehavior value="[code]"/><!-- 0..1 visual-group | logical-group | sentence-group -->
  <selectionBehavior value="[code]"/><!-- 0..1 any | all | all-or-none | exactly-one | at-most-one | one-or-more -->
  <requiredBehavior value="[code]"/><!-- 0..1 must | could | must-unless-documented -->
  <precheckBehavior value="[code]"/><!-- 0..1 yes | no -->
  <cardinalityBehavior value="[code]"/><!-- 0..1 single | multiple -->
  <definition[x]><!-- 0..1 canonical(ActivityDefinition|MessageDefinition|
    ObservationDefinition|PlanDefinition|Questionnaire|SpecimenDefinition)|uri Description of the activity to be performed --></definition[x]>
  <transform><!-- 0..1 canonical(StructureMap) Transform to apply the template --></transform>
  <dynamicValue>  <!-- 0..* Dynamic aspects of the definition -->
   <path value="[string]"/><!-- 0..1 The path to the element to be set dynamically -->
   <expression><!-- 0..1 Expression An expression that provides the dynamic value for the customization --></expression>
  </dynamicValue>
  <action><!-- 0..* Content as for PlanDefinition.action A sub-action --></action>
 </action>
 <asNeeded[x]><!-- 0..1 boolean|CodeableConcept Preconditions for service --></asNeeded[x]>
</PlanDefinition>

JSON Template

{doco
  "resourceType" : "PlanDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this plan definition, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the plan definition
  "version" : "<string>", // Business version of the plan definition
  // versionAlgorithm[x]: How to compare versions. One of these 2:
  "versionAlgorithmString" : "<string>",
  "versionAlgorithmCoding" : { Coding },
  "name" : "<string>", // I Name for this plan definition (computer friendly)
  "title" : "<string>", // Name for this plan definition (human friendly)
  "subtitle" : "<string>", // Subordinate title of the plan definition
  "type" : { CodeableConcept }, // order-set | clinical-protocol | eca-rule | workflow-definition
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  // subject[x]: Type of individual the plan definition is focused on. One of these 3:
  "subjectCodeableConcept" : { CodeableConcept },
  "subjectReference" : { Reference(AdministrableProductDefinition|Group|
   ManufacturedItemDefinition|MedicinalProductDefinition|
   PackagedProductDefinition|SubstanceDefinition) },
  "subjectCanonical" : "<canonical(EvidenceVariable)>",
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher/steward (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the plan definition
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for plan definition (if applicable)
  "purpose" : "<markdown>", // Why this plan definition is defined
  "usage" : "<markdown>", // Describes the clinical usage of the plan
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "copyrightLabel" : "<string>", // Copyright holder and year(s)
  "approvalDate" : "<date>", // When the plan definition was approved by publisher
  "lastReviewDate" : "<date>", // When the plan definition was last reviewed by the publisher
  "effectivePeriod" : { Period }, // When the plan definition is expected to be used
  "topic" : [{ CodeableConcept }], // E.g. Education, Treatment, Assessment
  "author" : [{ ContactDetail }], // Who authored the content
  "editor" : [{ ContactDetail }], // Who edited the content
  "reviewer" : [{ ContactDetail }], // Who reviewed the content
  "endorser" : [{ ContactDetail }], // Who endorsed the content
  "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations
  "library" : ["<canonical(Library)>"], // Logic used by the plan definition
  "goal" : [{ // I What the plan is trying to accomplish
    "category" : { CodeableConcept }, // E.g. Treatment, dietary, behavioral
    "description" : { CodeableConcept }, // R!  Code or text describing the goal
    "priority" : { CodeableConcept }, // high-priority | medium-priority | low-priority
    "start" : { CodeableConcept }, // When goal pursuit begins
    "addresses" : [{ CodeableConcept }], // What does the goal address
    "documentation" : [{ RelatedArtifact }], // Supporting documentation for the goal
    "target" : [{ // Target outcome for the goal
      "measure" : { CodeableConcept }, // The parameter whose value is to be tracked
      // detail[x]: The target value to be achieved. One of these 7:
      "detailQuantity" : { Quantity },
      "detailRange" : { Range },
      "detailCodeableConcept" : { CodeableConcept },
      "detailString" : "<string>",
      "detailBoolean" : <boolean>,
      "detailInteger" : <integer>,
      "detailRatio" : { Ratio },
      "due" : { Duration } // Reach goal within
    }]
  }],
  "actor" : [{ // Actors within the plan
    "title" : "<string>", // User-visible title
    "description" : "<markdown>", // Describes the actor
    "option" : [{ // R!  Who or what can be this actor
      "type" : "<code>", // careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
      "typeCanonical" : "<canonical(CapabilityStatement)>", // Who or what can participate
      "typeReference" : { Reference(CareTeam|Device|DeviceDefinition|Endpoint|
     Group|HealthcareService|Location|Organization|Patient|Practitioner|
     PractitionerRole|RelatedPerson) }, // Who or what can participate
      "role" : { CodeableConcept } // E.g. Nurse, Surgeon, Parent icon
    }]
  }],
  "action" : [{ // I Action defined by the plan
    "linkId" : "<string>", // Unique id for the action in the PlanDefinition
    "prefix" : "<string>", // User-visible prefix for the action (e.g. 1. or A.)
    "title" : "<string>", // User-visible title
    "description" : "<markdown>", // Brief description of the action
    "textEquivalent" : "<markdown>", // Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
    "priority" : "<code>", // routine | urgent | asap | stat
    "code" : { CodeableConcept }, // Code representing the meaning of the action or sub-actions
    "reason" : [{ CodeableConcept }], // Why the action should be performed
    "documentation" : [{ RelatedArtifact }], // Supporting documentation for the intended performer of the action
    "goalId" : ["<id>"], // I What goals this action supports
    // subject[x]: Type of individual the action is focused on. One of these 3:
    "subjectCodeableConcept" : { CodeableConcept },
    "subjectReference" : { Reference(Group) },
    "subjectCanonical" : "<canonical>",
    "trigger" : [{ TriggerDefinition }], // When the action should be triggered
    "condition" : [{ // Whether or not the action is applicable
      "kind" : "<code>", // R!  applicability | start | stop
      "expression" : { Expression } // Boolean-valued expression
    }],
    "input" : [{ // Input data requirements
      "title" : "<string>", // User-visible title
      "requirement" : { DataRequirement }, // I What data is provided
      "relatedData" : "<id>" // I What data is provided
    }],
    "output" : [{ // Output data definition
      "title" : "<string>", // User-visible title
      "requirement" : { DataRequirement }, // I What data is provided
      "relatedData" : "<string>" // I What data is provided
    }],
    "relatedAction" : [{ // I Relationship to another action
      "targetId" : "<id>", // I R!  What action is this related to
      "relationship" : "<code>", // R!  before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
      "endRelationship" : "<code>", // before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
      // offset[x]: Time offset for the relationship. One of these 2:
      "offsetDuration" : { Duration },
      "offsetRange" : { Range }
    }],
    // timing[x]: When the action should take place. One of these 4:
    "timingAge" : { Age },
    "timingDuration" : { Duration },
    "timingRange" : { Range },
    "timingTiming" : { Timing },
    "location" : { CodeableReference(Location) }, // Where it should happen
    "participant" : [{ // Who should participate in the action
      "actorId" : "<string>", // What actor
      "type" : "<code>", // careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
      "typeCanonical" : "<canonical(CapabilityStatement)>", // Who or what can participate
      "typeReference" : { Reference(CareTeam|Device|DeviceDefinition|Endpoint|
     Group|HealthcareService|Location|Organization|Patient|Practitioner|
     PractitionerRole|RelatedPerson) }, // Who or what can participate
      "role" : { CodeableConcept }, // E.g. Nurse, Surgeon, Parent icon
      "function" : { CodeableConcept } // E.g. Author, Reviewer, Witness, etc
    }],
    "type" : { CodeableConcept }, // create | update | remove | fire-event
    "groupingBehavior" : "<code>", // visual-group | logical-group | sentence-group
    "selectionBehavior" : "<code>", // any | all | all-or-none | exactly-one | at-most-one | one-or-more
    "requiredBehavior" : "<code>", // must | could | must-unless-documented
    "precheckBehavior" : "<code>", // yes | no
    "cardinalityBehavior" : "<code>", // single | multiple
    // definition[x]: Description of the activity to be performed. One of these 2:
    "definitionCanonical" : "<canonical(ActivityDefinition|MessageDefinition|ObservationDefinition|PlanDefinition|Questionnaire|SpecimenDefinition)>",
    "definitionUri" : "<uri>",
    "transform" : "<canonical(StructureMap)>", // Transform to apply the template
    "dynamicValue" : [{ // Dynamic aspects of the definition
      "path" : "<string>", // The path to the element to be set dynamically
      "expression" : { Expression } // An expression that provides the dynamic value for the customization
    }],
    "action" : [{ Content as for PlanDefinition.action }] // A sub-action
  }],
  // asNeeded[x]: Preconditions for service. One of these 2:
  "asNeededBoolean" : <boolean>,
  "asNeededCodeableConcept" : { CodeableConcept }
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:PlanDefinition;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:url [ uri ] ; # 0..1 Canonical identifier for this plan definition, represented as a URI (globally unique)
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Additional identifier for the plan definition
  fhir:version [ string ] ; # 0..1 Business version of the plan definition
  # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2
    fhir:versionAlgorithm [  a fhir:string ; string ]
    fhir:versionAlgorithm [  a fhir:Coding ; Coding ]
  fhir:name [ string ] ; # 0..1 I Name for this plan definition (computer friendly)
  fhir:title [ string ] ; # 0..1 Name for this plan definition (human friendly)
  fhir:subtitle [ string ] ; # 0..1 Subordinate title of the plan definition
  fhir:type [ CodeableConcept ] ; # 0..1 order-set | clinical-protocol | eca-rule | workflow-definition
  fhir:status [ code ] ; # 1..1 draft | active | retired | unknown
  fhir:experimental [ boolean ] ; # 0..1 For testing purposes, not real usage
  # subject[x] : 0..1 Type of individual the plan definition is focused on. One of these 3
    fhir:subject [  a fhir:CodeableConcept ; CodeableConcept ]
    fhir:subject [  a fhir:Reference ; Reference(AdministrableProductDefinition|Group|ManufacturedItemDefinition|
  MedicinalProductDefinition|PackagedProductDefinition|SubstanceDefinition) ]
    fhir:subject [  a fhir:canonical ; canonical(EvidenceVariable) ]
  fhir:date [ dateTime ] ; # 0..1 Date last changed
  fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual)
  fhir:contact  ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher
  fhir:description [ markdown ] ; # 0..1 Natural language description of the plan definition
  fhir:useContext  ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support
  fhir:jurisdiction  ( [ CodeableConcept ] ... ) ; # 0..* Intended jurisdiction for plan definition (if applicable)
  fhir:purpose [ markdown ] ; # 0..1 Why this plan definition is defined
  fhir:usage [ markdown ] ; # 0..1 Describes the clinical usage of the plan
  fhir:copyright [ markdown ] ; # 0..1 Use and/or publishing restrictions
  fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s)
  fhir:approvalDate [ date ] ; # 0..1 When the plan definition was approved by publisher
  fhir:lastReviewDate [ date ] ; # 0..1 When the plan definition was last reviewed by the publisher
  fhir:effectivePeriod [ Period ] ; # 0..1 When the plan definition is expected to be used
  fhir:topic  ( [ CodeableConcept ] ... ) ; # 0..* E.g. Education, Treatment, Assessment
  fhir:author  ( [ ContactDetail ] ... ) ; # 0..* Who authored the content
  fhir:editor  ( [ ContactDetail ] ... ) ; # 0..* Who edited the content
  fhir:reviewer  ( [ ContactDetail ] ... ) ; # 0..* Who reviewed the content
  fhir:endorser  ( [ ContactDetail ] ... ) ; # 0..* Who endorsed the content
  fhir:relatedArtifact  ( [ RelatedArtifact ] ... ) ; # 0..* Additional documentation, citations
  fhir:library  ( [ canonical(Library) ] ... ) ; # 0..* Logic used by the plan definition
  fhir:goal ( [ # 0..* I What the plan is trying to accomplish
    fhir:category [ CodeableConcept ] ; # 0..1 E.g. Treatment, dietary, behavioral
    fhir:description [ CodeableConcept ] ; # 1..1 Code or text describing the goal
    fhir:priority [ CodeableConcept ] ; # 0..1 high-priority | medium-priority | low-priority
    fhir:start [ CodeableConcept ] ; # 0..1 When goal pursuit begins
    fhir:addresses  ( [ CodeableConcept ] ... ) ; # 0..* What does the goal address
    fhir:documentation  ( [ RelatedArtifact ] ... ) ; # 0..* Supporting documentation for the goal
    fhir:target ( [ # 0..* Target outcome for the goal
      fhir:measure [ CodeableConcept ] ; # 0..1 The parameter whose value is to be tracked
      # detail[x] : 0..1 The target value to be achieved. One of these 7
        fhir:detail [  a fhir:Quantity ; Quantity ]
        fhir:detail [  a fhir:Range ; Range ]
        fhir:detail [  a fhir:CodeableConcept ; CodeableConcept ]
        fhir:detail [  a fhir:string ; string ]
        fhir:detail [  a fhir:boolean ; boolean ]
        fhir:detail [  a fhir:integer ; integer ]
        fhir:detail [  a fhir:Ratio ; Ratio ]
      fhir:due [ Duration ] ; # 0..1 Reach goal within
    ] ... ) ;
  ] ... ) ;
  fhir:actor ( [ # 0..* Actors within the plan
    fhir:title [ string ] ; # 0..1 User-visible title
    fhir:description [ markdown ] ; # 0..1 Describes the actor
    fhir:option ( [ # 1..* Who or what can be this actor
      fhir:type [ code ] ; # 0..1 careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
      fhir:typeCanonical [ canonical(CapabilityStatement) ] ; # 0..1 Who or what can participate
      fhir:typeReference [ Reference(CareTeam|Device|DeviceDefinition|Endpoint|Group|HealthcareService|Location|
  Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ] ; # 0..1 Who or what can participate
      fhir:role [ CodeableConcept ] ; # 0..1 E.g. Nurse, Surgeon, Parent
    ] ... ) ;
  ] ... ) ;
  fhir:action ( [ # 0..* I Action defined by the plan
    fhir:linkId [ string ] ; # 0..1 Unique id for the action in the PlanDefinition
    fhir:prefix [ string ] ; # 0..1 User-visible prefix for the action (e.g. 1. or A.)
    fhir:title [ string ] ; # 0..1 User-visible title
    fhir:description [ markdown ] ; # 0..1 Brief description of the action
    fhir:textEquivalent [ markdown ] ; # 0..1 Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
    fhir:priority [ code ] ; # 0..1 routine | urgent | asap | stat
    fhir:code [ CodeableConcept ] ; # 0..1 Code representing the meaning of the action or sub-actions
    fhir:reason  ( [ CodeableConcept ] ... ) ; # 0..* Why the action should be performed
    fhir:documentation  ( [ RelatedArtifact ] ... ) ; # 0..* Supporting documentation for the intended performer of the action
    fhir:goalId  ( [ id ] ... ) ; # 0..* I What goals this action supports
    # subject[x] : 0..1 Type of individual the action is focused on. One of these 3
      fhir:subject [  a fhir:CodeableConcept ; CodeableConcept ]
      fhir:subject [  a fhir:Reference ; Reference(Group) ]
      fhir:subject [  a fhir:canonical ; canonical ]
    fhir:trigger  ( [ TriggerDefinition ] ... ) ; # 0..* When the action should be triggered
    fhir:condition ( [ # 0..* Whether or not the action is applicable
      fhir:kind [ code ] ; # 1..1 applicability | start | stop
      fhir:expression [ Expression ] ; # 0..1 Boolean-valued expression
    ] ... ) ;
    fhir:input ( [ # 0..* Input data requirements
      fhir:title [ string ] ; # 0..1 User-visible title
      fhir:requirement [ DataRequirement ] ; # 0..1 I What data is provided
      fhir:relatedData [ id ] ; # 0..1 I What data is provided
    ] ... ) ;
    fhir:output ( [ # 0..* Output data definition
      fhir:title [ string ] ; # 0..1 User-visible title
      fhir:requirement [ DataRequirement ] ; # 0..1 I What data is provided
      fhir:relatedData [ string ] ; # 0..1 I What data is provided
    ] ... ) ;
    fhir:relatedAction ( [ # 0..* I Relationship to another action
      fhir:targetId [ id ] ; # 1..1 I What action is this related to
      fhir:relationship [ code ] ; # 1..1 before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
      fhir:endRelationship [ code ] ; # 0..1 before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
      # offset[x] : 0..1 Time offset for the relationship. One of these 2
        fhir:offset [  a fhir:Duration ; Duration ]
        fhir:offset [  a fhir:Range ; Range ]
    ] ... ) ;
    # timing[x] : 0..1 When the action should take place. One of these 4
      fhir:timing [  a fhir:Age ; Age ]
      fhir:timing [  a fhir:Duration ; Duration ]
      fhir:timing [  a fhir:Range ; Range ]
      fhir:timing [  a fhir:Timing ; Timing ]
    fhir:location [ CodeableReference(Location) ] ; # 0..1 Where it should happen
    fhir:participant ( [ # 0..* Who should participate in the action
      fhir:actorId [ string ] ; # 0..1 What actor
      fhir:type [ code ] ; # 0..1 careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
      fhir:typeCanonical [ canonical(CapabilityStatement) ] ; # 0..1 Who or what can participate
      fhir:typeReference [ Reference(CareTeam|Device|DeviceDefinition|Endpoint|Group|HealthcareService|Location|
  Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ] ; # 0..1 Who or what can participate
      fhir:role [ CodeableConcept ] ; # 0..1 E.g. Nurse, Surgeon, Parent
      fhir:function [ CodeableConcept ] ; # 0..1 E.g. Author, Reviewer, Witness, etc
    ] ... ) ;
    fhir:type [ CodeableConcept ] ; # 0..1 create | update | remove | fire-event
    fhir:groupingBehavior [ code ] ; # 0..1 visual-group | logical-group | sentence-group
    fhir:selectionBehavior [ code ] ; # 0..1 any | all | all-or-none | exactly-one | at-most-one | one-or-more
    fhir:requiredBehavior [ code ] ; # 0..1 must | could | must-unless-documented
    fhir:precheckBehavior [ code ] ; # 0..1 yes | no
    fhir:cardinalityBehavior [ code ] ; # 0..1 single | multiple
    # definition[x] : 0..1 Description of the activity to be performed. One of these 2
      fhir:definition [  a fhir:canonical ; canonical(ActivityDefinition|MessageDefinition|ObservationDefinition|PlanDefinition|
  Questionnaire|SpecimenDefinition) ]
      fhir:definition [  a fhir:uri ; uri ]
    fhir:transform [ canonical(StructureMap) ] ; # 0..1 Transform to apply the template
    fhir:dynamicValue ( [ # 0..* Dynamic aspects of the definition
      fhir:path [ string ] ; # 0..1 The path to the element to be set dynamically
      fhir:expression [ Expression ] ; # 0..1 An expression that provides the dynamic value for the customization
    ] ... ) ;
    fhir:action  ( [ See PlanDefinition.action ] ... ) ; # 0..* A sub-action
  ] ... ) ;
  # asNeeded[x] : 0..1 Preconditions for service. One of these 2
    fhir:asNeeded [  a fhir:boolean ; boolean ]
    fhir:asNeeded [  a fhir:CodeableConcept ; CodeableConcept ]
]

Changes from both R4 and R4B

PlanDefinition
PlanDefinition.versionAlgorithm[x]
  • Added Element
PlanDefinition.subject[x]
  • Add Type canonical(EvidenceVariable)
  • Change value set from http://hl7.org/fhir/ValueSet/subject-type to Participant Resource Types
  • Change code system for extensibly bound codes from "http://hl7.org/fhir/resource-types" to "http://hl7.org/fhir/fhir-types"
PlanDefinition.usage
  • Type changed from string to markdown
PlanDefinition.copyrightLabel
  • Added Element
PlanDefinition.goal.target.detail[x]
  • Add Types string, boolean, integer, Ratio
PlanDefinition.actor
  • Added Element
PlanDefinition.actor.title
  • Added Element
PlanDefinition.actor.description
  • Added Element
PlanDefinition.actor.option
  • Added Mandatory Element
PlanDefinition.actor.option.type
  • Added Element
PlanDefinition.actor.option.typeCanonical
  • Added Element
PlanDefinition.actor.option.typeReference
  • Added Element
PlanDefinition.actor.option.role
  • Added Element
PlanDefinition.action.linkId
  • Added Element
PlanDefinition.action.description
  • Type changed from string to markdown
PlanDefinition.action.textEquivalent
  • Type changed from string to markdown
PlanDefinition.action.code
  • Max Cardinality changed from * to 1
PlanDefinition.action.subject[x]
  • Add Type canonical
  • Change value set from http://hl7.org/fhir/ValueSet/subject-type to Participant Resource Types
  • Change code system for extensibly bound codes from "http://hl7.org/fhir/resource-types" to "http://hl7.org/fhir/fhir-types"
PlanDefinition.action.input
  • Type changed from DataRequirement to BackboneElement
PlanDefinition.action.input.title
  • Added Element
PlanDefinition.action.input.requirement
  • Added Element
PlanDefinition.action.input.relatedData
  • Added Element
PlanDefinition.action.output
  • Type changed from DataRequirement to BackboneElement
PlanDefinition.action.output.title
  • Added Element
PlanDefinition.action.output.requirement
  • Added Element
PlanDefinition.action.output.relatedData
  • Added Element
PlanDefinition.action.relatedAction.targetId
  • Added Mandatory Element
PlanDefinition.action.relatedAction.endRelationship
  • Added Element
PlanDefinition.action.timing[x]
  • Remove Types dateTime, Period
PlanDefinition.action.location
  • Added Element
PlanDefinition.action.participant.actorId
  • Added Element
PlanDefinition.action.participant.type
  • Min Cardinality changed from 1 to 0
  • Remove code related-person
  • Add codes careteam, group, healthcareservice, location, organization, practitionerrole, relatedperson
PlanDefinition.action.participant.typeCanonical
  • Added Element
PlanDefinition.action.participant.typeReference
  • Added Element
PlanDefinition.action.participant.function
  • Added Element
PlanDefinition.asNeeded[x]
  • Added Element
PlanDefinition.action.relatedAction.actionId
  • Deleted (PlanDefinition.action.relatedAction.targetId)

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. PlanDefinition TU DomainResource The definition of a plan for a series of actions, independent of any specific patient or context
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
+ Warning: goalid should reference the id of a goal definition
+ Warning: targetId should reference the id of an action

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
Interfaces Implemented: MetadataResource
... url ΣC 0..1 uri Canonical identifier for this plan definition, represented as a URI (globally unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic
... identifier Σ 0..* Identifier Additional identifier for the plan definition

... version Σ 0..1 string Business version of the plan definition
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: Version Algorithm (Extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name ΣC 0..1 string Name for this plan definition (computer friendly)
... title ΣT 0..1 string Name for this plan definition (human friendly)
... subtitle T 0..1 string Subordinate title of the plan definition
... type Σ 0..1 CodeableConcept order-set | clinical-protocol | eca-rule | workflow-definition
Binding: Plan Definition Type (Extensible)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (Required)
... experimental Σ 0..1 boolean For testing purposes, not real usage
... subject[x] 0..1 Type of individual the plan definition is focused on
Binding: Participant Resource Types (Extensible)
.... subjectCodeableConcept CodeableConcept
.... subjectReference Reference(Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition)
.... subjectCanonical canonical(EvidenceVariable)
... date Σ 0..1 dateTime Date last changed
... publisher ΣT 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher

... description ΣT 0..1 markdown Natural language description of the plan definition
... useContext Σ 0..* UsageContext The context that the content is intended to support

... jurisdiction ΣXD 0..* CodeableConcept Intended jurisdiction for plan definition (if applicable)
Binding: Jurisdiction ValueSet (Extensible)

... purpose T 0..1 markdown Why this plan definition is defined
... usage T 0..1 markdown Describes the clinical usage of the plan
... copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel T 0..1 string Copyright holder and year(s)
... approvalDate 0..1 date When the plan definition was approved by publisher
... lastReviewDate 0..1 date When the plan definition was last reviewed by the publisher
... effectivePeriod Σ 0..1 Period When the plan definition is expected to be used
... topic XD 0..* CodeableConcept E.g. Education, Treatment, Assessment
Binding: Definition Topic (Example)

... 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(Library) Logic used by the plan definition

... goal C 0..* BackboneElement What the plan is trying to accomplish

.... category 0..1 CodeableConcept E.g. Treatment, dietary, behavioral
Binding: Goal Category (Example)
.... description 1..1 CodeableConcept Code or text describing the goal
Binding: SNOMED CT Clinical Findings (Example)
.... priority 0..1 CodeableConcept high-priority | medium-priority | low-priority
Binding: Goal Priority (Preferred)
.... start 0..1 CodeableConcept When goal pursuit begins
Binding: Goal Start Event (Example)
.... addresses 0..* CodeableConcept What does the goal address
Binding: Condition/Problem/Diagnosis Codes (Example)

.... documentation 0..* RelatedArtifact Supporting documentation for the goal

.... target 0..* BackboneElement Target outcome for the goal

..... measure 0..1 CodeableConcept The parameter whose value is to be tracked
Binding: LOINC Codes (Example)
..... detail[x] 0..1 The target value to be achieved
...... detailQuantity Quantity
...... detailRange Range
...... detailCodeableConcept CodeableConcept
...... detailString string
...... detailBoolean boolean
...... detailInteger integer
...... detailRatio Ratio
..... due 0..1 Duration Reach goal within
... actor 0..* BackboneElement Actors within the plan

.... title T 0..1 string User-visible title
.... description T 0..1 markdown Describes the actor
.... option 1..* BackboneElement Who or what can be this actor

..... type 0..1 code careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: Action Participant Type (Required)
..... typeCanonical 0..1 canonical(CapabilityStatement) Who or what can participate
..... typeReference 0..1 Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) Who or what can participate
..... role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent
Binding: Action Participant Role icon (Example)
... action C 0..* BackboneElement Action defined by the plan

.... linkId 0..1 string Unique id for the action in the PlanDefinition
.... prefix 0..1 string User-visible prefix for the action (e.g. 1. or A.)
.... title T 0..1 string User-visible title
.... description T 0..1 markdown Brief description of the action
.... textEquivalent T 0..1 markdown 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)
.... code 0..1 CodeableConcept Code representing the meaning of the action or sub-actions
Binding: Action Code (Example)
.... reason 0..* CodeableConcept Why the action should be performed
Binding: Action Reason Code (Example)

.... documentation 0..* RelatedArtifact Supporting documentation for the intended performer of the action

.... goalId C 0..* id What goals this action supports

.... subject[x] 0..1 Type of individual the action is focused on
Binding: Participant Resource Types (Extensible)
..... subjectCodeableConcept CodeableConcept
..... subjectReference Reference(Group)
..... subjectCanonical canonical()
.... trigger 0..* TriggerDefinition When the action should be triggered

.... condition 0..* BackboneElement Whether or not the action is applicable

..... kind 1..1 code applicability | start | stop
Binding: Action Condition Kind (Required)
..... expression 0..1 Expression Boolean-valued expression
.... input C 0..* BackboneElement Input data requirements
+ Rule: Input data elements must have a requirement or a relatedData, but not both

..... title T 0..1 string User-visible title
..... requirement C 0..1 DataRequirement What data is provided
..... relatedData C 0..1 id What data is provided
.... output C 0..* BackboneElement Output data definition
+ Rule: Output data element must have a requirement or a relatedData, but not both

..... title T 0..1 string User-visible title
..... requirement C 0..1 DataRequirement What data is provided
..... relatedData C 0..1 string What data is provided
.... relatedAction C 0..* BackboneElement Relationship to another action

..... targetId C 1..1 id What action is this related to
..... relationship 1..1 code before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Binding: Action Relationship Type (Required)
..... endRelationship 0..1 code before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Binding: Action Relationship Type (Required)
..... offset[x] 0..1 Time offset for the relationship
...... offsetDuration Duration
...... offsetRange Range
.... timing[x] 0..1 When the action should take place
..... timingAge Age
..... timingDuration Duration
..... timingRange Range
..... timingTiming Timing
.... location 0..1 CodeableReference(Location) Where it should happen
.... participant 0..* BackboneElement Who should participate in the action

..... actorId 0..1 string What actor
..... type 0..1 code careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: Action Participant Type (Required)
..... typeCanonical 0..1 canonical(CapabilityStatement) Who or what can participate
..... typeReference 0..1 Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) Who or what can participate
..... role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent
Binding: Action Participant Role icon (Example)
..... function 0..1 CodeableConcept E.g. Author, Reviewer, Witness, etc
Binding: Action Participant Function (Example)
.... type 0..1 CodeableConcept create | update | remove | fire-event
Binding: Action Type (Extensible)
.... groupingBehavior 0..1 code visual-group | logical-group | sentence-group
Binding: Action Grouping Behavior (Required)
.... selectionBehavior 0..1 code any | all | all-or-none | exactly-one | at-most-one | one-or-more
Binding: Action Selection Behavior (Required)
.... requiredBehavior 0..1 code must | could | must-unless-documented
Binding: Action Required Behavior (Required)
.... precheckBehavior 0..1 code yes | no
Binding: Action Precheck Behavior (Required)
.... cardinalityBehavior 0..1 code single | multiple
Binding: Action Cardinality Behavior (Required)
.... definition[x] 0..1 Description of the activity to be performed
..... definitionCanonical canonical(ActivityDefinition | MessageDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition)
..... definitionUri uri
.... transform 0..1 canonical(StructureMap) Transform to apply the template
.... dynamicValue 0..* BackboneElement Dynamic aspects of the definition

..... 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 A sub-action

... asNeeded[x] Σ 0..1 Preconditions for service
Binding: SNOMED CT Medication As Needed Reason Codes (Example)
.... asNeededBoolean boolean
.... asNeededCodeableConcept CodeableConcept

doco Documentation for this format icon

See the Extensions for this resource

UML Diagram (Legend)

PlanDefinition (DomainResource) +MetadataResourceAn absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different serversurl : uri [0..1]A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instanceidentifier : Identifier [0..*]The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifactsversion : string [0..1]Indicates the mechanism used to compare versions to determine which is more currentversionAlgorithm[x] : DataType [0..1] « string|Coding; null (Strength=Extensible) VersionAlgorithm+ »A natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generationname : string [0..1] « This element has or is affected by some invariantsC »A short, descriptive, user-friendly title for the plan definitiontitle : string [0..1]An explanatory or alternate title for the plan definition giving additional information about its contentsubtitle : string [0..1]A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definitiontype : CodeableConcept [0..1] « null (Strength=Extensible)PlanDefinitionType+ »The status of this plan definition. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « null (Strength=Required)PublicationStatus! »A Boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usageexperimental : boolean [0..1]A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resourcesubject[x] : DataType [0..1] « CodeableConcept|Reference(Group| MedicinalProductDefinition|SubstanceDefinition| AdministrableProductDefinition|ManufacturedItemDefinition| PackagedProductDefinition)|canonical(EvidenceVariable); null (Strength=Extensible) ParticipantResourceTypes+ »The date (and optionally time) when the plan definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changesdate : dateTime [0..1]The name of the organization or individual responsible for the release and ongoing maintenance of the plan definitionpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the plan definition from a consumer's perspectivedescription : markdown [0..1]The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instancesuseContext : UsageContext [0..*]A legal or geographic region in which the plan definition is intended to be usedjurisdiction : CodeableConcept [0..*] « null (Strength=Extensible)JurisdictionValueSet+ »Explanation of why this plan definition is needed and why it has been designed as it haspurpose : markdown [0..1]A detailed description of how the plan definition is used from a clinical perspectiveusage : markdown [0..1]A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definitioncopyright : markdown [0..1]A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved')copyrightLabel : string [0..1]The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usageapprovalDate : date [0..1]The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval datelastReviewDate : date [0..1]The period during which the plan definition content was or is planned to be in active useeffectivePeriod : Period [0..1]Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searchingtopic : CodeableConcept [0..*] « null (Strength=Example)DefinitionTopic?? »An individiual or organization primarily involved in the creation and maintenance of the contentauthor : ContactDetail [0..*]An individual or organization primarily responsible for internal coherence of the contenteditor : ContactDetail [0..*]An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the contentreviewer : ContactDetail [0..*]An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some settingendorser : ContactDetail [0..*]Related artifacts such as additional documentation, justification, or bibliographic referencesrelatedArtifact : RelatedArtifact [0..*]A reference to a Library resource containing any formal logic used by the plan definitionlibrary : canonical [0..*] « Library »If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etcasNeeded[x] : DataType [0..1] « boolean|CodeableConcept; null (Strength=Example) SNOMEDCTMedicationAsNeededRea...?? »GoalIndicates a category the goal falls withincategory : CodeableConcept [0..1] « null (Strength=Example)GoalCategory?? »Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding"description : CodeableConcept [1..1] « null (Strength=Example)SNOMEDCTClinicalFindings?? »Identifies the expected level of importance associated with reaching/sustaining the defined goalpriority : CodeableConcept [0..1] « null (Strength=Preferred)GoalPriority? »The event after which the goal should begin being pursuedstart : CodeableConcept [0..1] « null (Strength=Example)GoalStartEvent?? »Identifies problems, conditions, issues, or concerns the goal is intended to addressaddresses : CodeableConcept [0..*] « null (Strength=Example)ConditionProblemDiagnosisCodes?? »Didactic or other informational resources associated with the goal that provide further supporting information about the goal. Information resources can include inline text commentary and links to web resourcesdocumentation : RelatedArtifact [0..*]TargetThe parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c levelmeasure : CodeableConcept [0..1] « null (Strength=Example)LOINCCodes?? »The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low valuedetail[x] : DataType [0..1] « Quantity|Range|CodeableConcept|string| boolean|integer|Ratio »Indicates the timeframe after the start of the goal in which the goal should be metdue : Duration [0..1]ActorA descriptive label for the actortitle : string [0..1]A description of how the actor fits into the overall actions of the plan definitiondescription : markdown [0..1]OptionThe type of participant in the actiontype : code [0..1] « null (Strength=Required)ActionParticipantType! »The type of participant in the actiontypeCanonical : canonical [0..1] « CapabilityStatement »The type of participant in the actiontypeReference : Reference [0..1] « CareTeam|Device|DeviceDefinition| Endpoint|Group|HealthcareService|Location|Organization|Patient| Practitioner|PractitionerRole|RelatedPerson »The role the participant should play in performing the described actionrole : CodeableConcept [0..1] « null (Strength=Example)ActionParticipantRole?? »ActionAn identifier that is unique within the PlanDefinition to allow linkage within the realized CarePlan and/or RequestOrchestrationlinkId : string [0..1]A user-visible prefix for the action. For example a section or item numbering such as 1. or Aprefix : string [0..1]The textual description of the action displayed to a user. For example, when the action is a test to be performed, the title would be the title of the test such as Assay by HPLCtitle : string [0..1]A brief description of the action used to provide a summary to display to the userdescription : markdown [0..1]A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamicallytextEquivalent : markdown [0..1]Indicates how quickly the action should be addressed with respect to other actionspriority : code [0..1] « null (Strength=Required)RequestPriority! »A code that provides a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical propertycode : CodeableConcept [0..1] « null (Strength=Example)ActionCode?? »A description of why this action is necessary or appropriatereason : CodeableConcept [0..*] « null (Strength=Example)ActionReasonCode?? »Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resourcesdocumentation : RelatedArtifact [0..*]Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the actiongoalId : id [0..*] « This element has or is affected by some invariantsC »A code, group definition, or canonical reference that describes the intended subject of the action and its children, if any. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resourcesubject[x] : DataType [0..1] « CodeableConcept|Reference(Group)| canonical; null (Strength=Extensible)ParticipantResourceTypes+ »A description of when the action should be triggered. When multiple triggers are specified on an action, any triggering event invokes the actiontrigger : TriggerDefinition [0..*]An optional value describing when the action should be performedtiming[x] : DataType [0..1] « Age|Duration|Range|Timing »Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etclocation : CodeableReference [0..1] « Location »The type of action to perform (create, update, remove)type : CodeableConcept [0..1] « null (Strength=Extensible)ActionType+ »Defines the grouping behavior for the action and its childrengroupingBehavior : code [0..1] « null (Strength=Required)ActionGroupingBehavior! »Defines the selection behavior for the action and its childrenselectionBehavior : code [0..1] « null (Strength=Required)ActionSelectionBehavior! »Defines the required behavior for the actionrequiredBehavior : code [0..1] « null (Strength=Required)ActionRequiredBehavior! »Defines whether the action should usually be preselectedprecheckBehavior : code [0..1] « null (Strength=Required)ActionPrecheckBehavior! »Defines whether the action can be selected multiple timescardinalityBehavior : code [0..1] « null (Strength=Required)ActionCardinalityBehavior! »A reference to an ActivityDefinition that describes the action to be taken in detail, a MessageDefinition describing a message to be snet, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captureddefinition[x] : PrimitiveType [0..1] « canonical(ActivityDefinition| MessageDefinition|ObservationDefinition|PlanDefinition| Questionnaire|SpecimenDefinition)|uri »A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the inputtransform : canonical [0..1] « StructureMap »ConditionThe kind of conditionkind : code [1..1] « null (Strength=Required)ActionConditionKind! »An expression that returns true or false, indicating whether the condition is satisfiedexpression : Expression [0..1]InputA human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readerstitle : string [0..1]Defines the data that is to be provided as input to the actionrequirement : DataRequirement [0..1] « This element has or is affected by some invariantsC »Points to an existing input or output element that provides data to this inputrelatedData : id [0..1] « This element has or is affected by some invariantsC »OutputA human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readerstitle : string [0..1]Defines the data that results as output from the actionrequirement : DataRequirement [0..1] « This element has or is affected by some invariantsC »Points to an existing input or output element that is results as output from the actionrelatedData : string [0..1] « This element has or is affected by some invariantsC »RelatedActionThe element id of the target related actiontargetId : id [1..1] « This element has or is affected by some invariantsC »The relationship of the start of this action to the related actionrelationship : code [1..1] « null (Strength=Required)ActionRelationshipType! »The relationship of the end of this action to the related actionendRelationship : code [0..1] « null (Strength=Required)ActionRelationshipType! »A duration or range of durations to apply to the relationship. For example, 30-60 minutes beforeoffset[x] : DataType [0..1] « Duration|Range »ParticipantA reference to the id element of the actor who will participate in this actionactorId : string [0..1]The type of participant in the actiontype : code [0..1] « null (Strength=Required)ActionParticipantType! »The type of participant in the actiontypeCanonical : canonical [0..1] « CapabilityStatement »The type of participant in the actiontypeReference : Reference [0..1] « CareTeam|Device|DeviceDefinition| Endpoint|Group|HealthcareService|Location|Organization|Patient| Practitioner|PractitionerRole|RelatedPerson »The role the participant should play in performing the described actionrole : CodeableConcept [0..1] « null (Strength=Example)ActionParticipantRole?? »Indicates how the actor will be involved in the action - author, reviewer, witness, etcfunction : CodeableConcept [0..1] « null (Strength=Example)ActionParticipantFunction?? »DynamicValueThe path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolvable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details)path : string [0..1]An expression specifying the value of the customized elementexpression : Expression [0..1]Indicates what should be done and within what timeframetarget[0..*]A goal describes an expected outcome that activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, meeting the acceptance criteria for a test as specified by a quality specification, etcgoal[0..*]The characteristics of the candidates that could serve as the actoroption[1..*]Actors represent the individuals or groups involved in the execution of the defined set of activitiesactor[0..*]An expression that describes applicability criteria or start/stop conditions for the actioncondition[0..*]Defines input data requirements for the actioninput[0..*]Defines the outputs of the action, if anyoutput[0..*]A relationship to another action such as "before" or "30-60 minutes after start of"relatedAction[0..*]Indicates who should participate in performing the action describedparticipant[0..*]Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the resultdynamicValue[0..*]Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definitionaction[0..*]An action or group of actions to be taken as part of the plan. For example, in clinical care, an action would be to prescribe a particular indicated medication, or perform a particular test as appropriate. In pharmaceutical quality, an action would be the test that needs to be performed on a drug product as defined in the quality specificationaction[0..*]

XML Template

<PlanDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this plan definition, represented as a URI (globally unique) -->
 <identifier><!-- 0..* Identifier Additional identifier for the plan definition --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the plan definition -->
 <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]>
 <name value="[string]"/><!-- I 0..1 Name for this plan definition (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this plan definition (human friendly) -->
 <subtitle value="[string]"/><!-- 0..1 Subordinate title of the plan definition -->
 <type><!-- 0..1 CodeableConcept order-set | clinical-protocol | eca-rule | workflow-definition --></type>
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <subject[x]><!-- 0..1 CodeableConcept|Reference(AdministrableProductDefinition|
   Group|ManufacturedItemDefinition|MedicinalProductDefinition|
   PackagedProductDefinition|SubstanceDefinition)|canonical(EvidenceVariable) Type of individual the plan definition is focused on --></subject[x]>
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the plan definition -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for plan definition (if applicable) --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this plan definition is defined -->
 <usage value="[markdown]"/><!-- 0..1 Describes the clinical usage of the plan -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) -->
 <approvalDate value="[date]"/><!-- 0..1 When the plan definition was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the plan definition was last reviewed by the publisher -->
 <effectivePeriod><!-- 0..1 Period When the plan definition is expected to be used --></effectivePeriod>
 <topic><!-- 0..* CodeableConcept E.g. Education, Treatment, Assessment --></topic>
 <author><!-- 0..* ContactDetail Who authored the content --></author>
 <editor><!-- 0..* ContactDetail Who edited the content --></editor>
 <reviewer><!-- 0..* ContactDetail Who reviewed the content --></reviewer>
 <endorser><!-- 0..* ContactDetail Who endorsed the content --></endorser>
 <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations --></relatedArtifact>
 <library><!-- 0..* canonical(Library) Logic used by the plan definition --></library>
 <goal>  <!-- I 0..* What the plan is trying to accomplish -->
  <category><!-- 0..1 CodeableConcept E.g. Treatment, dietary, behavioral --></category>
  <description><!-- 1..1 CodeableConcept Code or text describing the goal --></description>
  <priority><!-- 0..1 CodeableConcept high-priority | medium-priority | low-priority --></priority>
  <start><!-- 0..1 CodeableConcept When goal pursuit begins --></start>
  <addresses><!-- 0..* CodeableConcept What does the goal address --></addresses>
  <documentation><!-- 0..* RelatedArtifact Supporting documentation for the goal --></documentation>
  <target>  <!-- 0..* Target outcome for the goal -->
   <measure><!-- 0..1 CodeableConcept The parameter whose value is to be tracked --></measure>
   <detail[x]><!-- 0..1 Quantity|Range|CodeableConcept|string|boolean|integer|
     Ratio The target value to be achieved --></detail[x]>
   <due><!-- 0..1 Duration Reach goal within --></due>
  </target>
 </goal>
 <actor>  <!-- 0..* Actors within the plan -->
  <title value="[string]"/><!-- 0..1 User-visible title -->
  <description value="[markdown]"/><!-- 0..1 Describes the actor -->
  <option>  <!-- 1..* Who or what can be this actor -->
   <type value="[code]"/><!-- 0..1 careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson -->
   <typeCanonical><!-- 0..1 canonical(CapabilityStatement) Who or what can participate --></typeCanonical>
   <typeReference><!-- 0..1 Reference(CareTeam|Device|DeviceDefinition|Endpoint|
     Group|HealthcareService|Location|Organization|Patient|Practitioner|
     PractitionerRole|RelatedPerson) Who or what can participate --></typeReference>
   <role><!-- 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent icon --></role>
  </option>
 </actor>
 <action>  <!-- I 0..* Action defined by the plan -->
  <linkId value="[string]"/><!-- 0..1 Unique id for the action in the PlanDefinition -->
  <prefix value="[string]"/><!-- 0..1 User-visible prefix for the action (e.g. 1. or A.) -->
  <title value="[string]"/><!-- 0..1 User-visible title -->
  <description value="[markdown]"/><!-- 0..1 Brief description of the action -->
  <textEquivalent value="[markdown]"/><!-- 0..1 Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system -->
  <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat -->
  <code><!-- 0..1 CodeableConcept Code representing the meaning of the action or sub-actions --></code>
  <reason><!-- 0..* CodeableConcept Why the action should be performed --></reason>
  <documentation><!-- 0..* RelatedArtifact Supporting documentation for the intended performer of the action --></documentation>
  <goalId value="[id]"/><!-- I 0..* What goals this action supports -->
  <subject[x]><!-- 0..1 CodeableConcept|Reference(Group)|canonical Type of individual the action is focused on --></subject[x]>
  <trigger><!-- 0..* TriggerDefinition When the action should be triggered --></trigger>
  <condition>  <!-- 0..* Whether or not the action is applicable -->
   <kind value="[code]"/><!-- 1..1 applicability | start | stop -->
   <expression><!-- 0..1 Expression Boolean-valued expression --></expression>
  </condition>
  <input>  <!-- 0..* Input data requirements -->
   <title value="[string]"/><!-- 0..1 User-visible title -->
   <requirement><!-- I 0..1 DataRequirement What data is provided --></requirement>
   <relatedData value="[id]"/><!-- I 0..1 What data is provided -->
  </input>
  <output>  <!-- 0..* Output data definition -->
   <title value="[string]"/><!-- 0..1 User-visible title -->
   <requirement><!-- I 0..1 DataRequirement What data is provided --></requirement>
   <relatedData value="[string]"/><!-- I 0..1 What data is provided -->
  </output>
  <relatedAction>  <!-- I 0..* Relationship to another action -->
   <targetId value="[id]"/><!-- I 1..1 What action is this related to -->
   <relationship value="[code]"/><!-- 1..1 before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end -->
   <endRelationship value="[code]"/><!-- 0..1 before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end -->
   <offset[x]><!-- 0..1 Duration|Range Time offset for the relationship --></offset[x]>
  </relatedAction>
  <timing[x]><!-- 0..1 Age|Duration|Range|Timing When the action should take place --></timing[x]>
  <location><!-- 0..1 CodeableReference(Location) Where it should happen --></location>
  <participant>  <!-- 0..* Who should participate in the action -->
   <actorId value="[string]"/><!-- 0..1 What actor -->
   <type value="[code]"/><!-- 0..1 careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson -->
   <typeCanonical><!-- 0..1 canonical(CapabilityStatement) Who or what can participate --></typeCanonical>
   <typeReference><!-- 0..1 Reference(CareTeam|Device|DeviceDefinition|Endpoint|
     Group|HealthcareService|Location|Organization|Patient|Practitioner|
     PractitionerRole|RelatedPerson) Who or what can participate --></typeReference>
   <role><!-- 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent icon --></role>
   <function><!-- 0..1 CodeableConcept E.g. Author, Reviewer, Witness, etc --></function>
  </participant>
  <type><!-- 0..1 CodeableConcept create | update | remove | fire-event --></type>
  <groupingBehavior value="[code]"/><!-- 0..1 visual-group | logical-group | sentence-group -->
  <selectionBehavior value="[code]"/><!-- 0..1 any | all | all-or-none | exactly-one | at-most-one | one-or-more -->
  <requiredBehavior value="[code]"/><!-- 0..1 must | could | must-unless-documented -->
  <precheckBehavior value="[code]"/><!-- 0..1 yes | no -->
  <cardinalityBehavior value="[code]"/><!-- 0..1 single | multiple -->
  <definition[x]><!-- 0..1 canonical(ActivityDefinition|MessageDefinition|
    ObservationDefinition|PlanDefinition|Questionnaire|SpecimenDefinition)|uri Description of the activity to be performed --></definition[x]>
  <transform><!-- 0..1 canonical(StructureMap) Transform to apply the template --></transform>
  <dynamicValue>  <!-- 0..* Dynamic aspects of the definition -->
   <path value="[string]"/><!-- 0..1 The path to the element to be set dynamically -->
   <expression><!-- 0..1 Expression An expression that provides the dynamic value for the customization --></expression>
  </dynamicValue>
  <action><!-- 0..* Content as for PlanDefinition.action A sub-action --></action>
 </action>
 <asNeeded[x]><!-- 0..1 boolean|CodeableConcept Preconditions for service --></asNeeded[x]>
</PlanDefinition>

JSON Template

{doco
  "resourceType" : "PlanDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this plan definition, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the plan definition
  "version" : "<string>", // Business version of the plan definition
  // versionAlgorithm[x]: How to compare versions. One of these 2:
  "versionAlgorithmString" : "<string>",
  "versionAlgorithmCoding" : { Coding },
  "name" : "<string>", // I Name for this plan definition (computer friendly)
  "title" : "<string>", // Name for this plan definition (human friendly)
  "subtitle" : "<string>", // Subordinate title of the plan definition
  "type" : { CodeableConcept }, // order-set | clinical-protocol | eca-rule | workflow-definition
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  // subject[x]: Type of individual the plan definition is focused on. One of these 3:
  "subjectCodeableConcept" : { CodeableConcept },
  "subjectReference" : { Reference(AdministrableProductDefinition|Group|
   ManufacturedItemDefinition|MedicinalProductDefinition|
   PackagedProductDefinition|SubstanceDefinition) },
  "subjectCanonical" : "<canonical(EvidenceVariable)>",
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher/steward (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the plan definition
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for plan definition (if applicable)
  "purpose" : "<markdown>", // Why this plan definition is defined
  "usage" : "<markdown>", // Describes the clinical usage of the plan
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "copyrightLabel" : "<string>", // Copyright holder and year(s)
  "approvalDate" : "<date>", // When the plan definition was approved by publisher
  "lastReviewDate" : "<date>", // When the plan definition was last reviewed by the publisher
  "effectivePeriod" : { Period }, // When the plan definition is expected to be used
  "topic" : [{ CodeableConcept }], // E.g. Education, Treatment, Assessment
  "author" : [{ ContactDetail }], // Who authored the content
  "editor" : [{ ContactDetail }], // Who edited the content
  "reviewer" : [{ ContactDetail }], // Who reviewed the content
  "endorser" : [{ ContactDetail }], // Who endorsed the content
  "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations
  "library" : ["<canonical(Library)>"], // Logic used by the plan definition
  "goal" : [{ // I What the plan is trying to accomplish
    "category" : { CodeableConcept }, // E.g. Treatment, dietary, behavioral
    "description" : { CodeableConcept }, // R!  Code or text describing the goal
    "priority" : { CodeableConcept }, // high-priority | medium-priority | low-priority
    "start" : { CodeableConcept }, // When goal pursuit begins
    "addresses" : [{ CodeableConcept }], // What does the goal address
    "documentation" : [{ RelatedArtifact }], // Supporting documentation for the goal
    "target" : [{ // Target outcome for the goal
      "measure" : { CodeableConcept }, // The parameter whose value is to be tracked
      // detail[x]: The target value to be achieved. One of these 7:
      "detailQuantity" : { Quantity },
      "detailRange" : { Range },
      "detailCodeableConcept" : { CodeableConcept },
      "detailString" : "<string>",
      "detailBoolean" : <boolean>,
      "detailInteger" : <integer>,
      "detailRatio" : { Ratio },
      "due" : { Duration } // Reach goal within
    }]
  }],
  "actor" : [{ // Actors within the plan
    "title" : "<string>", // User-visible title
    "description" : "<markdown>", // Describes the actor
    "option" : [{ // R!  Who or what can be this actor
      "type" : "<code>", // careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
      "typeCanonical" : "<canonical(CapabilityStatement)>", // Who or what can participate
      "typeReference" : { Reference(CareTeam|Device|DeviceDefinition|Endpoint|
     Group|HealthcareService|Location|Organization|Patient|Practitioner|
     PractitionerRole|RelatedPerson) }, // Who or what can participate
      "role" : { CodeableConcept } // E.g. Nurse, Surgeon, Parent icon
    }]
  }],
  "action" : [{ // I Action defined by the plan
    "linkId" : "<string>", // Unique id for the action in the PlanDefinition
    "prefix" : "<string>", // User-visible prefix for the action (e.g. 1. or A.)
    "title" : "<string>", // User-visible title
    "description" : "<markdown>", // Brief description of the action
    "textEquivalent" : "<markdown>", // Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
    "priority" : "<code>", // routine | urgent | asap | stat
    "code" : { CodeableConcept }, // Code representing the meaning of the action or sub-actions
    "reason" : [{ CodeableConcept }], // Why the action should be performed
    "documentation" : [{ RelatedArtifact }], // Supporting documentation for the intended performer of the action
    "goalId" : ["<id>"], // I What goals this action supports
    // subject[x]: Type of individual the action is focused on. One of these 3:
    "subjectCodeableConcept" : { CodeableConcept },
    "subjectReference" : { Reference(Group) },
    "subjectCanonical" : "<canonical>",
    "trigger" : [{ TriggerDefinition }], // When the action should be triggered
    "condition" : [{ // Whether or not the action is applicable
      "kind" : "<code>", // R!  applicability | start | stop
      "expression" : { Expression } // Boolean-valued expression
    }],
    "input" : [{ // Input data requirements
      "title" : "<string>", // User-visible title
      "requirement" : { DataRequirement }, // I What data is provided
      "relatedData" : "<id>" // I What data is provided
    }],
    "output" : [{ // Output data definition
      "title" : "<string>", // User-visible title
      "requirement" : { DataRequirement }, // I What data is provided
      "relatedData" : "<string>" // I What data is provided
    }],
    "relatedAction" : [{ // I Relationship to another action
      "targetId" : "<id>", // I R!  What action is this related to
      "relationship" : "<code>", // R!  before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
      "endRelationship" : "<code>", // before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
      // offset[x]: Time offset for the relationship. One of these 2:
      "offsetDuration" : { Duration },
      "offsetRange" : { Range }
    }],
    // timing[x]: When the action should take place. One of these 4:
    "timingAge" : { Age },
    "timingDuration" : { Duration },
    "timingRange" : { Range },
    "timingTiming" : { Timing },
    "location" : { CodeableReference(Location) }, // Where it should happen
    "participant" : [{ // Who should participate in the action
      "actorId" : "<string>", // What actor
      "type" : "<code>", // careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
      "typeCanonical" : "<canonical(CapabilityStatement)>", // Who or what can participate
      "typeReference" : { Reference(CareTeam|Device|DeviceDefinition|Endpoint|
     Group|HealthcareService|Location|Organization|Patient|Practitioner|
     PractitionerRole|RelatedPerson) }, // Who or what can participate
      "role" : { CodeableConcept }, // E.g. Nurse, Surgeon, Parent icon
      "function" : { CodeableConcept } // E.g. Author, Reviewer, Witness, etc
    }],
    "type" : { CodeableConcept }, // create | update | remove | fire-event
    "groupingBehavior" : "<code>", // visual-group | logical-group | sentence-group
    "selectionBehavior" : "<code>", // any | all | all-or-none | exactly-one | at-most-one | one-or-more
    "requiredBehavior" : "<code>", // must | could | must-unless-documented
    "precheckBehavior" : "<code>", // yes | no
    "cardinalityBehavior" : "<code>", // single | multiple
    // definition[x]: Description of the activity to be performed. One of these 2:
    "definitionCanonical" : "<canonical(ActivityDefinition|MessageDefinition|ObservationDefinition|PlanDefinition|Questionnaire|SpecimenDefinition)>",
    "definitionUri" : "<uri>",
    "transform" : "<canonical(StructureMap)>", // Transform to apply the template
    "dynamicValue" : [{ // Dynamic aspects of the definition
      "path" : "<string>", // The path to the element to be set dynamically
      "expression" : { Expression } // An expression that provides the dynamic value for the customization
    }],
    "action" : [{ Content as for PlanDefinition.action }] // A sub-action
  }],
  // asNeeded[x]: Preconditions for service. One of these 2:
  "asNeededBoolean" : <boolean>,
  "asNeededCodeableConcept" : { CodeableConcept }
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:PlanDefinition;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:url [ uri ] ; # 0..1 Canonical identifier for this plan definition, represented as a URI (globally unique)
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Additional identifier for the plan definition
  fhir:version [ string ] ; # 0..1 Business version of the plan definition
  # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2
    fhir:versionAlgorithm [  a fhir:string ; string ]
    fhir:versionAlgorithm [  a fhir:Coding ; Coding ]
  fhir:name [ string ] ; # 0..1 I Name for this plan definition (computer friendly)
  fhir:title [ string ] ; # 0..1 Name for this plan definition (human friendly)
  fhir:subtitle [ string ] ; # 0..1 Subordinate title of the plan definition
  fhir:type [ CodeableConcept ] ; # 0..1 order-set | clinical-protocol | eca-rule | workflow-definition
  fhir:status [ code ] ; # 1..1 draft | active | retired | unknown
  fhir:experimental [ boolean ] ; # 0..1 For testing purposes, not real usage
  # subject[x] : 0..1 Type of individual the plan definition is focused on. One of these 3
    fhir:subject [  a fhir:CodeableConcept ; CodeableConcept ]
    fhir:subject [  a fhir:Reference ; Reference(AdministrableProductDefinition|Group|ManufacturedItemDefinition|
  MedicinalProductDefinition|PackagedProductDefinition|SubstanceDefinition) ]
    fhir:subject [  a fhir:canonical ; canonical(EvidenceVariable) ]
  fhir:date [ dateTime ] ; # 0..1 Date last changed
  fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual)
  fhir:contact  ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher
  fhir:description [ markdown ] ; # 0..1 Natural language description of the plan definition
  fhir:useContext  ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support
  fhir:jurisdiction  ( [ CodeableConcept ] ... ) ; # 0..* Intended jurisdiction for plan definition (if applicable)
  fhir:purpose [ markdown ] ; # 0..1 Why this plan definition is defined
  fhir:usage [ markdown ] ; # 0..1 Describes the clinical usage of the plan
  fhir:copyright [ markdown ] ; # 0..1 Use and/or publishing restrictions
  fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s)
  fhir:approvalDate [ date ] ; # 0..1 When the plan definition was approved by publisher
  fhir:lastReviewDate [ date ] ; # 0..1 When the plan definition was last reviewed by the publisher
  fhir:effectivePeriod [ Period ] ; # 0..1 When the plan definition is expected to be used
  fhir:topic  ( [ CodeableConcept ] ... ) ; # 0..* E.g. Education, Treatment, Assessment
  fhir:author  ( [ ContactDetail ] ... ) ; # 0..* Who authored the content
  fhir:editor  ( [ ContactDetail ] ... ) ; # 0..* Who edited the content
  fhir:reviewer  ( [ ContactDetail ] ... ) ; # 0..* Who reviewed the content
  fhir:endorser  ( [ ContactDetail ] ... ) ; # 0..* Who endorsed the content
  fhir:relatedArtifact  ( [ RelatedArtifact ] ... ) ; # 0..* Additional documentation, citations
  fhir:library  ( [ canonical(Library) ] ... ) ; # 0..* Logic used by the plan definition
  fhir:goal ( [ # 0..* I What the plan is trying to accomplish
    fhir:category [ CodeableConcept ] ; # 0..1 E.g. Treatment, dietary, behavioral
    fhir:description [ CodeableConcept ] ; # 1..1 Code or text describing the goal
    fhir:priority [ CodeableConcept ] ; # 0..1 high-priority | medium-priority | low-priority
    fhir:start [ CodeableConcept ] ; # 0..1 When goal pursuit begins
    fhir:addresses  ( [ CodeableConcept ] ... ) ; # 0..* What does the goal address
    fhir:documentation  ( [ RelatedArtifact ] ... ) ; # 0..* Supporting documentation for the goal
    fhir:target ( [ # 0..* Target outcome for the goal
      fhir:measure [ CodeableConcept ] ; # 0..1 The parameter whose value is to be tracked
      # detail[x] : 0..1 The target value to be achieved. One of these 7
        fhir:detail [  a fhir:Quantity ; Quantity ]
        fhir:detail [  a fhir:Range ; Range ]
        fhir:detail [  a fhir:CodeableConcept ; CodeableConcept ]
        fhir: