Release 5 Draft Ballot
Clinical ReasoningThis page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot - see ballot notes). 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
| Clinical Decision Support Work Group | Maturity Level: 2 | Trial Use | Security Category: Business | Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson |
Detailed Descriptions for the elements in the RequestGroup resource.
| RequestGroup | |||||||||
| Element Id | 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". | ||||||||
| Cardinality | 0..* | ||||||||
| Type | DomainResource | ||||||||
| Summary | false | ||||||||
| RequestGroup.identifier | |||||||||
| Element Id | RequestGroup.identifier | ||||||||
| Definition | Allows a service to provide a unique, business identifier for the request. | ||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
| Cardinality | 0..* | ||||||||
| Type | Identifier | ||||||||
| Requirements | Allows identification of the request as it is known by various participating systems and in a way that remains consistent across servers. | ||||||||
| Summary | true | ||||||||
| RequestGroup.instantiatesCanonical | |||||||||
| Element Id | RequestGroup.instantiatesCanonical | ||||||||
| 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. | ||||||||
| Cardinality | 0..* | ||||||||
| Type | canonical | ||||||||
| Summary | true | ||||||||
| RequestGroup.instantiatesUri | |||||||||
| Element Id | RequestGroup.instantiatesUri | ||||||||
| 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. | ||||||||
| Cardinality | 0..* | ||||||||
| Type | uri | ||||||||
| Summary | true | ||||||||
| RequestGroup.basedOn | |||||||||
| Element Id | RequestGroup.basedOn | ||||||||
| Definition | A plan, proposal or order that is fulfilled in whole or in part by this request. | ||||||||
| Cardinality | 0..* | ||||||||
| Type | Reference(Any) | ||||||||
| Requirements | Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon. | ||||||||
| Alternate Names | fulfills | ||||||||
| Summary | false | ||||||||
| RequestGroup.replaces | |||||||||
| Element Id | RequestGroup.replaces | ||||||||
| Definition | Completed or terminated request(s) whose function is taken by this new request. | ||||||||
| Cardinality | 0..* | ||||||||
| Type | Reference(Any) | ||||||||
| Requirements | Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests. | ||||||||
| Alternate Names | supersedes; prior; renewed order | ||||||||
| Summary | false | ||||||||
| Comments | 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. | ||||||||
| RequestGroup.groupIdentifier | |||||||||
| Element Id | RequestGroup.groupIdentifier | ||||||||
| Definition | 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. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | Identifier | ||||||||
| Requirements | Some business processes need to know if multiple items were ordered as part of the same "prescription" or "requisition" for billing or other purposes. | ||||||||
| Alternate Names | grouperid; requisition | ||||||||
| Summary | true | ||||||||
| Comments | 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. | ||||||||
| RequestGroup.status | |||||||||
| Element Id | RequestGroup.status | ||||||||
| Definition | The current state of the request. For request groups, the status reflects the status of all the requests in the group. | ||||||||
| Cardinality | 1..1 | ||||||||
| Terminology Binding | RequestStatus (Required) | ||||||||
| Type | code | ||||||||
| Is Modifier | true (Reason: This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid) | ||||||||
| Summary | true | ||||||||
| RequestGroup.intent | |||||||||
| Element Id | RequestGroup.intent | ||||||||
| Definition | Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain. | ||||||||
| Cardinality | 1..1 | ||||||||
| Terminology Binding | RequestIntent (Required) | ||||||||
| Type | code | ||||||||
| Is Modifier | true (Reason: This element changes the interpretation of all descriptive attributes. For example "the time the request is recommended to occur" vs. "the time the request is authorized to occur" or "who is recommended to perform the request" vs. "who is authorized to perform the request) | ||||||||
| Requirements | Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain. | ||||||||
| Alternate Names | category | ||||||||
| Summary | true | ||||||||
| RequestGroup.priority | |||||||||
| Element Id | RequestGroup.priority | ||||||||
| Definition | Indicates how quickly the request should be addressed with respect to other requests. | ||||||||
| Cardinality | 0..1 | ||||||||
| Terminology Binding | RequestPriority (Required) | ||||||||
| Type | code | ||||||||
| Meaning if Missing | If missing, this request should be performed with normal priority | ||||||||
| Summary | true | ||||||||
| RequestGroup.code | |||||||||
| Element Id | RequestGroup.code | ||||||||
| Definition | A code that identifies what the overall request group is. | ||||||||
| Cardinality | 0..1 | ||||||||
| Terminology Binding | ActionCode (Example) | ||||||||
| Type | CodeableConcept | ||||||||
| Summary | true | ||||||||
| Comments | 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. | ||||||||
| RequestGroup.subject | |||||||||
| Element Id | RequestGroup.subject | ||||||||
| Definition | The subject for which the request group was created. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | Reference(Patient | Group) | ||||||||
| Patterns | Reference(Patient,Group): Common patterns = Participant | ||||||||
| Summary | false | ||||||||
| RequestGroup.encounter | |||||||||
| Element Id | RequestGroup.encounter | ||||||||
| Definition | Describes the context of the request group, if any. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | Reference(Encounter) | ||||||||
| Summary | false | ||||||||
| RequestGroup.authoredOn | |||||||||
| Element Id | RequestGroup.authoredOn | ||||||||
| Definition | Indicates when the request group was created. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | dateTime | ||||||||
| Summary | false | ||||||||
| RequestGroup.author | |||||||||
| Element Id | RequestGroup.author | ||||||||
| Definition | Provides a reference to the author of the request group. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | Reference(Device | Practitioner | PractitionerRole) | ||||||||
| Patterns | Reference(Device,Practitioner,PractitionerRole): Common patterns = Participant | ||||||||
| Summary | false | ||||||||
| RequestGroup.reason | |||||||||
| Element Id | RequestGroup.reason | ||||||||
| Definition | Describes the reason for the request group in coded or textual form. | ||||||||
| Cardinality | 0..* | ||||||||
| Terminology Binding | ActionReasonCode (Example) | ||||||||
| Type | CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference) | ||||||||
| Patterns | CodeableReference(Condition,Observation,DiagnosticReport,DocumentReference): Common patterns = Event | ||||||||
| Summary | false | ||||||||
| RequestGroup.note | |||||||||
| Element Id | RequestGroup.note | ||||||||
| Definition | Provides a mechanism to communicate additional information about the response. | ||||||||
| Cardinality | 0..* | ||||||||
| Type | Annotation | ||||||||
| Summary | false | ||||||||
| RequestGroup.action | |||||||||
| Element Id | RequestGroup.action | ||||||||
| Definition | The actions, if any, produced by the evaluation of the artifact. | ||||||||
| Cardinality | 0..* | ||||||||
| Summary | false | ||||||||
| Invariants |
| ||||||||
| RequestGroup.action.prefix | |||||||||
| Element Id | RequestGroup.action.prefix | ||||||||
| Definition | A user-visible prefix for the action. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | string | ||||||||
| Summary | false | ||||||||
| RequestGroup.action.title | |||||||||
| Element Id | RequestGroup.action.title | ||||||||
| Definition | The title of the action displayed to a user. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | string | ||||||||
| Summary | false | ||||||||
| RequestGroup.action.description | |||||||||
| Element Id | RequestGroup.action.description | ||||||||
| Definition | A short description of the action used to provide a summary to display to the user. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | string | ||||||||
| Summary | true | ||||||||
| RequestGroup.action.textEquivalent | |||||||||
| Element Id | 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 might not be capable of interpreting it dynamically. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | string | ||||||||
| Summary | true | ||||||||
| RequestGroup.action.priority | |||||||||
| Element Id | RequestGroup.action.priority | ||||||||
| Definition | Indicates how quickly the action should be addressed with respect to other actions. | ||||||||
| Cardinality | 0..1 | ||||||||
| Terminology Binding | RequestPriority (Required) | ||||||||
| Type | code | ||||||||
| Summary | false | ||||||||
| RequestGroup.action.code | |||||||||
| Element Id | RequestGroup.action.code | ||||||||
| Definition | 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. | ||||||||
| Cardinality | 0..* | ||||||||
| Terminology Binding | ActionCode (Example) | ||||||||
| Type | CodeableConcept | ||||||||
| Summary | false | ||||||||
| RequestGroup.action.documentation | |||||||||
| Element Id | 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. | ||||||||
| Cardinality | 0..* | ||||||||
| Type | RelatedArtifact | ||||||||
| Summary | false | ||||||||
| RequestGroup.action.condition | |||||||||
| Element Id | RequestGroup.action.condition | ||||||||
| Definition | An expression that describes applicability criteria, or start/stop conditions for the action. | ||||||||
| Cardinality | 0..* | ||||||||
| Summary | false | ||||||||
| 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 of the conditions are true. | ||||||||
| RequestGroup.action.condition.kind | |||||||||
| Element Id | RequestGroup.action.condition.kind | ||||||||
| Definition | The kind of condition. | ||||||||
| Cardinality | 1..1 | ||||||||
| Terminology Binding | ActionConditionKind (Required) | ||||||||
| Type | code | ||||||||
| Summary | false | ||||||||
| 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. | ||||||||
| RequestGroup.action.condition.expression | |||||||||
| Element Id | RequestGroup.action.condition.expression | ||||||||
| Definition | An expression that returns true or false, indicating whether or not the condition is satisfied. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | Expression | ||||||||
| Summary | false | ||||||||
| 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 | |||||||||
| Element Id | RequestGroup.action.relatedAction | ||||||||
| Definition | A relationship to another action such as "before" or "30-60 minutes after start of". | ||||||||
| Cardinality | 0..* | ||||||||
| Summary | false | ||||||||
| RequestGroup.action.relatedAction.targetId | |||||||||
| Element Id | RequestGroup.action.relatedAction.targetId | ||||||||
| Definition | The element id of the target related action. | ||||||||
| Cardinality | 1..1 | ||||||||
| Type | id | ||||||||
| Summary | false | ||||||||
| RequestGroup.action.relatedAction.relationship | |||||||||
| Element Id | RequestGroup.action.relatedAction.relationship | ||||||||
| Definition | The relationship of this action to the related action. | ||||||||
| Cardinality | 1..1 | ||||||||
| Terminology Binding | ActionRelationshipType (Required) | ||||||||
| Type | code | ||||||||
| Summary | false | ||||||||
| RequestGroup.action.relatedAction.offset[x] | |||||||||
| Element Id | RequestGroup.action.relatedAction.offset[x] | ||||||||
| Definition | A duration or range of durations to apply to the relationship. For example, 30-60 minutes before. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | Duration|Range | ||||||||
| [x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||
| Summary | false | ||||||||
| RequestGroup.action.timing[x] | |||||||||
| Element Id | RequestGroup.action.timing[x] | ||||||||
| Definition | An optional value describing when the action should be performed. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | dateTime|Age|Period|Duration|Range|Timing | ||||||||
| [x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||
| Requirements | Allows prompting for activities and detection of missed planned activities. | ||||||||
| Summary | false | ||||||||
| Comments | The intent of the timing element is to provide timing for when the action should be performed. The timing may be absolute (specified as a dateTime or Period) or relative (specified as an Age, Duration, or Range), or it may be a more complex, potentially repeating timing specified using Timing. | ||||||||
| RequestGroup.action.location | |||||||||
| Element Id | RequestGroup.action.location | ||||||||
| Definition | Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etc. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | CodeableReference(Location) | ||||||||
| Requirements | Helps in planning of activity. | ||||||||
| Alternate Names | facility | ||||||||
| Summary | false | ||||||||
| Comments | May reference a specific clinical location or may just identify a type of location. | ||||||||
| RequestGroup.action.participant | |||||||||
| Element Id | RequestGroup.action.participant | ||||||||
| Definition | The participant that should perform or be responsible for this action. | ||||||||
| Cardinality | 0..* | ||||||||
| Summary | false | ||||||||
| Comments | Because request groups represent potential options for performing activities, some specific participants may still be unknown, so this element allows for both definitional participants (in the same way they are specified in ActivityDefinition and PlanDefinition resources) as well as identifying specific participants when they are known. | ||||||||
| RequestGroup.action.participant.type | |||||||||
| Element Id | RequestGroup.action.participant.type | ||||||||
| Definition | The type of participant in the action. | ||||||||
| Cardinality | 0..1 | ||||||||
| Terminology Binding | ActionParticipantType (Required) | ||||||||
| Type | code | ||||||||
| Summary | false | ||||||||
| RequestGroup.action.participant.typeReference | |||||||||
| Element Id | RequestGroup.action.participant.typeReference | ||||||||
| Definition | The type of participant in the action. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | ||||||||
| Patterns | Reference(CareTeam,Device,Group,HealthcareService,Location,Organization,Patient,Practitioner,PractitionerRole,RelatedPerson): Common patterns = Participant | ||||||||
| Summary | false | ||||||||
| Comments | When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location). | ||||||||
| RequestGroup.action.participant.role | |||||||||
| Element Id | RequestGroup.action.participant.role | ||||||||
| Definition | The role the participant should play in performing the described action. | ||||||||
| Cardinality | 0..1 | ||||||||
| Terminology Binding | ActionParticipantRole (Example) | ||||||||
| Type | CodeableConcept | ||||||||
| Summary | false | ||||||||
| RequestGroup.action.participant.function | |||||||||
| Element Id | RequestGroup.action.participant.function | ||||||||
| Definition | Indicates how the actor will be involved in the action - author, reviewer, witness, etc. | ||||||||
| Cardinality | 0..1 | ||||||||
| Terminology Binding | ActionParticipantFunction (Example) | ||||||||
| Type | CodeableConcept | ||||||||
| Summary | false | ||||||||
| RequestGroup.action.participant.actor | |||||||||
| Element Id | RequestGroup.action.participant.actor | ||||||||
| Definition | A reference to the actual participant. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | ||||||||
| Patterns | Reference(CareTeam,Device,Group,HealthcareService,Location,Organization,Patient,Practitioner,PractitionerRole,RelatedPerson): Common patterns = Participant | ||||||||
| Summary | false | ||||||||
| RequestGroup.action.type | |||||||||
| Element Id | RequestGroup.action.type | ||||||||
| Definition | The type of action to perform (create, update, remove). | ||||||||
| Cardinality | 0..1 | ||||||||
| Terminology Binding | ActionType (Extensible) | ||||||||
| Type | CodeableConcept | ||||||||
| Summary | false | ||||||||
| RequestGroup.action.groupingBehavior | |||||||||
| Element Id | RequestGroup.action.groupingBehavior | ||||||||
| Definition | Defines the grouping behavior for the action and its children. | ||||||||
| Cardinality | 0..1 | ||||||||
| Terminology Binding | ActionGroupingBehavior (Required) | ||||||||
| Type | code | ||||||||
| Summary | false | ||||||||
| RequestGroup.action.selectionBehavior | |||||||||
| Element Id | RequestGroup.action.selectionBehavior | ||||||||
| Definition | Defines the selection behavior for the action and its children. | ||||||||
| Cardinality | 0..1 | ||||||||
| Terminology Binding | ActionSelectionBehavior (Required) | ||||||||
| Type | code | ||||||||
| Summary | false | ||||||||
| RequestGroup.action.requiredBehavior | |||||||||
| Element Id | RequestGroup.action.requiredBehavior | ||||||||
| Definition | Defines expectations around whether an action is required. | ||||||||
| Cardinality | 0..1 | ||||||||
| Terminology Binding | ActionRequiredBehavior (Required) | ||||||||
| Type | code | ||||||||
| Summary | false | ||||||||
| RequestGroup.action.precheckBehavior | |||||||||
| Element Id | RequestGroup.action.precheckBehavior | ||||||||
| Definition | Defines whether the action should usually be preselected. | ||||||||
| Cardinality | 0..1 | ||||||||
| Terminology Binding | ActionPrecheckBehavior (Required) | ||||||||
| Type | code | ||||||||
| Summary | false | ||||||||
| RequestGroup.action.cardinalityBehavior | |||||||||
| Element Id | RequestGroup.action.cardinalityBehavior | ||||||||
| Definition | Defines whether the action can be selected multiple times. | ||||||||
| Cardinality | 0..1 | ||||||||
| Terminology Binding | ActionCardinalityBehavior (Required) | ||||||||
| Type | code | ||||||||
| Summary | false | ||||||||
| RequestGroup.action.resource | |||||||||
| Element Id | RequestGroup.action.resource | ||||||||
| Definition | The resource that is the target of the action (e.g. CommunicationRequest). | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | Reference(Any) | ||||||||
| Summary | false | ||||||||
| Comments | The target resource SHALL be a Request resource with a Request.intent set to "option". | ||||||||
| Invariants |
| ||||||||
| RequestGroup.action.action | |||||||||
| Element Id | RequestGroup.action.action | ||||||||
| Definition | Sub actions. | ||||||||
| Cardinality | 0..* | ||||||||
| Type | See RequestGroup.action | ||||||||
| Summary | false | ||||||||
| Invariants |
| ||||||||
FHIR ®© HL7.org 2011+. FHIR R5 Draft Ballot hl7.fhir.core#4.6.0 generated on Thu, Apr 15, 2021 12:29+1000.
Links: Search |
Version History |
Table of Contents |
QA Page |
Compare to R4 |
|
Propose a change