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 NHSEngland-RequestGroup-Genomics
Used for orchestration of familial test requests, where consultand tests need to be processed for interpretation of the proband. For Tumour First + Germline Late requests, the ServiceRequest.basedOn element SHALL be used instead.
Created and managed by the central service upon receipt of a ServiceRequest with a requisition identifier (proband requests are expected to include the extension:genomicPatientRole=Proband to identify them as the Proband request, at which point the RequestGroup will be created). Any requests submitted to the central service with the same requisition identifier will be added to the RequestGroup as additional action.resource references (it is expected that these will be consultand requests, though alternate scenarios, such as change of proband, are being investigated).
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 investigated.
| Profile url | FHIR Module | Normative Status |
|---|---|---|
| https://fhir.nhs.uk/StructureDefinition/NHSEngland-RequestGroup-Genomics | NHS England Genomics | trial-use |
| Canonical_URL | Status | Current_Version | Last_Updated | Description |
|---|---|---|---|---|
| https://fhir.nhs.uk/StructureDefinition/NHSEngland-RequestGroup-Genomics | active | 0.3.0 | 2026-04-16 | This profile defines the Genomics constraints and extensions on the International FHIR resource RequestGroup. |
Tree View
| NHSEngland_RequestGroup_Genomics (RequestGroup) | C | RequestGroup | |
| id | Σ | 0..1 | id |
| meta | Σ | 0..1 | Meta |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| text | 0..1 | Narrative | |
| contained | 0..* | Resource | |
| extension | C | 0..* | Extension |
| modifierExtension | ?! C | 0..* | Extension |
| identifier | Σ | 0..* | Identifier |
| instantiatesCanonical | Σ | 0..* | canonical |
| instantiatesUri | Σ | 0..* | uri |
| basedOn | C | 0..0 | Reference(Resource) |
| replaces | C | 0..* | Reference(Resource) |
| groupIdentifier | Σ | 0..0 | Identifier |
| status | Σ ?! | 1..1 | codeBinding |
| intent | Σ ?! | 1..1 | codeBinding |
| priority | Σ | 0..1 | codeBinding |
| code | Σ | 0..1 | CodeableConcept |
| subject | C | 1..1 | Reference(Group | Patient | NHSEngland_Patient_Genomics) |
| encounter | C | 0..0 | Reference(Encounter) |
| authoredOn | 0..1 | dateTime | |
| author | C | 0..0 | Reference(Device | Practitioner | PractitionerRole) |
| reasonCode | 0..* | CodeableConcept | |
| reasonReference | C | 0..* | Reference(Condition | DiagnosticReport | DocumentReference | Observation) |
| note | 0..0 | Annotation | |
| action | C | 1..* | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| prefix | 0..1 | string | |
| title | 0..1 | string | |
| description | Σ | 0..1 | string |
| textEquivalent | Σ | 0..1 | string |
| priority | 0..1 | codeBinding | |
| code | 0..* | CodeableConcept | |
| documentation | 0..* | RelatedArtifact | |
| condition | 0..* | BackboneElement | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| kind | 1..1 | codeBinding | |
| expression | C | 0..1 | Expression |
| relatedAction | 0..* | BackboneElement | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| actionId | 1..1 | id | |
| relationship | 1..1 | codeBinding | |
| offset[x] | 0..1 | ||
| offsetDuration | Duration | ||
| offsetRange | Range | ||
| timing[x] | 0..1 | ||
| timingAge | Age | ||
| timingDateTime | dateTime | ||
| timingDuration | Duration | ||
| timingPeriod | Period | ||
| timingRange | Range | ||
| timingTiming | Timing | ||
| participant | C | 0..* | Reference(Device | Patient | Practitioner | PractitionerRole | RelatedPerson) |
| type | 0..1 | CodeableConceptBinding | |
| groupingBehavior | 0..1 | codeBinding | |
| selectionBehavior | 0..1 | codeBinding | |
| requiredBehavior | 0..1 | codeBinding | |
| precheckBehavior | 0..1 | codeBinding | |
| cardinalityBehavior | 0..1 | codeBinding | |
| resource | C | 0..1 | Reference(Resource) |
| action | C | 0..* | see (action) |
Detailed Descriptions
| RequestGroup | |||
| Short | A group of related requests | ||
| Definition | 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". | ||
| Cardinality | 0..* | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.id | |||
| Short | Logical id of this artifact | ||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||
| Cardinality | 0..1 | ||
| Type | id | ||
| Summary | True | ||
| Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.meta | |||
| Short | Metadata about the resource | ||
| Definition | 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. | ||
| Cardinality | 0..1 | ||
| Type | Meta | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.implicitRules | |||
| Short | A set of rules under which this content was created | ||
| Definition | 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. | ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Modifier | True | ||
| Summary | True | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.language | |||
| Short | Language of the resource content | ||
| Definition | The base language in which the resource is written. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | A human language.
| ||
| Comments | 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.text | |||
| Short | Text summary of the resource, for human interpretation | ||
| Definition | 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. | ||
| Cardinality | 0..1 | ||
| Type | Narrative | ||
| Alias | narrative, html, xhtml, display | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.contained | |||
| Short | Contained, inline Resources | ||
| Definition | 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. | ||
| Cardinality | 0..* | ||
| Type | Resource | ||
| Alias | inline resources, anonymous resources, contained resources | ||
| Comments | 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. | ||
| Mappings |
| ||
| RequestGroup.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | 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. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.modifierExtension | |||
| Short | Extensions that cannot be ignored | ||
| Definition | 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). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Alias | extensions, user content | ||
| Requirements | 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. | ||
| Comments | 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.identifier | |||
| Short | Business identifier | ||
| Definition | Automatically assigned by the central service, matching the ServiceRequest.requisition. | ||
| Cardinality | 0..* | ||
| Type | Identifier | ||
| Summary | True | ||
| Requirements | Allows identification of the request as it is known by various participating systems and in a way that remains consistent across servers. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.instantiatesCanonical | |||
| Short | Instantiates FHIR protocol or definition | ||
| Definition | 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. | ||
| Cardinality | 0..* | ||
| Type | canonical | ||
| Summary | True | ||
| Comments | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.instantiatesUri | |||
| Short | Instantiates external protocol or definition | ||
| Definition | A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request. | ||
| Cardinality | 0..* | ||
| Type | uri | ||
| Summary | True | ||
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.basedOn | |||
| Short | Fulfills plan, proposal, or order | ||
| Definition | A plan, proposal or order that is fulfilled in whole or in part by this request. | ||
| Cardinality | 0..0 | ||
| Type | Reference(Resource) | ||
| Alias | fulfills | ||
| Requirements | Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon. | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.replaces | |||
| Short | Request(s) replaced by this request | ||
| Definition | Completed or terminated request(s) whose function is taken by this new request. | ||
| Cardinality | 0..* | ||
| Type | Reference(Resource) | ||
| Alias | supersedes, prior, renewed order | ||
| Requirements | Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests. | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.groupIdentifier | |||
| Short | Composite request this is part of | ||
| Definition | 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. | ||
| Cardinality | 0..0 | ||
| Type | Identifier | ||
| Summary | True | ||
| Alias | grouperid, requisition | ||
| Requirements | Some business processes need to know if multiple items were ordered as part of the same "prescription" or "requisition" for billing or other purposes. | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.status | |||
| Short | draft | active | on-hold | revoked | completed | entered-in-error | unknown | ||
| Definition | Automatically assigned by the central service, status will be propagated based on the included ServiceRequests. At the point a ServiceRequest is added, either in | ||
| Cardinality | 1..1 | ||
| Type | code | ||
| Binding | Codes identifying the lifecycle stage of a request. | ||
| Modifier | True | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.intent | |||
| Short | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option | ||
| Definition | Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain. | ||
| Cardinality | 1..1 | ||
| Type | code | ||
| Binding | Codes indicating the degree of authority/intentionality associated with a request. | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | category | ||
| Requirements | Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.priority | |||
| Short | routine | urgent | asap | stat | ||
| Definition | Indicates how quickly the request should be addressed with respect to other requests. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | Identifies the level of importance to be assigned to actioning the request. | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Meaning when missing | If missing, this request should be performed with normal priority | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.code | |||
| Short | What's being requested/ordered | ||
| Definition | A code that identifies what the overall request group is. | ||
| Cardinality | 0..1 | ||
| Type | CodeableConcept | ||
| Summary | True | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.subject | |||
| Short | Who the request group is about | ||
| Definition | Automatically assigned by the central service. SHALL match the subject referenced from the Proband request. | ||
| Cardinality | 1..1 | ||
| Type | Reference(Group | Patient | NHSEngland_Patient_Genomics) | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.encounter | |||
| Short | Created as part of | ||
| Definition | Describes the context of the request group, if any. | ||
| Cardinality | 0..0 | ||
| Type | Reference(Encounter) | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.authoredOn | |||
| Short | When the request group was authored | ||
| Definition | Indicates when the request group was created. | ||
| Cardinality | 0..1 | ||
| Type | dateTime | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.author | |||
| Short | Device or practitioner that authored the request group | ||
| Definition | Provides a reference to the author of the request group. | ||
| Cardinality | 0..0 | ||
| Type | Reference(Device | Practitioner | PractitionerRole) | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.reasonCode | |||
| Short | Why the request group is needed | ||
| Definition | Describes the reason for the request group in coded or textual form. | ||
| Cardinality | 0..* | ||
| Type | CodeableConcept | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.reasonReference | |||
| Short | Why the request group is needed | ||
| Definition | Indicates another resource whose existence justifies this request group. | ||
| Cardinality | 0..* | ||
| Type | Reference(Condition | DiagnosticReport | DocumentReference | Observation) | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.note | |||
| Short | Additional notes about the response | ||
| Definition | Provides a mechanism to communicate additional information about the response. | ||
| Cardinality | 0..0 | ||
| Type | Annotation | ||
| Comments | 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.action | |||
| Short | Proposed actions, if any | ||
| Definition | 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. | ||
| Cardinality | 1..* | ||
| Type | BackboneElement | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.action.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| RequestGroup.action.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | 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. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.action.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | 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). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | 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. | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.action.prefix | |||
| Short | User-visible prefix for the action (e.g. 1. or A.) | ||
| Definition | A user-visible prefix for the action. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.action.title | |||
| Short | User-visible title | ||
| Definition | The title of the action displayed to a user. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.action.description | |||
| Short | Short description of the action | ||
| Definition | A short description of the action used to provide a summary to display to the user. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.action.textEquivalent | |||
| Short | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system | ||
| Definition | 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. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.action.priority | |||
| Short | routine | urgent | asap | stat | ||
| Definition | Indicates how quickly the action should be addressed with respect to other actions. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | Identifies the level of importance to be assigned to actioning the request. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.action.code | |||
| Short | Code representing the meaning of the action or sub-actions | ||
| Definition | 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. | ||
| Cardinality | 0..* | ||
| Type | CodeableConcept | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.action.documentation | |||
| Short | Supporting documentation for the intended performer of the action | ||
| Definition | 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. | ||
| Cardinality | 0..* | ||
| Type | RelatedArtifact | ||
| Comments | Each related artifact is either an attachment, or a reference to another knowledge resource, but not both. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.action.condition | |||
| Short | Whether or not the action is applicable | ||
| Definition | An expression that describes applicability criteria, or start/stop conditions for the action. | ||
| Cardinality | 0..* | ||
| Type | BackboneElement | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.action.condition.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| RequestGroup.action.condition.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | 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. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.action.condition.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | 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). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | 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. | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.action.condition.kind | |||
| Short | applicability | start | stop | ||
| Definition | The kind of condition. | ||
| Cardinality | 1..1 | ||
| Type | code | ||
| Binding | The kind of condition for the action. | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.action.condition.expression | |||
| Short | Boolean-valued expression | ||
| Definition | An expression that returns true or false, indicating whether or not the condition is satisfied. | ||
| Cardinality | 0..1 | ||
| Type | Expression | ||
| Comments | The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.action.relatedAction | |||
| Short | Relationship to another action | ||
| Definition | A relationship to another action such as "before" or "30-60 minutes after start of". | ||
| Cardinality | 0..* | ||
| Type | BackboneElement | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.action.relatedAction.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| RequestGroup.action.relatedAction.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | 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. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.action.relatedAction.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | 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). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | 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. | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.action.relatedAction.actionId | |||
| Short | What action this is related to | ||
| Definition | The element id of the action this is related to. | ||
| Cardinality | 1..1 | ||
| Type | id | ||
| Comments | RFC 4122 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.action.relatedAction.relationship | |||
| Short | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end | ||
| Definition | The relationship of this action to the related action. | ||
| Cardinality | 1..1 | ||
| Type | code | ||
| Binding | Defines the types of relationships between actions. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.action.relatedAction.offset[x] | |||
| Short | Time offset for the relationship | ||
| Definition | A duration or range of durations to apply to the relationship. For example, 30-60 minutes before. | ||
| Cardinality | 0..1 | ||
| Type | Duration | Range | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.action.timing[x] | |||
| Short | When the action should take place | ||
| Definition | An optional value describing when the action should be performed. | ||
| Cardinality | 0..1 | ||
| Type | Age | dateTime | Duration | Period | Range | Timing | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.action.participant | |||
| Short | Who should perform the action | ||
| Definition | The participant that should perform or be responsible for this action. | ||
| Cardinality | 0..* | ||
| Type | Reference(Device | Patient | Practitioner | PractitionerRole | RelatedPerson) | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.action.type | |||
| Short | create | update | remove | fire-event | ||
| Definition | The type of action to perform (create, update, remove). | ||
| Cardinality | 0..1 | ||
| Type | CodeableConcept | ||
| Binding | The type of action to be performed. | ||
| Comments | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.action.groupingBehavior | |||
| Short | visual-group | logical-group | sentence-group | ||
| Definition | Defines the grouping behavior for the action and its children. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | Defines organization behavior of a group. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.action.selectionBehavior | |||
| Short | any | all | all-or-none | exactly-one | at-most-one | one-or-more | ||
| Definition | Defines the selection behavior for the action and its children. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | Defines selection behavior of a group. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.action.requiredBehavior | |||
| Short | must | could | must-unless-documented | ||
| Definition | Defines expectations around whether an action is required. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | Defines expectations around whether an action or action group is required. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.action.precheckBehavior | |||
| Short | yes | no | ||
| Definition | Defines whether the action should usually be preselected. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | Defines selection frequency behavior for an action or group. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.action.cardinalityBehavior | |||
| Short | single | multiple | ||
| Definition | Defines whether the action can be selected multiple times. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | Defines behavior for an action or a group for how many times that item may be repeated. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.action.resource | |||
| Short | The target of the action | ||
| Definition | The resource that is the target of the action (e.g. CommunicationRequest). | ||
| Cardinality | 0..1 | ||
| Type | Reference(Resource) | ||
| Comments | The target resource SHALL be a Request resource with a Request.intent set to "option". | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, rqg-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| RequestGroup.action.action | |||
| Short | Sub action | ||
| Definition | Sub actions. | ||
| Cardinality | 0..* | ||
| Type | see (action) | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: rqg-1 | ||
Table View
| RequestGroup | 0..* | |
| RequestGroup.id | id | 0..1 |
| RequestGroup.meta | Meta | 0..1 |
| RequestGroup.implicitRules | uri | 0..1 |
| RequestGroup.language | code | 0..1 |
| RequestGroup.text | Narrative | 0..1 |
| RequestGroup.contained | Resource | 0..* |
| RequestGroup.extension | Extension | 0..* |
| RequestGroup.modifierExtension | Extension | 0..* |
| RequestGroup.identifier | Identifier | 0..* |
| RequestGroup.instantiatesCanonical | canonical | 0..* |
| RequestGroup.instantiatesUri | uri | 0..* |
| RequestGroup.basedOn | Reference(Resource) | 0..0 |
| RequestGroup.replaces | Reference(Resource) | 0..* |
| RequestGroup.groupIdentifier | Identifier | 0..0 |
| RequestGroup.status | code | 1..1 |
| RequestGroup.intent | code | 1..1 |
| RequestGroup.priority | code | 0..1 |
| RequestGroup.code | CodeableConcept | 0..1 |
| RequestGroup.subject | Reference(Group | Patient | NHSEngland_Patient_Genomics) | 1..1 |
| RequestGroup.encounter | Reference(Encounter) | 0..0 |
| RequestGroup.authoredOn | dateTime | 0..1 |
| RequestGroup.author | Reference(Device | Practitioner | PractitionerRole) | 0..0 |
| RequestGroup.reasonCode | CodeableConcept | 0..* |
| RequestGroup.reasonReference | Reference(Condition | DiagnosticReport | DocumentReference | Observation) | 0..* |
| RequestGroup.note | Annotation | 0..0 |
| RequestGroup.action | BackboneElement | 1..* |
| RequestGroup.action.id | string | 0..1 |
| RequestGroup.action.extension | Extension | 0..* |
| RequestGroup.action.modifierExtension | Extension | 0..* |
| RequestGroup.action.prefix | string | 0..1 |
| RequestGroup.action.title | string | 0..1 |
| RequestGroup.action.description | string | 0..1 |
| RequestGroup.action.textEquivalent | string | 0..1 |
| RequestGroup.action.priority | code | 0..1 |
| RequestGroup.action.code | CodeableConcept | 0..* |
| RequestGroup.action.documentation | RelatedArtifact | 0..* |
| RequestGroup.action.condition | BackboneElement | 0..* |
| RequestGroup.action.condition.id | string | 0..1 |
| RequestGroup.action.condition.extension | Extension | 0..* |
| RequestGroup.action.condition.modifierExtension | Extension | 0..* |
| RequestGroup.action.condition.kind | code | 1..1 |
| RequestGroup.action.condition.expression | Expression | 0..1 |
| RequestGroup.action.relatedAction | BackboneElement | 0..* |
| RequestGroup.action.relatedAction.id | string | 0..1 |
| RequestGroup.action.relatedAction.extension | Extension | 0..* |
| RequestGroup.action.relatedAction.modifierExtension | Extension | 0..* |
| RequestGroup.action.relatedAction.actionId | id | 1..1 |
| RequestGroup.action.relatedAction.relationship | code | 1..1 |
| RequestGroup.action.relatedAction.offset[x] | Duration | Range | 0..1 |
| RequestGroup.action.timing[x] | Age | dateTime | Duration | Period | Range | Timing | 0..1 |
| RequestGroup.action.participant | Reference(Device | Patient | Practitioner | PractitionerRole | RelatedPerson) | 0..* |
| RequestGroup.action.type | CodeableConcept | 0..1 |
| RequestGroup.action.groupingBehavior | code | 0..1 |
| RequestGroup.action.selectionBehavior | code | 0..1 |
| RequestGroup.action.requiredBehavior | code | 0..1 |
| RequestGroup.action.precheckBehavior | code | 0..1 |
| RequestGroup.action.cardinalityBehavior | code | 0..1 |
| RequestGroup.action.resource | Reference(Resource) | 0..1 |
| RequestGroup.action.action | 0..* |
XML View
JSON View
| 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" } } ]