Notice
- Important: This guidance is under active development by NHS England and content may be added or updated on a regular basis.
- This Implementation Guide is currently in Draft and SHOULD NOT be used for development or active implementation without express direction from the NHS England Genomics Unit.
StructureDefinition RequestGroup
Created and managed by the central service upon receipt of a ServiceRequest with a requisition identifier. Any requests submitted to the central service with the same requisition identifier will be added to the RequestGroup as additional action.resource references.
Aspects of the RequestGroup will be automatically set based on the constituent requests, e.g. propagating status based on statuses of the ServiceRequests.
It is expected the resources will likely be read-only, though needs for editing RequestGroups, e.g. due to mark-in-error/revokation scenarios, are currently being investigating.
| Profile url | FHIR Module | Normative Status |
|---|---|---|
| http://hl7.org/fhir/StructureDefinition/RequestGroup | HL7 International | trial-use |
| RequestGroup | C | DomainResource | Element idRequestGroupShort description A group of related requests DefinitionA group of related requests that can be used to capture intended activities that have inter-dependencies such as "give this medication after that one".
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idRequestGroup.idShort description Logical id of this artifact DefinitionThe 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. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idRequestGroup.metaShort description Metadata about the resource DefinitionThe 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idRequestGroup.implicitRulesShort description A set of rules under which this content was created DefinitionA 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idRequestGroup.languageShort description Language of the resource content DefinitionThe 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). A human language.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idRequestGroup.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idRequestGroup.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRequestGroup.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idRequestGroup.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..* | Identifier | Element idRequestGroup.identifierShort description Business identifier DefinitionAllows a service to provide a unique, business identifier for the request. Allows identification of the request as it is known by various participating systems and in a way that remains consistent across servers. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| instantiatesCanonical | Σ | 0..* | canonical | Element idRequestGroup.instantiatesCanonicalShort description Instantiates FHIR protocol or definition DefinitionA canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| instantiatesUri | Σ | 0..* | uri | Element idRequestGroup.instantiatesUriShort description Instantiates external protocol or definition DefinitionA URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request. see http://en.wikipedia.org/wiki/Uniform_resource_identifier The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| basedOn | C | 0..* | Reference(Resource) | Element idRequestGroup.basedOnShort description Fulfills plan, proposal, or order Alternate namesfulfills DefinitionA plan, proposal or order that is fulfilled in whole or in part by this request. Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| replaces | C | 0..* | Reference(Resource) | Element idRequestGroup.replacesShort description Request(s) replaced by this request Alternate namessupersedes, prior, renewed order DefinitionCompleted or terminated request(s) whose function is taken by this new request. Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| groupIdentifier | Σ | 0..1 | Identifier | Element idRequestGroup.groupIdentifierShort description Composite request this is part of Alternate namesgrouperid, requisition DefinitionA 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. Some business processes need to know if multiple items were ordered as part of the same "prescription" or "requisition" for billing or other purposes. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| status | Σ ?! | 1..1 | codeBinding | Element idRequestGroup.statusShort description draft | active | on-hold | revoked | completed | entered-in-error | unknown DefinitionThe current state of the request. For request groups, the status reflects the status of all the requests in the group. Note that FHIR strings SHALL NOT exceed 1MB in size Codes identifying the lifecycle stage of a request. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| intent | Σ ?! | 1..1 | codeBinding | Element idRequestGroup.intentShort description proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Alternate namescategory DefinitionIndicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain. Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain. Note that FHIR strings SHALL NOT exceed 1MB in size Codes indicating the degree of authority/intentionality associated with a request. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| priority | Σ | 0..1 | codeBinding | Element idRequestGroup.priorityShort description routine | urgent | asap | stat DefinitionIndicates how quickly the request should be addressed with respect to other requests. Note that FHIR strings SHALL NOT exceed 1MB in size If missing, this request should be performed with normal priority Identifies the level of importance to be assigned to actioning the request. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ | 0..1 | CodeableConcept | Element idRequestGroup.codeShort description What's being requested/ordered DefinitionA 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| subject | C | 0..1 | Reference(Group | Patient) | Element idRequestGroup.subjectShort description Who the request group is about DefinitionThe subject for which the request group was created. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| encounter | C | 0..1 | Reference(Encounter) | Element idRequestGroup.encounterShort description Created as part of DefinitionDescribes the context of the request group, if any. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| authoredOn | 0..1 | dateTime | Element idRequestGroup.authoredOnShort description When the request group was authored DefinitionIndicates when the request group was created. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| author | C | 0..1 | Reference(Device | Practitioner | PractitionerRole) | Element idRequestGroup.authorShort description Device or practitioner that authored the request group DefinitionProvides a reference to the author of the request group. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Device | Practitioner | PractitionerRole) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| reasonCode | 0..* | CodeableConcept | Element idRequestGroup.reasonCodeShort description Why the request group is needed DefinitionDescribes the reason for the request group in coded or textual form. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| reasonReference | C | 0..* | Reference(Condition | DiagnosticReport | DocumentReference | Observation) | Element idRequestGroup.reasonReferenceShort description Why the request group is needed DefinitionIndicates another resource whose existence justifies this request group. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Condition | DiagnosticReport | DocumentReference | Observation) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| note | 0..* | Annotation | Element idRequestGroup.noteShort description Additional notes about the response DefinitionProvides a mechanism to communicate additional information about the response. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| action | C | 0..* | BackboneElement | Element idRequestGroup.actionShort description Proposed actions, if any DefinitionThe actions, if any, produced by the evaluation of the artifact. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idRequestGroup.action.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRequestGroup.action.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idRequestGroup.action.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| prefix | 0..1 | string | Element idRequestGroup.action.prefixShort description User-visible prefix for the action (e.g. 1. or A.) DefinitionA user-visible prefix for the action. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| title | 0..1 | string | Element idRequestGroup.action.titleShort description User-visible title DefinitionThe title of the action displayed to a user. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| description | Σ | 0..1 | string | Element idRequestGroup.action.descriptionShort description Short description of the action DefinitionA short description of the action used to provide a summary to display to the user. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| textEquivalent | Σ | 0..1 | string | Element idRequestGroup.action.textEquivalentShort description Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system DefinitionA 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. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| priority | 0..1 | codeBinding | Element idRequestGroup.action.priorityShort description routine | urgent | asap | stat DefinitionIndicates how quickly the action should be addressed with respect to other actions. Note that FHIR strings SHALL NOT exceed 1MB in size Identifies the level of importance to be assigned to actioning the request. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| code | 0..* | CodeableConcept | Element idRequestGroup.action.codeShort description Code representing the meaning of the action or sub-actions DefinitionA 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. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| documentation | 0..* | RelatedArtifact | Element idRequestGroup.action.documentationShort description Supporting documentation for the intended performer of the action DefinitionDidactic 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. Each related artifact is either an attachment, or a reference to another knowledge resource, but not both. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| condition | 0..* | BackboneElement | Element idRequestGroup.action.conditionShort description Whether or not the action is applicable DefinitionAn 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idRequestGroup.action.condition.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRequestGroup.action.condition.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idRequestGroup.action.condition.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| kind | 1..1 | codeBinding | Element idRequestGroup.action.condition.kindShort description applicability | start | stop DefinitionThe 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. The kind of condition for the action. ActionConditionKind (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| expression | C | 0..1 | Expression | Element idRequestGroup.action.condition.expressionShort description Boolean-valued expression DefinitionAn 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| relatedAction | 0..* | BackboneElement | Element idRequestGroup.action.relatedActionShort description Relationship to another action DefinitionA relationship to another action such as "before" or "30-60 minutes after start of". The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idRequestGroup.action.relatedAction.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRequestGroup.action.relatedAction.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idRequestGroup.action.relatedAction.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| actionId | 1..1 | id | Element idRequestGroup.action.relatedAction.actionIdShort description What action this is related to DefinitionThe element id of the action this is related to. RFC 4122 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| relationship | 1..1 | codeBinding | Element idRequestGroup.action.relatedAction.relationshipShort description before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end DefinitionThe relationship of this action to the related action. Note that FHIR strings SHALL NOT exceed 1MB in size Defines the types of relationships between actions. ActionRelationshipType (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| offset[x] | 0..1 | Element idRequestGroup.action.relatedAction.offset[x]Short description Time offset for the relationship DefinitionA duration or range of durations to apply to the relationship. For example, 30-60 minutes before. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| offsetDuration | Duration | Data type | ||||
| offsetRange | Range | Data type | ||||
| timing[x] | 0..1 | Element idRequestGroup.action.timing[x]Short description When the action should take place DefinitionAn optional value describing when the action should be performed. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| timingAge | Age | Data type | ||||
| timingDateTime | dateTime | Data type | ||||
| timingDuration | Duration | Data type | ||||
| timingPeriod | Period | Data type | ||||
| timingRange | Range | Data type | ||||
| timingTiming | Timing | Data type | ||||
| participant | C | 0..* | Reference(Device | Patient | Practitioner | PractitionerRole | RelatedPerson) | Element idRequestGroup.action.participantShort description Who should perform the action DefinitionThe participant that should perform or be responsible for this action. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Device | Patient | Practitioner | PractitionerRole | RelatedPerson) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | 0..1 | CodeableConceptBinding | Element idRequestGroup.action.typeShort description create | update | remove | fire-event DefinitionThe type of action to perform (create, update, remove). Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The type of action to be performed. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| groupingBehavior | 0..1 | codeBinding | Element idRequestGroup.action.groupingBehaviorShort description visual-group | logical-group | sentence-group DefinitionDefines the grouping behavior for the action and its children. Note that FHIR strings SHALL NOT exceed 1MB in size Defines organization behavior of a group. ActionGroupingBehavior (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| selectionBehavior | 0..1 | codeBinding | Element idRequestGroup.action.selectionBehaviorShort description any | all | all-or-none | exactly-one | at-most-one | one-or-more DefinitionDefines the selection behavior for the action and its children. Note that FHIR strings SHALL NOT exceed 1MB in size Defines selection behavior of a group. ActionSelectionBehavior (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| requiredBehavior | 0..1 | codeBinding | Element idRequestGroup.action.requiredBehaviorShort description must | could | must-unless-documented DefinitionDefines expectations around whether an action is required. Note that FHIR strings SHALL NOT exceed 1MB in size Defines expectations around whether an action or action group is required. ActionRequiredBehavior (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| precheckBehavior | 0..1 | codeBinding | Element idRequestGroup.action.precheckBehaviorShort description yes | no DefinitionDefines whether the action should usually be preselected. Note that FHIR strings SHALL NOT exceed 1MB in size Defines selection frequency behavior for an action or group. ActionPrecheckBehavior (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| cardinalityBehavior | 0..1 | codeBinding | Element idRequestGroup.action.cardinalityBehaviorShort description single | multiple DefinitionDefines whether the action can be selected multiple times. Note that FHIR strings SHALL NOT exceed 1MB in size Defines behavior for an action or a group for how many times that item may be repeated. ActionCardinalityBehavior (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| resource | C | 0..1 | Reference(Resource) | Element idRequestGroup.action.resourceShort description The target of the action DefinitionThe resource that is the target of the action (e.g. CommunicationRequest). The target resource SHALL be a Request resource with a Request.intent set to "option". The cardinality or value of this element may be affected by these constraints: ele-1, rqg-1 Constraints
| ||
| action | C | 0..* | see (action) | There are no (further) constraints on this element Element idRequestGroup.action.actionShort description Sub action DefinitionSub actions. The cardinality or value of this element may be affected by these constraints: rqg-1 |
| FHIR | MDS | HL7v2 |
|---|
Additional Guidance
identifier
Automatically assigned by the central service, matching the ServiceRequest.requisition."identifier": [ { "system": "https://fhir.leedssth.nhs.uk//Id/grouptestId", "value": "RR-REQ12764", "assigner": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RR8" } } } ],
status
Automatically assigned by the central service, status will be propagated based on the included ServiceRequests. At the point a ServiceRequest is added, either in `draft` or `active` state, the RequestGroup will be marked as `active`. If all ServiceRequests under the RequestGroup are marked as `completed` or `revoked`, this will be propagated up to the request group level.Propagation of other statuses is currently under review.
"status": "active",
subject
Automatically assigned by the central service. SHALL match the subject referenced from the Proband request."subject": { "reference": "Patient/Patient-MeirLieberman-Example", "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9449307873" } },
action
Automatically updated by the central service upon receipt of a request with a requisition identifier. Additional requests will be added to an existing request group if they share a requisition identifier with an existing service request."action": [ { "resource": { "reference": "ServiceRequest/ServiceRequest-WGSTestOrderForm-TrioTestingProband-Example" } }, { "resource": { "reference": "ServiceRequest/ServiceRequest-WGSTestOrderForm-TrioTestingProbandFather-Example" } }, { "resource": { "reference": "ServiceRequest/ServiceRequest-WGSTestOrderForm-TrioTestingProbandMother-Example" } } ]