PlanDefinition
SpecializedThis resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.
| Path | Card. | Type | Description & Constraints |
|---|---|---|---|
| PlanDefinition | 0..* | — | The definition of a plan for a series of actions, independent of any specific patient or context |
| .idΣ | 0..1 | String | Logical id of this artifact |
| .metaΣ | 0..1 | Meta | Metadata about the resource |
| .implicitRules?!Σ | 0..1 | uri | A set of rules under which this content was created |
| .language | 0..1 | code | Language of the resource content Bindinglanguages(preferred) |
| .text | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| .contained | 0..* | Resource | Contained, inline Resources |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?! | 0..* | Extension | Extensions that cannot be ignored |
| .urlΣ | 0..1 | uri | Canonical identifier for this plan definition, represented as a URI (globally unique) |
| .identifierΣ | 0..* | Identifier | Additional identifier for the plan definition |
| .versionΣ | 0..1 | string | Business version of the plan definition |
| .nameΣ | 0..1 | string | Name for this plan definition (computer friendly) |
| .titleΣ | 0..1 | string | Name for this plan definition (human friendly) |
| .subtitle | 0..1 | string | Subordinate title of the plan definition |
| .typeΣ | 0..1 | CodeableConcept | order-set | clinical-protocol | eca-rule | workflow-definition Bindingplan-definition-type(extensible) |
| .status?!Σ | 1..1 | code | draft | active | retired | unknown Bindingpublication-status(required) |
| .experimentalΣ | 0..1 | boolean | For testing purposes, not real usage |
| .subject[x] | 0..1 | CodeableConcept | Reference(Group) | Type of individual the plan definition is focused on Bindingsubject-type(extensible) |
| .dateΣ | 0..1 | dateTime | Date last changed |
| .publisherΣ | 0..1 | string | Name of the publisher (organization or individual) |
| .contactΣ | 0..* | ContactDetail | Contact details for the publisher |
| .descriptionΣ | 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) Bindingjurisdiction(extensible) |
| .purpose | 0..1 | markdown | Why this plan definition is defined |
| .usage | 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 Bindingdefinition-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 | Logic used by the plan definition |
| .goal | 0..* | BackboneElement | What the plan is trying to accomplish |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .category | 0..1 | CodeableConcept | E.g. Treatment, dietary, behavioral Bindinggoal-category(example) |
| .description | 1..1 | CodeableConcept | Code or text describing the goal Bindingclinical-findings(example) |
| .priority | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Bindinggoal-priority(preferred) |
| .start | 0..1 | CodeableConcept | When goal pursuit begins Bindinggoal-start-event(example) |
| .addresses | 0..* | CodeableConcept | What does the goal address Bindingcondition-code(example) |
| .documentation | 0..* | RelatedArtifact | Supporting documentation for the goal |
| .target | 0..* | BackboneElement | Target outcome for the goal |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .measure | 0..1 | CodeableConcept | The parameter whose value is to be tracked Bindingobservation-codes(example) |
| .detail[x] | 0..1 | Quantity | Range | CodeableConcept | The target value to be achieved |
| .due | 0..1 | Duration | Reach goal within |
| .action | 0..* | BackboneElement | Action defined by the plan |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .prefix | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) |
| .title | 0..1 | string | User-visible title |
| .description | 0..1 | string | Brief description of the action |
| .textEquivalent | 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 Bindingrequest-priority(required) |
| .code | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions |
| .reason | 0..* | CodeableConcept | Why the action should be performed |
| .documentation | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action |
| .goalId | 0..* | id | What goals this action supports |
| .subject[x] | 0..1 | CodeableConcept | Reference(Group) | Type of individual the action is focused on Bindingsubject-type(extensible) |
| .trigger | 0..* | TriggerDefinition | When the action should be triggered |
| .condition | 0..* | BackboneElement | Whether or not the action is applicable |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .kind | 1..1 | code | applicability | start | stop Bindingaction-condition-kind(required) |
| .expression | 0..1 | Expression | Boolean-valued expression |
| .input | 0..* | DataRequirement | Input data requirements |
| .output | 0..* | DataRequirement | Output data definition |
| .relatedAction | 0..* | BackboneElement | Relationship to another action |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .actionId | 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 Bindingaction-relationship-type(required) |
| .offset[x] | 0..1 | Duration | Range | Time offset for the relationship |
| .timing[x] | 0..1 | dateTime | Age | Period | Duration | Range | Timing | When the action should take place |
| .participant | 0..* | BackboneElement | Who should participate in the action |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .type | 1..1 | code | patient | practitioner | related-person | device Bindingaction-participant-type(required) |
| .role | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent Bindingaction-participant-role(example) |
| .type | 0..1 | CodeableConcept | create | update | remove | fire-event Bindingaction-type(extensible) |
| .groupingBehavior | 0..1 | code | visual-group | logical-group | sentence-group Bindingaction-grouping-behavior(required) |
| .selectionBehavior | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Bindingaction-selection-behavior(required) |
| .requiredBehavior | 0..1 | code | must | could | must-unless-documented Bindingaction-required-behavior(required) |
| .precheckBehavior | 0..1 | code | yes | no Bindingaction-precheck-behavior(required) |
| .cardinalityBehavior | 0..1 | code | single | multiple Bindingaction-cardinality-behavior(required) |
| .definition[x] | 0..1 | canonical | uri | Description of the activity to be performed |
| .transform | 0..1 | canonical | Transform to apply the template |
| .dynamicValue | 0..* | BackboneElement | Dynamic aspects of the definition |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .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..* | — | A sub-action |