STU3 Candidate

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

Control1..1
RequestGroup.identifier
Definition

Allows a service to provide a unique, business identifier for the response.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Summarytrue
RequestGroup.subject
Definition

The subject for which the request group was created.

Control0..1
TypeReference(Patient | Group)
RequestGroup.context
Definition

Describes the context of the request group, if any.

Control0..1
TypeReference(Encounter | EpisodeOfCare)
RequestGroup.occurrenceDateTime
Definition

Indicates when the request group was created.

Control0..1
TypedateTime
RequestGroup.author
Definition

Provides a reference to the author of the request group.

Control0..1
TypeReference(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.

Control0..1
TypeCodeableConcept|Reference(Any)
[x] NoteSee 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.

Control0..*
TypeAnnotation
RequestGroup.action
Definition

The actions, if any, produced by the evaluation of the artifact.

Control0..*
InvariantsDefined 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.

Control0..1
TypeIdentifier
RequestGroup.action.label
Definition

A user-visible label for the action.

Control0..1
Typestring
RequestGroup.action.title
Definition

The title of the action displayed to a user.

Control0..1
Typestring
RequestGroup.action.description
Definition

A short description of the action used to provide a summary to display to the user.

Control0..1
Typestring
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.

Control0..1
Typestring
RequestGroup.action.code
Definition

The concept represented by this action or its sub-actions.

Control0..*
TypeCodeableConcept
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.

Control0..*
TypeRelatedArtifact
RequestGroup.action.condition
Definition

An expression that describes applicability criteria, or start/stop conditions for the action.

Control0..*
RequestGroup.action.condition.kind
Definition

The kind of condition.

Control1..1
Terminology BindingPlanActionConditionKind (Required)
Typecode
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.

Control0..1
Typestring
RequestGroup.action.condition.language
Definition

The media type of the language for the expression.

Control0..1
Typestring
RequestGroup.action.condition.expression
Definition

An expression that returns true or false, indicating whether or not the condition is satisfied.

Control0..1
Typestring
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".

Control0..*
RequestGroup.action.relatedAction.actionIdentifier
Definition

The unique identifier of the related action.

Control1..1
TypeIdentifier
RequestGroup.action.relatedAction.relationship
Definition

The relationship of this action to the related action.

Control1..1
Terminology BindingPlanActionRelationshipType (Required)
Typecode
RequestGroup.action.relatedAction.offset[x]
Definition

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

Control0..1
TypeDuration|Range
[x] NoteSee 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.

Control0..1
TypedateTime|Period|Duration|Range|Timing
[x] NoteSee Choice of Data Types for further information about how to use [x]
RequestGroup.action.participant
Definition

The participant in the action.

Control0..*
TypeReference(Patient | Person | Practitioner | RelatedPerson)
RequestGroup.action.type
Definition

The type of action to perform (create, update, remove).

Control0..1
Terminology BindingPlanActionType (Extensible)
TypeCoding
RequestGroup.action.groupingBehavior
Definition

Defines the grouping behavior for the action and its children.

Control0..1
Terminology BindingPlanActionGroupingBehavior (Required)
Typecode
RequestGroup.action.selectionBehavior
Definition

Defines the selection behavior for the action and its children.

Control0..1
Terminology BindingPlanActionSelectionBehavior (Required)
Typecode
RequestGroup.action.requiredBehavior
Definition

Defines the requiredness behavior for the action.

Control0..1
Terminology BindingPlanActionRequiredBehavior (Required)
Typecode
RequestGroup.action.precheckBehavior
Definition

Defines whether the action should usually be preselected.

Control0..1
Terminology BindingPlanActionPrecheckBehavior (Required)
Typecode
RequestGroup.action.cardinalityBehavior
Definition

Defines whether the action can be selected multiple times.

Control0..1
Terminology BindingPlanActionCardinalityBehavior (Required)
Typecode
RequestGroup.action.resource
Definition

The resource that is the target of the action (e.g. CommunicationRequest).

Control0..1
TypeReference(Any)
Comments

The target resource SHALL be a Request resource with a Request.intent set to "option".

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

Control0..*
TypeSee RequestGroup.action
InvariantsAffect this element
rqg-1: Must have resource or action but not both (expression : resource.exists() != action.exists(), xpath: exists(f:resource) != exists(f:action))