Release 4
This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Clinical Decision Support Work Group   Maturity Level : 1 Trial Use Use Context : Any

The official URL for this profile is:

http://hl7.org/fhir/StructureDefinition/shareableplandefinition

Enforces the minimum information set for the plan definition metadata required by HL7 and other organizations that share and publish plan definitions

This profile was published on [no date] as a draft by HL7.

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

This structure is derived from PlanDefinition .

Summary

Mandatory: 6 elements
Must-Support: 6 elements

Name Flags Card. Type Description & Constraints doco
. . PlanDefinition I 1..1 PlanDefinition The definition of a plan for a series of actions, independent of any specific patient or context
. . . id Σ 0..1 string id Logical id of this artifact
. . . meta Σ I 0..1 Meta Metadata about the resource
. . . implicitRules ?! Σ I 0..1 uri A set of rules under which this content was created
. . . language I 0..1 code Language of the resource content
Binding: Common Languages ( preferred )
Max Binding: All Languages
. . . text I 0..1 Narrative Text summary of the resource, for human interpretation
. . . contained 0..* Resource Contained, inline Resources
. . . extension I 0..* Extension Additional content defined by implementations
. . . modifierExtension ?! I 0..* Extension Extensions that cannot be ignored
. . . url Σ I 1..1 uri Canonical identifier for this plan definition, represented as a URI (globally unique)
. . . identifier S Σ I 0..* Identifier Additional identifier for the plan definition
. . . version Σ I 1..1 string Business version of the plan definition
. . . name Σ I 1..1 string Name for this plan definition (computer friendly)
. . . title S Σ I 0..1 string Name for this plan definition (human friendly)
. . . subtitle I 0..1 string Subordinate title of the plan definition
. . . type Σ I 0..1 CodeableConcept order-set | clinical-protocol | eca-rule | workflow-definition
Binding: PlanDefinitionType ( extensible )
. . . status ?! Σ I 1..1 code draft | active | retired | unknown
Binding: PublicationStatus ( required )
. . . experimental Σ I 1..1 boolean For testing purposes, not real usage
. . . subject[x] I 0..1 Type of individual the plan definition is focused on
Binding: Subject type ( extensible )
. . . . subjectCodeableConcept CodeableConcept
. . . . subjectReference Reference (group.html) ( Group )
. . . date S Σ I 0..1 dateTime Date last changed
. . . publisher Σ I 1..1 string Name of the publisher (organization or individual)
. . . contact S Σ I 0..* ContactDetail Contact details for the publisher
. . . description Σ I 1..1 markdown Natural language description of the plan definition
. . . useContext S Σ I 0..* UsageContext The context that the content is intended to support
. . . jurisdiction S Σ I 0..* CodeableConcept Intended jurisdiction for plan definition (if applicable)
Binding: Jurisdiction ( extensible )
. . . purpose I 0..1 markdown Why this plan definition is defined
. . . usage I 0..1 string Describes the clinical usage of the plan
. . . copyright I 0..1 markdown Use and/or publishing restrictions
. . . approvalDate I 0..1 date When the plan definition was approved by publisher
. . . lastReviewDate I 0..1 date When the plan definition was last reviewed
. . . effectivePeriod Σ I 0..1 Period When the plan definition is expected to be used
. . . topic I 0..* CodeableConcept E.g. Education, Treatment, Assessment
Binding: DefinitionTopic ( example )
. . . author I 0..* ContactDetail Who authored the content
. . . editor I 0..* ContactDetail Who edited the content
. . . reviewer I 0..* ContactDetail Who reviewed the content
. . . endorser I 0..* ContactDetail Who endorsed the content
. . . relatedArtifact I 0..* RelatedArtifact Additional documentation, citations
. . . library I 0..* canonical ( Library ) Logic used by the plan definition
. . . goal I 0..* BackboneElement What the plan is trying to accomplish
. . . . id 0..1 string id Unique id for inter-element referencing
. . . . extension I 0..* Extension Additional content defined by implementations
. . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . category I 0..1 CodeableConcept E.g. Treatment, dietary, behavioral
Binding: Goal category ( example )
. . . . description I 1..1 CodeableConcept Code or text describing the goal
Binding: SNOMED CT Clinical Findings ( example )
. . . . priority I 0..1 CodeableConcept high-priority | medium-priority | low-priority
Binding: Goal priority ( preferred )
. . . . start I 0..1 CodeableConcept When goal pursuit begins
Binding: Goal start event ( example )
. . . . addresses I 0..* CodeableConcept What does the goal address
Binding: Condition/Problem/Diagnosis Codes ( example )
. . . . documentation I 0..* RelatedArtifact Supporting documentation for the goal
. . . . target I 0..* BackboneElement Target outcome for the goal
. . . . . id 0..1 string id Unique id for inter-element referencing
. . . . . extension I 0..* Extension Additional content defined by implementations
. . . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . . measure I 0..1 CodeableConcept The parameter whose value is to be tracked
Binding: LOINC Codes ( example )
. . . . . detail[x] I 0..1 The target value to be achieved
. . . . . . detailQuantity Quantity
. . . . . . detailRange Range
. . . . . . detailCodeableConcept CodeableConcept
. . . . . due I 0..1 Duration Reach goal within
. . . action I 0..* BackboneElement Action defined by the plan
. . . . id 0..1 string id Unique id for inter-element referencing
. . . . extension I 0..* Extension Additional content defined by implementations
. . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . prefix I 0..1 string User-visible prefix for the action (e.g. 1. or A.)
. . . . title I 0..1 string User-visible title
. . . . description I 0..1 string Brief description of the action
. . . . textEquivalent I 0..1 string Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
. . . . priority I 0..1 code routine | urgent | asap | stat
Binding: Request priority ( required )
. . . . code I 0..* CodeableConcept Code representing the meaning of the action or sub-actions
. . . . reason I 0..* CodeableConcept Why the action should be performed
. . . . documentation I 0..* RelatedArtifact Supporting documentation for the intended performer of the action
. . . . goalId I 0..* id What goals this action supports
. . . . subject[x] I 0..1 Type of individual the action is focused on
Binding: Subject type ( extensible )
. . . . . subjectCodeableConcept CodeableConcept
. . . . . subjectReference Reference (group.html) ( Group )
. . . . trigger I 0..* TriggerDefinition When the action should be triggered
. . . . condition I 0..* BackboneElement Whether or not the action is applicable
. . . . . id 0..1 string id Unique id for inter-element referencing
. . . . . extension I 0..* Extension Additional content defined by implementations
. . . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . . kind I 1..1 code applicability | start | stop
Binding: ActionConditionKind ( required )
. . . . . expression I 0..1 Expression Boolean-valued expression
. . . . input I 0..* DataRequirement Input data requirements
. . . . output I 0..* DataRequirement Output data definition
. . . . relatedAction I 0..* BackboneElement Relationship to another action
. . . . . id 0..1 string id Unique id for inter-element referencing
. . . . . extension I 0..* Extension Additional content defined by implementations
. . . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . . actionId I 1..1 id What action is this related to
. . . . . relationship I 1..1 code before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Binding: ActionRelationshipType ( required )
. . . . . offset[x] I 0..1 Time offset for the relationship
. . . . . . offsetDuration Duration
. . . . . . offsetRange Range
. . . . timing[x] I 0..1 When the action should take place
. . . . . timingDateTime dateTime
. . . . . timingAge Age
. . . . . timingPeriod Period
. . . . . timingDuration Duration
. . . . . timingRange Range
. . . . . timingTiming Timing
. . . . participant I 0..* BackboneElement Who should participate in the action
. . . . . id 0..1 string id Unique id for inter-element referencing
. . . . . extension I 0..* Extension Additional content defined by implementations
. . . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . . type I 1..1 code patient | practitioner | related-person | device
Binding: ActionParticipantType ( required )
. . . . . role I 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent
Binding: Action participant role ( example )
. . . . type I 0..1 CodeableConcept create | update | remove | fire-event
Binding: ActionType ( extensible )
. . . . groupingBehavior I 0..1 code visual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior ( required )
. . . . selectionBehavior I 0..1 code any | all | all-or-none | exactly-one | at-most-one | one-or-more
Binding: ActionSelectionBehavior ( required )
. . . . requiredBehavior I 0..1 code must | could | must-unless-documented
Binding: ActionRequiredBehavior ( required )
. . . . precheckBehavior I 0..1 code yes | no
Binding: ActionPrecheckBehavior ( required )
. . . . cardinalityBehavior I 0..1 code single | multiple
Binding: ActionCardinalityBehavior ( required )
. . . . definition[x] I 0..1 Description of the activity to be performed
. . . . . definitionCanonical canonical (activitydefinition.html ( ActivityDefinition | plandefinition.html PlanDefinition | questionnaire.html) Questionnaire )
. . . . . definitionUri uri
. . . . transform I 0..1 canonical ( StructureMap ) Transform to apply the template
. . . . dynamicValue I 0..* BackboneElement Dynamic aspects of the definition
. . . . . id 0..1 string id Unique id for inter-element referencing
. . . . . extension I 0..* Extension Additional content defined by implementations
. . . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . . path I 0..1 string The path to the element to be set dynamically
. . . . . expression I 0..1 Expression An expression that provides the dynamic value for the customization
. . . . action I 0..* Unknown reference to #PlanDefinition.action
A sub-action

doco Documentation for this format
<!-- Shareable PlanDefinition -->doco
<PlanDefinition xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <</id>

 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->

 <meta><!-- ?? 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- ?? 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- ?? 0..1 Language of the resource content   -->
 <text><!-- ?? 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <url value="[uri]"/><!-- ?? 1..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]"/><!-- ?? 1..1 Business version of the plan definition -->
 <name value="[string]"/><!-- ?? 1..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]"/><!-- ?? 1..1 For testing purposes, not real usage -->
 <subject[x]><!-- ?? 0..1 CodeableConcept|Reference(Group) Type of individual the plan definition is focused on   --></subject[x]>
 <date value="[dateTime]"/><!-- ?? 0..1 Date last changed -->
 <publisher value="[string]"/><!-- ?? 1..1 Name of the publisher (organization or individual) -->
 <contact><!-- ?? 0..* ContactDetail 
     Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- ?? 1..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="[string]"/><!-- ?? 0..1 Describes the clinical usage of the plan -->
 <copyright value="[markdown]"/><!-- ?? 0..1 Use and/or publishing restrictions -->
 <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 -->
 <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 value="[canonical]"/><!-- ?? 0..* Logic used by the plan definition -->
 <

 <goal> ?? 0..* BackboneElement  <!-- ?? 0..* What the plan is trying to accomplish -->

  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <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..* BackboneElement  <!-- ?? 0..* Target outcome for the goal -->

   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <measure><!-- ?? 0..1 CodeableConcept The parameter whose value is to be tracked   --></measure>
   <detail[x]><!-- ?? 0..1 Quantity|Range|
     CodeableConcept The target value to be achieved --></detail[x]>
   <due><!-- ?? 0..1 Duration 
       Reach goal within --></due>
  </target>
 </goal>
 <

 <action> ?? 0..* BackboneElement  <!-- ?? 0..* Action defined by the plan -->

  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <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="[string]"/><!-- ?? 0..1 Brief description of the action -->
  <textEquivalent value="[string]"/><!-- ?? 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..* 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]"/><!-- ?? 0..* What goals this action supports -->
  <subject[x]><!-- ?? 0..1 CodeableConcept|Reference(Group) Type of individual the action is focused on   --></subject[x]>
  <trigger><!-- ?? 0..* TriggerDefinition 
      When the action should be triggered --></trigger>
  <

  <condition> ?? 0..* BackboneElement  <!-- ?? 0..* Whether or not the action is applicable -->

   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <kind value="[code]"/><!-- ?? 1..1 applicability | start | stop   -->
   <expression><!-- ?? 0..1 Expression 
       Boolean-valued expression --></expression>
  </condition>
  <input><!-- ?? 0..* DataRequirement 
      Input data requirements --></input>
  <output><!-- ?? 0..* DataRequirement 
      Output data definition --></output>
  <

  <relatedAction> ?? 0..* BackboneElement  <!-- ?? 0..* Relationship to another action -->

   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <actionId value="[id]"/><!-- ?? 1..1 What action is this related to -->
   <relationship value="[code]"/><!-- ?? 1..1 before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end   -->
   <offset[x]><!-- ?? 0..1 Duration|Range 
       Time offset for the relationship --></offset[x]>
  </relatedAction>
  <timing[x]><!-- ?? 0..1 dateTime|Age|Period|Duration|Range|
    Timing When the action should take place --></timing[x]>
  <

  <participant> ?? 0..* BackboneElement  <!-- ?? 0..* Who should participate in the action -->

   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <type value="[code]"/><!-- ?? 1..1 patient | practitioner | related-person | device   -->
   <role><!-- ?? 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent   --></role>
  </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|uri 
      Description of the activity to be performed --></definition[x]>
  <transform value="[canonical]"/><!-- ?? 0..1 Transform to apply the template -->
  <

  <dynamicValue> ?? 0..* BackboneElement  <!-- ?? 0..* Dynamic aspects of the definition -->

   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <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><!-- See #PlanDefinition.action  A sub-action --></action>
 </action>
</PlanDefinition>
{ // Shareable PlanDefinition
  // from Element: extension
    "meta" : { Meta }, // C?Metadata about the resource
    "implicitRules" : "<uri>", // C?A set of rules under which this content was created
    "language" : "<code>", // C?Language of the resource content
    "text" : { Narrative }, // C?Text summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
    "url" : "<uri>", // C? R! Canonical identifier for this plan definition, represented as a URI (globally unique)
    "identifier" : [{ Identifier }], // C?Additional identifier for the plan definition
    "version" : "<string>", // C? R! Business version of the plan definition
    "name" : "<string>", // C? R! Name for this plan definition (computer friendly)
    "title" : "<string>", // C?Name for this plan definition (human friendly)
    "subtitle" : "<string>", // C?Subordinate title of the plan definition
    "type" : { CodeableConcept }, // C?order-set | clinical-protocol | eca-rule | workflow-definition
    "status" : "<code>", // C? R! draft | active | retired | unknown
    "experimental" : <boolean>, // C? R! For testing purposes, not real usage
// value[x]: Type of individual the plan definition is focused on. One of these 2:
    "subjectCodeableConcept" : { CodeableConcept }, // C?Type of individual the plan definition is focused on
    "subjectReference" : { Reference(Group) }, // C?Type of individual the plan definition is focused on
    "date" : "<dateTime>", // C?Date last changed
    "publisher" : "<string>", // C? R! Name of the publisher (organization or individual)
    "contact" : [{ ContactDetail }], // C?Contact details for the publisher
    "description" : "<markdown>", // C? R! Natural language description of the plan definition
    "useContext" : [{ UsageContext }], // C?The context that the content is intended to support
    "jurisdiction" : [{ CodeableConcept }], // C?Intended jurisdiction for plan definition (if applicable)
    "purpose" : "<markdown>", // C?Why this plan definition is defined
    "usage" : "<string>", // C?Describes the clinical usage of the plan
    "copyright" : "<markdown>", // C?Use and/or publishing restrictions
    "approvalDate" : "<date>", // C?When the plan definition was approved by publisher
    "lastReviewDate" : "<date>", // C?When the plan definition was last reviewed
    "effectivePeriod" : { Period }, // C?When the plan definition is expected to be used
    "topic" : [{ CodeableConcept }], // C?E.g. Education, Treatment, Assessment
    "author" : [{ ContactDetail }], // C?Who authored the content
    "editor" : [{ ContactDetail }], // C?Who edited the content
    "reviewer" : [{ ContactDetail }], // C?Who reviewed the content
    "endorser" : [{ ContactDetail }], // C?Who endorsed the content
    "relatedArtifact" : [{ RelatedArtifact }], // C?Additional documentation, citations
    "library" : ["<canonical>"], // C?Logic used by the plan definition
    "
    "

    "goal" : [{ BackboneElement }] // C?What the plan is trying to accomplish
    "action" : [{ BackboneElement }], // C?Action defined by the plan

  }

This structure is derived from PlanDefinition .

Summary

Mandatory: 6 elements
Must-Support: 6 elements

Snapshot View

Name Flags Card. Type Description & Constraints doco
. . PlanDefinition I 1..1 PlanDefinition The definition of a plan for a series of actions, independent of any specific patient or context
. . . id Σ 0..1 string id Logical id of this artifact
. . . meta Σ I 0..1 Meta Metadata about the resource
. . . implicitRules ?! Σ I 0..1 uri A set of rules under which this content was created
. . . language I 0..1 code Language of the resource content
Binding: Common Languages ( preferred )
Max Binding: All Languages
. . . text I 0..1 Narrative Text summary of the resource, for human interpretation
. . . contained 0..* Resource Contained, inline Resources
. . . extension I 0..* Extension Additional content defined by implementations
. . . modifierExtension ?! I 0..* Extension Extensions that cannot be ignored
. . . url Σ I 1..1 uri Canonical identifier for this plan definition, represented as a URI (globally unique)
. . . identifier S Σ I 0..* Identifier Additional identifier for the plan definition
. . . version Σ I 1..1 string Business version of the plan definition
. . . name Σ I 1..1 string Name for this plan definition (computer friendly)
. . . title S Σ I 0..1 string Name for this plan definition (human friendly)
. . . subtitle I 0..1 string Subordinate title of the plan definition
. . . type Σ I 0..1 CodeableConcept order-set | clinical-protocol | eca-rule | workflow-definition
Binding: PlanDefinitionType ( extensible )
. . . status ?! Σ I 1..1 code draft | active | retired | unknown
Binding: PublicationStatus ( required )
. . . experimental Σ I 1..1 boolean For testing purposes, not real usage
. . . subject[x] I 0..1 Type of individual the plan definition is focused on
Binding: Subject type ( extensible )
. . . . subjectCodeableConcept CodeableConcept
. . . . subjectReference Reference (group.html) ( Group )
. . . date S Σ I 0..1 dateTime Date last changed
. . . publisher Σ I 1..1 string Name of the publisher (organization or individual)
. . . contact S Σ I 0..* ContactDetail Contact details for the publisher
. . . description Σ I 1..1 markdown Natural language description of the plan definition
. . . useContext S Σ I 0..* UsageContext The context that the content is intended to support
. . . jurisdiction S Σ I 0..* CodeableConcept Intended jurisdiction for plan definition (if applicable)
Binding: Jurisdiction ( extensible )
. . . purpose I 0..1 markdown Why this plan definition is defined
. . . usage I 0..1 string Describes the clinical usage of the plan
. . . copyright I 0..1 markdown Use and/or publishing restrictions
. . . approvalDate I 0..1 date When the plan definition was approved by publisher
. . . lastReviewDate I 0..1 date When the plan definition was last reviewed
. . . effectivePeriod Σ I 0..1 Period When the plan definition is expected to be used
. . . topic I 0..* CodeableConcept E.g. Education, Treatment, Assessment
Binding: DefinitionTopic ( example )
. . . author I 0..* ContactDetail Who authored the content
. . . editor I 0..* ContactDetail Who edited the content
. . . reviewer I 0..* ContactDetail Who reviewed the content
. . . endorser I 0..* ContactDetail Who endorsed the content
. . . relatedArtifact I 0..* RelatedArtifact Additional documentation, citations
. . . library I 0..* canonical ( Library ) Logic used by the plan definition
. . . goal I 0..* BackboneElement What the plan is trying to accomplish
. . . . id 0..1 string id Unique id for inter-element referencing
. . . . extension I 0..* Extension Additional content defined by implementations
. . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . category I 0..1 CodeableConcept E.g. Treatment, dietary, behavioral
Binding: Goal category ( example )
. . . . description I 1..1 CodeableConcept Code or text describing the goal
Binding: SNOMED CT Clinical Findings ( example )
. . . . priority I 0..1 CodeableConcept high-priority | medium-priority | low-priority
Binding: Goal priority ( preferred )
. . . . start I 0..1 CodeableConcept When goal pursuit begins
Binding: Goal start event ( example )
. . . . addresses I 0..* CodeableConcept What does the goal address
Binding: Condition/Problem/Diagnosis Codes ( example )
. . . . documentation I 0..* RelatedArtifact Supporting documentation for the goal
. . . . target I 0..* BackboneElement Target outcome for the goal
. . . . . id 0..1 string id Unique id for inter-element referencing
. . . . . extension I 0..* Extension Additional content defined by implementations
. . . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . . measure I 0..1 CodeableConcept The parameter whose value is to be tracked
Binding: LOINC Codes ( example )
. . . . . detail[x] I 0..1 The target value to be achieved
. . . . . . detailQuantity Quantity
. . . . . . detailRange Range
. . . . . . detailCodeableConcept CodeableConcept
. . . . . due I 0..1 Duration Reach goal within
. . . action I 0..* BackboneElement Action defined by the plan
. . . . id 0..1 string id Unique id for inter-element referencing
. . . . extension I 0..* Extension Additional content defined by implementations
. . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . prefix I 0..1 string User-visible prefix for the action (e.g. 1. or A.)
. . . . title I 0..1 string User-visible title
. . . . description I 0..1 string Brief description of the action
. . . . textEquivalent I 0..1 string Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
. . . . priority I 0..1 code routine | urgent | asap | stat
Binding: Request priority ( required )
. . . . code I 0..* CodeableConcept Code representing the meaning of the action or sub-actions
. . . . reason I 0..* CodeableConcept Why the action should be performed
. . . . documentation I 0..* RelatedArtifact Supporting documentation for the intended performer of the action
. . . . goalId I 0..* id What goals this action supports
. . . . subject[x] I 0..1 Type of individual the action is focused on
Binding: Subject type ( extensible )
. . . . . subjectCodeableConcept CodeableConcept
. . . . . subjectReference Reference (group.html) ( Group )
. . . . trigger I 0..* TriggerDefinition When the action should be triggered
. . . . condition I 0..* BackboneElement Whether or not the action is applicable
. . . . . id 0..1 string id Unique id for inter-element referencing
. . . . . extension I 0..* Extension Additional content defined by implementations
. . . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . . kind I 1..1 code applicability | start | stop
Binding: ActionConditionKind ( required )
. . . . . expression I 0..1 Expression Boolean-valued expression
. . . . input I 0..* DataRequirement Input data requirements
. . . . output I 0..* DataRequirement Output data definition
. . . . relatedAction I 0..* BackboneElement Relationship to another action
. . . . . id 0..1 string id Unique id for inter-element referencing
. . . . . extension I 0..* Extension Additional content defined by implementations
. . . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . . actionId I 1..1 id What action is this related to
. . . . . relationship I 1..1 code before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Binding: ActionRelationshipType ( required )
. . . . . offset[x] I 0..1 Time offset for the relationship
. . . . . . offsetDuration Duration
. . . . . . offsetRange Range
. . . . timing[x] I 0..1 When the action should take place
. . . . . timingDateTime dateTime
. . . . . timingAge Age
. . . . . timingPeriod Period
. . . . . timingDuration Duration
. . . . . timingRange Range
. . . . . timingTiming Timing
. . . . participant I 0..* BackboneElement Who should participate in the action
. . . . . id 0..1 string id Unique id for inter-element referencing
. . . . . extension I 0..* Extension Additional content defined by implementations
. . . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . . type I 1..1 code patient | practitioner | related-person | device
Binding: ActionParticipantType ( required )
. . . . . role I 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent
Binding: Action participant role ( example )
. . . . type I 0..1 CodeableConcept create | update | remove | fire-event
Binding: ActionType ( extensible )
. . . . groupingBehavior I 0..1 code visual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior ( required )
. . . . selectionBehavior I 0..1 code any | all | all-or-none | exactly-one | at-most-one | one-or-more
Binding: ActionSelectionBehavior ( required )
. . . . requiredBehavior I 0..1 code must | could | must-unless-documented
Binding: ActionRequiredBehavior ( required )
. . . . precheckBehavior I 0..1 code yes | no
Binding: ActionPrecheckBehavior ( required )
. . . . cardinalityBehavior I 0..1 code single | multiple
Binding: ActionCardinalityBehavior ( required )
. . . . definition[x] I 0..1 Description of the activity to be performed
. . . . . definitionCanonical canonical (activitydefinition.html ( ActivityDefinition | plandefinition.html PlanDefinition | questionnaire.html) Questionnaire )
. . . . . definitionUri uri
. . . . transform I 0..1 canonical ( StructureMap ) Transform to apply the template
. . . . dynamicValue I 0..* BackboneElement Dynamic aspects of the definition
. . . . . id 0..1 string id Unique id for inter-element referencing
. . . . . extension I 0..* Extension Additional content defined by implementations
. . . . . modifierExtension ?! Σ I 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . . path I 0..1 string The path to the element to be set dynamically
. . . . . expression I 0..1 Expression An expression that provides the dynamic value for the customization
. . . . action I 0..* Unknown reference to #PlanDefinition.action
A sub-action

doco Documentation for this format

XML Template

<!-- Shareable PlanDefinition -->doco
<PlanDefinition xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <</id>

 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->

 <meta><!-- ?? 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- ?? 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- ?? 0..1 Language of the resource content   -->
 <text><!-- ?? 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <url value="[uri]"/><!-- ?? 1..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]"/><!-- ?? 1..1 Business version of the plan definition -->
 <name value="[string]"/><!-- ?? 1..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]"/><!-- ?? 1..1 For testing purposes, not real usage -->
 <subject[x]><!-- ?? 0..1 CodeableConcept|Reference(Group) Type of individual the plan definition is focused on   --></subject[x]>
 <date value="[dateTime]"/><!-- ?? 0..1 Date last changed -->
 <publisher value="[string]"/><!-- ?? 1..1 Name of the publisher (organization or individual) -->
 <contact><!-- ?? 0..* ContactDetail 
     Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- ?? 1..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="[string]"/><!-- ?? 0..1 Describes the clinical usage of the plan -->
 <copyright value="[markdown]"/><!-- ?? 0..1 Use and/or publishing restrictions -->
 <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 -->
 <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 value="[canonical]"/><!-- ?? 0..* Logic used by the plan definition -->
 <

 <goal> ?? 0..* BackboneElement  <!-- ?? 0..* What the plan is trying to accomplish -->

  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <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..* BackboneElement  <!-- ?? 0..* Target outcome for the goal -->

   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <measure><!-- ?? 0..1 CodeableConcept The parameter whose value is to be tracked   --></measure>
   <detail[x]><!-- ?? 0..1 Quantity|Range|
     CodeableConcept The target value to be achieved --></detail[x]>
   <due><!-- ?? 0..1 Duration 
       Reach goal within --></due>
  </target>
 </goal>
 <

 <action> ?? 0..* BackboneElement  <!-- ?? 0..* Action defined by the plan -->

  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <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="[string]"/><!-- ?? 0..1 Brief description of the action -->
  <textEquivalent value="[string]"/><!-- ?? 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..* 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]"/><!-- ?? 0..* What goals this action supports -->
  <subject[x]><!-- ?? 0..1 CodeableConcept|Reference(Group) Type of individual the action is focused on   --></subject[x]>
  <trigger><!-- ?? 0..* TriggerDefinition 
      When the action should be triggered --></trigger>
  <

  <condition> ?? 0..* BackboneElement  <!-- ?? 0..* Whether or not the action is applicable -->

   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <kind value="[code]"/><!-- ?? 1..1 applicability | start | stop   -->
   <expression><!-- ?? 0..1 Expression 
       Boolean-valued expression --></expression>
  </condition>
  <input><!-- ?? 0..* DataRequirement 
      Input data requirements --></input>
  <output><!-- ?? 0..* DataRequirement 
      Output data definition --></output>
  <

  <relatedAction> ?? 0..* BackboneElement  <!-- ?? 0..* Relationship to another action -->

   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <actionId value="[id]"/><!-- ?? 1..1 What action is this related to -->
   <relationship value="[code]"/><!-- ?? 1..1 before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end   -->
   <offset[x]><!-- ?? 0..1 Duration|Range 
       Time offset for the relationship --></offset[x]>
  </relatedAction>
  <timing[x]><!-- ?? 0..1 dateTime|Age|Period|Duration|Range|
    Timing When the action should take place --></timing[x]>
  <

  <participant> ?? 0..* BackboneElement  <!-- ?? 0..* Who should participate in the action -->

   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <type value="[code]"/><!-- ?? 1..1 patient | practitioner | related-person | device   -->
   <role><!-- ?? 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent   --></role>
  </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|uri 
      Description of the activity to be performed --></definition[x]>
  <transform value="[canonical]"/><!-- ?? 0..1 Transform to apply the template -->
  <

  <dynamicValue> ?? 0..* BackboneElement  <!-- ?? 0..* Dynamic aspects of the definition -->

   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <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><!-- See #PlanDefinition.action  A sub-action --></action>
 </action>
</PlanDefinition>

JSON Template

{ // Shareable PlanDefinition
  // from Element: extension
    "meta" : { Meta }, // C?Metadata about the resource
    "implicitRules" : "<uri>", // C?A set of rules under which this content was created
    "language" : "<code>", // C?Language of the resource content
    "text" : { Narrative }, // C?Text summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
    "url" : "<uri>", // C? R! Canonical identifier for this plan definition, represented as a URI (globally unique)
    "identifier" : [{ Identifier }], // C?Additional identifier for the plan definition
    "version" : "<string>", // C? R! Business version of the plan definition
    "name" : "<string>", // C? R! Name for this plan definition (computer friendly)
    "title" : "<string>", // C?Name for this plan definition (human friendly)
    "subtitle" : "<string>", // C?Subordinate title of the plan definition
    "type" : { CodeableConcept }, // C?order-set | clinical-protocol | eca-rule | workflow-definition
    "status" : "<code>", // C? R! draft | active | retired | unknown
    "experimental" : <boolean>, // C? R! For testing purposes, not real usage
// value[x]: Type of individual the plan definition is focused on. One of these 2:
    "subjectCodeableConcept" : { CodeableConcept }, // C?Type of individual the plan definition is focused on
    "subjectReference" : { Reference(Group) }, // C?Type of individual the plan definition is focused on
    "date" : "<dateTime>", // C?Date last changed
    "publisher" : "<string>", // C? R! Name of the publisher (organization or individual)
    "contact" : [{ ContactDetail }], // C?Contact details for the publisher
    "description" : "<markdown>", // C? R! Natural language description of the plan definition
    "useContext" : [{ UsageContext }], // C?The context that the content is intended to support
    "jurisdiction" : [{ CodeableConcept }], // C?Intended jurisdiction for plan definition (if applicable)
    "purpose" : "<markdown>", // C?Why this plan definition is defined
    "usage" : "<string>", // C?Describes the clinical usage of the plan
    "copyright" : "<markdown>", // C?Use and/or publishing restrictions
    "approvalDate" : "<date>", // C?When the plan definition was approved by publisher
    "lastReviewDate" : "<date>", // C?When the plan definition was last reviewed
    "effectivePeriod" : { Period }, // C?When the plan definition is expected to be used
    "topic" : [{ CodeableConcept }], // C?E.g. Education, Treatment, Assessment
    "author" : [{ ContactDetail }], // C?Who authored the content
    "editor" : [{ ContactDetail }], // C?Who edited the content
    "reviewer" : [{ ContactDetail }], // C?Who reviewed the content
    "endorser" : [{ ContactDetail }], // C?Who endorsed the content
    "relatedArtifact" : [{ RelatedArtifact }], // C?Additional documentation, citations
    "library" : ["<canonical>"], // C?Logic used by the plan definition
    "
    "

    "goal" : [{ BackboneElement }] // C?What the plan is trying to accomplish
    "action" : [{ BackboneElement }], // C?Action defined by the plan

  }

 

Alternate definitions: Master Definition ( XML , JSON ), Schematron

Path Name Conformance ValueSet
PlanDefinition.language Common Languages preferred Common Languages
PlanDefinition.type PlanDefinitionType extensible PlanDefinitionType
PlanDefinition.status PublicationStatus required PublicationStatus
PlanDefinition.subject[x] Subject type extensible Subject type
PlanDefinition.jurisdiction Jurisdiction extensible Jurisdiction
PlanDefinition.topic DefinitionTopic example DefinitionTopic
PlanDefinition.goal.category Goal category example Goal category
PlanDefinition.goal.description SNOMED CT Clinical Findings example SNOMED CT Clinical Findings
PlanDefinition.goal.priority Goal priority preferred Goal priority
PlanDefinition.goal.start Goal start event example Goal start event
PlanDefinition.goal.addresses Condition/Problem/Diagnosis Codes example Condition/Problem/Diagnosis Codes
PlanDefinition.goal.target.measure LOINC Codes example LOINC Codes
PlanDefinition.action.priority Request priority required Request priority
PlanDefinition.action.subject[x] Subject type extensible Subject type
PlanDefinition.action.condition.kind ActionConditionKind required ActionConditionKind
PlanDefinition.action.relatedAction.relationship ActionRelationshipType required ActionRelationshipType
PlanDefinition.action.participant.type ActionParticipantType required ActionParticipantType
PlanDefinition.action.participant.role Action participant role example Action participant role
PlanDefinition.action.type ActionType extensible ActionType
PlanDefinition.action.groupingBehavior ActionGroupingBehavior required ActionGroupingBehavior
PlanDefinition.action.selectionBehavior ActionSelectionBehavior required ActionSelectionBehavior
PlanDefinition.action.requiredBehavior ActionRequiredBehavior required ActionRequiredBehavior
PlanDefinition.action.precheckBehavior ActionPrecheckBehavior required ActionPrecheckBehavior
PlanDefinition.action.cardinalityBehavior ActionCardinalityBehavior required ActionCardinalityBehavior
.