12.18 12.23 Resource PlanDefinition - Content

Name	Flags	Card.	Type	Description & Constraints
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 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
name	Σ I 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 PlanDefinitionType ( Extensible )
status	?! Σ	1..1	code	draft | active | retired | unknown 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 Subject type Participant Resource Types ( Extensible )
subjectCodeableConcept			CodeableConcept
subjectReference			Reference ( Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition )
subjectCanonical			canonical ( MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition EvidenceVariable )
date	Σ	0..1	dateTime	Date last changed
publisher	Σ T	0..1	string	Name of the publisher 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	Σ	0..*	CodeableConcept	Intended jurisdiction for plan definition (if applicable) Jurisdiction ValueSet ( Extensible )
purpose	T	0..1	markdown	Why this plan definition is defined
usage	T	0..1	string	Describes the clinical usage of the plan
copyright		0..1	markdown	Use and/or publishing restrictions
approvalDate		0..1	date	When the plan definition was approved by publisher
lastReviewDate		0..1	date	When the plan definition was last reviewed
effectivePeriod	Σ	0..1	Period	When the plan definition is expected to be used
topic		0..*	CodeableConcept	E.g. Education, Treatment, Assessment DefinitionTopic ( 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		0..*	BackboneElement	What the plan is trying to accomplish
category		0..1	CodeableConcept	E.g. Treatment, dietary, behavioral GoalCategory ( Example )
description		1..1	CodeableConcept	Code or text describing the goal SNOMED CT Clinical Findings ( Example )
priority		0..1	CodeableConcept	high-priority | medium-priority | low-priority GoalPriority ( Preferred )
start		0..1	CodeableConcept	When goal pursuit begins GoalStartEvent ( Example )
addresses		0..*	CodeableConcept	What does the goal address 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 LOINC Codes ( Example )
detail[x]		0..1		The target value to be achieved
detailQuantity			Quantity
detailRange			Range
detailCodeableConcept			CodeableConcept
detailString			string
detailBoolean		CodeableConcept	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 ActionParticipantType ( 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 ActionParticipantRole ( Example )
action		0..*	BackboneElement	Action defined by the plan
prefix 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	string	Brief description of the action
textEquivalent	T	0..1	string	Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
priority		0..1	code	routine | urgent | asap | stat RequestPriority ( Required )
code	0..*	0..1	CodeableConcept	Code representing the meaning of the action or sub-actions ActionCode ( Example )
reason		0..*	CodeableConcept	Why the action should be performed ActionReasonCode ( Example )
documentation		0..*	RelatedArtifact	Supporting documentation for the intended performer of the action
goalId		0..*	id	What goals this action supports
subject[x]		0..1		Type of individual the action is focused on Subject type 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 ActionConditionKind ( 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..* 0..1	string	User-visible title
requirement		0..1	DataRequirement	What data is provided
relatedData		Input 0..1	id	What data requirements is provided
output	C	0..*	DataRequirement BackboneElement	Output data definition + Rule: Output data element must have a requirement or a relatedData, but not both
relatedAction title	T	0..* 0..1	BackboneElement string	Relationship to another action User-visible title
actionId requirement		0..1	DataRequirement	1..1 What data is provided
relatedData		0..1	string	What data is provided
relatedAction		0..*	BackboneElement	Relationship to another action
targetId		1..1	id	What action is this related to
relationship		1..1	code	before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end ActionRelationshipType ( Required )
offset[x]		0..1		Time offset for the relationship
offsetDuration			Duration
offsetRange			Range
timing[x]		0..1		When the action should take place
timingDateTime timingAge			Age	dateTime
timingDuration			Duration
timingAge timingRange			Age Range
timingPeriod timingTiming			Timing
location		0..1	CodeableReference ( Location )	Where it should happen
participant		0..*	BackboneElement	Who should participate in the action
timingDuration actorId		0..1	Duration string	What actor
timingRange type		0..1	Range code	careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson ActionParticipantType ( Required )
timingTiming typeCanonical		0..1	Timing canonical ( CapabilityStatement )	Who or what can participate
participant typeReference		0..* 0..1	BackboneElement Reference ( CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson )	Who should or what can participate in the action
type role		1..1 0..1	code CodeableConcept	patient | practitioner | related-person | device E.g. Nurse, Surgeon, Parent ActionParticipantType ActionParticipantRole ( Required Example )
role function		0..1	CodeableConcept	E.g. Nurse, Surgeon, Parent Author, Reviewer, Witness, etc. ActionParticipantRole ActionParticipantFunction ( Example )
type		0..1	CodeableConcept	create | update | remove | fire-event ActionType ( Extensible )
groupingBehavior		0..1	code	visual-group | logical-group | sentence-group ActionGroupingBehavior ( Required )
selectionBehavior		0..1	code	any | all | all-or-none | exactly-one | at-most-one | one-or-more ActionSelectionBehavior ( Required )
requiredBehavior		0..1	code	must | could | must-unless-documented ActionRequiredBehavior ( Required )
precheckBehavior		0..1	code	yes | no ActionPrecheckBehavior ( Required )
cardinalityBehavior		0..1	code	single | multiple ActionCardinalityBehavior ( Required )
definition[x]		0..1		Description of the activity to be performed
definitionCanonical			canonical ( ActivityDefinition | 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 SNOMED CT Medication As Needed Reason Codes ( Example )
asNeededBoolean			boolean
asNeededCodeableConcept			CodeableConcept
Documentation for this format

See the Extensions for this resource

<PlanDefinition xmlns="http://hl7.org/fhir"> 
 <!-- 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 -->
 <

 <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]>
 <
 <

 <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="[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><!-- 0..* canonical(Library) Logic used by the plan definition --></library>
 <goal>  <!-- 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]>

   <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  --></role>
  </option>
 </actor>

 <action>  <!-- 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="[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>

  <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]"/><!-- 0..* What goals this action supports -->
  <</subject[x]>
  <</trigger>

  <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>
  <</output>

  <input>  <!-- 0..* Input data requirements -->
   <title value="[string]"/><!-- 0..1 User-visible title -->
   <requirement><!-- 0..1 DataRequirement What data is provided --></requirement>
   <relatedData value="[id]"/><!-- 0..1 What data is provided -->
  </input>
  <output>  <!-- 0..* Output data definition -->
   <title value="[string]"/><!-- 0..1 User-visible title -->
   <requirement><!-- 0..1 DataRequirement What data is provided --></requirement>
   <relatedData value="[string]"/><!-- 0..1 What data is provided -->
  </output>

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

   <targetId 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]>

  <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 -->
   <
   <</role>

   <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  --></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]>

  <definition[x]><!-- 0..1 canonical(ActivityDefinition|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>

{
  "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
  "

  "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" : "<string>", // Describes the clinical usage of the plan
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "approvalDate" : "<date>", // When the plan definition was approved by publisher
  "lastReviewDate" : "<date>", // When the plan definition was last reviewed
  "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" : [{ // 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 
    }]
  }],

  "action" : [{ // 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" : "<string>", // Brief description of the action
    "textEquivalent" : "<string>", // 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>"], // 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 }, // What data is provided
      "relatedData" : "<id>" // What data is provided
    }],
    "output" : [{ // Output data definition
      "title" : "<string>", // User-visible title
      "requirement" : { DataRequirement }, // What data is provided
      "relatedData" : "<string>" // What data is provided
    }],

    "relatedAction" : [{ // Relationship to another action
      "

      "targetId" : "<id>", // R!  What action is this related to

      "relationship" : "<code>", // R!  before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | 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 
      "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|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 }

}

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


[ 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:

  fhir:PlanDefinition.url [ uri ]; # 0..1 Canonical identifier for this plan definition, represented as a URI (globally unique)

  fhir:PlanDefinition.identifier [ Identifier ], ... ; # 0..* Additional identifier for the plan definition
  fhir:PlanDefinition.version [ string ]; # 0..1 Business version of the plan definition
  fhir:

  fhir:PlanDefinition.name [ string ]; # 0..1 I Name for this plan definition (computer friendly)

  fhir:PlanDefinition.title [ string ]; # 0..1 Name for this plan definition (human friendly)
  fhir:PlanDefinition.subtitle [ string ]; # 0..1 Subordinate title of the plan definition
  fhir:PlanDefinition.type [ CodeableConcept ]; # 0..1 order-set | clinical-protocol | eca-rule | workflow-definition
  fhir:PlanDefinition.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:PlanDefinition.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  # PlanDefinition.subject[x] : 0..1 Type of individual the plan definition is focused on. One of these 3
    fhir:PlanDefinition.subjectCodeableConcept [ CodeableConcept ]
    fhir:) ]
    fhir:|

    fhir:PlanDefinition.subjectReference [ Reference(AdministrableProductDefinition|Group|ManufacturedItemDefinition|

  MedicinalProductDefinition|PackagedProductDefinition|SubstanceDefinition) ]
  fhir:
  fhir:

    fhir:PlanDefinition.subjectCanonical [ canonical(EvidenceVariable) ]
  fhir:PlanDefinition.date [ dateTime ]; # 0..1 Date last changed
  fhir:PlanDefinition.publisher [ string ]; # 0..1 Name of the publisher/steward (organization or individual)

  fhir:PlanDefinition.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:PlanDefinition.description [ markdown ]; # 0..1 Natural language description of the plan definition
  fhir:PlanDefinition.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support
  fhir:PlanDefinition.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for plan definition (if applicable)
  fhir:PlanDefinition.purpose [ markdown ]; # 0..1 Why this plan definition is defined
  fhir:PlanDefinition.usage [ string ]; # 0..1 Describes the clinical usage of the plan
  fhir:PlanDefinition.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  fhir:PlanDefinition.approvalDate [ date ]; # 0..1 When the plan definition was approved by publisher
  fhir:PlanDefinition.lastReviewDate [ date ]; # 0..1 When the plan definition was last reviewed
  fhir:PlanDefinition.effectivePeriod [ Period ]; # 0..1 When the plan definition is expected to be used
  fhir:PlanDefinition.topic [ CodeableConcept ], ... ; # 0..* E.g. Education, Treatment, Assessment
  fhir:PlanDefinition.author [ ContactDetail ], ... ; # 0..* Who authored the content
  fhir:PlanDefinition.editor [ ContactDetail ], ... ; # 0..* Who edited the content
  fhir:PlanDefinition.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the content
  fhir:PlanDefinition.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the content
  fhir:PlanDefinition.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations
  fhir:PlanDefinition.library [ canonical(Library) ], ... ; # 0..* Logic used by the plan definition
  fhir:PlanDefinition.goal [ # 0..* What the plan is trying to accomplish
    fhir:PlanDefinition.goal.category [ CodeableConcept ]; # 0..1 E.g. Treatment, dietary, behavioral
    fhir:PlanDefinition.goal.description [ CodeableConcept ]; # 1..1 Code or text describing the goal
    fhir:PlanDefinition.goal.priority [ CodeableConcept ]; # 0..1 high-priority | medium-priority | low-priority
    fhir:PlanDefinition.goal.start [ CodeableConcept ]; # 0..1 When goal pursuit begins
    fhir:PlanDefinition.goal.addresses [ CodeableConcept ], ... ; # 0..* What does the goal address
    fhir:PlanDefinition.goal.documentation [ RelatedArtifact ], ... ; # 0..* Supporting documentation for the goal
    fhir:PlanDefinition.goal.target [ # 0..* Target outcome for the goal
      fhir:PlanDefinition.goal.target.measure [ CodeableConcept ]; # 0..1 The parameter whose value is to be tracked
      # . One of these 3

      # PlanDefinition.goal.target.detail[x] : 0..1 The target value to be achieved. One of these 7

        fhir:PlanDefinition.goal.target.detailQuantity [ Quantity ]
        fhir:PlanDefinition.goal.target.detailRange [ Range ]
        fhir:PlanDefinition.goal.target.detailCodeableConcept [ CodeableConcept ]
        fhir:PlanDefinition.goal.target.detailString [ string ]
        fhir:PlanDefinition.goal.target.detailBoolean [ boolean ]
        fhir:PlanDefinition.goal.target.detailInteger [ integer ]
        fhir:PlanDefinition.goal.target.detailRatio [ Ratio ]

      fhir:PlanDefinition.goal.target.due [ Duration ]; # 0..1 Reach goal within
    ], ...;
  ], ...;
  fhir:PlanDefinition.actor [ # 0..* Actors within the plan
    fhir:PlanDefinition.actor.title [ string ]; # 0..1 User-visible title
    fhir:PlanDefinition.actor.description [ markdown ]; # 0..1 Describes the actor
    fhir:PlanDefinition.actor.option [ # 1..* Who or what can be this actor
      fhir:PlanDefinition.actor.option.type [ code ]; # 0..1 careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
      fhir:PlanDefinition.actor.option.typeCanonical [ canonical(CapabilityStatement) ]; # 0..1 Who or what can participate
      fhir:PlanDefinition.actor.option.typeReference [ Reference(CareTeam|Device|DeviceDefinition|Endpoint|Group|HealthcareService|Location|
  Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ]; # 0..1 Who or what can participate

      fhir:PlanDefinition.actor.option.role [ CodeableConcept ]; # 0..1 E.g. Nurse, Surgeon, Parent
    ], ...;
  ], ...;

  fhir:PlanDefinition.action [ # 0..* Action defined by the plan
    fhir:

    fhir:PlanDefinition.action.linkId [ string ]; # 0..1 Unique id for the action in the PlanDefinition
    fhir:PlanDefinition.action.prefix [ string ]; # 0..1 User-visible prefix for the action (e.g. 1. or A.)

    fhir:PlanDefinition.action.title [ string ]; # 0..1 User-visible title
    fhir:PlanDefinition.action.description [ string ]; # 0..1 Brief description of the action
    fhir:PlanDefinition.action.textEquivalent [ string ]; # 0..1 Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
    fhir:PlanDefinition.action.priority [ code ]; # 0..1 routine | urgent | asap | stat
    fhir:

    fhir:PlanDefinition.action.code [ CodeableConcept ]; # 0..1 Code representing the meaning of the action or sub-actions

    fhir:PlanDefinition.action.reason [ CodeableConcept ], ... ; # 0..* Why the action should be performed
    fhir:PlanDefinition.action.documentation [ RelatedArtifact ], ... ; # 0..* Supporting documentation for the intended performer of the action
    fhir:PlanDefinition.action.goalId [ id ], ... ; # 0..* What goals this action supports
    # PlanDefinition.action.subject[x] : 0..1 Type of individual the action is focused on. One of these 3
      fhir:PlanDefinition.action.subjectCodeableConcept [ CodeableConcept ]
      fhir:PlanDefinition.action.subjectReference [ Reference(Group) ]
      fhir:PlanDefinition.action.subjectCanonical [ canonical ]
    fhir:

    fhir:PlanDefinition.action.trigger [ TriggerDefinition ], ... ; # 0..* When the action should be triggered

    fhir:PlanDefinition.action.condition [ # 0..* Whether or not the action is applicable
      fhir:PlanDefinition.action.condition.kind [ code ]; # 1..1 applicability | start | stop
      fhir:PlanDefinition.action.condition.expression [ Expression ]; # 0..1 Boolean-valued expression
    ], ...;
    fhir:
    fhir:

    fhir:PlanDefinition.action.input [ # 0..* Input data requirements
      fhir:PlanDefinition.action.input.title [ string ]; # 0..1 User-visible title
      fhir:PlanDefinition.action.input.requirement [ DataRequirement ]; # 0..1 What data is provided
      fhir:PlanDefinition.action.input.relatedData [ id ]; # 0..1 What data is provided
    ], ...;
    fhir:PlanDefinition.action.output [ # 0..* Output data definition
      fhir:PlanDefinition.action.output.title [ string ]; # 0..1 User-visible title
      fhir:PlanDefinition.action.output.requirement [ DataRequirement ]; # 0..1 What data is provided
      fhir:PlanDefinition.action.output.relatedData [ string ]; # 0..1 What data is provided
    ], ...;

    fhir:PlanDefinition.action.relatedAction [ # 0..* Relationship to another action
      fhir:

      fhir:PlanDefinition.action.relatedAction.targetId [ id ]; # 1..1 What action is this related to

      fhir:PlanDefinition.action.relatedAction.relationship [ code ]; # 1..1 before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
      # PlanDefinition.action.relatedAction.offset[x] : 0..1 Time offset for the relationship. One of these 2
        fhir:PlanDefinition.action.relatedAction.offsetDuration [ Duration ]
        fhir:PlanDefinition.action.relatedAction.offsetRange [ Range ]
    ], ...;
    # . One of these 6
      fhir: ]

    # PlanDefinition.action.timing[x] : 0..1 When the action should take place. One of these 4

      fhir:PlanDefinition.action.timingAge [ Age ]
      fhir: ]

      fhir:PlanDefinition.action.timingDuration [ Duration ]
      fhir:PlanDefinition.action.timingRange [ Range ]
      fhir:PlanDefinition.action.timingTiming [ Timing ]
    fhir:PlanDefinition.action.location [ CodeableReference(Location) ]; # 0..1 Where it should happen

    fhir:PlanDefinition.action.participant [ # 0..* Who should participate in the action
      fhir:

      fhir:PlanDefinition.action.participant.actorId [ string ]; # 0..1 What actor
      fhir:PlanDefinition.action.participant.type [ code ]; # 0..1 careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
      fhir:PlanDefinition.action.participant.typeCanonical [ canonical(CapabilityStatement) ]; # 0..1 Who or what can participate
      fhir:PlanDefinition.action.participant.typeReference [ Reference(CareTeam|Device|DeviceDefinition|Endpoint|Group|HealthcareService|Location|
  Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ]; # 0..1 Who or what can participate
      fhir:PlanDefinition.action.participant.role [ CodeableConcept ]; # 0..1 E.g. Nurse, Surgeon, Parent
      fhir:PlanDefinition.action.participant.function [ CodeableConcept ]; # 0..1 E.g. Author, Reviewer, Witness, etc.

    ], ...;
    fhir:PlanDefinition.action.type [ CodeableConcept ]; # 0..1 create | update | remove | fire-event
    fhir:PlanDefinition.action.groupingBehavior [ code ]; # 0..1 visual-group | logical-group | sentence-group
    fhir:PlanDefinition.action.selectionBehavior [ code ]; # 0..1 any | all | all-or-none | exactly-one | at-most-one | one-or-more
    fhir:PlanDefinition.action.requiredBehavior [ code ]; # 0..1 must | could | must-unless-documented
    fhir:PlanDefinition.action.precheckBehavior [ code ]; # 0..1 yes | no
    fhir:PlanDefinition.action.cardinalityBehavior [ code ]; # 0..1 single | multiple
    # . One of these 2
      fhir:) ]
      fhir: ]

    # PlanDefinition.action.definition[x] : 0..1 Description of the activity to be performed. One of these 2
      fhir:PlanDefinition.action.definitionCanonical [ canonical(ActivityDefinition|ObservationDefinition|PlanDefinition|Questionnaire|
  SpecimenDefinition) ]

      fhir:PlanDefinition.action.definitionUri [ uri ]

    fhir:PlanDefinition.action.transform [ canonical(StructureMap) ]; # 0..1 Transform to apply the template
    fhir:PlanDefinition.action.dynamicValue [ # 0..* Dynamic aspects of the definition
      fhir:PlanDefinition.action.dynamicValue.path [ string ]; # 0..1 The path to the element to be set dynamically
      fhir:PlanDefinition.action.dynamicValue.expression [ Expression ]; # 0..1 An expression that provides the dynamic value for the customization
    ], ...;
    fhir:PlanDefinition.action.action [ See PlanDefinition.action ], ... ; # 0..* A sub-action
  ], ...;
  # PlanDefinition.asNeeded[x] : 0..1 Preconditions for service. One of these 2
    fhir:PlanDefinition.asNeededBoolean [ boolean ]
    fhir:PlanDefinition.asNeededCodeableConcept [ CodeableConcept ]

]

See the Full Difference for further information

This analysis is available as XML or JSON .

Conversions between R3 and R4 See R3 <--> R4 Conversion Maps (status = 11 tests of which 6 fail to execute . All tests pass round-trip testing and 5 r3 resources are invalid (0 errors). )