This page is part of the FHIR Specification v4.3.0-snapshot1: R4B Snapshot to support the Jan 2022 Connectathon. About the R4B version of FHIR. The current officially released version is 4.3.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3
Clinical Decision Support Work Group | Maturity Level: 3 | Trial Use | Security Category: Business | Compartments: Not linked to any defined compartments |
Detailed Descriptions for the elements in the PlanDefinition resource.
PlanDefinition | |||||||||
Element Id | PlanDefinition | ||||||||
Definition | This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical and non-clinical artifacts such as clinical decision support rules, order sets, protocols, and drug quality specifications. | ||||||||
Cardinality | 0..* | ||||||||
Type | DomainResource | ||||||||
Summary | false | ||||||||
Invariants |
| ||||||||
PlanDefinition.url | |||||||||
Element Id | PlanDefinition.url | ||||||||
Definition | An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different servers. | ||||||||
Cardinality | 0..1 | ||||||||
Type | uri | ||||||||
Requirements | Allows the plan definition to be referenced by a single globally unique identifier. | ||||||||
Summary | true | ||||||||
Comments | Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found. | ||||||||
PlanDefinition.identifier | |||||||||
Element Id | PlanDefinition.identifier | ||||||||
Definition | A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance. | ||||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
Cardinality | 0..* | ||||||||
Type | Identifier | ||||||||
Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module. | ||||||||
Summary | true | ||||||||
Comments | Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this plan definition outside of FHIR, where it is not possible to use the logical URI. | ||||||||
PlanDefinition.version | |||||||||
Element Id | PlanDefinition.version | ||||||||
Definition | The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts. | ||||||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | true | ||||||||
Comments | There may be different plan definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the plan definition with the format [url]|[version]. | ||||||||
PlanDefinition.name | |||||||||
Element Id | PlanDefinition.name | ||||||||
Definition | A natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Requirements | Support human navigation and code generation. | ||||||||
Summary | true | ||||||||
Comments | The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. | ||||||||
Invariants |
| ||||||||
PlanDefinition.title | |||||||||
Element Id | PlanDefinition.title | ||||||||
Definition | A short, descriptive, user-friendly title for the plan definition. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | true | ||||||||
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. | ||||||||
PlanDefinition.subtitle | |||||||||
Element Id | PlanDefinition.subtitle | ||||||||
Definition | An explanatory or alternate title for the plan definition giving additional information about its content. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
PlanDefinition.type | |||||||||
Element Id | PlanDefinition.type | ||||||||
Definition | A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition. | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | PlanDefinitionType (Extensible) | ||||||||
Type | CodeableConcept | ||||||||
Summary | true | ||||||||
PlanDefinition.status | |||||||||
Element Id | PlanDefinition.status | ||||||||
Definition | The status of this plan definition. Enables tracking the life-cycle of the content. | ||||||||
Cardinality | 1..1 | ||||||||
Terminology Binding | PublicationStatus (Required) | ||||||||
Type | code | ||||||||
Is Modifier | true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration) | ||||||||
Summary | true | ||||||||
Comments | Allows filtering of plan definitions that are appropriate for use versus not. | ||||||||
PlanDefinition.experimental | |||||||||
Element Id | PlanDefinition.experimental | ||||||||
Definition | A Boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. | ||||||||
Cardinality | 0..1 | ||||||||
Type | boolean | ||||||||
Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level plan definition. | ||||||||
Summary | true | ||||||||
Comments | Allows filtering of plan definitions that are appropriate for use versus not. | ||||||||
PlanDefinition.subject[x] | |||||||||
Element Id | PlanDefinition.subject[x] | ||||||||
Definition | A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | Subject type (Extensible) | ||||||||
Type | CodeableConcept|Reference(Group)|canonical(MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition) | ||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||
Meaning if Missing | Patient | ||||||||
Summary | false | ||||||||
PlanDefinition.date | |||||||||
Element Id | PlanDefinition.date | ||||||||
Definition | The date (and optionally time) when the plan definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changes. | ||||||||
Cardinality | 0..1 | ||||||||
Type | dateTime | ||||||||
Alternate Names | Revision Date | ||||||||
Summary | true | ||||||||
Comments | Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the plan definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. | ||||||||
PlanDefinition.publisher | |||||||||
Element Id | PlanDefinition.publisher | ||||||||
Definition | The name of the organization or individual that published the plan definition. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Requirements | Helps establish the "authority/credibility" of the plan definition. May also allow for contact. | ||||||||
Summary | true | ||||||||
Comments | Usually an organization but may be an individual. The publisher (or steward) of the plan definition is the organization or individual primarily responsible for the maintenance and upkeep of the plan definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the plan definition. This item SHOULD be populated unless the information is available from context. | ||||||||
PlanDefinition.contact | |||||||||
Element Id | PlanDefinition.contact | ||||||||
Definition | Contact details to assist a user in finding and communicating with the publisher. | ||||||||
Cardinality | 0..* | ||||||||
Type | ContactDetail | ||||||||
Summary | true | ||||||||
Comments | May be a web site, an email address, a telephone number, etc. | ||||||||
PlanDefinition.description | |||||||||
Element Id | PlanDefinition.description | ||||||||
Definition | A free text natural language description of the plan definition from a consumer's perspective. | ||||||||
Cardinality | 0..1 | ||||||||
Type | markdown | ||||||||
Summary | true | ||||||||
Comments | This description can be used to capture details such as why the plan definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the plan definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the plan definition is presumed to be the predominant language in the place the plan definition was created). | ||||||||
PlanDefinition.useContext | |||||||||
Element Id | PlanDefinition.useContext | ||||||||
Definition | The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances. | ||||||||
Cardinality | 0..* | ||||||||
Type | UsageContext | ||||||||
Requirements | Assist in searching for appropriate content. | ||||||||
Summary | true | ||||||||
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. | ||||||||
PlanDefinition.jurisdiction | |||||||||
Element Id | PlanDefinition.jurisdiction | ||||||||
Definition | A legal or geographic region in which the plan definition is intended to be used. | ||||||||
Cardinality | 0..* | ||||||||
Terminology Binding | Jurisdiction (Extensible) | ||||||||
Type | CodeableConcept | ||||||||
Summary | true | ||||||||
Comments | It may be possible for the plan definition to be used in jurisdictions other than those for which it was originally designed or intended. | ||||||||
PlanDefinition.purpose | |||||||||
Element Id | PlanDefinition.purpose | ||||||||
Definition | Explanation of why this plan definition is needed and why it has been designed as it has. | ||||||||
Cardinality | 0..1 | ||||||||
Type | markdown | ||||||||
Summary | false | ||||||||
Comments | This element does not describe the usage of the plan definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this plan definition. | ||||||||
PlanDefinition.usage | |||||||||
Element Id | PlanDefinition.usage | ||||||||
Definition | A detailed description of how the plan definition is used from a clinical perspective. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
PlanDefinition.copyright | |||||||||
Element Id | PlanDefinition.copyright | ||||||||
Definition | A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition. | ||||||||
Cardinality | 0..1 | ||||||||
Type | markdown | ||||||||
Requirements | Consumers must be able to determine any legal restrictions on the use of the plan definition and/or its content. | ||||||||
Alternate Names | License; Restrictions | ||||||||
Summary | false | ||||||||
PlanDefinition.approvalDate | |||||||||
Element Id | PlanDefinition.approvalDate | ||||||||
Definition | The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. | ||||||||
Cardinality | 0..1 | ||||||||
Type | date | ||||||||
Summary | false | ||||||||
Comments | The 'date' element may be more recent than the approval date because of minor changes or editorial corrections. | ||||||||
PlanDefinition.lastReviewDate | |||||||||
Element Id | PlanDefinition.lastReviewDate | ||||||||
Definition | The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. | ||||||||
Cardinality | 0..1 | ||||||||
Type | date | ||||||||
Requirements | Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant. | ||||||||
Summary | false | ||||||||
Comments | If specified, this date follows the original approval date. | ||||||||
PlanDefinition.effectivePeriod | |||||||||
Element Id | PlanDefinition.effectivePeriod | ||||||||
Definition | The period during which the plan definition content was or is planned to be in active use. | ||||||||
Cardinality | 0..1 | ||||||||
Type | Period | ||||||||
Requirements | Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the plan definition are or are expected to be used instead. | ||||||||
Summary | true | ||||||||
Comments | The effective period for a plan definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015. | ||||||||
PlanDefinition.topic | |||||||||
Element Id | PlanDefinition.topic | ||||||||
Definition | Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching. | ||||||||
Cardinality | 0..* | ||||||||
Terminology Binding | DefinitionTopic (Example) | ||||||||
Type | CodeableConcept | ||||||||
Requirements | Repositories must be able to determine how to categorize the plan definition so that it can be found by topical searches. | ||||||||
Summary | false | ||||||||
PlanDefinition.author | |||||||||
Element Id | PlanDefinition.author | ||||||||
Definition | An individiual or organization primarily involved in the creation and maintenance of the content. | ||||||||
Cardinality | 0..* | ||||||||
Type | ContactDetail | ||||||||
Summary | false | ||||||||
PlanDefinition.editor | |||||||||
Element Id | PlanDefinition.editor | ||||||||
Definition | An individual or organization primarily responsible for internal coherence of the content. | ||||||||
Cardinality | 0..* | ||||||||
Type | ContactDetail | ||||||||
Summary | false | ||||||||
PlanDefinition.reviewer | |||||||||
Element Id | PlanDefinition.reviewer | ||||||||
Definition | An individual or organization primarily responsible for review of some aspect of the content. | ||||||||
Cardinality | 0..* | ||||||||
Type | ContactDetail | ||||||||
Summary | false | ||||||||
PlanDefinition.endorser | |||||||||
Element Id | PlanDefinition.endorser | ||||||||
Definition | An individual or organization responsible for officially endorsing the content for use in some setting. | ||||||||
Cardinality | 0..* | ||||||||
Type | ContactDetail | ||||||||
Summary | false | ||||||||
PlanDefinition.relatedArtifact | |||||||||
Element Id | PlanDefinition.relatedArtifact | ||||||||
Definition | Related artifacts such as additional documentation, justification, or bibliographic references. | ||||||||
Cardinality | 0..* | ||||||||
Type | RelatedArtifact | ||||||||
Requirements | Plan definitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content. | ||||||||
Summary | false | ||||||||
Comments | Each related artifact is either an attachment, or a reference to another resource, but not both. | ||||||||
PlanDefinition.library | |||||||||
Element Id | PlanDefinition.library | ||||||||
Definition | A reference to a Library resource containing any formal logic used by the plan definition. | ||||||||
Cardinality | 0..* | ||||||||
Type | canonical(Library) | ||||||||
Summary | false | ||||||||
PlanDefinition.goal | |||||||||
Element Id | PlanDefinition.goal | ||||||||
Definition | A goal describes an expected outcome that activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, meeting the acceptance criteria for a test as specified by a quality specification, etc. | ||||||||
Cardinality | 0..* | ||||||||
Requirements | Goal information needs to be captured for order sets, protocols, and care plan definitions to better describe the objectives of the protocol activities and to guide the creation of specific goals within the derived care plans and orders. | ||||||||
Summary | false | ||||||||
PlanDefinition.goal.category | |||||||||
Element Id | PlanDefinition.goal.category | ||||||||
Definition | Indicates a category the goal falls within. | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | GoalCategory (Example) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
PlanDefinition.goal.description | |||||||||
Element Id | PlanDefinition.goal.description | ||||||||
Definition | Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding". | ||||||||
Cardinality | 1..1 | ||||||||
Terminology Binding | SNOMED CT Clinical Findings (Example) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
Comments | If no code is available, use CodeableConcept.text. | ||||||||
PlanDefinition.goal.priority | |||||||||
Element Id | PlanDefinition.goal.priority | ||||||||
Definition | Identifies the expected level of importance associated with reaching/sustaining the defined goal. | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | GoalPriority (Preferred) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
PlanDefinition.goal.start | |||||||||
Element Id | PlanDefinition.goal.start | ||||||||
Definition | The event after which the goal should begin being pursued. | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | GoalStartEvent (Example) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
PlanDefinition.goal.addresses | |||||||||
Element Id | PlanDefinition.goal.addresses | ||||||||
Definition | Identifies problems, conditions, issues, or concerns the goal is intended to address. | ||||||||
Cardinality | 0..* | ||||||||
Terminology Binding | Condition/Problem/Diagnosis Codes (Example) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
PlanDefinition.goal.documentation | |||||||||
Element Id | PlanDefinition.goal.documentation | ||||||||
Definition | Didactic or other informational resources associated with the goal that provide further supporting information about the goal. Information resources can include inline text commentary and links to web resources. | ||||||||
Cardinality | 0..* | ||||||||
Type | RelatedArtifact | ||||||||
Summary | false | ||||||||
PlanDefinition.goal.target | |||||||||
Element Id | PlanDefinition.goal.target | ||||||||
Definition | Indicates what should be done and within what timeframe. | ||||||||
Cardinality | 0..* | ||||||||
Summary | false | ||||||||
PlanDefinition.goal.target.measure | |||||||||
Element Id | PlanDefinition.goal.target.measure | ||||||||
Definition | The parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level. | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | LOINC Codes (Example) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
PlanDefinition.goal.target.detail[x] | |||||||||
Element Id | PlanDefinition.goal.target.detail[x] | ||||||||
Definition | The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value. | ||||||||
Cardinality | 0..1 | ||||||||
Type | Quantity|Range|CodeableConcept | ||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||
Summary | false | ||||||||
PlanDefinition.goal.target.due | |||||||||
Element Id | PlanDefinition.goal.target.due | ||||||||
Definition | Indicates the timeframe after the start of the goal in which the goal should be met. | ||||||||
Cardinality | 0..1 | ||||||||
Type | Duration | ||||||||
Summary | false | ||||||||
PlanDefinition.action | |||||||||
Element Id | PlanDefinition.action | ||||||||
Definition | An action or group of actions to be taken as part of the plan. For example, in clinical care, an action would be to prescribe a particular indicated medication, or perform a particular test as appropriate. In pharmaceutical quality, an action would be the test that needs to be performed on a drug product as defined in the quality specification. | ||||||||
Cardinality | 0..* | ||||||||
Summary | false | ||||||||
Comments | Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information. | ||||||||
PlanDefinition.action.prefix | |||||||||
Element Id | PlanDefinition.action.prefix | ||||||||
Definition | A user-visible prefix for the action. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
PlanDefinition.action.title | |||||||||
Element Id | PlanDefinition.action.title | ||||||||
Definition | The textual description of the action displayed to a user. For example, when the action is a test to be performed, the title would be the title of the test such as Assay by HPLC. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
PlanDefinition.action.description | |||||||||
Element Id | PlanDefinition.action.description | ||||||||
Definition | A brief description of the action used to provide a summary to display to the user. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
PlanDefinition.action.textEquivalent | |||||||||
Element Id | PlanDefinition.action.textEquivalent | ||||||||
Definition | A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
PlanDefinition.action.priority | |||||||||
Element Id | PlanDefinition.action.priority | ||||||||
Definition | Indicates how quickly the action should be addressed with respect to other actions. | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | RequestPriority (Required) | ||||||||
Type | code | ||||||||
Summary | false | ||||||||
PlanDefinition.action.code | |||||||||
Element Id | PlanDefinition.action.code | ||||||||
Definition | A code that provides a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical property. | ||||||||
Cardinality | 0..* | ||||||||
Terminology Binding | ActionCode (Example) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
PlanDefinition.action.reason | |||||||||
Element Id | PlanDefinition.action.reason | ||||||||
Definition | A description of why this action is necessary or appropriate. | ||||||||
Cardinality | 0..* | ||||||||
Terminology Binding | ActionReasonCode (Example) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
Comments | This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action. | ||||||||
PlanDefinition.action.documentation | |||||||||
Element Id | PlanDefinition.action.documentation | ||||||||
Definition | Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources. | ||||||||
Cardinality | 0..* | ||||||||
Type | RelatedArtifact | ||||||||
Summary | false | ||||||||
PlanDefinition.action.goalId | |||||||||
Element Id | PlanDefinition.action.goalId | ||||||||
Definition | Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action. | ||||||||
Cardinality | 0..* | ||||||||
Type | id | ||||||||
Summary | false | ||||||||
PlanDefinition.action.subject[x] | |||||||||
Element Id | PlanDefinition.action.subject[x] | ||||||||
Definition | A code, group definition, or canonical reference that describes the intended subject of the action and its children, if any. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | Subject type (Extensible) | ||||||||
Type | CodeableConcept|Reference(Group)|canonical | ||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||
Meaning if Missing | Patient | ||||||||
Requirements | Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions. | ||||||||
Summary | false | ||||||||
Comments | The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified. In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient). | ||||||||
PlanDefinition.action.trigger | |||||||||
Element Id | PlanDefinition.action.trigger | ||||||||
Definition | A description of when the action should be triggered. | ||||||||
Cardinality | 0..* | ||||||||
Type | TriggerDefinition | ||||||||
Summary | false | ||||||||
PlanDefinition.action.condition | |||||||||
Element Id | PlanDefinition.action.condition | ||||||||
Definition | An expression that describes applicability criteria or start/stop conditions for the action. | ||||||||
Cardinality | 0..* | ||||||||
Summary | false | ||||||||
Comments | When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true. | ||||||||
PlanDefinition.action.condition.kind | |||||||||
Element Id | PlanDefinition.action.condition.kind | ||||||||
Definition | The kind of condition. | ||||||||
Cardinality | 1..1 | ||||||||
Terminology Binding | ActionConditionKind (Required) | ||||||||
Type | code | ||||||||
Summary | false | ||||||||
Comments | Applicability criteria are used to determine immediate applicability when a plan definition is applied to a given context. Start and stop criteria are carried through application and used to describe enter/exit criteria for an action. | ||||||||
PlanDefinition.action.condition.expression | |||||||||
Element Id | PlanDefinition.action.condition.expression | ||||||||
Definition | An expression that returns true or false, indicating whether the condition is satisfied. | ||||||||
Cardinality | 0..1 | ||||||||
Type | Expression | ||||||||
Summary | false | ||||||||
Comments | The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element. | ||||||||
PlanDefinition.action.input | |||||||||
Element Id | PlanDefinition.action.input | ||||||||
Definition | Defines input data requirements for the action. | ||||||||
Cardinality | 0..* | ||||||||
Type | DataRequirement | ||||||||
Summary | false | ||||||||
PlanDefinition.action.output | |||||||||
Element Id | PlanDefinition.action.output | ||||||||
Definition | Defines the outputs of the action, if any. | ||||||||
Cardinality | 0..* | ||||||||
Type | DataRequirement | ||||||||
Summary | false | ||||||||
PlanDefinition.action.relatedAction | |||||||||
Element Id | PlanDefinition.action.relatedAction | ||||||||
Definition | A relationship to another action such as "before" or "30-60 minutes after start of". | ||||||||
Cardinality | 0..* | ||||||||
Summary | false | ||||||||
Comments | When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency. | ||||||||
PlanDefinition.action.relatedAction.actionId | |||||||||
Element Id | PlanDefinition.action.relatedAction.actionId | ||||||||
Definition | The element id of the related action. | ||||||||
Cardinality | 1..1 | ||||||||
Type | id | ||||||||
Summary | false | ||||||||
PlanDefinition.action.relatedAction.relationship | |||||||||
Element Id | PlanDefinition.action.relatedAction.relationship | ||||||||
Definition | The relationship of this action to the related action. | ||||||||
Cardinality | 1..1 | ||||||||
Terminology Binding | ActionRelationshipType (Required) | ||||||||
Type | code | ||||||||
Summary | false | ||||||||
PlanDefinition.action.relatedAction.offset[x] | |||||||||
Element Id | PlanDefinition.action.relatedAction.offset[x] | ||||||||
Definition | A duration or range of durations to apply to the relationship. For example, 30-60 minutes before. | ||||||||
Cardinality | 0..1 | ||||||||
Type | Duration|Range | ||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||
Summary | false | ||||||||
PlanDefinition.action.timing[x] | |||||||||
Element Id | PlanDefinition.action.timing[x] | ||||||||
Definition | An optional value describing when the action should be performed. | ||||||||
Cardinality | 0..1 | ||||||||
Type | dateTime|Age|Period|Duration|Range|Timing | ||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||
Summary | false | ||||||||
PlanDefinition.action.participant | |||||||||
Element Id | PlanDefinition.action.participant | ||||||||
Definition | Indicates who should participate in performing the action described. | ||||||||
Cardinality | 0..* | ||||||||
Summary | false | ||||||||
PlanDefinition.action.participant.type | |||||||||
Element Id | PlanDefinition.action.participant.type | ||||||||
Definition | The type of participant in the action. | ||||||||
Cardinality | 1..1 | ||||||||
Terminology Binding | ActionParticipantType (Required) | ||||||||
Type | code | ||||||||
Summary | false | ||||||||
PlanDefinition.action.participant.role | |||||||||
Element Id | PlanDefinition.action.participant.role | ||||||||
Definition | The role the participant should play in performing the described action. | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | ActionParticipantRole (Example) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
PlanDefinition.action.type | |||||||||
Element Id | PlanDefinition.action.type | ||||||||
Definition | The type of action to perform (create, update, remove). | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | ActionType (Extensible) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
PlanDefinition.action.groupingBehavior | |||||||||
Element Id | PlanDefinition.action.groupingBehavior | ||||||||
Definition | Defines the grouping behavior for the action and its children. | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | ActionGroupingBehavior (Required) | ||||||||
Type | code | ||||||||
Summary | false | ||||||||
PlanDefinition.action.selectionBehavior | |||||||||
Element Id | PlanDefinition.action.selectionBehavior | ||||||||
Definition | Defines the selection behavior for the action and its children. | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | ActionSelectionBehavior (Required) | ||||||||
Type | code | ||||||||
Summary | false | ||||||||
PlanDefinition.action.requiredBehavior | |||||||||
Element Id | PlanDefinition.action.requiredBehavior | ||||||||
Definition | Defines the required behavior for the action. | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | ActionRequiredBehavior (Required) | ||||||||
Type | code | ||||||||
Summary | false | ||||||||
PlanDefinition.action.precheckBehavior | |||||||||
Element Id | PlanDefinition.action.precheckBehavior | ||||||||
Definition | Defines whether the action should usually be preselected. | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | ActionPrecheckBehavior (Required) | ||||||||
Type | code | ||||||||
Summary | false | ||||||||
PlanDefinition.action.cardinalityBehavior | |||||||||
Element Id | PlanDefinition.action.cardinalityBehavior | ||||||||
Definition | Defines whether the action can be selected multiple times. | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | ActionCardinalityBehavior (Required) | ||||||||
Type | code | ||||||||
Summary | false | ||||||||
PlanDefinition.action.definition[x] | |||||||||
Element Id | PlanDefinition.action.definition[x] | ||||||||
Definition | A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken. | ||||||||
Cardinality | 0..1 | ||||||||
Type | canonical(ActivityDefinition | PlanDefinition | Questionnaire)|uri | ||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||
Summary | false | ||||||||
Comments | Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically. | ||||||||
PlanDefinition.action.transform | |||||||||
Element Id | PlanDefinition.action.transform | ||||||||
Definition | A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input. | ||||||||
Cardinality | 0..1 | ||||||||
Type | canonical(StructureMap) | ||||||||
Summary | false | ||||||||
Comments | Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform. | ||||||||
PlanDefinition.action.dynamicValue | |||||||||
Element Id | PlanDefinition.action.dynamicValue | ||||||||
Definition | Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result. | ||||||||
Cardinality | 0..* | ||||||||
Summary | false | ||||||||
Comments | Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform. | ||||||||
PlanDefinition.action.dynamicValue.path | |||||||||
Element Id | PlanDefinition.action.dynamicValue.path | ||||||||
Definition | The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
Comments | To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation. | ||||||||
PlanDefinition.action.dynamicValue.expression | |||||||||
Element Id | PlanDefinition.action.dynamicValue.expression | ||||||||
Definition | An expression specifying the value of the customized element. | ||||||||
Cardinality | 0..1 | ||||||||
Type | Expression | ||||||||
Summary | false | ||||||||
Comments | The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element. | ||||||||
PlanDefinition.action.action | |||||||||
Element Id | PlanDefinition.action.action | ||||||||
Definition | Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition. | ||||||||
Cardinality | 0..* | ||||||||
Type | See PlanDefinition.action | ||||||||
Summary | false |