Resource type: requestgroup

Description

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".

Elements

PathShortDefinitionComments
A group of related requestsA group of related requests that can be used to capture intended activities that have inter-dependencies such as "give this medication after that one".
identifierBusiness identifierAllows a service to provide a unique, business identifier for the request.
instantiatesCanonicalInstantiates FHIR protocol or definitionA canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
instantiatesUriInstantiates external protocol or definitionA URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
basedOnFulfills plan, proposal, or orderA plan, proposal or order that is fulfilled in whole or in part by this request.
replacesRequest(s) replaced by this requestCompleted 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.
groupIdentifierComposite request this is part ofA 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.
statusdraft | active | suspended | cancelled | completed | entered-in-error | unknownThe current state of the request. For request groups, the status reflects the status of all the requests in the group.
intentproposal | plan | orderIndicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.
priorityroutine | urgent | asap | statIndicates how quickly the request should be addressed with respect to other requests.
codeWhat's being requested/orderedA 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.
subjectWho the request group is aboutThe subject for which the request group was created.
contextEncounter or Episode for the request groupDescribes the context of the request group, if any.
authoredOnWhen the request group was authoredIndicates when the request group was created.
authorDevice or practitioner that authored the request groupProvides a reference to the author of the request group.
reasonCodeWhy the request group is neededDescribes the reason for the request group in coded or textual form.
reasonReferenceWhy the request group is neededIndicates another resource whose existence justifies this request group.
noteAdditional notes about the responseProvides a mechanism to communicate additional information about the response.
actionProposed actions, if anyThe actions, if any, produced by the evaluation of the artifact.
action.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
action.extensionAdditional content defined by implementationsMay 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.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay 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.prefixUser-visible prefix for the action (e.g. 1. or A.)A user-visible prefix for the action.
action.titleUser-visible titleThe title of the action displayed to a user.
action.descriptionShort description of the actionA short description of the action used to provide a summary to display to the user.
action.textEquivalentStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving systemA 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.priorityroutine | urgent | asap | statIndicates how quickly the action should be addressed with respect to other actions.
action.codeCode representing the meaning of the action or sub-actionsA 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.documentationSupporting documentation for the intended performer of the actionDidactic 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.conditionWhether or not the action is applicableAn 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.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
action.condition.extensionAdditional content defined by implementationsMay 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.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay 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.kindapplicability | start | stopThe 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.descriptionNatural language description of the conditionA brief, natural language description of the condition that effectively communicates the intended semantics.
action.condition.languageLanguage of the expressionThe media type of the language for the expression.
action.condition.expressionBoolean-valued expressionAn 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.relatedActionRelationship to another actionA relationship to another action such as "before" or "30-60 minutes after start of".
action.relatedAction.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
action.relatedAction.extensionAdditional content defined by implementationsMay 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.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay 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.actionIdWhat action this is related toThe element id of the action this is related to.
action.relatedAction.relationshipbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-endThe relationship of this action to the related action.
action.relatedAction.offset[x]Time offset for the relationshipA duration or range of durations to apply to the relationship. For example, 30-60 minutes before.
action.timing[x]When the action should take placeAn optional value describing when the action should be performed.
action.participantWho should perform the actionThe participant that should perform or be responsible for this action.
action.typecreate | update | remove | fire-eventThe type of action to perform (create, update, remove).
action.groupingBehaviorvisual-group | logical-group | sentence-groupDefines the grouping behavior for the action and its children.
action.selectionBehaviorany | all | all-or-none | exactly-one | at-most-one | one-or-moreDefines the selection behavior for the action and its children.
action.requiredBehaviormust | could | must-unless-documentedDefines expectations around whether an action is required.
action.precheckBehavioryes | noDefines whether the action should usually be preselected.
action.cardinalityBehaviorsingle | multipleDefines whether the action can be selected multiple times.
action.resourceThe target of the actionThe 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.actionSub actionSub actions.

Scope and Usage

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.

Usage

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.

Search Parameters

authorThe author of the request groupRequestGroup.author
authoredThe date the request group was authoredRequestGroup.authoredOn
codeThe code of the request groupRequestGroup.code
contextThe context the request group applies toRequestGroup.context
encounterThe encounter the request group applies toRequestGroup.context.where(resolve() is Encounter)
group-identifierThe group identifier for the request groupRequestGroup.groupIdentifier
identifierExternal identifiers for the request groupRequestGroup.identifier
instantiates-canonicalThe FHIR-based definition from which the request group is realizedRequestGroup.instantiatesCanonical
instantiates-uriThe external definition from which the request group is realizedRequestGroup.instantiatesUri
intentThe intent of the request groupRequestGroup.intent
participantThe participant in the requests in the groupRequestGroup.action.participant
patientThe identity of a patient to search for request groupsRequestGroup.subject.where(resolve() is Patient)
priorityThe priority of the request groupRequestGroup.priority
statusThe status of the request groupRequestGroup.status
subjectThe subject that the request group is aboutRequestGroup.subject

Extension Definitions

These are extension definitions for this resource defined by the spec

Profiles based on this resource

CDS Hooks RequestGroup

Defines a RequestGroup that can represent a CDS Hooks response

Elements

PathShortDefinitionComments
A group of related requestsA group of related requests that can be used to capture intended activities that have inter-dependencies such as "give this medication after that one".
identifierBusiness identifierAllows a service to provide a unique, business identifier for the request.
instantiatesCanonicalInstantiates FHIR protocol or definitionA canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
instantiatesUriInstantiates external protocol or definitionA URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
basedOnFulfills plan, proposal, or orderA plan, proposal or order that is fulfilled in whole or in part by this request.
replacesRequest(s) replaced by this requestCompleted 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.
groupIdentifierComposite request this is part ofA 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.
statusdraft | active | suspended | cancelled | completed | entered-in-error | unknownThe current state of the request. For request groups, the status reflects the status of all the requests in the group.
intentproposal | plan | orderIndicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.
priorityroutine | urgent | asap | statIndicates how quickly the request should be addressed with respect to other requests.
codeWhat's being requested/orderedA 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.
subjectWho the request group is aboutThe subject for which the request group was created.
contextEncounter or Episode for the request groupDescribes the context of the request group, if any.
authoredOnWhen the request group was authoredIndicates when the request group was created.
authorDevice or practitioner that authored the request groupProvides a reference to the author of the request group.
reasonCodeWhy the request group is neededDescribes the reason for the request group in coded or textual form.
reasonReferenceWhy the request group is neededIndicates another resource whose existence justifies this request group.
noteAdditional notes about the responseProvides a mechanism to communicate additional information about the response.
actionProposed actions, if anyThe actions, if any, produced by the evaluation of the artifact.
action.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
action.extensionAdditional content defined by implementationsMay 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.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay 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.prefixUser-visible prefix for the action (e.g. 1. or A.)A user-visible prefix for the action.
action.titleUser-visible titleThe title of the action displayed to a user.
action.descriptionShort description of the actionA short description of the action used to provide a summary to display to the user.
action.textEquivalentStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving systemA 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.priorityroutine | urgent | asap | statIndicates how quickly the action should be addressed with respect to other actions.
action.codeCode representing the meaning of the action or sub-actionsA 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.documentationSupporting documentation for the intended performer of the actionDidactic 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.conditionWhether or not the action is applicableAn 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.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
action.condition.extensionAdditional content defined by implementationsMay 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.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay 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.kindapplicability | start | stopThe 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.descriptionNatural language description of the conditionA brief, natural language description of the condition that effectively communicates the intended semantics.
action.condition.languageLanguage of the expressionThe media type of the language for the expression.
action.condition.expressionBoolean-valued expressionAn 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.relatedActionRelationship to another actionA relationship to another action such as "before" or "30-60 minutes after start of".
action.relatedAction.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
action.relatedAction.extensionAdditional content defined by implementationsMay 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.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay 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.actionIdWhat action this is related toThe element id of the action this is related to.
action.relatedAction.relationshipbefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-endThe relationship of this action to the related action.
action.relatedAction.offset[x]Time offset for the relationshipA duration or range of durations to apply to the relationship. For example, 30-60 minutes before.
action.timing[x]When the action should take placeAn optional value describing when the action should be performed.
action.participantWho should perform the actionThe participant that should perform or be responsible for this action.
action.typecreate | update | remove | fire-eventThe type of action to perform (create, update, remove).
action.groupingBehaviorvisual-group | logical-group | sentence-groupDefines the grouping behavior for the action and its children.
action.selectionBehaviorany | all | all-or-none | exactly-one | at-most-one | one-or-moreDefines the selection behavior for the action and its children.
action.requiredBehaviormust | could | must-unless-documentedDefines expectations around whether an action is required.
action.precheckBehavioryes | noDefines whether the action should usually be preselected.
action.cardinalityBehaviorsingle | multipleDefines whether the action can be selected multiple times.
action.resourceThe target of the actionThe 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.actionSub actionSub actions.