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 will be used to group related requests that can be used to capture intended activities that have inter-dependencies.
Detailed implementation guidance for a RequestGroup
resource in the CDS context 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. The status MUST match the CarePlan.status. If the status does not match the CarePlan.status the Encounter Management System MUST throw an error. |
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. | |
reason.reasonCodeableConcept |
CodeableConcept | This MUST NOT be populated. | ||
reason.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 |
This MUST NOT be populated. |
action.label |
0..1 |
String | User-visible label for the action (e.g. 1. or A.) | This MUST NOT be populated. |
action.title |
0..1 |
String | User-visible title | This MUST NOT be populated. |
action.description |
0..1 |
String | Short description of the action | This MUST NOT be populated. |
action.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. |
action.code |
0..* |
CodeableConcept | Code representing the meaning of the action or sub-actions | This MUST NOT be populated. |
action.documentation |
0..* |
RelatedArtifact | Supporting documentation for the intended performer of the action | This MUST NOT be populated. |
action.condition |
0..* |
BackboneElement | Whether or not the action is applicable | This MUST NOT be populated. |
action.relatedAction |
0..* |
BackboneElement | Relationship to another action | This MUST NOT be populated. |
action.relatedAction.actionId |
1..1 |
id | What action this is related to | This MUST NOT be populated. |
action.relatedAction.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. |
action.timing[x] |
0..1 |
When the action should take place | This MUST NOT be populated. | |
action.type |
0..1 |
Coding | create | update | remove | fire-event ActionType (Extensible) | This MUST NOT be populated. |
action.groupingBehavior |
0..1 |
code | visual-group | logical-group | sentence-group ActionGroupingBehavior (Required) | This MUST NOT be populated. |
action.selectionBehavior |
0..1 |
code | any | all | all-or-none | exactly-one | at-most-one | one-or-more ActionSelectionBehavior (Required) | This MUST NOT be populated. |
action.requiredBehavior |
0..1 |
code | must | could | must-unless-documented ActionRequiredBehavior (Required) | This MUST NOT be populated. |
action.precheckBehavior |
0..1 |
code | yes | no ActionPrecheckBehavior (Required) | This MUST NOT be populated. |
action.cardinalityBehavior |
0..1 |
code | single | multiple ActionCardinalityBehavior (Required) | This MUST NOT be populated. |
action.resource |
0..1 |
Reference(Any) | The target of the action | This MUST NOT be populated. |
action |
0..* |
action | Sub action | This MUST NOT be populated. |