This page is part of the Pharmaceutical Quality (Industry) (v1.0.0: STU1) based on FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions
Active as of 2024-05-08 |
Definitions for the PlanDefinition-drug-pq resource profile.
Guidance on how to interpret the contents of this table can be found here
0. PlanDefinition | |||||||||
2. PlanDefinition.extension | |||||||||
Slicing | This element introduces a set of slices on PlanDefinition.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||||||
4. PlanDefinition.extension:plan-document-reference | |||||||||
Slice Name | plan-document-reference | ||||||||
Short | plan-document-reference | ||||||||
Control | 0..? | ||||||||
Type | Extension(Extension - Plan Document Reference PQ) (Extension Type: Reference(DocumentReference - Drug PQ)) | ||||||||
Must Support | true | ||||||||
6. PlanDefinition.extension:history-of-process | |||||||||
Slice Name | history-of-process | ||||||||
Short | history-of-process | ||||||||
Control | 0..? | ||||||||
Type | Extension(Extension - History of Process PQ) (Extension Type: Choice of: markdown, string) | ||||||||
Must Support | true | ||||||||
8. PlanDefinition.identifier | |||||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
Must Support | true | ||||||||
10. PlanDefinition.version | |||||||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||||||
Must Support | true | ||||||||
12. PlanDefinition.title | |||||||||
Must Support | true | ||||||||
14. PlanDefinition.type | |||||||||
Binding | For example codes, see Plan Type (example to http://hl7.org/fhir/uv/pharm-quality/ValueSet/vs-planType-pq ) | ||||||||
Must Support | true | ||||||||
16. PlanDefinition.status | |||||||||
Must Support | true | ||||||||
18. PlanDefinition.subject[x] | |||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||
Must Support | true | ||||||||
20. PlanDefinition.jurisdiction | |||||||||
Must Support | true | ||||||||
22. PlanDefinition.effectivePeriod | |||||||||
Must Support | true | ||||||||
24. PlanDefinition.goal | |||||||||
Must Support | true | ||||||||
26. PlanDefinition.goal.category | |||||||||
Binding | For example codes, see Equipment Classes (example to http://hl7.org/fhir/uv/pharm-quality/ValueSet/vs-equipmentClass-pq ) | ||||||||
Must Support | true | ||||||||
28. PlanDefinition.goal.priority | |||||||||
Short | high-priority | medium-priority | low-priority | ||||||||
Binding | For example codes, see Goal Priority (example to http://hl7.org/fhir/uv/pharm-quality/ValueSet/vs-goalPriority-pq ) | ||||||||
Type | CodeableConcept | ||||||||
Must Support | true | ||||||||
30. PlanDefinition.actor | |||||||||
32. PlanDefinition.actor.option | |||||||||
34. PlanDefinition.actor.option.role | |||||||||
Binding | For example codes, see Test Category (example to http://hl7.org/fhir/uv/pharm-quality/ValueSet/vs-testCategory-pq ) | ||||||||
36. PlanDefinition.action | |||||||||
Must Support | true | ||||||||
38. PlanDefinition.action.extension | |||||||||
Slicing | This element introduces a set of slices on PlanDefinition.action.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||||||
40. PlanDefinition.action.extension:process-parameters | |||||||||
Slice Name | process-parameters | ||||||||
Short | process-parameters | ||||||||
Type | Extension(Extension - Process Parameters PQ) (Complex Extension) | ||||||||
Must Support | true | ||||||||
42. PlanDefinition.action.extension:process-step-scale | |||||||||
Slice Name | process-step-scale | ||||||||
Short | process-step-scale | ||||||||
Type | Extension(Extension - Process Step Scale PQ) (Extension Type: Coding) | ||||||||
Must Support | true | ||||||||
44. PlanDefinition.action.code | |||||||||
Binding | For example codes, see ActionCode (example to http://hl7.org/fhir/ValueSet/action-code )
| ||||||||
Must Support | true | ||||||||
46. PlanDefinition.action.participant | |||||||||
48. PlanDefinition.action.participant.typeReference | |||||||||
50. PlanDefinition.action.participant.typeReference.extension | |||||||||
Slicing | This element introduces a set of slices on PlanDefinition.action.participant.typeReference.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||||||
52. PlanDefinition.action.participant.typeReference.extension:manufacturing-participant | |||||||||
Slice Name | manufacturing-participant | ||||||||
Short | manufacturing-participant | ||||||||
Type | Extension(Extension - Manufacturing Participant PQ) (Extension Type: Reference(SubstanceDefinition - Component Substance Drug PQ)) | ||||||||
Must Support | true | ||||||||
54. PlanDefinition.action.participant.role | |||||||||
Binding | For example codes, see Manufacturing Participant Role (example to http://hl7.org/fhir/uv/pharm-quality/ValueSet/vs-manufacturingParticipantRole-pq ) | ||||||||
Must Support | true |
Guidance on how to interpret the contents of this table can be found here
0. PlanDefinition | |||||||||
Definition | This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical and non-clinical artifacts such as clinical decision support rules, order sets, protocols, and drug quality specifications. | ||||||||
Short | The definition of a plan for a series of actions, independent of any specific patient or context | ||||||||
Control | 0..* | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')) pld-3: goalid should reference the id of a goal definition (%context.repeat(action).where((goalId in %context.goal.id).not()).exists().not()) pld-4: targetId should reference the id of an action (%context.repeat(action).relatedAction.where((targetId in %context.repeat(action).id).not()).exists().not()) | ||||||||
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. | ||||||||
Short | A set of rules under which this content was created | ||||||||
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 its narrative along with other profiles, value sets, etc. | ||||||||
Control | 0..1 | ||||||||
Type | uri | ||||||||
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | true | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
4. PlanDefinition.contained | |||||||||
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. | ||||||||
Short | Contained, inline 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. | ||||||||
Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 | ||||||||
Type | Resource | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||||||
6. PlanDefinition.extension | |||||||||
Definition | An Extension 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 managable, 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. | ||||||||
Short | ExtensionAdditional content defined by implementations | ||||||||
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. | ||||||||
Control | 0..* | ||||||||
Type | Extension | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Alternate Names | extensions, user content | ||||||||
Invariants | 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.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||||||
8. PlanDefinition.extension:plan-document-reference | |||||||||
Slice Name | plan-document-reference | ||||||||
Definition | An Extension | ||||||||
Short | plan-document-reference | ||||||||
Control | 0..* | ||||||||
Type | Extension(Extension - Plan Document Reference PQ) (Extension Type: Reference(DocumentReference - Drug PQ)) | ||||||||
Is Modifier | false | ||||||||
Must Support | true | ||||||||
Invariants | 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.extension:history-of-process | |||||||||
Slice Name | history-of-process | ||||||||
Definition | An Extension | ||||||||
Short | history-of-process | ||||||||
Control | 0..* | ||||||||
Type | Extension(Extension - History of Process PQ) (Extension Type: Choice of: markdown, string) | ||||||||
Is Modifier | false | ||||||||
Must Support | true | ||||||||
Invariants | 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.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 managable, 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). | ||||||||
Short | Extensions that cannot be ignored | ||||||||
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. | ||||||||
Control | 0..* | ||||||||
Type | Extension | ||||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||||||
Must Support | false | ||||||||
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 | ||||||||
Invariants | 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()) | ||||||||
14. 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. | ||||||||
Short | Additional identifier for the plan definition | ||||||||
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. | ||||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
Control | 0..* | ||||||||
Type | Identifier | ||||||||
Is Modifier | false | ||||||||
Must Support | true | ||||||||
Summary | true | ||||||||
Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module. | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
16. 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. | ||||||||
Short | Business version of the plan definition | ||||||||
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]. The version SHOULD NOT contain a '#' - see Business Version. | ||||||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||||||
Control | 0..1 | ||||||||
Type | string | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | true | ||||||||
Summary | true | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
18. PlanDefinition.title | |||||||||
Definition | A short, descriptive, user-friendly title for the plan definition. | ||||||||
Short | Name for this plan definition (human friendly) | ||||||||
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. | ||||||||
Control | 0..1 | ||||||||
Type | string | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | true | ||||||||
Summary | true | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
20. 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. | ||||||||
Short | order-set | clinical-protocol | eca-rule | workflow-definition | ||||||||
Control | 0..1 | ||||||||
Binding | For example codes, see Unless not suitable, these codes SHALL be taken from Plan Typehttp://hl7.org/fhir/ValueSet/plan-definition-type (example to http://hl7.org/fhir/uv/pharm-quality/ValueSet/vs-planType-pq ) | ||||||||
Type | CodeableConcept | ||||||||
Is Modifier | false | ||||||||
Must Support | true | ||||||||
Summary | true | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
22. PlanDefinition.status | |||||||||
Definition | The status of this plan definition. Enables tracking the life-cycle of the content. | ||||||||
Short | draft | active | retired | unknown | ||||||||
Comments | Allows filtering of plan definitions that are appropriate for use versus not. See guidance around (not) making local changes to elements here. | ||||||||
Control | 1..1 | ||||||||
Binding | The codes SHALL be taken from PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0 (required to http://hl7.org/fhir/ValueSet/publication-status|5.0.0 )The lifecycle status of an artifact. | ||||||||
Type | code | ||||||||
Is Modifier | true because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | true | ||||||||
Summary | true | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
24. PlanDefinition.subject[x] | |||||||||
Definition | A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. | ||||||||
Short | Type of individual the plan definition is focused on | ||||||||
Comments | Note that the choice of canonical for the subject element was introduced in R4B to support pharmaceutical quality use cases. To ensure as much backwards-compatibility as possible, it is recommended to only use the new canonical type with these use cases. | ||||||||
Control | 0..1 | ||||||||
Binding | Unless not suitable, these codes SHALL be taken from ParticipantResourceTypeshttp://hl7.org/fhir/ValueSet/participant-resource-types (extensible to http://hl7.org/fhir/ValueSet/participant-resource-types )The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||||
Type | Choice of: CodeableConcept, Reference(Group, MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, PackagedProductDefinition), canonical(EvidenceVariable) | ||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | true | ||||||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||||||
Summary | false | ||||||||
Meaning if Missing | Patient | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
26. PlanDefinition.jurisdiction | |||||||||
Definition | A legal or geographic region in which the plan definition is intended to be used. | ||||||||
Short | Intended jurisdiction for plan definition (if applicable) | ||||||||
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. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) | ||||||||
Control | 0..* | ||||||||
Binding | Unless not suitable, these codes SHALL be taken from JurisdictionValueSethttp://hl7.org/fhir/ValueSet/jurisdiction (extensible to http://hl7.org/fhir/ValueSet/jurisdiction )Countries and regions within which this artifact is targeted for use. | ||||||||
Type | CodeableConcept | ||||||||
Is Modifier | false | ||||||||
Must Support | true | ||||||||
Summary | true | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
28. PlanDefinition.effectivePeriod | |||||||||
Definition | The period during which the plan definition content was or is planned to be in active use. | ||||||||
Short | When the plan definition is expected to be used | ||||||||
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 plan definition intended to be used for the year 2016 might be published in 2015. See guidance around (not) making local changes to elements here. | ||||||||
Control | 0..1 | ||||||||
Type | Period | ||||||||
Is Modifier | false | ||||||||
Must Support | true | ||||||||
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. | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
30. PlanDefinition.goal | |||||||||
Definition | A goal describes an expected outcome that activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, meeting the acceptance criteria for a test as specified by a quality specification, etc. | ||||||||
Short | What the plan is trying to accomplish | ||||||||
Control | 0..* This element is affected by the following invariants: pld-3 | ||||||||
Type | BackboneElement | ||||||||
Is Modifier | false | ||||||||
Must Support | true | ||||||||
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 | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
32. 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 managable, 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). | ||||||||
Short | Extensions that cannot be ignored even if unrecognized | ||||||||
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. | ||||||||
Control | 0..* | ||||||||
Type | Extension | ||||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||||
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 | ||||||||
Invariants | 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()) | ||||||||
34. PlanDefinition.goal.category | |||||||||
Definition | Indicates a category the goal falls within. | ||||||||
Short | E.g. Treatment, dietary, behavioral | ||||||||
Control | 0..1 | ||||||||
Binding | For example codes, see Equipment Classeshttp://hl7.org/fhir/ValueSet/goal-category (example to http://hl7.org/fhir/uv/pharm-quality/ValueSet/vs-equipmentClass-pq ) | ||||||||
Type | CodeableConcept | ||||||||
Is Modifier | false | ||||||||
Must Support | true | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
36. 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". | ||||||||
Short | Code or text describing the goal | ||||||||
Comments | If no code is available, use CodeableConcept.text. | ||||||||
Control | 1..1 | ||||||||
Binding | For example codes, see SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings (example to http://hl7.org/fhir/ValueSet/clinical-findings )Describes goals that can be achieved. | ||||||||
Type | CodeableConcept | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
38. PlanDefinition.goal.priority | |||||||||
Definition | Identifies the expected level of importance associated with reaching/sustaining the defined goal. | ||||||||
Short | high-priority | medium-priority | low-priority | ||||||||
Control | 0..1 | ||||||||
Binding | For example codes, see The codes SHOULD be taken from Goal Priorityhttp://hl7.org/fhir/ValueSet/goal-priority (example to http://hl7.org/fhir/uv/pharm-quality/ValueSet/vs-goalPriority-pq ) | ||||||||
Type | CodeableConcept | ||||||||
Is Modifier | false | ||||||||
Must Support | true | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
40. PlanDefinition.action | |||||||||
Definition | An action or group of actions to be taken as part of the plan. For example, in clinical care, an action would be to prescribe a particular indicated medication, or perform a particular test as appropriate. In pharmaceutical quality, an action would be the test that needs to be performed on a drug product as defined in the quality specification. | ||||||||
Short | Action defined by the plan | ||||||||
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. | ||||||||
Control | 0..* This element is affected by the following invariants: pld-3, pld-4 | ||||||||
Type | BackboneElement | ||||||||
Is Modifier | false | ||||||||
Must Support | true | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
42. PlanDefinition.action.extension | |||||||||
Definition | An Extension 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 managable, 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. | ||||||||
Short | ExtensionAdditional content defined by implementations | ||||||||
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. | ||||||||
Control | 0..* | ||||||||
Type | Extension | ||||||||
Is Modifier | false | ||||||||
Summary | false | ||||||||
Alternate Names | extensions, user content | ||||||||
Invariants | 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.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||||||
44. PlanDefinition.action.extension:process-parameters | |||||||||
Slice Name | process-parameters | ||||||||
Definition | An Extension | ||||||||
Short | process-parameters | ||||||||
Control | 0..* | ||||||||
Type | Extension(Extension - Process Parameters PQ) (Complex Extension) | ||||||||
Is Modifier | false | ||||||||
Must Support | true | ||||||||
Invariants | 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() ) | ||||||||
46. PlanDefinition.action.extension:process-step-scale | |||||||||
Slice Name | process-step-scale | ||||||||
Definition | An Extension | ||||||||
Short | process-step-scale | ||||||||
Control | 0..* | ||||||||
Type | Extension(Extension - Process Step Scale PQ) (Extension Type: Coding) | ||||||||
Is Modifier | false | ||||||||
Must Support | true | ||||||||
Invariants | 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()) | ||||||||
48. 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 managable, 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). | ||||||||
Short | Extensions that cannot be ignored even if unrecognized | ||||||||
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. | ||||||||
Control | 0..* | ||||||||
Type | Extension | ||||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||||
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 | ||||||||
Invariants | 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()) | ||||||||
50. PlanDefinition.action.code | |||||||||
Definition | A code that provides a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical property. | ||||||||
Short | Code representing the meaning of the action or sub-actions | ||||||||
Control | 0..1 | ||||||||
Binding | For example codes, see ActionCodehttp://hl7.org/fhir/ValueSet/action-code (example to http://hl7.org/fhir/ValueSet/action-code )
| ||||||||
Type | CodeableConcept | ||||||||
Is Modifier | false | ||||||||
Must Support | true | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
52. PlanDefinition.action.participant | |||||||||
Definition | Indicates who should participate in performing the action described. | ||||||||
Short | Who should participate in the action | ||||||||
Control | 0..* | ||||||||
Type | BackboneElement | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
54. 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 managable, 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). | ||||||||
Short | Extensions that cannot be ignored even if unrecognized | ||||||||
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. | ||||||||
Control | 0..* | ||||||||
Type | Extension | ||||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||||
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 | ||||||||
Invariants | 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()) | ||||||||
56. PlanDefinition.action.participant.typeReference | |||||||||
Definition | The type of participant in the action. | ||||||||
Short | Who or what can participate | ||||||||
Comments | When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location). | ||||||||
Control | 0..1 | ||||||||
Type | Reference(CareTeam, Device, DeviceDefinition, Endpoint, Group, HealthcareService, Location, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson) | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
58. PlanDefinition.action.participant.typeReference.extension | |||||||||
Definition | An Extension 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 managable, 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. | ||||||||
Short | ExtensionAdditional content defined by implementations | ||||||||
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. | ||||||||
Control | 0..* | ||||||||
Type | Extension | ||||||||
Is Modifier | false | ||||||||
Summary | false | ||||||||
Alternate Names | extensions, user content | ||||||||
Invariants | 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.participant.typeReference.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||||||
60. PlanDefinition.action.participant.typeReference.extension:manufacturing-participant | |||||||||
Slice Name | manufacturing-participant | ||||||||
Definition | An Extension | ||||||||
Short | manufacturing-participant | ||||||||
Control | 0..* | ||||||||
Type | Extension(Extension - Manufacturing Participant PQ) (Extension Type: Reference(SubstanceDefinition - Component Substance Drug PQ)) | ||||||||
Is Modifier | false | ||||||||
Must Support | true | ||||||||
Summary | false | ||||||||
Invariants | 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()) | ||||||||
62. PlanDefinition.action.participant.typeReference.reference | |||||||||
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||||||
Short | Literal reference, Relative, internal or absolute URL | ||||||||
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||||||
Control | 0..1 This element is affected by the following invariants: ref-2, ref-1 | ||||||||
Type | string | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Summary | true | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
64. PlanDefinition.action.participant.role | |||||||||
Definition | The role the participant should play in performing the described action. | ||||||||
Short | E.g. Nurse, Surgeon, Parent | ||||||||
Control | 0..1 | ||||||||
Binding | For example codes, see Manufacturing Participant Rolehttp://terminology.hl7.org/ValueSet/action-participant-role (example to http://hl7.org/fhir/uv/pharm-quality/ValueSet/vs-manufacturingParticipantRole-pq ) | ||||||||
Type | CodeableConcept | ||||||||
Is Modifier | false | ||||||||
Must Support | true | ||||||||
Summary | false | ||||||||
Invariants | 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
0. PlanDefinition | |||||||||
Definition | This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical and non-clinical artifacts such as clinical decision support rules, order sets, protocols, and drug quality specifications. | ||||||||
Short | The definition of a plan for a series of actions, independent of any specific patient or context | ||||||||
Control | 0..* | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') )pld-3: goalid should reference the id of a goal definition ( %context.repeat(action).where((goalId in %context.goal.id).not()).exists().not() )pld-4: targetId should reference the id of an action ( %context.repeat(action).relatedAction.where((targetId in %context.repeat(action).id).not()).exists().not() ) | ||||||||
2. PlanDefinition.id | |||||||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||||||
Short | Logical id of this artifact | ||||||||
Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. | ||||||||
Control | 0..1 | ||||||||
Type | id | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | true | ||||||||
4. 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. | ||||||||
Short | Metadata about the resource | ||||||||
Control | 0..1 | ||||||||
Type | Meta | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | true | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
6. 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. | ||||||||
Short | A set of rules under which this content was created | ||||||||
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 its narrative along with other profiles, value sets, etc. | ||||||||
Control | 0..1 | ||||||||
Type | uri | ||||||||
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | true | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
8. PlanDefinition.language | |||||||||
Definition | The base language in which the resource is written. | ||||||||
Short | Language of the resource content | ||||||||
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). | ||||||||
Control | 0..1 | ||||||||
Binding | The codes SHALL be taken from AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0 )IETF language tag for a human language | ||||||||
Type | code | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
10. 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. | ||||||||
Short | Text summary of the resource, for human interpretation | ||||||||
Comments | Contained resources do not have a 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. | ||||||||
Control | 0..1 This element is affected by the following invariants: dom-6 | ||||||||
Type | Narrative | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Alternate Names | narrative, html, xhtml, display | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
12. PlanDefinition.contained | |||||||||
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. | ||||||||
Short | Contained, inline 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. | ||||||||
Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 | ||||||||
Type | Resource | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||||||
14. PlanDefinition.extension | |||||||||
Definition | An Extension | ||||||||
Short | Extension | ||||||||
Control | 0..* | ||||||||
Type | Extension | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | 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.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||||||
16. PlanDefinition.extension:plan-document-reference | |||||||||
Slice Name | plan-document-reference | ||||||||
Definition | An Extension | ||||||||
Short | plan-document-reference | ||||||||
Control | 0..* | ||||||||
Type | Extension(Extension - Plan Document Reference PQ) (Extension Type: Reference(DocumentReference - Drug PQ)) | ||||||||
Is Modifier | false | ||||||||
Must Support | true | ||||||||
Invariants | 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.extension:history-of-process | |||||||||
Slice Name | history-of-process | ||||||||
Definition | An Extension | ||||||||
Short | history-of-process | ||||||||
Control | 0..* | ||||||||
Type | Extension(Extension - History of Process PQ) (Extension Type: Choice of: markdown, string) | ||||||||
Is Modifier | false | ||||||||
Must Support | true | ||||||||
Invariants | 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() ) | ||||||||
20. 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 managable, 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). | ||||||||
Short | Extensions that cannot be ignored | ||||||||
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. | ||||||||
Control | 0..* | ||||||||
Type | Extension | ||||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||||||
Must Support | false | ||||||||
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 | ||||||||
Invariants | 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() ) | ||||||||
22. 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 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. | ||||||||
Short | Canonical identifier for this plan definition, represented as a URI (globally unique) | ||||||||
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. | ||||||||
Control | 0..1 | ||||||||
Type | uri | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | true | ||||||||
Requirements | Allows the plan definition to be referenced by a single globally unique identifier. | ||||||||
Invariants | cnl-1: URL should not contain | or # - these characters make processing canonical references problematic (exists() implies matches('^[^|# ]+$') )ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) ) | ||||||||
24. 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. | ||||||||
Short | Additional identifier for the plan definition | ||||||||
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. | ||||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
Control | 0..* | ||||||||
Type | Identifier | ||||||||
Is Modifier | false | ||||||||
Must Support | true | ||||||||
Summary | true | ||||||||
Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module. | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
26. 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. | ||||||||
Short | Business version of the plan definition | ||||||||
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]. The version SHOULD NOT contain a '#' - see Business Version. | ||||||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||||||
Control | 0..1 | ||||||||
Type | string | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | true | ||||||||
Summary | true | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
28. PlanDefinition.versionAlgorithm[x] | |||||||||
Definition | Indicates the mechanism used to compare versions to determine which is more current. | ||||||||
Short | How to compare versions | ||||||||
Comments | If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. | ||||||||
Control | 0..1 | ||||||||
Binding | Unless not suitable, these codes SHALL be taken from VersionAlgorithm (extensible to http://hl7.org/fhir/ValueSet/version-algorithm ) | ||||||||
Type | Choice of: string, Coding | ||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | true | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
30. 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. | ||||||||
Short | Name for this plan definition (computer friendly) | ||||||||
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. | ||||||||
Control | 0..1 This element is affected by the following invariants: cnl-0 | ||||||||
Type | string | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | true | ||||||||
Requirements | Support human navigation and code generation. | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
32. PlanDefinition.title | |||||||||
Definition | A short, descriptive, user-friendly title for the plan definition. | ||||||||
Short | Name for this plan definition (human friendly) | ||||||||
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. | ||||||||
Control | 0..1 | ||||||||
Type | string | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | true | ||||||||
Summary | true | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
34. PlanDefinition.subtitle | |||||||||
Definition | An explanatory or alternate title for the plan definition giving additional information about its content. | ||||||||
Short | Subordinate title of the plan definition | ||||||||
Control | 0..1 | ||||||||
Type | string | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
36. 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. | ||||||||
Short | order-set | clinical-protocol | eca-rule | workflow-definition | ||||||||
Control | 0..1 | ||||||||
Binding | For example codes, see Plan Type (example to http://hl7.org/fhir/uv/pharm-quality/ValueSet/vs-planType-pq ) | ||||||||
Type | CodeableConcept | ||||||||
Is Modifier | false | ||||||||
Must Support | true | ||||||||
Summary | true | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
38. PlanDefinition.status | |||||||||
Definition | The status of this plan definition. Enables tracking the life-cycle of the content. | ||||||||
Short | draft | active | retired | unknown | ||||||||
Comments | Allows filtering of plan definitions that are appropriate for use versus not. See guidance around (not) making local changes to elements here. | ||||||||
Control | 1..1 | ||||||||
Binding | The codes SHALL be taken from PublicationStatus (required to http://hl7.org/fhir/ValueSet/publication-status|5.0.0 )The lifecycle status of an artifact. | ||||||||
Type | code | ||||||||
Is Modifier | true because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | true | ||||||||
Summary | true | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
40. 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. | ||||||||
Short | For testing purposes, not real usage | ||||||||
Comments | Allows filtering of plan definitions that are appropriate for use versus not. | ||||||||
Control | 0..1 | ||||||||
Type | boolean | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | true | ||||||||
Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level plan definition. | ||||||||
Meaning if Missing | If absent, this resource is treated as though it is not experimental. | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
42. PlanDefinition.subject[x] | |||||||||
Definition | A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. | ||||||||
Short | Type of individual the plan definition is focused on | ||||||||
Comments | Note that the choice of canonical for the subject element was introduced in R4B to support pharmaceutical quality use cases. To ensure as much backwards-compatibility as possible, it is recommended to only use the new canonical type with these use cases. | ||||||||
Control | 0..1 | ||||||||
Binding | Unless not suitable, these codes SHALL be taken from ParticipantResourceTypes (extensible to http://hl7.org/fhir/ValueSet/participant-resource-types )The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||||
Type | Choice of: CodeableConcept, Reference(Group, MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, PackagedProductDefinition), canonical(EvidenceVariable) | ||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | true | ||||||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||||||
Summary | false | ||||||||
Meaning if Missing | Patient | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
44. PlanDefinition.date | |||||||||
Definition | The date (and optionally time) when the plan definition was last significantly changed. 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. | ||||||||
Short | Date last changed | ||||||||
Comments | The date is often not tracked until the resource is published, but may be present on draft content. 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. See guidance around (not) making local changes to elements here. | ||||||||
Control | 0..1 | ||||||||
Type | dateTime | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | true | ||||||||
Alternate Names | Revision Date | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
46. PlanDefinition.publisher | |||||||||
Definition | The name of the organization or individual responsible for the release and ongoing maintenance of the plan definition. | ||||||||
Short | Name of the publisher/steward (organization or individual) | ||||||||
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. | ||||||||
Control | 0..1 | ||||||||
Type | string | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | true | ||||||||
Requirements | Helps establish the "authority/credibility" of the plan definition. May also allow for contact. | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
48. PlanDefinition.contact | |||||||||
Definition | Contact details to assist a user in finding and communicating with the publisher. | ||||||||
Short | Contact details for the publisher | ||||||||
Comments | May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements here. | ||||||||
Control | 0..* | ||||||||
Type | ContactDetail | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | true | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
50. PlanDefinition.description | |||||||||
Definition | A free text natural language description of the plan definition from a consumer's perspective. | ||||||||
Short | Natural language description of the plan definition | ||||||||
Comments | This description can be used to capture details such as 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). | ||||||||
Control | 0..1 | ||||||||
Type | markdown | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | true | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
52. 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. | ||||||||
Short | The context that the content is intended to support | ||||||||
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. | ||||||||
Control | 0..* | ||||||||
Type | UsageContext | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | true | ||||||||
Requirements | Assist in searching for appropriate content. | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
54. PlanDefinition.jurisdiction | |||||||||
Definition | A legal or geographic region in which the plan definition is intended to be used. | ||||||||
Short | Intended jurisdiction for plan definition (if applicable) | ||||||||
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. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) | ||||||||
Control | 0..* | ||||||||
Binding | Unless not suitable, these codes SHALL be taken from JurisdictionValueSet (extensible to http://hl7.org/fhir/ValueSet/jurisdiction )Countries and regions within which this artifact is targeted for use. | ||||||||
Type | CodeableConcept | ||||||||
Is Modifier | false | ||||||||
Must Support | true | ||||||||
Summary | true | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
56. PlanDefinition.purpose | |||||||||
Definition | Explanation of why this plan definition is needed and why it has been designed as it has. | ||||||||
Short | Why this plan definition is defined | ||||||||
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. | ||||||||
Control | 0..1 | ||||||||
Type | markdown | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
58. PlanDefinition.usage | |||||||||
Definition | A detailed description of how the plan definition is used from a clinical perspective. | ||||||||
Short | Describes the clinical usage of the plan | ||||||||
Control | 0..1 | ||||||||
Type | markdown | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
60. 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. | ||||||||
Short | Use and/or publishing restrictions | ||||||||
Comments | The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element. | ||||||||
Control | 0..1 | ||||||||
Type | markdown | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
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 | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
62. PlanDefinition.copyrightLabel | |||||||||
Definition | A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). | ||||||||
Short | Copyright holder and year(s) | ||||||||
Comments | The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element. | ||||||||
Control | 0..1 | ||||||||
Type | string | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Requirements | Defines the content expected to be rendered in all representations of the artifact. | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
64. 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. | ||||||||
Short | When the plan definition was approved by publisher | ||||||||
Comments | The 'date' element may be more recent than the approval date because of minor changes or editorial corrections. See guidance around (not) making local changes to elements here. | ||||||||
Control | 0..1 | ||||||||
Type | date | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
66. 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. | ||||||||
Short | When the plan definition was last reviewed by the publisher | ||||||||
Comments | If specified, this date follows the original approval date. See guidance around (not) making local changes to elements here. | ||||||||
Control | 0..1 | ||||||||
Type | date | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
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. | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
68. PlanDefinition.effectivePeriod | |||||||||
Definition | The period during which the plan definition content was or is planned to be in active use. | ||||||||
Short | When the plan definition is expected to be used | ||||||||
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 plan definition intended to be used for the year 2016 might be published in 2015. See guidance around (not) making local changes to elements here. | ||||||||
Control | 0..1 | ||||||||
Type | Period | ||||||||
Is Modifier | false | ||||||||
Must Support | true | ||||||||
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. | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
70. 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. | ||||||||
Short | E.g. Education, Treatment, Assessment | ||||||||
Comments | DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) | ||||||||
Control | 0..* | ||||||||
Binding | For example codes, see DefinitionTopic (example to http://hl7.org/fhir/ValueSet/definition-topic )High-level categorization of the definition, used for searching, sorting, and filtering. | ||||||||
Type | CodeableConcept | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
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 | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
72. PlanDefinition.author | |||||||||
Definition | An individiual or organization primarily involved in the creation and maintenance of the content. | ||||||||
Short | Who authored the content | ||||||||
Control | 0..* | ||||||||
Type | ContactDetail | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
74. PlanDefinition.editor | |||||||||
Definition | An individual or organization primarily responsible for internal coherence of the content. | ||||||||
Short | Who edited the content | ||||||||
Control | 0..* | ||||||||
Type | ContactDetail | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
76. PlanDefinition.reviewer | |||||||||
Definition | An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content. | ||||||||
Short | Who reviewed the content | ||||||||
Comments | See guidance around (not) making local changes to elements here. | ||||||||
Control | 0..* | ||||||||
Type | ContactDetail | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
78. PlanDefinition.endorser | |||||||||
Definition | An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting. | ||||||||
Short | Who endorsed the content | ||||||||
Comments | See guidance around (not) making local changes to elements here. | ||||||||
Control | 0..* | ||||||||
Type | ContactDetail | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
80. PlanDefinition.relatedArtifact | |||||||||
Definition | Related artifacts such as additional documentation, justification, or bibliographic references. | ||||||||
Short | Additional documentation, citations | ||||||||
Comments | Each related artifact is either an attachment, or a reference to another resource, but not both. | ||||||||
Control | 0..* | ||||||||
Type | RelatedArtifact | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
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. | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
82. PlanDefinition.library | |||||||||
Definition | A reference to a Library resource containing any formal logic used by the plan definition. | ||||||||
Short | Logic used by the plan definition | ||||||||
Control | 0..* | ||||||||
Type | canonical(Library) | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
84. PlanDefinition.goal | |||||||||
Definition | A goal describes an expected outcome that activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, meeting the acceptance criteria for a test as specified by a quality specification, etc. | ||||||||
Short | What the plan is trying to accomplish | ||||||||
Control | 0..* This element is affected by the following invariants: pld-3 | ||||||||
Type | BackboneElement | ||||||||
Is Modifier | false | ||||||||
Must Support | true | ||||||||
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 | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
86. 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. | ||||||||
Short | Unique id for inter-element referencing | ||||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||
Type | string | ||||||||
Is Modifier | false | ||||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||||
Summary | false | ||||||||
88. 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 managable, 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. | ||||||||
Short | Additional content defined by implementations | ||||||||
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. | ||||||||
Control | 0..* | ||||||||
Type | Extension | ||||||||
Is Modifier | false | ||||||||
Summary | false | ||||||||
Alternate Names | extensions, user content | ||||||||
Invariants | 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() ) | ||||||||
90. 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 managable, 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). | ||||||||
Short | Extensions that cannot be ignored even if unrecognized | ||||||||
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. | ||||||||
Control | 0..* | ||||||||
Type | Extension | ||||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||||
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 | ||||||||
Invariants | 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.goal.category | |||||||||
Definition | Indicates a category the goal falls within. | ||||||||
Short | E.g. Treatment, dietary, behavioral | ||||||||
Control | 0..1 | ||||||||
Binding | For example codes, see Equipment Classes (example to http://hl7.org/fhir/uv/pharm-quality/ValueSet/vs-equipmentClass-pq ) | ||||||||
Type | CodeableConcept | ||||||||
Is Modifier | false | ||||||||
Must Support | true | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
94. 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". | ||||||||
Short | Code or text describing the goal | ||||||||
Comments | If no code is available, use CodeableConcept.text. | ||||||||
Control | 1..1 | ||||||||
Binding | For example codes, see SNOMEDCTClinicalFindings (example to http://hl7.org/fhir/ValueSet/clinical-findings )Describes goals that can be achieved. | ||||||||
Type | CodeableConcept | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
96. PlanDefinition.goal.priority | |||||||||
Definition | Identifies the expected level of importance associated with reaching/sustaining the defined goal. | ||||||||
Short | high-priority | medium-priority | low-priority | ||||||||
Control | 0..1 | ||||||||
Binding | For example codes, see Goal Priority (example to http://hl7.org/fhir/uv/pharm-quality/ValueSet/vs-goalPriority-pq ) | ||||||||
Type | CodeableConcept | ||||||||
Is Modifier | false | ||||||||
Must Support | true | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
98. PlanDefinition.goal.start | |||||||||
Definition | The event after which the goal should begin being pursued. | ||||||||
Short | When goal pursuit begins | ||||||||
Control | 0..1 | ||||||||
Binding | For example codes, see GoalStartEvent (example to http://hl7.org/fhir/ValueSet/goal-start-event )Identifies the types of events that might trigger the start of a goal. | ||||||||
Type | CodeableConcept | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
100. PlanDefinition.goal.addresses | |||||||||
Definition | Identifies problems, conditions, issues, or concerns the goal is intended to address. | ||||||||
Short | What does the goal address | ||||||||
Control | 0..* | ||||||||
Binding | For example codes, see ConditionProblemDiagnosisCodes (example to http://hl7.org/fhir/ValueSet/condition-code )Identifies problems, conditions, issues, or concerns that goals may address. | ||||||||
Type | CodeableConcept | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
102. 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. | ||||||||
Short | Supporting documentation for the goal | ||||||||
Control | 0..* | ||||||||
Type | RelatedArtifact | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
104. PlanDefinition.goal.target | |||||||||
Definition | Indicates what should be done and within what timeframe. | ||||||||
Short | Target outcome for the goal | ||||||||
Control | 0..* | ||||||||
Type | BackboneElement | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
106. 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. | ||||||||
Short | Unique id for inter-element referencing | ||||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||
Type | string | ||||||||
Is Modifier | false | ||||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||||
Summary | false | ||||||||
108. 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 managable, 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. | ||||||||
Short | Additional content defined by implementations | ||||||||
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. | ||||||||
Control | 0..* | ||||||||
Type | Extension | ||||||||
Is Modifier | false | ||||||||
Summary | false | ||||||||
Alternate Names | extensions, user content | ||||||||
Invariants | 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() ) | ||||||||
110. 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 managable, 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). | ||||||||
Short | Extensions that cannot be ignored even if unrecognized | ||||||||
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. | ||||||||
Control | 0..* | ||||||||
Type | Extension | ||||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||||
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 | ||||||||
Invariants | 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() ) | ||||||||
112. PlanDefinition.goal.target.measure | |||||||||
Definition | The parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level. | ||||||||
Short | The parameter whose value is to be tracked | ||||||||
Control | 0..1 | ||||||||
Binding | For example codes, see LOINCCodes (example to http://hl7.org/fhir/ValueSet/observation-codes )Identifies types of parameters that can be tracked to determine goal achievement. | ||||||||
Type | CodeableConcept | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
114. PlanDefinition.goal.target.detail[x] | |||||||||
Definition | The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value. | ||||||||
Short | The target value to be achieved | ||||||||
Comments | A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the goal.target.measure defines a coded value. | ||||||||
Control | 0..1 | ||||||||
Type | Choice of: Quantity, Range, CodeableConcept, string, boolean, integer, Ratio | ||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
116. PlanDefinition.goal.target.due | |||||||||
Definition | Indicates the timeframe after the start of the goal in which the goal should be met. | ||||||||
Short | Reach goal within | ||||||||
Control | 0..1 | ||||||||
Type | Duration | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
118. PlanDefinition.actor | |||||||||
Definition | Actors represent the individuals or groups involved in the execution of the defined set of activities. | ||||||||
Short | Actors within the plan | ||||||||
Control | 0..* | ||||||||
Type | BackboneElement | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
120. PlanDefinition.actor.id | |||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||
Short | Unique id for inter-element referencing | ||||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||
Type | string | ||||||||
Is Modifier | false | ||||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||||
Summary | false | ||||||||
122. PlanDefinition.actor.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 managable, 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. | ||||||||
Short | Additional content defined by implementations | ||||||||
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. | ||||||||
Control | 0..* | ||||||||
Type | Extension | ||||||||
Is Modifier | false | ||||||||
Summary | false | ||||||||
Alternate Names | extensions, user content | ||||||||
Invariants | 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() ) | ||||||||
124. PlanDefinition.actor.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 managable, 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). | ||||||||
Short | Extensions that cannot be ignored even if unrecognized | ||||||||
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. | ||||||||
Control | 0..* | ||||||||
Type | Extension | ||||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||||
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 | ||||||||
Invariants | 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() ) | ||||||||
126. PlanDefinition.actor.title | |||||||||
Definition | A descriptive label for the actor. | ||||||||
Short | User-visible title | ||||||||
Control | 0..1 | ||||||||
Type | string | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
128. PlanDefinition.actor.description | |||||||||
Definition | A description of how the actor fits into the overall actions of the plan definition. | ||||||||
Short | Describes the actor | ||||||||
Control | 0..1 | ||||||||
Type | markdown | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
130. PlanDefinition.actor.option | |||||||||
Definition | The characteristics of the candidates that could serve as the actor. | ||||||||
Short | Who or what can be this actor | ||||||||
Control | 1..* | ||||||||
Type | BackboneElement | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
132. PlanDefinition.actor.option.id | |||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||
Short | Unique id for inter-element referencing | ||||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||
Type | string | ||||||||
Is Modifier | false | ||||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||||
Summary | false | ||||||||
134. PlanDefinition.actor.option.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 managable, 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. | ||||||||
Short | Additional content defined by implementations | ||||||||
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. | ||||||||
Control | 0..* | ||||||||
Type | Extension | ||||||||
Is Modifier | false | ||||||||
Summary | false | ||||||||
Alternate Names | extensions, user content | ||||||||
Invariants | 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() ) | ||||||||
136. PlanDefinition.actor.option.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 managable, 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). | ||||||||
Short | Extensions that cannot be ignored even if unrecognized | ||||||||
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. | ||||||||
Control | 0..* | ||||||||
Type | Extension | ||||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||||
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 | ||||||||
Invariants | 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() ) | ||||||||
138. PlanDefinition.actor.option.type | |||||||||
Definition | The type of participant in the action. | ||||||||
Short | careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson | ||||||||
Control | 0..1 | ||||||||
Binding | The codes SHALL be taken from ActionParticipantType (required to http://hl7.org/fhir/ValueSet/action-participant-type|5.0.0 )The type of participant in the activity. | ||||||||
Type | code | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
140. PlanDefinition.actor.option.typeCanonical | |||||||||
Definition | The type of participant in the action. | ||||||||
Short | Who or what can participate | ||||||||
Control | 0..1 | ||||||||
Type | canonical(CapabilityStatement) | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
142. PlanDefinition.actor.option.typeReference | |||||||||
Definition | The type of participant in the action. | ||||||||
Short | Who or what can participate | ||||||||
Comments | When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location). | ||||||||
Control | 0..1 | ||||||||
Type | Reference(CareTeam, Device, DeviceDefinition, Endpoint, Group, HealthcareService, Location, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson) | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
144. PlanDefinition.actor.option.role | |||||||||
Definition | The role the participant should play in performing the described action. | ||||||||
Short | E.g. Nurse, Surgeon, Parent | ||||||||
Control | 0..1 | ||||||||
Binding | For example codes, see Test Category (example to http://hl7.org/fhir/uv/pharm-quality/ValueSet/vs-testCategory-pq ) | ||||||||
Type | CodeableConcept | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
146. PlanDefinition.action | |||||||||
Definition | An action or group of actions to be taken as part of the plan. For example, in clinical care, an action would be to prescribe a particular indicated medication, or perform a particular test as appropriate. In pharmaceutical quality, an action would be the test that needs to be performed on a drug product as defined in the quality specification. | ||||||||
Short | Action defined by the plan | ||||||||
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. | ||||||||
Control | 0..* This element is affected by the following invariants: pld-3, pld-4 | ||||||||
Type | BackboneElement | ||||||||
Is Modifier | false | ||||||||
Must Support | true | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
148. 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. | ||||||||
Short | Unique id for inter-element referencing | ||||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||
Type | string | ||||||||
Is Modifier | false | ||||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||||
Summary | false | ||||||||
150. PlanDefinition.action.extension | |||||||||
Definition | An Extension | ||||||||
Short | Extension | ||||||||
Control | 0..* | ||||||||
Type | Extension | ||||||||
Is Modifier | false | ||||||||
Summary | false | ||||||||
Invariants | 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.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||||||
152. PlanDefinition.action.extension:process-parameters | |||||||||
Slice Name | process-parameters | ||||||||
Definition | An Extension | ||||||||
Short | process-parameters | ||||||||
Control | 0..* | ||||||||
Type | Extension(Extension - Process Parameters PQ) (Complex Extension) | ||||||||
Is Modifier | false | ||||||||
Must Support | true | ||||||||
Invariants | 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() ) | ||||||||
154. PlanDefinition.action.extension:process-step-scale | |||||||||
Slice Name | process-step-scale | ||||||||
Definition | An Extension | ||||||||
Short | process-step-scale | ||||||||
Control | 0..* | ||||||||
Type | Extension(Extension - Process Step Scale PQ) (Extension Type: Coding) | ||||||||
Is Modifier | false | ||||||||
Must Support | true | ||||||||
Invariants | 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() ) | ||||||||
156. 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 managable, 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). | ||||||||
Short | Extensions that cannot be ignored even if unrecognized | ||||||||
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. | ||||||||
Control | 0..* | ||||||||
Type | Extension | ||||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||||
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 | ||||||||
Invariants | 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() ) | ||||||||
158. PlanDefinition.action.linkId | |||||||||
Definition | An identifier that is unique within the PlanDefinition to allow linkage within the realized CarePlan and/or RequestOrchestration. | ||||||||
Short | Unique id for the action in the PlanDefinition | ||||||||
Control | 0..1 | ||||||||
Type | string | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
160. PlanDefinition.action.prefix | |||||||||
Definition | A user-visible prefix for the action. For example a section or item numbering such as 1. or A. | ||||||||
Short | User-visible prefix for the action (e.g. 1. or A.) | ||||||||
Control | 0..1 | ||||||||
Type | string | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
162. PlanDefinition.action.title | |||||||||
Definition | The textual description of the action displayed to a user. For example, when the action is a test to be performed, the title would be the title of the test such as Assay by HPLC. | ||||||||
Short | User-visible title | ||||||||
Control | 0..1 | ||||||||
Type | string | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
164. PlanDefinition.action.description | |||||||||
Definition | A brief description of the action used to provide a summary to display to the user. | ||||||||
Short | Brief description of the action | ||||||||
Control | 0..1 | ||||||||
Type | markdown | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
166. 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. | ||||||||
Short | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system | ||||||||
Control | 0..1 | ||||||||
Type | markdown | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
168. PlanDefinition.action.priority | |||||||||
Definition | Indicates how quickly the action should be addressed with respect to other actions. | ||||||||
Short | routine | urgent | asap | stat | ||||||||
Control | 0..1 | ||||||||
Binding | The codes SHALL be taken from RequestPriority (required to http://hl7.org/fhir/ValueSet/request-priority|5.0.0 )Identifies the level of importance to be assigned to actioning the request. | ||||||||
Type | code | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
170. PlanDefinition.action.code | |||||||||
Definition | A code that provides a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical property. | ||||||||
Short | Code representing the meaning of the action or sub-actions | ||||||||
Control | 0..1 | ||||||||
Binding | For example codes, see ActionCode (example to http://hl7.org/fhir/ValueSet/action-code )
| ||||||||
Type | CodeableConcept | ||||||||
Is Modifier | false | ||||||||
Must Support | true | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
172. PlanDefinition.action.reason | |||||||||
Definition | A description of why this action is necessary or appropriate. | ||||||||
Short | Why the action should be performed | ||||||||
Comments | This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action. | ||||||||
Control | 0..* | ||||||||
Binding | For example codes, see ActionReasonCode (example to http://hl7.org/fhir/ValueSet/action-reason-code )Provides examples of reasons for actions to be performed. | ||||||||
Type | CodeableConcept | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
174. 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. | ||||||||
Short | Supporting documentation for the intended performer of the action | ||||||||
Control | 0..* | ||||||||
Type | RelatedArtifact | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
176. PlanDefinition.action.goalId | |||||||||
Definition | Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action. | ||||||||
Short | What goals this action supports | ||||||||
Control | 0..* This element is affected by the following invariants: pld-3 | ||||||||
Type | id | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
178. PlanDefinition.action.subject[x] | |||||||||
Definition | A code, group definition, or canonical reference that describes the intended subject of the action and its children, if any. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. | ||||||||
Short | Type of individual the action is focused on | ||||||||
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). | ||||||||
Control | 0..1 | ||||||||
Binding | Unless not suitable, these codes SHALL be taken from ParticipantResourceTypes (extensible to http://hl7.org/fhir/ValueSet/participant-resource-types )The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||||
Type | Choice of: CodeableConcept, Reference(Group), canonical | ||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
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. | ||||||||
Meaning if Missing | Patient | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
180. PlanDefinition.action.trigger | |||||||||
Definition | A description of when the action should be triggered. When multiple triggers are specified on an action, any triggering event invokes the action. | ||||||||
Short | When the action should be triggered | ||||||||
Control | 0..* | ||||||||
Type | TriggerDefinition | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
182. PlanDefinition.action.condition | |||||||||
Definition | An expression that describes applicability criteria or start/stop conditions for the action. | ||||||||
Short | Whether or not the action is applicable | ||||||||
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. | ||||||||
Control | 0..* | ||||||||
Type | BackboneElement | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
184. 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. | ||||||||
Short | Unique id for inter-element referencing | ||||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||
Type | string | ||||||||
Is Modifier | false | ||||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||||
Summary | false | ||||||||
186. 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 managable, 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. | ||||||||
Short | Additional content defined by implementations | ||||||||
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. | ||||||||
Control | 0..* | ||||||||
Type | Extension | ||||||||
Is Modifier | false | ||||||||
Summary | false | ||||||||
Alternate Names | extensions, user content | ||||||||
Invariants | 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() ) | ||||||||
188. 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 managable, 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). | ||||||||
Short | Extensions that cannot be ignored even if unrecognized | ||||||||
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. | ||||||||
Control | 0..* | ||||||||
Type | Extension | ||||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||||
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 | ||||||||
Invariants | 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() ) | ||||||||
190. PlanDefinition.action.condition.kind | |||||||||
Definition | The kind of condition. | ||||||||
Short | applicability | start | stop | ||||||||
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. | ||||||||
Control | 1..1 | ||||||||
Binding | The codes SHALL be taken from ActionConditionKind (required to http://hl7.org/fhir/ValueSet/action-condition-kind|5.0.0 )Defines the kinds of conditions that can appear on actions. | ||||||||
Type | code | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
192. PlanDefinition.action.condition.expression | |||||||||
Definition | An expression that returns true or false, indicating whether the condition is satisfied. | ||||||||
Short | Boolean-valued expression | ||||||||
Comments | The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element. | ||||||||
Control | 0..1 | ||||||||
Type | Expression | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
194. PlanDefinition.action.input | |||||||||
Definition | Defines input data requirements for the action. | ||||||||
Short | Input data requirements | ||||||||
Control | 0..* | ||||||||
Type | BackboneElement | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )pld-0: Input data elements must have a requirement or a relatedData, but not both ( requirement.exists() xor relatedData.exists() ) | ||||||||
196. PlanDefinition.action.input.id | |||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||
Short | Unique id for inter-element referencing | ||||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||
Type | string | ||||||||
Is Modifier | false | ||||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||||
Summary | false | ||||||||
198. PlanDefinition.action.input.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 managable, 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. | ||||||||
Short | Additional content defined by implementations | ||||||||
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. | ||||||||
Control | 0..* | ||||||||
Type | Extension | ||||||||
Is Modifier | false | ||||||||
Summary | false | ||||||||
Alternate Names | extensions, user content | ||||||||
Invariants | 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() ) | ||||||||
200. PlanDefinition.action.input.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 managable, 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). | ||||||||
Short | Extensions that cannot be ignored even if unrecognized | ||||||||
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. | ||||||||
Control | 0..* | ||||||||
Type | Extension | ||||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||||
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 | ||||||||
Invariants | 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() ) | ||||||||
202. PlanDefinition.action.input.title | |||||||||
Definition | A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers. | ||||||||
Short | User-visible title | ||||||||
Control | 0..1 | ||||||||
Type | string | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
204. PlanDefinition.action.input.requirement | |||||||||
Definition | Defines the data that is to be provided as input to the action. | ||||||||
Short | What data is provided | ||||||||
Control | 0..1 This element is affected by the following invariants: pld-0 | ||||||||
Type | DataRequirement | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
206. PlanDefinition.action.input.relatedData | |||||||||
Definition | Points to an existing input or output element that provides data to this input. | ||||||||
Short | What data is provided | ||||||||
Comments | The relatedData element allows indicating that an input to a parent action is an input to specific child actions. It also allows the output of one action to be identified as the input to a different action | ||||||||
Control | 0..1 This element is affected by the following invariants: pld-0 | ||||||||
Type | id | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
208. PlanDefinition.action.output | |||||||||
Definition | Defines the outputs of the action, if any. | ||||||||
Short | Output data definition | ||||||||
Control | 0..* | ||||||||
Type | BackboneElement | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )pld-1: Output data element must have a requirement or a relatedData, but not both ( requirement.exists() xor relatedData.exists() ) | ||||||||
210. PlanDefinition.action.output.id | |||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||
Short | Unique id for inter-element referencing | ||||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||
Type | string | ||||||||
Is Modifier | false | ||||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||||
Summary | false | ||||||||
212. PlanDefinition.action.output.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 managable, 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. | ||||||||
Short | Additional content defined by implementations | ||||||||
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. | ||||||||
Control | 0..* | ||||||||
Type | Extension | ||||||||
Is Modifier | false | ||||||||
Summary | false | ||||||||
Alternate Names | extensions, user content | ||||||||
Invariants | 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() ) | ||||||||
214. PlanDefinition.action.output.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 managable, 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). | ||||||||
Short | Extensions that cannot be ignored even if unrecognized | ||||||||
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. | ||||||||
Control | 0..* | ||||||||
Type | Extension | ||||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||||
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 | ||||||||
Invariants | 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() ) | ||||||||
216. PlanDefinition.action.output.title | |||||||||
Definition | A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers. | ||||||||
Short | User-visible title | ||||||||
Control | 0..1 | ||||||||
Type | string | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
218. PlanDefinition.action.output.requirement | |||||||||
Definition | Defines the data that results as output from the action. | ||||||||
Short | What data is provided | ||||||||
Control | 0..1 This element is affected by the following invariants: pld-1 | ||||||||
Type | DataRequirement | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
220. PlanDefinition.action.output.relatedData | |||||||||
Definition | Points to an existing input or output element that is results as output from the action. | ||||||||
Short | What data is provided | ||||||||
Comments | The relatedData element allows indicating that the output of child action is also the output of a parent action. It also allows the input of one action to be identified as the output of a different action | ||||||||
Control | 0..1 This element is affected by the following invariants: pld-1 | ||||||||
Type | string | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
222. PlanDefinition.action.relatedAction | |||||||||
Definition | A relationship to another action such as "before" or "30-60 minutes after start of". | ||||||||
Short | Relationship to another action | ||||||||
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. | ||||||||
Control | 0..* This element is affected by the following invariants: pld-4 | ||||||||
Type | BackboneElement | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
224. 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. | ||||||||
Short | Unique id for inter-element referencing | ||||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||
Type | string | ||||||||
Is Modifier | false | ||||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||||
Summary | false | ||||||||
226. PlanDefinition.action.relatedAction.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 managable, 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. | ||||||||
Short | Additional content defined by implementations | ||||||||
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. | ||||||||
Control | 0..* | ||||||||
Type | Extension | ||||||||
Is Modifier | false | ||||||||
Summary | false | ||||||||
Alternate Names | extensions, user content | ||||||||
Invariants | 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() ) | ||||||||
228. 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 managable, 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). | ||||||||
Short | Extensions that cannot be ignored even if unrecognized | ||||||||
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. | ||||||||
Control | 0..* | ||||||||
Type | Extension | ||||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||||
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 | ||||||||
Invariants | 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() ) | ||||||||
230. PlanDefinition.action.relatedAction.targetId | |||||||||
Definition | The element id of the target related action. | ||||||||
Short | What action is this related to | ||||||||
Control | 1..1 This element is affected by the following invariants: pld-4 | ||||||||
Type | id | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
232. PlanDefinition.action.relatedAction.relationship | |||||||||
Definition | The relationship of the start of this action to the related action. | ||||||||
Short | before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end | ||||||||
Control | 1..1 | ||||||||
Binding | The codes SHALL be taken from ActionRelationshipType (required to http://hl7.org/fhir/ValueSet/action-relationship-type|5.0.0 )Defines the types of relationships between actions. | ||||||||
Type | code | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
234. PlanDefinition.action.relatedAction.endRelationship | |||||||||
Definition | The relationship of the end of this action to the related action. | ||||||||
Short | before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end | ||||||||
Control | 0..1 | ||||||||
Binding | The codes SHALL be taken from ActionRelationshipType (required to http://hl7.org/fhir/ValueSet/action-relationship-type|5.0.0 )Defines the types of relationships between actions. | ||||||||
Type | code | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
236. PlanDefinition.action.relatedAction.offset[x] | |||||||||
Definition | A duration or range of durations to apply to the relationship. For example, 30-60 minutes before. | ||||||||
Short | Time offset for the relationship | ||||||||
Control | 0..1 | ||||||||
Type | Choice of: Duration, Range | ||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
238. PlanDefinition.action.timing[x] | |||||||||
Definition | An optional value describing when the action should be performed. | ||||||||
Short | When the action should take place | ||||||||
Comments | The intent of the timing element is to provide timing when the action should be performed. As a definitional resource, this timing is interpreted as part of an apply operation so that the timing of the result actions in a CarePlan or RequestOrchestration, for example, would be specified by evaluating the timing definition in the context of the apply and setting the resulting timing on the appropriate elements of the target resource. If the timing is an Age, the activity is expected to be performed when the subject is the given Age. When the timing is a Duration, the activity is expected to be performed within the specified duration from the apply. When the timing is a Range, it may be a range of Ages or Durations, providing a range for the expected timing of the resulting activity. When the timing is a Timing, it is establishing a schedule for the timing of the resulting activity. | ||||||||
Control | 0..1 | ||||||||
Type | Choice of: Age, Duration, Range, Timing | ||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Requirements | Allows prompting for activities and detection of missed planned activities. | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
240. PlanDefinition.action.location | |||||||||
Definition | Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etc. | ||||||||
Short | Where it should happen | ||||||||
Comments | May reference a specific clinical location or may just identify a type of location. | ||||||||
Control | 0..1 | ||||||||
Type | CodeableReference(Location) | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Requirements | Helps in planning of activity. | ||||||||
Alternate Names | facility | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
242. PlanDefinition.action.participant | |||||||||
Definition | Indicates who should participate in performing the action described. | ||||||||
Short | Who should participate in the action | ||||||||
Control | 0..* | ||||||||
Type | BackboneElement | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
244. 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. | ||||||||
Short | Unique id for inter-element referencing | ||||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||
Type | string | ||||||||
Is Modifier | false | ||||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||||
Summary | false | ||||||||
246. 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 managable, 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. | ||||||||
Short | Additional content defined by implementations | ||||||||
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. | ||||||||
Control | 0..* | ||||||||
Type | Extension | ||||||||
Is Modifier | false | ||||||||
Summary | false | ||||||||
Alternate Names | extensions, user content | ||||||||
Invariants | 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() ) | ||||||||
248. 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 managable, 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). | ||||||||
Short | Extensions that cannot be ignored even if unrecognized | ||||||||
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. | ||||||||
Control | 0..* | ||||||||
Type | Extension | ||||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||||
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 | ||||||||
Invariants | 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() ) | ||||||||
250. PlanDefinition.action.participant.actorId | |||||||||
Definition | A reference to the id element of the actor who will participate in this action. | ||||||||
Short | What actor | ||||||||
Control | 0..1 | ||||||||
Type | string | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
252. PlanDefinition.action.participant.type | |||||||||
Definition | The type of participant in the action. | ||||||||
Short | careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson | ||||||||
Control | 0..1 | ||||||||
Binding | The codes SHALL be taken from ActionParticipantType (required to http://hl7.org/fhir/ValueSet/action-participant-type|5.0.0 )The type of participant in the activity. | ||||||||
Type | code | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
254. PlanDefinition.action.participant.typeCanonical | |||||||||
Definition | The type of participant in the action. | ||||||||
Short | Who or what can participate | ||||||||
Control | 0..1 | ||||||||
Type | canonical(CapabilityStatement) | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
256. PlanDefinition.action.participant.typeReference | |||||||||
Definition | The type of participant in the action. | ||||||||
Short | Who or what can participate | ||||||||
Comments | When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location). | ||||||||
Control | 0..1 | ||||||||
Type | Reference(CareTeam, Device, DeviceDefinition, Endpoint, Group, HealthcareService, Location, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson) | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
258. PlanDefinition.action.participant.typeReference.id | |||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||
Short | Unique id for inter-element referencing | ||||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||
Type | id | ||||||||
Is Modifier | false | ||||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||||
Summary | false | ||||||||
260. PlanDefinition.action.participant.typeReference.extension | |||||||||
Definition | An Extension | ||||||||
Short | Extension | ||||||||
Control | 0..* | ||||||||
Type | Extension | ||||||||
Is Modifier | false | ||||||||
Summary | false | ||||||||
Invariants | 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.participant.typeReference.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||||||
262. PlanDefinition.action.participant.typeReference.extension:manufacturing-participant | |||||||||
Slice Name | manufacturing-participant | ||||||||
Definition | An Extension | ||||||||
Short | manufacturing-participant | ||||||||
Control | 0..* | ||||||||
Type | Extension(Extension - Manufacturing Participant PQ) (Extension Type: Reference(SubstanceDefinition - Component Substance Drug PQ)) | ||||||||
Is Modifier | false | ||||||||
Must Support | true | ||||||||
Summary | false | ||||||||
Invariants | 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() ) | ||||||||
264. PlanDefinition.action.participant.typeReference.reference | |||||||||
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||||||
Short | Literal reference, Relative, internal or absolute URL | ||||||||
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||||||
Control | 0..1 This element is affected by the following invariants: ref-2, ref-1 | ||||||||
Type | string | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Summary | true | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
266. PlanDefinition.action.participant.typeReference.type | |||||||||
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | ||||||||
Short | Type the reference refers to (e.g. "Patient") - must be a resource in resources | ||||||||
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference. | ||||||||
Control | 0..1 | ||||||||
Binding | Unless not suitable, these codes SHALL be taken from ResourceType (extensible to http://hl7.org/fhir/ValueSet/resource-types )Aa resource (or, for logical models, the URI of the logical model). | ||||||||
Type | uri | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Summary | true | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
268. PlanDefinition.action.participant.typeReference.identifier | |||||||||
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||||||
Short | Logical reference, when literal reference is not known | ||||||||
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. | ||||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
Control | 0..1 This element is affected by the following invariants: ref-2 | ||||||||
Type | Identifier | ||||||||
Is Modifier | false | ||||||||
Summary | true | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
270. PlanDefinition.action.participant.typeReference.display | |||||||||
Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||||||
Short | Text alternative for the resource | ||||||||
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||||||
Control | 0..1 This element is affected by the following invariants: ref-2 | ||||||||
Type | string | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Summary | true | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
272. PlanDefinition.action.participant.role | |||||||||
Definition | The role the participant should play in performing the described action. | ||||||||
Short | E.g. Nurse, Surgeon, Parent | ||||||||
Control | 0..1 | ||||||||
Binding | For example codes, see Manufacturing Participant Role (example to http://hl7.org/fhir/uv/pharm-quality/ValueSet/vs-manufacturingParticipantRole-pq ) | ||||||||
Type | CodeableConcept | ||||||||
Is Modifier | false | ||||||||
Must Support | true | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
274. PlanDefinition.action.participant.function | |||||||||
Definition | Indicates how the actor will be involved in the action - author, reviewer, witness, etc. | ||||||||
Short | E.g. Author, Reviewer, Witness, etc | ||||||||
Control | 0..1 | ||||||||
Binding | For example codes, see ActionParticipantFunction (example to http://hl7.org/fhir/ValueSet/action-participant-function ) | ||||||||
Type | CodeableConcept | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
276. PlanDefinition.action.type | |||||||||
Definition | The type of action to perform (create, update, remove). | ||||||||
Short | create | update | remove | fire-event | ||||||||
Control | 0..1 | ||||||||
Binding | Unless not suitable, these codes SHALL be taken from ActionType (extensible to http://hl7.org/fhir/ValueSet/action-type )The type of action to be performed. | ||||||||
Type | CodeableConcept | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
278. PlanDefinition.action.groupingBehavior | |||||||||
Definition | Defines the grouping behavior for the action and its children. | ||||||||
Short | visual-group | logical-group | sentence-group | ||||||||
Control | 0..1 | ||||||||
Binding | The codes SHALL be taken from ActionGroupingBehavior (required to http://hl7.org/fhir/ValueSet/action-grouping-behavior|5.0.0 )Defines organization behavior of a group. | ||||||||
Type | code | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Meaning if Missing | If no grouping behavior is specified but the action has children (i.e. is a group), the grouping behavior is assumed to be `logical-group`. | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
280. PlanDefinition.action.selectionBehavior | |||||||||
Definition | Defines the selection behavior for the action and its children. | ||||||||
Short | any | all | all-or-none | exactly-one | at-most-one | one-or-more | ||||||||
Control | 0..1 | ||||||||
Binding | The codes SHALL be taken from ActionSelectionBehavior (required to http://hl7.org/fhir/ValueSet/action-selection-behavior|5.0.0 )Defines selection behavior of a group. | ||||||||
Type | code | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Meaning if Missing | If no selection behavior is specified but the action has children (i.e. is a group), the selection behavior is assumed to be `all`. | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
282. PlanDefinition.action.requiredBehavior | |||||||||
Definition | Defines the required behavior for the action. | ||||||||
Short | must | could | must-unless-documented | ||||||||
Control | 0..1 | ||||||||
Binding | The codes SHALL be taken from ActionRequiredBehavior (required to http://hl7.org/fhir/ValueSet/action-required-behavior|5.0.0 )Defines expectations around whether an action or action group is required. | ||||||||
Type | code | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Meaning if Missing | If no required behavior is specified but the action has children (i.e. is a group), the required behavior is assumed to be `could`. | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
284. PlanDefinition.action.precheckBehavior | |||||||||
Definition | Defines whether the action should usually be preselected. | ||||||||
Short | yes | no | ||||||||
Control | 0..1 | ||||||||
Binding | The codes SHALL be taken from ActionPrecheckBehavior (required to http://hl7.org/fhir/ValueSet/action-precheck-behavior|5.0.0 )Defines selection frequency behavior for an action or group. | ||||||||
Type | code | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Meaning if Missing | If no precheck behavior is specified but the action has children (i.e. is a group), the precheck behavior is assumed to be `no`. | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
286. PlanDefinition.action.cardinalityBehavior | |||||||||
Definition | Defines whether the action can be selected multiple times. | ||||||||
Short | single | multiple | ||||||||
Control | 0..1 | ||||||||
Binding | The codes SHALL be taken from ActionCardinalityBehavior (required to http://hl7.org/fhir/ValueSet/action-cardinality-behavior|5.0.0 )Defines behavior for an action or a group for how many times that item may be repeated. | ||||||||
Type | code | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Meaning if Missing | If no cardinality behavior is specified but the action has children (i.e. is a group), the cardinality behavior is assumed to be `single`. | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
288. PlanDefinition.action.definition[x] | |||||||||
Definition | A reference to an ActivityDefinition that describes the action to be taken in detail, a MessageDefinition describing a message to be snet, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured. | ||||||||
Short | Description of the activity to be performed | ||||||||
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. | ||||||||
Control | 0..1 | ||||||||
Type | Choice of: canonical(ActivityDefinition, MessageDefinition, ObservationDefinition, PlanDefinition, Questionnaire, SpecimenDefinition), uri | ||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
290. 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. | ||||||||
Short | Transform to apply the template | ||||||||
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. | ||||||||
Control | 0..1 | ||||||||
Type | canonical(StructureMap) | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
292. 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. | ||||||||
Short | Dynamic aspects of the definition | ||||||||
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. | ||||||||
Control | 0..* | ||||||||
Type | BackboneElement | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
294. 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. | ||||||||
Short | Unique id for inter-element referencing | ||||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||
Type | string | ||||||||
Is Modifier | false | ||||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||||
Summary | false | ||||||||
296. 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 managable, 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. | ||||||||
Short | Additional content defined by implementations | ||||||||
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. | ||||||||
Control | 0..* | ||||||||
Type | Extension | ||||||||
Is Modifier | false | ||||||||
Summary | false | ||||||||
Alternate Names | extensions, user content | ||||||||
Invariants | 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() ) | ||||||||
298. 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 managable, 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). | ||||||||
Short | Extensions that cannot be ignored even if unrecognized | ||||||||
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. | ||||||||
Control | 0..* | ||||||||
Type | Extension | ||||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||||
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 | ||||||||
Invariants | 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() ) | ||||||||
300. 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 resolvable 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). | ||||||||
Short | The path to the element to be set dynamically | ||||||||
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. | ||||||||
Control | 0..1 | ||||||||
Type | string | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
302. PlanDefinition.action.dynamicValue.expression | |||||||||
Definition | An expression specifying the value of the customized element. | ||||||||
Short | An expression that provides the dynamic value for the customization | ||||||||
Comments | The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element. | ||||||||
Control | 0..1 | ||||||||
Type | Expression | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
304. 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. | ||||||||
Short | A sub-action | ||||||||
Control | 0..* | ||||||||
Type | See ttp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action | ||||||||
Is Modifier | false | ||||||||
Must Support | false | ||||||||
Summary | false | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||||
306. PlanDefinition.asNeeded[x] | |||||||||
Definition | If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc. | ||||||||
Short | Preconditions for service | ||||||||
Control | 0..1 | ||||||||
Binding | For example codes, see SNOMEDCTMedicationAsNeededReasonCodes (example to http://hl7.org/fhir/ValueSet/medication-as-needed-reason )A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | ||||||||
Type | Choice of: boolean, CodeableConcept | ||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||
Is Modifier | false | ||||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
Must Support | false | ||||||||
Summary | true | ||||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |