Resources
PlanDefinition
Resources
PlanDefinition
This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.
Properties
| Name | Required | Type | Description |
|---|---|---|---|
| url | No | uri | Canonical identifier for this plan definition, represented as a URI (globally unique) |
| identifier | No | Identifier[] | Additional identifier for the plan definition |
| version | No | string | Business version of the plan definition |
| name | No | string | Name for this plan definition (computer friendly) |
| title | No | string | Name for this plan definition (human friendly) |
| subtitle | No | string | Subordinate title of the plan definition |
| type | No | CodeableConcept | order-set / clinical-protocol / eca-rule / workflow-definition |
| status | Yes | code | draft / active / retired / unknown |
| experimental | No | boolean | For testing purposes, not real usage |
| subject[x] | No | CodeableConcept, Reference<Group> | Type of individual the plan definition is focused on |
| date | No | dateTime | Date last changed |
| publisher | No | string | Name of the publisher (organization or individual) |
| contact | No | ContactDetail[] | Contact details for the publisher |
| description | No | markdown | Natural language description of the plan definition |
| useContext | No | UsageContext[] | The context that the content is intended to support |
| jurisdiction | No | CodeableConcept[] | Intended jurisdiction for plan definition (if applicable) |
| purpose | No | markdown | Why this plan definition is defined |
| usage | No | string | Describes the clinical usage of the plan |
| copyright | No | markdown | Use and/or publishing restrictions |
| approvalDate | No | date | When the plan definition was approved by publisher |
| lastReviewDate | No | date | When the plan definition was last reviewed |
| effectivePeriod | No | Period | When the plan definition is expected to be used |
| topic | No | CodeableConcept[] | E.g. Education, Treatment, Assessment |
| author | No | ContactDetail[] | Who authored the content |
| editor | No | ContactDetail[] | Who edited the content |
| reviewer | No | ContactDetail[] | Who reviewed the content |
| endorser | No | ContactDetail[] | Who endorsed the content |
| relatedArtifact | No | RelatedArtifact[] | Additional documentation, citations |
| library | No | canonical[] | Logic used by the plan definition |
| goal | No | PlanDefinitionGoal | What the plan is trying to accomplish |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - category | No | CodeableConcept | E.g. Treatment, dietary, behavioral |
| - description | Yes | CodeableConcept | Code or text describing the goal |
| - priority | No | CodeableConcept | high-priority / medium-priority / low-priority |
| - start | No | CodeableConcept | When goal pursuit begins |
| - addresses | No | CodeableConcept[] | What does the goal address |
| - documentation | No | RelatedArtifact[] | Supporting documentation for the goal |
| - target | No | PlanDefinitionGoalTarget | Target outcome for the goal |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - measure | No | CodeableConcept | The parameter whose value is to be tracked |
| - detail[x] | No | Quantity, Range, CodeableConcept | The target value to be achieved |
| - due | No | Duration | Reach goal within |
| action | No | PlanDefinitionAction | Action defined by the plan |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - prefix | No | string | User-visible prefix for the action (e.g. 1. or A.) |
| - title | No | string | User-visible title |
| - description | No | string | Brief description of the action |
| - textEquivalent | No | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system |
| - priority | No | code | routine / urgent / asap / stat |
| - code | No | CodeableConcept[] | Code representing the meaning of the action or sub-actions |
| - reason | No | CodeableConcept[] | Why the action should be performed |
| - documentation | No | RelatedArtifact[] | Supporting documentation for the intended performer of the action |
| - goalId | No | id[] | What goals this action supports |
| - subject[x] | No | CodeableConcept, Reference<Group> | Type of individual the action is focused on |
| - trigger | No | TriggerDefinition[] | When the action should be triggered |
| - condition | No | PlanDefinitionActionCondition | Whether or not the action is applicable |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - kind | Yes | code | applicability / start / stop |
| - expression | No | Expression | Boolean-valued expression |
| - input | No | DataRequirement[] | Input data requirements |
| - output | No | DataRequirement[] | Output data definition |
| - relatedAction | No | PlanDefinitionActionRelatedAction | Relationship to another action |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - actionId | Yes | id | What action is this related to |
| - relationship | Yes | code | before-start / before / before-end / concurrent-with-start / concurrent / concurrent-with-end / after-start / after / after-end |
| - offset[x] | No | Duration, Range | Time offset for the relationship |
| - timing[x] | No | dateTime, Age, Period, Duration, Range, Timing | When the action should take place |
| - participant | No | PlanDefinitionActionParticipant | Who should participate in the action |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - type | Yes | code | patient / practitioner / related-person / device |
| - role | No | CodeableConcept | E.g. Nurse, Surgeon, Parent |
| - type | No | CodeableConcept | create / update / remove / fire-event |
| - groupingBehavior | No | code | visual-group / logical-group / sentence-group |
| - selectionBehavior | No | code | any / all / all-or-none / exactly-one / at-most-one / one-or-more |
| - requiredBehavior | No | code | must / could / must-unless-documented |
| - precheckBehavior | No | code | yes / no |
| - cardinalityBehavior | No | code | single / multiple |
| - definition[x] | No | canonical, uri | Description of the activity to be performed |
| - transform | No | canonical | Transform to apply the template |
| - dynamicValue | No | PlanDefinitionActionDynamicValue | Dynamic aspects of the definition |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - path | No | string | The path to the element to be set dynamically |
| - expression | No | Expression | An expression that provides the dynamic value for the customization |
| - action | No | [] | A sub-action |
Search Parameters
| Name | Type | Description | Expression |
|---|---|---|---|
| composed-of | reference | What resource is being referenced | PlanDefinition.relatedArtifact |
| context | token | A use context assigned to the plan definition | PlanDefinition.useContext.value |
| context-quantity | quantity | A quantity- or range-valued use context assigned to the plan definition | PlanDefinition.useContext.value |
| context-type | token | A type of use context assigned to the plan definition | PlanDefinition.useContext.code |
| date | date | The plan definition publication date | PlanDefinition.date |
| definition | reference | Activity or plan definitions used by plan definition | PlanDefinition.action.definition |
| depends-on | reference | What resource is being referenced | PlanDefinition.relatedArtifact |
| derived-from | reference | What resource is being referenced | PlanDefinition.relatedArtifact |
| description | string | The description of the plan definition | PlanDefinition.description |
| effective | date | The time during which the plan definition is intended to be in use | PlanDefinition.effectivePeriod |
| identifier | token | External identifier for the plan definition | PlanDefinition.identifier |
| jurisdiction | token | Intended jurisdiction for the plan definition | PlanDefinition.jurisdiction |
| name | string | Computationally friendly name of the plan definition | PlanDefinition.name |
| predecessor | reference | What resource is being referenced | PlanDefinition.relatedArtifact |
| publisher | string | Name of the publisher of the plan definition | PlanDefinition.publisher |
| status | token | The current status of the plan definition | PlanDefinition.status |
| successor | reference | What resource is being referenced | PlanDefinition.relatedArtifact |
| title | string | The human-friendly name of the plan definition | PlanDefinition.title |
| topic | token | Topics associated with the module | PlanDefinition.topic |
| type | token | The type of artifact the plan (e.g. order-set, eca-rule, protocol) | PlanDefinition.type |
| url | uri | The uri that identifies the plan definition | PlanDefinition.url |
| version | token | The business version of the plan definition | PlanDefinition.version |
| context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the plan definition | PlanDefinition.useContext |
| context-type-value | composite | A use context type and value assigned to the plan definition | PlanDefinition.useContext |
Inherited Properties
| Name | Required | Type | Description |
|---|---|---|---|
| id | No | string | Logical id of this artifact |
| meta | No | Meta | Metadata about the resource |
| implicitRules | No | uri | A set of rules under which this content was created |
| language | No | code | Language of the resource content |
| text | No | Narrative | Text summary of the resource, for human interpretation |
| contained | No | Resource[] | Contained, inline Resources |
| extension | No | Extension[] | Additional content defined by implementations |
| modifierExtension | No | Extension[] | Extensions that cannot be ignored |
To view the FHIR specification for this resource, see PlanDefinition.