Skip to main content

RequestGroup

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

Properties

NameRequiredTypeDescription
identifierIdentifier[]

Business identifier

Details

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

instantiatesCanonicalcanonical[]

Instantiates FHIR protocol or definition

Details

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.

instantiatesUriuri[]

Instantiates external protocol or definition

Details

A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.

basedOnReference<Resource>[]

Fulfills plan, proposal, or order

Details

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

replacesReference<Resource>[]

Request(s) replaced by this request

Details

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

groupIdentifierIdentifier

Composite request this is part of

Details

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.

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.

statuscode

draft | active | on-hold | revoked | completed | entered-in-error | unknown

Details

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

intentcode

proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option

Details

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

prioritycode

routine | urgent | asap | stat

Details

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

codeCodeableConcept

What's being requested/ordered

Details

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

subjectReference<Patient | Group>

Who the request group is about

Details

The subject for which the request group was created.

encounterReference<Encounter>

Created as part of

Details

Describes the context of the request group, if any.

authoredOndateTime

When the request group was authored

Details

Indicates when the request group was created.

authorReference< Device | Practitioner | PractitionerRole >

Device or practitioner that authored the request group

Details

Provides a reference to the author of the request group.

reasonCodeCodeableConcept[]

Why the request group is needed

Details

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

reasonReferenceReference< Condition | Observation | DiagnosticReport | DocumentReference >[]

Why the request group is needed

Details

Indicates another resource whose existence justifies this request group.

noteAnnotation[]

Additional notes about the response

Details

Provides a mechanism to communicate additional information about the response.

actionRequestGroupAction[]

Proposed actions, if any

Details

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

idstring

Unique id for inter-element referencing

Details

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

extensionExtension[]

Additional content defined by implementations

Details

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

modifierExtensionExtension[]

Extensions that cannot be ignored even if unrecognized

Details

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

prefixstring

User-visible prefix for the action (e.g. 1. or A.)

Details

A user-visible prefix for the action.

titlestring

User-visible title

Details

The title of the action displayed to a user.

descriptionstring

Short description of the action

Details

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

textEquivalentstring

Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system

Details

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.

prioritycode

routine | urgent | asap | stat

Details

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

codeCodeableConcept[]

Code representing the meaning of the action or sub-actions

Details

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.

documentationRelatedArtifact[]

Supporting documentation for the intended performer of the action

Details

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.

conditionRequestGroupActionCondition[]

Whether or not the action is applicable

Details

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

idstring

Unique id for inter-element referencing

Details

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

extensionExtension[]

Additional content defined by implementations

Details

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

modifierExtensionExtension[]

Extensions that cannot be ignored even if unrecognized

Details

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

kindcode

applicability | start | stop

Details

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

expressionExpression

Boolean-valued expression

Details

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

relatedActionRequestGroupActionRelatedAction[]

Relationship to another action

Details

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

idstring

Unique id for inter-element referencing

Details

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

extensionExtension[]

Additional content defined by implementations

Details

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

modifierExtensionExtension[]

Extensions that cannot be ignored even if unrecognized

Details

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

actionIdid

What action this is related to

Details

The element id of the action this is related to.

relationshipcode

before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end

Details

The relationship of this action to the related action.

offset[x]Duration, Range

Time offset for the relationship

Details

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

timing[x]dateTime, Age, Period, Duration, Range, Timing

When the action should take place

Details

An optional value describing when the action should be performed.

participantReference< Patient | Practitioner | PractitionerRole | RelatedPerson | Device >[]

Who should perform the action

Details

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

typeCodeableConcept

create | update | remove | fire-event

Details

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

groupingBehaviorcode

visual-group | logical-group | sentence-group

Details

Defines the grouping behavior for the action and its children.

selectionBehaviorcode

any | all | all-or-none | exactly-one | at-most-one | one-or-more

Details

Defines the selection behavior for the action and its children.

requiredBehaviorcode

must | could | must-unless-documented

Details

Defines expectations around whether an action is required.

precheckBehaviorcode

yes | no

Details

Defines whether the action should usually be preselected.

cardinalityBehaviorcode

single | multiple

Details

Defines whether the action can be selected multiple times.

resourceReference<Resource>

The target of the action

Details

The 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[]

Sub action

Details

Sub actions.

Search Parameters

NameTypeDescriptionExpression
authorreferenceThe author of the request groupRequestGroup.author
authoreddateThe date the request group was authoredRequestGroup.authoredOn
codetokenThe code of the request groupRequestGroup.code
encounterreferenceThe encounter the request group applies toRequestGroup.encounter
group-identifiertokenThe group identifier for the request groupRequestGroup.groupIdentifier
identifiertokenExternal identifiers for the request groupRequestGroup.identifier
instantiates-canonicalreferenceThe FHIR-based definition from which the request group is realizedRequestGroup.instantiatesCanonical
instantiates-uriuriThe external definition from which the request group is realizedRequestGroup.instantiatesUri
intenttokenThe intent of the request groupRequestGroup.intent
participantreferenceThe participant in the requests in the groupRequestGroup.action.participant
patientreferenceThe identity of a patient to search for request groupsRequestGroup.subject.where(resolve() is Patient)
prioritytokenThe priority of the request groupRequestGroup.priority
statustokenThe status of the request groupRequestGroup.status
subjectreferenceThe subject that the request group is aboutRequestGroup.subject

Inherited Properties

NameRequiredTypeDescription
idstring

Logical id of this artifact

Details

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

metaMeta

Metadata about the resource

Details

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRulesuri

A set of rules under which this content was created

Details

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

languagecode

Language of the resource content

Details

The base language in which the resource is written.

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

textNarrative

Text summary of the resource, for human interpretation

Details

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

containedResource[]

Contained, inline Resources

Details

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

extensionExtension[]

Additional content defined by implementations

Details

May be used to represent additional information that is not part of the basic definition of the resource. 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.

modifierExtensionExtension[]

Extensions that cannot be ignored

Details

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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.