Path | Short | Definition | Comments |
---|---|---|---|
A group of related requests | A group of related requests that can be used to capture intended activities that have inter-dependencies such as "give this medication after that one". | ||
identifier | Business identifier | Allows a service to provide a unique, business identifier for the request. | |
instantiatesCanonical | Instantiates FHIR protocol or definition | A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request. | |
instantiatesUri | Instantiates external protocol or definition | A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request. | |
basedOn | Fulfills plan, proposal, or order | A plan, proposal or order that is fulfilled in whole or in part by this request. | |
replaces | Request(s) replaced by this request | Completed or terminated request(s) whose function is taken by this new request. | The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing. |
groupIdentifier | Composite request this is part of | A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form. | Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation. |
status | draft | active | suspended | cancelled | completed | entered-in-error | unknown | The current state of the request. For request groups, the status reflects the status of all the requests in the group. | |
intent | proposal | plan | order | Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain. | |
priority | routine | urgent | asap | stat | Indicates how quickly the request should be addressed with respect to other requests. | |
code | What's being requested/ordered | A code that identifies what the overall request group is. | This element can be used to provide a code that captures the meaning of the request group as a whole, as opposed to the code of the action element, which captures the meaning of the individual actions within the request group. |
subject | Who the request group is about | The subject for which the request group was created. | |
context | Encounter or Episode for the request group | Describes the context of the request group, if any. | |
authoredOn | When the request group was authored | Indicates when the request group was created. | |
author | Device or practitioner that authored the request group | Provides a reference to the author of the request group. | |
reasonCode | Why the request group is needed | Describes the reason for the request group in coded or textual form. | |
reasonReference | Why the request group is needed | Indicates another resource whose existence justifies this request group. | |
note | Additional notes about the response | Provides a mechanism to communicate additional information about the response. | |
action | Proposed actions, if any | The actions, if any, produced by the evaluation of the artifact. | |
action.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
action.extension | Additional content defined by implementations | 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. | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
action.modifierExtension | Extensions that cannot be ignored even if unrecognized | 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). | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
action.prefix | User-visible prefix for the action (e.g. 1. or A.) | A user-visible prefix for the action. | |
action.title | User-visible title | The title of the action displayed to a user. | |
action.description | Short description of the action | A short description of the action used to provide a summary to display to the user. | |
action.textEquivalent | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system | 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. | |
action.priority | routine | urgent | asap | stat | Indicates how quickly the action should be addressed with respect to other actions. | |
action.code | Code representing the meaning of the action or sub-actions | A code that provides meaning for the action or action group. For example, a section may have a LOINC code for a section of a documentation template. | |
action.documentation | Supporting documentation for the intended performer of the action | 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. | |
action.condition | Whether or not the action is applicable | An expression that describes applicability criteria, or start/stop conditions for the action. | 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 of the conditions are true. |
action.condition.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
action.condition.extension | Additional content defined by implementations | 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. | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
action.condition.modifierExtension | Extensions that cannot be ignored even if unrecognized | 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). | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
action.condition.kind | applicability | start | stop | The kind of condition. | 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. |
action.condition.description | Natural language description of the condition | A brief, natural language description of the condition that effectively communicates the intended semantics. | |
action.condition.language | Language of the expression | The media type of the language for the expression. | |
action.condition.expression | Boolean-valued expression | An expression that returns true or false, indicating whether or not the condition is satisfied. | The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element. |
action.relatedAction | Relationship to another action | A relationship to another action such as "before" or "30-60 minutes after start of". | |
action.relatedAction.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
action.relatedAction.extension | Additional content defined by implementations | 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. | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
action.relatedAction.modifierExtension | Extensions that cannot be ignored even if unrecognized | 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). | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
action.relatedAction.actionId | What action this is related to | The element id of the action this is related to. | |
action.relatedAction.relationship | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end | The relationship of this action to the related action. | |
action.relatedAction.offset[x] | Time offset for the relationship | A duration or range of durations to apply to the relationship. For example, 30-60 minutes before. | |
action.timing[x] | When the action should take place | An optional value describing when the action should be performed. | |
action.participant | Who should perform the action | The participant that should perform or be responsible for this action. | |
action.type | create | update | remove | fire-event | The type of action to perform (create, update, remove). | |
action.groupingBehavior | visual-group | logical-group | sentence-group | Defines the grouping behavior for the action and its children. | |
action.selectionBehavior | any | all | all-or-none | exactly-one | at-most-one | one-or-more | Defines the selection behavior for the action and its children. | |
action.requiredBehavior | must | could | must-unless-documented | Defines expectations around whether an action is required. | |
action.precheckBehavior | yes | no | Defines whether the action should usually be preselected. | |
action.cardinalityBehavior | single | multiple | Defines whether the action can be selected multiple times. | |
action.resource | The target of the action | The resource that is the target of the action (e.g. CommunicationRequest). | The target resource SHALL be a [Request](request.html) resource with a Request.intent set to "option". |
action.action | Sub action | Sub actions. |
This resource is a request resource from a FHIR workflow perspective - see Workflow, specifically Request.
The RequestGroup resource is used to represent a group of optional activities that may be performed for a specific patient or context. This resource is often, but not always, the result of applying a specific PlanDefinition to a particular patient. Other than differences that tie the RequestGroup to a particular subject and setting, the actionDefinition
element of PlanDefinition is identical to the action
element of the RequestGroup, allowing the same features and functionality to be used in both places to describe optionality of and relationships between activities in a workflow.
RequestGroups can contain hierarchical groups of actions, where each specific action references the action to be performed (in terms of a Request resource), and each group describes additional behavior, relationships, and applicable conditions between the actions in the overall group.
The RequestGroup resource is used when there are temporal, co-occurrence or other dependencies between
one or more steps of an overall workflow. For example, "do procedure A or procedure B, but not both" or
"do procedure A after procedure B" or "Act on this ServiceRequest, then use the value of that observation in
the calculation of the dose of this subsequent MedicationRequest". RequestGroups that define actions
(i.e. that are more than just narrative representations) will always reference other Request resources with
an intent
of "option".
Each "option" request can only be interpreted in the context of a RequestGroup that references it. This is because the RequestGroup defines the context in which the option request may/should/must occur, including any triggers, timing constraints, choices, sequencing requirements, etc. Typically such "option" requests will be contained resources due to this dependency. However, in some cases "option" requests may be stand-alone if they are immutable or tightly tied to a ActivityDefinition such that the option resources can safely be referenced without a risk of their content/intent changing
Elements in the "option" requests may include extensions for timing or other elements that allow calculation based on information found in the RequestGroup or other referenced "option" resources, as well as to expose elements within the "option" resource for referencing in other "option" resources. These extensions are:
The RequestGroup and all of its referenced "option" Requests are treated as a single integrated Request whose status is the status of the RequestGroup. If there is a need to manage statuses of the different parts, separately, refer to the guidance here.
author | The author of the request group | RequestGroup.author |
authored | The date the request group was authored | RequestGroup.authoredOn |
code | The code of the request group | RequestGroup.code |
context | The context the request group applies to | RequestGroup.context |
encounter | The encounter the request group applies to | RequestGroup.context.where(resolve() is Encounter) |
group-identifier | The group identifier for the request group | RequestGroup.groupIdentifier |
identifier | External identifiers for the request group | RequestGroup.identifier |
instantiates-canonical | The FHIR-based definition from which the request group is realized | RequestGroup.instantiatesCanonical |
instantiates-uri | The external definition from which the request group is realized | RequestGroup.instantiatesUri |
intent | The intent of the request group | RequestGroup.intent |
participant | The participant in the requests in the group | RequestGroup.action.participant |
patient | The identity of a patient to search for request groups | RequestGroup.subject.where(resolve() is Patient) |
priority | The priority of the request group | RequestGroup.priority |
status | The status of the request group | RequestGroup.status |
subject | The subject that the request group is about | RequestGroup.subject |
Defines a RequestGroup that can represent a CDS Hooks response
Path | Short | Definition | Comments |
---|---|---|---|
A group of related requests | A group of related requests that can be used to capture intended activities that have inter-dependencies such as "give this medication after that one". | ||
identifier | Business identifier | Allows a service to provide a unique, business identifier for the request. | |
instantiatesCanonical | Instantiates FHIR protocol or definition | A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request. | |
instantiatesUri | Instantiates external protocol or definition | A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request. | |
basedOn | Fulfills plan, proposal, or order | A plan, proposal or order that is fulfilled in whole or in part by this request. | |
replaces | Request(s) replaced by this request | Completed or terminated request(s) whose function is taken by this new request. | The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing. |
groupIdentifier | Composite request this is part of | A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form. | Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation. |
status | draft | active | suspended | cancelled | completed | entered-in-error | unknown | The current state of the request. For request groups, the status reflects the status of all the requests in the group. | |
intent | proposal | plan | order | Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain. | |
priority | routine | urgent | asap | stat | Indicates how quickly the request should be addressed with respect to other requests. | |
code | What's being requested/ordered | A code that identifies what the overall request group is. | This element can be used to provide a code that captures the meaning of the request group as a whole, as opposed to the code of the action element, which captures the meaning of the individual actions within the request group. |
subject | Who the request group is about | The subject for which the request group was created. | |
context | Encounter or Episode for the request group | Describes the context of the request group, if any. | |
authoredOn | When the request group was authored | Indicates when the request group was created. | |
author | Device or practitioner that authored the request group | Provides a reference to the author of the request group. | |
reasonCode | Why the request group is needed | Describes the reason for the request group in coded or textual form. | |
reasonReference | Why the request group is needed | Indicates another resource whose existence justifies this request group. | |
note | Additional notes about the response | Provides a mechanism to communicate additional information about the response. | |
action | Proposed actions, if any | The actions, if any, produced by the evaluation of the artifact. | |
action.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
action.extension | Additional content defined by implementations | 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. | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
action.modifierExtension | Extensions that cannot be ignored even if unrecognized | 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). | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
action.prefix | User-visible prefix for the action (e.g. 1. or A.) | A user-visible prefix for the action. | |
action.title | User-visible title | The title of the action displayed to a user. | |
action.description | Short description of the action | A short description of the action used to provide a summary to display to the user. | |
action.textEquivalent | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system | 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. | |
action.priority | routine | urgent | asap | stat | Indicates how quickly the action should be addressed with respect to other actions. | |
action.code | Code representing the meaning of the action or sub-actions | A code that provides meaning for the action or action group. For example, a section may have a LOINC code for a section of a documentation template. | |
action.documentation | Supporting documentation for the intended performer of the action | 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. | |
action.condition | Whether or not the action is applicable | An expression that describes applicability criteria, or start/stop conditions for the action. | 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 of the conditions are true. |
action.condition.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
action.condition.extension | Additional content defined by implementations | 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. | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
action.condition.modifierExtension | Extensions that cannot be ignored even if unrecognized | 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). | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
action.condition.kind | applicability | start | stop | The kind of condition. | 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. |
action.condition.description | Natural language description of the condition | A brief, natural language description of the condition that effectively communicates the intended semantics. | |
action.condition.language | Language of the expression | The media type of the language for the expression. | |
action.condition.expression | Boolean-valued expression | An expression that returns true or false, indicating whether or not the condition is satisfied. | The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element. |
action.relatedAction | Relationship to another action | A relationship to another action such as "before" or "30-60 minutes after start of". | |
action.relatedAction.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
action.relatedAction.extension | Additional content defined by implementations | 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. | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
action.relatedAction.modifierExtension | Extensions that cannot be ignored even if unrecognized | 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). | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
action.relatedAction.actionId | What action this is related to | The element id of the action this is related to. | |
action.relatedAction.relationship | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end | The relationship of this action to the related action. | |
action.relatedAction.offset[x] | Time offset for the relationship | A duration or range of durations to apply to the relationship. For example, 30-60 minutes before. | |
action.timing[x] | When the action should take place | An optional value describing when the action should be performed. | |
action.participant | Who should perform the action | The participant that should perform or be responsible for this action. | |
action.type | create | update | remove | fire-event | The type of action to perform (create, update, remove). | |
action.groupingBehavior | visual-group | logical-group | sentence-group | Defines the grouping behavior for the action and its children. | |
action.selectionBehavior | any | all | all-or-none | exactly-one | at-most-one | one-or-more | Defines the selection behavior for the action and its children. | |
action.requiredBehavior | must | could | must-unless-documented | Defines expectations around whether an action is required. | |
action.precheckBehavior | yes | no | Defines whether the action should usually be preselected. | |
action.cardinalityBehavior | single | multiple | Defines whether the action can be selected multiple times. | |
action.resource | The target of the action | The resource that is the target of the action (e.g. CommunicationRequest). | The target resource SHALL be a [Request](request.html) resource with a Request.intent set to "option". |
action.action | Sub action | Sub actions. |