Extensions for Using Data Elements from FHIR R5 in FHIR STU3 - Downloaded Version null See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 0 |
Definitions for the profile-PlanDefinition resource profile.
Guidance on how to interpret the contents of this table can be foundhere
| 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 artifacts such as clinical decision support rules, order sets and protocols. |
| Short | The definition of a plan for a series of actions, independent of any specific patient or context |
| Control | 0..* |
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.empty())dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource ( contained.where(('#'+id in %resource.descendants().reference).not()).empty())dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty()) |
| 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. |
| 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 4. PlanDefinition.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| 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 |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on PlanDefinition.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. PlanDefinition.extension:versionAlgorithm | |
| Slice Name | versionAlgorithm |
| Definition | R5: |
| Short | R5: How to compare versions (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm) |
| 8. PlanDefinition.extension:subtitle | |
| Slice Name | subtitle |
| Definition | R5: |
| Short | R5: Subordinate title of the plan definition (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: Subordinate title of the plan definition (new)) (Extension Type: string) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 10. PlanDefinition.extension:subject | |
| Slice Name | subject |
| Definition | R5: |
| Short | R5: Type of individual the plan definition is focused on (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: Type of individual the plan definition is focused on (new)) (Extension Type: Choice of: CodeableConcept, Reference(Cross-version Profile for R5.Group for use in FHIR STU3, Group, Cross-version Profile for R5.MedicinalProductDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.SubstanceDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.AdministrableProductDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.ManufacturedItemDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.PackagedProductDefinition for use in FHIR STU3, Basic), uri(Cross-version Profile for R5.EvidenceVariable for use in FHIR STU3, Basic)) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 12. PlanDefinition.extension:copyrightLabel | |
| Slice Name | copyrightLabel |
| Definition | R5: |
| Short | R5: Copyright holder and year(s) (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel) |
| 14. PlanDefinition.extension:actor | |
| Slice Name | actor |
| Definition | R5: |
| Short | R5: Actors within the plan (new) |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: Actors within the plan (new)) (Complex Extension) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 16. PlanDefinition.extension:asNeeded | |
| Slice Name | asNeeded |
| Definition | R5: |
| Short | R5: Preconditions for service (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: Preconditions for service (new)) (Extension Type: Choice of: boolean, CodeableConcept) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 18. 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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
| 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 No Modifier Reason provideed in previous versions of FHIR |
| Alternate Names | extensions, user content |
| 20. 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 vs. not. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|3.0.2 (required to http://hl7.org/fhir/ValueSet/publication-status|3.0.2)The lifecycle status of a Value Set or Concept Map. |
| Type | code |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 22. 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 definition that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental plan definition in production. |
| Control | 0..1 |
| Type | boolean |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level plan definition. |
Guidance on how to interpret the contents of this table can be foundhere
| 0. PlanDefinition | |
| 2. PlanDefinition.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on PlanDefinition.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 4. PlanDefinition.extension:versionAlgorithm | |
| Slice Name | versionAlgorithm |
| Definition | R5: |
| Short | R5: How to compare versions (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm) |
| 6. PlanDefinition.extension:subtitle | |
| Slice Name | subtitle |
| Definition | R5: |
| Short | R5: Subordinate title of the plan definition (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: Subordinate title of the plan definition (new)) (Extension Type: string) |
| 8. PlanDefinition.extension:subject | |
| Slice Name | subject |
| Definition | R5: |
| Short | R5: Type of individual the plan definition is focused on (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: Type of individual the plan definition is focused on (new)) (Extension Type: Choice of: CodeableConcept, Reference(Cross-version Profile for R5.Group for use in FHIR STU3, Group, Cross-version Profile for R5.MedicinalProductDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.SubstanceDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.AdministrableProductDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.ManufacturedItemDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.PackagedProductDefinition for use in FHIR STU3, Basic), uri(Cross-version Profile for R5.EvidenceVariable for use in FHIR STU3, Basic)) |
| 10. PlanDefinition.extension:copyrightLabel | |
| Slice Name | copyrightLabel |
| Definition | R5: |
| Short | R5: Copyright holder and year(s) (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel) |
| 12. PlanDefinition.extension:actor | |
| Slice Name | actor |
| Definition | R5: |
| Short | R5: Actors within the plan (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R5: Actors within the plan (new)) (Complex Extension) |
| 14. PlanDefinition.extension:asNeeded | |
| Slice Name | asNeeded |
| Definition | R5: |
| Short | R5: Preconditions for service (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: Preconditions for service (new)) (Extension Type: Choice of: boolean, CodeableConcept) |
| 16. PlanDefinition.contributor | |
| 18. PlanDefinition.contributor.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on PlanDefinition.contributor.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 20. PlanDefinition.contributor.extension:author | |
| Slice Name | author |
| Definition | R5: |
| Short | R5: Who authored the content additional types |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R5: Who authored the content additional types) (Complex Extension) |
| 22. PlanDefinition.contributor.extension:editor | |
| Slice Name | editor |
| Definition | R5: |
| Short | R5: Who edited the content additional types |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R5: Who edited the content additional types) (Complex Extension) |
| 24. PlanDefinition.contributor.extension:reviewer | |
| Slice Name | reviewer |
| Definition | R5: |
| Short | R5: Who reviewed the content additional types |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R5: Who reviewed the content additional types) (Complex Extension) |
| 26. PlanDefinition.contributor.extension:endorser | |
| Slice Name | endorser |
| Definition | R5: |
| Short | R5: Who endorsed the content additional types |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R5: Who endorsed the content additional types) (Complex Extension) |
| 28. PlanDefinition.contact | |
| 30. PlanDefinition.contact.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on PlanDefinition.contact.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 32. PlanDefinition.contact.extension:contact | |
| Slice Name | contact |
| Definition | R5: |
| Short | R5: contact additional types |
| Comments | Element See guidance around (not) making local changes to elements here. |
| Control | 0..* |
| Type | Extension(R5: contact additional types) (Complex Extension) |
| 34. PlanDefinition.library | |
| 36. PlanDefinition.library.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on PlanDefinition.library.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 38. PlanDefinition.library.extension:library | |
| Slice Name | library |
| Definition | R5: |
| Short | R5: library additional types |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R5: library additional types) (Extension Type: uri(Cross-version Profile for R5.Library for use in FHIR STU3, Library)) |
| 40. PlanDefinition.goal | |
| 42. PlanDefinition.goal.target | |
| 44. PlanDefinition.goal.target.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on PlanDefinition.goal.target.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 46. PlanDefinition.goal.target.extension:detail | |
| Slice Name | detail |
| Definition | R5: |
| Short | R5: detail additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: detail additional types) (Extension Type: Choice of: string, boolean, integer, Ratio) |
| 48. PlanDefinition.action | |
| 50. PlanDefinition.action.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on PlanDefinition.action.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 52. PlanDefinition.action.extension:linkId | |
| Slice Name | linkId |
| Definition | R5: |
| Short | R5: Unique id for the action in the PlanDefinition (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: Unique id for the action in the PlanDefinition (new)) (Extension Type: string) |
| 54. PlanDefinition.action.extension:priority | |
| Slice Name | priority |
| Definition | R5: |
| Short | R5: routine | urgent | asap | stat (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: routine | urgent | asap | stat (new)) (Extension Type: code) |
| 56. PlanDefinition.action.extension:subject | |
| Slice Name | subject |
| Definition | R5: |
| Short | R5: Type of individual the action is focused on (new) |
| Comments | Element 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 |
| Type | Extension(R5: Type of individual the action is focused on (new)) (Extension Type: Choice of: CodeableConcept, Reference(Cross-version Profile for R5.Group for use in FHIR STU3, Group), uri) |
| 58. PlanDefinition.action.extension:timing | |
| Slice Name | timing |
| Definition | R5: |
| Short | R5: timing additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: timing additional types) (Extension Type: Age) |
| 60. PlanDefinition.action.extension:location | |
| Slice Name | location |
| Definition | R5: |
| Short | R5: Where it should happen (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: Where it should happen (new)) (Complex Extension) |
| 62. PlanDefinition.action.input | |
| 64. PlanDefinition.action.input.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on PlanDefinition.action.input.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 66. PlanDefinition.action.input.extension:title | |
| Slice Name | title |
| Definition | R5: |
| Short | R5: User-visible title (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: User-visible title (new)) (Extension Type: string) |
| 68. PlanDefinition.action.input.extension:requirement | |
| Slice Name | requirement |
| Definition | R5: |
| Short | R5: What data is provided (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: What data is provided (new)) (Complex Extension) |
| 70. PlanDefinition.action.input.extension:relatedData | |
| Slice Name | relatedData |
| Definition | R5: |
| Short | R5: What data is provided (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: What data is provided (new)) (Extension Type: id) |
| 72. PlanDefinition.action.output | |
| 74. PlanDefinition.action.output.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on PlanDefinition.action.output.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 76. PlanDefinition.action.output.extension:title | |
| Slice Name | title |
| Definition | R5: |
| Short | R5: User-visible title (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: User-visible title (new)) (Extension Type: string) |
| 78. PlanDefinition.action.output.extension:requirement | |
| Slice Name | requirement |
| Definition | R5: |
| Short | R5: What data is provided (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: What data is provided (new)) (Complex Extension) |
| 80. PlanDefinition.action.output.extension:relatedData | |
| Slice Name | relatedData |
| Definition | R5: |
| Short | R5: What data is provided (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: What data is provided (new)) (Extension Type: string) |
| 82. PlanDefinition.action.participant | |
| 84. PlanDefinition.action.participant.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on PlanDefinition.action.participant.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 86. PlanDefinition.action.participant.extension:actorId | |
| Slice Name | actorId |
| Definition | R5: |
| Short | R5: What actor (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: What actor (new)) (Extension Type: string) |
| 88. PlanDefinition.action.participant.extension:typeCanonical | |
| Slice Name | typeCanonical |
| Definition | R5: |
| Short | R5: Who or what can participate (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: Who or what can participate (new)) (Extension Type: uri(Cross-version Profile for R5.CapabilityStatement for use in FHIR STU3, CapabilityStatement)) |
| 90. PlanDefinition.action.participant.extension:typeReference | |
| Slice Name | typeReference |
| Definition | R5: |
| Short | R5: Who or what can participate (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: Who or what can participate (new)) (Extension Type: Reference(Cross-version Profile for R5.CareTeam for use in FHIR STU3, CareTeam, Cross-version Profile for R5.Device for use in FHIR STU3, Device, Cross-version Profile for R5.DeviceDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.Endpoint for use in FHIR STU3, Endpoint, Cross-version Profile for R5.Group for use in FHIR STU3, Group, Cross-version Profile for R5.HealthcareService for use in FHIR STU3, HealthcareService, Cross-version Profile for R5.Location for use in FHIR STU3, Location, Cross-version Profile for R5.Organization for use in FHIR STU3, Organization, Cross-version Profile for R5.Patient for use in FHIR STU3, Patient, Cross-version Profile for R5.Practitioner for use in FHIR STU3, Practitioner, Cross-version Profile for R5.PractitionerRole for use in FHIR STU3, PractitionerRole, Cross-version Profile for R5.RelatedPerson for use in FHIR STU3, RelatedPerson)) |
| 92. PlanDefinition.action.participant.extension:function | |
| Slice Name | function |
| Definition | R5: |
| Short | R5: E.g. Author, Reviewer, Witness, etc (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: E.g. Author, Reviewer, Witness, etc (new)) (Extension Type: CodeableConcept) |
| 94. PlanDefinition.action.participant.type | |
| 96. PlanDefinition.action.participant.type.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on PlanDefinition.action.participant.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 98. PlanDefinition.action.participant.type.extension:type | |
| Slice Name | type |
| Definition | R5: |
| Short | R5: careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson) (Extension Type: code) |
| 100. PlanDefinition.action.type | |
| 102. PlanDefinition.action.type.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on PlanDefinition.action.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 104. PlanDefinition.action.type.extension:type | |
| Slice Name | type |
| Definition | R5: |
| Short | R5: type additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: type additional types) (Extension Type: CodeableConcept) |
| 106. PlanDefinition.action.definition | |
| 108. PlanDefinition.action.definition.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on PlanDefinition.action.definition.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 110. PlanDefinition.action.definition.extension:definition | |
| Slice Name | definition |
| Definition | R5: |
| Short | R5: definition additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: definition additional types) (Extension Type: uri(Cross-version Profile for R5.ActivityDefinition for use in FHIR STU3, ActivityDefinition, Cross-version Profile for R5.MessageDefinition for use in FHIR STU3, MessageDefinition, Cross-version Profile for R5.ObservationDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.PlanDefinition for use in FHIR STU3, PlanDefinition, Cross-version Profile for R5.Questionnaire for use in FHIR STU3, Questionnaire, Cross-version Profile for R5.SpecimenDefinition for use in FHIR STU3, Basic)) |
| 112. PlanDefinition.action.transform | |
| 114. PlanDefinition.action.transform.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on PlanDefinition.action.transform.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 116. PlanDefinition.action.transform.extension:transform | |
| Slice Name | transform |
| Definition | R5: |
| Short | R5: transform additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: transform additional types) (Extension Type: uri(Cross-version Profile for R5.StructureMap for use in FHIR STU3, StructureMap)) |
Guidance on how to interpret the contents of this table can be foundhere
| 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 artifacts such as clinical decision support rules, order sets and protocols. | ||||
| Short | The definition of a plan for a series of actions, independent of any specific patient or context | ||||
| Control | 0..* | ||||
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.empty())dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource ( contained.where(('#'+id in %resource.descendants().reference).not()).empty()) | ||||
| 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 | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 4. PlanDefinition.meta | |||||
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. | ||||
| Short | Metadata about the resource | ||||
| Control | 0..1 | ||||
| Type | Meta | ||||
| Summary | true | ||||
| 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. | ||||
| 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 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 | Unless not suitable, these codes SHALL be taken from Common Languages ![]() (extensible to http://hl7.org/fhir/ValueSet/languages|3.0.2)A human language.
| ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 10. PlanDefinition.text | |||||
| Definition | A human-readable narrative that contains a summary of the resource, and may 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 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 in formation is added later. | ||||
| Control | 0..1 This element is affected by the following invariants: dom-1 | ||||
| Type | Narrative | ||||
| Alternate Names | narrative, html, xhtml, display | ||||
| 12. PlanDefinition.contained | |||||
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Resource | ||||
| Alternate Names | inline resources, anonymous resources, contained resources | ||||
| 14. PlanDefinition.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on PlanDefinition.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 16. PlanDefinition.extension:versionAlgorithm | |||||
| Slice Name | versionAlgorithm | ||||
| Definition | R5: | ||||
| Short | R5: How to compare versions (new) | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm) | ||||
| 18. PlanDefinition.extension:subtitle | |||||
| Slice Name | subtitle | ||||
| Definition | R5: | ||||
| Short | R5: Subordinate title of the plan definition (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Subordinate title of the plan definition (new)) (Extension Type: string) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 20. PlanDefinition.extension:subject | |||||
| Slice Name | subject | ||||
| Definition | R5: | ||||
| Short | R5: Type of individual the plan definition is focused on (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Type of individual the plan definition is focused on (new)) (Extension Type: Choice of: CodeableConcept, Reference(Cross-version Profile for R5.Group for use in FHIR STU3, Group, Cross-version Profile for R5.MedicinalProductDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.SubstanceDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.AdministrableProductDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.ManufacturedItemDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.PackagedProductDefinition for use in FHIR STU3, Basic), uri(Cross-version Profile for R5.EvidenceVariable for use in FHIR STU3, Basic)) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 22. PlanDefinition.extension:copyrightLabel | |||||
| Slice Name | copyrightLabel | ||||
| Definition | R5: | ||||
| Short | R5: Copyright holder and year(s) (new) | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel) | ||||
| 24. PlanDefinition.extension:actor | |||||
| Slice Name | actor | ||||
| Definition | R5: | ||||
| Short | R5: Actors within the plan (new) | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Actors within the plan (new)) (Complex Extension) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 26. PlanDefinition.extension:asNeeded | |||||
| Slice Name | asNeeded | ||||
| Definition | R5: | ||||
| Short | R5: Preconditions for service (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Preconditions for service (new)) (Extension Type: Choice of: boolean, CodeableConcept) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 28. 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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
| 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 No Modifier Reason provideed in previous versions of FHIR | ||||
| Alternate Names | extensions, user content | ||||
| 30. 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. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this plan definition is (or will be) published. The URL SHOULD include the major version of the plan definition. For more information see Technical and Business Versions. | ||||
| Short | Logical URI to reference this plan definition (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. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows the plan definition to be referenced by a single globally unique identifier. | ||||
| 32. 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, e.g., to 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 | ||||
| Summary | true | ||||
| Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module. | ||||
| 34. 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 refrence to a particular business version of the plan definition with the format [url]|[version]. | ||||
| Note | This is a business version Id, not a resource version Id (see discussion) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 36. 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 alpha-numeric type name to ensure that it is computable friendly. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Support human navigation and code generation. | ||||
| 38. 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 | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 40. PlanDefinition.type | |||||
| Definition | The type of asset the plan definition represents, e.g. an order set, protocol, or event-condition-action rule. | ||||
| Short | order-set | protocol | eca-rule | ||||
| Control | 0..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from PlanDefinitionType (extensible to http://hl7.org/fhir/ValueSet/plan-definition-type|3.0.2)The type of PlanDefinition | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| 42. 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 vs. not. | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from PublicationStatus (required to http://hl7.org/fhir/ValueSet/publication-status|3.0.2)The lifecycle status of a Value Set or Concept Map. | ||||
| Type | code | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 44. 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 definition that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental plan definition in production. | ||||
| Control | 0..1 | ||||
| Type | boolean | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level plan definition. | ||||
| 46. PlanDefinition.date | |||||
| Definition | The date (and optionally time) when the plan definition was published. The date must change if and 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 this was last changed | ||||
| Comments | Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the plan definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. | ||||
| Control | 0..1 | ||||
| Type | dateTime | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Alternate Names | Revision Date | ||||
| 48. PlanDefinition.publisher | |||||
| Definition | The name of the individual or organization that published the plan definition. | ||||
| Short | Name of the publisher (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 | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Helps establish the "authority/credibility" of the plan definition. May also allow for contact. | ||||
| 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 why the plan definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the plan definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the profile is presumed to be the predominant language in the place the profile was created). | ||||
| Control | 0..1 | ||||
| Type | markdown | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 52. PlanDefinition.purpose | |||||
| Definition | Explaination 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 | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 54. PlanDefinition.usage | |||||
| Definition | A detailed description of how the asset is used from a clinical perspective. | ||||
| Short | Describes the clinical usage of the asset | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 56. 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 / editorial corrections. | ||||
| Control | 0..1 | ||||
| Type | date | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 58. PlanDefinition.lastReviewDate | |||||
| Definition | The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date. | ||||
| Short | When the plan definition was last reviewed | ||||
| Comments | If specified, this is usually after the approval date. | ||||
| Control | 0..1 | ||||
| Type | date | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 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. | ||||
| 60. 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 measure intended to be used for the year 2016 might be published in 2015. | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Summary | true | ||||
| Requirements | Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of a the plan definition are or are expected to be used instead. | ||||
| 62. PlanDefinition.useContext | |||||
| Definition | The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate plan definition instances. | ||||
| Short | Context the content is intended to support | ||||
| Comments | When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply. | ||||
| Control | 0..* | ||||
| Type | UsageContext | ||||
| Summary | true | ||||
| Requirements | Assist in searching for appropriate content. | ||||
| 64. 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. | ||||
| Control | 0..* | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Jurisdiction ValueSet (extensible to http://hl7.org/fhir/ValueSet/jurisdiction|3.0.2)Countries and regions within which this artifact is targeted for use | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| 66. 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, etc | ||||
| Control | 0..* | ||||
| Binding | For example codes, see DefinitionTopic (example to http://hl7.org/fhir/ValueSet/definition-topic|3.0.2)High-level categorization of the definition, used for searching, sorting, and filtering | ||||
| Type | CodeableConcept | ||||
| Requirements | Repositories must be able to determine how to categorize the asset so that it can be found by topical searches. | ||||
| 68. PlanDefinition.contributor | |||||
| Definition | A contributor to the content of the asset, including authors, editors, reviewers, and endorsers. | ||||
| Short | A content contributor | ||||
| Control | 0..* | ||||
| Type | Contributor | ||||
| Requirements | Consumers of the content must be able to quickly determine who contributed to the content of the asset. | ||||
| 70. PlanDefinition.contributor.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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 72. PlanDefinition.contributor.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on PlanDefinition.contributor.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 74. PlanDefinition.contributor.extension:author | |||||
| Slice Name | author | ||||
| Definition | R5: | ||||
| Short | R5: Who authored the content additional types | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(R5: Who authored the content additional types) (Complex Extension) | ||||
| 76. PlanDefinition.contributor.extension:editor | |||||
| Slice Name | editor | ||||
| Definition | R5: | ||||
| Short | R5: Who edited the content additional types | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(R5: Who edited the content additional types) (Complex Extension) | ||||
| 78. PlanDefinition.contributor.extension:reviewer | |||||
| Slice Name | reviewer | ||||
| Definition | R5: | ||||
| Short | R5: Who reviewed the content additional types | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(R5: Who reviewed the content additional types) (Complex Extension) | ||||
| 80. PlanDefinition.contributor.extension:endorser | |||||
| Slice Name | endorser | ||||
| Definition | R5: | ||||
| Short | R5: Who endorsed the content additional types | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(R5: Who endorsed the content additional types) (Complex Extension) | ||||
| 82. PlanDefinition.contributor.type | |||||
| Definition | The type of contributor. | ||||
| Short | author | editor | reviewer | endorser | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from ContributorType (required to http://hl7.org/fhir/ValueSet/contributor-type|3.0.2)The type of contributor | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 84. PlanDefinition.contributor.name | |||||
| Definition | The name of the individual or organization responsible for the contribution. | ||||
| Short | Who contributed the content | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 86. PlanDefinition.contributor.contact | |||||
| Definition | Contact details to assist a user in finding and communicating with the contributor. | ||||
| Short | Contact details of the contributor | ||||
| Control | 0..* | ||||
| Type | ContactDetail | ||||
| Summary | true | ||||
| 88. 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. | ||||
| Control | 0..* | ||||
| Type | ContactDetail | ||||
| Summary | true | ||||
| 90. PlanDefinition.contact.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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 92. PlanDefinition.contact.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on PlanDefinition.contact.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 94. PlanDefinition.contact.extension:contact | |||||
| Slice Name | contact | ||||
| Definition | R5: | ||||
| Short | R5: contact additional types | ||||
| Comments | Element See guidance around (not) making local changes to elements here. | ||||
| Control | 0..* | ||||
| Type | Extension(R5: contact additional types) (Complex Extension) | ||||
| 96. PlanDefinition.contact.name | |||||
| Definition | The name of an individual to contact. | ||||
| Short | Name of an individual to contact | ||||
| Comments | If there is no named individual, the telecom information is for the organization as a whole. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 98. PlanDefinition.contact.telecom | |||||
| Definition | The contact details for the individual (if a name was provided) or the organization. | ||||
| Short | Contact details for individual or organization | ||||
| Control | 0..* | ||||
| Type | ContactPoint | ||||
| Summary | true | ||||
| 100. 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 | ||||
| Control | 0..1 | ||||
| Type | markdown | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 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 | ||||
| 102. PlanDefinition.relatedArtifact | |||||
| Definition | Related artifacts such as additional documentation, justification, or bibliographic references. | ||||
| Short | Related artifacts for the asset | ||||
| Comments | Each related artifact is either an attachment, or a reference to another resource, but not both. | ||||
| Control | 0..* | ||||
| Type | RelatedArtifact | ||||
| Requirements | Assets 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. | ||||
| 104. 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 | Reference(Library) | ||||
| 106. PlanDefinition.library.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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 108. PlanDefinition.library.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on PlanDefinition.library.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 110. PlanDefinition.library.extension:library | |||||
| Slice Name | library | ||||
| Definition | R5: | ||||
| Short | R5: library additional types | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(R5: library additional types) (Extension Type: uri(Cross-version Profile for R5.Library for use in FHIR STU3, Library)) | ||||
| 112. PlanDefinition.library.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-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 114. PlanDefinition.library.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity 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. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 116. PlanDefinition.library.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 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 118. PlanDefinition.goal | |||||
| Definition | Goals that describe what the activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc. | ||||
| Short | What the plan is trying to accomplish | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| 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() | (children().count() > id.count())) | ||||
| 120. 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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 122. PlanDefinition.goal.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| 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 | ||||
| Alternate Names | extensions, user content | ||||
| 124. 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
| 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 No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 126. PlanDefinition.goal.category | |||||
| Definition | Indicates a category the goal falls within. | ||||
| Short | E.g. Treatment, dietary, behavioral, etc | ||||
| Control | 0..1 | ||||
| Binding | For example codes, see GoalCategory (example to http://hl7.org/fhir/ValueSet/goal-category|3.0.2)Example codes for grouping goals for filtering or presentation | ||||
| Type | CodeableConcept | ||||
| 128. 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 SNOMED CT Clinical Findings (example to http://hl7.org/fhir/ValueSet/clinical-findings|3.0.2)Describes goals that can be achieved | ||||
| Type | CodeableConcept | ||||
| 130. 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 | The codes SHOULD be taken from GoalPriority (preferred to http://hl7.org/fhir/ValueSet/goal-priority|3.0.2)Indicates the level of importance associated with reaching or sustaining a goal | ||||
| Type | CodeableConcept | ||||
| 132. 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|3.0.2)Identifies the types of events that might trigger the start of a goal | ||||
| Type | CodeableConcept | ||||
| 134. 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 Condition/Problem/Diagnosis Codes (example to http://hl7.org/fhir/ValueSet/condition-code|3.0.2)Identifies problems, conditions, issues, or concerns that goals may address | ||||
| Type | CodeableConcept | ||||
| 136. 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 | ||||
| 138. PlanDefinition.goal.target | |||||
| Definition | Indicates what should be done and within what timeframe. | ||||
| Short | Target outcome for the goal | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 140. 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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 142. PlanDefinition.goal.target.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on PlanDefinition.goal.target.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 144. PlanDefinition.goal.target.extension:detail | |||||
| Slice Name | detail | ||||
| Definition | R5: | ||||
| Short | R5: detail additional types | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: detail additional types) (Extension Type: Choice of: string, boolean, integer, Ratio) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 146. 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
| 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 No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 148. PlanDefinition.goal.target.measure | |||||
| Definition | The parameter whose value is to be tracked, e.g. body weigth, blood pressure, or hemoglobin A1c level. | ||||
| Short | The parameter whose value is to be tracked | ||||
| Control | 0..1 | ||||
| Binding | For example codes, see LOINC Codes (example to http://hl7.org/fhir/ValueSet/observation-codes|3.0.2)Identifies types of parameters that can be tracked to determine goal achievement | ||||
| Type | CodeableConcept | ||||
| 150. PlanDefinition.goal.target.detail[x] | |||||
| Definition | The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%. Either the high or low or both values of the range can be specified. Whan 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 | ||||
| Control | 0..1 | ||||
| Type | Choice of: Quantity, Range, CodeableConcept | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| 152. 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 | ||||
| 154. PlanDefinition.action | |||||
| Definition | An action to be taken as part of the plan. | ||||
| Short | Action defined by the plan | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 156. 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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 158. PlanDefinition.action.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on PlanDefinition.action.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 160. PlanDefinition.action.extension:linkId | |||||
| Slice Name | linkId | ||||
| Definition | R5: | ||||
| Short | R5: Unique id for the action in the PlanDefinition (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Unique id for the action in the PlanDefinition (new)) (Extension Type: string) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 162. PlanDefinition.action.extension:priority | |||||
| Slice Name | priority | ||||
| Definition | R5: | ||||
| Short | R5: routine | urgent | asap | stat (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: routine | urgent | asap | stat (new)) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 164. PlanDefinition.action.extension:subject | |||||
| Slice Name | subject | ||||
| Definition | R5: | ||||
| Short | R5: Type of individual the action is focused on (new) | ||||
| Comments | Element 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 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Type of individual the action is focused on (new)) (Extension Type: Choice of: CodeableConcept, Reference(Cross-version Profile for R5.Group for use in FHIR STU3, Group), uri) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 166. PlanDefinition.action.extension:timing | |||||
| Slice Name | timing | ||||
| Definition | R5: | ||||
| Short | R5: timing additional types | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: timing additional types) (Extension Type: Age) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 168. PlanDefinition.action.extension:location | |||||
| Slice Name | location | ||||
| Definition | R5: | ||||
| Short | R5: Where it should happen (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Where it should happen (new)) (Complex Extension) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 170. 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
| 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 No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 172. PlanDefinition.action.label | |||||
| Definition | A user-visible label for the action. | ||||
| Short | User-visible label for the action (e.g. 1. or A.) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 174. PlanDefinition.action.title | |||||
| Definition | The title of the action displayed to a user. | ||||
| Short | User-visible title | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 176. PlanDefinition.action.description | |||||
| Definition | A short description of the action used to provide a summary to display to the user. | ||||
| Short | Short description of the action | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 178. 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 may 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 | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 180. PlanDefinition.action.code | |||||
| Definition | A code that provides meaning for the action or action group. For example, a section may have a LOINC code for a the section of a documentation template. | ||||
| Short | Code representing the meaning of the action or sub-actions | ||||
| Control | 0..* | ||||
| Type | CodeableConcept | ||||
| 182. 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..* | ||||
| Type | CodeableConcept | ||||
| 184. 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 | ||||
| 186. PlanDefinition.action.goalId | |||||
| Definition | Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. | ||||
| Short | What goals this action supports | ||||
| Control | 0..* | ||||
| Type | id | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 188. PlanDefinition.action.triggerDefinition | |||||
| Definition | A description of when the action should be triggered. | ||||
| Short | When the action should be triggered | ||||
| Control | 0..* | ||||
| Type | TriggerDefinition | ||||
| 190. 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 | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 192. 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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 194. PlanDefinition.action.condition.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| 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 | ||||
| Alternate Names | extensions, user content | ||||
| 196. 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
| 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 No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 198. 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 when 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|3.0.2)Defines the kinds of conditions that can appear on actions | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 200. PlanDefinition.action.condition.description | |||||
| Definition | A brief, natural language description of the condition that effectively communicates the intended semantics. | ||||
| Short | Natural language description of the condition | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 202. PlanDefinition.action.condition.language | |||||
| Definition | The media type of the language for the expression. | ||||
| Short | Language of the expression | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 204. PlanDefinition.action.condition.expression | |||||
| Definition | An expression that returns true or false, indicating whether or not 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 | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 206. PlanDefinition.action.input | |||||
| Definition | Defines input data requirements for the action. | ||||
| Short | Input data requirements | ||||
| Control | 0..* | ||||
| Type | DataRequirement | ||||
| 208. 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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 210. PlanDefinition.action.input.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on PlanDefinition.action.input.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 212. PlanDefinition.action.input.extension:title | |||||
| Slice Name | title | ||||
| Definition | R5: | ||||
| Short | R5: User-visible title (new) | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(R5: User-visible title (new)) (Extension Type: string) | ||||
| 214. PlanDefinition.action.input.extension:requirement | |||||
| Slice Name | requirement | ||||
| Definition | R5: | ||||
| Short | R5: What data is provided (new) | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(R5: What data is provided (new)) (Complex Extension) | ||||
| 216. PlanDefinition.action.input.extension:relatedData | |||||
| Slice Name | relatedData | ||||
| Definition | R5: | ||||
| Short | R5: What data is provided (new) | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(R5: What data is provided (new)) (Extension Type: id) | ||||
| 218. PlanDefinition.action.input.type | |||||
| Definition | The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile. | ||||
| Short | The type of the required data | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from FHIRAllTypes (required to http://hl7.org/fhir/ValueSet/all-types|3.0.2)Either an abstract type, a resource or a data type. | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 220. PlanDefinition.action.input.profile | |||||
| Definition | The profile of the required data, specified as the uri of the profile definition. | ||||
| Short | The profile of the required data | ||||
| Control | 0..* | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 222. PlanDefinition.action.input.mustSupport | |||||
| Definition | Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. Note that the value for this element can be a path to allow references to nested elements. In that case, all the elements along the path must be supported. | ||||
| Short | Indicates that specific structure elements are referenced by the knowledge module | ||||
| Control | 0..* | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 224. PlanDefinition.action.input.codeFilter | |||||
| Definition | Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. | ||||
| Short | What codes are expected | ||||
| Control | 0..* | ||||
| Type | Element | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 226. PlanDefinition.action.input.codeFilter.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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 228. PlanDefinition.action.input.codeFilter.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| 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 | ||||
| Alternate Names | extensions, user content | ||||
| Slicing | This element introduces a set of slices on PlanDefinition.action.input.codeFilter.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 230. PlanDefinition.action.input.codeFilter.path | |||||
| Definition | The code-valued attribute of the filter. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept. | ||||
| Short | The code-valued attribute of the filter | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 232. PlanDefinition.action.input.codeFilter.valueSet[x] | |||||
| Definition | The valueset for the code filter. The valueSet and value elements are exclusive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset. | ||||
| Short | Valueset for the filter | ||||
| Control | 0..1 | ||||
| Type | Choice of: string, Reference(ValueSet) | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 234. PlanDefinition.action.input.codeFilter.valueCode | |||||
| Definition | The codes for the code filter. Only one of valueSet, valueCode, valueCoding, or valueCodeableConcept may be specified. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. | ||||
| Short | What code is expected | ||||
| Control | 0..* | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 236. PlanDefinition.action.input.codeFilter.valueCoding | |||||
| Definition | The Codings for the code filter. Only one of valueSet, valueCode, valueConding, or valueCodeableConcept may be specified. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified Codings. | ||||
| Short | What Coding is expected | ||||
| Control | 0..* | ||||
| Type | Coding | ||||
| Summary | true | ||||
| 238. PlanDefinition.action.input.codeFilter.valueCodeableConcept | |||||
| Definition | The CodeableConcepts for the code filter. Only one of valueSet, valueCode, valueConding, or valueCodeableConcept may be specified. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified CodeableConcepts. | ||||
| Short | What CodeableConcept is expected | ||||
| Control | 0..* | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| 240. PlanDefinition.action.input.dateFilter | |||||
| Definition | Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. | ||||
| Short | What dates/date ranges are expected | ||||
| Control | 0..* | ||||
| Type | Element | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 242. PlanDefinition.action.input.dateFilter.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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 244. PlanDefinition.action.input.dateFilter.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| 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 | ||||
| Alternate Names | extensions, user content | ||||
| Slicing | This element introduces a set of slices on PlanDefinition.action.input.dateFilter.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 246. PlanDefinition.action.input.dateFilter.path | |||||
| Definition | The date-valued attribute of the filter. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant. The path must resolve to an element of type dateTime, Period, Schedule, or Timing. | ||||
| Short | The date-valued attribute of the filter | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 248. PlanDefinition.action.input.dateFilter.value[x] | |||||
| Definition | The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration from now. | ||||
| Short | The value of the filter, as a Period, DateTime, or Duration value | ||||
| Control | 0..1 | ||||
| Type | Choice of: dateTime, Period, Duration | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 250. PlanDefinition.action.output | |||||
| Definition | Defines the outputs of the action, if any. | ||||
| Short | Output data definition | ||||
| Control | 0..* | ||||
| Type | DataRequirement | ||||
| 252. 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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 254. PlanDefinition.action.output.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on PlanDefinition.action.output.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 256. PlanDefinition.action.output.extension:title | |||||
| Slice Name | title | ||||
| Definition | R5: | ||||
| Short | R5: User-visible title (new) | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(R5: User-visible title (new)) (Extension Type: string) | ||||
| 258. PlanDefinition.action.output.extension:requirement | |||||
| Slice Name | requirement | ||||
| Definition | R5: | ||||
| Short | R5: What data is provided (new) | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(R5: What data is provided (new)) (Complex Extension) | ||||
| 260. PlanDefinition.action.output.extension:relatedData | |||||
| Slice Name | relatedData | ||||
| Definition | R5: | ||||
| Short | R5: What data is provided (new) | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(R5: What data is provided (new)) (Extension Type: string) | ||||
| 262. PlanDefinition.action.output.type | |||||
| Definition | The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile. | ||||
| Short | The type of the required data | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from FHIRAllTypes (required to http://hl7.org/fhir/ValueSet/all-types|3.0.2)Either an abstract type, a resource or a data type. | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 264. PlanDefinition.action.output.profile | |||||
| Definition | The profile of the required data, specified as the uri of the profile definition. | ||||
| Short | The profile of the required data | ||||
| Control | 0..* | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 266. PlanDefinition.action.output.mustSupport | |||||
| Definition | Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. Note that the value for this element can be a path to allow references to nested elements. In that case, all the elements along the path must be supported. | ||||
| Short | Indicates that specific structure elements are referenced by the knowledge module | ||||
| Control | 0..* | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 268. PlanDefinition.action.output.codeFilter | |||||
| Definition | Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. | ||||
| Short | What codes are expected | ||||
| Control | 0..* | ||||
| Type | Element | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 270. PlanDefinition.action.output.codeFilter.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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 272. PlanDefinition.action.output.codeFilter.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| 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 | ||||
| Alternate Names | extensions, user content | ||||
| Slicing | This element introduces a set of slices on PlanDefinition.action.output.codeFilter.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 274. PlanDefinition.action.output.codeFilter.path | |||||
| Definition | The code-valued attribute of the filter. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept. | ||||
| Short | The code-valued attribute of the filter | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 276. PlanDefinition.action.output.codeFilter.valueSet[x] | |||||
| Definition | The valueset for the code filter. The valueSet and value elements are exclusive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset. | ||||
| Short | Valueset for the filter | ||||
| Control | 0..1 | ||||
| Type | Choice of: string, Reference(ValueSet) | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 278. PlanDefinition.action.output.codeFilter.valueCode | |||||
| Definition | The codes for the code filter. Only one of valueSet, valueCode, valueCoding, or valueCodeableConcept may be specified. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. | ||||
| Short | What code is expected | ||||
| Control | 0..* | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 280. PlanDefinition.action.output.codeFilter.valueCoding | |||||
| Definition | The Codings for the code filter. Only one of valueSet, valueCode, valueConding, or valueCodeableConcept may be specified. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified Codings. | ||||
| Short | What Coding is expected | ||||
| Control | 0..* | ||||
| Type | Coding | ||||
| Summary | true | ||||
| 282. PlanDefinition.action.output.codeFilter.valueCodeableConcept | |||||
| Definition | The CodeableConcepts for the code filter. Only one of valueSet, valueCode, valueConding, or valueCodeableConcept may be specified. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified CodeableConcepts. | ||||
| Short | What CodeableConcept is expected | ||||
| Control | 0..* | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| 284. PlanDefinition.action.output.dateFilter | |||||
| Definition | Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. | ||||
| Short | What dates/date ranges are expected | ||||
| Control | 0..* | ||||
| Type | Element | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 286. PlanDefinition.action.output.dateFilter.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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 288. PlanDefinition.action.output.dateFilter.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| 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 | ||||
| Alternate Names | extensions, user content | ||||
| Slicing | This element introduces a set of slices on PlanDefinition.action.output.dateFilter.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 290. PlanDefinition.action.output.dateFilter.path | |||||
| Definition | The date-valued attribute of the filter. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant. The path must resolve to an element of type dateTime, Period, Schedule, or Timing. | ||||
| Short | The date-valued attribute of the filter | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 292. PlanDefinition.action.output.dateFilter.value[x] | |||||
| Definition | The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration from now. | ||||
| Short | The value of the filter, as a Period, DateTime, or Duration value | ||||
| Control | 0..1 | ||||
| Type | Choice of: dateTime, Period, Duration | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 294. 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..* | ||||
| Type | BackboneElement | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 296. 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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 298. PlanDefinition.action.relatedAction.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| 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 | ||||
| Alternate Names | extensions, user content | ||||
| 300. 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
| 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 No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 302. PlanDefinition.action.relatedAction.actionId | |||||
| Definition | The element id of the related action. | ||||
| Short | What action is this related to | ||||
| Control | 1..1 | ||||
| Type | id | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 304. PlanDefinition.action.relatedAction.relationship | |||||
| Definition | The relationship of this action to the related action. | ||||
| Short | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from ActionRelationshipType (required to http://hl7.org/fhir/ValueSet/action-relationship-type|3.0.2)Defines the types of relationships between actions | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 306. 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 | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| 308. PlanDefinition.action.timing[x] | |||||
| Definition | An optional value describing when the action should be performed. | ||||
| Short | When the action should take place | ||||
| Control | 0..1 | ||||
| Type | Choice of: dateTime, Period, Duration, Range, Timing | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 310. PlanDefinition.action.participant | |||||
| Definition | Indicates who should participate in performing the action described. | ||||
| Short | Who should participate in the action | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 312. 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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 314. PlanDefinition.action.participant.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on PlanDefinition.action.participant.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 316. PlanDefinition.action.participant.extension:actorId | |||||
| Slice Name | actorId | ||||
| Definition | R5: | ||||
| Short | R5: What actor (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: What actor (new)) (Extension Type: string) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 318. PlanDefinition.action.participant.extension:typeCanonical | |||||
| Slice Name | typeCanonical | ||||
| Definition | R5: | ||||
| Short | R5: Who or what can participate (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Who or what can participate (new)) (Extension Type: uri(Cross-version Profile for R5.CapabilityStatement for use in FHIR STU3, CapabilityStatement)) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 320. PlanDefinition.action.participant.extension:typeReference | |||||
| Slice Name | typeReference | ||||
| Definition | R5: | ||||
| Short | R5: Who or what can participate (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Who or what can participate (new)) (Extension Type: Reference(Cross-version Profile for R5.CareTeam for use in FHIR STU3, CareTeam, Cross-version Profile for R5.Device for use in FHIR STU3, Device, Cross-version Profile for R5.DeviceDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.Endpoint for use in FHIR STU3, Endpoint, Cross-version Profile for R5.Group for use in FHIR STU3, Group, Cross-version Profile for R5.HealthcareService for use in FHIR STU3, HealthcareService, Cross-version Profile for R5.Location for use in FHIR STU3, Location, Cross-version Profile for R5.Organization for use in FHIR STU3, Organization, Cross-version Profile for R5.Patient for use in FHIR STU3, Patient, Cross-version Profile for R5.Practitioner for use in FHIR STU3, Practitioner, Cross-version Profile for R5.PractitionerRole for use in FHIR STU3, PractitionerRole, Cross-version Profile for R5.RelatedPerson for use in FHIR STU3, RelatedPerson)) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 322. PlanDefinition.action.participant.extension:function | |||||
| Slice Name | function | ||||
| Definition | R5: | ||||
| Short | R5: E.g. Author, Reviewer, Witness, etc (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: E.g. Author, Reviewer, Witness, etc (new)) (Extension Type: CodeableConcept) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 324. 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
| 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 No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 326. PlanDefinition.action.participant.type | |||||
| Definition | The type of participant in the action. | ||||
| Short | patient | practitioner | related-person | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from ActionParticipantType ![]() (required to http://hl7.org/fhir/ValueSet/action-participant-type|3.0.2)The type of participant for the action | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 328. PlanDefinition.action.participant.type.id | |||||
| Definition | unique id for the element within a resource (for internal references) | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 330. PlanDefinition.action.participant.type.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on PlanDefinition.action.participant.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 332. PlanDefinition.action.participant.type.extension:type | |||||
| Slice Name | type | ||||
| Definition | R5: | ||||
| Short | R5: careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 334. PlanDefinition.action.participant.type.value | |||||
| Definition | Primitive value for code | ||||
| Short | Primitive value for code | ||||
| Control | 0..1 | ||||
| Type | code | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 336. PlanDefinition.action.participant.role | |||||
| Definition | The role the participant should play in performing the described action. | ||||
| Short | E.g. Nurse, Surgeon, Parent, etc | ||||
| Control | 0..1 | ||||
| Binding | For example codes, see ActionParticipantRole (example to http://hl7.org/fhir/ValueSet/action-participant-role|3.0.2)Defines roles played by participants for the action | ||||
| Type | CodeableConcept | ||||
| 338. PlanDefinition.action.type | |||||
| Definition | The type of action to perform (create, update, remove). | ||||
| Short | create | update | remove | fire-event | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from ActionType (required to http://hl7.org/fhir/ValueSet/action-type|3.0.2)The type of action to be performed | ||||
| Type | Coding | ||||
| 340. PlanDefinition.action.type.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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 342. PlanDefinition.action.type.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on PlanDefinition.action.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 344. PlanDefinition.action.type.extension:type | |||||
| Slice Name | type | ||||
| Definition | R5: | ||||
| Short | R5: type additional types | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(R5: type additional types) (Extension Type: CodeableConcept) | ||||
| 346. PlanDefinition.action.type.system | |||||
| Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
| Short | Identity of the terminology system | ||||
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
| 348. PlanDefinition.action.type.version | |||||
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
| Short | Version of the system - if relevant | ||||
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
| Note | This is a business version Id, not a resource version Id (see discussion) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 350. PlanDefinition.action.type.code | |||||
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
| Short | Symbol in syntax defined by the system | ||||
| Control | 0..1 | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to refer to a particular code in the system. | ||||
| 352. PlanDefinition.action.type.display | |||||
| Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
| Short | Representation defined by the system | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
| 354. PlanDefinition.action.type.userSelected | |||||
| Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). | ||||
| Short | If this coding was chosen directly by the user | ||||
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
| Control | 0..1 | ||||
| Type | boolean | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
| 356. 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|3.0.2)Defines organization behavior of a group | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 358. 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|3.0.2)Defines selection behavior of a group | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 360. PlanDefinition.action.requiredBehavior | |||||
| Definition | Defines the requiredness 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|3.0.2)Defines requiredness behavior for selecting an action or an action group | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 362. 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|3.0.2)Defines selection frequency behavior for an action or group | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 364. 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|3.0.2)Defines behavior for an action or a group for how many times that item may be repeated | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 366. PlanDefinition.action.definition | |||||
| Definition | A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken. | ||||
| 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 (~) path can be used to define the entire resource dynamically. | ||||
| Control | 0..1 | ||||
| Type | Reference(ActivityDefinition, PlanDefinition) | ||||
| 368. PlanDefinition.action.definition.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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 370. PlanDefinition.action.definition.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on PlanDefinition.action.definition.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 372. PlanDefinition.action.definition.extension:definition | |||||
| Slice Name | definition | ||||
| Definition | R5: | ||||
| Short | R5: definition additional types | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(R5: definition additional types) (Extension Type: uri(Cross-version Profile for R5.ActivityDefinition for use in FHIR STU3, ActivityDefinition, Cross-version Profile for R5.MessageDefinition for use in FHIR STU3, MessageDefinition, Cross-version Profile for R5.ObservationDefinition for use in FHIR STU3, Basic, Cross-version Profile for R5.PlanDefinition for use in FHIR STU3, PlanDefinition, Cross-version Profile for R5.Questionnaire for use in FHIR STU3, Questionnaire, Cross-version Profile for R5.SpecimenDefinition for use in FHIR STU3, Basic)) | ||||
| 374. PlanDefinition.action.definition.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-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 376. PlanDefinition.action.definition.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity 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. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 378. PlanDefinition.action.definition.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 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 380. 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 | ||||
| Control | 0..1 | ||||
| Type | Reference(StructureMap) | ||||
| 382. PlanDefinition.action.transform.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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 384. PlanDefinition.action.transform.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on PlanDefinition.action.transform.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 386. PlanDefinition.action.transform.extension:transform | |||||
| Slice Name | transform | ||||
| Definition | R5: | ||||
| Short | R5: transform additional types | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(R5: transform additional types) (Extension Type: uri(Cross-version Profile for R5.StructureMap for use in FHIR STU3, StructureMap)) | ||||
| 388. PlanDefinition.action.transform.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-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 390. PlanDefinition.action.transform.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity 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. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 392. PlanDefinition.action.transform.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 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 394. 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 | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 396. 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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 398. PlanDefinition.action.dynamicValue.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| 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 | ||||
| Alternate Names | extensions, user content | ||||
| 400. 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
| 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 No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 402. PlanDefinition.action.dynamicValue.description | |||||
| Definition | A brief, natural language description of the intended semantics of the dynamic value. | ||||
| Short | Natural language description of the dynamic value | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 404. 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. | ||||
| Short | The path to the element to be set dynamically | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 406. PlanDefinition.action.dynamicValue.language | |||||
| Definition | The media type of the language for the expression. | ||||
| Short | Language of the expression | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 408. 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 | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 410. 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 | Seettp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action | ||||