Release 4

Clinical Decision Support Work GroupMaturity Level: 2 Trial UseSecurity Category: Business Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson

Detailed Descriptions for the elements in the RequestGroup resource.

RequestGroup
Element IdRequestGroup
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".

Cardinality0..*
TypeDomainResource
RequestGroup.identifier
Element IdRequestGroup.identifier
Definition

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

NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Requirements

Allows identification of the request as it is known by various participating systems and in a way that remains consistent across servers.

Summarytrue
RequestGroup.instantiatesCanonical
Element IdRequestGroup.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.

Cardinality0..*
Typecanonical
Summarytrue
RequestGroup.instantiatesUri
Element IdRequestGroup.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.

Cardinality0..*
Typeuri
Summarytrue
RequestGroup.basedOn
Element IdRequestGroup.basedOn
Definition

A plan, proposal or order that is fulfilled in whole or in part by this request.

Cardinality0..*
TypeReference(Any)
Requirements

Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon.

Alternate Namesfulfills
RequestGroup.replaces
Element IdRequestGroup.replaces
Definition

Completed or terminated request(s) whose function is taken by this new request.

Cardinality0..*
TypeReference(Any)
Requirements

Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests.

Alternate Namessupersedes; prior; renewed order
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 IdRequestGroup.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.

Cardinality0..1
TypeIdentifier
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 Namesgrouperid; requisition
Summarytrue
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 IdRequestGroup.status
Definition

The current state of the request. For request groups, the status reflects the status of all the requests in the group.

Cardinality1..1
Terminology BindingRequestStatus (Required)
Typecode
Is Modifiertrue (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)
Summarytrue
RequestGroup.intent
Element IdRequestGroup.intent
Definition

Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.

Cardinality1..1
Terminology BindingRequestIntent (Required)
Typecode
Is Modifiertrue (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 Namescategory
Summarytrue
RequestGroup.priority
Element IdRequestGroup.priority
Definition

Indicates how quickly the request should be addressed with respect to other requests.

Cardinality0..1
Terminology BindingRequest priority (Required)
Typecode
Meaning if MissingIf missing, this request should be performed with normal priority
Summarytrue
RequestGroup.code
Element IdRequestGroup.code
Definition

A code that identifies what the overall request group is.

Cardinality0..1
TypeCodeableConcept
Summarytrue
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 IdRequestGroup.subject
Definition

The subject for which the request group was created.

Cardinality0..1
TypeReference(Patient | Group)
RequestGroup.encounter
Element IdRequestGroup.encounter
Definition

Describes the context of the request group, if any.

Cardinality0..1
TypeReference(Encounter)
RequestGroup.authoredOn
Element IdRequestGroup.authoredOn
Definition

Indicates when the request group was created.

Cardinality0..1
TypedateTime
RequestGroup.author
Element IdRequestGroup.author
Definition

Provides a reference to the author of the request group.

Cardinality0..1
TypeReference(Device | Practitioner | PractitionerRole)
RequestGroup.reasonCode
Element IdRequestGroup.reasonCode
Definition

Describes the reason for the request group in coded or textual form.

Cardinality0..*
TypeCodeableConcept
RequestGroup.reasonReference
Element IdRequestGroup.reasonReference
Definition

Indicates another resource whose existence justifies this request group.

Cardinality0..*
TypeReference(Condition | Observation | DiagnosticReport | DocumentReference)
RequestGroup.note
Element IdRequestGroup.note
Definition

Provides a mechanism to communicate additional information about the response.

Cardinality0..*
TypeAnnotation
RequestGroup.action
Element IdRequestGroup.action
Definition

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

Cardinality0..*
Invariants
Defined on this element
rqg-1Rule Must have resource or action but not bothresource.exists() != action.exists()
RequestGroup.action.prefix
Element IdRequestGroup.action.prefix
Definition

A user-visible prefix for the action.

Cardinality0..1
Typestring
RequestGroup.action.title
Element IdRequestGroup.action.title
Definition

The title of the action displayed to a user.

Cardinality0..1
Typestring
RequestGroup.action.description
Element IdRequestGroup.action.description
Definition

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

Cardinality0..1
Typestring
Summarytrue
RequestGroup.action.textEquivalent
Element IdRequestGroup.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.

Cardinality0..1
Typestring
Summarytrue
RequestGroup.action.priority
Element IdRequestGroup.action.priority
Definition

Indicates how quickly the action should be addressed with respect to other actions.

Cardinality0..1
Terminology BindingRequest priority (Required)
Typecode
RequestGroup.action.code
Element IdRequestGroup.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.

Cardinality0..*
TypeCodeableConcept
RequestGroup.action.documentation
Element IdRequestGroup.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.

Cardinality0..*
TypeRelatedArtifact
RequestGroup.action.condition
Element IdRequestGroup.action.condition
Definition

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

Cardinality0..*
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 IdRequestGroup.action.condition.kind
Definition

The kind of condition.

Cardinality1..1
Terminology BindingActionConditionKind (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 enter/exit criteria for an action.

RequestGroup.action.condition.expression
Element IdRequestGroup.action.condition.expression
Definition

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

Cardinality0..1
TypeExpression
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 IdRequestGroup.action.relatedAction
Definition

A relationship to another action such as "before" or "30-60 minutes after start of".

Cardinality0..*
RequestGroup.action.relatedAction.actionId
Element IdRequestGroup.action.relatedAction.actionId
Definition

The element id of the action this is related to.

Cardinality1..1
Typeid
RequestGroup.action.relatedAction.relationship
Element IdRequestGroup.action.relatedAction.relationship
Definition

The relationship of this action to the related action.

Cardinality1..1
Terminology BindingActionRelationshipType (Required)
Typecode
RequestGroup.action.relatedAction.offset[x]
Element IdRequestGroup.action.relatedAction.offset[x]
Definition

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

Cardinality0..1
TypeDuration|Range
[x] NoteSee Choice of Data Types for further information about how to use [x]
RequestGroup.action.timing[x]
Element IdRequestGroup.action.timing[x]
Definition

An optional value describing when the action should be performed.

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

The participant that should perform or be responsible for this action.

Cardinality0..*
TypeReference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device)
RequestGroup.action.type
Element IdRequestGroup.action.type
Definition

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

Cardinality0..1
Terminology BindingActionType (Extensible)
TypeCodeableConcept
RequestGroup.action.groupingBehavior
Element IdRequestGroup.action.groupingBehavior
Definition

Defines the grouping behavior for the action and its children.

Cardinality0..1
Terminology BindingActionGroupingBehavior (Required)
Typecode
RequestGroup.action.selectionBehavior
Element IdRequestGroup.action.selectionBehavior
Definition

Defines the selection behavior for the action and its children.

Cardinality0..1
Terminology BindingActionSelectionBehavior (Required)
Typecode
RequestGroup.action.requiredBehavior
Element IdRequestGroup.action.requiredBehavior
Definition

Defines expectations around whether an action is required.

Cardinality0..1
Terminology BindingActionRequiredBehavior (Required)
Typecode
RequestGroup.action.precheckBehavior
Element IdRequestGroup.action.precheckBehavior
Definition

Defines whether the action should usually be preselected.

Cardinality0..1
Terminology BindingActionPrecheckBehavior (Required)
Typecode
RequestGroup.action.cardinalityBehavior
Element IdRequestGroup.action.cardinalityBehavior
Definition

Defines whether the action can be selected multiple times.

Cardinality0..1
Terminology BindingActionCardinalityBehavior (Required)
Typecode
RequestGroup.action.resource
Element IdRequestGroup.action.resource
Definition

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

Cardinality0..1
TypeReference(Any)
Comments

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

Invariants
Affect this element
rqg-1Rule Must have resource or action but not bothresource.exists() != action.exists()
RequestGroup.action.action
Element IdRequestGroup.action.action
Definition

Sub actions.

Cardinality0..*
TypeSee RequestGroup.action
Invariants
Affect this element
rqg-1Rule Must have resource or action but not bothresource.exists() != action.exists()