Order Catalog Implementation Guide
1.0.0 - STU 1

Order Catalog Implementation Guide, published by HL7 International / Orders and Observations. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-order-catalog/ and changes regularly. See the Directory of published versions

## Resource Profile: LabServiceDefinition - Detailed Descriptions

Page standards status: Informative

Definitions for the LabServiceDefinition resource profile.

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

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 and non-clinical artifacts such as clinical decision support rules, order sets, protocols, and drug quality specifications.
Short | The definition of a plan for a series of actionsThe definition of a plan for a series of actions, independent of any specific patient or context
Comments | The LabServiceDefinition profile constrains the resource PlanDefinition to represent a laboratory diagnostic service made visible to clinicians: the potential consumers of this service.
Control | 0..*
Is Modifier | false
Must Support | false
Summary | false
Invariants | cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')) pld-3: goalid should reference the id of a goal definition (%context.repeat(action).where((goalId in %context.goal.id).not()).exists().not()) pld-4: targetId should reference the id of an action (%context.repeat(action).relatedAction.where((targetId in %context.repeat(action).id).not()).exists().not())
2. PlanDefinition.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.
Control | 0..1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. PlanDefinition.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.
Short | Contained, inline Resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.
Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
Type | Resource
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
6. PlanDefinition.extension
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | ExtensionAdditional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `PlanDefinition.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
8. PlanDefinition.extension:CatalogReference
Slice Name | CatalogReference
Definition | This extension to PlanDefinition, MedicationKnowledge and DeviceDefinition conveys the reference to a catalog containing the extended resource
Short | Reference to a catalog exposing this service
Control | 0..*
Type | Extension(Reference to a catalog) (Extension Type: Reference(Catalog Header))
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
10. PlanDefinition.extension:ServiceBillingCode
Slice Name | ServiceBillingCode
Definition | Optional Extension Element - found in all resources.
Short | A billing code associated with the service
Control | 0..*
Type | Extension(Healthcare Service Billing Code) (Extension Type: Choice of: CodeableConcept, Reference)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
12. PlanDefinition.extension:BillingSummary
Slice Name | BillingSummary
Definition | An Extension
Short | Textual summary of billing applied to the service
Control | 0..1
Type | Extension(Billing summary for the plan definition) (Complex Extension)
Is Modifier | false
Must Support | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
14. PlanDefinition.extension:ScheduleSummary
Slice Name | ScheduleSummary
Definition | An Extension
Short | Textual summary of the schedule of the service
Control | 0..1
Type | Extension(Schedule summary for the plan definition) (Extension Type: string)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
16. PlanDefinition.extension:LimitationSummary
Slice Name | LimitationSummary
Definition | An Extension
Short | Textual summary of limitations associated with the service
Control | 0..1
Type | Extension(Limitation summary for the plan definition) (Extension Type: string)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
18. PlanDefinition.extension:RegulatorySummary
Slice Name | RegulatorySummary
Definition | An Extension
Short | Textual summary of regulations applicable to this service
Control | 0..1
Type | Extension(Summary of regulations applicable to the laboratory service) (Extension Type: string)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
20. PlanDefinition.extension:ResultInterpretationSummary
Slice Name | ResultInterpretationSummary
Definition | An Extension
Short | markdown summary of result interpretation guidance for this service
Control | 0..1
Type | Extension(Summary of result interpretation guidance of the laboratory service) (Extension Type: markdown)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
22. PlanDefinition.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Support | false
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
24. PlanDefinition.type
Definition | A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.
Short | panel | testorder-set | clinical-protocol | eca-rule | workflow-definition
Comments | In this LabServiceDefiniton profile, PlanDefinition represents a laboratory service, which can be either a test or a panel. A test is a single measurement performed on a material/digital specimen, producing generally one result (sometimes zero, sometime more). A panel is a collection of tests and panels, performed on one or more material/digital specimens, and producing a collection of results. Therefore, the type is bound to a value set {"test", "panel"}. The original value bound to this element with binding strength "extensible" does not contain appropriate values for laboratory diagnostic services.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from Types of diagnostic services performed by a laboratory http://hl7.org/fhir/ValueSet/plan-definition-type|5.0.0 (extensible to `http://hl7.org/fhir/uv/order-catalog/ValueSet/laboratory-service-type` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. PlanDefinition.status
Definition | The status of this plan definition. Enables tracking the life-cycle of the content.
Short | draft | active | retired | unknown
Comments | Allows filtering of plan definitions that are appropriate for use versus not. See guidance around (not) making local changes to elements here. Allows filtering of plan definitions that are appropriate for use versus not. See guidance around (not) making local changes to elements here.
Control | 1..1
Binding | The codes SHALL be taken from PublicationStatus http://hl7.org/fhir/ValueSet/publication-status|5.0.0 (required to `http://hl7.org/fhir/ValueSet/publication-status|5.0.0` ) The lifecycle status of an artifact.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. 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 provides details such as when this laboratory diagnostic service can be ordered, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the plan definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the plan definition is presumed to be the predominant language in the place the plan definition was created). This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the plan definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the plan definition is presumed to be the predominant language in the place the plan definition was created).
Control | 0..1
Type | markdown
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. PlanDefinition.description.extension
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | ExtensionAdditional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `PlanDefinition.description.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
32. PlanDefinition.description.extension:OtherDescription
Slice Name | OtherDescription
Definition | Translation of the description of the laboratory service in a specified language
Short | Translation in a specified language
Control | 0..*
Type | Extension(Translation) (Complex Extension)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
34. PlanDefinition.useContext
Definition | The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances.
Short | The context that the content is intended to support
Comments | When multiple useContexts are specified, in this LabServiceDefinition profile, all contexts apply to the defined laboratory service. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
Control | 0..*
Type | UsageContext
Is Modifier | false
Must Support | true
Summary | true
Requirements | Assist in searching for appropriate content.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `PlanDefinition.useContext`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ code type @ value value @ value
36. PlanDefinition.useContext:Orderable
Slice Name | Orderable
Definition | The presence of this slice indicates that the service is open to laboratory order entry The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances.
Short | Service is orderableThe context that the content is intended to support
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
Control | 0..1*
Type | UsageContext
Is Modifier | false
Must Support | true
Summary | true
Requirements | Assist in searching for appropriate content.
Label | orderable
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. PlanDefinition.useContext:Orderable.code
Definition | A code that identifies the type of context being specified by this usage context.
Short | Type of context being specified
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from UsageContextType http://terminology.hl7.org/ValueSet/usage-context-type (extensible to `http://terminology.hl7.org/ValueSet/usage-context-type` ) A code that specifies a type of context being specified by a usage context.
Type | Coding
Is Modifier | false
Summary | true
Pattern Value | `{ "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type", "code" : "task" }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. PlanDefinition.useContext:Orderable.value[x]
Definition | A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.
Short | Value that defines the context
Control | 1..1
Binding | For example codes, see ContextOfUseValueSet http://hl7.org/fhir/ValueSet/use-context|5.0.0 (example to `http://hl7.org/fhir/ValueSet/use-context|5.0.0` ) A code that defines the specific value for the context being specified.
Type | CodeableConcept, Reference(PlanDefinition, ResearchStudy, InsurancePlan, HealthcareService, Group, Location, Organization), Quantity, Range
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
Pattern Value | `{ "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode", "code" : "LABOE" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. PlanDefinition.useContext:PathologistInitiative
Slice Name | PathologistInitiative
Definition | The presence of this slice indicates that the service may be added to an existing order by the pathologist after review of the preliminary results of this order The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances.
Short | Service may be added by pathologistThe context that the content is intended to support
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
Control | 0..1*
Type | UsageContext
Is Modifier | false
Must Support | true
Summary | true
Requirements | Assist in searching for appropriate content.
Label | pathologist
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. PlanDefinition.useContext:PathologistInitiative.code
Definition | A code that identifies the type of context being specified by this usage context.
Short | Type of context being specified
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from UsageContextType http://terminology.hl7.org/ValueSet/usage-context-type (extensible to `http://terminology.hl7.org/ValueSet/usage-context-type` ) A code that specifies a type of context being specified by a usage context.
Type | Coding
Is Modifier | false
Summary | true
Pattern Value | `{ "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type", "code" : "task" }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. PlanDefinition.useContext:PathologistInitiative.value[x]
Definition | A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.
Short | Value that defines the context
Control | 1..1
Binding | For example codes, see ContextOfUseValueSet http://hl7.org/fhir/ValueSet/use-context|5.0.0 (example to `http://hl7.org/fhir/ValueSet/use-context|5.0.0` ) A code that defines the specific value for the context being specified.
Type | CodeableConcept, Reference(PlanDefinition, ResearchStudy, InsurancePlan, HealthcareService, Group, Location, Organization), Quantity, Range
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
Pattern Value | `{ "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode", "code" : "LABRREV" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. PlanDefinition.useContext:OneGender
Slice Name | OneGender
Definition | The presence of this slice indicates that the service is restricted to one gender of subject (female or male) The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances.
Short | service restricted to one genderThe context that the content is intended to support
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
Control | 0..1*
Type | UsageContext
Is Modifier | false
Must Support | true
Summary | true
Requirements | Assist in searching for appropriate content.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. PlanDefinition.useContext:OneGender.code
Definition | A code that identifies the type of context being specified by this usage context.
Short | Type of context being specified
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from UsageContextType http://terminology.hl7.org/ValueSet/usage-context-type (extensible to `http://terminology.hl7.org/ValueSet/usage-context-type` ) A code that specifies a type of context being specified by a usage context.
Type | Coding
Is Modifier | false
Summary | true
Pattern Value | `{ "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type", "code" : "gender" }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. PlanDefinition.useContext:OneGender.value[x]
Definition | A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.
Short | Value that defines the context
Control | 1..1
Binding | The codes SHALL be taken from For example codes, see AdministrativeGender http://hl7.org/fhir/ValueSet/use-context|5.0.0 (required to `http://hl7.org/fhir/ValueSet/administrative-gender` )
Type | CodeableConcept, Reference(PlanDefinition, ResearchStudy, InsurancePlan, HealthcareService, Group, Location, Organization), Quantity, Range
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. PlanDefinition.useContext:StoreSpecimen
Slice Name | StoreSpecimen
Definition | The presence of this slice indicates that the specimens used to perform this service will be kept in long-time storage and available for re-testing in the future The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances.
Short | Specimens to be keptThe context that the content is intended to support
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
Control | 0..1*
Type | UsageContext
Is Modifier | false
Must Support | true
Summary | true
Requirements | Assist in searching for appropriate content.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. PlanDefinition.useContext:StoreSpecimen.code
Definition | A code that identifies the type of context being specified by this usage context.
Short | Type of context being specified
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from UsageContextType http://terminology.hl7.org/ValueSet/usage-context-type (extensible to `http://terminology.hl7.org/ValueSet/usage-context-type` ) A code that specifies a type of context being specified by a usage context.
Type | Coding
Is Modifier | false
Summary | true
Pattern Value | `{ "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type", "code" : "task" }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. PlanDefinition.useContext:StoreSpecimen.value[x]
Definition | A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.
Short | Value that defines the context
Control | 1..1
Binding | For example codes, see ContextOfUseValueSet http://hl7.org/fhir/ValueSet/use-context|5.0.0 (example to `http://hl7.org/fhir/ValueSet/use-context|5.0.0` ) A code that defines the specific value for the context being specified.
Type | CodeableConcept, Reference(PlanDefinition, ResearchStudy, InsurancePlan, HealthcareService, Group, Location, Organization), Quantity, Range
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
Pattern Value | `{ "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode", "code" : "SSTOR" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. PlanDefinition.useContext:AgeRange
Slice Name | AgeRange
Definition | The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances.
Short | A patient age range applicable for this serviceThe context that the content is intended to support
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
Control | 0..*
Type | UsageContext
Is Modifier | false
Must Support | true
Summary | true
Requirements | Assist in searching for appropriate content.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. PlanDefinition.useContext:AgeRange.code
Definition | A code that identifies the type of context being specified by this usage context.
Short | Type of context being specified
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from UsageContextType http://terminology.hl7.org/ValueSet/usage-context-type (extensible to `http://terminology.hl7.org/ValueSet/usage-context-type` ) A code that specifies a type of context being specified by a usage context.
Type | Coding
Is Modifier | false
Summary | true
Pattern Value | `{ "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type", "code" : "age" }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
64. PlanDefinition.useContext:AgeRange.value[x]
Definition | A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.
Short | patient age range applicable for this serviceValue that defines the context
Control | 1..1
Binding | For example codes, see ContextOfUseValueSet http://hl7.org/fhir/ValueSet/use-context|5.0.0 (example to `http://hl7.org/fhir/ValueSet/use-context|5.0.0` ) A code that defines the specific value for the context being specified.
Type | Range, Reference(PlanDefinition, ResearchStudy, InsurancePlan, HealthcareService, Group, Location, Organization), Quantity, CodeableConcept
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. PlanDefinition.usage
Definition | A detailed description of how the laboratory diagnostic service is used from a clinical perspective. A detailed description of how the plan definition is used from a clinical perspective.
Short | Describes the clinical usage of the laboratory diagnostic serviceDescribes the clinical usage of the plan
Control | 0..1
Type | markdown
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
68. PlanDefinition.topic
Definition | Descriptive topics related to the content of the laboratory service definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching. Some possible axes of categorization include laboratory specialty, kind of pathology, kind of biologic specimen tested, ... 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 | categorization of the laboratory serviceE.g. Education, Treatment, Assessment
Comments | Topics are usually chosen by the laboratory or the organization owning the catalog DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic)
Control | 0..*
Binding | For example codes, see DefinitionTopic http://hl7.org/fhir/ValueSet/definition-topic|5.0.0 (example to `http://hl7.org/fhir/ValueSet/definition-topic|5.0.0` ) High-level categorization of the definition, used for searching, sorting, and filtering.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Repositories must be able to determine how to categorize the plan definition so that it can be found by topical searches.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
70. PlanDefinition.relatedArtifact
Definition | Related artifacts such as additional documentation, justification, or bibliographic references.
Short | Additional documentation, citations
Comments | Each related artifact is either an attachment, or a reference to another resource, but not both.
Control | 0..*
Type | RelatedArtifact
Is Modifier | false
Must Support | true
Summary | false
Requirements | Plan definitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `PlanDefinition.relatedArtifact`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ type
72. PlanDefinition.relatedArtifact:InputDocumentExpected
Slice Name | InputDocumentExpected
Definition | Document that needs to be provided alongside the order for the laboratory service Related artifacts such as additional documentation, justification, or bibliographic references.
Short | Input document expected by the laboratory serviceAdditional documentation, citations
Comments | Examples of documents that should accompany an order for this service include patient consent for genetic testing, patient agreement for payment of a non-reimbursable service, insurance formal acceptation of a specific test (e.g. prenatal karyotyping) ... Each related artifact is either an attachment, or a reference to another resource, but not both.
Control | 0..*
Type | RelatedArtifact
Is Modifier | false
Must Support | true
Summary | false
Requirements | Plan definitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
74. PlanDefinition.relatedArtifact:InputDocumentExpected.type
Definition | The type of relationship to the related artifact.
Short | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Comments | The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet.
Control | 1..1
Binding | The codes SHALL be taken from RelatedArtifactType http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0 (required to `http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0` ) The type of relationship to the related artifact.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Pattern Value | `depends-on`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
76. PlanDefinition.relatedArtifact:InputDocumentExpected.label
Definition | Various kinds (or models) of documents may be expected as input to a laboratory service. This element provides an unambiguous short name for such a kind of document. A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.
Short | Name of the kind of document expectedShort label
Comments | Examples of kinds of documents expected include: the paper lab order scanned the statement of acceptation of the service by the insurance provider (e.g. for a prenatal karyotyping) the patient consent (e.g. for a genetic test) the patient insurance affiliation scanned
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Label | Kind of document
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
78. PlanDefinition.relatedArtifact:InputDocumentExpected.display
Definition | A brief description of the document that need to be provided alongside the order of this laboratory service A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.
Short | Brief description of the related artifact
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
80. PlanDefinition.relatedArtifact:InputDocumentExpected.document
Definition | provides in the attachment a model for the kind of document expected The document being referenced, represented as an attachment. This is exclusive with the resource element.
Short | Document modelWhat document is being referenced
Comments | The model can be encoded in base64 in the data sub-element, with its mime type encoded in the contentType sub-element, or it can be external, accessible through the url sub-element.
Control | 0..1
Type | Attachment
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
82. PlanDefinition.relatedArtifact:InputDocumentExpected.document.url
Definition | used if the model of document is accessible externally A location where the data can be accessed.
Short | url of the model of document expectedUri where the data can be found
Comments | If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.
Control | 0..1
Type | url
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | The data needs to be transmitted by reference.
Example | General: http://www.acme.com/logo-small.png
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
84. PlanDefinition.relatedArtifact:InputDocumentExpected.document.title
Definition | May be sufficient to specify the document expected, in cases where no pre-defined needs to be communicated to the orderer of the service. A label or set of text to display in place of the data.
Short | Title of the kind or model of documentLabel to display in place of the data
Comments | May sometimes be derived from the source filename.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.
Example | General: Official Corporate Logo
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
86. PlanDefinition.relatedArtifact:IsReplacedBy
Slice Name | IsReplacedBy
Definition | The related artifact is another instance of PlanDefinition, which is a replacement for the current no longer usable laboratory service Related artifacts such as additional documentation, justification, or bibliographic references.
Short | Reference to a service replacing the current non-usable oneAdditional documentation, citations
Comments | Each related artifact is either an attachment, or a reference to another resource, but not both.
Control | 0..*
Type | RelatedArtifact
Is Modifier | false
Must Support | true
Summary | false
Requirements | Plan definitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
88. PlanDefinition.relatedArtifact:IsReplacedBy.type
Definition | The type of relationship to the related artifact is successor, meaning that the related artifact is in this case another instance of PlanDefinition representing the laboratory service, which is substituted to the current instance. The type of relationship to the related artifact.
Short | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Comments | The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet.
Control | 1..1
Binding | The codes SHALL be taken from RelatedArtifactType http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0 (required to `http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0` ) The type of relationship to the related artifact.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Pattern Value | `successor`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
90. PlanDefinition.relatedArtifact:IsReplacedBy.resource
Definition | The related resource, in this case a PlanDefinition constrained by the LabServiceDefinition profile The related artifact, such as a library, value set, profile, or other knowledge resource.
Short | What artifact is being referenced
Comments | If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource.
Control | 10..1
Type | canonical(Laboratory Service Definition, Resource)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
92. PlanDefinition.relatedArtifact:Includes
Slice Name | Includes
Definition | The related artifact is another instance of PlanDefinition, representing a laboratory service orderable on its own, and which is also part of the current one, either systematically or reflexed by a trigger. Related artifacts such as additional documentation, justification, or bibliographic references.
Short | Reference to a panel or test included by the current oneAdditional documentation, citations
Comments | Each related artifact is either an attachment, or a reference to another resource, but not both.
Control | 0..*
Type | RelatedArtifact
Is Modifier | false
Must Support | true
Summary | false
Requirements | Plan definitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
94. PlanDefinition.relatedArtifact:Includes.type
Definition | The type of relationship to the related artifact is composed-of, meaning that the related artifact is another standalone laboratory service, which is also included as a sub-service of the current one. The type of relationship to the related artifact.
Short | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Comments | The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet.
Control | 1..1
Binding | The codes SHALL be taken from RelatedArtifactType http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0 (required to `http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0` ) The type of relationship to the related artifact.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Pattern Value | `composed-of`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
96. PlanDefinition.relatedArtifact:Includes.resource
Definition | The related resource, in this case a PlanDefinition constrained by the LabServiceDefinition profile The related artifact, such as a library, value set, profile, or other knowledge resource.
Short | What artifact is being referenced
Comments | If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource.
Control | 10..1
Type | canonical(Laboratory Service Definition, Resource)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
98. PlanDefinition.relatedArtifact:Bibliography
Slice Name | Bibliography
Definition | Related bibliographic references such as documentation, justification, or citation. Related artifacts such as additional documentation, justification, or bibliographic references.
Short | Additional documentation, citation or justificationAdditional documentation, citations
Comments | Each related artifact is either an attachment, or a reference to another resource, but not both.
Control | 0..*
Type | RelatedArtifact
Is Modifier | false
Must Support | true
Summary | false
Requirements | Plan definitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
100. PlanDefinition.relatedArtifact:Bibliography.type
Definition | kind of associated bibliographic artifact The type of relationship to the related artifact.
Short | documentation | justification | citationdocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Comments | The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet.
Control | 1..1
Binding | The codes SHALL be taken from Types of bibliographic artifacts http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0 (required to `http://hl7.org/fhir/uv/order-catalog/ValueSet/bibliography-artifact-type` )
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
102. PlanDefinition.action
Definition | The concrete action or group of actions conveyed by this laboratory diagnostic service An action or group of actions to be taken as part of the plan. For example, in clinical care, an action would be to prescribe a particular indicated medication, or perform a particular test as appropriate. In pharmaceutical quality, an action would be the test that needs to be performed on a drug product as defined in the quality specification.
Short | Action defined by the plan
Comments | The LabServiceDefinition profile constrains the content of PlanDefinition to be a single action at the top level. This action may be implemented by a single laboratory procedure referenced as an instance of ActivityDefinition, or may be decomposed into any level of logical groups of more granular actions, each leaf action referencing an ActivityDefinition. Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.
Control | 10..1* This element is affected by the following invariants: pld-3, pld-4
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
104. PlanDefinition.action.extension
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | ExtensionAdditional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `PlanDefinition.action.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
106. PlanDefinition.action.extension:SpecimenRequested
Slice Name | SpecimenRequested
Definition | A set of specimens requested as input by this laboratory service. The set is organized as a collection of one or more alternative groups (exactly one group should be chosen at specimen collection time). Each group describes one or more specimens that must all be provided, in case this group is the one chosen.
Short | Specimens required for this action
Comments | In case this element has multiple occurrence, all occurrences apply: Each set of specimen requirements represented by an occurrence of action.extension:SpecimenRequested must be fulfilled for the service described by the PlanDefinition instance.
Control | 0..*
Type | Extension(Specimens requested by a laboratory service) (Complex Extension)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
108. PlanDefinition.action.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
110. PlanDefinition.action.description
Definition | A brief description of the laboratory service, which may mention the analytical method(s) used by the laboratory A brief description of the action used to provide a summary to display to the user.
Short | Brief description of the laboratory service and its methodBrief description of the action
Control | 0..1
Type | markdown
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
112. PlanDefinition.action.priority
Definition | Indicates how quickly this diagnostic panel or test should be performed. Indicates how quickly the action should be addressed with respect to other actions.
Short | routine | urgent | asap | stat
Control | 0..1
Binding | The codes SHALL be taken from RequestPriority http://hl7.org/fhir/ValueSet/request-priority|5.0.0 (required to `http://hl7.org/fhir/ValueSet/request-priority|5.0.0` ) Identifies the level of importance to be assigned to actioning the request.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
114. PlanDefinition.action.code
Definition | A code that provides meaning to the laboratory service A code that provides a meaning, grouping, or classification for the action or action group. For example, a section may have a LOINC code for the section of a documentation template. In pharmaceutical quality, an action (Test) such as pH could be classified as a physical property.
Short | Code of the laboratory serviceCode representing the meaning of the action or sub-actions
Control | 0..1
Binding | For example codes, see ActionCode http://hl7.org/fhir/ValueSet/action-code|5.0.0 (example to `http://hl7.org/fhir/ValueSet/action-code|5.0.0` ) Provides examples of actions to be performed.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
116. PlanDefinition.action.code.coding
Definition | A reference to a code defined by a terminology system.
Short | Code for the laboratory serviceCode defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..*
Type | Coding
Is Modifier | false
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `PlanDefinition.action.code.coding`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ system
118. PlanDefinition.action.code.coding:orderCodeLOINC
Slice Name | orderCodeLOINC
Definition | A reference to a code defined by a terminology system.
Short | LOINC code for the laboratory serviceCode defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..1*
Type | Coding
Is Modifier | false
Must Support | true
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
120. PlanDefinition.action.code.coding:orderCodeLOINC.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | LOINC code systemIdentity 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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Control | 0..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Label | LOINC
Pattern Value | `http://loinc.org`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
122. PlanDefinition.action.trigger
Definition | A description of when the action should be triggered. When multiple triggers are specified on an action, any triggering event invokes the action.
Short | When the action should be triggered
Control | 0..*
Type | TriggerDefinition
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `PlanDefinition.action.trigger`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ type
124. PlanDefinition.action.trigger:Reflex
Slice Name | Reflex
Definition | This trigger introduces a reflex laboratory procedure (test or panel) represended by the ActivityDefinition referenced by the action.definition. The trigger is expressed as a named event, and may also be refined with a data requirement and a condition. A description of when the action should be triggered. When multiple triggers are specified on an action, any triggering event invokes the action.
Short | Reflex laboratory procedureWhen the action should be triggered
Control | 0..*
Type | TriggerDefinition
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
126. PlanDefinition.action.trigger:Reflex.type
Definition | The type of triggering event.
Short | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Control | 1..1 This element is affected by the following invariants: trd-3
Binding | The codes SHALL be taken from TriggerType http://hl7.org/fhir/ValueSet/trigger-type|5.0.0 (required to `http://hl7.org/fhir/ValueSet/trigger-type|5.0.0` ) The type of trigger.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Pattern Value | `named-event`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
128. PlanDefinition.action.trigger:Reflex.name
Definition | The natural language expression of the trigger for the reflex laboratory procedure A formal name for the event. This may be an absolute URI that identifies the event formally (e.g. from a trigger registry), or a simple relative URI that identifies the event in a local context.
Short | Name or URI that identifies the event
Comments | An event name can be provided for all event types, but is required for named events. If a name is provided for a type other than named events, it is considered to be a shorthand for the semantics described by the formal description of the event.
Control | 10..1 This element is affected by the following invariants: trd-3
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
130. PlanDefinition.action.trigger:Reflex.timing[x]
Definition | The timing of the event (if this is a periodic trigger).
Short | Timing of the event
Control | 0..1 This element is affected by the following invariants: trd-3, trd-1
Type | Choice of: Timing, Reference(Schedule), date, dateTime
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
132. PlanDefinition.action.trigger:Reflex.data
Definition | The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.
Short | Triggering data of the event (multiple = 'and')
Comments | This element shall be present for any data type trigger.
Control | 0..* This element is affected by the following invariants: trd-3, trd-2, trd-1
Type | DataRequirement
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
134. 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 http://hl7.org/fhir/ValueSet/action-grouping-behavior|5.0.0 (required to `http://hl7.org/fhir/ValueSet/action-grouping-behavior|5.0.0` ) Defines organization behavior of a group.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Meaning if Missing | If no grouping behavior is specified but the action has children (i.e. is a group), the grouping behavior is assumed to be `logical-group`.
Pattern Value | `logical-group`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
136. PlanDefinition.action.definition[x]
Definition | A reference to an ActivityDefinition that describes the laboratory procedure to be performed, or to a PlanDefinition representing a child laboratory service, either embedded or reflexed by the current one. A reference to an ActivityDefinition that describes the action to be taken in detail, a MessageDefinition describing a message to be snet, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured.
Short | Description of the activity to be performed
Comments | The definition is present only when there is no grouping of sub-actions Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically.
Control | 0..1
Type | canonical(Laboratory Procedure Definition, ActivityDefinition, MessageDefinition, ObservationDefinition, PlanDefinition, Questionnaire, SpecimenDefinition), uri
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be foundhere

0. PlanDefinition
Short | The definition of a plan for a series of actions
Comments | The LabServiceDefinition profile constrains the resource PlanDefinition to represent a laboratory diagnostic service made visible to clinicians: the potential consumers of this service.
2. PlanDefinition.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: value @ url
4. PlanDefinition.extension:CatalogReference
Slice Name | CatalogReference
Short | Reference to a catalog exposing this service
Type | Extension(Reference to a catalog) (Extension Type: Reference(Catalog Header))
6. PlanDefinition.extension:ServiceBillingCode
Slice Name | ServiceBillingCode
Short | A billing code associated with the service
Type | Extension(Healthcare Service Billing Code) (Extension Type: Choice of: CodeableConcept, Reference)
8. PlanDefinition.extension:BillingSummary
Slice Name | BillingSummary
Short | Textual summary of billing applied to the service
Type | Extension(Billing summary for the plan definition) (Complex Extension)
10. PlanDefinition.extension:ScheduleSummary
Slice Name | ScheduleSummary
Short | Textual summary of the schedule of the service
Type | Extension(Schedule summary for the plan definition) (Extension Type: string)
12. PlanDefinition.extension:LimitationSummary
Slice Name | LimitationSummary
Short | Textual summary of limitations associated with the service
Type | Extension(Limitation summary for the plan definition) (Extension Type: string)
14. PlanDefinition.extension:RegulatorySummary
Slice Name | RegulatorySummary
Short | Textual summary of regulations applicable to this service
Type | Extension(Summary of regulations applicable to the laboratory service) (Extension Type: string)
16. PlanDefinition.extension:ResultInterpretationSummary
Slice Name | ResultInterpretationSummary
Short | markdown summary of result interpretation guidance for this service
Type | Extension(Summary of result interpretation guidance of the laboratory service) (Extension Type: markdown)
18. PlanDefinition.title
20. PlanDefinition.title.extension
Slicing | This element introduces a set of slices on `PlanDefinition.title.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
22. PlanDefinition.title.extension:OtherTitle
Slice Name | OtherTitle
Definition | Expresses a synonym of the laboratory service in a specified language
Short | Synonym in a specified language
Type | Extension(Translation) (Complex Extension)
24. PlanDefinition.type
Short | panel | test
Comments | In this LabServiceDefiniton profile, PlanDefinition represents a laboratory service, which can be either a test or a panel. A test is a single measurement performed on a material/digital specimen, producing generally one result (sometimes zero, sometime more). A panel is a collection of tests and panels, performed on one or more material/digital specimens, and producing a collection of results. Therefore, the type is bound to a value set {"test", "panel"}. The original value bound to this element with binding strength "extensible" does not contain appropriate values for laboratory diagnostic services.
Binding | Unless not suitable, these codes SHALL be taken from Types of diagnostic services performed by a laboratory (extensible to `http://hl7.org/fhir/uv/order-catalog/ValueSet/laboratory-service-type` )
Must Support | true
26. PlanDefinition.description
Comments | This description provides details such as when this laboratory diagnostic service can be ordered, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the plan definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the plan definition is presumed to be the predominant language in the place the plan definition was created).
28. PlanDefinition.description.extension
Slicing | This element introduces a set of slices on `PlanDefinition.description.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
30. PlanDefinition.description.extension:OtherDescription
Slice Name | OtherDescription
Definition | Translation of the description of the laboratory service in a specified language
Short | Translation in a specified language
Type | Extension(Translation) (Complex Extension)
32. PlanDefinition.useContext
Comments | When multiple useContexts are specified, in this LabServiceDefinition profile, all contexts apply to the defined laboratory service.
Must Support | true
Slicing | This element introduces a set of slices on `PlanDefinition.useContext`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ code type @ value value @ value
34. PlanDefinition.useContext:Orderable
Slice Name | Orderable
Definition | The presence of this slice indicates that the service is open to laboratory order entry
Short | Service is orderable
Control | 0..1
Must Support | true
Label | orderable
36. PlanDefinition.useContext:Orderable.code
Pattern Value | `{ "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type", "code" : "task" }`
38. PlanDefinition.useContext:Orderable.value[x]
Type | CodeableConcept
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Pattern Value | `{ "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode", "code" : "LABOE" }] }`
40. PlanDefinition.useContext:PathologistInitiative
Slice Name | PathologistInitiative
Definition | The presence of this slice indicates that the service may be added to an existing order by the pathologist after review of the preliminary results of this order
Short | Service may be added by pathologist
Control | 0..1
Must Support | true
Label | pathologist
42. PlanDefinition.useContext:PathologistInitiative.code
Pattern Value | `{ "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type", "code" : "task" }`
44. PlanDefinition.useContext:PathologistInitiative.value[x]
Type | CodeableConcept
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Pattern Value | `{ "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode", "code" : "LABRREV" }] }`
46. PlanDefinition.useContext:OneGender
Slice Name | OneGender
Definition | The presence of this slice indicates that the service is restricted to one gender of subject (female or male)
Short | service restricted to one gender
Control | 0..1
Must Support | true
48. PlanDefinition.useContext:OneGender.code
Pattern Value | `{ "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type", "code" : "gender" }`
50. PlanDefinition.useContext:OneGender.value[x]
Binding | The codes SHALL be taken from AdministrativeGender (required to `http://hl7.org/fhir/ValueSet/administrative-gender` )
Type | CodeableConcept
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
52. PlanDefinition.useContext:StoreSpecimen
Slice Name | StoreSpecimen
Definition | The presence of this slice indicates that the specimens used to perform this service will be kept in long-time storage and available for re-testing in the future
Short | Specimens to be kept
Control | 0..1
Must Support | true
54. PlanDefinition.useContext:StoreSpecimen.code
Pattern Value | `{ "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type", "code" : "task" }`
56. PlanDefinition.useContext:StoreSpecimen.value[x]
Type | CodeableConcept
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Pattern Value | `{ "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode", "code" : "SSTOR" }] }`
58. PlanDefinition.useContext:AgeRange
Slice Name | AgeRange
Short | A patient age range applicable for this service
Must Support | true
60. PlanDefinition.useContext:AgeRange.code
Pattern Value | `{ "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type", "code" : "age" }`
62. PlanDefinition.useContext:AgeRange.value[x]
Short | patient age range applicable for this service
Type | Range
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
64. PlanDefinition.usage
Definition | A detailed description of how the laboratory diagnostic service is used from a clinical perspective.
Short | Describes the clinical usage of the laboratory diagnostic service
Must Support | true
66. PlanDefinition.topic
Definition | Descriptive topics related to the content of the laboratory service definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching. Some possible axes of categorization include laboratory specialty, kind of pathology, kind of biologic specimen tested, ...
Short | categorization of the laboratory service
Comments | Topics are usually chosen by the laboratory or the organization owning the catalog
Must Support | true
68. PlanDefinition.relatedArtifact
Must Support | true
Slicing | This element introduces a set of slices on `PlanDefinition.relatedArtifact`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ type
70. PlanDefinition.relatedArtifact:InputDocumentExpected
Slice Name | InputDocumentExpected
Definition | Document that needs to be provided alongside the order for the laboratory service
Short | Input document expected by the laboratory service
Comments | Examples of documents that should accompany an order for this service include patient consent for genetic testing, patient agreement for payment of a non-reimbursable service, insurance formal acceptation of a specific test (e.g. prenatal karyotyping) ...
Must Support | true
72. PlanDefinition.relatedArtifact:InputDocumentExpected.type
Pattern Value | `depends-on`
74. PlanDefinition.relatedArtifact:InputDocumentExpected.label
Definition | Various kinds (or models) of documents may be expected as input to a laboratory service. This element provides an unambiguous short name for such a kind of document.
Short | Name of the kind of document expected
Comments | Examples of kinds of documents expected include: the paper lab order scanned the statement of acceptation of the service by the insurance provider (e.g. for a prenatal karyotyping) the patient consent (e.g. for a genetic test) the patient insurance affiliation scanned
Control | 1..?
Label | Kind of document
76. PlanDefinition.relatedArtifact:InputDocumentExpected.display
Definition | A brief description of the document that need to be provided alongside the order of this laboratory service
Control | 1..?
78. PlanDefinition.relatedArtifact:InputDocumentExpected.document
Definition | provides in the attachment a model for the kind of document expected
Short | Document model
Comments | The model can be encoded in base64 in the data sub-element, with its mime type encoded in the contentType sub-element, or it can be external, accessible through the url sub-element.
80. PlanDefinition.relatedArtifact:InputDocumentExpected.document.url
Definition | used if the model of document is accessible externally
Short | url of the model of document expected
82. PlanDefinition.relatedArtifact:InputDocumentExpected.document.title
Definition | May be sufficient to specify the document expected, in cases where no pre-defined needs to be communicated to the orderer of the service.
Short | Title of the kind or model of document
84. PlanDefinition.relatedArtifact:IsReplacedBy
Slice Name | IsReplacedBy
Definition | The related artifact is another instance of PlanDefinition, which is a replacement for the current no longer usable laboratory service
Short | Reference to a service replacing the current non-usable one
Must Support | true
86. PlanDefinition.relatedArtifact:IsReplacedBy.type
Definition | The type of relationship to the related artifact is successor, meaning that the related artifact is in this case another instance of PlanDefinition representing the laboratory service, which is substituted to the current instance.
Pattern Value | `successor`
88. PlanDefinition.relatedArtifact:IsReplacedBy.resource
Definition | The related resource, in this case a PlanDefinition constrained by the LabServiceDefinition profile
Control | 1..?
Type | canonical(Laboratory Service Definition)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
90. PlanDefinition.relatedArtifact:Includes
Slice Name | Includes
Definition | The related artifact is another instance of PlanDefinition, representing a laboratory service orderable on its own, and which is also part of the current one, either systematically or reflexed by a trigger.
Short | Reference to a panel or test included by the current one
Must Support | true
92. PlanDefinition.relatedArtifact:Includes.type
Definition | The type of relationship to the related artifact is composed-of, meaning that the related artifact is another standalone laboratory service, which is also included as a sub-service of the current one.
Pattern Value | `composed-of`
94. PlanDefinition.relatedArtifact:Includes.resource
Definition | The related resource, in this case a PlanDefinition constrained by the LabServiceDefinition profile
Control | 1..?
Type | canonical(Laboratory Service Definition)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
96. PlanDefinition.relatedArtifact:Bibliography
Slice Name | Bibliography
Definition | Related bibliographic references such as documentation, justification, or citation.
Short | Additional documentation, citation or justification
Must Support | true
98. PlanDefinition.relatedArtifact:Bibliography.type
Definition | kind of associated bibliographic artifact
Short | documentation | justification | citation
Binding | The codes SHALL be taken from Types of bibliographic artifacts (required to `http://hl7.org/fhir/uv/order-catalog/ValueSet/bibliography-artifact-type` )
100. PlanDefinition.action
Definition | The concrete action or group of actions conveyed by this laboratory diagnostic service
Comments | The LabServiceDefinition profile constrains the content of PlanDefinition to be a single action at the top level. This action may be implemented by a single laboratory procedure referenced as an instance of ActivityDefinition, or may be decomposed into any level of logical groups of more granular actions, each leaf action referencing an ActivityDefinition.
Control | 1..1
102. PlanDefinition.action.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: value @ url
104. PlanDefinition.action.extension:SpecimenRequested
Slice Name | SpecimenRequested
Definition | A set of specimens requested as input by this laboratory service. The set is organized as a collection of one or more alternative groups (exactly one group should be chosen at specimen collection time). Each group describes one or more specimens that must all be provided, in case this group is the one chosen.
Short | Specimens required for this action
Comments | In case this element has multiple occurrence, all occurrences apply: Each set of specimen requirements represented by an occurrence of action.extension:SpecimenRequested must be fulfilled for the service described by the PlanDefinition instance.
Type | Extension(Specimens requested by a laboratory service) (Complex Extension)
106. PlanDefinition.action.description
Definition | A brief description of the laboratory service, which may mention the analytical method(s) used by the laboratory
Short | Brief description of the laboratory service and its method
108. PlanDefinition.action.priority
Definition | Indicates how quickly this diagnostic panel or test should be performed.
110. PlanDefinition.action.code
Definition | A code that provides meaning to the laboratory service
Short | Code of the laboratory service
Control | 0..1
Must Support | true
112. PlanDefinition.action.code.coding
Short | Code for the laboratory service
Slicing | This element introduces a set of slices on `PlanDefinition.action.code.coding`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ system
114. PlanDefinition.action.code.coding:orderCodeLOINC
Slice Name | orderCodeLOINC
Short | LOINC code for the laboratory service
Control | 0..1
Must Support | true
116. PlanDefinition.action.code.coding:orderCodeLOINC.system
Short | LOINC code system
Must Support | true
Label | LOINC
Pattern Value | `http://loinc.org`
118. PlanDefinition.action.trigger
Must Support | true
Slicing | This element introduces a set of slices on `PlanDefinition.action.trigger`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ type
120. PlanDefinition.action.trigger:Reflex
Slice Name | Reflex
Definition | This trigger introduces a reflex laboratory procedure (test or panel) represended by the ActivityDefinition referenced by the action.definition. The trigger is expressed as a named event, and may also be refined with a data requirement and a condition.
Short | Reflex laboratory procedure
Must Support | true
122. PlanDefinition.action.trigger:Reflex.type
Pattern Value | `named-event`
124. PlanDefinition.action.trigger:Reflex.name
Definition | The natural language expression of the trigger for the reflex laboratory procedure
Control | 1..?
126. PlanDefinition.action.groupingBehavior
Pattern Value | `logical-group`
128. PlanDefinition.action.definition[x]
Definition | A reference to an ActivityDefinition that describes the laboratory procedure to be performed, or to a PlanDefinition representing a child laboratory service, either embedded or reflexed by the current one.
Comments | The definition is present only when there is no grouping of sub-actions
Type | canonical(Laboratory Procedure Definition), uri
[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
Must Support | true

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 and non-clinical artifacts such as clinical decision support rules, order sets, protocols, and drug quality specifications.
Short | The definition of a plan for a series of actions
Comments | The LabServiceDefinition profile constrains the resource PlanDefinition to represent a laboratory diagnostic service made visible to clinicians: the potential consumers of this service.
Control | 0..*
Is Modifier | false
Must Support | false
Summary | false
Invariants | cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (`name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')`) pld-3: goalid should reference the id of a goal definition (`%context.repeat(action).where((goalId in %context.goal.id).not()).exists().not()`) pld-4: targetId should reference the id of an action (`%context.repeat(action).relatedAction.where((targetId in %context.repeat(action).id).not()).exists().not()`)
2. PlanDefinition.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short | Logical id of this artifact
Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.
Control | 0..1
Type | id
Is Modifier | false
Must Support | false
Summary | true
4. PlanDefinition.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Short | Metadata about the resource
Control | 0..1
Type | Meta
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
6. PlanDefinition.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.
Control | 0..1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
8. PlanDefinition.language
Definition | The base language in which the resource is written.
Short | Language of the resource content
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Control | 0..1
Binding | The codes SHALL be taken from AllLanguages (required to `http://hl7.org/fhir/ValueSet/all-languages|5.0.0` ) IETF language tag for a human language
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
10. PlanDefinition.text
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Short | Text summary of the resource, for human interpretation
Comments | Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Control | 0..1 This element is affected by the following invariants: dom-6
Type | Narrative
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | narrative, html, xhtml, display
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
12. PlanDefinition.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.
Short | Contained, inline Resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.
Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
Type | Resource
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
14. PlanDefinition.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PlanDefinition.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
16. PlanDefinition.extension:CatalogReference
Slice Name | CatalogReference
Definition | This extension to PlanDefinition, MedicationKnowledge and DeviceDefinition conveys the reference to a catalog containing the extended resource
Short | Reference to a catalog exposing this service
Control | 0..*
Type | Extension(Reference to a catalog) (Extension Type: Reference(Catalog Header))
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
18. PlanDefinition.extension:ServiceBillingCode
Slice Name | ServiceBillingCode
Definition | Optional Extension Element - found in all resources.
Short | A billing code associated with the service
Control | 0..*
Type | Extension(Healthcare Service Billing Code) (Extension Type: Choice of: CodeableConcept, Reference)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
20. PlanDefinition.extension:BillingSummary
Slice Name | BillingSummary
Definition | An Extension
Short | Textual summary of billing applied to the service
Control | 0..1
Type | Extension(Billing summary for the plan definition) (Complex Extension)
Is Modifier | false
Must Support | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
22. PlanDefinition.extension:ScheduleSummary
Slice Name | ScheduleSummary
Definition | An Extension
Short | Textual summary of the schedule of the service
Control | 0..1
Type | Extension(Schedule summary for the plan definition) (Extension Type: string)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
24. PlanDefinition.extension:LimitationSummary
Slice Name | LimitationSummary
Definition | An Extension
Short | Textual summary of limitations associated with the service
Control | 0..1
Type | Extension(Limitation summary for the plan definition) (Extension Type: string)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
26. PlanDefinition.extension:RegulatorySummary
Slice Name | RegulatorySummary
Definition | An Extension
Short | Textual summary of regulations applicable to this service
Control | 0..1
Type | Extension(Summary of regulations applicable to the laboratory service) (Extension Type: string)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
28. PlanDefinition.extension:ResultInterpretationSummary
Slice Name | ResultInterpretationSummary
Definition | An Extension
Short | markdown summary of result interpretation guidance for this service
Control | 0..1
Type | Extension(Summary of result interpretation guidance of the laboratory service) (Extension Type: markdown)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
30. PlanDefinition.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Support | false
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
32. PlanDefinition.url
Definition | An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different servers.
Short | Canonical identifier for this plan definition, represented as a URI (globally unique)
Comments | Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.
Control | 0..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Requirements | Allows the plan definition to be referenced by a single globally unique identifier.
Invariants | cnl-1: URL should not contain | or # - these characters make processing canonical references problematic (`exists() implies matches('^[^|# ]+$')`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
34. PlanDefinition.identifier
Definition | A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
Short | Additional identifier for the plan definition
Comments | Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this plan definition outside of FHIR, where it is not possible to use the logical URI.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Is Modifier | false
Must Support | false
Summary | true
Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
36. PlanDefinition.version
Definition | The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.
Short | Business version of the plan definition
Comments | There may be different plan definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the plan definition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version.
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
38. PlanDefinition.versionAlgorithm[x]
Definition | Indicates the mechanism used to compare versions to determine which is more current.
Short | How to compare versions
Comments | If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from VersionAlgorithm (extensible to `http://hl7.org/fhir/ValueSet/version-algorithm|5.0.0` )
Type | Choice of: string, Coding
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
40. PlanDefinition.name
Definition | A natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
Short | Name for this plan definition (computer friendly)
Comments | The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
Control | 0..1 This element is affected by the following invariants: cnl-0
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Requirements | Support human navigation and code generation.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
42. PlanDefinition.title
Definition | A short, descriptive, user-friendly title for the plan definition.
Short | Name for this plan definition (human friendly)
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
44. PlanDefinition.title.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
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
46. PlanDefinition.title.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PlanDefinition.title.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
48. PlanDefinition.title.extension:OtherTitle
Slice Name | OtherTitle
Definition | Expresses a synonym of the laboratory service in a specified language
Short | Synonym in a specified language
Control | 0..*
Type | Extension(Translation) (Complex Extension)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
50. PlanDefinition.title.value
Definition | The actual value
Short | Primitive value for string
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Max Length: | 1048576
52. PlanDefinition.subtitle
Definition | An explanatory or alternate title for the plan definition giving additional information about its content.
Short | Subordinate title of the plan definition
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
54. PlanDefinition.type
Definition | A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.
Short | panel | test
Comments | In this LabServiceDefiniton profile, PlanDefinition represents a laboratory service, which can be either a test or a panel. A test is a single measurement performed on a material/digital specimen, producing generally one result (sometimes zero, sometime more). A panel is a collection of tests and panels, performed on one or more material/digital specimens, and producing a collection of results. Therefore, the type is bound to a value set {"test", "panel"}. The original value bound to this element with binding strength "extensible" does not contain appropriate values for laboratory diagnostic services.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from Types of diagnostic services performed by a laboratory (extensible to `http://hl7.org/fhir/uv/order-catalog/ValueSet/laboratory-service-type` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
56. PlanDefinition.status
Definition | The status of this plan definition. Enables tracking the life-cycle of the content.
Short | draft | active | retired | unknown
Comments | Allows filtering of plan definitions that are appropriate for use versus not. See guidance around (not) making local changes to elements here.
Control | 1..1
Binding | The codes SHALL be taken from PublicationStatus (required to `http://hl7.org/fhir/ValueSet/publication-status|5.0.0` ) The lifecycle status of an artifact.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
58. PlanDefinition.experimental
Definition | A Boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
Short | For testing purposes, not real usage
Comments | Allows filtering of plan definitions that are appropriate for use versus not.
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level plan definition.
Meaning if Missing | If absent, this resource is treated as though it is not experimental.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
60. PlanDefinition.subject[x]
Definition | A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.
Short | Type of individual the plan definition is focused on
Comments | Note that the choice of canonical for the subject element was introduced in R4B to support pharmaceutical quality use cases. To ensure as much backwards-compatibility as possible, it is recommended to only use the new canonical type with these use cases.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from ParticipantResourceTypes (extensible to `http://hl7.org/fhir/ValueSet/participant-resource-types|5.0.0` ) The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
Type | Choice of: CodeableConcept, Reference(Group, MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, PackagedProductDefinition), canonical(EvidenceVariable)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Meaning if Missing | Patient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
62. PlanDefinition.date
Definition | The date (and optionally time) when the plan definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changes.
Short | Date last changed
Comments | The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the plan definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. See guidance around (not) making local changes to elements here.
Control | 0..1
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Alternate Names | Revision Date
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
64. PlanDefinition.publisher
Definition | The name of the organization or individual responsible for the release and ongoing maintenance of the plan definition.
Short | Name of the publisher/steward (organization or individual)
Comments | Usually an organization but may be an individual. The publisher (or steward) of the plan definition is the organization or individual primarily responsible for the maintenance and upkeep of the plan definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the plan definition. This item SHOULD be populated unless the information is available from context.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Requirements | Helps establish the "authority/credibility" of the plan definition. May also allow for contact.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
66. PlanDefinition.contact
Definition | Contact details to assist a user in finding and communicating with the publisher.
Short | Contact details for the publisher
Comments | May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements here.
Control | 0..*
Type | ContactDetail
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
68. 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 provides details such as when this laboratory diagnostic service can be ordered, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the plan definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the plan definition is presumed to be the predominant language in the place the plan definition was created).
Control | 0..1
Type | markdown
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
70. PlanDefinition.description.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
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
72. PlanDefinition.description.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PlanDefinition.description.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
74. PlanDefinition.description.extension:OtherDescription
Slice Name | OtherDescription
Definition | Translation of the description of the laboratory service in a specified language
Short | Translation in a specified language
Control | 0..*
Type | Extension(Translation) (Complex Extension)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
76. PlanDefinition.description.value
Definition | Primitive value for markdown
Short | Primitive value for markdown
Control | 0..1
Type | markdown
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
78. PlanDefinition.useContext
Definition | The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances.
Short | The context that the content is intended to support
Comments | When multiple useContexts are specified, in this LabServiceDefinition profile, all contexts apply to the defined laboratory service.
Control | 0..*
Type | UsageContext
Is Modifier | false
Must Support | true
Summary | true
Requirements | Assist in searching for appropriate content.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `PlanDefinition.useContext`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ code type @ value value @ value
80. PlanDefinition.useContext:Orderable
Slice Name | Orderable
Definition | The presence of this slice indicates that the service is open to laboratory order entry
Short | Service is orderable
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
Control | 0..1
Type | UsageContext
Is Modifier | false
Must Support | true
Summary | true
Requirements | Assist in searching for appropriate content.
Label | orderable
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
82. PlanDefinition.useContext:Orderable.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | id
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
84. PlanDefinition.useContext:Orderable.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PlanDefinition.useContext.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
86. PlanDefinition.useContext:Orderable.code
Definition | A code that identifies the type of context being specified by this usage context.
Short | Type of context being specified
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from UsageContextType (extensible to `http://terminology.hl7.org/ValueSet/usage-context-type` ) A code that specifies a type of context being specified by a usage context.
Type | Coding
Is Modifier | false
Summary | true
Pattern Value | `{ "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type", "code" : "task" }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
88. PlanDefinition.useContext:Orderable.value[x]
Definition | A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.
Short | Value that defines the context
Control | 1..1
Binding | For example codes, see ContextOfUseValueSet (example to `http://hl7.org/fhir/ValueSet/use-context|5.0.0` ) A code that defines the specific value for the context being specified.
Type | CodeableConcept
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
Pattern Value | `{ "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode", "code" : "LABOE" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
90. PlanDefinition.useContext:PathologistInitiative
Slice Name | PathologistInitiative
Definition | The presence of this slice indicates that the service may be added to an existing order by the pathologist after review of the preliminary results of this order
Short | Service may be added by pathologist
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
Control | 0..1
Type | UsageContext
Is Modifier | false
Must Support | true
Summary | true
Requirements | Assist in searching for appropriate content.
Label | pathologist
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
92. PlanDefinition.useContext:PathologistInitiative.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | id
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
94. PlanDefinition.useContext:PathologistInitiative.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PlanDefinition.useContext.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
96. PlanDefinition.useContext:PathologistInitiative.code
Definition | A code that identifies the type of context being specified by this usage context.
Short | Type of context being specified
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from UsageContextType (extensible to `http://terminology.hl7.org/ValueSet/usage-context-type` ) A code that specifies a type of context being specified by a usage context.
Type | Coding
Is Modifier | false
Summary | true
Pattern Value | `{ "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type", "code" : "task" }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
98. PlanDefinition.useContext:PathologistInitiative.value[x]
Definition | A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.
Short | Value that defines the context
Control | 1..1
Binding | For example codes, see ContextOfUseValueSet (example to `http://hl7.org/fhir/ValueSet/use-context|5.0.0` ) A code that defines the specific value for the context being specified.
Type | CodeableConcept
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
Pattern Value | `{ "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode", "code" : "LABRREV" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
100. PlanDefinition.useContext:OneGender
Slice Name | OneGender
Definition | The presence of this slice indicates that the service is restricted to one gender of subject (female or male)
Short | service restricted to one gender
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
Control | 0..1
Type | UsageContext
Is Modifier | false
Must Support | true
Summary | true
Requirements | Assist in searching for appropriate content.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
102. PlanDefinition.useContext:OneGender.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | id
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
104. PlanDefinition.useContext:OneGender.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PlanDefinition.useContext.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
106. PlanDefinition.useContext:OneGender.code
Definition | A code that identifies the type of context being specified by this usage context.
Short | Type of context being specified
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from UsageContextType (extensible to `http://terminology.hl7.org/ValueSet/usage-context-type` ) A code that specifies a type of context being specified by a usage context.
Type | Coding
Is Modifier | false
Summary | true
Pattern Value | `{ "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type", "code" : "gender" }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
108. PlanDefinition.useContext:OneGender.value[x]
Definition | A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.
Short | Value that defines the context
Control | 1..1
Binding | The codes SHALL be taken from AdministrativeGender (required to `http://hl7.org/fhir/ValueSet/administrative-gender` )
Type | CodeableConcept
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
110. PlanDefinition.useContext:StoreSpecimen
Slice Name | StoreSpecimen
Definition | The presence of this slice indicates that the specimens used to perform this service will be kept in long-time storage and available for re-testing in the future
Short | Specimens to be kept
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
Control | 0..1
Type | UsageContext
Is Modifier | false
Must Support | true
Summary | true
Requirements | Assist in searching for appropriate content.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
112. PlanDefinition.useContext:StoreSpecimen.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | id
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
114. PlanDefinition.useContext:StoreSpecimen.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PlanDefinition.useContext.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
116. PlanDefinition.useContext:StoreSpecimen.code
Definition | A code that identifies the type of context being specified by this usage context.
Short | Type of context being specified
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from UsageContextType (extensible to `http://terminology.hl7.org/ValueSet/usage-context-type` ) A code that specifies a type of context being specified by a usage context.
Type | Coding
Is Modifier | false
Summary | true
Pattern Value | `{ "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type", "code" : "task" }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
118. PlanDefinition.useContext:StoreSpecimen.value[x]
Definition | A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.
Short | Value that defines the context
Control | 1..1
Binding | For example codes, see ContextOfUseValueSet (example to `http://hl7.org/fhir/ValueSet/use-context|5.0.0` ) A code that defines the specific value for the context being specified.
Type | CodeableConcept
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
Pattern Value | `{ "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode", "code" : "SSTOR" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
120. PlanDefinition.useContext:AgeRange
Slice Name | AgeRange
Definition | The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances.
Short | A patient age range applicable for this service
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
Control | 0..*
Type | UsageContext
Is Modifier | false
Must Support | true
Summary | true
Requirements | Assist in searching for appropriate content.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
122. PlanDefinition.useContext:AgeRange.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | id
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
124. PlanDefinition.useContext:AgeRange.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PlanDefinition.useContext.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
126. PlanDefinition.useContext:AgeRange.code
Definition | A code that identifies the type of context being specified by this usage context.
Short | Type of context being specified
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from UsageContextType (extensible to `http://terminology.hl7.org/ValueSet/usage-context-type` ) A code that specifies a type of context being specified by a usage context.
Type | Coding
Is Modifier | false
Summary | true
Pattern Value | `{ "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type", "code" : "age" }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
128. PlanDefinition.useContext:AgeRange.value[x]
Definition | A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.
Short | patient age range applicable for this service
Control | 1..1
Binding | For example codes, see ContextOfUseValueSet (example to `http://hl7.org/fhir/ValueSet/use-context|5.0.0` ) A code that defines the specific value for the context being specified.
Type | Range
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
130. PlanDefinition.jurisdiction
Definition | A legal or geographic region in which the plan definition is intended to be used.
Short | Intended jurisdiction for plan definition (if applicable)
Comments | It may be possible for the plan definition to be used in jurisdictions other than those for which it was originally designed or intended. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)
Control | 0..*
Binding | Unless not suitable, these codes SHALL be taken from JurisdictionValueSet (extensible to `http://hl7.org/fhir/ValueSet/jurisdiction|5.0.0` ) Countries and regions within which this artifact is targeted for use.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
132. PlanDefinition.purpose
Definition | Explanation of why this plan definition is needed and why it has been designed as it has.
Short | Why this plan definition is defined
Comments | This element does not describe the usage of the plan definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this plan definition.
Control | 0..1
Type | markdown
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
134. PlanDefinition.usage
Definition | A detailed description of how the laboratory diagnostic service is used from a clinical perspective.
Short | Describes the clinical usage of the laboratory diagnostic service
Control | 0..1
Type | markdown
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
136. PlanDefinition.copyright
Definition | A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition.
Short | Use and/or publishing restrictions
Comments | The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.
Control | 0..1
Type | markdown
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Requirements | Consumers must be able to determine any legal restrictions on the use of the plan definition and/or its content.
Alternate Names | License, Restrictions
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
138. PlanDefinition.copyrightLabel
Definition | A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
Short | Copyright holder and year(s)
Comments | The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Requirements | Defines the content expected to be rendered in all representations of the artifact.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
140. PlanDefinition.approvalDate
Definition | The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
Short | When the plan definition was approved by publisher
Comments | The 'date' element may be more recent than the approval date because of minor changes or editorial corrections. See guidance around (not) making local changes to elements here.
Control | 0..1
Type | date
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
142. PlanDefinition.lastReviewDate
Definition | The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
Short | When the plan definition was last reviewed by the publisher
Comments | If specified, this date follows the original approval date. See guidance around (not) making local changes to elements here.
Control | 0..1
Type | date
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Requirements | Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
144. PlanDefinition.effectivePeriod
Definition | The period during which the plan definition content was or is planned to be in active use.
Short | When the plan definition is expected to be used
Comments | The effective period for a plan definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a plan definition intended to be used for the year 2016 might be published in 2015. See guidance around (not) making local changes to elements here.
Control | 0..1
Type | Period
Is Modifier | false
Must Support | false
Summary | true
Requirements | Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the plan definition are or are expected to be used instead.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
146. PlanDefinition.topic
Definition | Descriptive topics related to the content of the laboratory service definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching. Some possible axes of categorization include laboratory specialty, kind of pathology, kind of biologic specimen tested, ...
Short | categorization of the laboratory service
Comments | Topics are usually chosen by the laboratory or the organization owning the catalog
Control | 0..*
Binding | For example codes, see DefinitionTopic (example to `http://hl7.org/fhir/ValueSet/definition-topic|5.0.0` ) High-level categorization of the definition, used for searching, sorting, and filtering.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Repositories must be able to determine how to categorize the plan definition so that it can be found by topical searches.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
148. PlanDefinition.author
Definition | An individiual or organization primarily involved in the creation and maintenance of the content.
Short | Who authored the content
Control | 0..*
Type | ContactDetail
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
150. PlanDefinition.editor
Definition | An individual or organization primarily responsible for internal coherence of the content.
Short | Who edited the content
Control | 0..*
Type | ContactDetail
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
152. PlanDefinition.reviewer
Definition | An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content.
Short | Who reviewed the content
Comments | See guidance around (not) making local changes to elements here.
Control | 0..*
Type | ContactDetail
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
154. PlanDefinition.endorser
Definition | An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting.
Short | Who endorsed the content
Comments | See guidance around (not) making local changes to elements here.
Control | 0..*
Type | ContactDetail
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
156. PlanDefinition.relatedArtifact
Definition | Related artifacts such as additional documentation, justification, or bibliographic references.
Short | Additional documentation, citations
Comments | Each related artifact is either an attachment, or a reference to another resource, but not both.
Control | 0..*
Type | RelatedArtifact
Is Modifier | false
Must Support | true
Summary | false
Requirements | Plan definitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `PlanDefinition.relatedArtifact`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ type
158. PlanDefinition.relatedArtifact:InputDocumentExpected
Slice Name | InputDocumentExpected
Definition | Document that needs to be provided alongside the order for the laboratory service
Short | Input document expected by the laboratory service
Comments | Examples of documents that should accompany an order for this service include patient consent for genetic testing, patient agreement for payment of a non-reimbursable service, insurance formal acceptation of a specific test (e.g. prenatal karyotyping) ...
Control | 0..*
Type | RelatedArtifact
Is Modifier | false
Must Support | true
Summary | false
Requirements | Plan definitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
160. PlanDefinition.relatedArtifact:InputDocumentExpected.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | id
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
162. PlanDefinition.relatedArtifact:InputDocumentExpected.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PlanDefinition.relatedArtifact.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
164. PlanDefinition.relatedArtifact:InputDocumentExpected.type
Definition | The type of relationship to the related artifact.
Short | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Comments | The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet.
Control | 1..1
Binding | The codes SHALL be taken from RelatedArtifactType (required to `http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0` ) The type of relationship to the related artifact.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Pattern Value | `depends-on`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
166. PlanDefinition.relatedArtifact:InputDocumentExpected.classifier
Definition | Provides additional classifiers of the related artifact.
Short | Additional classifiers
Control | 0..*
Binding | For example codes, see CitationArtifactClassifier (example to `http://hl7.org/fhir/ValueSet/citation-artifact-classifier|5.0.0` ) Additional classifiers for the related artifact.
Type | CodeableConcept
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
168. PlanDefinition.relatedArtifact:InputDocumentExpected.label
Definition | Various kinds (or models) of documents may be expected as input to a laboratory service. This element provides an unambiguous short name for such a kind of document.
Short | Name of the kind of document expected
Comments | Examples of kinds of documents expected include: the paper lab order scanned the statement of acceptation of the service by the insurance provider (e.g. for a prenatal karyotyping) the patient consent (e.g. for a genetic test) the patient insurance affiliation scanned
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Label | Kind of document
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
170. PlanDefinition.relatedArtifact:InputDocumentExpected.display
Definition | A brief description of the document that need to be provided alongside the order of this laboratory service
Short | Brief description of the related artifact
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
172. PlanDefinition.relatedArtifact:InputDocumentExpected.citation
Definition | A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.
Short | Bibliographic citation for the artifact
Comments | Additional structured information about citations should be captured as extensions.
Control | 0..1
Type | markdown
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
174. PlanDefinition.relatedArtifact:InputDocumentExpected.document
Definition | provides in the attachment a model for the kind of document expected
Short | Document model
Comments | The model can be encoded in base64 in the data sub-element, with its mime type encoded in the contentType sub-element, or it can be external, accessible through the url sub-element.
Control | 0..1
Type | Attachment
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
176. PlanDefinition.relatedArtifact:InputDocumentExpected.document.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | id
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
178. PlanDefinition.relatedArtifact:InputDocumentExpected.document.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PlanDefinition.relatedArtifact.document.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
180. PlanDefinition.relatedArtifact:InputDocumentExpected.document.contentType
Definition | Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.
Short | Mime type of the content, with charset etc.
Control | 0..1 This element is affected by the following invariants: att-1
Binding | The codes SHALL be taken from MimeTypes (required to `http://hl7.org/fhir/ValueSet/mimetypes|5.0.0` ) BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Processors of the data need to be able to know how to interpret the data.
Example | General: text/plain; charset=UTF-8, image/png
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
182. PlanDefinition.relatedArtifact:InputDocumentExpected.document.language
Definition | The human language of the content. The value can be any valid value according to BCP 47.
Short | Human language of the content (BCP-47)
Control | 0..1
Binding | The codes SHALL be taken from AllLanguages (required to `http://hl7.org/fhir/ValueSet/all-languages|5.0.0` ) IETF language tag for a human language.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Users need to be able to choose between the languages in a set of attachments.
Example | General: en-AU
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
184. PlanDefinition.relatedArtifact:InputDocumentExpected.document.data
Definition | The actual data of the attachment - a sequence of bytes, base64 encoded.
Short | Data inline, base64ed
Comments | The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.
Control | 0..1 This element is affected by the following invariants: att-1
Type | base64Binary
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | The data needs to able to be transmitted inline.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
186. PlanDefinition.relatedArtifact:InputDocumentExpected.document.url
Definition | used if the model of document is accessible externally
Short | url of the model of document expected
Comments | If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.
Control | 0..1
Type | url
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | The data needs to be transmitted by reference.
Example | General: http://www.acme.com/logo-small.png
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
188. PlanDefinition.relatedArtifact:InputDocumentExpected.document.size
Definition | The number of bytes of data that make up this attachment (before base64 encoding, if that is done).
Short | Number of bytes of content (if url provided)
Comments | The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.
Control | 0..1
Type | integer64
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
190. PlanDefinition.relatedArtifact:InputDocumentExpected.document.hash
Definition | The calculated hash of the data using SHA-1. Represented using base64.
Short | Hash of the data (sha-1, base64ed)
Comments | The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature.
Control | 0..1
Type | base64Binary
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version).
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
192. PlanDefinition.relatedArtifact:InputDocumentExpected.document.title
Definition | May be sufficient to specify the document expected, in cases where no pre-defined needs to be communicated to the orderer of the service.
Short | Title of the kind or model of document
Comments | May sometimes be derived from the source filename.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.
Example | General: Official Corporate Logo
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
194. PlanDefinition.relatedArtifact:InputDocumentExpected.document.creation
Definition | The date that the attachment was first created.
Short | Date attachment was first created
Control | 0..1
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | This is often tracked as an integrity issue for use of the attachment.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
196. PlanDefinition.relatedArtifact:InputDocumentExpected.document.height
Definition | Height of the image in pixels (photo/video).
Short | Height of the image in pixels (photo/video)
Control | 0..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
198. PlanDefinition.relatedArtifact:InputDocumentExpected.document.width
Definition | Width of the image in pixels (photo/video).
Short | Width of the image in pixels (photo/video)
Control | 0..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
200. PlanDefinition.relatedArtifact:InputDocumentExpected.document.frames
Definition | The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.
Short | Number of frames if > 1 (photo)
Comments | if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated.
Control | 0..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
202. PlanDefinition.relatedArtifact:InputDocumentExpected.document.duration
Definition | The duration of the recording in seconds - for audio and video.
Short | Length in seconds (audio / video)
Comments | The duration might differ from occurrencePeriod if recording was paused.
Control | 0..1
Type | decimal
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
204. PlanDefinition.relatedArtifact:InputDocumentExpected.document.pages
Definition | The number of pages when printed.
Short | Number of printed pages
Control | 0..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
206. PlanDefinition.relatedArtifact:InputDocumentExpected.resource
Definition | The related artifact, such as a library, value set, profile, or other knowledge resource.
Short | What artifact is being referenced
Comments | If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource.
Control | 0..1
Type | canonical(Resource)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
208. PlanDefinition.relatedArtifact:InputDocumentExpected.resourceReference
Definition | The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.
Short | What artifact, if not a conformance resource
Comments | If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.
Control | 0..1
Type | Reference(Resource)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
210. PlanDefinition.relatedArtifact:InputDocumentExpected.publicationStatus
Definition | The publication status of the artifact being referred to.
Short | draft | active | retired | unknown
Control | 0..1
Binding | The codes SHALL be taken from PublicationStatus (required to `http://hl7.org/fhir/ValueSet/publication-status|5.0.0` ) Publication status of an artifact being referred to.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
212. PlanDefinition.relatedArtifact:InputDocumentExpected.publicationDate
Definition | The date of publication of the artifact being referred to.
Short | Date of publication of the artifact being referred to
Control | 0..1
Type | date
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
214. PlanDefinition.relatedArtifact:IsReplacedBy
Slice Name | IsReplacedBy
Definition | The related artifact is another instance of PlanDefinition, which is a replacement for the current no longer usable laboratory service
Short | Reference to a service replacing the current non-usable one
Comments | Each related artifact is either an attachment, or a reference to another resource, but not both.
Control | 0..*
Type | RelatedArtifact
Is Modifier | false
Must Support | true
Summary | false
Requirements | Plan definitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
216. PlanDefinition.relatedArtifact:IsReplacedBy.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | id
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
218. PlanDefinition.relatedArtifact:IsReplacedBy.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PlanDefinition.relatedArtifact.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
220. PlanDefinition.relatedArtifact:IsReplacedBy.type
Definition | The type of relationship to the related artifact is successor, meaning that the related artifact is in this case another instance of PlanDefinition representing the laboratory service, which is substituted to the current instance.
Short | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Comments | The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet.
Control | 1..1
Binding | The codes SHALL be taken from RelatedArtifactType (required to `http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0` ) The type of relationship to the related artifact.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Pattern Value | `successor`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
222. PlanDefinition.relatedArtifact:IsReplacedBy.classifier
Definition | Provides additional classifiers of the related artifact.
Short | Additional classifiers
Control | 0..*
Binding | For example codes, see CitationArtifactClassifier (example to `http://hl7.org/fhir/ValueSet/citation-artifact-classifier|5.0.0` ) Additional classifiers for the related artifact.
Type | CodeableConcept
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
224. PlanDefinition.relatedArtifact:IsReplacedBy.label
Definition | A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.
Short | Short label
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
226. PlanDefinition.relatedArtifact:IsReplacedBy.display
Definition | A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.
Short | Brief description of the related artifact
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
228. PlanDefinition.relatedArtifact:IsReplacedBy.citation
Definition | A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.
Short | Bibliographic citation for the artifact
Comments | Additional structured information about citations should be captured as extensions.
Control | 0..1
Type | markdown
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
230. PlanDefinition.relatedArtifact:IsReplacedBy.document
Definition | The document being referenced, represented as an attachment. This is exclusive with the resource element.
Short | What document is being referenced
Control | 0..1
Type | Attachment
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
232. PlanDefinition.relatedArtifact:IsReplacedBy.resource
Definition | The related resource, in this case a PlanDefinition constrained by the LabServiceDefinition profile
Short | What artifact is being referenced
Comments | If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource.
Control | 1..1
Type | canonical(Laboratory Service Definition)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
234. PlanDefinition.relatedArtifact:IsReplacedBy.resourceReference
Definition | The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.
Short | What artifact, if not a conformance resource
Comments | If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.
Control | 0..1
Type | Reference(Resource)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
236. PlanDefinition.relatedArtifact:IsReplacedBy.publicationStatus
Definition | The publication status of the artifact being referred to.
Short | draft | active | retired | unknown
Control | 0..1
Binding | The codes SHALL be taken from PublicationStatus (required to `http://hl7.org/fhir/ValueSet/publication-status|5.0.0` ) Publication status of an artifact being referred to.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
238. PlanDefinition.relatedArtifact:IsReplacedBy.publicationDate
Definition | The date of publication of the artifact being referred to.
Short | Date of publication of the artifact being referred to
Control | 0..1
Type | date
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
240. PlanDefinition.relatedArtifact:Includes
Slice Name | Includes
Definition | The related artifact is another instance of PlanDefinition, representing a laboratory service orderable on its own, and which is also part of the current one, either systematically or reflexed by a trigger.
Short | Reference to a panel or test included by the current one
Comments | Each related artifact is either an attachment, or a reference to another resource, but not both.
Control | 0..*
Type | RelatedArtifact
Is Modifier | false
Must Support | true
Summary | false
Requirements | Plan definitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
242. PlanDefinition.relatedArtifact:Includes.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | id
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
244. PlanDefinition.relatedArtifact:Includes.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PlanDefinition.relatedArtifact.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
246. PlanDefinition.relatedArtifact:Includes.type
Definition | The type of relationship to the related artifact is composed-of, meaning that the related artifact is another standalone laboratory service, which is also included as a sub-service of the current one.
Short | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Comments | The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet.
Control | 1..1
Binding | The codes SHALL be taken from RelatedArtifactType (required to `http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0` ) The type of relationship to the related artifact.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Pattern Value | `composed-of`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
248. PlanDefinition.relatedArtifact:Includes.classifier
Definition | Provides additional classifiers of the related artifact.
Short | Additional classifiers
Control | 0..*
Binding | For example codes, see CitationArtifactClassifier (example to `http://hl7.org/fhir/ValueSet/citation-artifact-classifier|5.0.0` ) Additional classifiers for the related artifact.
Type | CodeableConcept
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
250. PlanDefinition.relatedArtifact:Includes.label
Definition | A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.
Short | Short label
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
252. PlanDefinition.relatedArtifact:Includes.display
Definition | A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.
Short | Brief description of the related artifact
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
254. PlanDefinition.relatedArtifact:Includes.citation
Definition | A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.
Short | Bibliographic citation for the artifact
Comments | Additional structured information about citations should be captured as extensions.
Control | 0..1
Type | markdown
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
256. PlanDefinition.relatedArtifact:Includes.document
Definition | The document being referenced, represented as an attachment. This is exclusive with the resource element.
Short | What document is being referenced
Control | 0..1
Type | Attachment
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
258. PlanDefinition.relatedArtifact:Includes.resource
Definition | The related resource, in this case a PlanDefinition constrained by the LabServiceDefinition profile
Short | What artifact is being referenced
Comments | If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource.
Control | 1..1
Type | canonical(Laboratory Service Definition)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
260. PlanDefinition.relatedArtifact:Includes.resourceReference
Definition | The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.
Short | What artifact, if not a conformance resource
Comments | If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.
Control | 0..1
Type | Reference(Resource)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
262. PlanDefinition.relatedArtifact:Includes.publicationStatus
Definition | The publication status of the artifact being referred to.
Short | draft | active | retired | unknown
Control | 0..1
Binding | The codes SHALL be taken from PublicationStatus (required to `http://hl7.org/fhir/ValueSet/publication-status|5.0.0` ) Publication status of an artifact being referred to.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
264. PlanDefinition.relatedArtifact:Includes.publicationDate
Definition | The date of publication of the artifact being referred to.
Short | Date of publication of the artifact being referred to
Control | 0..1
Type | date
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
266. PlanDefinition.relatedArtifact:Bibliography
Slice Name | Bibliography
Definition | Related bibliographic references such as documentation, justification, or citation.
Short | Additional documentation, citation or justification
Comments | Each related artifact is either an attachment, or a reference to another resource, but not both.
Control | 0..*
Type | RelatedArtifact
Is Modifier | false
Must Support | true
Summary | false
Requirements | Plan definitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
268. PlanDefinition.relatedArtifact:Bibliography.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | id
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
270. PlanDefinition.relatedArtifact:Bibliography.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PlanDefinition.relatedArtifact.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
272. PlanDefinition.relatedArtifact:Bibliography.type
Definition | kind of associated bibliographic artifact
Short | documentation | justification | citation
Comments | The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet.
Control | 1..1
Binding | The codes SHALL be taken from Types of bibliographic artifacts (required to `http://hl7.org/fhir/uv/order-catalog/ValueSet/bibliography-artifact-type` )
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
274. PlanDefinition.relatedArtifact:Bibliography.classifier
Definition | Provides additional classifiers of the related artifact.
Short | Additional classifiers
Control | 0..*
Binding | For example codes, see CitationArtifactClassifier (example to `http://hl7.org/fhir/ValueSet/citation-artifact-classifier|5.0.0` ) Additional classifiers for the related artifact.
Type | CodeableConcept
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
276. PlanDefinition.relatedArtifact:Bibliography.label
Definition | A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.
Short | Short label
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
278. PlanDefinition.relatedArtifact:Bibliography.display
Definition | A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.
Short | Brief description of the related artifact
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
280. PlanDefinition.relatedArtifact:Bibliography.citation
Definition | A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.
Short | Bibliographic citation for the artifact
Comments | Additional structured information about citations should be captured as extensions.
Control | 0..1
Type | markdown
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
282. PlanDefinition.relatedArtifact:Bibliography.document
Definition | The document being referenced, represented as an attachment. This is exclusive with the resource element.
Short | What document is being referenced
Control | 0..1
Type | Attachment
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
284. PlanDefinition.relatedArtifact:Bibliography.resource
Definition | The related artifact, such as a library, value set, profile, or other knowledge resource.
Short | What artifact is being referenced
Comments | If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource.
Control | 0..1
Type | canonical(Resource)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
286. PlanDefinition.relatedArtifact:Bibliography.resourceReference
Definition | The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.
Short | What artifact, if not a conformance resource
Comments | If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.
Control | 0..1
Type | Reference(Resource)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
288. PlanDefinition.relatedArtifact:Bibliography.publicationStatus
Definition | The publication status of the artifact being referred to.
Short | draft | active | retired | unknown
Control | 0..1
Binding | The codes SHALL be taken from PublicationStatus (required to `http://hl7.org/fhir/ValueSet/publication-status|5.0.0` ) Publication status of an artifact being referred to.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
290. PlanDefinition.relatedArtifact:Bibliography.publicationDate
Definition | The date of publication of the artifact being referred to.
Short | Date of publication of the artifact being referred to
Control | 0..1
Type | date
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
292. PlanDefinition.library
Definition | A reference to a Library resource containing any formal logic used by the plan definition.
Short | Logic used by the plan definition
Control | 0..*
Type | canonical(Library)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
294. PlanDefinition.goal
Definition | A goal describes an expected outcome that activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, meeting the acceptance criteria for a test as specified by a quality specification, etc.
Short | What the plan is trying to accomplish
Control | 0..* This element is affected by the following invariants: pld-3
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | false
Requirements | Goal information needs to be captured for order sets, protocols, and care plan definitions to better describe the objectives of the protocol activities and to guide the creation of specific goals within the derived care plans and orders.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
296. PlanDefinition.goal.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
298. PlanDefinition.goal.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
300. PlanDefinition.goal.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
302. PlanDefinition.goal.category
Definition | Indicates a category the goal falls within.
Short | E.g. Treatment, dietary, behavioral
Control | 0..1
Binding | For example codes, see GoalCategory (example to `http://hl7.org/fhir/ValueSet/goal-category|5.0.0` ) Example codes for grouping goals for filtering or presentation.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
304. PlanDefinition.goal.description
Definition | Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding".
Short | Code or text describing the goal
Comments | If no code is available, use CodeableConcept.text.
Control | 1..1
Binding | For example codes, see SNOMEDCTClinicalFindings (example to `http://hl7.org/fhir/ValueSet/clinical-findings|5.0.0` ) Describes goals that can be achieved.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
306. 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|5.0.0` ) Indicates the level of importance associated with reaching or sustaining a goal.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
308. 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|5.0.0` ) Identifies the types of events that might trigger the start of a goal.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
310. PlanDefinition.goal.addresses
Definition | Identifies problems, conditions, issues, or concerns the goal is intended to address.
Short | What does the goal address
Control | 0..*
Binding | For example codes, see ConditionProblemDiagnosisCodes (example to `http://hl7.org/fhir/ValueSet/condition-code|5.0.0` ) Identifies problems, conditions, issues, or concerns that goals may address.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
312. PlanDefinition.goal.documentation
Definition | Didactic or other informational resources associated with the goal that provide further supporting information about the goal. Information resources can include inline text commentary and links to web resources.
Short | Supporting documentation for the goal
Control | 0..*
Type | RelatedArtifact
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
314. PlanDefinition.goal.target
Definition | Indicates what should be done and within what timeframe.
Short | Target outcome for the goal
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
316. PlanDefinition.goal.target.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
318. PlanDefinition.goal.target.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
320. PlanDefinition.goal.target.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
322. PlanDefinition.goal.target.measure
Definition | The parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.
Short | The parameter whose value is to be tracked
Control | 0..1
Binding | For example codes, see LOINCCodes (example to `http://hl7.org/fhir/ValueSet/observation-codes|5.0.0` ) Identifies types of parameters that can be tracked to determine goal achievement.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
324. PlanDefinition.goal.target.detail[x]
Definition | The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%, or in the case of pharmaceutical quality - NMT 0.6%, Clear solution, etc. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.
Short | The target value to be achieved
Comments | A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the goal.target.measure defines a coded value.
Control | 0..1
Type | Choice of: Quantity, Range, CodeableConcept, string, boolean, integer, Ratio
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
326. PlanDefinition.goal.target.due
Definition | Indicates the timeframe after the start of the goal in which the goal should be met.
Short | Reach goal within
Control | 0..1
Type | Duration
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
328. PlanDefinition.actor
Definition | Actors represent the individuals or groups involved in the execution of the defined set of activities.
Short | Actors within the plan
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
330. PlanDefinition.actor.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
332. PlanDefinition.actor.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
334. PlanDefinition.actor.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
336. PlanDefinition.actor.title
Definition | A descriptive label for the actor.
Short | User-visible title
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
338. PlanDefinition.actor.description
Definition | A description of how the actor fits into the overall actions of the plan definition.
Short | Describes the actor
Control | 0..1
Type | markdown
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
340. PlanDefinition.actor.option
Definition | The characteristics of the candidates that could serve as the actor.
Short | Who or what can be this actor
Control | 1..*
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
342. PlanDefinition.actor.option.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
344. PlanDefinition.actor.option.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
346. PlanDefinition.actor.option.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
348. PlanDefinition.actor.option.type
Definition | The type of participant in the action.
Short | careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Control | 0..1
Binding | The codes SHALL be taken from ActionParticipantType (required to `http://hl7.org/fhir/ValueSet/action-participant-type|5.0.0` ) The type of participant in the activity.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
350. PlanDefinition.actor.option.typeCanonical
Definition | The type of participant in the action.
Short | Who or what can participate
Control | 0..1
Type | canonical(CapabilityStatement)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
352. PlanDefinition.actor.option.typeReference
Definition | The type of participant in the action.
Short | Who or what can participate
Comments | When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location).
Control | 0..1
Type | Reference(CareTeam, Device, DeviceDefinition, Endpoint, Group, HealthcareService, Location, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
354. PlanDefinition.actor.option.role
Definition | The role the participant should play in performing the described action.
Short | E.g. Nurse, Surgeon, Parent
Control | 0..1
Binding | For example codes, see Action Participant Role (example to `http://terminology.hl7.org/ValueSet/action-participant-role` )
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
356. PlanDefinition.action
Definition | The concrete action or group of actions conveyed by this laboratory diagnostic service
Short | Action defined by the plan
Comments | The LabServiceDefinition profile constrains the content of PlanDefinition to be a single action at the top level. This action may be implemented by a single laboratory procedure referenced as an instance of ActivityDefinition, or may be decomposed into any level of logical groups of more granular actions, each leaf action referencing an ActivityDefinition.
Control | 1..1 This element is affected by the following invariants: pld-3, pld-4
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
358. PlanDefinition.action.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
360. PlanDefinition.action.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PlanDefinition.action.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
362. PlanDefinition.action.extension:SpecimenRequested
Slice Name | SpecimenRequested
Definition | A set of specimens requested as input by this laboratory service. The set is organized as a collection of one or more alternative groups (exactly one group should be chosen at specimen collection time). Each group describes one or more specimens that must all be provided, in case this group is the one chosen.
Short | Specimens required for this action
Comments | In case this element has multiple occurrence, all occurrences apply: Each set of specimen requirements represented by an occurrence of action.extension:SpecimenRequested must be fulfilled for the service described by the PlanDefinition instance.
Control | 0..*
Type | Extension(Specimens requested by a laboratory service) (Complex Extension)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
364. PlanDefinition.action.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
366. PlanDefinition.action.linkId
Definition | An identifier that is unique within the PlanDefinition to allow linkage within the realized CarePlan and/or RequestOrchestration.
Short | Unique id for the action in the PlanDefinition
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
368. PlanDefinition.action.prefix
Definition | A user-visible prefix for the action. For example a section or item numbering such as 1. or A.
Short | User-visible prefix for the action (e.g. 1. or A.)
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
370. PlanDefinition.action.title
Definition | The textual description of the action displayed to a user. For example, when the action is a test to be performed, the title would be the title of the test such as Assay by HPLC.
Short | User-visible title
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
372. PlanDefinition.action.description
Definition | A brief description of the laboratory service, which may mention the analytical method(s) used by the laboratory
Short | Brief description of the laboratory service and its method
Control | 0..1
Type | markdown
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
374. PlanDefinition.action.textEquivalent
Definition | A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.
Short | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Control | 0..1
Type | markdown
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
376. PlanDefinition.action.priority
Definition | Indicates how quickly this diagnostic panel or test should be performed.
Short | routine | urgent | asap | stat
Control | 0..1
Binding | The codes SHALL be taken from RequestPriority (required to `http://hl7.org/fhir/ValueSet/request-priority|5.0.0` ) Identifies the level of importance to be assigned to actioning the request.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
378. PlanDefinition.action.code
Definition | A code that provides meaning to the laboratory service
Short | Code of the laboratory service
Control | 0..1
Binding | For example codes, see ActionCode (example to `http://hl7.org/fhir/ValueSet/action-code|5.0.0` ) Provides examples of actions to be performed.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
380. PlanDefinition.action.code.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | id
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
382. PlanDefinition.action.code.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PlanDefinition.action.code.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
384. PlanDefinition.action.code.coding
Definition | A reference to a code defined by a terminology system.
Short | Code for the laboratory service
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..*
Type | Coding
Is Modifier | false
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `PlanDefinition.action.code.coding`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ system
386. PlanDefinition.action.code.coding:orderCodeLOINC
Slice Name | orderCodeLOINC
Definition | A reference to a code defined by a terminology system.
Short | LOINC code for the laboratory service
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..1
Type | Coding
Is Modifier | false
Must Support | true
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
388. PlanDefinition.action.code.coding:orderCodeLOINC.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | id
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
390. PlanDefinition.action.code.coding:orderCodeLOINC.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PlanDefinition.action.code.coding.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
392. PlanDefinition.action.code.coding:orderCodeLOINC.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | LOINC code 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 be an absolute reference to some definition that establishes the system clearly and unambiguously.
Control | 0..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Label | LOINC
Pattern Value | `http://loinc.org`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
394. PlanDefinition.action.code.coding:orderCodeLOINC.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
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
396. PlanDefinition.action.code.coding:orderCodeLOINC.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 This element is affected by the following invariants: cod-1
Type | code
Is Modifier | false
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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
398. PlanDefinition.action.code.coding:orderCodeLOINC.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 This element is affected by the following invariants: cod-1
Type | string
Is Modifier | false
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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
400. PlanDefinition.action.code.coding:orderCodeLOINC.userSelected
Definition | Indicates that this coding was chosen by a user directly - e.g. 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
Is Modifier | false
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.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
402. PlanDefinition.action.code.text
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
404. PlanDefinition.action.reason
Definition | A description of why this action is necessary or appropriate.
Short | Why the action should be performed
Comments | This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action.
Control | 0..*
Binding | For example codes, see ActionReasonCode (example to `http://hl7.org/fhir/ValueSet/action-reason-code|5.0.0` ) Provides examples of reasons for actions to be performed.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
406. PlanDefinition.action.documentation
Definition | Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.
Short | Supporting documentation for the intended performer of the action
Control | 0..*
Type | RelatedArtifact
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
408. PlanDefinition.action.goalId
Definition | Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition. In pharmaceutical quality, a goal represents acceptance criteria (Goal) for a given action (Test), so the goalId would be the unique id of a defined goal element establishing the acceptance criteria for the action.
Short | What goals this action supports
Control | 0..* This element is affected by the following invariants: pld-3
Type | id
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
410. PlanDefinition.action.subject[x]
Definition | A code, group definition, or canonical reference that describes the intended subject of the action and its children, if any. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.
Short | Type of individual the action is focused on
Comments | The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified. In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from ParticipantResourceTypes (extensible to `http://hl7.org/fhir/ValueSet/participant-resource-types|5.0.0` ) The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
Type | Choice of: CodeableConcept, Reference(Group), canonical
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Requirements | Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.
Meaning if Missing | Patient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
412. PlanDefinition.action.trigger
Definition | A description of when the action should be triggered. When multiple triggers are specified on an action, any triggering event invokes the action.
Short | When the action should be triggered
Control | 0..*
Type | TriggerDefinition
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `PlanDefinition.action.trigger`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ type
414. PlanDefinition.action.trigger:Reflex
Slice Name | Reflex
Definition | This trigger introduces a reflex laboratory procedure (test or panel) represended by the ActivityDefinition referenced by the action.definition. The trigger is expressed as a named event, and may also be refined with a data requirement and a condition.
Short | Reflex laboratory procedure
Control | 0..*
Type | TriggerDefinition
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
416. PlanDefinition.action.trigger:Reflex.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | id
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
418. PlanDefinition.action.trigger:Reflex.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `PlanDefinition.action.trigger.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
420. PlanDefinition.action.trigger:Reflex.type
Definition | The type of triggering event.
Short | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Control | 1..1 This element is affected by the following invariants: trd-3
Binding | The codes SHALL be taken from TriggerType (required to `http://hl7.org/fhir/ValueSet/trigger-type|5.0.0` ) The type of trigger.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Pattern Value | `named-event`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
422. PlanDefinition.action.trigger:Reflex.name
Definition | The natural language expression of the trigger for the reflex laboratory procedure
Short | Name or URI that identifies the event
Comments | An event name can be provided for all event types, but is required for named events. If a name is provided for a type other than named events, it is considered to be a shorthand for the semantics described by the formal description of the event.
Control | 1..1 This element is affected by the following invariants: trd-3
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
424. PlanDefinition.action.trigger:Reflex.code
Definition | A code that identifies the event.
Short | Coded definition of the event
Control | 0..1
Type | CodeableConcept
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
426. PlanDefinition.action.trigger:Reflex.subscriptionTopic
Definition | A reference to a SubscriptionTopic resource that defines the event. If this element is provided, no other information about the trigger definition may be supplied.
Short | What event
Control | 0..1
Type | canonical(SubscriptionTopic)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
428. PlanDefinition.action.trigger:Reflex.timing[x]
Definition | The timing of the event (if this is a periodic trigger).
Short | Timing of the event
Control | 0..1 This element is affected by the following invariants: trd-3, trd-1
Type | Choice of: Timing, Reference(Schedule), date, dateTime
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
430. PlanDefinition.action.trigger:Reflex.data
Definition | The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.
Short | Triggering data of the event (multiple = 'and')
Comments | This element shall be present for any data type trigger.
Control | 0..* This element is affected by the following invariants: trd-3, trd-2, trd-1
Type | DataRequirement
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
432. PlanDefinition.action.trigger:Reflex.condition
Definition | A boolean-valued expression that is evaluated in the context of the container of the trigger definition and returns whether or not the trigger fires.
Short | Whether the event triggers (boolean expression)
Comments | This element can be only be specified for data type triggers and provides additional semantics for the trigger. The context available within the condition is based on the type of data event. For all events, the current resource will be available as context. In addition, for modification events, the previous resource will also be available. The expression may be inlined, or may be a simple absolute URI, which is a reference to a named expression within a logic library referenced by a library element or extension within the containing resource. If the expression is a FHIR Path expression, it evaluates in the context of a resource of one of the type identified in the data requirement, and may also refer to the variable %previous for delta comparisons on events of type data-changed, data-modified, and data-deleted which will always have the same type.
Control | 0..1 This element is affected by the following invariants: trd-2
Type | Expression
Is Modifier | false
Summary | true
Requirements | Need to be able to formally describe the triggering criteria.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
434. PlanDefinition.action.condition
Definition | An expression that describes applicability criteria or start/stop conditions for the action.
Short | Whether or not the action is applicable
Comments | When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
436. PlanDefinition.action.condition.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
438. PlanDefinition.action.condition.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
440. PlanDefinition.action.condition.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
442. PlanDefinition.action.condition.kind
Definition | The kind of condition.
Short | applicability | start | stop
Comments | Applicability criteria are used to determine immediate applicability when a plan definition is applied to a given context. Start and stop criteria are carried through application and used to describe enter/exit criteria for an action.
Control | 1..1
Binding | The codes SHALL be taken from ActionConditionKind (required to `http://hl7.org/fhir/ValueSet/action-condition-kind|5.0.0` ) Defines the kinds of conditions that can appear on actions.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
444. PlanDefinition.action.condition.expression
Definition | An expression that returns true or false, indicating whether the condition is satisfied.
Short | Boolean-valued expression
Comments | The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.
Control | 0..1
Type | Expression
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
446. PlanDefinition.action.input
Definition | Defines input data requirements for the action.
Short | Input data requirements
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) pld-0: Input data elements must have a requirement or a relatedData, but not both (`requirement.exists() xor relatedData.exists()`)
448. PlanDefinition.action.input.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
450. PlanDefinition.action.input.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
452. PlanDefinition.action.input.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
454. PlanDefinition.action.input.title
Definition | A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.
Short | User-visible title
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
456. PlanDefinition.action.input.requirement
Definition | Defines the data that is to be provided as input to the action.
Short | What data is provided
Control | 0..1 This element is affected by the following invariants: pld-0
Type | DataRequirement
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
458. PlanDefinition.action.input.relatedData
Definition | Points to an existing input or output element that provides data to this input.
Short | What data is provided
Comments | The relatedData element allows indicating that an input to a parent action is an input to specific child actions. It also allows the output of one action to be identified as the input to a different action
Control | 0..1 This element is affected by the following invariants: pld-0
Type | id
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
460. PlanDefinition.action.output
Definition | Defines the outputs of the action, if any.
Short | Output data definition
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) pld-1: Output data element must have a requirement or a relatedData, but not both (`requirement.exists() xor relatedData.exists()`)
462. PlanDefinition.action.output.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
464. PlanDefinition.action.output.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
466. PlanDefinition.action.output.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
468. PlanDefinition.action.output.title
Definition | A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.
Short | User-visible title
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
470. PlanDefinition.action.output.requirement
Definition | Defines the data that results as output from the action.
Short | What data is provided
Control | 0..1 This element is affected by the following invariants: pld-1
Type | DataRequirement
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
472. PlanDefinition.action.output.relatedData
Definition | Points to an existing input or output element that is results as output from the action.
Short | What data is provided
Comments | The relatedData element allows indicating that the output of child action is also the output of a parent action. It also allows the input of one action to be identified as the output of a different action
Control | 0..1 This element is affected by the following invariants: pld-1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
474. PlanDefinition.action.relatedAction
Definition | A relationship to another action such as "before" or "30-60 minutes after start of".
Short | Relationship to another action
Comments | When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.
Control | 0..* This element is affected by the following invariants: pld-4
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
476. PlanDefinition.action.relatedAction.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
478. PlanDefinition.action.relatedAction.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
480. PlanDefinition.action.relatedAction.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
482. PlanDefinition.action.relatedAction.targetId
Definition | The element id of the target related action.
Short | What action is this related to
Control | 1..1 This element is affected by the following invariants: pld-4
Type | id
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
484. PlanDefinition.action.relatedAction.relationship
Definition | The relationship of the start of this action to the related action.
Short | before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Control | 1..1
Binding | The codes SHALL be taken from ActionRelationshipType (required to `http://hl7.org/fhir/ValueSet/action-relationship-type|5.0.0` ) Defines the types of relationships between actions.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
486. PlanDefinition.action.relatedAction.endRelationship
Definition | The relationship of the end of this action to the related action.
Short | before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Control | 0..1
Binding | The codes SHALL be taken from ActionRelationshipType (required to `http://hl7.org/fhir/ValueSet/action-relationship-type|5.0.0` ) Defines the types of relationships between actions.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
488. 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]
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
490. PlanDefinition.action.timing[x]
Definition | An optional value describing when the action should be performed.
Short | When the action should take place
Comments | The intent of the timing element is to provide timing when the action should be performed. As a definitional resource, this timing is interpreted as part of an apply operation so that the timing of the result actions in a CarePlan or RequestOrchestration, for example, would be specified by evaluating the timing definition in the context of the apply and setting the resulting timing on the appropriate elements of the target resource. If the timing is an Age, the activity is expected to be performed when the subject is the given Age. When the timing is a Duration, the activity is expected to be performed within the specified duration from the apply. When the timing is a Range, it may be a range of Ages or Durations, providing a range for the expected timing of the resulting activity. When the timing is a Timing, it is establishing a schedule for the timing of the resulting activity.
Control | 0..1
Type | Choice of: Age, Duration, Range, Timing
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Must Support | false
Summary | false
Requirements | Allows prompting for activities and detection of missed planned activities.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
492. PlanDefinition.action.location
Definition | Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etc.
Short | Where it should happen
Comments | May reference a specific clinical location or may just identify a type of location.
Control | 0..1
Type | CodeableReference(Location)
Is Modifier | false
Must Support | false
Summary | false
Requirements | Helps in planning of activity.
Alternate Names | facility
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
494. PlanDefinition.action.participant
Definition | Indicates who should participate in performing the action described.
Short | Who should participate in the action
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
496. PlanDefinition.action.participant.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
498. PlanDefinition.action.participant.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
500. PlanDefinition.action.participant.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
502. PlanDefinition.action.participant.actorId
Definition | A reference to the id element of the actor who will participate in this action.
Short | What actor
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
504. PlanDefinition.action.participant.type
Definition | The type of participant in the action.
Short | careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Control | 0..1
Binding | The codes SHALL be taken from ActionParticipantType (required to `http://hl7.org/fhir/ValueSet/action-participant-type|5.0.0` ) The type of participant in the activity.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
506. PlanDefinition.action.participant.typeCanonical
Definition | The type of participant in the action.
Short | Who or what can participate
Control | 0..1
Type | canonical(CapabilityStatement)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
508. PlanDefinition.action.participant.typeReference
Definition | The type of participant in the action.
Short | Who or what can participate
Comments | When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location).
Control | 0..1
Type | Reference(CareTeam, Device, DeviceDefinition, Endpoint, Group, HealthcareService, Location, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
510. PlanDefinition.action.participant.role
Definition | The role the participant should play in performing the described action.
Short | E.g. Nurse, Surgeon, Parent
Control | 0..1
Binding | For example codes, see Action Participant Role (example to `http://terminology.hl7.org/ValueSet/action-participant-role` ) Defines roles played by participants for the action.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
512. PlanDefinition.action.participant.function
Definition | Indicates how the actor will be involved in the action - author, reviewer, witness, etc.
Short | E.g. Author, Reviewer, Witness, etc
Control | 0..1
Binding | For example codes, see ActionParticipantFunction (example to `http://hl7.org/fhir/ValueSet/action-participant-function|5.0.0` )
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
514. PlanDefinition.action.type
Definition | The type of action to perform (create, update, remove).
Short | create | update | remove | fire-event
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from ActionType (extensible to `http://hl7.org/fhir/ValueSet/action-type|5.0.0` ) The type of action to be performed.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
516. PlanDefinition.action.groupingBehavior
Definition | Defines the grouping behavior for the action and its children.
Short | visual-group | logical-group | sentence-group
Control | 0..1
Binding | The codes SHALL be taken from ActionGroupingBehavior (required to `http://hl7.org/fhir/ValueSet/action-grouping-behavior|5.0.0` ) Defines organization behavior of a group.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Meaning if Missing | If no grouping behavior is specified but the action has children (i.e. is a group), the grouping behavior is assumed to be `logical-group`.
Pattern Value | `logical-group`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
518. PlanDefinition.action.selectionBehavior
Definition | Defines the selection behavior for the action and its children.
Short | any | all | all-or-none | exactly-one | at-most-one | one-or-more
Control | 0..1
Binding | The codes SHALL be taken from ActionSelectionBehavior (required to `http://hl7.org/fhir/ValueSet/action-selection-behavior|5.0.0` ) Defines selection behavior of a group.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Meaning if Missing | If no selection behavior is specified but the action has children (i.e. is a group), the selection behavior is assumed to be `all`.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
520. PlanDefinition.action.requiredBehavior
Definition | Defines the required behavior for the action.
Short | must | could | must-unless-documented
Control | 0..1
Binding | The codes SHALL be taken from ActionRequiredBehavior (required to `http://hl7.org/fhir/ValueSet/action-required-behavior|5.0.0` ) Defines expectations around whether an action or action group is required.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Meaning if Missing | If no required behavior is specified but the action has children (i.e. is a group), the required behavior is assumed to be `could`.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
522. PlanDefinition.action.precheckBehavior
Definition | Defines whether the action should usually be preselected.
Short | yes | no
Control | 0..1
Binding | The codes SHALL be taken from ActionPrecheckBehavior (required to `http://hl7.org/fhir/ValueSet/action-precheck-behavior|5.0.0` ) Defines selection frequency behavior for an action or group.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Meaning if Missing | If no precheck behavior is specified but the action has children (i.e. is a group), the precheck behavior is assumed to be `no`.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
524. PlanDefinition.action.cardinalityBehavior
Definition | Defines whether the action can be selected multiple times.
Short | single | multiple
Control | 0..1
Binding | The codes SHALL be taken from ActionCardinalityBehavior (required to `http://hl7.org/fhir/ValueSet/action-cardinality-behavior|5.0.0` ) Defines behavior for an action or a group for how many times that item may be repeated.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Meaning if Missing | If no cardinality behavior is specified but the action has children (i.e. is a group), the cardinality behavior is assumed to be `single`.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
526. PlanDefinition.action.definition[x]
Definition | A reference to an ActivityDefinition that describes the laboratory procedure to be performed, or to a PlanDefinition representing a child laboratory service, either embedded or reflexed by the current one.
Short | Description of the activity to be performed
Comments | The definition is present only when there is no grouping of sub-actions
Control | 0..1
Type | canonical(Laboratory Procedure Definition)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
528. PlanDefinition.action.transform
Definition | A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.
Short | Transform to apply the template
Comments | Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.
Control | 0..1
Type | canonical(StructureMap)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
530. PlanDefinition.action.dynamicValue
Definition | Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result.
Short | Dynamic aspects of the definition
Comments | Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
532. PlanDefinition.action.dynamicValue.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
534. PlanDefinition.action.dynamicValue.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
536. PlanDefinition.action.dynamicValue.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
538. PlanDefinition.action.dynamicValue.path
Definition | The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolvable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).
Short | The path to the element to be set dynamically
Comments | To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
540. PlanDefinition.action.dynamicValue.expression
Definition | An expression specifying the value of the customized element.
Short | An expression that provides the dynamic value for the customization
Comments | The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.
Control | 0..1
Type | Expression
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
542. 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
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
544. PlanDefinition.asNeeded[x]
Definition | If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc.
Short | Preconditions for service
Control | 0..1
Binding | For example codes, see SNOMEDCTMedicationAsNeededReasonCodes (example to `http://hl7.org/fhir/ValueSet/medication-as-needed-reason|5.0.0` ) A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.
Type | Choice of: boolean, CodeableConcept
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)