Clinical Study Schedule of Activities
1.0.0 - trial-use

Clinical Study Schedule of Activities, published by HL7 International - Biomedical Research & Regulation Work Group. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/Vulcan-schedule-ig/ and changes regularly. See the Directory of published versions

## Resource Profile: PlannedStudyVisitSoa - Detailed Descriptions

Active as of 2023-04-18

Definitions for the PlannedStudyVisitSoa resource profile.

- Differential Elements Table
- Key Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be found here.

1. PlanDefinition

Guidance on how to interpret the contents of this table can be found here.

1. 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 artifacts such as clinical decision support rules, order sets and protocols.
Control | 0..*
Summary | false
Invariants | Defined on this element dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (: text.`div`.exists()) pdf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (: name.matches('[A-Z]([A-Za-z0-9_]){0,254}'))
2. PlanDefinition.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Control | 0..1
Type | uri
Is Modifier | true
Summary | true
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
3. PlanDefinition.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | false
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
4. 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.
Control | 0..1
Type | uri
Must Support | true
Summary | true
Requirements | Allows the plan definition to be referenced by a single globally unique identifier.
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. 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.
Control | 0..1 This element is affected by the following invariants: inv-0
Type | string
Must Support | true
Summary | true
Requirements | Support human navigation and code generation.
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. PlanDefinition.title
Definition | A short, descriptive, user-friendly title for the plan definition.
Control | 0..1
Type | string
Must Support | true
Summary | true
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. PlanDefinition.status
Definition | The status of this plan definition. Enables tracking the life-cycle of the content.
Control | 1..1
Binding | The codes SHALL be taken from PublicationStatus The lifecycle status of an artifact.
Type | code
Is Modifier | true
Must Support | true
Summary | true
Comments | Allows filtering of plan definitions that are appropriate for use versus not.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
8. PlanDefinition.subject[x]
Definition | A code or group definition that describes the intended subject of the plan definition.
Control | 0..1
Binding | The codes SHALL be taken from SubjectType; other codes may be used where these codes are not suitable The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
Type | Choice of: CodeableConcept, Reference(Group)
[x] Note | See Choice of Data Types for further information about how to use [x]
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Summary | false
Meaning if Missing | Patient
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
9. PlanDefinition.description
Definition | A free text natural language description of the plan definition from a consumer's perspective.
Control | 0..1
Type | markdown
Must Support | true
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).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
10. PlanDefinition.action
Definition | An action or group of actions to be taken as part of the plan.
Control | 0..*
Type | BackboneElement
Must Support | true
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
11. PlanDefinition.action.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
12. PlanDefinition.action.title
Definition | The title of the action displayed to a user.
Control | 0..1
Type | string
Must Support | true
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. PlanDefinition.action.code
Definition | A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.
Control | 0..*
Type | CodeableConcept
Must Support | true
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. PlanDefinition.action.trigger
Definition | A description of when the action should be triggered.
Control | 0..*
Type | TriggerDefinition
Must Support | true
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. PlanDefinition.action.relatedAction
Definition | A relationship to another action such as "before" or "30-60 minutes after start of".
Control | 0..*
Type | BackboneElement
Must Support | true
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. PlanDefinition.action.relatedAction.extension:acceptableOffsetRange
SliceName | acceptableOffsetRange
Definition | Provides an offset range that, along with offsetDuration, indicates an acceptable range of dates for a related action.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(AcceptableOffsetRangeSoa) (Extension Type: Range)
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
17. PlanDefinition.action.relatedAction.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
18. PlanDefinition.action.relatedAction.actionId
Definition | The element id of the related action.
Control | 1..1
Type | id
Must Support | true
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
19. PlanDefinition.action.relatedAction.relationship
Definition | The relationship of this action to the related action.
Control | 1..1
Binding | The codes SHALL be taken from ActionRelationshipType Defines the types of relationships between actions.
Type | code
Must Support | true
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
20. PlanDefinition.action.relatedAction.offset[x]
Definition | A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.
Control | 0..1
Type | Choice of: Duration, Range
[x] Note | See Choice of Data Types for further information about how to use [x]
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
21. PlanDefinition.action.timing[x]
Definition | An optional value describing when the action should be performed.
Control | 0..1
Type | Choice of: dateTime, Age, Period, Duration, Range, Timing
[x] Note | See Choice of Data Types for further information about how to use [x]
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. PlanDefinition.action.requiredBehavior
Definition | Defines the required behavior for the action.
Control | 0..1
Binding | The codes SHALL be taken from ActionRequiredBehavior Defines expectations around whether an action or action group is required.
Type | code
Must Support | true
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
23. PlanDefinition.action.cardinalityBehavior
Definition | Defines whether the action can be selected multiple times.
Control | 0..1
Binding | The codes SHALL be taken from ActionCardinalityBehavior Defines behavior for an action or a group for how many times that item may be repeated.
Type | code
Must Support | true
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
24. 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.
Control | 0..1
Type | Choice of: canonical(ActivityDefinition|PlanDefinition|Questionnaire), uri
[x] Note | See Choice of Data Types for further information about how to use [x]
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here.

1. 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 artifacts such as clinical decision support rules, order sets and protocols.
Control | 0..*
Summary | false
2. PlanDefinition.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Control | 0..1
Type | id
Summary | true
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
3. PlanDefinition.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Control | 0..1
Type | Meta
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. PlanDefinition.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Control | 0..1
Type | uri
Is Modifier | true
Summary | true
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. PlanDefinition.language
Definition | The base language in which the resource is written.
Control | 0..1
Binding | The codes SHOULD be taken from CommonLanguages A human language
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Summary | false
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. PlanDefinition.text
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Control | 0..1
Type | Narrative
Summary | false
Alternate Names | narrative, html, xhtml, display
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. PlanDefinition.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Control | 0..*
Type | Resource
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
8. PlanDefinition.extension
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
9. PlanDefinition.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | false
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. 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.
Control | 0..1
Type | uri
Must Support | true
Summary | true
Requirements | Allows the plan definition to be referenced by a single globally unique identifier.
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
11. 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)
Control | 0..*
Type | Identifier
Summary | true
Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module.
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. 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)
Control | 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].
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. 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.
Control | 0..1 This element is affected by the following invariants: inv-0
Type | string
Must Support | true
Summary | true
Requirements | Support human navigation and code generation.
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. PlanDefinition.title
Definition | A short, descriptive, user-friendly title for the plan definition.
Control | 0..1
Type | string
Must Support | true
Summary | true
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. PlanDefinition.subtitle
Definition | An explanatory or alternate title for the plan definition giving additional information about its content.
Control | 0..1
Type | string
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. 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.
Control | 0..1
Binding | The codes SHALL be taken from PlanDefinitionType; other codes may be used where these codes are not suitable The type of PlanDefinition
Type | CodeableConcept
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
17. PlanDefinition.status
Definition | The status of this plan definition. Enables tracking the life-cycle of the content.
Control | 1..1
Binding | The codes SHALL be taken from PublicationStatus The lifecycle status of an artifact
Type | code
Is Modifier | true
Must Support | true
Summary | true
Comments | Allows filtering of plan definitions that are appropriate for use versus not.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
18. 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.
Control | 0..1
Type | boolean
Summary | true
Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level plan definition.
Comments | Allows filtering of plan definitions that are appropriate for use versus not.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
19. PlanDefinition.subject[x]
Definition | A code or group definition that describes the intended subject of the plan definition.
Control | 0..1
Binding | The codes SHALL be taken from SubjectType; other codes may be used where these codes are not suitable The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.)
Type | Choice of: CodeableConcept, Reference(Group)
[x] Note | See Choice of Data Types for further information about how to use [x]
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Summary | false
Meaning if Missing | Patient
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
20. 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.
Control | 0..1
Type | dateTime
Summary | true
Alternate Names | Revision Date
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
21. PlanDefinition.publisher
Definition | The name of the organization or individual that published the plan definition.
Control | 0..1
Type | string
Summary | true
Requirements | Helps establish the "authority/credibility" of the plan definition. May also allow for contact.
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. PlanDefinition.contact
Definition | Contact details to assist a user in finding and communicating with the publisher.
Control | 0..*
Type | ContactDetail
Summary | true
Comments | May be a web site, an email address, a telephone number, etc.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
23. PlanDefinition.description
Definition | A free text natural language description of the plan definition from a consumer's perspective.
Control | 0..1
Type | markdown
Must Support | true
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).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
24. 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.
Control | 0..*
Type | UsageContext
Summary | true
Requirements | Assist in searching for appropriate content.
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
25. PlanDefinition.jurisdiction
Definition | A legal or geographic region in which the plan definition is intended to be used.
Control | 0..*
Binding | The codes SHALL be taken from Jurisdiction ValueSet; other codes may be used where these codes are not suitable Countries and regions within which this artifact is targeted for use
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
26. PlanDefinition.purpose
Definition | Explanation of why this plan definition is needed and why it has been designed as it has.
Control | 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
27. PlanDefinition.usage
Definition | A detailed description of how the plan definition is used from a clinical perspective.
Control | 0..1
Type | string
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
28. 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.
Control | 0..1
Type | markdown
Summary | false
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
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
29. 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.
Control | 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
30. 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.
Control | 0..1
Type | date
Summary | false
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.
Comments | If specified, this date follows the original approval date.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
31. PlanDefinition.effectivePeriod
Definition | The period during which the plan definition content was or is planned to be in active use.
Control | 0..1
Type | Period
Summary | true
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.
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
32. 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.
Control | 0..*
Binding | For example codes, see DefinitionTopic High-level categorization of the definition, used for searching, sorting, and filtering
Type | CodeableConcept
Summary | false
Requirements | Repositories must be able to determine how to categorize the plan definition so that it can be found by topical searches.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
33. PlanDefinition.author
Definition | An individiual or organization primarily involved in the creation and maintenance of the content.
Control | 0..*
Type | ContactDetail
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
34. PlanDefinition.editor
Definition | An individual or organization primarily responsible for internal coherence of the content.
Control | 0..*
Type | ContactDetail
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
35. PlanDefinition.reviewer
Definition | An individual or organization primarily responsible for review of some aspect of the content.
Control | 0..*
Type | ContactDetail
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
36. PlanDefinition.endorser
Definition | An individual or organization responsible for officially endorsing the content for use in some setting.
Control | 0..*
Type | ContactDetail
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
37. PlanDefinition.relatedArtifact
Definition | Related artifacts such as additional documentation, justification, or bibliographic references.
Control | 0..*
Type | RelatedArtifact
Summary | false
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.
Comments | Each related artifact is either an attachment, or a reference to another resource, but not both.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
38. PlanDefinition.library
Definition | A reference to a Library resource containing any formal logic used by the plan definition.
Control | 0..*
Type | canonical(Library)
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
39. PlanDefinition.goal
Definition | Goals that describe what the 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, etc.
Control | 0..*
Type | BackboneElement
Summary | false
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
40. PlanDefinition.goal.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
41. PlanDefinition.goal.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
42. PlanDefinition.goal.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
43. PlanDefinition.goal.category
Definition | Indicates a category the goal falls within.
Control | 0..1
Binding | For example codes, see GoalCategory Example codes for grouping goals for filtering or presentation
Type | CodeableConcept
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
44. 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".
Control | 1..1
Binding | For example codes, see SNOMEDCTClinicalFindings Describes goals that can be achieved
Type | CodeableConcept
Summary | false
Comments | If no code is available, use CodeableConcept.text.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
45. PlanDefinition.goal.priority
Definition | Identifies the expected level of importance associated with reaching/sustaining the defined goal.
Control | 0..1
Binding | The codes SHOULD be taken from GoalPriority Indicates the level of importance associated with reaching or sustaining a goal
Type | CodeableConcept
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
46. PlanDefinition.goal.start
Definition | The event after which the goal should begin being pursued.
Control | 0..1
Binding | For example codes, see GoalStartEvent Identifies the types of events that might trigger the start of a goal
Type | CodeableConcept
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
47. PlanDefinition.goal.addresses
Definition | Identifies problems, conditions, issues, or concerns the goal is intended to address.
Control | 0..*
Binding | For example codes, see Condition/Problem/DiagnosisCodes Identifies problems, conditions, issues, or concerns that goals may address
Type | CodeableConcept
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
48. 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.
Control | 0..*
Type | RelatedArtifact
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
49. PlanDefinition.goal.target
Definition | Indicates what should be done and within what timeframe.
Control | 0..*
Type | BackboneElement
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
50. PlanDefinition.goal.target.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
51. PlanDefinition.goal.target.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
52. PlanDefinition.goal.target.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
53. PlanDefinition.goal.target.measure
Definition | The parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.
Control | 0..1
Binding | For example codes, see LOINCCodes Identifies types of parameters that can be tracked to determine goal achievement
Type | CodeableConcept
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
54. 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%. 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.
Control | 0..1
Type | Choice of: Quantity, Range, CodeableConcept
[x] Note | See Choice of Data Types for further information about how to use [x]
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
55. PlanDefinition.goal.target.due
Definition | Indicates the timeframe after the start of the goal in which the goal should be met.
Control | 0..1
Type | Duration
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
56. PlanDefinition.action
Definition | An action or group of actions to be taken as part of the plan.
Control | 0..*
Type | BackboneElement
Must Support | true
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
57. PlanDefinition.action.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
58. PlanDefinition.action.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
59. PlanDefinition.action.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
60. PlanDefinition.action.prefix
Definition | A user-visible prefix for the action.
Control | 0..1
Type | string
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
61. PlanDefinition.action.title
Definition | The title of the action displayed to a user.
Control | 0..1
Type | string
Must Support | true
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
62. PlanDefinition.action.description
Definition | A brief description of the action used to provide a summary to display to the user.
Control | 0..1
Type | string
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
63. 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.
Control | 0..1
Type | string
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
64. PlanDefinition.action.priority
Definition | Indicates how quickly the action should be addressed with respect to other actions.
Control | 0..1
Binding | The codes SHALL be taken from RequestPriority Identifies the level of importance to be assigned to actioning the request
Type | code
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
65. PlanDefinition.action.code
Definition | A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.
Control | 0..*
Type | CodeableConcept
Must Support | true
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
66. PlanDefinition.action.reason
Definition | A description of why this action is necessary or appropriate.
Control | 0..*
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
67. 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.
Control | 0..*
Type | RelatedArtifact
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
68. PlanDefinition.action.goalId
Definition | Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.
Control | 0..*
Type | id
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
69. PlanDefinition.action.subject[x]
Definition | A code or group definition that describes the intended subject of the action and its children, if any.
Control | 0..1
Binding | The codes SHALL be taken from SubjectType; other codes may be used where these codes are not suitable The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.)
Type | Choice of: CodeableConcept, Reference(Group)
[x] Note | See Choice of Data Types for further information about how to use [x]
Summary | false
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.
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).
Meaning if Missing | Patient
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
70. PlanDefinition.action.trigger
Definition | A description of when the action should be triggered.
Control | 0..*
Type | TriggerDefinition
Must Support | true
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
71. PlanDefinition.action.condition
Definition | An expression that describes applicability criteria or start/stop conditions for the action.
Control | 0..*
Type | BackboneElement
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
72. PlanDefinition.action.condition.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
73. PlanDefinition.action.condition.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
74. PlanDefinition.action.condition.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
75. PlanDefinition.action.condition.kind
Definition | The kind of condition.
Control | 1..1
Binding | The codes SHALL be taken from ActionConditionKind Defines the kinds of conditions that can appear on actions
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
76. PlanDefinition.action.condition.expression
Definition | An expression that returns true or false, indicating whether the condition is satisfied.
Control | 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
77. PlanDefinition.action.input
Definition | Defines input data requirements for the action.
Control | 0..*
Type | DataRequirement
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
78. PlanDefinition.action.output
Definition | Defines the outputs of the action, if any.
Control | 0..*
Type | DataRequirement
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
79. PlanDefinition.action.relatedAction
Definition | A relationship to another action such as "before" or "30-60 minutes after start of".
Control | 0..*
Type | BackboneElement
Must Support | true
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
80. PlanDefinition.action.relatedAction.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
81. PlanDefinition.action.relatedAction.extension
Definition | An Extension
Control | 0..*
Type | Extension
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on PlanDefinition.action.relatedAction.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
82. PlanDefinition.action.relatedAction.extension:acceptableOffsetRange
SliceName | acceptableOffsetRange
Definition | Provides an offset range that, along with offsetDuration, indicates an acceptable range of dates for a related action.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(AcceptableOffsetRangeSoa) (Extension Type: Range)
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
83. PlanDefinition.action.relatedAction.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
84. PlanDefinition.action.relatedAction.actionId
Definition | The element id of the related action.
Control | 1..1
Type | id
Must Support | true
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
85. PlanDefinition.action.relatedAction.relationship
Definition | The relationship of this action to the related action.
Control | 1..1
Binding | The codes SHALL be taken from ActionRelationshipType Defines the types of relationships between actions
Type | code
Must Support | true
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
86. PlanDefinition.action.relatedAction.offset[x]
Definition | A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.
Control | 0..1
Type | Choice of: Duration, Range
[x] Note | See Choice of Data Types for further information about how to use [x]
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
87. PlanDefinition.action.timing[x]
Definition | An optional value describing when the action should be performed.
Control | 0..1
Type | Choice of: dateTime, Age, Period, Duration, Range, Timing
[x] Note | See Choice of Data Types for further information about how to use [x]
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
88. PlanDefinition.action.participant
Definition | Indicates who should participate in performing the action described.
Control | 0..*
Type | BackboneElement
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
89. PlanDefinition.action.participant.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
90. PlanDefinition.action.participant.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
91. PlanDefinition.action.participant.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
92. PlanDefinition.action.participant.type
Definition | The type of participant in the action.
Control | 1..1
Binding | The codes SHALL be taken from ActionParticipantType The type of participant for the action
Type | code
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
93. PlanDefinition.action.participant.role
Definition | The role the participant should play in performing the described action.
Control | 0..1
Binding | For example codes, see ActionParticipantRole Defines roles played by participants for the action
Type | CodeableConcept
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
94. PlanDefinition.action.type
Definition | The type of action to perform (create, update, remove).
Control | 0..1
Binding | The codes SHALL be taken from ActionType; other codes may be used where these codes are not suitable The type of action to be performed
Type | CodeableConcept
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
95. PlanDefinition.action.groupingBehavior
Definition | Defines the grouping behavior for the action and its children.
Control | 0..1
Binding | The codes SHALL be taken from ActionGroupingBehavior Defines organization behavior of a group
Type | code
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
96. PlanDefinition.action.selectionBehavior
Definition | Defines the selection behavior for the action and its children.
Control | 0..1
Binding | The codes SHALL be taken from ActionSelectionBehavior Defines selection behavior of a group
Type | code
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
97. PlanDefinition.action.requiredBehavior
Definition | Defines the required behavior for the action.
Control | 0..1
Binding | The codes SHALL be taken from ActionRequiredBehavior Defines expectations around whether an action or action group is required
Type | code
Must Support | true
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
98. PlanDefinition.action.precheckBehavior
Definition | Defines whether the action should usually be preselected.
Control | 0..1
Binding | The codes SHALL be taken from ActionPrecheckBehavior Defines selection frequency behavior for an action or group
Type | code
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
99. PlanDefinition.action.cardinalityBehavior
Definition | Defines whether the action can be selected multiple times.
Control | 0..1
Binding | The codes SHALL be taken from ActionCardinalityBehavior Defines behavior for an action or a group for how many times that item may be repeated
Type | code
Must Support | true
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
100. 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.
Control | 0..1
Type | Choice of: canonical(ActivityDefinition|PlanDefinition|Questionnaire), uri
[x] Note | See Choice of Data Types for further information about how to use [x]
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
101. 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.
Control | 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
102. 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.
Control | 0..*
Type | BackboneElement
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
103. PlanDefinition.action.dynamicValue.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
104. PlanDefinition.action.dynamicValue.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
105. PlanDefinition.action.dynamicValue.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
106. 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).
Control | 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
107. PlanDefinition.action.dynamicValue.expression
Definition | An expression specifying the value of the customized element.
Control | 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
108. 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.
Control | 0..*
Type | See ttp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))