Health Care Surveys Reporting
2.0.0 - STU 2

Health Care Surveys Reporting, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.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-health-care-surveys-reporting-ig/ and changes regularly. See the Directory of published versions

## Resource Profile: Health Care Surveys PlanDefinition - Detailed Descriptions

Page standards status: Trial-use | Maturity Level: 3

Definitions for the hcs-plandefinition resource profile

- Key Elements Table
- Differential Table
- Snapshot Table

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

0. PlanDefinition
Definition | This PlanDefinition profile defines the logic and rules around determining whether or not data from an encounter is reportable to National Center for Health Statistics (NCHS). This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.
Short | Health Care Surveys Knowledge ArtifactThe definition of a plan for a series of actions, independent of any specific patient or context
Control | 10..1*
Is Modifier | false
Summary | false
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) pdf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (`name.matches('[A-Z]([A-Za-z0-9_]){0,254}')`) pdf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.matches('[A-Z]([A-Za-z0-9_]){0,254}'))
2. PlanDefinition.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
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 it's 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 it's meaning or interpretation
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()))
4. PlanDefinition.extension:receiverAddress
Slice Name | receiverAddress
Definition | Indicates the address where the report has to be sent.
Short | Indicates the address where the report has to be sent.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(US Public Health Receiver Address Extension) (Extension Type: Reference(Endpoint))
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. PlanDefinition.extension:asyncIndicator
Slice Name | asyncIndicator
Definition | An Extension
Short | US Public Health Async Indicator Extension
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(US Public Health Async Indicator Extension) (Extension Type: boolean)
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. PlanDefinition.extension:contentEncrypted
Slice Name | contentEncrypted
Definition | Indicates whether the data in the content bundle is encrypted or not.
Short | US Public Health Data Encrypted Extension
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(US Public Health Data Encrypted Extension) (Extension Type: boolean)
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
10. PlanDefinition.extension:jwksForContentEncryption
Slice Name | jwksForContentEncryption
Definition | An Extension
Short | US Public Health Receiver Jwks Url
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(US Public Health Receiver JWKS Url Extension) (Extension Type: url)
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
12. PlanDefinition.extension:contentEncryptionAlgorithm
Slice Name | contentEncryptionAlgorithm
Definition | An Extension
Short | US Public Health Data Encryption Algorithm
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(US Public Health Data Encryption Algorithm Extension) (Extension Type: code)
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
14. PlanDefinition.extension:expectedResponseDuration
Slice Name | expectedResponseDuration
Definition | An Extension
Short | US Public Health Expected Response Time Extension
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(US Public Health Expected Response Time Extension) (Extension Type: Duration)
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
16. PlanDefinition.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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
Summary | false
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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())
18. PlanDefinition.url
Definition | An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different servers.
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. 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 | 10..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the plan definition to be referenced by a single globally unique identifier.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. PlanDefinition.identifier
Definition | A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
Short | Additional identifier for the plan definition
Comments | Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this plan definition outside of FHIR, where it is not possible to use the logical URI.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Is Modifier | false
Must Support | true
Summary | true
Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. PlanDefinition.version
Definition | Business version of the PlanDefinition 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 PlanDefinitionBusiness 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].
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. PlanDefinition.name
Definition | Name for this PlanDefinition (computer friendly) 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 PlanDefinition (computer friendly)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 | 10..1 This element is affected by the following invariants: inv-0
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
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()))
26. PlanDefinition.title
Definition | Title for this PlanDefinition A short, descriptive, user-friendly title for the plan definition.
Short | Title for this PlanDefinitionName 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 | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. PlanDefinition.type
Definition | Type of this PlanDefinition A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.
Short | Type of this PlanDefinitionorder-set | clinical-protocol | eca-rule | workflow-definition
Control | 10..1
Binding | Unless not suitable, these codes SHALL be taken from PlanDefinitionType http://hl7.org/fhir/ValueSet/plan-definition-type|4.0.1 (extensible to `http://hl7.org/fhir/ValueSet/plan-definition-type` ) The type of PlanDefinition.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | true
Pattern Value | `{ "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/plan-definition-type", "code" : "workflow-definition", "display" : "Workflow Definition" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. 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.
Control | 1..1
Binding | The codes SHALL be taken from PublicationStatus http://hl7.org/fhir/ValueSet/publication-status|4.0.1 (required to `http://hl7.org/fhir/ValueSet/publication-status|4.0.1` ) 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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. 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 | 10..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level plan definition.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. PlanDefinition.subject[x]
Definition | A code or group definition that describes the intended subject of the plan definition.
Short | Type of individual the plan definition is focused on
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from SubjectType http://hl7.org/fhir/ValueSet/subject-type|4.0.1 (extensible to `http://hl7.org/fhir/ValueSet/subject-type` ) The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
Type | Choice of: CodeableConcept, Reference(Group, Group)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Summary | false
Meaning if Missing | Patient
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. PlanDefinition.date
Definition | Date the PlanDefinition was last changed The date (and optionally time) when the plan definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changes.
Short | Date the PlanDefinition was last changedDate last changed
Comments | Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the plan definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
Control | 10..1
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Alternate Names | Revision Date
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. PlanDefinition.publisher
Definition | Name of the agency that published this PlanDefinition The name of the organization or individual that published the plan definition.
Short | Name of the agency that published this PlanDefinitionName of the publisher (organization or individual)
Comments | Usually an organization but may be an individual. The publisher (or steward) of the plan definition is the organization or individual primarily responsible for the maintenance and upkeep of the plan definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the plan definition. This item SHOULD be populated unless the information is available from context.
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Helps establish the "authority/credibility" of the plan definition. May also allow for contact.
Alternate Names | steward
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. PlanDefinition.contact
Definition | Contact details to assist a user in finding and communicating with the publisher.
Short | Contact details for the publisher
Comments | May be a web site, an email address, a telephone number, etc.
Control | 0..*
Type | ContactDetail
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()))
42. PlanDefinition.description
Definition | A free text natural language description of the plan definition from a consumer's perspective.
Short | Natural language description of the plan definition
Comments | This description can be used to capture details such as why the plan definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the plan definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the plan definition is presumed to be the predominant language in the place the plan definition was created).
Control | 10..1
Type | markdown
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Alternate Names | scope
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. PlanDefinition.useContext
Definition | The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances.
Short | The context that the content is intended to support
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
Control | 0..*
Type | UsageContext
Is Modifier | false
Must Support | 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()))
46. PlanDefinition.jurisdiction
Definition | A legal or geographic region in which the plan definition is intended to be used.
Short | Intended jurisdiction for plan definition (if applicable)
Comments | It may be possible for the plan definition to be used in jurisdictions other than those for which it was originally designed or intended.
Control | 0..*
Binding | Unless not suitable, these codes SHALL be taken from Jurisdiction ValueSet http://hl7.org/fhir/ValueSet/jurisdiction|4.0.1 (extensible to `http://hl7.org/fhir/ValueSet/jurisdiction` ) Countries and regions within which this artifact is targeted for use.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. PlanDefinition.effectivePeriod
Definition | The period during which the PlanDefinition is valid The period during which the plan definition content was or is planned to be in active use.
Short | When the PlanDefinition is validWhen the plan definition is expected to be used
Comments | The effective period for a plan definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.
Control | 0..1
Type | Period
Is Modifier | false
Must Support | true
Summary | true
Requirements | Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the plan definition are or are expected to be used instead.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. PlanDefinition.effectivePeriod.start
Definition | The start of the time period when this PlanDefinition goes into effect The start of the period. The boundary is inclusive.
Short | The start of the time period when this PlanDefinition goes into effectStarting time with inclusive boundary
Comments | If the low element is missing, the meaning is that the low boundary is not known.
Control | 10..1 This element is affected by the following invariants: per-1
Type | dateTime
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()))
52. 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, Library)
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()))
54. PlanDefinition.action
Definition | An action or group of actions to be taken as part of the plan.
Short | All constraints on action are intended to apply to any nested constraints.Action defined by the plan
Comments | Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.
Control | 50..*
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `PlanDefinition.action`. The slices areOrdered and Open, and can be differentiated using the following discriminators: value @ id
56. PlanDefinition.action.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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. 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())
58. PlanDefinition.action.description
Definition | A brief description of the action used to provide a summary to display to the user.
Short | Brief description of the action
Control | 0..1
Type | string
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()))
60. PlanDefinition.action.code
Definition | A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.
Short | Code representing the meaning of the action or sub-actions
Control | 0..1*
Binding | Unless not suitable, these codes SHALL be taken from For codes, see US Public Health VaueSet - PlanDefinition Action (extensible to `http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-plandefinition-action` )
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()))
62. PlanDefinition.action.trigger
Definition | A description of when the action should be triggered.
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()))
64. PlanDefinition.action.trigger.extension:namedEventType
Slice Name | namedEventType
Definition | Indicates the types of named events to subscribe to from the EHR.
Short | US Public Health Named Event Type Extension
Control | 0..1
Type | Extension(US Public Health Named Event Type Extension) (Extension 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())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
66. PlanDefinition.action.trigger.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
Binding | The codes SHALL be taken from TriggerType http://hl7.org/fhir/ValueSet/trigger-type|4.0.1 (required to `http://hl7.org/fhir/ValueSet/trigger-type|4.0.1` ) The type of trigger.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Fixed Value | `named-event`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
68. 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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
70. PlanDefinition.action.condition.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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. 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())
72. 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 http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1 (required to `http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1` ) 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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
74. 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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
76. PlanDefinition.action.input
Definition | Defines input data requirements for the action.
Short | Input data requirements
Control | 0..*
Type | DataRequirement
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()))
78. PlanDefinition.action.input.type
Definition | The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.
Short | The type of the required data
Control | 1..1
Binding | The codes SHALL be taken from FHIRAllTypes http://hl7.org/fhir/ValueSet/all-types|4.0.1 (required to `http://hl7.org/fhir/ValueSet/all-types|4.0.1` ) A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
80. PlanDefinition.action.output
Definition | Defines the outputs of the action, if any.
Short | Output data definition
Control | 0..*
Type | DataRequirement
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()))
82. PlanDefinition.action.output.type
Definition | The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.
Short | The type of the required data
Control | 1..1
Binding | The codes SHALL be taken from FHIRAllTypes http://hl7.org/fhir/ValueSet/all-types|4.0.1 (required to `http://hl7.org/fhir/ValueSet/all-types|4.0.1` ) A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
84. PlanDefinition.action.relatedAction
Definition | A relationship to another action such as "before" or "30-60 minutes after start of".
Short | Relationship to another action
Comments | When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.
Control | 0..*
Type | BackboneElement
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()))
86. PlanDefinition.action.relatedAction.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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. 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())
88. PlanDefinition.action.relatedAction.actionId
Definition | The element id of the related action.
Short | What action is this related to
Control | 1..1
Type | id
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()))
90. PlanDefinition.action.relatedAction.relationship
Definition | The relationship of this action to the related action.
Short | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control | 1..1
Binding | The codes SHALL be taken from ActionRelationshipType http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1 (required to `http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1` ) 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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
92. 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
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.relatedAction.offset[x]`. The slices areUnordered and Open, and can be differentiated using the following discriminators: type @ $this
94. PlanDefinition.action.relatedAction.offset[x]:offsetDuration
Slice Name | offsetDuration
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 | Duration, Range
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
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()))
96. PlanDefinition.action.timing[x]
Definition | An optional value describing when the action should be performed.
Short | When the action should take place
Control | 0..1
Type | Duration, dateTime, Period, Timing, Range, Age
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
98. PlanDefinition.action:startWorkflow
Slice Name | startWorkflow
Definition | An action or group of actions to be taken as part of the plan.
Short | All constraints on action are intended to apply to any nested constraints.Action defined by the plan
Comments | Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.
Control | 10..1*
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
100. PlanDefinition.action:startWorkflow.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 | 10..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Pattern Value | `start-workflow`
102. PlanDefinition.action:startWorkflow.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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. 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())
104. PlanDefinition.action:startWorkflow.description
Definition | A brief description of the action used to provide a summary to display to the user.
Short | Brief description of the action
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Pattern Value | `Start the workflow action.`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
106. PlanDefinition.action:startWorkflow.textEquivalent
Definition | Text equivalent of the start workflow action. 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 | Text equivalent of the start workflow action.Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Fixed Value | `Start the reporting workflow in response to an encounter-end event`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
108. PlanDefinition.action:startWorkflow.code
Definition | The US-PH-PlanDefinition-Action code for the start action. A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.
Short | Code for the start action.Code representing the meaning of the action or sub-actions
Control | 10..1*
Binding | Unless not suitable, these codes SHALL be taken from For codes, see US Public Health VaueSet - PlanDefinition Action (extensible to `http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-plandefinition-action` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Pattern Value | `{ "coding" : [{ "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions", "code" : "initiate-reporting-workflow" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
110. PlanDefinition.action:startWorkflow.trigger
Definition | When the start action should be triggered. A description of when the action should be triggered.
Short | When the start action should be triggered.When the action should be triggered
Control | 10..*
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()))
112. PlanDefinition.action:startWorkflow.trigger.extension:namedEventType
Slice Name | namedEventType
Definition | Indicates the types of named events to subscribe to from the EHR.
Short | Indicates the types of named events to subscribe to from the EHR.
Control | 0..1
Type | Extension(US Public Health Named Event Type Extension) (Extension 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())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
114. PlanDefinition.action:startWorkflow.trigger.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
Binding | The codes SHALL be taken from TriggerType http://hl7.org/fhir/ValueSet/trigger-type|4.0.1 (required to `http://hl7.org/fhir/ValueSet/trigger-type|4.0.1` ) The type of trigger.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Fixed Value | `named-event`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
116. PlanDefinition.action:startWorkflow.trigger.name
Definition | The name of the event, encounter-end in this case. For any action invoked as a result of this trigger, the triggering encounter is accessible via the context variable `%encounter` 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 | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Fixed Value | `encounter-end`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
118. PlanDefinition.action:startWorkflow.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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
120. PlanDefinition.action:startWorkflow.condition.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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. 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())
122. PlanDefinition.action:startWorkflow.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 http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1 (required to `http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1` ) 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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
124. PlanDefinition.action:startWorkflow.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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
126. PlanDefinition.action:startWorkflow.input
Definition | Defines input data requirements for the action.
Short | Input data requirements
Control | 0..*
Type | DataRequirement
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()))
128. PlanDefinition.action:startWorkflow.input.type
Definition | The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.
Short | The type of the required data
Control | 1..1
Binding | The codes SHALL be taken from FHIRAllTypes http://hl7.org/fhir/ValueSet/all-types|4.0.1 (required to `http://hl7.org/fhir/ValueSet/all-types|4.0.1` ) A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
130. PlanDefinition.action:startWorkflow.output
Definition | Defines the outputs of the action, if any.
Short | Output data definition
Control | 0..*
Type | DataRequirement
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()))
132. PlanDefinition.action:startWorkflow.output.type
Definition | The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.
Short | The type of the required data
Control | 1..1
Binding | The codes SHALL be taken from FHIRAllTypes http://hl7.org/fhir/ValueSet/all-types|4.0.1 (required to `http://hl7.org/fhir/ValueSet/all-types|4.0.1` ) A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
134. PlanDefinition.action:startWorkflow.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 | 10..1*
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
136. PlanDefinition.action:startWorkflow.relatedAction.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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. Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
138. PlanDefinition.action:startWorkflow.relatedAction.actionId
Definition | The element id of the related action.
Short | What action is this related to
Control | 1..1
Type | id
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Fixed Value | `check-reportability`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
140. PlanDefinition.action:startWorkflow.relatedAction.relationship
Definition | The relationship of this action to the related action.
Short | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control | 1..1
Binding | The codes SHALL be taken from ActionRelationshipType http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1 (required to `http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1` ) 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 | true
Summary | false
Fixed Value | `before-start`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
142. PlanDefinition.action:startWorkflow.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
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.relatedAction.offset[x]`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: type @ $this
144. PlanDefinition.action:startWorkflow.relatedAction.offset[x]:offsetDuration
Slice Name | offsetDuration
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 | Duration, Range
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Must Support | true
Summary | false
Example | Wait 72 hour before next action.: { "value" : 72, "unit" : "h" }
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
146. PlanDefinition.action:startWorkflow.timing[x]
Definition | An optional value describing when the action should be performed.
Short | When the action should take place
Control | 0..1
Type | Duration, dateTime, Period, Timing, Range, Age
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
148. PlanDefinition.action:executeReportingWorkflow
Slice Name | executeReportingWorkflow
Definition | An action or group of actions to be taken as part of the plan.
Short | All constraints on action are intended to apply to any nested constraints.Action defined by the plan
Comments | Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.
Control | 10..1*
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
150. PlanDefinition.action:executeReportingWorkflow.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 | 10..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Pattern Value | `check-reportability`
152. PlanDefinition.action:executeReportingWorkflow.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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. 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())
154. PlanDefinition.action:executeReportingWorkflow.description
Definition | A brief description of the action used to provide a summary to display to the user.
Short | Brief description of the action
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Pattern Value | `Execute reporting workflow action.`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
156. PlanDefinition.action:executeReportingWorkflow.code
Definition | The US-PH-PlanDefinition-Action code for the execute-reporting-workflow action. A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.
Short | Code for the execute-reporting-workflow action.Code representing the meaning of the action or sub-actions
Control | 10..1*
Binding | Unless not suitable, these codes SHALL be taken from For codes, see US Public Health VaueSet - PlanDefinition Action (extensible to `http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-plandefinition-action` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Pattern Value | `{ "coding" : [{ "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions", "code" : "execute-reporting-workflow" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
158. PlanDefinition.action:executeReportingWorkflow.trigger
Definition | A description of when the action should be triggered.
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()))
160. PlanDefinition.action:executeReportingWorkflow.trigger.extension:namedEventType
Slice Name | namedEventType
Definition | Indicates the types of named events to subscribe to from the EHR.
Short | US Public Health Named Event Type Extension
Control | 0..1
Type | Extension(US Public Health Named Event Type Extension) (Extension 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())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
162. PlanDefinition.action:executeReportingWorkflow.trigger.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
Binding | The codes SHALL be taken from TriggerType http://hl7.org/fhir/ValueSet/trigger-type|4.0.1 (required to `http://hl7.org/fhir/ValueSet/trigger-type|4.0.1` ) The type of trigger.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Fixed Value | `named-event`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
164. PlanDefinition.action:executeReportingWorkflow.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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
166. PlanDefinition.action:executeReportingWorkflow.condition.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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. 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())
168. PlanDefinition.action:executeReportingWorkflow.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 http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1 (required to `http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1` ) 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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
170. PlanDefinition.action:executeReportingWorkflow.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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
172. PlanDefinition.action:executeReportingWorkflow.input
Definition | Defines input data requirements for the action.
Short | Input data requirements
Control | 0..*
Type | DataRequirement
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()))
174. PlanDefinition.action:executeReportingWorkflow.input.type
Definition | The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.
Short | The type of the required data
Control | 1..1
Binding | The codes SHALL be taken from FHIRAllTypes http://hl7.org/fhir/ValueSet/all-types|4.0.1 (required to `http://hl7.org/fhir/ValueSet/all-types|4.0.1` ) A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
176. PlanDefinition.action:executeReportingWorkflow.output
Definition | Defines the outputs of the action, if any.
Short | Output data definition
Control | 0..*
Type | DataRequirement
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()))
178. PlanDefinition.action:executeReportingWorkflow.output.type
Definition | The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.
Short | The type of the required data
Control | 1..1
Binding | The codes SHALL be taken from FHIRAllTypes http://hl7.org/fhir/ValueSet/all-types|4.0.1 (required to `http://hl7.org/fhir/ValueSet/all-types|4.0.1` ) A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
180. PlanDefinition.action:executeReportingWorkflow.relatedAction
Definition | A relationship to another action such as "before" or "30-60 minutes after start of".
Short | Relationship to another action
Comments | When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.
Control | 0..*
Type | BackboneElement
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()))
182. PlanDefinition.action:executeReportingWorkflow.relatedAction.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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. 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())
184. PlanDefinition.action:executeReportingWorkflow.relatedAction.actionId
Definition | The element id of the related action.
Short | What action is this related to
Control | 1..1
Type | id
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()))
186. PlanDefinition.action:executeReportingWorkflow.relatedAction.relationship
Definition | The relationship of this action to the related action.
Short | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control | 1..1
Binding | The codes SHALL be taken from ActionRelationshipType http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1 (required to `http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1` ) 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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
188. PlanDefinition.action:executeReportingWorkflow.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
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.relatedAction.offset[x]`. The slices areUnordered and Open, and can be differentiated using the following discriminators: type @ $this
190. PlanDefinition.action:executeReportingWorkflow.relatedAction.offset[x]:offsetDuration
Slice Name | offsetDuration
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 | Duration, Range
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
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()))
192. PlanDefinition.action:executeReportingWorkflow.timing[x]
Definition | An optional value describing when the action should be performed.
Short | When the action should take place
Control | 0..1
Type | Duration, dateTime, Period, Timing, Range, Age
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
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()))
194. PlanDefinition.action:executeReportingWorkflow.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 | 20..*
Type | Seettp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifier | false
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.action`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ id
196. PlanDefinition.action:executeReportingWorkflow.action.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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. 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())
198. PlanDefinition.action:executeReportingWorkflow.action.description
Definition | A brief description of the action used to provide a summary to display to the user.
Short | Brief description of the action
Control | 0..1
Type | string
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()))
200. PlanDefinition.action:executeReportingWorkflow.action.code
Definition | A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.
Short | Code representing the meaning of the action or sub-actions
Control | 0..1*
Binding | Unless not suitable, these codes SHALL be taken from For codes, see US Public Health VaueSet - PlanDefinition Action (extensible to `http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-plandefinition-action` ) The set of actions that can be used to create plan definition
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()))
202. PlanDefinition.action:executeReportingWorkflow.action.trigger
Definition | A description of when the action should be triggered.
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()))
204. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable
Slice Name | isAmbulatoryEncounterReportable
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 | 10..1*
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
206. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.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 | 10..1
Type | string
Is Modifier | false
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `is-ambulatory-encounter-reportable`
208. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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())
210. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.code
Definition | A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.
Short | Code representing the meaning of the action or sub-actions
Control | 10..1*
Type | CodeableConcept
Is Modifier | false
Summary | false
Pattern Value | `{ "coding" : [{ "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions", "code" : "evaluate-condition" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
212. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
214. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
216. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.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 http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1 (required to `http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1` ) 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
Summary | false
Fixed Value | `applicability`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
218. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.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 | 10..1
Type | Expression
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()))
220. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.expression.language
Definition | The media type of the language for the expression.
Short | text/cql | text/fhirpath | application/x-fhir-query | etc.
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from ExpressionLanguage http://hl7.org/fhir/ValueSet/expression-language|4.0.1 (extensible to `http://hl7.org/fhir/ValueSet/expression-language|4.0.1` ) The media type of the expression language.
Additional Bindings | Purpose
http://www.rfc-editor.org/bcp/bcp13.txt | Max Binding
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Fixed Value | `text/fhirpath`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
222. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input
Definition | Defines input data requirements for the action. Required data is accessible via a context variable named `%[id]` using the `id` of the input data requirement Defines input data requirements for the action.
Short | Input data requirements
Control | 0..*
Type | DataRequirement
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()))
224. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.id
Definition | The id of the input requirement, allowing the data to be referenced via a context variable named `%[id]` 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 | 10..1
Type | string
Is Modifier | false
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
226. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.type
Definition | The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.
Short | The type of the required data
Control | 1..1
Binding | The codes SHALL be taken from FHIRAllTypes http://hl7.org/fhir/ValueSet/all-types|4.0.1 (required to `http://hl7.org/fhir/ValueSet/all-types|4.0.1` ) A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
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()))
228. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable
Slice Name | isInpatientEncounterReportable
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 | 10..1*
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
230. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.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 | 10..1
Type | string
Is Modifier | false
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `is-inpatient-encounter-reportable`
232. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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())
234. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.code
Definition | A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.
Short | Code representing the meaning of the action or sub-actions
Control | 10..1*
Type | CodeableConcept
Is Modifier | false
Summary | false
Pattern Value | `{ "coding" : [{ "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions", "code" : "evaluate-condition" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
236. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
238. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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())
240. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.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 http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1 (required to `http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1` ) 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
Summary | false
Fixed Value | `applicability`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
242. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.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 | 10..1
Type | Expression
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()))
244. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.expression.language
Definition | The media type of the language for the expression.
Short | text/cql | text/fhirpath | application/x-fhir-query | etc.
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from ExpressionLanguage http://hl7.org/fhir/ValueSet/expression-language|4.0.1 (extensible to `http://hl7.org/fhir/ValueSet/expression-language|4.0.1` ) The media type of the expression language.
Additional Bindings | Purpose
http://www.rfc-editor.org/bcp/bcp13.txt | Max Binding
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Fixed Value | `text/fhirpath`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
246. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input
Definition | Defines input data requirements for the action. Required data is accessible via a context variable named `%[id]` using the `id` of the input data requirement Defines input data requirements for the action.
Short | Input data requirements
Control | 0..*
Type | DataRequirement
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()))
248. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.id
Definition | The id of the input requirement, allowing the data to be referenced via a context variable named `%[id]` 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 | 10..1
Type | string
Is Modifier | false
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
250. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.type
Definition | The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.
Short | The type of the required data
Control | 1..1
Binding | The codes SHALL be taken from FHIRAllTypes http://hl7.org/fhir/ValueSet/all-types|4.0.1 (required to `http://hl7.org/fhir/ValueSet/all-types|4.0.1` ) A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
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()))
252. PlanDefinition.action:createReport
Slice Name | createReport
Definition | An action or group of actions to be taken as part of the plan.
Short | All constraints on action are intended to apply to any nested constraints.Action defined by the plan
Comments | Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.
Control | 10..1*
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
254. PlanDefinition.action:createReport.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 | 10..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Pattern Value | `create-hcs-report`
256. PlanDefinition.action:createReport.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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. 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())
258. PlanDefinition.action:createReport.description
Definition | A brief description of the action used to provide a summary to display to the user.
Short | Brief description of the action
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Pattern Value | `Create HCS report action.`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
260. PlanDefinition.action:createReport.code
Definition | A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.
Short | Code representing the meaning of the action or sub-actions
Control | 10..1*
Binding | Unless not suitable, these codes SHALL be taken from For codes, see US Public Health VaueSet - PlanDefinition Action (extensible to `http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-plandefinition-action` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Pattern Value | `{ "coding" : [{ "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions", "code" : "create-report" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
262. PlanDefinition.action:createReport.trigger
Definition | A description of when the action should be triggered.
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()))
264. PlanDefinition.action:createReport.trigger.extension:namedEventType
Slice Name | namedEventType
Definition | Indicates the types of named events to subscribe to from the EHR.
Short | US Public Health Named Event Type Extension
Control | 0..1
Type | Extension(US Public Health Named Event Type Extension) (Extension 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())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
266. PlanDefinition.action:createReport.trigger.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
Binding | The codes SHALL be taken from TriggerType http://hl7.org/fhir/ValueSet/trigger-type|4.0.1 (required to `http://hl7.org/fhir/ValueSet/trigger-type|4.0.1` ) The type of trigger.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Fixed Value | `named-event`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
268. PlanDefinition.action:createReport.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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
270. PlanDefinition.action:createReport.condition.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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. 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())
272. PlanDefinition.action:createReport.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 http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1 (required to `http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1` ) 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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
274. PlanDefinition.action:createReport.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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
276. PlanDefinition.action:createReport.input
Definition | Defines input data requirements for the action. Required data is accessible via a context variable named `%[id]` using the `id` of the input data requirement Defines input data requirements for the action.
Short | Input data requirements
Control | 0..*
Type | DataRequirement
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()))
278. PlanDefinition.action:createReport.input.id
Definition | The id of the input requirement, allowing the data to be referenced via a context variable named `%[id]` 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 | 10..1
Type | string
Is Modifier | false
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
280. PlanDefinition.action:createReport.input.type
Definition | The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.
Short | The type of the required data
Control | 1..1
Binding | The codes SHALL be taken from FHIRAllTypes http://hl7.org/fhir/ValueSet/all-types|4.0.1 (required to `http://hl7.org/fhir/ValueSet/all-types|4.0.1` ) A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
282. PlanDefinition.action:createReport.output
Definition | Defines output produced by the action. Required data is accessible via a context variable named `%[id]` using the `id` of the output data requirement Defines the outputs of the action, if any.
Short | Output data definition
Control | 0..*
Type | DataRequirement
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()))
284. PlanDefinition.action:createReport.output.id
Definition | The id of the output produced, allowing the data to be referenced via a context variable named `%[id]` 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 | 10..1
Type | string
Is Modifier | false
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
286. PlanDefinition.action:createReport.output.type
Definition | The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.
Short | The type of the required data
Control | 1..1
Binding | The codes SHALL be taken from FHIRAllTypes http://hl7.org/fhir/ValueSet/all-types|4.0.1 (required to `http://hl7.org/fhir/ValueSet/all-types|4.0.1` ) A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
288. PlanDefinition.action:createReport.relatedAction
Definition | A relationship to another action such as "before" or "30-60 minutes after start of".
Short | Relationship to another action
Comments | When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.
Control | 0..*
Type | BackboneElement
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()))
290. PlanDefinition.action:createReport.relatedAction.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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. 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())
292. PlanDefinition.action:createReport.relatedAction.actionId
Definition | The element id of the related action.
Short | What action is this related to
Control | 1..1
Type | id
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Fixed Value | `validate-hcs-report`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
294. PlanDefinition.action:createReport.relatedAction.relationship
Definition | The relationship of this action to the related action.
Short | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control | 1..1
Binding | The codes SHALL be taken from ActionRelationshipType http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1 (required to `http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1` ) 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 | true
Summary | false
Fixed Value | `before-start`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
296. PlanDefinition.action:createReport.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
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.relatedAction.offset[x]`. The slices areUnordered and Open, and can be differentiated using the following discriminators: type @ $this
298. PlanDefinition.action:createReport.relatedAction.offset[x]:offsetDuration
Slice Name | offsetDuration
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 | Duration, Range
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
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()))
300. PlanDefinition.action:createReport.timing[x]
Definition | An optional value describing when the action should be performed.
Short | When the action should take place
Control | 0..1
Type | Duration, dateTime, Period, Timing, Range, Age
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
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()))
302. PlanDefinition.action:validateReport
Slice Name | validateReport
Definition | An action or group of actions to be taken as part of the plan.
Short | All constraints on action are intended to apply to any nested constraints.Action defined by the plan
Comments | Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.
Control | 10..1*
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
304. PlanDefinition.action:validateReport.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 | 10..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Pattern Value | `validate-hcs-report`
306. PlanDefinition.action:validateReport.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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. 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())
308. PlanDefinition.action:validateReport.description
Definition | A brief description of the action used to provide a summary to display to the user.
Short | Brief description of the action
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Pattern Value | `Validate HCS report action.`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
310. PlanDefinition.action:validateReport.code
Definition | A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.
Short | Code representing the meaning of the action or sub-actions
Control | 0..1*
Binding | Unless not suitable, these codes SHALL be taken from For codes, see US Public Health VaueSet - PlanDefinition Action (extensible to `http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-plandefinition-action` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Pattern Value | `{ "coding" : [{ "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions", "code" : "validate-report" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
312. PlanDefinition.action:validateReport.trigger
Definition | A description of when the action should be triggered.
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()))
314. PlanDefinition.action:validateReport.trigger.extension:namedEventType
Slice Name | namedEventType
Definition | Indicates the types of named events to subscribe to from the EHR.
Short | US Public Health Named Event Type Extension
Control | 0..1
Type | Extension(US Public Health Named Event Type Extension) (Extension 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())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
316. PlanDefinition.action:validateReport.trigger.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
Binding | The codes SHALL be taken from TriggerType http://hl7.org/fhir/ValueSet/trigger-type|4.0.1 (required to `http://hl7.org/fhir/ValueSet/trigger-type|4.0.1` ) The type of trigger.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Fixed Value | `named-event`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
318. PlanDefinition.action:validateReport.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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
320. PlanDefinition.action:validateReport.condition.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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. 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.action:validateReport.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 http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1 (required to `http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1` ) 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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
324. PlanDefinition.action:validateReport.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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
326. PlanDefinition.action:validateReport.input
Definition | Defines input data requirements for the action. Required data is accessible via a context variable named `%[id]` using the `id` of the input data requirement Defines input data requirements for the action.
Short | Input data requirements
Control | 0..*
Type | DataRequirement
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()))
328. PlanDefinition.action:validateReport.input.id
Definition | The id of the input requirement, allowing the data to be referenced via a context variable named `%[id]` 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 | 10..1
Type | string
Is Modifier | false
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
330. PlanDefinition.action:validateReport.input.type
Definition | The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.
Short | The type of the required data
Control | 1..1
Binding | The codes SHALL be taken from FHIRAllTypes http://hl7.org/fhir/ValueSet/all-types|4.0.1 (required to `http://hl7.org/fhir/ValueSet/all-types|4.0.1` ) A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
332. PlanDefinition.action:validateReport.output
Definition | Defines output produced by the action. Required data is accessible via a context variable named `%[id]` using the `id` of the output data requirement Defines the outputs of the action, if any.
Short | Output data definition
Control | 0..*
Type | DataRequirement
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()))
334. PlanDefinition.action:validateReport.output.id
Definition | The id of the output produced, allowing the data to be referenced via a context variable named `%[id]` 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 | 10..1
Type | string
Is Modifier | false
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
336. PlanDefinition.action:validateReport.output.type
Definition | The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.
Short | The type of the required data
Control | 1..1
Binding | The codes SHALL be taken from FHIRAllTypes http://hl7.org/fhir/ValueSet/all-types|4.0.1 (required to `http://hl7.org/fhir/ValueSet/all-types|4.0.1` ) A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
338. PlanDefinition.action:validateReport.relatedAction
Definition | A relationship to another action such as "before" or "30-60 minutes after start of".
Short | Relationship to another action
Comments | When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.
Control | 0..*
Type | BackboneElement
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()))
340. PlanDefinition.action:validateReport.relatedAction.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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. 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())
342. PlanDefinition.action:validateReport.relatedAction.actionId
Definition | The element id of the related action.
Short | What action is this related to
Control | 1..1
Type | id
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Fixed Value | `submit-hcs-report`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
344. PlanDefinition.action:validateReport.relatedAction.relationship
Definition | The relationship of this action to the related action.
Short | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control | 1..1
Binding | The codes SHALL be taken from ActionRelationshipType http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1 (required to `http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1` ) 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 | true
Summary | false
Fixed Value | `before-start`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
346. PlanDefinition.action:validateReport.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
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.relatedAction.offset[x]`. The slices areUnordered and Open, and can be differentiated using the following discriminators: type @ $this
348. PlanDefinition.action:validateReport.relatedAction.offset[x]:offsetDuration
Slice Name | offsetDuration
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 | Duration, Range
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
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()))
350. PlanDefinition.action:validateReport.timing[x]
Definition | An optional value describing when the action should be performed.
Short | When the action should take place
Control | 0..1
Type | Duration, dateTime, Period, Timing, Range, Age
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
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()))
352. PlanDefinition.action:submitHcsReport
Slice Name | submitHcsReport
Definition | An action or group of actions to be taken as part of the plan.
Short | All constraints on action are intended to apply to any nested constraints.Action defined by the plan
Comments | Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.
Control | 10..1*
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
354. PlanDefinition.action:submitHcsReport.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 | 10..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Pattern Value | `submit-hcs-report`
356. PlanDefinition.action:submitHcsReport.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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. 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())
358. PlanDefinition.action:submitHcsReport.description
Definition | A brief description of the action used to provide a summary to display to the user.
Short | Brief description of the action
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Pattern Value | `Submit HCS report action.`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
360. PlanDefinition.action:submitHcsReport.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 | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Fixed Value | `Route and send HCS Report`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
362. PlanDefinition.action:submitHcsReport.code
Definition | A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.
Short | Code representing the meaning of the action or sub-actions
Control | 0..1*
Binding | Unless not suitable, these codes SHALL be taken from For codes, see US Public Health VaueSet - PlanDefinition Action (extensible to `http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-plandefinition-action` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Pattern Value | `{ "coding" : [{ "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions", "code" : "submit-report" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
364. PlanDefinition.action:submitHcsReport.trigger
Definition | A description of when the action should be triggered.
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()))
366. PlanDefinition.action:submitHcsReport.trigger.extension:namedEventType
Slice Name | namedEventType
Definition | Indicates the types of named events to subscribe to from the EHR.
Short | US Public Health Named Event Type Extension
Control | 0..1
Type | Extension(US Public Health Named Event Type Extension) (Extension 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())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
368. PlanDefinition.action:submitHcsReport.trigger.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
Binding | The codes SHALL be taken from TriggerType http://hl7.org/fhir/ValueSet/trigger-type|4.0.1 (required to `http://hl7.org/fhir/ValueSet/trigger-type|4.0.1` ) The type of trigger.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Fixed Value | `named-event`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
370. PlanDefinition.action:submitHcsReport.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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
372. PlanDefinition.action:submitHcsReport.condition.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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. 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())
374. PlanDefinition.action:submitHcsReport.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 http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1 (required to `http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1` ) 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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
376. PlanDefinition.action:submitHcsReport.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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
378. PlanDefinition.action:submitHcsReport.input
Definition | Defines input data requirements for the action. Required data is accessible via a context variable named `%[id]` using the `id` of the input data requirement Defines input data requirements for the action.
Short | Input data requirements
Control | 0..*
Type | DataRequirement
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:submitHcsReport.input.id
Definition | The id of the input requirement, allowing the data to be referenced via a context variable named `%[id]` 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 | 10..1
Type | string
Is Modifier | false
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
382. PlanDefinition.action:submitHcsReport.input.type
Definition | The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.
Short | The type of the required data
Control | 1..1
Binding | The codes SHALL be taken from FHIRAllTypes http://hl7.org/fhir/ValueSet/all-types|4.0.1 (required to `http://hl7.org/fhir/ValueSet/all-types|4.0.1` ) A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
384. PlanDefinition.action:submitHcsReport.output
Definition | Defines the outputs of the action, if any.
Short | Output data definition
Control | 0..*
Type | DataRequirement
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()))
386. PlanDefinition.action:submitHcsReport.output.type
Definition | The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.
Short | The type of the required data
Control | 1..1
Binding | The codes SHALL be taken from FHIRAllTypes http://hl7.org/fhir/ValueSet/all-types|4.0.1 (required to `http://hl7.org/fhir/ValueSet/all-types|4.0.1` ) A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
388. PlanDefinition.action:submitHcsReport.relatedAction
Definition | A relationship to another action such as "before" or "30-60 minutes after start of".
Short | Relationship to another action
Comments | When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.
Control | 0..*
Type | BackboneElement
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()))
390. PlanDefinition.action:submitHcsReport.relatedAction.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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. 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())
392. PlanDefinition.action:submitHcsReport.relatedAction.actionId
Definition | The element id of the related action.
Short | What action is this related to
Control | 1..1
Type | id
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()))
394. PlanDefinition.action:submitHcsReport.relatedAction.relationship
Definition | The relationship of this action to the related action.
Short | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control | 1..1
Binding | The codes SHALL be taken from ActionRelationshipType http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1 (required to `http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1` ) 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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
396. PlanDefinition.action:submitHcsReport.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
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.relatedAction.offset[x]`. The slices areUnordered and Open, and can be differentiated using the following discriminators: type @ $this
398. PlanDefinition.action:submitHcsReport.relatedAction.offset[x]:offsetDuration
Slice Name | offsetDuration
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 | Duration, Range
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
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()))
400. PlanDefinition.action:submitHcsReport.timing[x]
Definition | An optional value describing when the action should be performed.
Short | When the action should take place
Control | 0..1
Type | Duration, dateTime, Period, Timing, Range, Age
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

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

0. PlanDefinition
Definition | This PlanDefinition profile defines the logic and rules around determining whether or not data from an encounter is reportable to National Center for Health Statistics (NCHS).
Short | Health Care Surveys Knowledge Artifact
2. PlanDefinition.action
Control | 5..?
Slicing | This element introduces a set of slices on `PlanDefinition.action`. The slices areOrdered and Open, and can be differentiated using the following discriminators: value @ id
4. PlanDefinition.action.code
Binding | Unless not suitable, these codes SHALL be taken from US Public Health VaueSet - PlanDefinition Action (extensible to `http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-plandefinition-action` )
6. PlanDefinition.action:startWorkflow
Slice Name | startWorkflow
Control | 1..1
8. PlanDefinition.action:startWorkflow.id
Control | 1..?
Pattern Value | `start-workflow`
10. PlanDefinition.action:startWorkflow.description
Pattern Value | `Start the workflow action.`
12. PlanDefinition.action:startWorkflow.textEquivalent
Definition | Text equivalent of the start workflow action.
Short | Text equivalent of the start workflow action.
Control | 1..?
Must Support | true
Fixed Value | `Start the reporting workflow in response to an encounter-end event`
14. PlanDefinition.action:startWorkflow.code
Definition | The US-PH-PlanDefinition-Action code for the start action.
Short | Code for the start action.
Control | 1..?
Pattern Value | `{ "coding" : [{ "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions", "code" : "initiate-reporting-workflow" }] }`
16. PlanDefinition.action:startWorkflow.trigger
Definition | When the start action should be triggered.
Short | When the start action should be triggered.
Control | 1..?
18. PlanDefinition.action:startWorkflow.trigger.extension:namedEventType
Slice Name | namedEventType
Short | Indicates the types of named events to subscribe to from the EHR.
20. PlanDefinition.action:startWorkflow.trigger.name
Definition | The name of the event, encounter-end in this case. For any action invoked as a result of this trigger, the triggering encounter is accessible via the context variable `%encounter`
Fixed Value | `encounter-end`
22. PlanDefinition.action:startWorkflow.relatedAction
Control | 1..1
24. PlanDefinition.action:startWorkflow.relatedAction.actionId
Fixed Value | `check-reportability`
26. PlanDefinition.action:startWorkflow.relatedAction.relationship
Fixed Value | `before-start`
28. PlanDefinition.action:startWorkflow.relatedAction.offset[x]:offsetDuration
Slice Name | offsetDuration
Type | Duration
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Example | Wait 72 hour before next action.: { "value" : 72, "unit" : "h" }
30. PlanDefinition.action:executeReportingWorkflow
Slice Name | executeReportingWorkflow
Control | 1..1
32. PlanDefinition.action:executeReportingWorkflow.id
Control | 1..?
Pattern Value | `check-reportability`
34. PlanDefinition.action:executeReportingWorkflow.description
Pattern Value | `Execute reporting workflow action.`
36. PlanDefinition.action:executeReportingWorkflow.code
Definition | The US-PH-PlanDefinition-Action code for the execute-reporting-workflow action.
Short | Code for the execute-reporting-workflow action.
Control | 1..?
Pattern Value | `{ "coding" : [{ "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions", "code" : "execute-reporting-workflow" }] }`
38. PlanDefinition.action:executeReportingWorkflow.trigger
40. PlanDefinition.action:executeReportingWorkflow.trigger.extension:namedEventType
Slice Name | namedEventType
42. PlanDefinition.action:executeReportingWorkflow.action
Control | 2..?
Slicing | This element introduces a set of slices on `PlanDefinition.action.action`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ id
44. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable
Slice Name | isAmbulatoryEncounterReportable
Control | 1..1
Type | BackboneElement
Must Support | true
46. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.id
Control | 1..?
Must Support | true
Fixed Value | `is-ambulatory-encounter-reportable`
48. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.code
Control | 1..1
Pattern Value | `{ "coding" : [{ "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions", "code" : "evaluate-condition" }] }`
50. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition
52. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.kind
Fixed Value | `applicability`
54. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.expression
Control | 1..?
Must Support | true
56. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.expression.language
Fixed Value | `text/fhirpath`
58. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input
Definition | Defines input data requirements for the action. Required data is accessible via a context variable named `%[id]` using the `id` of the input data requirement
Must Support | true
60. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.id
Definition | The id of the input requirement, allowing the data to be referenced via a context variable named `%[id]`
Control | 1..?
Must Support | true
62. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.relatedAction
64. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.relatedAction.actionId
Fixed Value | `create-hcs-report`
66. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.relatedAction.relationship
Fixed Value | `before-start`
68. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable
Slice Name | isInpatientEncounterReportable
Control | 1..1
Type | BackboneElement
Must Support | true
70. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.id
Control | 1..?
Must Support | true
Fixed Value | `is-inpatient-encounter-reportable`
72. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.code
Control | 1..1
Pattern Value | `{ "coding" : [{ "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions", "code" : "evaluate-condition" }] }`
74. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition
76. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.kind
Fixed Value | `applicability`
78. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.expression
Control | 1..?
Must Support | true
80. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.expression.language
Fixed Value | `text/fhirpath`
82. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input
Definition | Defines input data requirements for the action. Required data is accessible via a context variable named `%[id]` using the `id` of the input data requirement
Must Support | true
84. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.id
Definition | The id of the input requirement, allowing the data to be referenced via a context variable named `%[id]`
Control | 1..?
Must Support | true
86. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.relatedAction
88. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.relatedAction.actionId
Fixed Value | `create-hcs-report`
90. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.relatedAction.relationship
Fixed Value | `before-start`
92. PlanDefinition.action:createReport
Slice Name | createReport
Control | 1..1
94. PlanDefinition.action:createReport.id
Control | 1..?
Pattern Value | `create-hcs-report`
96. PlanDefinition.action:createReport.description
Pattern Value | `Create HCS report action.`
98. PlanDefinition.action:createReport.code
Control | 1..?
Pattern Value | `{ "coding" : [{ "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions", "code" : "create-report" }] }`
100. PlanDefinition.action:createReport.trigger
102. PlanDefinition.action:createReport.trigger.extension:namedEventType
Slice Name | namedEventType
104. PlanDefinition.action:createReport.input
Definition | Defines input data requirements for the action. Required data is accessible via a context variable named `%[id]` using the `id` of the input data requirement
106. PlanDefinition.action:createReport.input.id
Definition | The id of the input requirement, allowing the data to be referenced via a context variable named `%[id]`
Control | 1..?
Must Support | true
108. PlanDefinition.action:createReport.output
Definition | Defines output produced by the action. Required data is accessible via a context variable named `%[id]` using the `id` of the output data requirement
110. PlanDefinition.action:createReport.output.id
Definition | The id of the output produced, allowing the data to be referenced via a context variable named `%[id]`
Control | 1..?
Must Support | true
112. PlanDefinition.action:createReport.relatedAction
114. PlanDefinition.action:createReport.relatedAction.actionId
Fixed Value | `validate-hcs-report`
116. PlanDefinition.action:createReport.relatedAction.relationship
Fixed Value | `before-start`
118. PlanDefinition.action:validateReport
Slice Name | validateReport
Control | 1..1
120. PlanDefinition.action:validateReport.id
Control | 1..?
Pattern Value | `validate-hcs-report`
122. PlanDefinition.action:validateReport.description
Pattern Value | `Validate HCS report action.`
124. PlanDefinition.action:validateReport.code
Pattern Value | `{ "coding" : [{ "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions", "code" : "validate-report" }] }`
126. PlanDefinition.action:validateReport.trigger
128. PlanDefinition.action:validateReport.trigger.extension:namedEventType
Slice Name | namedEventType
130. PlanDefinition.action:validateReport.input
Definition | Defines input data requirements for the action. Required data is accessible via a context variable named `%[id]` using the `id` of the input data requirement
132. PlanDefinition.action:validateReport.input.id
Definition | The id of the input requirement, allowing the data to be referenced via a context variable named `%[id]`
Control | 1..?
Must Support | true
134. PlanDefinition.action:validateReport.output
Definition | Defines output produced by the action. Required data is accessible via a context variable named `%[id]` using the `id` of the output data requirement
136. PlanDefinition.action:validateReport.output.id
Definition | The id of the output produced, allowing the data to be referenced via a context variable named `%[id]`
Control | 1..?
Must Support | true
138. PlanDefinition.action:validateReport.relatedAction
140. PlanDefinition.action:validateReport.relatedAction.actionId
Fixed Value | `submit-hcs-report`
142. PlanDefinition.action:validateReport.relatedAction.relationship
Fixed Value | `before-start`
144. PlanDefinition.action:submitHcsReport
Slice Name | submitHcsReport
Control | 1..1
146. PlanDefinition.action:submitHcsReport.id
Control | 1..?
Pattern Value | `submit-hcs-report`
148. PlanDefinition.action:submitHcsReport.description
Pattern Value | `Submit HCS report action.`
150. PlanDefinition.action:submitHcsReport.textEquivalent
Control | 1..?
Must Support | true
Fixed Value | `Route and send HCS Report`
152. PlanDefinition.action:submitHcsReport.code
Pattern Value | `{ "coding" : [{ "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions", "code" : "submit-report" }] }`
154. PlanDefinition.action:submitHcsReport.trigger
156. PlanDefinition.action:submitHcsReport.trigger.extension:namedEventType
Slice Name | namedEventType
158. PlanDefinition.action:submitHcsReport.input
Definition | Defines input data requirements for the action. Required data is accessible via a context variable named `%[id]` using the `id` of the input data requirement
160. PlanDefinition.action:submitHcsReport.input.id
Definition | The id of the input requirement, allowing the data to be referenced via a context variable named `%[id]`
Control | 1..?
Must Support | true

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

0. PlanDefinition
Definition | This PlanDefinition profile defines the logic and rules around determining whether or not data from an encounter is reportable to National Center for Health Statistics (NCHS).
Short | Health Care Surveys Knowledge Artifact
Control | 1..1
Is Modifier | false
Summary | false
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (`contained.contained.empty()`) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (`contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (`contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (`contained.meta.security.empty()`) dom-6: A resource should have narrative for robust management (`text.`div`.exists()`) pdf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (`name.matches('[A-Z]([A-Za-z0-9_]){0,254}')`)
2. PlanDefinition.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short | Logical id of this artifact
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Control | 0..1
Type | id
Is Modifier | 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
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 it's 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 it's meaning or interpretation
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())`)
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 SHOULD be taken from CommonLanguages (preferred to `http://hl7.org/fhir/ValueSet/languages` ) A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
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())`)
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 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
Type | Narrative
Is Modifier | 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, and nor can they have their own independent transaction scope.
Short | Contained, inline Resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Control | 0..*
Type | Resource
Is Modifier | 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
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:receiverAddress
Slice Name | receiverAddress
Definition | Indicates the address where the report has to be sent.
Short | Indicates the address where the report has to be sent.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(US Public Health Receiver Address Extension) (Extension Type: Reference(Endpoint))
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
18. PlanDefinition.extension:asyncIndicator
Slice Name | asyncIndicator
Definition | An Extension
Short | US Public Health Async Indicator Extension
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(US Public Health Async Indicator Extension) (Extension Type: boolean)
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
20. PlanDefinition.extension:contentEncrypted
Slice Name | contentEncrypted
Definition | Indicates whether the data in the content bundle is encrypted or not.
Short | US Public Health Data Encrypted Extension
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(US Public Health Data Encrypted Extension) (Extension Type: boolean)
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
22. PlanDefinition.extension:jwksForContentEncryption
Slice Name | jwksForContentEncryption
Definition | An Extension
Short | US Public Health Receiver Jwks Url
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(US Public Health Receiver JWKS Url Extension) (Extension Type: url)
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
24. PlanDefinition.extension:contentEncryptionAlgorithm
Slice Name | contentEncryptionAlgorithm
Definition | An Extension
Short | US Public Health Data Encryption Algorithm
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(US Public Health Data Encryption Algorithm Extension) (Extension Type: code)
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
26. PlanDefinition.extension:expectedResponseDuration
Slice Name | expectedResponseDuration
Definition | An Extension
Short | US Public Health Expected Response Time Extension
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(US Public Health Expected Response Time Extension) (Extension Type: Duration)
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
28. PlanDefinition.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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
Summary | false
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
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.url
Definition | An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different servers.
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 | 1..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the plan definition to be referenced by a single globally unique identifier.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
32. PlanDefinition.identifier
Definition | A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
Short | Additional identifier for the plan definition
Comments | Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this plan definition outside of FHIR, where it is not possible to use the logical URI.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Is Modifier | false
Must Support | true
Summary | true
Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
34. PlanDefinition.version
Definition | Business version of the PlanDefinition
Short | Business version of the PlanDefinition
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].
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
36. PlanDefinition.name
Definition | Name for this PlanDefinition (computer friendly)
Short | Name for this PlanDefinition (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 | 1..1 This element is affected by the following invariants: inv-0
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
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())`)
38. PlanDefinition.title
Definition | Title for this PlanDefinition
Short | Title for this PlanDefinition
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
40. 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
42. PlanDefinition.type
Definition | Type of this PlanDefinition
Short | Type of this PlanDefinition
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from PlanDefinitionType (extensible to `http://hl7.org/fhir/ValueSet/plan-definition-type` ) The type of PlanDefinition.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | true
Pattern Value | `{ "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/plan-definition-type", "code" : "workflow-definition", "display" : "Workflow Definition" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
44. 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.
Control | 1..1
Binding | The codes SHALL be taken from PublicationStatus (required to `http://hl7.org/fhir/ValueSet/publication-status|4.0.1` ) 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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
46. 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 | 1..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level plan definition.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
48. PlanDefinition.subject[x]
Definition | A code or group definition that describes the intended subject of the plan definition.
Short | Type of individual the plan definition is focused on
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from SubjectType (extensible to `http://hl7.org/fhir/ValueSet/subject-type` ) The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
Type | Choice of: CodeableConcept, Reference(Group)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Summary | false
Meaning if Missing | Patient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
50. PlanDefinition.date
Definition | Date the PlanDefinition was last changed
Short | Date the PlanDefinition was last changed
Comments | Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the plan definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
Control | 1..1
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Alternate Names | Revision Date
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
52. PlanDefinition.publisher
Definition | Name of the agency that published this PlanDefinition
Short | Name of the agency that published this PlanDefinition
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 | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Helps establish the "authority/credibility" of the plan definition. May also allow for contact.
Alternate Names | steward
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
54. PlanDefinition.contact
Definition | Contact details to assist a user in finding and communicating with the publisher.
Short | Contact details for the publisher
Comments | May be a web site, an email address, a telephone number, etc.
Control | 0..*
Type | ContactDetail
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.description
Definition | A free text natural language description of the plan definition from a consumer's perspective.
Short | Natural language description of the plan definition
Comments | This description can be used to capture details such as why the plan definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the plan definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the plan definition is presumed to be the predominant language in the place the plan definition was created).
Control | 1..1
Type | markdown
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Alternate Names | scope
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
58. PlanDefinition.useContext
Definition | The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances.
Short | The context that the content is intended to support
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
Control | 0..*
Type | UsageContext
Is Modifier | false
Must Support | 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())`)
60. PlanDefinition.jurisdiction
Definition | A legal or geographic region in which the plan definition is intended to be used.
Short | Intended jurisdiction for plan definition (if applicable)
Comments | It may be possible for the plan definition to be used in jurisdictions other than those for which it was originally designed or intended.
Control | 0..*
Binding | Unless not suitable, these codes SHALL be taken from Jurisdiction ValueSet (extensible to `http://hl7.org/fhir/ValueSet/jurisdiction` ) Countries and regions within which this artifact is targeted for use.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
62. 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
64. PlanDefinition.usage
Definition | A detailed description of how the plan definition is used from a clinical perspective.
Short | Describes the clinical usage of the plan
Control | 0..1
Type | string
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())`)
66. PlanDefinition.copyright
Definition | A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition.
Short | Use and/or publishing restrictions
Control | 0..1
Type | markdown
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
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())`)
68. 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.
Control | 0..1
Type | date
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())`)
70. 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
Comments | If specified, this date follows the original approval date.
Control | 0..1
Type | date
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
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())`)
72. PlanDefinition.effectivePeriod
Definition | The period during which the PlanDefinition is valid
Short | When the PlanDefinition is valid
Comments | The effective period for a plan definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.
Control | 0..1
Type | Period
Is Modifier | false
Must Support | true
Summary | true
Requirements | Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the plan definition are or are expected to be used instead.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
74. PlanDefinition.effectivePeriod.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
76. PlanDefinition.effectivePeriod.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.effectivePeriod.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
78. PlanDefinition.effectivePeriod.start
Definition | The start of the time period when this PlanDefinition goes into effect
Short | The start of the time period when this PlanDefinition goes into effect
Comments | If the low element is missing, the meaning is that the low boundary is not known.
Control | 1..1 This element is affected by the following invariants: per-1
Type | dateTime
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.effectivePeriod.end
Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
Short | End time with inclusive boundary, if not ongoing
Comments | The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Control | 0..1 This element is affected by the following invariants: per-1
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Meaning if Missing | If the end of the period is missing, it means that the period is ongoing
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
82. PlanDefinition.topic
Definition | Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching.
Short | E.g. Education, Treatment, Assessment
Control | 0..*
Binding | For example codes, see DefinitionTopic (example to `http://hl7.org/fhir/ValueSet/definition-topic` ) High-level categorization of the definition, used for searching, sorting, and filtering.
Type | CodeableConcept
Is Modifier | false
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())`)
84. 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
86. 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
88. PlanDefinition.reviewer
Definition | An individual or organization primarily responsible for review of some aspect of the content.
Short | Who reviewed the content
Control | 0..*
Type | ContactDetail
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
90. PlanDefinition.endorser
Definition | An individual or organization responsible for officially endorsing the content for use in some setting.
Short | Who endorsed the content
Control | 0..*
Type | ContactDetail
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
92. 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
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.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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
96. PlanDefinition.goal
Definition | Goals that describe what the activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.
Short | What the plan is trying to accomplish
Control | 0..*
Type | BackboneElement
Is Modifier | 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())`)
98. 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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
100. PlanDefinition.goal.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
102. PlanDefinition.goal.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
104. 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` ) Example codes for grouping goals for filtering or presentation.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
106. PlanDefinition.goal.description
Definition | Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding".
Short | Code or text describing the goal
Comments | If no code is available, use CodeableConcept.text.
Control | 1..1
Binding | For example codes, see SNOMEDCTClinicalFindings (example to `http://hl7.org/fhir/ValueSet/clinical-findings` ) Describes goals that can be achieved.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
108. 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` ) Indicates the level of importance associated with reaching or sustaining a goal.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
110. PlanDefinition.goal.start
Definition | The event after which the goal should begin being pursued.
Short | When goal pursuit begins
Control | 0..1
Binding | For example codes, see GoalStartEvent (example to `http://hl7.org/fhir/ValueSet/goal-start-event` ) Identifies the types of events that might trigger the start of a goal.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
112. PlanDefinition.goal.addresses
Definition | Identifies problems, conditions, issues, or concerns the goal is intended to address.
Short | What does the goal address
Control | 0..*
Binding | For example codes, see Condition/Problem/DiagnosisCodes (example to `http://hl7.org/fhir/ValueSet/condition-code` ) Identifies problems, conditions, issues, or concerns that goals may address.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
114. 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
116. 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
118. 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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
120. PlanDefinition.goal.target.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
122. PlanDefinition.goal.target.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
124. PlanDefinition.goal.target.measure
Definition | The parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.
Short | The parameter whose value is to be tracked
Control | 0..1
Binding | For example codes, see LOINCCodes (example to `http://hl7.org/fhir/ValueSet/observation-codes` ) Identifies types of parameters that can be tracked to determine goal achievement.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
126. PlanDefinition.goal.target.detail[x]
Definition | The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.
Short | The target value to be achieved
Control | 0..1
Type | Choice of: Quantity, Range, CodeableConcept
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
128. 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
130. PlanDefinition.action
Definition | An action or group of actions to be taken as part of the plan.
Short | All constraints on action are intended to apply to any nested constraints.
Comments | Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.
Control | 5..*
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `PlanDefinition.action`. The slices areOrdered and Open, and can be differentiated using the following discriminators: value @ id
132. 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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
134. PlanDefinition.action.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
136. PlanDefinition.action.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
138. PlanDefinition.action.prefix
Definition | A user-visible prefix for the action.
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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
140. PlanDefinition.action.title
Definition | The title of the action displayed to a user.
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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
142. PlanDefinition.action.description
Definition | A brief description of the action used to provide a summary to display to the user.
Short | Brief description of the action
Control | 0..1
Type | string
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())`)
144. 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 | string
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())`)
146. PlanDefinition.action.priority
Definition | Indicates how quickly the action should be addressed with respect to other actions.
Short | routine | urgent | asap | stat
Control | 0..1
Binding | The codes SHALL be taken from RequestPriority (required to `http://hl7.org/fhir/ValueSet/request-priority|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
148. PlanDefinition.action.code
Definition | A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.
Short | Code representing the meaning of the action or sub-actions
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from US Public Health VaueSet - PlanDefinition Action (extensible to `http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-plandefinition-action` )
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())`)
150. PlanDefinition.action.reason
Definition | A description of why this action is necessary or appropriate.
Short | Why the action should be performed
Comments | This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action.
Control | 0..*
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
152. 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
154. PlanDefinition.action.goalId
Definition | Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.
Short | What goals this action supports
Control | 0..*
Type | id
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())`)
156. PlanDefinition.action.subject[x]
Definition | A code or group definition that describes the intended subject of the action and its children, if any.
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 SubjectType (extensible to `http://hl7.org/fhir/ValueSet/subject-type` ) The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
Type | Choice of: CodeableConcept, Reference(Group)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | 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())`)
158. PlanDefinition.action.trigger
Definition | A description of when the action should be triggered.
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())`)
160. PlanDefinition.action.trigger.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
162. PlanDefinition.action.trigger.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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
164. PlanDefinition.action.trigger.extension:namedEventType
Slice Name | namedEventType
Definition | Indicates the types of named events to subscribe to from the EHR.
Short | US Public Health Named Event Type Extension
Control | 0..1
Type | Extension(US Public Health Named Event Type Extension) (Extension 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())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
166. PlanDefinition.action.trigger.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
Binding | The codes SHALL be taken from TriggerType (required to `http://hl7.org/fhir/ValueSet/trigger-type|4.0.1` ) The type of trigger.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Fixed Value | `named-event`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
168. PlanDefinition.action.trigger.name
Definition | 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 | 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())`)
170. PlanDefinition.action.trigger.timing[x]
Definition | The timing of the event (if this is a periodic trigger).
Short | Timing of the event
Control | 0..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())`)
172. PlanDefinition.action.trigger.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..*
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())`)
174. PlanDefinition.action.trigger.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
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())`)
176. 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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
178. 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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
180. PlanDefinition.action.condition.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
182. PlanDefinition.action.condition.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
184. 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|4.0.1` ) 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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
186. 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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
188. PlanDefinition.action.input
Definition | Defines input data requirements for the action.
Short | Input data requirements
Control | 0..*
Type | DataRequirement
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())`)
190. 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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
192. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.input.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
194. PlanDefinition.action.input.type
Definition | The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.
Short | The type of the required data
Control | 1..1
Binding | The codes SHALL be taken from FHIRAllTypes (required to `http://hl7.org/fhir/ValueSet/all-types|4.0.1` ) A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
196. PlanDefinition.action.input.profile
Definition | The profile of the required data, specified as the uri of the profile definition.
Short | The profile of the required data
Control | 0..*
Type | canonical(StructureDefinition)
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())`)
198. PlanDefinition.action.input.subject[x]
Definition | The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.
Short | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments | The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from SubjectType (extensible to `http://hl7.org/fhir/ValueSet/subject-type` ) The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
Type | Choice of: CodeableConcept, Reference(Group)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
Meaning if Missing | Patient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
200. PlanDefinition.action.input.mustSupport
Definition | Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).
Short | Indicates specific structure elements that are referenced by the knowledge module
Control | 0..*
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())`)
202. PlanDefinition.action.input.codeFilter
Definition | Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.
Short | What codes are expected
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Invariants | drq-1: Either a path or a searchParam must be provided, but not both (`path.exists() xor searchParam.exists()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
204. PlanDefinition.action.input.codeFilter.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
206. PlanDefinition.action.input.codeFilter.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.input.codeFilter.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
208. PlanDefinition.action.input.codeFilter.path
Definition | The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.
Short | A code-valued attribute to filter on
Comments | 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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
210. PlanDefinition.action.input.codeFilter.searchParam
Definition | A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.
Short | A coded (token) parameter to search on
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())`)
212. PlanDefinition.action.input.codeFilter.valueSet
Definition | The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.
Short | Valueset for the filter
Control | 0..1
Type | canonical(ValueSet)
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.action.input.codeFilter.code
Definition | The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.
Short | What code is expected
Control | 0..*
Type | Coding
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
216. PlanDefinition.action.input.dateFilter
Definition | Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.
Short | What dates/date ranges are expected
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Invariants | drq-2: Either a path or a searchParam must be provided, but not both (`path.exists() xor searchParam.exists()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
218. PlanDefinition.action.input.dateFilter.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
220. PlanDefinition.action.input.dateFilter.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.input.dateFilter.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
222. PlanDefinition.action.input.dateFilter.path
Definition | The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.
Short | A date-valued attribute to filter on
Comments | The path attribute contains a Simple FHIR 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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
224. PlanDefinition.action.input.dateFilter.searchParam
Definition | A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.
Short | A date valued parameter to search on
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.action.input.dateFilter.value[x]
Definition | The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.
Short | The value of the filter, as a Period, DateTime, or Duration value
Control | 0..1
Type | Choice of: dateTime, Period, Duration
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
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.action.input.limit
Definition | Specifies a maximum number of results that are required (uses the _count search parameter).
Short | Number of results
Comments | This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".
Control | 0..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Enables the requirement "most recent 5 results" to be expressed.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
230. PlanDefinition.action.input.sort
Definition | Specifies the order of the results to be returned.
Short | Order of the results
Comments | This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Requirements | Enables the requirement "most recent 5 results" to be expressed.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
232. PlanDefinition.action.input.sort.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
234. PlanDefinition.action.input.sort.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.input.sort.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
236. PlanDefinition.action.input.sort.path
Definition | The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.
Short | The name of the attribute to perform the sort
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())`)
238. PlanDefinition.action.input.sort.direction
Definition | The direction of the sort, ascending or descending.
Short | ascending | descending
Control | 1..1
Binding | The codes SHALL be taken from SortDirection (required to `http://hl7.org/fhir/ValueSet/sort-direction|4.0.1` ) The possible sort directions, ascending or descending.
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())`)
240. PlanDefinition.action.output
Definition | Defines the outputs of the action, if any.
Short | Output data definition
Control | 0..*
Type | DataRequirement
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())`)
242. 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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
244. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.output.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
246. PlanDefinition.action.output.type
Definition | The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.
Short | The type of the required data
Control | 1..1
Binding | The codes SHALL be taken from FHIRAllTypes (required to `http://hl7.org/fhir/ValueSet/all-types|4.0.1` ) A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
248. PlanDefinition.action.output.profile
Definition | The profile of the required data, specified as the uri of the profile definition.
Short | The profile of the required data
Control | 0..*
Type | canonical(StructureDefinition)
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())`)
250. PlanDefinition.action.output.subject[x]
Definition | The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.
Short | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments | The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from SubjectType (extensible to `http://hl7.org/fhir/ValueSet/subject-type` ) The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
Type | Choice of: CodeableConcept, Reference(Group)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
Meaning if Missing | Patient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
252. PlanDefinition.action.output.mustSupport
Definition | Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).
Short | Indicates specific structure elements that are referenced by the knowledge module
Control | 0..*
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.action.output.codeFilter
Definition | Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.
Short | What codes are expected
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Invariants | drq-1: Either a path or a searchParam must be provided, but not both (`path.exists() xor searchParam.exists()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
256. PlanDefinition.action.output.codeFilter.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
258. PlanDefinition.action.output.codeFilter.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.output.codeFilter.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
260. PlanDefinition.action.output.codeFilter.path
Definition | The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.
Short | A code-valued attribute to filter on
Comments | 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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
262. PlanDefinition.action.output.codeFilter.searchParam
Definition | A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.
Short | A coded (token) parameter to search on
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())`)
264. PlanDefinition.action.output.codeFilter.valueSet
Definition | The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.
Short | Valueset for the filter
Control | 0..1
Type | canonical(ValueSet)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
266. PlanDefinition.action.output.codeFilter.code
Definition | The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.
Short | What code is expected
Control | 0..*
Type | Coding
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
268. PlanDefinition.action.output.dateFilter
Definition | Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.
Short | What dates/date ranges are expected
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Invariants | drq-2: Either a path or a searchParam must be provided, but not both (`path.exists() xor searchParam.exists()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
270. PlanDefinition.action.output.dateFilter.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
272. PlanDefinition.action.output.dateFilter.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.output.dateFilter.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
274. PlanDefinition.action.output.dateFilter.path
Definition | The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.
Short | A date-valued attribute to filter on
Comments | The path attribute contains a Simple FHIR 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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
276. PlanDefinition.action.output.dateFilter.searchParam
Definition | A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.
Short | A date valued parameter to search on
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.action.output.dateFilter.value[x]
Definition | The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.
Short | The value of the filter, as a Period, DateTime, or Duration value
Control | 0..1
Type | Choice of: dateTime, Period, Duration
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
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.action.output.limit
Definition | Specifies a maximum number of results that are required (uses the _count search parameter).
Short | Number of results
Comments | This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".
Control | 0..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Enables the requirement "most recent 5 results" to be expressed.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
282. PlanDefinition.action.output.sort
Definition | Specifies the order of the results to be returned.
Short | Order of the results
Comments | This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Requirements | Enables the requirement "most recent 5 results" to be expressed.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
284. PlanDefinition.action.output.sort.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
286. PlanDefinition.action.output.sort.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.output.sort.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
288. PlanDefinition.action.output.sort.path
Definition | The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.
Short | The name of the attribute to perform the sort
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())`)
290. PlanDefinition.action.output.sort.direction
Definition | The direction of the sort, ascending or descending.
Short | ascending | descending
Control | 1..1
Binding | The codes SHALL be taken from SortDirection (required to `http://hl7.org/fhir/ValueSet/sort-direction|4.0.1` ) The possible sort directions, ascending or descending.
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())`)
292. PlanDefinition.action.relatedAction
Definition | A relationship to another action such as "before" or "30-60 minutes after start of".
Short | Relationship to another action
Comments | When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.
Control | 0..*
Type | BackboneElement
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())`)
294. 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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
296. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
298. PlanDefinition.action.relatedAction.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
300. PlanDefinition.action.relatedAction.actionId
Definition | The element id of the related action.
Short | What action is this related to
Control | 1..1
Type | id
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())`)
302. PlanDefinition.action.relatedAction.relationship
Definition | The relationship of this action to the related action.
Short | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control | 1..1
Binding | The codes SHALL be taken from ActionRelationshipType (required to `http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1` ) 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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
304. 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
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.relatedAction.offset[x]`. The slices areUnordered and Open, and can be differentiated using the following discriminators: type @ $this
306. PlanDefinition.action.relatedAction.offset[x]:offsetDuration
Slice Name | offsetDuration
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 | Duration
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
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())`)
308. PlanDefinition.action.timing[x]
Definition | An optional value describing when the action should be performed.
Short | When the action should take place
Control | 0..1
Type | Duration
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
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())`)
310. PlanDefinition.action.participant
Definition | Indicates who should participate in performing the action described.
Short | Who should participate in the action
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
312. PlanDefinition.action.participant.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
314. PlanDefinition.action.participant.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
316. PlanDefinition.action.participant.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
318. PlanDefinition.action.participant.type
Definition | The type of participant in the action.
Short | patient | practitioner | related-person | device
Control | 1..1
Binding | The codes SHALL be taken from ActionParticipantType (required to `http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1` ) The type of participant for the action.
Type | code
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())`)
320. 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 ActionParticipantRole (example to `http://hl7.org/fhir/ValueSet/action-participant-role` ) Defines roles played by participants for the action.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
322. PlanDefinition.action.type
Definition | The type of action to perform (create, update, remove).
Short | create | update | remove | fire-event
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from ActionType (extensible to `http://hl7.org/fhir/ValueSet/action-type` ) The type of action to be performed.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
324. 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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
326. 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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
328. 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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
330. 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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
332. 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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
334. PlanDefinition.action.definition[x]
Definition | A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.
Short | Description of the activity to be performed
Comments | Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically.
Control | 0..1
Type | Choice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
336. 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
338. 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
340. 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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
342. PlanDefinition.action.dynamicValue.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
344. PlanDefinition.action.dynamicValue.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
346. PlanDefinition.action.dynamicValue.path
Definition | The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).
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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
348. 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
350. 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
352. PlanDefinition.action:startWorkflow
Slice Name | startWorkflow
Definition | An action or group of actions to be taken as part of the plan.
Short | All constraints on action are intended to apply to any nested constraints.
Comments | Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.
Control | 1..1
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
354. PlanDefinition.action:startWorkflow.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 | 1..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Pattern Value | `start-workflow`
356. PlanDefinition.action:startWorkflow.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
358. PlanDefinition.action:startWorkflow.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
360. PlanDefinition.action:startWorkflow.prefix
Definition | A user-visible prefix for the action.
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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
362. PlanDefinition.action:startWorkflow.title
Definition | The title of the action displayed to a user.
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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
364. PlanDefinition.action:startWorkflow.description
Definition | A brief description of the action used to provide a summary to display to the user.
Short | Brief description of the action
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Pattern Value | `Start the workflow action.`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
366. PlanDefinition.action:startWorkflow.textEquivalent
Definition | Text equivalent of the start workflow action.
Short | Text equivalent of the start workflow action.
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Fixed Value | `Start the reporting workflow in response to an encounter-end event`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
368. PlanDefinition.action:startWorkflow.priority
Definition | Indicates how quickly the action should be addressed with respect to other actions.
Short | routine | urgent | asap | stat
Control | 0..1
Binding | The codes SHALL be taken from RequestPriority (required to `http://hl7.org/fhir/ValueSet/request-priority|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
370. PlanDefinition.action:startWorkflow.code
Definition | The US-PH-PlanDefinition-Action code for the start action.
Short | Code for the start action.
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from US Public Health VaueSet - PlanDefinition Action (extensible to `http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-plandefinition-action` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Pattern Value | `{ "coding" : [{ "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions", "code" : "initiate-reporting-workflow" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
372. PlanDefinition.action:startWorkflow.reason
Definition | A description of why this action is necessary or appropriate.
Short | Why the action should be performed
Comments | This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action.
Control | 0..*
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
374. PlanDefinition.action:startWorkflow.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
376. PlanDefinition.action:startWorkflow.goalId
Definition | Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.
Short | What goals this action supports
Control | 0..*
Type | id
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())`)
378. PlanDefinition.action:startWorkflow.subject[x]
Definition | A code or group definition that describes the intended subject of the action and its children, if any.
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 SubjectType (extensible to `http://hl7.org/fhir/ValueSet/subject-type` ) The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
Type | Choice of: CodeableConcept, Reference(Group)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | 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())`)
380. PlanDefinition.action:startWorkflow.trigger
Definition | When the start action should be triggered.
Short | When the start action should be triggered.
Control | 1..*
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())`)
382. PlanDefinition.action:startWorkflow.trigger.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
384. PlanDefinition.action:startWorkflow.trigger.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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
386. PlanDefinition.action:startWorkflow.trigger.extension:namedEventType
Slice Name | namedEventType
Definition | Indicates the types of named events to subscribe to from the EHR.
Short | Indicates the types of named events to subscribe to from the EHR.
Control | 0..1
Type | Extension(US Public Health Named Event Type Extension) (Extension 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())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
388. PlanDefinition.action:startWorkflow.trigger.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
Binding | The codes SHALL be taken from TriggerType (required to `http://hl7.org/fhir/ValueSet/trigger-type|4.0.1` ) The type of trigger.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Fixed Value | `named-event`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
390. PlanDefinition.action:startWorkflow.trigger.name
Definition | The name of the event, encounter-end in this case. For any action invoked as a result of this trigger, the triggering encounter is accessible via the context variable `%encounter`
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 | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Fixed Value | `encounter-end`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
392. PlanDefinition.action:startWorkflow.trigger.timing[x]
Definition | The timing of the event (if this is a periodic trigger).
Short | Timing of the event
Control | 0..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())`)
394. PlanDefinition.action:startWorkflow.trigger.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..*
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())`)
396. PlanDefinition.action:startWorkflow.trigger.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
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())`)
398. PlanDefinition.action:startWorkflow.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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
400. PlanDefinition.action:startWorkflow.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
402. PlanDefinition.action:startWorkflow.condition.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
404. PlanDefinition.action:startWorkflow.condition.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
406. PlanDefinition.action:startWorkflow.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|4.0.1` ) 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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
408. PlanDefinition.action:startWorkflow.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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
410. PlanDefinition.action:startWorkflow.input
Definition | Defines input data requirements for the action.
Short | Input data requirements
Control | 0..*
Type | DataRequirement
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())`)
412. PlanDefinition.action:startWorkflow.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
414. PlanDefinition.action:startWorkflow.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.input.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
416. PlanDefinition.action:startWorkflow.input.type
Definition | The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.
Short | The type of the required data
Control | 1..1
Binding | The codes SHALL be taken from FHIRAllTypes (required to `http://hl7.org/fhir/ValueSet/all-types|4.0.1` ) A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
418. PlanDefinition.action:startWorkflow.input.profile
Definition | The profile of the required data, specified as the uri of the profile definition.
Short | The profile of the required data
Control | 0..*
Type | canonical(StructureDefinition)
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())`)
420. PlanDefinition.action:startWorkflow.input.subject[x]
Definition | The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.
Short | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments | The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from SubjectType (extensible to `http://hl7.org/fhir/ValueSet/subject-type` ) The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
Type | Choice of: CodeableConcept, Reference(Group)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
Meaning if Missing | Patient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
422. PlanDefinition.action:startWorkflow.input.mustSupport
Definition | Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).
Short | Indicates specific structure elements that are referenced by the knowledge module
Control | 0..*
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:startWorkflow.input.codeFilter
Definition | Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.
Short | What codes are expected
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Invariants | drq-1: Either a path or a searchParam must be provided, but not both (`path.exists() xor searchParam.exists()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
426. PlanDefinition.action:startWorkflow.input.codeFilter.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
428. PlanDefinition.action:startWorkflow.input.codeFilter.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.input.codeFilter.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
430. PlanDefinition.action:startWorkflow.input.codeFilter.path
Definition | The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.
Short | A code-valued attribute to filter on
Comments | 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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
432. PlanDefinition.action:startWorkflow.input.codeFilter.searchParam
Definition | A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.
Short | A coded (token) parameter to search on
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())`)
434. PlanDefinition.action:startWorkflow.input.codeFilter.valueSet
Definition | The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.
Short | Valueset for the filter
Control | 0..1
Type | canonical(ValueSet)
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())`)
436. PlanDefinition.action:startWorkflow.input.codeFilter.code
Definition | The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.
Short | What code is expected
Control | 0..*
Type | Coding
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
438. PlanDefinition.action:startWorkflow.input.dateFilter
Definition | Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.
Short | What dates/date ranges are expected
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Invariants | drq-2: Either a path or a searchParam must be provided, but not both (`path.exists() xor searchParam.exists()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
440. PlanDefinition.action:startWorkflow.input.dateFilter.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
442. PlanDefinition.action:startWorkflow.input.dateFilter.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.input.dateFilter.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
444. PlanDefinition.action:startWorkflow.input.dateFilter.path
Definition | The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.
Short | A date-valued attribute to filter on
Comments | The path attribute contains a Simple FHIR 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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
446. PlanDefinition.action:startWorkflow.input.dateFilter.searchParam
Definition | A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.
Short | A date valued parameter to search on
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())`)
448. PlanDefinition.action:startWorkflow.input.dateFilter.value[x]
Definition | The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.
Short | The value of the filter, as a Period, DateTime, or Duration value
Control | 0..1
Type | Choice of: dateTime, Period, Duration
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
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())`)
450. PlanDefinition.action:startWorkflow.input.limit
Definition | Specifies a maximum number of results that are required (uses the _count search parameter).
Short | Number of results
Comments | This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".
Control | 0..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Enables the requirement "most recent 5 results" to be expressed.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
452. PlanDefinition.action:startWorkflow.input.sort
Definition | Specifies the order of the results to be returned.
Short | Order of the results
Comments | This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Requirements | Enables the requirement "most recent 5 results" to be expressed.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
454. PlanDefinition.action:startWorkflow.input.sort.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
456. PlanDefinition.action:startWorkflow.input.sort.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.input.sort.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
458. PlanDefinition.action:startWorkflow.input.sort.path
Definition | The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.
Short | The name of the attribute to perform the sort
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())`)
460. PlanDefinition.action:startWorkflow.input.sort.direction
Definition | The direction of the sort, ascending or descending.
Short | ascending | descending
Control | 1..1
Binding | The codes SHALL be taken from SortDirection (required to `http://hl7.org/fhir/ValueSet/sort-direction|4.0.1` ) The possible sort directions, ascending or descending.
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())`)
462. PlanDefinition.action:startWorkflow.output
Definition | Defines the outputs of the action, if any.
Short | Output data definition
Control | 0..*
Type | DataRequirement
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())`)
464. PlanDefinition.action:startWorkflow.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
466. PlanDefinition.action:startWorkflow.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.output.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
468. PlanDefinition.action:startWorkflow.output.type
Definition | The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.
Short | The type of the required data
Control | 1..1
Binding | The codes SHALL be taken from FHIRAllTypes (required to `http://hl7.org/fhir/ValueSet/all-types|4.0.1` ) A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
470. PlanDefinition.action:startWorkflow.output.profile
Definition | The profile of the required data, specified as the uri of the profile definition.
Short | The profile of the required data
Control | 0..*
Type | canonical(StructureDefinition)
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())`)
472. PlanDefinition.action:startWorkflow.output.subject[x]
Definition | The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.
Short | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments | The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from SubjectType (extensible to `http://hl7.org/fhir/ValueSet/subject-type` ) The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
Type | Choice of: CodeableConcept, Reference(Group)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
Meaning if Missing | Patient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
474. PlanDefinition.action:startWorkflow.output.mustSupport
Definition | Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).
Short | Indicates specific structure elements that are referenced by the knowledge module
Control | 0..*
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())`)
476. PlanDefinition.action:startWorkflow.output.codeFilter
Definition | Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.
Short | What codes are expected
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Invariants | drq-1: Either a path or a searchParam must be provided, but not both (`path.exists() xor searchParam.exists()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
478. PlanDefinition.action:startWorkflow.output.codeFilter.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
480. PlanDefinition.action:startWorkflow.output.codeFilter.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.output.codeFilter.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
482. PlanDefinition.action:startWorkflow.output.codeFilter.path
Definition | The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.
Short | A code-valued attribute to filter on
Comments | 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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
484. PlanDefinition.action:startWorkflow.output.codeFilter.searchParam
Definition | A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.
Short | A coded (token) parameter to search on
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())`)
486. PlanDefinition.action:startWorkflow.output.codeFilter.valueSet
Definition | The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.
Short | Valueset for the filter
Control | 0..1
Type | canonical(ValueSet)
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())`)
488. PlanDefinition.action:startWorkflow.output.codeFilter.code
Definition | The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.
Short | What code is expected
Control | 0..*
Type | Coding
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
490. PlanDefinition.action:startWorkflow.output.dateFilter
Definition | Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.
Short | What dates/date ranges are expected
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Invariants | drq-2: Either a path or a searchParam must be provided, but not both (`path.exists() xor searchParam.exists()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
492. PlanDefinition.action:startWorkflow.output.dateFilter.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
494. PlanDefinition.action:startWorkflow.output.dateFilter.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.output.dateFilter.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
496. PlanDefinition.action:startWorkflow.output.dateFilter.path
Definition | The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.
Short | A date-valued attribute to filter on
Comments | The path attribute contains a Simple FHIR 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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
498. PlanDefinition.action:startWorkflow.output.dateFilter.searchParam
Definition | A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.
Short | A date valued parameter to search on
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())`)
500. PlanDefinition.action:startWorkflow.output.dateFilter.value[x]
Definition | The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.
Short | The value of the filter, as a Period, DateTime, or Duration value
Control | 0..1
Type | Choice of: dateTime, Period, Duration
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
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())`)
502. PlanDefinition.action:startWorkflow.output.limit
Definition | Specifies a maximum number of results that are required (uses the _count search parameter).
Short | Number of results
Comments | This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".
Control | 0..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Enables the requirement "most recent 5 results" to be expressed.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
504. PlanDefinition.action:startWorkflow.output.sort
Definition | Specifies the order of the results to be returned.
Short | Order of the results
Comments | This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Requirements | Enables the requirement "most recent 5 results" to be expressed.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
506. PlanDefinition.action:startWorkflow.output.sort.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
508. PlanDefinition.action:startWorkflow.output.sort.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.output.sort.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
510. PlanDefinition.action:startWorkflow.output.sort.path
Definition | The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.
Short | The name of the attribute to perform the sort
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())`)
512. PlanDefinition.action:startWorkflow.output.sort.direction
Definition | The direction of the sort, ascending or descending.
Short | ascending | descending
Control | 1..1
Binding | The codes SHALL be taken from SortDirection (required to `http://hl7.org/fhir/ValueSet/sort-direction|4.0.1` ) The possible sort directions, ascending or descending.
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())`)
514. PlanDefinition.action:startWorkflow.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 | 1..1
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
516. PlanDefinition.action:startWorkflow.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
518. PlanDefinition.action:startWorkflow.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
520. PlanDefinition.action:startWorkflow.relatedAction.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
522. PlanDefinition.action:startWorkflow.relatedAction.actionId
Definition | The element id of the related action.
Short | What action is this related to
Control | 1..1
Type | id
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Fixed Value | `check-reportability`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
524. PlanDefinition.action:startWorkflow.relatedAction.relationship
Definition | The relationship of this action to the related action.
Short | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control | 1..1
Binding | The codes SHALL be taken from ActionRelationshipType (required to `http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1` ) 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 | true
Summary | false
Fixed Value | `before-start`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
526. PlanDefinition.action:startWorkflow.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
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.relatedAction.offset[x]`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: type @ $this
528. PlanDefinition.action:startWorkflow.relatedAction.offset[x]:offsetDuration
Slice Name | offsetDuration
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 | Duration
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Must Support | true
Summary | false
Example | Wait 72 hour before next action.: { "value" : 72, "unit" : "h" }
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
530. PlanDefinition.action:startWorkflow.timing[x]
Definition | An optional value describing when the action should be performed.
Short | When the action should take place
Control | 0..1
Type | Duration
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
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())`)
532. PlanDefinition.action:startWorkflow.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
534. PlanDefinition.action:startWorkflow.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
536. PlanDefinition.action:startWorkflow.participant.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
538. PlanDefinition.action:startWorkflow.participant.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
540. PlanDefinition.action:startWorkflow.participant.type
Definition | The type of participant in the action.
Short | patient | practitioner | related-person | device
Control | 1..1
Binding | The codes SHALL be taken from ActionParticipantType (required to `http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1` ) The type of participant for the action.
Type | code
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())`)
542. PlanDefinition.action:startWorkflow.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 ActionParticipantRole (example to `http://hl7.org/fhir/ValueSet/action-participant-role` ) Defines roles played by participants for the action.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
544. PlanDefinition.action:startWorkflow.type
Definition | The type of action to perform (create, update, remove).
Short | create | update | remove | fire-event
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from ActionType (extensible to `http://hl7.org/fhir/ValueSet/action-type` ) The type of action to be performed.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
546. PlanDefinition.action:startWorkflow.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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
548. PlanDefinition.action:startWorkflow.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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
550. PlanDefinition.action:startWorkflow.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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
552. PlanDefinition.action:startWorkflow.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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
554. PlanDefinition.action:startWorkflow.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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
556. PlanDefinition.action:startWorkflow.definition[x]
Definition | A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.
Short | Description of the activity to be performed
Comments | Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically.
Control | 0..1
Type | Choice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
558. PlanDefinition.action:startWorkflow.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
560. PlanDefinition.action:startWorkflow.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
562. PlanDefinition.action:startWorkflow.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
564. PlanDefinition.action:startWorkflow.dynamicValue.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
566. PlanDefinition.action:startWorkflow.dynamicValue.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
568. PlanDefinition.action:startWorkflow.dynamicValue.path
Definition | The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).
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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
570. PlanDefinition.action:startWorkflow.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
572. PlanDefinition.action:startWorkflow.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
574. PlanDefinition.action:executeReportingWorkflow
Slice Name | executeReportingWorkflow
Definition | An action or group of actions to be taken as part of the plan.
Short | All constraints on action are intended to apply to any nested constraints.
Comments | Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.
Control | 1..1
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
576. PlanDefinition.action:executeReportingWorkflow.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 | 1..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Pattern Value | `check-reportability`
578. PlanDefinition.action:executeReportingWorkflow.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
580. PlanDefinition.action:executeReportingWorkflow.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
582. PlanDefinition.action:executeReportingWorkflow.prefix
Definition | A user-visible prefix for the action.
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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
584. PlanDefinition.action:executeReportingWorkflow.title
Definition | The title of the action displayed to a user.
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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
586. PlanDefinition.action:executeReportingWorkflow.description
Definition | A brief description of the action used to provide a summary to display to the user.
Short | Brief description of the action
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Pattern Value | `Execute reporting workflow action.`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
588. PlanDefinition.action:executeReportingWorkflow.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 | string
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())`)
590. PlanDefinition.action:executeReportingWorkflow.priority
Definition | Indicates how quickly the action should be addressed with respect to other actions.
Short | routine | urgent | asap | stat
Control | 0..1
Binding | The codes SHALL be taken from RequestPriority (required to `http://hl7.org/fhir/ValueSet/request-priority|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
592. PlanDefinition.action:executeReportingWorkflow.code
Definition | The US-PH-PlanDefinition-Action code for the execute-reporting-workflow action.
Short | Code for the execute-reporting-workflow action.
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from US Public Health VaueSet - PlanDefinition Action (extensible to `http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-plandefinition-action` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Pattern Value | `{ "coding" : [{ "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions", "code" : "execute-reporting-workflow" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
594. PlanDefinition.action:executeReportingWorkflow.reason
Definition | A description of why this action is necessary or appropriate.
Short | Why the action should be performed
Comments | This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action.
Control | 0..*
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
596. PlanDefinition.action:executeReportingWorkflow.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
598. PlanDefinition.action:executeReportingWorkflow.goalId
Definition | Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.
Short | What goals this action supports
Control | 0..*
Type | id
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())`)
600. PlanDefinition.action:executeReportingWorkflow.subject[x]
Definition | A code or group definition that describes the intended subject of the action and its children, if any.
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 SubjectType (extensible to `http://hl7.org/fhir/ValueSet/subject-type` ) The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
Type | Choice of: CodeableConcept, Reference(Group)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | 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())`)
602. PlanDefinition.action:executeReportingWorkflow.trigger
Definition | A description of when the action should be triggered.
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())`)
604. PlanDefinition.action:executeReportingWorkflow.trigger.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
606. PlanDefinition.action:executeReportingWorkflow.trigger.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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
608. PlanDefinition.action:executeReportingWorkflow.trigger.extension:namedEventType
Slice Name | namedEventType
Definition | Indicates the types of named events to subscribe to from the EHR.
Short | US Public Health Named Event Type Extension
Control | 0..1
Type | Extension(US Public Health Named Event Type Extension) (Extension 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())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
610. PlanDefinition.action:executeReportingWorkflow.trigger.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
Binding | The codes SHALL be taken from TriggerType (required to `http://hl7.org/fhir/ValueSet/trigger-type|4.0.1` ) The type of trigger.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Fixed Value | `named-event`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
612. PlanDefinition.action:executeReportingWorkflow.trigger.name
Definition | 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 | 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())`)
614. PlanDefinition.action:executeReportingWorkflow.trigger.timing[x]
Definition | The timing of the event (if this is a periodic trigger).
Short | Timing of the event
Control | 0..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())`)
616. PlanDefinition.action:executeReportingWorkflow.trigger.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..*
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())`)
618. PlanDefinition.action:executeReportingWorkflow.trigger.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
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())`)
620. PlanDefinition.action:executeReportingWorkflow.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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
622. PlanDefinition.action:executeReportingWorkflow.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
624. PlanDefinition.action:executeReportingWorkflow.condition.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
626. PlanDefinition.action:executeReportingWorkflow.condition.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
628. PlanDefinition.action:executeReportingWorkflow.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|4.0.1` ) 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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
630. PlanDefinition.action:executeReportingWorkflow.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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
632. PlanDefinition.action:executeReportingWorkflow.input
Definition | Defines input data requirements for the action.
Short | Input data requirements
Control | 0..*
Type | DataRequirement
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())`)
634. PlanDefinition.action:executeReportingWorkflow.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
636. PlanDefinition.action:executeReportingWorkflow.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.input.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
638. PlanDefinition.action:executeReportingWorkflow.input.type
Definition | The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.
Short | The type of the required data
Control | 1..1
Binding | The codes SHALL be taken from FHIRAllTypes (required to `http://hl7.org/fhir/ValueSet/all-types|4.0.1` ) A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
640. PlanDefinition.action:executeReportingWorkflow.input.profile
Definition | The profile of the required data, specified as the uri of the profile definition.
Short | The profile of the required data
Control | 0..*
Type | canonical(StructureDefinition)
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())`)
642. PlanDefinition.action:executeReportingWorkflow.input.subject[x]
Definition | The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.
Short | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments | The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from SubjectType (extensible to `http://hl7.org/fhir/ValueSet/subject-type` ) The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
Type | Choice of: CodeableConcept, Reference(Group)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
Meaning if Missing | Patient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
644. PlanDefinition.action:executeReportingWorkflow.input.mustSupport
Definition | Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).
Short | Indicates specific structure elements that are referenced by the knowledge module
Control | 0..*
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())`)
646. PlanDefinition.action:executeReportingWorkflow.input.codeFilter
Definition | Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.
Short | What codes are expected
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Invariants | drq-1: Either a path or a searchParam must be provided, but not both (`path.exists() xor searchParam.exists()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
648. PlanDefinition.action:executeReportingWorkflow.input.codeFilter.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
650. PlanDefinition.action:executeReportingWorkflow.input.codeFilter.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.input.codeFilter.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
652. PlanDefinition.action:executeReportingWorkflow.input.codeFilter.path
Definition | The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.
Short | A code-valued attribute to filter on
Comments | 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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
654. PlanDefinition.action:executeReportingWorkflow.input.codeFilter.searchParam
Definition | A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.
Short | A coded (token) parameter to search on
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())`)
656. PlanDefinition.action:executeReportingWorkflow.input.codeFilter.valueSet
Definition | The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.
Short | Valueset for the filter
Control | 0..1
Type | canonical(ValueSet)
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())`)
658. PlanDefinition.action:executeReportingWorkflow.input.codeFilter.code
Definition | The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.
Short | What code is expected
Control | 0..*
Type | Coding
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
660. PlanDefinition.action:executeReportingWorkflow.input.dateFilter
Definition | Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.
Short | What dates/date ranges are expected
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Invariants | drq-2: Either a path or a searchParam must be provided, but not both (`path.exists() xor searchParam.exists()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
662. PlanDefinition.action:executeReportingWorkflow.input.dateFilter.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
664. PlanDefinition.action:executeReportingWorkflow.input.dateFilter.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.input.dateFilter.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
666. PlanDefinition.action:executeReportingWorkflow.input.dateFilter.path
Definition | The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.
Short | A date-valued attribute to filter on
Comments | The path attribute contains a Simple FHIR 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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
668. PlanDefinition.action:executeReportingWorkflow.input.dateFilter.searchParam
Definition | A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.
Short | A date valued parameter to search on
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())`)
670. PlanDefinition.action:executeReportingWorkflow.input.dateFilter.value[x]
Definition | The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.
Short | The value of the filter, as a Period, DateTime, or Duration value
Control | 0..1
Type | Choice of: dateTime, Period, Duration
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
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())`)
672. PlanDefinition.action:executeReportingWorkflow.input.limit
Definition | Specifies a maximum number of results that are required (uses the _count search parameter).
Short | Number of results
Comments | This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".
Control | 0..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Enables the requirement "most recent 5 results" to be expressed.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
674. PlanDefinition.action:executeReportingWorkflow.input.sort
Definition | Specifies the order of the results to be returned.
Short | Order of the results
Comments | This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Requirements | Enables the requirement "most recent 5 results" to be expressed.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
676. PlanDefinition.action:executeReportingWorkflow.input.sort.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
678. PlanDefinition.action:executeReportingWorkflow.input.sort.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.input.sort.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
680. PlanDefinition.action:executeReportingWorkflow.input.sort.path
Definition | The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.
Short | The name of the attribute to perform the sort
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())`)
682. PlanDefinition.action:executeReportingWorkflow.input.sort.direction
Definition | The direction of the sort, ascending or descending.
Short | ascending | descending
Control | 1..1
Binding | The codes SHALL be taken from SortDirection (required to `http://hl7.org/fhir/ValueSet/sort-direction|4.0.1` ) The possible sort directions, ascending or descending.
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())`)
684. PlanDefinition.action:executeReportingWorkflow.output
Definition | Defines the outputs of the action, if any.
Short | Output data definition
Control | 0..*
Type | DataRequirement
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())`)
686. PlanDefinition.action:executeReportingWorkflow.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
688. PlanDefinition.action:executeReportingWorkflow.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.output.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
690. PlanDefinition.action:executeReportingWorkflow.output.type
Definition | The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.
Short | The type of the required data
Control | 1..1
Binding | The codes SHALL be taken from FHIRAllTypes (required to `http://hl7.org/fhir/ValueSet/all-types|4.0.1` ) A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
692. PlanDefinition.action:executeReportingWorkflow.output.profile
Definition | The profile of the required data, specified as the uri of the profile definition.
Short | The profile of the required data
Control | 0..*
Type | canonical(StructureDefinition)
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())`)
694. PlanDefinition.action:executeReportingWorkflow.output.subject[x]
Definition | The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.
Short | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments | The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from SubjectType (extensible to `http://hl7.org/fhir/ValueSet/subject-type` ) The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
Type | Choice of: CodeableConcept, Reference(Group)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
Meaning if Missing | Patient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
696. PlanDefinition.action:executeReportingWorkflow.output.mustSupport
Definition | Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).
Short | Indicates specific structure elements that are referenced by the knowledge module
Control | 0..*
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())`)
698. PlanDefinition.action:executeReportingWorkflow.output.codeFilter
Definition | Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.
Short | What codes are expected
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Invariants | drq-1: Either a path or a searchParam must be provided, but not both (`path.exists() xor searchParam.exists()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
700. PlanDefinition.action:executeReportingWorkflow.output.codeFilter.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
702. PlanDefinition.action:executeReportingWorkflow.output.codeFilter.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.output.codeFilter.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
704. PlanDefinition.action:executeReportingWorkflow.output.codeFilter.path
Definition | The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.
Short | A code-valued attribute to filter on
Comments | 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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
706. PlanDefinition.action:executeReportingWorkflow.output.codeFilter.searchParam
Definition | A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.
Short | A coded (token) parameter to search on
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())`)
708. PlanDefinition.action:executeReportingWorkflow.output.codeFilter.valueSet
Definition | The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.
Short | Valueset for the filter
Control | 0..1
Type | canonical(ValueSet)
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())`)
710. PlanDefinition.action:executeReportingWorkflow.output.codeFilter.code
Definition | The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.
Short | What code is expected
Control | 0..*
Type | Coding
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
712. PlanDefinition.action:executeReportingWorkflow.output.dateFilter
Definition | Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.
Short | What dates/date ranges are expected
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Invariants | drq-2: Either a path or a searchParam must be provided, but not both (`path.exists() xor searchParam.exists()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
714. PlanDefinition.action:executeReportingWorkflow.output.dateFilter.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
716. PlanDefinition.action:executeReportingWorkflow.output.dateFilter.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.output.dateFilter.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
718. PlanDefinition.action:executeReportingWorkflow.output.dateFilter.path
Definition | The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.
Short | A date-valued attribute to filter on
Comments | The path attribute contains a Simple FHIR 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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
720. PlanDefinition.action:executeReportingWorkflow.output.dateFilter.searchParam
Definition | A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.
Short | A date valued parameter to search on
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())`)
722. PlanDefinition.action:executeReportingWorkflow.output.dateFilter.value[x]
Definition | The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.
Short | The value of the filter, as a Period, DateTime, or Duration value
Control | 0..1
Type | Choice of: dateTime, Period, Duration
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
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())`)
724. PlanDefinition.action:executeReportingWorkflow.output.limit
Definition | Specifies a maximum number of results that are required (uses the _count search parameter).
Short | Number of results
Comments | This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".
Control | 0..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Enables the requirement "most recent 5 results" to be expressed.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
726. PlanDefinition.action:executeReportingWorkflow.output.sort
Definition | Specifies the order of the results to be returned.
Short | Order of the results
Comments | This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Requirements | Enables the requirement "most recent 5 results" to be expressed.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
728. PlanDefinition.action:executeReportingWorkflow.output.sort.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
730. PlanDefinition.action:executeReportingWorkflow.output.sort.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.output.sort.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
732. PlanDefinition.action:executeReportingWorkflow.output.sort.path
Definition | The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.
Short | The name of the attribute to perform the sort
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())`)
734. PlanDefinition.action:executeReportingWorkflow.output.sort.direction
Definition | The direction of the sort, ascending or descending.
Short | ascending | descending
Control | 1..1
Binding | The codes SHALL be taken from SortDirection (required to `http://hl7.org/fhir/ValueSet/sort-direction|4.0.1` ) The possible sort directions, ascending or descending.
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())`)
736. PlanDefinition.action:executeReportingWorkflow.relatedAction
Definition | A relationship to another action such as "before" or "30-60 minutes after start of".
Short | Relationship to another action
Comments | When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.
Control | 0..*
Type | BackboneElement
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())`)
738. PlanDefinition.action:executeReportingWorkflow.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
740. PlanDefinition.action:executeReportingWorkflow.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
742. PlanDefinition.action:executeReportingWorkflow.relatedAction.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
744. PlanDefinition.action:executeReportingWorkflow.relatedAction.actionId
Definition | The element id of the related action.
Short | What action is this related to
Control | 1..1
Type | id
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())`)
746. PlanDefinition.action:executeReportingWorkflow.relatedAction.relationship
Definition | The relationship of this action to the related action.
Short | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control | 1..1
Binding | The codes SHALL be taken from ActionRelationshipType (required to `http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1` ) 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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
748. PlanDefinition.action:executeReportingWorkflow.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
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.relatedAction.offset[x]`. The slices areUnordered and Open, and can be differentiated using the following discriminators: type @ $this
750. PlanDefinition.action:executeReportingWorkflow.relatedAction.offset[x]:offsetDuration
Slice Name | offsetDuration
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 | Duration
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
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())`)
752. PlanDefinition.action:executeReportingWorkflow.timing[x]
Definition | An optional value describing when the action should be performed.
Short | When the action should take place
Control | 0..1
Type | Duration
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
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())`)
754. PlanDefinition.action:executeReportingWorkflow.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
756. PlanDefinition.action:executeReportingWorkflow.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
758. PlanDefinition.action:executeReportingWorkflow.participant.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
760. PlanDefinition.action:executeReportingWorkflow.participant.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
762. PlanDefinition.action:executeReportingWorkflow.participant.type
Definition | The type of participant in the action.
Short | patient | practitioner | related-person | device
Control | 1..1
Binding | The codes SHALL be taken from ActionParticipantType (required to `http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1` ) The type of participant for the action.
Type | code
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())`)
764. PlanDefinition.action:executeReportingWorkflow.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 ActionParticipantRole (example to `http://hl7.org/fhir/ValueSet/action-participant-role` ) Defines roles played by participants for the action.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
766. PlanDefinition.action:executeReportingWorkflow.type
Definition | The type of action to perform (create, update, remove).
Short | create | update | remove | fire-event
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from ActionType (extensible to `http://hl7.org/fhir/ValueSet/action-type` ) The type of action to be performed.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
768. PlanDefinition.action:executeReportingWorkflow.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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
770. PlanDefinition.action:executeReportingWorkflow.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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
772. PlanDefinition.action:executeReportingWorkflow.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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
774. PlanDefinition.action:executeReportingWorkflow.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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
776. PlanDefinition.action:executeReportingWorkflow.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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
778. PlanDefinition.action:executeReportingWorkflow.definition[x]
Definition | A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.
Short | Description of the activity to be performed
Comments | Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically.
Control | 0..1
Type | Choice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
780. PlanDefinition.action:executeReportingWorkflow.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
782. PlanDefinition.action:executeReportingWorkflow.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
784. PlanDefinition.action:executeReportingWorkflow.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
786. PlanDefinition.action:executeReportingWorkflow.dynamicValue.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
788. PlanDefinition.action:executeReportingWorkflow.dynamicValue.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
790. PlanDefinition.action:executeReportingWorkflow.dynamicValue.path
Definition | The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).
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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
792. PlanDefinition.action:executeReportingWorkflow.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
794. PlanDefinition.action:executeReportingWorkflow.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 | 2..*
Type | Seettp://hl7.org/fhir/StructureDefinition/PlanDefinition#PlanDefinition.action
Is Modifier | false
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.action`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ id
796. PlanDefinition.action:executeReportingWorkflow.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
798. PlanDefinition.action:executeReportingWorkflow.action.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
800. PlanDefinition.action:executeReportingWorkflow.action.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
802. PlanDefinition.action:executeReportingWorkflow.action.prefix
Definition | A user-visible prefix for the action.
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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
804. PlanDefinition.action:executeReportingWorkflow.action.title
Definition | The title of the action displayed to a user.
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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
806. PlanDefinition.action:executeReportingWorkflow.action.description
Definition | A brief description of the action used to provide a summary to display to the user.
Short | Brief description of the action
Control | 0..1
Type | string
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())`)
808. PlanDefinition.action:executeReportingWorkflow.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 | string
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())`)
810. PlanDefinition.action:executeReportingWorkflow.action.priority
Definition | Indicates how quickly the action should be addressed with respect to other actions.
Short | routine | urgent | asap | stat
Control | 0..1
Binding | The codes SHALL be taken from RequestPriority (required to `http://hl7.org/fhir/ValueSet/request-priority|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
812. PlanDefinition.action:executeReportingWorkflow.action.code
Definition | A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.
Short | Code representing the meaning of the action or sub-actions
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from US Public Health VaueSet - PlanDefinition Action (extensible to `http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-plandefinition-action` ) The set of actions that can be used to create plan definition
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())`)
814. PlanDefinition.action:executeReportingWorkflow.action.reason
Definition | A description of why this action is necessary or appropriate.
Short | Why the action should be performed
Comments | This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action.
Control | 0..*
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
816. PlanDefinition.action:executeReportingWorkflow.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
818. PlanDefinition.action:executeReportingWorkflow.action.goalId
Definition | Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.
Short | What goals this action supports
Control | 0..*
Type | id
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())`)
820. PlanDefinition.action:executeReportingWorkflow.action.subject[x]
Definition | A code or group definition that describes the intended subject of the action and its children, if any.
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 SubjectType (extensible to `http://hl7.org/fhir/ValueSet/subject-type` ) The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
Type | Choice of: CodeableConcept, Reference(Group)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | 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())`)
822. PlanDefinition.action:executeReportingWorkflow.action.trigger
Definition | A description of when the action should be triggered.
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())`)
824. PlanDefinition.action:executeReportingWorkflow.action.trigger.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
826. PlanDefinition.action:executeReportingWorkflow.action.trigger.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.action.trigger.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
828. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable
Slice Name | isAmbulatoryEncounterReportable
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 | 1..1
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
830. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.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 | 1..1
Type | string
Is Modifier | false
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `is-ambulatory-encounter-reportable`
832. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
834. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
836. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.prefix
Definition | A user-visible prefix for the action.
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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
838. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.title
Definition | The title of the action displayed to a user.
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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
840. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.description
Definition | A brief description of the action used to provide a summary to display to the user.
Short | Brief description of the action
Control | 0..1
Type | string
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())`)
842. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.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 | string
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())`)
844. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.priority
Definition | Indicates how quickly the action should be addressed with respect to other actions.
Short | routine | urgent | asap | stat
Control | 0..1
Binding | The codes SHALL be taken from RequestPriority (required to `http://hl7.org/fhir/ValueSet/request-priority|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
846. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.code
Definition | A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.
Short | Code representing the meaning of the action or sub-actions
Control | 1..1
Type | CodeableConcept
Is Modifier | false
Summary | false
Pattern Value | `{ "coding" : [{ "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions", "code" : "evaluate-condition" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
848. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.reason
Definition | A description of why this action is necessary or appropriate.
Short | Why the action should be performed
Comments | This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action.
Control | 0..*
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
850. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
852. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.goalId
Definition | Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.
Short | What goals this action supports
Control | 0..*
Type | id
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())`)
854. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.subject[x]
Definition | A code or group definition that describes the intended subject of the action and its children, if any.
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 SubjectType (extensible to `http://hl7.org/fhir/ValueSet/subject-type|4.0.1` ) The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
Type | Choice of: CodeableConcept, Reference(Group)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | 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())`)
856. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.trigger
Definition | A description of when the action should be triggered.
Short | When the action should be triggered
Control | 0..*
Type | TriggerDefinition
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
858. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
860. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
862. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
864. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
866. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.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|4.0.1` ) 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
Summary | false
Fixed Value | `applicability`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
868. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.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 | 1..1
Type | Expression
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())`)
870. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.expression.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
872. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.expression.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.action.condition.expression.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
874. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.expression.description
Definition | A brief, natural language description of the condition that effectively communicates the intended semantics.
Short | Natural language description of the condition
Control | 0..1
Type | string
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())`)
876. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.expression.name
Definition | A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.
Short | Short name assigned to expression for reuse
Control | 0..1
Type | id
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())`)
878. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.expression.language
Definition | The media type of the language for the expression.
Short | text/cql | text/fhirpath | application/x-fhir-query | etc.
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from ExpressionLanguage (extensible to `http://hl7.org/fhir/ValueSet/expression-language|4.0.1` ) The media type of the expression language.
Additional Bindings | Purpose
http://www.rfc-editor.org/bcp/bcp13.txt | Max Binding
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Fixed Value | `text/fhirpath`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
880. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.expression.expression
Definition | An expression in the specified language that returns a value.
Short | Expression in specified language
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())`)
882. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.condition.expression.reference
Definition | A URI that defines where the expression is found.
Short | Where the expression is found
Comments | If both a reference and an expression is found, the reference SHALL point to the same expression.
Control | 0..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
884. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input
Definition | Defines input data requirements for the action. Required data is accessible via a context variable named `%[id]` using the `id` of the input data requirement
Short | Input data requirements
Control | 0..*
Type | DataRequirement
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())`)
886. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.id
Definition | The id of the input requirement, allowing the data to be referenced via a context variable named `%[id]`
Short | Unique id for inter-element referencing
Control | 1..1
Type | string
Is Modifier | false
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
888. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.action.input.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
890. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.type
Definition | The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.
Short | The type of the required data
Control | 1..1
Binding | The codes SHALL be taken from FHIRAllTypes (required to `http://hl7.org/fhir/ValueSet/all-types|4.0.1` ) A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
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())`)
892. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.profile
Definition | The profile of the required data, specified as the uri of the profile definition.
Short | The profile of the required data
Control | 0..*
Type | canonical(StructureDefinition)
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())`)
894. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.subject[x]
Definition | The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.
Short | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments | The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from SubjectType (extensible to `http://hl7.org/fhir/ValueSet/subject-type|4.0.1` ) The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
Type | Choice of: CodeableConcept, Reference(Group)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
Meaning if Missing | Patient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
896. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.mustSupport
Definition | Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).
Short | Indicates specific structure elements that are referenced by the knowledge module
Control | 0..*
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())`)
898. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.codeFilter
Definition | Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.
Short | What codes are expected
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Invariants | drq-1: Either a path or a searchParam must be provided, but not both (`path.exists() xor searchParam.exists()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
900. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.codeFilter.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
902. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.codeFilter.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.action.input.codeFilter.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
904. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.codeFilter.path
Definition | The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.
Short | A code-valued attribute to filter on
Comments | 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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
906. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.codeFilter.searchParam
Definition | A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.
Short | A coded (token) parameter to search on
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())`)
908. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.codeFilter.valueSet
Definition | The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.
Short | Valueset for the filter
Control | 0..1
Type | canonical(ValueSet)
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())`)
910. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.codeFilter.code
Definition | The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.
Short | What code is expected
Control | 0..*
Type | Coding
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
912. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.dateFilter
Definition | Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.
Short | What dates/date ranges are expected
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Invariants | drq-2: Either a path or a searchParam must be provided, but not both (`path.exists() xor searchParam.exists()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
914. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.dateFilter.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
916. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.dateFilter.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.action.input.dateFilter.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
918. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.dateFilter.path
Definition | The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.
Short | A date-valued attribute to filter on
Comments | The path attribute contains a Simple FHIR 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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
920. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.dateFilter.searchParam
Definition | A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.
Short | A date valued parameter to search on
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())`)
922. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.dateFilter.value[x]
Definition | The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.
Short | The value of the filter, as a Period, DateTime, or Duration value
Control | 0..1
Type | Choice of: dateTime, Period, Duration
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
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())`)
924. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.limit
Definition | Specifies a maximum number of results that are required (uses the _count search parameter).
Short | Number of results
Comments | This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".
Control | 0..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Enables the requirement "most recent 5 results" to be expressed.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
926. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.sort
Definition | Specifies the order of the results to be returned.
Short | Order of the results
Comments | This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Requirements | Enables the requirement "most recent 5 results" to be expressed.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
928. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.sort.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
930. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.sort.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.action.input.sort.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
932. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.sort.path
Definition | The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.
Short | The name of the attribute to perform the sort
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())`)
934. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.input.sort.direction
Definition | The direction of the sort, ascending or descending.
Short | ascending | descending
Control | 1..1
Binding | The codes SHALL be taken from SortDirection (required to `http://hl7.org/fhir/ValueSet/sort-direction|4.0.1` ) The possible sort directions, ascending or descending.
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())`)
936. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.output
Definition | Defines the outputs of the action, if any.
Short | Output data definition
Control | 0..*
Type | DataRequirement
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
938. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.relatedAction
Definition | A relationship to another action such as "before" or "30-60 minutes after start of".
Short | Relationship to another action
Comments | When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
940. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
942. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
944. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.relatedAction.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
946. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.relatedAction.actionId
Definition | The element id of the related action.
Short | What action is this related to
Control | 1..1
Type | id
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Fixed Value | `create-hcs-report`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
948. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.relatedAction.relationship
Definition | The relationship of this action to the related action.
Short | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control | 1..1
Binding | The codes SHALL be taken from ActionRelationshipType (required to `http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1` ) 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
Summary | false
Fixed Value | `before-start`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
950. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
952. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.timing[x]
Definition | An optional value describing when the action should be performed.
Short | When the action should take place
Control | 0..1
Type | Choice of: dateTime, Age, Period, Duration, Range, Timing
[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 | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
954. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
956. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
958. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.participant.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
960. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.participant.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
962. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.participant.type
Definition | The type of participant in the action.
Short | patient | practitioner | related-person | device
Control | 1..1
Binding | The codes SHALL be taken from ActionParticipantType (required to `http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1` ) The type of participant for the action.
Type | code
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())`)
964. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.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 ActionParticipantRole (example to `http://hl7.org/fhir/ValueSet/action-participant-role|4.0.1` ) Defines roles played by participants for the action.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
966. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.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|4.0.1` ) The type of action to be performed.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
968. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
970. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
972. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
974. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
976. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
978. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.definition[x]
Definition | A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.
Short | Description of the activity to be performed
Comments | Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically.
Control | 0..1
Type | Choice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
980. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
982. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
984. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
986. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.dynamicValue.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
988. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.dynamicValue.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
990. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.dynamicValue.path
Definition | The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).
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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
992. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
994. PlanDefinition.action:executeReportingWorkflow.action:isAmbulatoryEncounterReportable.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
996. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable
Slice Name | isInpatientEncounterReportable
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 | 1..1
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
998. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.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 | 1..1
Type | string
Is Modifier | false
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `is-inpatient-encounter-reportable`
1000. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
1002. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
1004. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.prefix
Definition | A user-visible prefix for the action.
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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1006. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.title
Definition | The title of the action displayed to a user.
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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1008. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.description
Definition | A brief description of the action used to provide a summary to display to the user.
Short | Brief description of the action
Control | 0..1
Type | string
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())`)
1010. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.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 | string
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())`)
1012. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.priority
Definition | Indicates how quickly the action should be addressed with respect to other actions.
Short | routine | urgent | asap | stat
Control | 0..1
Binding | The codes SHALL be taken from RequestPriority (required to `http://hl7.org/fhir/ValueSet/request-priority|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1014. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.code
Definition | A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.
Short | Code representing the meaning of the action or sub-actions
Control | 1..1
Type | CodeableConcept
Is Modifier | false
Summary | false
Pattern Value | `{ "coding" : [{ "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions", "code" : "evaluate-condition" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1016. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.reason
Definition | A description of why this action is necessary or appropriate.
Short | Why the action should be performed
Comments | This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action.
Control | 0..*
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1018. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1020. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.goalId
Definition | Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.
Short | What goals this action supports
Control | 0..*
Type | id
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())`)
1022. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.subject[x]
Definition | A code or group definition that describes the intended subject of the action and its children, if any.
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 SubjectType (extensible to `http://hl7.org/fhir/ValueSet/subject-type|4.0.1` ) The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
Type | Choice of: CodeableConcept, Reference(Group)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | 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())`)
1024. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.trigger
Definition | A description of when the action should be triggered.
Short | When the action should be triggered
Control | 0..*
Type | TriggerDefinition
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1026. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1028. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1030. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
1032. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
1034. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.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|4.0.1` ) 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
Summary | false
Fixed Value | `applicability`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1036. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.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 | 1..1
Type | Expression
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())`)
1038. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.expression.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1040. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.expression.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.action.condition.expression.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
1042. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.expression.description
Definition | A brief, natural language description of the condition that effectively communicates the intended semantics.
Short | Natural language description of the condition
Control | 0..1
Type | string
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())`)
1044. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.expression.name
Definition | A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.
Short | Short name assigned to expression for reuse
Control | 0..1
Type | id
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())`)
1046. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.expression.language
Definition | The media type of the language for the expression.
Short | text/cql | text/fhirpath | application/x-fhir-query | etc.
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from ExpressionLanguage (extensible to `http://hl7.org/fhir/ValueSet/expression-language|4.0.1` ) The media type of the expression language.
Additional Bindings | Purpose
http://www.rfc-editor.org/bcp/bcp13.txt | Max Binding
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Fixed Value | `text/fhirpath`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1048. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.expression.expression
Definition | An expression in the specified language that returns a value.
Short | Expression in specified language
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())`)
1050. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.condition.expression.reference
Definition | A URI that defines where the expression is found.
Short | Where the expression is found
Comments | If both a reference and an expression is found, the reference SHALL point to the same expression.
Control | 0..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1052. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input
Definition | Defines input data requirements for the action. Required data is accessible via a context variable named `%[id]` using the `id` of the input data requirement
Short | Input data requirements
Control | 0..*
Type | DataRequirement
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())`)
1054. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.id
Definition | The id of the input requirement, allowing the data to be referenced via a context variable named `%[id]`
Short | Unique id for inter-element referencing
Control | 1..1
Type | string
Is Modifier | false
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1056. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.action.input.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
1058. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.type
Definition | The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.
Short | The type of the required data
Control | 1..1
Binding | The codes SHALL be taken from FHIRAllTypes (required to `http://hl7.org/fhir/ValueSet/all-types|4.0.1` ) A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
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())`)
1060. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.profile
Definition | The profile of the required data, specified as the uri of the profile definition.
Short | The profile of the required data
Control | 0..*
Type | canonical(StructureDefinition)
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())`)
1062. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.subject[x]
Definition | The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.
Short | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments | The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from SubjectType (extensible to `http://hl7.org/fhir/ValueSet/subject-type|4.0.1` ) The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
Type | Choice of: CodeableConcept, Reference(Group)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
Meaning if Missing | Patient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1064. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.mustSupport
Definition | Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).
Short | Indicates specific structure elements that are referenced by the knowledge module
Control | 0..*
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())`)
1066. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.codeFilter
Definition | Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.
Short | What codes are expected
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Invariants | drq-1: Either a path or a searchParam must be provided, but not both (`path.exists() xor searchParam.exists()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1068. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.codeFilter.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1070. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.codeFilter.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.action.input.codeFilter.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
1072. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.codeFilter.path
Definition | The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.
Short | A code-valued attribute to filter on
Comments | 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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1074. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.codeFilter.searchParam
Definition | A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.
Short | A coded (token) parameter to search on
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())`)
1076. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.codeFilter.valueSet
Definition | The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.
Short | Valueset for the filter
Control | 0..1
Type | canonical(ValueSet)
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())`)
1078. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.codeFilter.code
Definition | The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.
Short | What code is expected
Control | 0..*
Type | Coding
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1080. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.dateFilter
Definition | Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.
Short | What dates/date ranges are expected
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Invariants | drq-2: Either a path or a searchParam must be provided, but not both (`path.exists() xor searchParam.exists()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1082. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.dateFilter.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1084. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.dateFilter.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.action.input.dateFilter.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
1086. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.dateFilter.path
Definition | The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.
Short | A date-valued attribute to filter on
Comments | The path attribute contains a Simple FHIR 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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1088. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.dateFilter.searchParam
Definition | A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.
Short | A date valued parameter to search on
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())`)
1090. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.dateFilter.value[x]
Definition | The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.
Short | The value of the filter, as a Period, DateTime, or Duration value
Control | 0..1
Type | Choice of: dateTime, Period, Duration
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
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())`)
1092. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.limit
Definition | Specifies a maximum number of results that are required (uses the _count search parameter).
Short | Number of results
Comments | This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".
Control | 0..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Enables the requirement "most recent 5 results" to be expressed.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1094. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.sort
Definition | Specifies the order of the results to be returned.
Short | Order of the results
Comments | This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Requirements | Enables the requirement "most recent 5 results" to be expressed.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1096. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.sort.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1098. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.sort.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.action.input.sort.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
1100. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.sort.path
Definition | The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.
Short | The name of the attribute to perform the sort
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())`)
1102. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.input.sort.direction
Definition | The direction of the sort, ascending or descending.
Short | ascending | descending
Control | 1..1
Binding | The codes SHALL be taken from SortDirection (required to `http://hl7.org/fhir/ValueSet/sort-direction|4.0.1` ) The possible sort directions, ascending or descending.
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())`)
1104. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.output
Definition | Defines the outputs of the action, if any.
Short | Output data definition
Control | 0..*
Type | DataRequirement
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1106. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.relatedAction
Definition | A relationship to another action such as "before" or "30-60 minutes after start of".
Short | Relationship to another action
Comments | When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1108. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1110. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
1112. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.relatedAction.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
1114. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.relatedAction.actionId
Definition | The element id of the related action.
Short | What action is this related to
Control | 1..1
Type | id
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Fixed Value | `create-hcs-report`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1116. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.relatedAction.relationship
Definition | The relationship of this action to the related action.
Short | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control | 1..1
Binding | The codes SHALL be taken from ActionRelationshipType (required to `http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1` ) 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
Summary | false
Fixed Value | `before-start`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1118. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1120. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.timing[x]
Definition | An optional value describing when the action should be performed.
Short | When the action should take place
Control | 0..1
Type | Choice of: dateTime, Age, Period, Duration, Range, Timing
[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 | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1122. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1124. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1126. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.participant.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
1128. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.participant.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
1130. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.participant.type
Definition | The type of participant in the action.
Short | patient | practitioner | related-person | device
Control | 1..1
Binding | The codes SHALL be taken from ActionParticipantType (required to `http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1` ) The type of participant for the action.
Type | code
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())`)
1132. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.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 ActionParticipantRole (example to `http://hl7.org/fhir/ValueSet/action-participant-role|4.0.1` ) Defines roles played by participants for the action.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1134. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.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|4.0.1` ) The type of action to be performed.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1136. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1138. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1140. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1142. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1144. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1146. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.definition[x]
Definition | A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.
Short | Description of the activity to be performed
Comments | Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically.
Control | 0..1
Type | Choice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1148. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1150. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1152. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1154. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.dynamicValue.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
1156. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.dynamicValue.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
1158. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.dynamicValue.path
Definition | The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).
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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1160. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1162. PlanDefinition.action:executeReportingWorkflow.action:isInpatientEncounterReportable.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1164. PlanDefinition.action:createReport
Slice Name | createReport
Definition | An action or group of actions to be taken as part of the plan.
Short | All constraints on action are intended to apply to any nested constraints.
Comments | Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.
Control | 1..1
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1166. PlanDefinition.action:createReport.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 | 1..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Pattern Value | `create-hcs-report`
1168. PlanDefinition.action:createReport.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
1170. PlanDefinition.action:createReport.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
1172. PlanDefinition.action:createReport.prefix
Definition | A user-visible prefix for the action.
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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1174. PlanDefinition.action:createReport.title
Definition | The title of the action displayed to a user.
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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1176. PlanDefinition.action:createReport.description
Definition | A brief description of the action used to provide a summary to display to the user.
Short | Brief description of the action
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Pattern Value | `Create HCS report action.`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1178. PlanDefinition.action:createReport.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 | string
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())`)
1180. PlanDefinition.action:createReport.priority
Definition | Indicates how quickly the action should be addressed with respect to other actions.
Short | routine | urgent | asap | stat
Control | 0..1
Binding | The codes SHALL be taken from RequestPriority (required to `http://hl7.org/fhir/ValueSet/request-priority|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1182. PlanDefinition.action:createReport.code
Definition | A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.
Short | Code representing the meaning of the action or sub-actions
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from US Public Health VaueSet - PlanDefinition Action (extensible to `http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-plandefinition-action` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Pattern Value | `{ "coding" : [{ "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions", "code" : "create-report" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1184. PlanDefinition.action:createReport.reason
Definition | A description of why this action is necessary or appropriate.
Short | Why the action should be performed
Comments | This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action.
Control | 0..*
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1186. PlanDefinition.action:createReport.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1188. PlanDefinition.action:createReport.goalId
Definition | Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.
Short | What goals this action supports
Control | 0..*
Type | id
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())`)
1190. PlanDefinition.action:createReport.subject[x]
Definition | A code or group definition that describes the intended subject of the action and its children, if any.
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 SubjectType (extensible to `http://hl7.org/fhir/ValueSet/subject-type` ) The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
Type | Choice of: CodeableConcept, Reference(Group)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | 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())`)
1192. PlanDefinition.action:createReport.trigger
Definition | A description of when the action should be triggered.
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())`)
1194. PlanDefinition.action:createReport.trigger.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1196. PlanDefinition.action:createReport.trigger.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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
1198. PlanDefinition.action:createReport.trigger.extension:namedEventType
Slice Name | namedEventType
Definition | Indicates the types of named events to subscribe to from the EHR.
Short | US Public Health Named Event Type Extension
Control | 0..1
Type | Extension(US Public Health Named Event Type Extension) (Extension 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())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
1200. PlanDefinition.action:createReport.trigger.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
Binding | The codes SHALL be taken from TriggerType (required to `http://hl7.org/fhir/ValueSet/trigger-type|4.0.1` ) The type of trigger.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Fixed Value | `named-event`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1202. PlanDefinition.action:createReport.trigger.name
Definition | 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 | 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())`)
1204. PlanDefinition.action:createReport.trigger.timing[x]
Definition | The timing of the event (if this is a periodic trigger).
Short | Timing of the event
Control | 0..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())`)
1206. PlanDefinition.action:createReport.trigger.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..*
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())`)
1208. PlanDefinition.action:createReport.trigger.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
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())`)
1210. PlanDefinition.action:createReport.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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1212. PlanDefinition.action:createReport.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1214. PlanDefinition.action:createReport.condition.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
1216. PlanDefinition.action:createReport.condition.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
1218. PlanDefinition.action:createReport.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|4.0.1` ) 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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1220. PlanDefinition.action:createReport.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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1222. PlanDefinition.action:createReport.input
Definition | Defines input data requirements for the action. Required data is accessible via a context variable named `%[id]` using the `id` of the input data requirement
Short | Input data requirements
Control | 0..*
Type | DataRequirement
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())`)
1224. PlanDefinition.action:createReport.input.id
Definition | The id of the input requirement, allowing the data to be referenced via a context variable named `%[id]`
Short | Unique id for inter-element referencing
Control | 1..1
Type | string
Is Modifier | false
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1226. PlanDefinition.action:createReport.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.input.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
1228. PlanDefinition.action:createReport.input.type
Definition | The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.
Short | The type of the required data
Control | 1..1
Binding | The codes SHALL be taken from FHIRAllTypes (required to `http://hl7.org/fhir/ValueSet/all-types|4.0.1` ) A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1230. PlanDefinition.action:createReport.input.profile
Definition | The profile of the required data, specified as the uri of the profile definition.
Short | The profile of the required data
Control | 0..*
Type | canonical(StructureDefinition)
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())`)
1232. PlanDefinition.action:createReport.input.subject[x]
Definition | The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.
Short | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments | The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from SubjectType (extensible to `http://hl7.org/fhir/ValueSet/subject-type` ) The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
Type | Choice of: CodeableConcept, Reference(Group)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
Meaning if Missing | Patient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1234. PlanDefinition.action:createReport.input.mustSupport
Definition | Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).
Short | Indicates specific structure elements that are referenced by the knowledge module
Control | 0..*
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())`)
1236. PlanDefinition.action:createReport.input.codeFilter
Definition | Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.
Short | What codes are expected
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Invariants | drq-1: Either a path or a searchParam must be provided, but not both (`path.exists() xor searchParam.exists()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1238. PlanDefinition.action:createReport.input.codeFilter.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1240. PlanDefinition.action:createReport.input.codeFilter.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.input.codeFilter.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
1242. PlanDefinition.action:createReport.input.codeFilter.path
Definition | The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.
Short | A code-valued attribute to filter on
Comments | 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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1244. PlanDefinition.action:createReport.input.codeFilter.searchParam
Definition | A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.
Short | A coded (token) parameter to search on
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())`)
1246. PlanDefinition.action:createReport.input.codeFilter.valueSet
Definition | The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.
Short | Valueset for the filter
Control | 0..1
Type | canonical(ValueSet)
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())`)
1248. PlanDefinition.action:createReport.input.codeFilter.code
Definition | The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.
Short | What code is expected
Control | 0..*
Type | Coding
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1250. PlanDefinition.action:createReport.input.dateFilter
Definition | Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.
Short | What dates/date ranges are expected
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Invariants | drq-2: Either a path or a searchParam must be provided, but not both (`path.exists() xor searchParam.exists()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1252. PlanDefinition.action:createReport.input.dateFilter.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1254. PlanDefinition.action:createReport.input.dateFilter.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.input.dateFilter.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
1256. PlanDefinition.action:createReport.input.dateFilter.path
Definition | The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.
Short | A date-valued attribute to filter on
Comments | The path attribute contains a Simple FHIR 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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1258. PlanDefinition.action:createReport.input.dateFilter.searchParam
Definition | A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.
Short | A date valued parameter to search on
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())`)
1260. PlanDefinition.action:createReport.input.dateFilter.value[x]
Definition | The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.
Short | The value of the filter, as a Period, DateTime, or Duration value
Control | 0..1
Type | Choice of: dateTime, Period, Duration
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
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())`)
1262. PlanDefinition.action:createReport.input.limit
Definition | Specifies a maximum number of results that are required (uses the _count search parameter).
Short | Number of results
Comments | This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".
Control | 0..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Enables the requirement "most recent 5 results" to be expressed.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1264. PlanDefinition.action:createReport.input.sort
Definition | Specifies the order of the results to be returned.
Short | Order of the results
Comments | This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Requirements | Enables the requirement "most recent 5 results" to be expressed.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1266. PlanDefinition.action:createReport.input.sort.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1268. PlanDefinition.action:createReport.input.sort.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.input.sort.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
1270. PlanDefinition.action:createReport.input.sort.path
Definition | The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.
Short | The name of the attribute to perform the sort
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())`)
1272. PlanDefinition.action:createReport.input.sort.direction
Definition | The direction of the sort, ascending or descending.
Short | ascending | descending
Control | 1..1
Binding | The codes SHALL be taken from SortDirection (required to `http://hl7.org/fhir/ValueSet/sort-direction|4.0.1` ) The possible sort directions, ascending or descending.
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())`)
1274. PlanDefinition.action:createReport.output
Definition | Defines output produced by the action. Required data is accessible via a context variable named `%[id]` using the `id` of the output data requirement
Short | Output data definition
Control | 0..*
Type | DataRequirement
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())`)
1276. PlanDefinition.action:createReport.output.id
Definition | The id of the output produced, allowing the data to be referenced via a context variable named `%[id]`
Short | Unique id for inter-element referencing
Control | 1..1
Type | string
Is Modifier | false
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1278. PlanDefinition.action:createReport.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.output.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
1280. PlanDefinition.action:createReport.output.type
Definition | The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.
Short | The type of the required data
Control | 1..1
Binding | The codes SHALL be taken from FHIRAllTypes (required to `http://hl7.org/fhir/ValueSet/all-types|4.0.1` ) A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1282. PlanDefinition.action:createReport.output.profile
Definition | The profile of the required data, specified as the uri of the profile definition.
Short | The profile of the required data
Control | 0..*
Type | canonical(StructureDefinition)
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())`)
1284. PlanDefinition.action:createReport.output.subject[x]
Definition | The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.
Short | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments | The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from SubjectType (extensible to `http://hl7.org/fhir/ValueSet/subject-type` ) The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
Type | Choice of: CodeableConcept, Reference(Group)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
Meaning if Missing | Patient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1286. PlanDefinition.action:createReport.output.mustSupport
Definition | Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).
Short | Indicates specific structure elements that are referenced by the knowledge module
Control | 0..*
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())`)
1288. PlanDefinition.action:createReport.output.codeFilter
Definition | Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.
Short | What codes are expected
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Invariants | drq-1: Either a path or a searchParam must be provided, but not both (`path.exists() xor searchParam.exists()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1290. PlanDefinition.action:createReport.output.codeFilter.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1292. PlanDefinition.action:createReport.output.codeFilter.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.output.codeFilter.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
1294. PlanDefinition.action:createReport.output.codeFilter.path
Definition | The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.
Short | A code-valued attribute to filter on
Comments | 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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1296. PlanDefinition.action:createReport.output.codeFilter.searchParam
Definition | A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.
Short | A coded (token) parameter to search on
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())`)
1298. PlanDefinition.action:createReport.output.codeFilter.valueSet
Definition | The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.
Short | Valueset for the filter
Control | 0..1
Type | canonical(ValueSet)
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())`)
1300. PlanDefinition.action:createReport.output.codeFilter.code
Definition | The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.
Short | What code is expected
Control | 0..*
Type | Coding
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1302. PlanDefinition.action:createReport.output.dateFilter
Definition | Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.
Short | What dates/date ranges are expected
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Invariants | drq-2: Either a path or a searchParam must be provided, but not both (`path.exists() xor searchParam.exists()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1304. PlanDefinition.action:createReport.output.dateFilter.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1306. PlanDefinition.action:createReport.output.dateFilter.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.output.dateFilter.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
1308. PlanDefinition.action:createReport.output.dateFilter.path
Definition | The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.
Short | A date-valued attribute to filter on
Comments | The path attribute contains a Simple FHIR 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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1310. PlanDefinition.action:createReport.output.dateFilter.searchParam
Definition | A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.
Short | A date valued parameter to search on
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())`)
1312. PlanDefinition.action:createReport.output.dateFilter.value[x]
Definition | The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.
Short | The value of the filter, as a Period, DateTime, or Duration value
Control | 0..1
Type | Choice of: dateTime, Period, Duration
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
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())`)
1314. PlanDefinition.action:createReport.output.limit
Definition | Specifies a maximum number of results that are required (uses the _count search parameter).
Short | Number of results
Comments | This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".
Control | 0..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Enables the requirement "most recent 5 results" to be expressed.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1316. PlanDefinition.action:createReport.output.sort
Definition | Specifies the order of the results to be returned.
Short | Order of the results
Comments | This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Requirements | Enables the requirement "most recent 5 results" to be expressed.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1318. PlanDefinition.action:createReport.output.sort.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1320. PlanDefinition.action:createReport.output.sort.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.output.sort.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
1322. PlanDefinition.action:createReport.output.sort.path
Definition | The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.
Short | The name of the attribute to perform the sort
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())`)
1324. PlanDefinition.action:createReport.output.sort.direction
Definition | The direction of the sort, ascending or descending.
Short | ascending | descending
Control | 1..1
Binding | The codes SHALL be taken from SortDirection (required to `http://hl7.org/fhir/ValueSet/sort-direction|4.0.1` ) The possible sort directions, ascending or descending.
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())`)
1326. PlanDefinition.action:createReport.relatedAction
Definition | A relationship to another action such as "before" or "30-60 minutes after start of".
Short | Relationship to another action
Comments | When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.
Control | 0..*
Type | BackboneElement
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())`)
1328. PlanDefinition.action:createReport.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1330. PlanDefinition.action:createReport.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
1332. PlanDefinition.action:createReport.relatedAction.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
1334. PlanDefinition.action:createReport.relatedAction.actionId
Definition | The element id of the related action.
Short | What action is this related to
Control | 1..1
Type | id
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Fixed Value | `validate-hcs-report`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1336. PlanDefinition.action:createReport.relatedAction.relationship
Definition | The relationship of this action to the related action.
Short | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control | 1..1
Binding | The codes SHALL be taken from ActionRelationshipType (required to `http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1` ) 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 | true
Summary | false
Fixed Value | `before-start`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1338. PlanDefinition.action:createReport.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
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.relatedAction.offset[x]`. The slices areUnordered and Open, and can be differentiated using the following discriminators: type @ $this
1340. PlanDefinition.action:createReport.relatedAction.offset[x]:offsetDuration
Slice Name | offsetDuration
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 | Duration
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
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())`)
1342. PlanDefinition.action:createReport.timing[x]
Definition | An optional value describing when the action should be performed.
Short | When the action should take place
Control | 0..1
Type | Duration
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
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())`)
1344. PlanDefinition.action:createReport.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1346. PlanDefinition.action:createReport.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1348. PlanDefinition.action:createReport.participant.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
1350. PlanDefinition.action:createReport.participant.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
1352. PlanDefinition.action:createReport.participant.type
Definition | The type of participant in the action.
Short | patient | practitioner | related-person | device
Control | 1..1
Binding | The codes SHALL be taken from ActionParticipantType (required to `http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1` ) The type of participant for the action.
Type | code
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())`)
1354. PlanDefinition.action:createReport.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 ActionParticipantRole (example to `http://hl7.org/fhir/ValueSet/action-participant-role` ) Defines roles played by participants for the action.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1356. PlanDefinition.action:createReport.type
Definition | The type of action to perform (create, update, remove).
Short | create | update | remove | fire-event
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from ActionType (extensible to `http://hl7.org/fhir/ValueSet/action-type` ) The type of action to be performed.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1358. PlanDefinition.action:createReport.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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1360. PlanDefinition.action:createReport.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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1362. PlanDefinition.action:createReport.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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1364. PlanDefinition.action:createReport.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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1366. PlanDefinition.action:createReport.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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1368. PlanDefinition.action:createReport.definition[x]
Definition | A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.
Short | Description of the activity to be performed
Comments | Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically.
Control | 0..1
Type | Choice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1370. PlanDefinition.action:createReport.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1372. PlanDefinition.action:createReport.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1374. PlanDefinition.action:createReport.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1376. PlanDefinition.action:createReport.dynamicValue.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
1378. PlanDefinition.action:createReport.dynamicValue.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
1380. PlanDefinition.action:createReport.dynamicValue.path
Definition | The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).
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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1382. PlanDefinition.action:createReport.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1384. PlanDefinition.action:createReport.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1386. PlanDefinition.action:validateReport
Slice Name | validateReport
Definition | An action or group of actions to be taken as part of the plan.
Short | All constraints on action are intended to apply to any nested constraints.
Comments | Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.
Control | 1..1
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1388. PlanDefinition.action:validateReport.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 | 1..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Pattern Value | `validate-hcs-report`
1390. PlanDefinition.action:validateReport.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
1392. PlanDefinition.action:validateReport.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
1394. PlanDefinition.action:validateReport.prefix
Definition | A user-visible prefix for the action.
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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1396. PlanDefinition.action:validateReport.title
Definition | The title of the action displayed to a user.
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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1398. PlanDefinition.action:validateReport.description
Definition | A brief description of the action used to provide a summary to display to the user.
Short | Brief description of the action
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Pattern Value | `Validate HCS report action.`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1400. PlanDefinition.action:validateReport.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 | string
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())`)
1402. PlanDefinition.action:validateReport.priority
Definition | Indicates how quickly the action should be addressed with respect to other actions.
Short | routine | urgent | asap | stat
Control | 0..1
Binding | The codes SHALL be taken from RequestPriority (required to `http://hl7.org/fhir/ValueSet/request-priority|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1404. PlanDefinition.action:validateReport.code
Definition | A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.
Short | Code representing the meaning of the action or sub-actions
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from US Public Health VaueSet - PlanDefinition Action (extensible to `http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-plandefinition-action` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Pattern Value | `{ "coding" : [{ "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions", "code" : "validate-report" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1406. PlanDefinition.action:validateReport.reason
Definition | A description of why this action is necessary or appropriate.
Short | Why the action should be performed
Comments | This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action.
Control | 0..*
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1408. PlanDefinition.action:validateReport.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1410. PlanDefinition.action:validateReport.goalId
Definition | Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.
Short | What goals this action supports
Control | 0..*
Type | id
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())`)
1412. PlanDefinition.action:validateReport.subject[x]
Definition | A code or group definition that describes the intended subject of the action and its children, if any.
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 SubjectType (extensible to `http://hl7.org/fhir/ValueSet/subject-type` ) The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
Type | Choice of: CodeableConcept, Reference(Group)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | 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())`)
1414. PlanDefinition.action:validateReport.trigger
Definition | A description of when the action should be triggered.
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())`)
1416. PlanDefinition.action:validateReport.trigger.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1418. PlanDefinition.action:validateReport.trigger.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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
1420. PlanDefinition.action:validateReport.trigger.extension:namedEventType
Slice Name | namedEventType
Definition | Indicates the types of named events to subscribe to from the EHR.
Short | US Public Health Named Event Type Extension
Control | 0..1
Type | Extension(US Public Health Named Event Type Extension) (Extension 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())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
1422. PlanDefinition.action:validateReport.trigger.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
Binding | The codes SHALL be taken from TriggerType (required to `http://hl7.org/fhir/ValueSet/trigger-type|4.0.1` ) The type of trigger.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Fixed Value | `named-event`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1424. PlanDefinition.action:validateReport.trigger.name
Definition | 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 | 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())`)
1426. PlanDefinition.action:validateReport.trigger.timing[x]
Definition | The timing of the event (if this is a periodic trigger).
Short | Timing of the event
Control | 0..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())`)
1428. PlanDefinition.action:validateReport.trigger.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..*
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())`)
1430. PlanDefinition.action:validateReport.trigger.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
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())`)
1432. PlanDefinition.action:validateReport.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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1434. PlanDefinition.action:validateReport.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1436. PlanDefinition.action:validateReport.condition.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
1438. PlanDefinition.action:validateReport.condition.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
1440. PlanDefinition.action:validateReport.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|4.0.1` ) 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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1442. PlanDefinition.action:validateReport.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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1444. PlanDefinition.action:validateReport.input
Definition | Defines input data requirements for the action. Required data is accessible via a context variable named `%[id]` using the `id` of the input data requirement
Short | Input data requirements
Control | 0..*
Type | DataRequirement
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())`)
1446. PlanDefinition.action:validateReport.input.id
Definition | The id of the input requirement, allowing the data to be referenced via a context variable named `%[id]`
Short | Unique id for inter-element referencing
Control | 1..1
Type | string
Is Modifier | false
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1448. PlanDefinition.action:validateReport.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.input.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
1450. PlanDefinition.action:validateReport.input.type
Definition | The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.
Short | The type of the required data
Control | 1..1
Binding | The codes SHALL be taken from FHIRAllTypes (required to `http://hl7.org/fhir/ValueSet/all-types|4.0.1` ) A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1452. PlanDefinition.action:validateReport.input.profile
Definition | The profile of the required data, specified as the uri of the profile definition.
Short | The profile of the required data
Control | 0..*
Type | canonical(StructureDefinition)
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())`)
1454. PlanDefinition.action:validateReport.input.subject[x]
Definition | The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.
Short | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments | The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from SubjectType (extensible to `http://hl7.org/fhir/ValueSet/subject-type` ) The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
Type | Choice of: CodeableConcept, Reference(Group)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
Meaning if Missing | Patient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1456. PlanDefinition.action:validateReport.input.mustSupport
Definition | Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).
Short | Indicates specific structure elements that are referenced by the knowledge module
Control | 0..*
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())`)
1458. PlanDefinition.action:validateReport.input.codeFilter
Definition | Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.
Short | What codes are expected
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Invariants | drq-1: Either a path or a searchParam must be provided, but not both (`path.exists() xor searchParam.exists()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1460. PlanDefinition.action:validateReport.input.codeFilter.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1462. PlanDefinition.action:validateReport.input.codeFilter.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.input.codeFilter.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
1464. PlanDefinition.action:validateReport.input.codeFilter.path
Definition | The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.
Short | A code-valued attribute to filter on
Comments | 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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1466. PlanDefinition.action:validateReport.input.codeFilter.searchParam
Definition | A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.
Short | A coded (token) parameter to search on
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())`)
1468. PlanDefinition.action:validateReport.input.codeFilter.valueSet
Definition | The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.
Short | Valueset for the filter
Control | 0..1
Type | canonical(ValueSet)
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())`)
1470. PlanDefinition.action:validateReport.input.codeFilter.code
Definition | The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.
Short | What code is expected
Control | 0..*
Type | Coding
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1472. PlanDefinition.action:validateReport.input.dateFilter
Definition | Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.
Short | What dates/date ranges are expected
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Invariants | drq-2: Either a path or a searchParam must be provided, but not both (`path.exists() xor searchParam.exists()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1474. PlanDefinition.action:validateReport.input.dateFilter.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1476. PlanDefinition.action:validateReport.input.dateFilter.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.input.dateFilter.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
1478. PlanDefinition.action:validateReport.input.dateFilter.path
Definition | The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.
Short | A date-valued attribute to filter on
Comments | The path attribute contains a Simple FHIR 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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1480. PlanDefinition.action:validateReport.input.dateFilter.searchParam
Definition | A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.
Short | A date valued parameter to search on
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())`)
1482. PlanDefinition.action:validateReport.input.dateFilter.value[x]
Definition | The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.
Short | The value of the filter, as a Period, DateTime, or Duration value
Control | 0..1
Type | Choice of: dateTime, Period, Duration
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
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())`)
1484. PlanDefinition.action:validateReport.input.limit
Definition | Specifies a maximum number of results that are required (uses the _count search parameter).
Short | Number of results
Comments | This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".
Control | 0..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Enables the requirement "most recent 5 results" to be expressed.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1486. PlanDefinition.action:validateReport.input.sort
Definition | Specifies the order of the results to be returned.
Short | Order of the results
Comments | This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Requirements | Enables the requirement "most recent 5 results" to be expressed.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1488. PlanDefinition.action:validateReport.input.sort.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1490. PlanDefinition.action:validateReport.input.sort.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.input.sort.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
1492. PlanDefinition.action:validateReport.input.sort.path
Definition | The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.
Short | The name of the attribute to perform the sort
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())`)
1494. PlanDefinition.action:validateReport.input.sort.direction
Definition | The direction of the sort, ascending or descending.
Short | ascending | descending
Control | 1..1
Binding | The codes SHALL be taken from SortDirection (required to `http://hl7.org/fhir/ValueSet/sort-direction|4.0.1` ) The possible sort directions, ascending or descending.
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())`)
1496. PlanDefinition.action:validateReport.output
Definition | Defines output produced by the action. Required data is accessible via a context variable named `%[id]` using the `id` of the output data requirement
Short | Output data definition
Control | 0..*
Type | DataRequirement
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())`)
1498. PlanDefinition.action:validateReport.output.id
Definition | The id of the output produced, allowing the data to be referenced via a context variable named `%[id]`
Short | Unique id for inter-element referencing
Control | 1..1
Type | string
Is Modifier | false
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1500. PlanDefinition.action:validateReport.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.output.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
1502. PlanDefinition.action:validateReport.output.type
Definition | The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.
Short | The type of the required data
Control | 1..1
Binding | The codes SHALL be taken from FHIRAllTypes (required to `http://hl7.org/fhir/ValueSet/all-types|4.0.1` ) A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1504. PlanDefinition.action:validateReport.output.profile
Definition | The profile of the required data, specified as the uri of the profile definition.
Short | The profile of the required data
Control | 0..*
Type | canonical(StructureDefinition)
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())`)
1506. PlanDefinition.action:validateReport.output.subject[x]
Definition | The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.
Short | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments | The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from SubjectType (extensible to `http://hl7.org/fhir/ValueSet/subject-type` ) The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
Type | Choice of: CodeableConcept, Reference(Group)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
Meaning if Missing | Patient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1508. PlanDefinition.action:validateReport.output.mustSupport
Definition | Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).
Short | Indicates specific structure elements that are referenced by the knowledge module
Control | 0..*
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())`)
1510. PlanDefinition.action:validateReport.output.codeFilter
Definition | Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.
Short | What codes are expected
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Invariants | drq-1: Either a path or a searchParam must be provided, but not both (`path.exists() xor searchParam.exists()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1512. PlanDefinition.action:validateReport.output.codeFilter.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1514. PlanDefinition.action:validateReport.output.codeFilter.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.output.codeFilter.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
1516. PlanDefinition.action:validateReport.output.codeFilter.path
Definition | The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.
Short | A code-valued attribute to filter on
Comments | 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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1518. PlanDefinition.action:validateReport.output.codeFilter.searchParam
Definition | A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.
Short | A coded (token) parameter to search on
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())`)
1520. PlanDefinition.action:validateReport.output.codeFilter.valueSet
Definition | The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.
Short | Valueset for the filter
Control | 0..1
Type | canonical(ValueSet)
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())`)
1522. PlanDefinition.action:validateReport.output.codeFilter.code
Definition | The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.
Short | What code is expected
Control | 0..*
Type | Coding
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1524. PlanDefinition.action:validateReport.output.dateFilter
Definition | Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.
Short | What dates/date ranges are expected
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Invariants | drq-2: Either a path or a searchParam must be provided, but not both (`path.exists() xor searchParam.exists()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1526. PlanDefinition.action:validateReport.output.dateFilter.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1528. PlanDefinition.action:validateReport.output.dateFilter.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.output.dateFilter.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
1530. PlanDefinition.action:validateReport.output.dateFilter.path
Definition | The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.
Short | A date-valued attribute to filter on
Comments | The path attribute contains a Simple FHIR 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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1532. PlanDefinition.action:validateReport.output.dateFilter.searchParam
Definition | A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.
Short | A date valued parameter to search on
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())`)
1534. PlanDefinition.action:validateReport.output.dateFilter.value[x]
Definition | The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.
Short | The value of the filter, as a Period, DateTime, or Duration value
Control | 0..1
Type | Choice of: dateTime, Period, Duration
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
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())`)
1536. PlanDefinition.action:validateReport.output.limit
Definition | Specifies a maximum number of results that are required (uses the _count search parameter).
Short | Number of results
Comments | This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".
Control | 0..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Enables the requirement "most recent 5 results" to be expressed.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1538. PlanDefinition.action:validateReport.output.sort
Definition | Specifies the order of the results to be returned.
Short | Order of the results
Comments | This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Requirements | Enables the requirement "most recent 5 results" to be expressed.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1540. PlanDefinition.action:validateReport.output.sort.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1542. PlanDefinition.action:validateReport.output.sort.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.output.sort.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
1544. PlanDefinition.action:validateReport.output.sort.path
Definition | The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.
Short | The name of the attribute to perform the sort
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())`)
1546. PlanDefinition.action:validateReport.output.sort.direction
Definition | The direction of the sort, ascending or descending.
Short | ascending | descending
Control | 1..1
Binding | The codes SHALL be taken from SortDirection (required to `http://hl7.org/fhir/ValueSet/sort-direction|4.0.1` ) The possible sort directions, ascending or descending.
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())`)
1548. PlanDefinition.action:validateReport.relatedAction
Definition | A relationship to another action such as "before" or "30-60 minutes after start of".
Short | Relationship to another action
Comments | When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.
Control | 0..*
Type | BackboneElement
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())`)
1550. PlanDefinition.action:validateReport.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1552. PlanDefinition.action:validateReport.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
1554. PlanDefinition.action:validateReport.relatedAction.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
1556. PlanDefinition.action:validateReport.relatedAction.actionId
Definition | The element id of the related action.
Short | What action is this related to
Control | 1..1
Type | id
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Fixed Value | `submit-hcs-report`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1558. PlanDefinition.action:validateReport.relatedAction.relationship
Definition | The relationship of this action to the related action.
Short | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control | 1..1
Binding | The codes SHALL be taken from ActionRelationshipType (required to `http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1` ) 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 | true
Summary | false
Fixed Value | `before-start`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1560. PlanDefinition.action:validateReport.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
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.relatedAction.offset[x]`. The slices areUnordered and Open, and can be differentiated using the following discriminators: type @ $this
1562. PlanDefinition.action:validateReport.relatedAction.offset[x]:offsetDuration
Slice Name | offsetDuration
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 | Duration
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
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())`)
1564. PlanDefinition.action:validateReport.timing[x]
Definition | An optional value describing when the action should be performed.
Short | When the action should take place
Control | 0..1
Type | Duration
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
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())`)
1566. PlanDefinition.action:validateReport.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1568. PlanDefinition.action:validateReport.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1570. PlanDefinition.action:validateReport.participant.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
1572. PlanDefinition.action:validateReport.participant.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
1574. PlanDefinition.action:validateReport.participant.type
Definition | The type of participant in the action.
Short | patient | practitioner | related-person | device
Control | 1..1
Binding | The codes SHALL be taken from ActionParticipantType (required to `http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1` ) The type of participant for the action.
Type | code
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())`)
1576. PlanDefinition.action:validateReport.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 ActionParticipantRole (example to `http://hl7.org/fhir/ValueSet/action-participant-role` ) Defines roles played by participants for the action.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1578. PlanDefinition.action:validateReport.type
Definition | The type of action to perform (create, update, remove).
Short | create | update | remove | fire-event
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from ActionType (extensible to `http://hl7.org/fhir/ValueSet/action-type` ) The type of action to be performed.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1580. PlanDefinition.action:validateReport.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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1582. PlanDefinition.action:validateReport.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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1584. PlanDefinition.action:validateReport.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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1586. PlanDefinition.action:validateReport.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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1588. PlanDefinition.action:validateReport.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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1590. PlanDefinition.action:validateReport.definition[x]
Definition | A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.
Short | Description of the activity to be performed
Comments | Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically.
Control | 0..1
Type | Choice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1592. PlanDefinition.action:validateReport.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1594. PlanDefinition.action:validateReport.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1596. PlanDefinition.action:validateReport.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1598. PlanDefinition.action:validateReport.dynamicValue.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
1600. PlanDefinition.action:validateReport.dynamicValue.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
1602. PlanDefinition.action:validateReport.dynamicValue.path
Definition | The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).
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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1604. PlanDefinition.action:validateReport.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1606. PlanDefinition.action:validateReport.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1608. PlanDefinition.action:submitHcsReport
Slice Name | submitHcsReport
Definition | An action or group of actions to be taken as part of the plan.
Short | All constraints on action are intended to apply to any nested constraints.
Comments | Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.
Control | 1..1
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1610. PlanDefinition.action:submitHcsReport.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 | 1..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Pattern Value | `submit-hcs-report`
1612. PlanDefinition.action:submitHcsReport.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
1614. PlanDefinition.action:submitHcsReport.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
1616. PlanDefinition.action:submitHcsReport.prefix
Definition | A user-visible prefix for the action.
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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1618. PlanDefinition.action:submitHcsReport.title
Definition | The title of the action displayed to a user.
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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1620. PlanDefinition.action:submitHcsReport.description
Definition | A brief description of the action used to provide a summary to display to the user.
Short | Brief description of the action
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Pattern Value | `Submit HCS report action.`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1622. PlanDefinition.action:submitHcsReport.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 | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Fixed Value | `Route and send HCS Report`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1624. PlanDefinition.action:submitHcsReport.priority
Definition | Indicates how quickly the action should be addressed with respect to other actions.
Short | routine | urgent | asap | stat
Control | 0..1
Binding | The codes SHALL be taken from RequestPriority (required to `http://hl7.org/fhir/ValueSet/request-priority|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1626. PlanDefinition.action:submitHcsReport.code
Definition | A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.
Short | Code representing the meaning of the action or sub-actions
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from US Public Health VaueSet - PlanDefinition Action (extensible to `http://hl7.org/fhir/us/ph-library/ValueSet/us-ph-valueset-plandefinition-action` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Pattern Value | `{ "coding" : [{ "system" : "http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions", "code" : "submit-report" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1628. PlanDefinition.action:submitHcsReport.reason
Definition | A description of why this action is necessary or appropriate.
Short | Why the action should be performed
Comments | This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action.
Control | 0..*
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1630. PlanDefinition.action:submitHcsReport.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1632. PlanDefinition.action:submitHcsReport.goalId
Definition | Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.
Short | What goals this action supports
Control | 0..*
Type | id
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())`)
1634. PlanDefinition.action:submitHcsReport.subject[x]
Definition | A code or group definition that describes the intended subject of the action and its children, if any.
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 SubjectType (extensible to `http://hl7.org/fhir/ValueSet/subject-type` ) The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
Type | Choice of: CodeableConcept, Reference(Group)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | 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())`)
1636. PlanDefinition.action:submitHcsReport.trigger
Definition | A description of when the action should be triggered.
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())`)
1638. PlanDefinition.action:submitHcsReport.trigger.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1640. PlanDefinition.action:submitHcsReport.trigger.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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
1642. PlanDefinition.action:submitHcsReport.trigger.extension:namedEventType
Slice Name | namedEventType
Definition | Indicates the types of named events to subscribe to from the EHR.
Short | US Public Health Named Event Type Extension
Control | 0..1
Type | Extension(US Public Health Named Event Type Extension) (Extension 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())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
1644. PlanDefinition.action:submitHcsReport.trigger.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
Binding | The codes SHALL be taken from TriggerType (required to `http://hl7.org/fhir/ValueSet/trigger-type|4.0.1` ) The type of trigger.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Fixed Value | `named-event`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1646. PlanDefinition.action:submitHcsReport.trigger.name
Definition | 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 | 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())`)
1648. PlanDefinition.action:submitHcsReport.trigger.timing[x]
Definition | The timing of the event (if this is a periodic trigger).
Short | Timing of the event
Control | 0..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())`)
1650. PlanDefinition.action:submitHcsReport.trigger.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..*
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())`)
1652. PlanDefinition.action:submitHcsReport.trigger.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
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())`)
1654. PlanDefinition.action:submitHcsReport.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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1656. PlanDefinition.action:submitHcsReport.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1658. PlanDefinition.action:submitHcsReport.condition.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
1660. PlanDefinition.action:submitHcsReport.condition.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
1662. PlanDefinition.action:submitHcsReport.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|4.0.1` ) 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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1664. PlanDefinition.action:submitHcsReport.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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1666. PlanDefinition.action:submitHcsReport.input
Definition | Defines input data requirements for the action. Required data is accessible via a context variable named `%[id]` using the `id` of the input data requirement
Short | Input data requirements
Control | 0..*
Type | DataRequirement
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())`)
1668. PlanDefinition.action:submitHcsReport.input.id
Definition | The id of the input requirement, allowing the data to be referenced via a context variable named `%[id]`
Short | Unique id for inter-element referencing
Control | 1..1
Type | string
Is Modifier | false
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1670. PlanDefinition.action:submitHcsReport.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.input.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
1672. PlanDefinition.action:submitHcsReport.input.type
Definition | The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.
Short | The type of the required data
Control | 1..1
Binding | The codes SHALL be taken from FHIRAllTypes (required to `http://hl7.org/fhir/ValueSet/all-types|4.0.1` ) A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1674. PlanDefinition.action:submitHcsReport.input.profile
Definition | The profile of the required data, specified as the uri of the profile definition.
Short | The profile of the required data
Control | 0..*
Type | canonical(StructureDefinition)
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())`)
1676. PlanDefinition.action:submitHcsReport.input.subject[x]
Definition | The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.
Short | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments | The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from SubjectType (extensible to `http://hl7.org/fhir/ValueSet/subject-type` ) The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
Type | Choice of: CodeableConcept, Reference(Group)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
Meaning if Missing | Patient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1678. PlanDefinition.action:submitHcsReport.input.mustSupport
Definition | Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).
Short | Indicates specific structure elements that are referenced by the knowledge module
Control | 0..*
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())`)
1680. PlanDefinition.action:submitHcsReport.input.codeFilter
Definition | Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.
Short | What codes are expected
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Invariants | drq-1: Either a path or a searchParam must be provided, but not both (`path.exists() xor searchParam.exists()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1682. PlanDefinition.action:submitHcsReport.input.codeFilter.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1684. PlanDefinition.action:submitHcsReport.input.codeFilter.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.input.codeFilter.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
1686. PlanDefinition.action:submitHcsReport.input.codeFilter.path
Definition | The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.
Short | A code-valued attribute to filter on
Comments | 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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1688. PlanDefinition.action:submitHcsReport.input.codeFilter.searchParam
Definition | A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.
Short | A coded (token) parameter to search on
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())`)
1690. PlanDefinition.action:submitHcsReport.input.codeFilter.valueSet
Definition | The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.
Short | Valueset for the filter
Control | 0..1
Type | canonical(ValueSet)
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())`)
1692. PlanDefinition.action:submitHcsReport.input.codeFilter.code
Definition | The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.
Short | What code is expected
Control | 0..*
Type | Coding
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1694. PlanDefinition.action:submitHcsReport.input.dateFilter
Definition | Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.
Short | What dates/date ranges are expected
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Invariants | drq-2: Either a path or a searchParam must be provided, but not both (`path.exists() xor searchParam.exists()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1696. PlanDefinition.action:submitHcsReport.input.dateFilter.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1698. PlanDefinition.action:submitHcsReport.input.dateFilter.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.input.dateFilter.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
1700. PlanDefinition.action:submitHcsReport.input.dateFilter.path
Definition | The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.
Short | A date-valued attribute to filter on
Comments | The path attribute contains a Simple FHIR 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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1702. PlanDefinition.action:submitHcsReport.input.dateFilter.searchParam
Definition | A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.
Short | A date valued parameter to search on
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())`)
1704. PlanDefinition.action:submitHcsReport.input.dateFilter.value[x]
Definition | The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.
Short | The value of the filter, as a Period, DateTime, or Duration value
Control | 0..1
Type | Choice of: dateTime, Period, Duration
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
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())`)
1706. PlanDefinition.action:submitHcsReport.input.limit
Definition | Specifies a maximum number of results that are required (uses the _count search parameter).
Short | Number of results
Comments | This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".
Control | 0..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Enables the requirement "most recent 5 results" to be expressed.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1708. PlanDefinition.action:submitHcsReport.input.sort
Definition | Specifies the order of the results to be returned.
Short | Order of the results
Comments | This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Requirements | Enables the requirement "most recent 5 results" to be expressed.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1710. PlanDefinition.action:submitHcsReport.input.sort.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1712. PlanDefinition.action:submitHcsReport.input.sort.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.input.sort.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
1714. PlanDefinition.action:submitHcsReport.input.sort.path
Definition | The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.
Short | The name of the attribute to perform the sort
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())`)
1716. PlanDefinition.action:submitHcsReport.input.sort.direction
Definition | The direction of the sort, ascending or descending.
Short | ascending | descending
Control | 1..1
Binding | The codes SHALL be taken from SortDirection (required to `http://hl7.org/fhir/ValueSet/sort-direction|4.0.1` ) The possible sort directions, ascending or descending.
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())`)
1718. PlanDefinition.action:submitHcsReport.output
Definition | Defines the outputs of the action, if any.
Short | Output data definition
Control | 0..*
Type | DataRequirement
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())`)
1720. PlanDefinition.action:submitHcsReport.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1722. PlanDefinition.action:submitHcsReport.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.output.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
1724. PlanDefinition.action:submitHcsReport.output.type
Definition | The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.
Short | The type of the required data
Control | 1..1
Binding | The codes SHALL be taken from FHIRAllTypes (required to `http://hl7.org/fhir/ValueSet/all-types|4.0.1` ) A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1726. PlanDefinition.action:submitHcsReport.output.profile
Definition | The profile of the required data, specified as the uri of the profile definition.
Short | The profile of the required data
Control | 0..*
Type | canonical(StructureDefinition)
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())`)
1728. PlanDefinition.action:submitHcsReport.output.subject[x]
Definition | The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.
Short | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Comments | The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from SubjectType (extensible to `http://hl7.org/fhir/ValueSet/subject-type` ) The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
Type | Choice of: CodeableConcept, Reference(Group)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | true
Meaning if Missing | Patient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1730. PlanDefinition.action:submitHcsReport.output.mustSupport
Definition | Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).
Short | Indicates specific structure elements that are referenced by the knowledge module
Control | 0..*
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())`)
1732. PlanDefinition.action:submitHcsReport.output.codeFilter
Definition | Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.
Short | What codes are expected
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Invariants | drq-1: Either a path or a searchParam must be provided, but not both (`path.exists() xor searchParam.exists()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1734. PlanDefinition.action:submitHcsReport.output.codeFilter.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1736. PlanDefinition.action:submitHcsReport.output.codeFilter.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.output.codeFilter.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
1738. PlanDefinition.action:submitHcsReport.output.codeFilter.path
Definition | The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.
Short | A code-valued attribute to filter on
Comments | 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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1740. PlanDefinition.action:submitHcsReport.output.codeFilter.searchParam
Definition | A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.
Short | A coded (token) parameter to search on
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())`)
1742. PlanDefinition.action:submitHcsReport.output.codeFilter.valueSet
Definition | The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.
Short | Valueset for the filter
Control | 0..1
Type | canonical(ValueSet)
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())`)
1744. PlanDefinition.action:submitHcsReport.output.codeFilter.code
Definition | The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.
Short | What code is expected
Control | 0..*
Type | Coding
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1746. PlanDefinition.action:submitHcsReport.output.dateFilter
Definition | Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.
Short | What dates/date ranges are expected
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Invariants | drq-2: Either a path or a searchParam must be provided, but not both (`path.exists() xor searchParam.exists()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1748. PlanDefinition.action:submitHcsReport.output.dateFilter.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1750. PlanDefinition.action:submitHcsReport.output.dateFilter.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.output.dateFilter.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
1752. PlanDefinition.action:submitHcsReport.output.dateFilter.path
Definition | The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.
Short | A date-valued attribute to filter on
Comments | The path attribute contains a Simple FHIR 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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1754. PlanDefinition.action:submitHcsReport.output.dateFilter.searchParam
Definition | A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.
Short | A date valued parameter to search on
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())`)
1756. PlanDefinition.action:submitHcsReport.output.dateFilter.value[x]
Definition | The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.
Short | The value of the filter, as a Period, DateTime, or Duration value
Control | 0..1
Type | Choice of: dateTime, Period, Duration
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
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())`)
1758. PlanDefinition.action:submitHcsReport.output.limit
Definition | Specifies a maximum number of results that are required (uses the _count search parameter).
Short | Number of results
Comments | This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".
Control | 0..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Enables the requirement "most recent 5 results" to be expressed.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1760. PlanDefinition.action:submitHcsReport.output.sort
Definition | Specifies the order of the results to be returned.
Short | Order of the results
Comments | This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.
Control | 0..*
Type | Element
Is Modifier | false
Summary | true
Requirements | Enables the requirement "most recent 5 results" to be expressed.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1762. PlanDefinition.action:submitHcsReport.output.sort.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1764. PlanDefinition.action:submitHcsReport.output.sort.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.output.sort.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
1766. PlanDefinition.action:submitHcsReport.output.sort.path
Definition | The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.
Short | The name of the attribute to perform the sort
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())`)
1768. PlanDefinition.action:submitHcsReport.output.sort.direction
Definition | The direction of the sort, ascending or descending.
Short | ascending | descending
Control | 1..1
Binding | The codes SHALL be taken from SortDirection (required to `http://hl7.org/fhir/ValueSet/sort-direction|4.0.1` ) The possible sort directions, ascending or descending.
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())`)
1770. PlanDefinition.action:submitHcsReport.relatedAction
Definition | A relationship to another action such as "before" or "30-60 minutes after start of".
Short | Relationship to another action
Comments | When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.
Control | 0..*
Type | BackboneElement
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())`)
1772. PlanDefinition.action:submitHcsReport.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1774. PlanDefinition.action:submitHcsReport.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
1776. PlanDefinition.action:submitHcsReport.relatedAction.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
1778. PlanDefinition.action:submitHcsReport.relatedAction.actionId
Definition | The element id of the related action.
Short | What action is this related to
Control | 1..1
Type | id
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())`)
1780. PlanDefinition.action:submitHcsReport.relatedAction.relationship
Definition | The relationship of this action to the related action.
Short | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Control | 1..1
Binding | The codes SHALL be taken from ActionRelationshipType (required to `http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1` ) 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 | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1782. PlanDefinition.action:submitHcsReport.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
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.relatedAction.offset[x]`. The slices areUnordered and Open, and can be differentiated using the following discriminators: type @ $this
1784. PlanDefinition.action:submitHcsReport.relatedAction.offset[x]:offsetDuration
Slice Name | offsetDuration
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 | Duration
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
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())`)
1786. PlanDefinition.action:submitHcsReport.timing[x]
Definition | An optional value describing when the action should be performed.
Short | When the action should take place
Control | 0..1
Type | Duration
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
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())`)
1788. PlanDefinition.action:submitHcsReport.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1790. PlanDefinition.action:submitHcsReport.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1792. PlanDefinition.action:submitHcsReport.participant.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
1794. PlanDefinition.action:submitHcsReport.participant.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
1796. PlanDefinition.action:submitHcsReport.participant.type
Definition | The type of participant in the action.
Short | patient | practitioner | related-person | device
Control | 1..1
Binding | The codes SHALL be taken from ActionParticipantType (required to `http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1` ) The type of participant for the action.
Type | code
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())`)
1798. PlanDefinition.action:submitHcsReport.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 ActionParticipantRole (example to `http://hl7.org/fhir/ValueSet/action-participant-role` ) Defines roles played by participants for the action.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1800. PlanDefinition.action:submitHcsReport.type
Definition | The type of action to perform (create, update, remove).
Short | create | update | remove | fire-event
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from ActionType (extensible to `http://hl7.org/fhir/ValueSet/action-type` ) The type of action to be performed.
Type | CodeableConcept
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1802. PlanDefinition.action:submitHcsReport.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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1804. PlanDefinition.action:submitHcsReport.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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1806. PlanDefinition.action:submitHcsReport.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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1808. PlanDefinition.action:submitHcsReport.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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1810. PlanDefinition.action:submitHcsReport.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|4.0.1` ) 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1812. PlanDefinition.action:submitHcsReport.definition[x]
Definition | A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.
Short | Description of the activity to be performed
Comments | Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically.
Control | 0..1
Type | Choice of: canonical(ActivityDefinition, PlanDefinition, Questionnaire), 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1814. PlanDefinition.action:submitHcsReport.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1816. PlanDefinition.action:submitHcsReport.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1818. PlanDefinition.action:submitHcsReport.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
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
1820. PlanDefinition.action:submitHcsReport.dynamicValue.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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()`)
1822. PlanDefinition.action:submitHcsReport.dynamicValue.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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()`)
1824. PlanDefinition.action:submitHcsReport.dynamicValue.path
Definition | The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).
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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1826. PlanDefinition.action:submitHcsReport.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
1828. PlanDefinition.action:submitHcsReport.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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)