RequestGroup

ResourceClinical · Care ProvisionTrial useMaturity 2

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

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

14 of 14 parameters tested

Structure

Show inherited elements (17)

Element	Card.	Type	Description
identifierΣ	0..*	Identifier	Business identifier
instantiatesCanonicalΣ	0..*	canonical	Instantiates FHIR protocol or definition
instantiatesUriΣ	0..*	uri	Instantiates external protocol or definition
basedOn	0..*	Reference(Resource)	Fulfills plan, proposal, or order
replaces	0..*	Reference(Resource)	Request(s) replaced by this request
groupIdentifierΣ	0..1	Identifier	Composite request this is part of
statusRequired?!Σ	1..1	code	draft | active | on-hold | revoked | completed | entered-in-error | unknownBinding (required): request-status
intentRequired?!Σ	1..1	code	proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | optionBinding (required): request-intent
priorityΣ	0..1	code	routine | urgent | asap | statBinding (required): request-priority
codeΣ	0..1	CodeableConcept	What's being requested/ordered
subject	0..1	Reference(Patient | Group)	Who the request group is about
encounter	0..1	Reference(Encounter)	Created as part of
authoredOn	0..1	dateTime	When the request group was authored
author	0..1	Reference(Device | Practitioner | PractitionerRole)	Device or practitioner that authored the request group
reasonCode	0..*	CodeableConcept	Why the request group is needed
reasonReference	0..*	Reference(Condition | Observation | DiagnosticReport | DocumentReference)	Why the request group is needed
note	0..*	Annotation	Additional notes about the response
action	0..*	BackboneElement	Proposed actions, if any
prefix	0..1	string	User-visible prefix for the action (e.g. 1. or A.)
title	0..1	string	User-visible title
descriptionΣ	0..1	string	Short description of the action
textEquivalentΣ	0..1	string	Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
priority	0..1	code	routine | urgent | asap | statBinding (required): request-priority
code	0..*	CodeableConcept	Code representing the meaning of the action or sub-actions
documentation	0..*	RelatedArtifact	Supporting documentation for the intended performer of the action
condition	0..*	BackboneElement	Whether or not the action is applicable
kindRequired	1..1	code	applicability | start | stopBinding (required): action-condition-kind
expression	0..1	Expression	Boolean-valued expression
relatedAction	0..*	BackboneElement	Relationship to another action
actionIdRequired	1..1	id	What action this is related to
relationshipRequired	1..1	code	before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-endBinding (required): action-relationship-type
offset[x]	0..1	Duration | Range	Time offset for the relationship
timing[x]	0..1	dateTime | Age | Period | Duration | Range | Timing	When the action should take place
participant	0..*	Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device)	Who should perform the action
type	0..1	CodeableConcept	create | update | remove | fire-eventBinding (extensible): action-type
groupingBehavior	0..1	code	visual-group | logical-group | sentence-groupBinding (required): action-grouping-behavior
selectionBehavior	0..1	code	any | all | all-or-none | exactly-one | at-most-one | one-or-moreBinding (required): action-selection-behavior
requiredBehavior	0..1	code	must | could | must-unless-documentedBinding (required): action-required-behavior
precheckBehavior	0..1	code	yes | noBinding (required): action-precheck-behavior
cardinalityBehavior	0..1	code	single | multipleBinding (required): action-cardinality-behavior
resource	0..1	Reference(Resource)	The target of the action
action	0..*	Same as RequestGroup.action	Sub action

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/RequestGroup?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
author	reference	The author of the request group RequestGroup.author
authored	date	The date the request group was authored RequestGroup.authoredOn
code	token	The code of the request group RequestGroup.code
encounter	reference	The encounter the request group applies to RequestGroup.encounter
group-identifier	token	The group identifier for the request group RequestGroup.groupIdentifier
identifier	token	External identifiers for the request group RequestGroup.identifier
instantiates-canonical	reference	The FHIR-based definition from which the request group is realized RequestGroup.instantiatesCanonical
instantiates-uri	uri	The external definition from which the request group is realized RequestGroup.instantiatesUri
intent	token	The intent of the request group RequestGroup.intent
participant	reference	The participant in the requests in the group RequestGroup.action.participant
patient	reference	The identity of a patient to search for request groups RequestGroup.subject.where(resolve() is Patient)
priority	token	The priority of the request group RequestGroup.priority
status	token	The status of the request group RequestGroup.status
subject	reference	The subject that the request group is about RequestGroup.subject

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition