This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4B R4 R3
Detailed Descriptions for the elements in the RequestGroup resource.
RequestGroup | |
Definition | 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". |
Control | 1..1 |
RequestGroup.identifier | |
Definition | Allows a service to provide a unique, business identifier for the response. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
Summary | true |
RequestGroup.subject | |
Definition | The subject for which the request group was created. |
Control | 0..1 |
Type | Reference(Patient | Group) |
RequestGroup.context | |
Definition | Describes the context of the request group, if any. |
Control | 0..1 |
Type | Reference(Encounter | EpisodeOfCare) |
RequestGroup.occurrenceDateTime | |
Definition | Indicates when the request group was created. |
Control | 0..1 |
Type | dateTime |
RequestGroup.author | |
Definition | Provides a reference to the author of the request group. |
Control | 0..1 |
Type | Reference(Device | Practitioner) |
RequestGroup.reason[x] | |
Definition | Indicates the reason the request group was created. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response. |
Control | 0..1 |
Type | CodeableConcept|Reference(Any) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
RequestGroup.note | |
Definition | Provides a mechanism to communicate additional information about the response. |
Control | 0..* |
Type | Annotation |
RequestGroup.action | |
Definition | The actions, if any, produced by the evaluation of the artifact. |
Control | 0..* |
Invariants | Defined on this element rqg-1: Must have resource or action but not both (expression : resource.exists() != action.exists(), xpath: exists(f:resource) != exists(f:action)) |
RequestGroup.action.actionIdentifier | |
Definition | A unique identifier for the action. The identifier SHALL be unique within the container in which it appears, and MAY be universally unique. |
Control | 0..1 |
Type | Identifier |
RequestGroup.action.label | |
Definition | A user-visible label for the action. |
Control | 0..1 |
Type | string |
RequestGroup.action.title | |
Definition | The title of the action displayed to a user. |
Control | 0..1 |
Type | string |
RequestGroup.action.description | |
Definition | A short description of the action used to provide a summary to display to the user. |
Control | 0..1 |
Type | string |
RequestGroup.action.textEquivalent | |
Definition | A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that may not be capable of interpreting it dynamically. |
Control | 0..1 |
Type | string |
RequestGroup.action.code | |
Definition | The concept represented by this action or its sub-actions. |
Control | 0..* |
Type | CodeableConcept |
RequestGroup.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. |
Control | 0..* |
Type | RelatedArtifact |
RequestGroup.action.condition | |
Definition | An expression that describes applicability criteria, or start/stop conditions for the action. |
Control | 0..* |
RequestGroup.action.condition.kind | |
Definition | The kind of condition. |
Control | 1..1 |
Terminology Binding | PlanActionConditionKind (Required) |
Type | code |
Comments | Applicability criteria are used to determine immediate applicability when a plan definition is applied to a given context. Start and stop criteria are carried through application and used to describe when enter/exit criteria for an action. |
RequestGroup.action.condition.description | |
Definition | A brief, natural language description of the condition that effectively communicates the intended semantics. |
Control | 0..1 |
Type | string |
RequestGroup.action.condition.language | |
Definition | The media type of the language for the expression. |
Control | 0..1 |
Type | string |
RequestGroup.action.condition.expression | |
Definition | An expression that returns true or false, indicating whether or not the condition is satisfied. |
Control | 0..1 |
Type | string |
Comments | The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element. |
RequestGroup.action.relatedAction | |
Definition | A relationship to another action such as "before" or "30-60 minutes after start of". |
Control | 0..* |
RequestGroup.action.relatedAction.actionIdentifier | |
Definition | The unique identifier of the related action. |
Control | 1..1 |
Type | Identifier |
RequestGroup.action.relatedAction.relationship | |
Definition | The relationship of this action to the related action. |
Control | 1..1 |
Terminology Binding | PlanActionRelationshipType (Required) |
Type | code |
RequestGroup.action.relatedAction.offset[x] | |
Definition | A duration or range of durations to apply to the relationship. For example, 30-60 minutes before. |
Control | 0..1 |
Type | Duration|Range |
[x] Note | See Choice of Data Types for further information about how to use [x] |
RequestGroup.action.timing[x] | |
Definition | An optional value describing when the action should be performed. |
Control | 0..1 |
Type | dateTime|Period|Duration|Range|Timing |
[x] Note | See Choice of Data Types for further information about how to use [x] |
RequestGroup.action.participant | |
Definition | The participant in the action. |
Control | 0..* |
Type | Reference(Patient | Person | Practitioner | RelatedPerson) |
RequestGroup.action.type | |
Definition | The type of action to perform (create, update, remove). |
Control | 0..1 |
Terminology Binding | PlanActionType (Extensible) |
Type | Coding |
RequestGroup.action.groupingBehavior | |
Definition | Defines the grouping behavior for the action and its children. |
Control | 0..1 |
Terminology Binding | PlanActionGroupingBehavior (Required) |
Type | code |
RequestGroup.action.selectionBehavior | |
Definition | Defines the selection behavior for the action and its children. |
Control | 0..1 |
Terminology Binding | PlanActionSelectionBehavior (Required) |
Type | code |
RequestGroup.action.requiredBehavior | |
Definition | Defines the requiredness behavior for the action. |
Control | 0..1 |
Terminology Binding | PlanActionRequiredBehavior (Required) |
Type | code |
RequestGroup.action.precheckBehavior | |
Definition | Defines whether the action should usually be preselected. |
Control | 0..1 |
Terminology Binding | PlanActionPrecheckBehavior (Required) |
Type | code |
RequestGroup.action.cardinalityBehavior | |
Definition | Defines whether the action can be selected multiple times. |
Control | 0..1 |
Terminology Binding | PlanActionCardinalityBehavior (Required) |
Type | code |
RequestGroup.action.resource | |
Definition | The resource that is the target of the action (e.g. CommunicationRequest). |
Control | 0..1 |
Type | Reference(Any) |
Comments | The target resource SHALL be a Request resource with a Request.intent set to "option". |
Invariants | Affect this element rqg-1: Must have resource or action but not both (expression : resource.exists() != action.exists(), xpath: exists(f:resource) != exists(f:action)) |
RequestGroup.action.action | |
Definition | Sub actions. |
Control | 0..* |
Type | See RequestGroup.action |
Invariants | Affect this element rqg-1: Must have resource or action but not both (expression : resource.exists() != action.exists(), xpath: exists(f:resource) != exists(f:action)) |