RequestGroup resource implementation guidance
Important: This site is under active development by NHS Digital and is intended to provide all the technical resources you need to successfully develop applications using the FHIR® CDS API.
RequestGroup: Implementation Guidance
Usage
The RequestGroup resource is a container for 0..1 referral requests and 0..* care plans.
Detailed implementation guidance for a RequestGroup resource in the scope of this implementation guide is given below:
| Name | Cardinality | Type | FHIR Documentation | CDS Implementation Guidance |
|---|---|---|---|---|
id |
0..1 |
id | Logical id of this artifact | Note that this will always be populated except when the resource is being created (initial creation call) |
meta |
0..1 |
Meta | Metadata about the resource | |
implicitRules |
0..1 |
uri | A set of rules under which this content was created | |
language |
0..1 |
code | Language of the resource content. Common Languages (Extensible but limited to All Languages) |
|
text |
0..1 |
Narrative | Text summary of the resource, for human interpretation | |
contained |
0..* |
Resource | Contained, inline Resources | This SHOULD NOT be populated |
extension |
0..* |
Extension | Additional Content defined by implementations | |
modifierExtension |
0..* |
Extension | Extensions that cannot be ignored | |
identifier |
0..* |
Identifier | Business identifier | |
definition |
0..* |
Reference(Any) | Instantiates protocol or definition | |
basedOn |
0..* |
Reference(Any) | Fulfills plan, proposal, or order | This MUST NOT be populated. |
replaces |
0..* |
Reference(Any) | Request(s) replaced by this request | This MUST NOT be populated. |
groupIdentifier |
0..1 |
Identifier | Composite request this is part of | This MUST NOT be populated. |
status |
1..1 |
code | draft | active | suspended | cancelled | completed | entered-in-error | unknown RequestStatus (Required) | This MUST be populated with either 'active', 'completed' or 'cancelled'. Other statuses are not valid. |
intent |
1..1 |
code | proposal | plan | order RequestIntent (Required) | This MUST be populated with 'plan'. |
priority |
0..1 |
code | routine | urgent | asap | stat RequestPriority (Required) | This MUST be populated with 'routine'. |
subject |
0..1 |
Reference(Patient/Group) | Who the request group is about | This MUST be populated with the Patient. |
context |
0..1 |
Reference(Encounter | | EpisodeOfCare) | Encounter or Episode for the request group | This MUST be populated with the Encounter. |
authoredOn |
0..1 |
dateTime | When the request group was authored | This SHOULD be populated. |
author |
0..1 |
Reference(Device/Practitioner) | Device or practitioner that authored the request group | This MUST be populated with the CDS (Device). |
reason[x] |
0..1 |
Reason for the request group | This MUST NOT be populated. | |
reasonCodeableConcept |
CodeableConcept | This MUST NOT be populated. | ||
reasonReference |
Reference(Any) | This MUST NOT be populated. | ||
note |
0..* |
Annotation | Additional notes about the response | This MUST NOT be populated. |
action |
0..* |
BackboneElement | Proposed actions, if any + Must have resource or action but not both |
Where, populated, this MUST only be populated with a resource. |
label |
0..1 |
String | User-visible label for the action (e.g. 1. or A.) | This MUST NOT be populated. |
title |
0..1 |
String | User-visible title | This MUST NOT be populated. |
description |
0..1 |
String | Short description of the action | This MUST NOT be populated. |
textEquivalent |
0..1 |
String | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system | This MUST NOT be populated. |
code |
0..* |
CodeableConcept | Code representing the meaning of the action or sub-actions | This MUST NOT be populated. |
documentation |
0..* |
RelatedArtifact | Supporting documentation for the intended performer of the action | This MUST NOT be populated. |
condition |
0..* |
BackboneElement | Whether or not the action is applicable | This MUST NOT be populated. |
relatedAction |
0..* |
BackboneElement | Relationship to another action | This MUST NOT be populated. |
actionId |
1..1 |
id | What action this is related to | This MUST NOT be populated. |
relationship |
1..1 |
code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end ActionRelationshipType (Required) | This MUST NOT be populated. |
timing[x] |
0..1 |
When the action should take place | This MUST NOT be populated. | |
type |
0..1 |
Coding | create | update | remove | fire-event ActionType (Extensible) | This MUST NOT be populated. |
groupingBehavior |
0..1 |
code | visual-group | logical-group | sentence-group ActionGroupingBehavior (Required) | This MUST NOT be populated. |
selectionBehavior |
0..1 |
code | any | all | all-or-none | exactly-one | at-most-one | one-or-more ActionSelectionBehavior (Required) | This MUST NOT be populated. |
requiredBehavior |
0..1 |
code | must | could | must-unless-documented ActionRequiredBehavior (Required) | This MUST NOT be populated. |
precheckBehavior |
0..1 |
code | yes | no ActionPrecheckBehavior (Required) | This MUST NOT be populated. |
cardinalityBehavior |
0..1 |
code | single | multiple ActionCardinalityBehavior (Required) | This MUST NOT be populated. |
resource |
0..1 |
Reference(Any) | The target of the action | This MAY be populated. |
action |
0..* |
action | Sub action | This MUST NOT be populated. |
