DRAFT Implementation Guide

This is for collaboration and discussion purposes and is subject to change.

North West Genomics Testing Workflow (GTW) - Local Development build (v0.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• XML
• JSON

Resource Profile: RequestGroup

DRAFT To provide grouping of individual ServiceRequests in the Test Order

Usage:

• This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from RequestGroup

Name	Flags	Card.	Type	Description & Constraints
RequestGroup		0..*	RequestGroup	A group of related requests
identifier	S	1..*	CorrelationIdentifier	Business identifier
subject	S	1..1	Reference(Patient)	Who the request group is about
action	S	1..*	BackboneElement	Proposed actions, if any
resource	S	1..1	Reference(ServiceRequest)	The target of the action
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
RequestGroup		0..*	RequestGroup	A group of related requests dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	SΣ	1..*	CorrelationIdentifier	Business identifier ele-1: All FHIR elements must have a @value or children
status	?!Σ	1..1	code	draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): Codes identifying the lifecycle stage of a request. ele-1: All FHIR elements must have a @value or children
intent	?!Σ	1..1	code	proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request. ele-1: All FHIR elements must have a @value or children
subject	S	1..1	Reference(Patient)	Who the request group is about ele-1: All FHIR elements must have a @value or children
action	SC	1..*	BackboneElement	Proposed actions, if any ele-1: All FHIR elements must have a @value or children rqg-1: Must have resource or action but not both
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
resource	SC	1..1	Reference(ServiceRequest)	The target of the action ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
RequestGroup.status	required	RequestStatus http://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard
RequestGroup.intent	required	RequestIntent http://hl7.org/fhir/ValueSet/request-intent|4.0.1 from the FHIR Standard

Name	Flags	Card.	Type	Description & Constraints
RequestGroup		0..*	RequestGroup	A group of related requests
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..*	CorrelationIdentifier	Business identifier
instantiatesCanonical	Σ	0..*	canonical()	Instantiates FHIR protocol or definition
instantiatesUri	Σ	0..*	uri	Instantiates external protocol or definition
basedOn		0..*	Reference(Resource)	Fulfills plan, proposal, or order
replaces		0..*	Reference(Resource)	Request(s) replaced by this request
groupIdentifier	Σ	0..1	Identifier	Composite request this is part of
status	?!Σ	1..1	code	draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): Codes identifying the lifecycle stage of a request.
intent	?!Σ	1..1	code	proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request.
priority	Σ	0..1	code	routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
code	Σ	0..1	CodeableConcept	What's being requested/ordered
subject	S	1..1	Reference(Patient)	Who the request group is about
encounter		0..1	Reference(Encounter)	Created as part of
authoredOn		0..1	dateTime	When the request group was authored
author		0..1	Reference(Device | Practitioner | PractitionerRole)	Device or practitioner that authored the request group
reasonCode		0..*	CodeableConcept	Why the request group is needed
reasonReference		0..*	Reference(Condition | Observation | DiagnosticReport | DocumentReference)	Why the request group is needed
note		0..*	Annotation	Additional notes about the response
action	SC	1..*	BackboneElement	Proposed actions, if any rqg-1: Must have resource or action but not both
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
prefix		0..1	string	User-visible prefix for the action (e.g. 1. or A.)
title		0..1	string	User-visible title
description	Σ	0..1	string	Short description of the action
textEquivalent	Σ	0..1	string	Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
priority		0..1	code	routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
code		0..*	CodeableConcept	Code representing the meaning of the action or sub-actions
documentation		0..*	RelatedArtifact	Supporting documentation for the intended performer of the action
condition		0..*	BackboneElement	Whether or not the action is applicable
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
kind		1..1	code	applicability | start | stop Binding: ActionConditionKind (required): The kind of condition for the action.
expression		0..1	Expression	Boolean-valued expression
relatedAction		0..*	BackboneElement	Relationship to another action
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actionId		1..1	id	What action this is related to
relationship		1..1	code	before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
offset[x]		0..1		Time offset for the relationship
offsetDuration			Duration
offsetRange			Range
timing[x]		0..1		When the action should take place
timingDateTime			dateTime
timingAge			Age
timingPeriod			Period
timingDuration			Duration
timingRange			Range
timingTiming			Timing
participant		0..*	Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device)	Who should perform the action
type		0..1	CodeableConcept	create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed.
groupingBehavior		0..1	code	visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
selectionBehavior		0..1	code	any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.
requiredBehavior		0..1	code	must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
precheckBehavior		0..1	code	yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
cardinalityBehavior		0..1	code	single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.
resource	SC	1..1	Reference(ServiceRequest)	The target of the action
action	C	0..*	See action (RequestGroup)	Sub action
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
RequestGroup.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
RequestGroup.status	required	RequestStatus http://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard
RequestGroup.intent	required	RequestIntent http://hl7.org/fhir/ValueSet/request-intent|4.0.1 from the FHIR Standard
RequestGroup.priority	required	RequestPriority http://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard
RequestGroup.action.priority	required	RequestPriority http://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard
RequestGroup.action.condition.kind	required	ActionConditionKind http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1 from the FHIR Standard
RequestGroup.action.relatedAction.relationship	required	ActionRelationshipType http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1 from the FHIR Standard
RequestGroup.action.type	extensible	ActionType http://hl7.org/fhir/ValueSet/action-type from the FHIR Standard
RequestGroup.action.groupingBehavior	required	ActionGroupingBehavior http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1 from the FHIR Standard
RequestGroup.action.selectionBehavior	required	ActionSelectionBehavior http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1 from the FHIR Standard
RequestGroup.action.requiredBehavior	required	ActionRequiredBehavior http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1 from the FHIR Standard
RequestGroup.action.precheckBehavior	required	ActionPrecheckBehavior http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1 from the FHIR Standard
RequestGroup.action.cardinalityBehavior	required	ActionCardinalityBehavior http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1 from the FHIR Standard

This structure is derived from RequestGroup

Summary

Mandatory: 4 elements
Must-Support: 4 elements

Structures

This structure refers to these other structures:

• Correlation Identifier (https://hl7.mft.nhs.uk/StructureDefinition/CorrelationIdentifier)
• Patient (https://hl7.mft.nhs.uk/StructureDefinition/Patient)
• ServiceRequest (https://hl7.mft.nhs.uk/StructureDefinition/ServiceRequest)

Differential View

This structure is derived from RequestGroup

Name	Flags	Card.	Type	Description & Constraints
RequestGroup		0..*	RequestGroup	A group of related requests
identifier	S	1..*	CorrelationIdentifier	Business identifier
subject	S	1..1	Reference(Patient)	Who the request group is about
action	S	1..*	BackboneElement	Proposed actions, if any
resource	S	1..1	Reference(ServiceRequest)	The target of the action
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
RequestGroup		0..*	RequestGroup	A group of related requests dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	SΣ	1..*	CorrelationIdentifier	Business identifier ele-1: All FHIR elements must have a @value or children
status	?!Σ	1..1	code	draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): Codes identifying the lifecycle stage of a request. ele-1: All FHIR elements must have a @value or children
intent	?!Σ	1..1	code	proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request. ele-1: All FHIR elements must have a @value or children
subject	S	1..1	Reference(Patient)	Who the request group is about ele-1: All FHIR elements must have a @value or children
action	SC	1..*	BackboneElement	Proposed actions, if any ele-1: All FHIR elements must have a @value or children rqg-1: Must have resource or action but not both
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
resource	SC	1..1	Reference(ServiceRequest)	The target of the action ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
RequestGroup.status	required	RequestStatus http://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard
RequestGroup.intent	required	RequestIntent http://hl7.org/fhir/ValueSet/request-intent|4.0.1 from the FHIR Standard

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
RequestGroup		0..*	RequestGroup	A group of related requests
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..*	CorrelationIdentifier	Business identifier
instantiatesCanonical	Σ	0..*	canonical()	Instantiates FHIR protocol or definition
instantiatesUri	Σ	0..*	uri	Instantiates external protocol or definition
basedOn		0..*	Reference(Resource)	Fulfills plan, proposal, or order
replaces		0..*	Reference(Resource)	Request(s) replaced by this request
groupIdentifier	Σ	0..1	Identifier	Composite request this is part of
status	?!Σ	1..1	code	draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): Codes identifying the lifecycle stage of a request.
intent	?!Σ	1..1	code	proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request.
priority	Σ	0..1	code	routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
code	Σ	0..1	CodeableConcept	What's being requested/ordered
subject	S	1..1	Reference(Patient)	Who the request group is about
encounter		0..1	Reference(Encounter)	Created as part of
authoredOn		0..1	dateTime	When the request group was authored
author		0..1	Reference(Device | Practitioner | PractitionerRole)	Device or practitioner that authored the request group
reasonCode		0..*	CodeableConcept	Why the request group is needed
reasonReference		0..*	Reference(Condition | Observation | DiagnosticReport | DocumentReference)	Why the request group is needed
note		0..*	Annotation	Additional notes about the response
action	SC	1..*	BackboneElement	Proposed actions, if any rqg-1: Must have resource or action but not both
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
prefix		0..1	string	User-visible prefix for the action (e.g. 1. or A.)
title		0..1	string	User-visible title
description	Σ	0..1	string	Short description of the action
textEquivalent	Σ	0..1	string	Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
priority		0..1	code	routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
code		0..*	CodeableConcept	Code representing the meaning of the action or sub-actions
documentation		0..*	RelatedArtifact	Supporting documentation for the intended performer of the action
condition		0..*	BackboneElement	Whether or not the action is applicable
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
kind		1..1	code	applicability | start | stop Binding: ActionConditionKind (required): The kind of condition for the action.
expression		0..1	Expression	Boolean-valued expression
relatedAction		0..*	BackboneElement	Relationship to another action
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actionId		1..1	id	What action this is related to
relationship		1..1	code	before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
offset[x]		0..1		Time offset for the relationship
offsetDuration			Duration
offsetRange			Range
timing[x]		0..1		When the action should take place
timingDateTime			dateTime
timingAge			Age
timingPeriod			Period
timingDuration			Duration
timingRange			Range
timingTiming			Timing
participant		0..*	Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device)	Who should perform the action
type		0..1	CodeableConcept	create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed.
groupingBehavior		0..1	code	visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
selectionBehavior		0..1	code	any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.
requiredBehavior		0..1	code	must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
precheckBehavior		0..1	code	yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
cardinalityBehavior		0..1	code	single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.
resource	SC	1..1	Reference(ServiceRequest)	The target of the action
action	C	0..*	See action (RequestGroup)	Sub action
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
RequestGroup.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
RequestGroup.status	required	RequestStatus http://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard
RequestGroup.intent	required	RequestIntent http://hl7.org/fhir/ValueSet/request-intent|4.0.1 from the FHIR Standard
RequestGroup.priority	required	RequestPriority http://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard
RequestGroup.action.priority	required	RequestPriority http://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard
RequestGroup.action.condition.kind	required	ActionConditionKind http://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1 from the FHIR Standard
RequestGroup.action.relatedAction.relationship	required	ActionRelationshipType http://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1 from the FHIR Standard
RequestGroup.action.type	extensible	ActionType http://hl7.org/fhir/ValueSet/action-type from the FHIR Standard
RequestGroup.action.groupingBehavior	required	ActionGroupingBehavior http://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1 from the FHIR Standard
RequestGroup.action.selectionBehavior	required	ActionSelectionBehavior http://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1 from the FHIR Standard
RequestGroup.action.requiredBehavior	required	ActionRequiredBehavior http://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1 from the FHIR Standard
RequestGroup.action.precheckBehavior	required	ActionPrecheckBehavior http://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1 from the FHIR Standard
RequestGroup.action.cardinalityBehavior	required	ActionCardinalityBehavior http://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1 from the FHIR Standard

This structure is derived from RequestGroup

Summary

Mandatory: 4 elements
Must-Support: 4 elements

Structures

This structure refers to these other structures:

• Correlation Identifier (https://hl7.mft.nhs.uk/StructureDefinition/CorrelationIdentifier)
• Patient (https://hl7.mft.nhs.uk/StructureDefinition/Patient)
• ServiceRequest (https://hl7.mft.nhs.uk/StructureDefinition/ServiceRequest)

Other representations of profile: CSV, Excel, Schematron