NHS England FHIR Implementation Guide (deprecated)

There are no (further) constraints on this element

Element id

RequestGroup

Short description

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".

Data type

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
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
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()

Mappings

rim: Entity. Role, or Act
workflow: Request

0..1

There are no (further) constraints on this element

Element id

RequestGroup.id

Short description

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.

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

There are no (further) constraints on this element

Element id

RequestGroup.meta

Short description

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

implicitRules

Σ ?!

0..1

There are no (further) constraints on this element

Element id

RequestGroup.implicitRules

Short description

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.

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

RequestGroup.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

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).

Data type

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

text

0..1

There are no (further) constraints on this element

Element id

RequestGroup.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

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.

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: Act.text?

contained

0..*

There are no (further) constraints on this element

Element id

RequestGroup.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained 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.

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.

Data type

Mappings

rim: Entity. Role, or Act
rim: N/A

extension

0..*

There are no (further) constraints on this element

Element id

RequestGroup.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

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.

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.

Data type

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

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

NHSBSAprescriptionType

0..1

Element id

RequestGroup.extension:NHSBSAprescriptionType

Short description

Setting and HCP type for the prescrption

Alternate names

extensions, user content

Definition

Care Setting and type of prescriber.

Comments

Data type

ExtensionNHSBSAprescriptionType

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

prescriptionPendingCancellation

0..1

Element id

RequestGroup.extension:prescriptionPendingCancellation

Short description

An extension use to record if a prescription or any of its line items is pending cancellation.

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

An extension use to record if a prescription or any of its line items is pending cancellation

Data type

ExtensionPendingCancellation

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

prescriptionStatusHistory

0..*

Extension(Complex)

Element id

RequestGroup.extension:prescriptionStatusHistory

Short description

Dispensing Prescription Status

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

Extension(Complex)

Extension URL

ExtensionDMPrescriptionStatusHistory

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

repeatInformation

0..*

Extension(Complex)

Element id

RequestGroup.extension:repeatInformation

Short description

An extension use to record both the instance and the maximum number of repeat allowed for a prescription.

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

Extension(Complex)

Extension URL

ExtensionEPSRepeatInformation

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

?! C

0..*

There are no (further) constraints on this element

Element id

RequestGroup.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

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).

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

Data type

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

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

identifier

0..*

There are no (further) constraints on this element

Element id

RequestGroup.identifier

Short description

Business identifier

Definition

Allows a service to provide a unique, business identifier for the request.

Requirements

Allows identification of the request as it is known by various participating systems and in a way that remains consistent across servers.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
workflow: Request.identifier
w5: FiveWs.identifier

instantiatesCanonical

0..*

There are no (further) constraints on this element

Element id

RequestGroup.instantiatesCanonical

Short description

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.

Comments

see Canonical References

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.instantiatesCanonical

instantiatesUri

0..*

There are no (further) constraints on this element

Element id

RequestGroup.instantiatesUri

Short description

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.

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.instantiatesUri

basedOn

0..*

There are no (further) constraints on this element

Element id

RequestGroup.basedOn

Short description

Fulfills plan, proposal, or order

Alternate names

fulfills

Definition

A plan, proposal or order that is fulfilled in whole or in part by this request.

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.basedOn

replaces

0..*

There are no (further) constraints on this element

Element id

RequestGroup.replaces

Short description

Request(s) replaced by this request

Alternate names

supersedes, prior, renewed order

Definition

Completed or terminated request(s) whose function is taken by this new request.

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.replaces

groupIdentifier

0..1

There are no (further) constraints on this element

Element id

RequestGroup.groupIdentifier

Short description

Composite request this is part of

Alternate names

grouperid, requisition

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.

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
workflow: Request.groupIdentifier

status

Σ ?!

1..1

codeBinding

There are no (further) constraints on this element

Element id

RequestGroup.status

Short description

Definition

The current state of the request. For request groups, the status reflects the status of all the requests in the group.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Binding

Codes identifying the lifecycle stage of a request.

RequestStatus (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.status
w5: FiveWs.status

intent

Σ ?!

1..1

codeBinding

There are no (further) constraints on this element

Element id

RequestGroup.intent

Short description

Alternate names

category

Definition

Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.

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

Data type

Binding

Codes indicating the degree of authority/intentionality associated with a request.

RequestIntent (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.intent
w5: FiveWs.class

priority

0..1

codeBinding

There are no (further) constraints on this element

Element id

RequestGroup.priority

Short description

routine | urgent | asap | stat

Definition

Indicates how quickly the request should be addressed with respect to other requests.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Meaning when missing

If missing, this request should be performed with normal priority

Data type

Binding

Identifies the level of importance to be assigned to actioning the request.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.priority
w5: FiveWs.grade

code

0..1

There are no (further) constraints on this element

Element id

RequestGroup.code

Short description

What's being requested/ordered

Definition

A code that identifies what the overall request group is.

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Request.code
w5: FiveWs.what[x]

subject

0..1

There are no (further) constraints on this element

Element id

RequestGroup.subject

Short description

Who the request group is about

Definition

The subject for which the request group was created.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.subject
w5: FiveWs.subject[x]
w5: FiveWs.subject

encounter

0..1

There are no (further) constraints on this element

Element id

RequestGroup.encounter

Short description

Created as part of

Definition

Describes the context of the request group, if any.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.encounter
w5: FiveWs.context

authoredOn

0..1

There are no (further) constraints on this element

Element id

RequestGroup.authoredOn

Short description

When the request group was authored

Definition

Indicates when the request group was created.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.authoredOn
w5: FiveWs.recorded

author

0..1

Reference(Device | Practitioner | PractitionerRole)

There are no (further) constraints on this element

Element id

RequestGroup.author

Short description

Device or practitioner that authored the request group

Definition

Provides a reference to the author of the request group.

Comments

Data type

Reference(Device | Practitioner | PractitionerRole)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.requester
w5: FiveWs.author

reasonCode

0..*

There are no (further) constraints on this element

Element id

RequestGroup.reasonCode

Short description

Why the request group is needed

Definition

Describes the reason for the request group in coded or textual form.

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Request.reasonCode
w5: FiveWs.why[x]

reasonReference

0..*

Reference(Condition | DiagnosticReport | DocumentReference | Observation)

There are no (further) constraints on this element

Element id

RequestGroup.reasonReference

Short description

Why the request group is needed

Definition

Indicates another resource whose existence justifies this request group.

Comments

Data type

Reference(Condition | DiagnosticReport | DocumentReference | Observation)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.reasonReference
w5: FiveWs.why[x]

note

0..*

There are no (further) constraints on this element

Element id

RequestGroup.note

Short description

Additional notes about the response

Definition

Provides a mechanism to communicate additional information about the response.

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).

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Act
workflow: Request.note

action

0..*

There are no (further) constraints on this element

Element id

RequestGroup.action

Short description

Proposed actions, if any

Definition

The actions, if any, produced by the evaluation of the artifact.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
rqg-1: Must have resource or action but not both
resource.exists() != action.exists()

Mappings

rim: n/a

0..1

There are no (further) constraints on this element

Element id

RequestGroup.action.id

Short description

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.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

RequestGroup.action.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

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.

Comments

Data type

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

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

RequestGroup.action.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

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).

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

prefix

0..1

There are no (further) constraints on this element

Element id

RequestGroup.action.prefix

Short description

User-visible prefix for the action (e.g. 1. or A.)

Definition

A user-visible prefix for the action.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

title

0..1

There are no (further) constraints on this element

Element id

RequestGroup.action.title

Short description

User-visible title

Definition

The title of the action displayed to a user.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

description

0..1

There are no (further) constraints on this element

Element id

RequestGroup.action.description

Short description

Short description of the action

Definition

A short description of the action used to provide a summary to display to the user.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

textEquivalent

0..1

There are no (further) constraints on this element

Element id

RequestGroup.action.textEquivalent

Short description

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.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

priority

0..1

codeBinding

There are no (further) constraints on this element

Element id

RequestGroup.action.priority

Short description

routine | urgent | asap | stat

Definition

Indicates how quickly the action should be addressed with respect to other actions.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Binding

Identifies the level of importance to be assigned to actioning the request.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.priority

code

0..*

There are no (further) constraints on this element

Element id

RequestGroup.action.code

Short description

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.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Request.code

documentation

0..*

There are no (further) constraints on this element

Element id

RequestGroup.action.documentation

Short description

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.

Comments

Each related artifact is either an attachment, or a reference to another knowledge resource, but not both.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.supportingInfo

condition

0..*

There are no (further) constraints on this element

Element id

RequestGroup.action.condition

Short description

Whether or not the action is applicable

Definition

An expression that describes applicability criteria, or start/stop conditions for the action.

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

0..1

There are no (further) constraints on this element

Element id

RequestGroup.action.condition.id

Short description

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.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

RequestGroup.action.condition.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

RequestGroup.action.condition.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

kind

1..1

codeBinding

There are no (further) constraints on this element

Element id

RequestGroup.action.condition.kind

Short description

applicability | start | stop

Definition

The kind of condition.

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.

Data type

ActionConditionKind (required)

Binding

The kind of condition for the action.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

expression

0..1

There are no (further) constraints on this element

Element id

RequestGroup.action.condition.expression

Short description

Boolean-valued expression

Definition

An expression that returns true or false, indicating whether or not the condition is satisfied.

Comments

The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
exp-1: An expression or a reference must be provided
expression.exists() or reference.exists()

Mappings

rim: n/a

relatedAction

0..*

There are no (further) constraints on this element

Element id

RequestGroup.action.relatedAction

Short description

Relationship to another action

Definition

A relationship to another action such as "before" or "30-60 minutes after start of".

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

0..1

There are no (further) constraints on this element

Element id

RequestGroup.action.relatedAction.id

Short description

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.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

RequestGroup.action.relatedAction.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

RequestGroup.action.relatedAction.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

actionId

1..1

There are no (further) constraints on this element

Element id

RequestGroup.action.relatedAction.actionId

Short description

What action this is related to

Definition

The element id of the action this is related to.

Comments

RFC 4122

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

relationship

1..1

codeBinding

There are no (further) constraints on this element

Element id

RequestGroup.action.relatedAction.relationship

Short description

Definition

The relationship of this action to the related action.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

ActionRelationshipType (required)

Binding

Defines the types of relationships between actions.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

offset[x]

0..1

There are no (further) constraints on this element

Element id

RequestGroup.action.relatedAction.offset[x]

Short description

Time offset for the relationship

Definition

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

offsetDuration

There are no (further) constraints on this element

Data type

offsetRange

There are no (further) constraints on this element

Data type

timing[x]

0..1

There are no (further) constraints on this element

Element id

RequestGroup.action.timing[x]

Short description

When the action should take place

Definition

An optional value describing when the action should be performed.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.occurrence[x]

timingAge

There are no (further) constraints on this element

Data type

timingDateTime

There are no (further) constraints on this element

Data type

timingDuration

There are no (further) constraints on this element

Data type

timingPeriod

There are no (further) constraints on this element

Data type

timingRange

There are no (further) constraints on this element

Data type

timingTiming

There are no (further) constraints on this element

Data type

participant

0..*

Reference(Device | Patient | Practitioner | PractitionerRole | RelatedPerson)

Element id

RequestGroup.action.participant

Short description

Who should perform the action

Definition

The participant that should perform or be responsible for this action.

Comments

Data type

Reference(Device | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
nhse-requsetgrp-001: If extension-ParticipantType R5 Backport is used then RequestGroup.action.participant SHALL be empty.
RequestGroup.action.participant.empty() or RequestGroup.action.participant.extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-RequestOrchestration.action.participant.typeReference').empty()

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.performer
w5: FiveWs.actor

0..1

There are no (further) constraints on this element

Element id

RequestGroup.action.participant.id

Short description

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.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

RequestGroup.action.participant.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

participantR5

0..1

Element id

RequestGroup.action.participant.extension:participantR5

Short description

An extension use to record the type of a participant designated to perform an action.

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

Extension URL

ExtensionParticipantType

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

reference

Σ C

0..1

There are no (further) constraints on this element

Element id

RequestGroup.action.participant.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, ref-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

type

0..1

uriBinding

There are no (further) constraints on this element

Element id

RequestGroup.action.participant.type

Short description

Type the reference refers to (e.g. "Patient")

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Data type

Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

identifier

0..1

There are no (further) constraints on this element

Element id

RequestGroup.action.participant.identifier

Short description

Logical reference, when literal reference is not known

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
rim: .identifier

display

0..1

There are no (further) constraints on this element

Element id

RequestGroup.action.participant.display

Short description

Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

RequestGroup.action.type

Short description

create | update | remove | fire-event

Definition

The type of action to perform (create, update, remove).

Comments

Data type

Binding

The type of action to be performed.

ActionType (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD

groupingBehavior

0..1

codeBinding

There are no (further) constraints on this element

Element id

RequestGroup.action.groupingBehavior

Short description

visual-group | logical-group | sentence-group

Definition

Defines the grouping behavior for the action and its children.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

ActionGroupingBehavior (required)

Binding

Defines organization behavior of a group.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

selectionBehavior

0..1

codeBinding

There are no (further) constraints on this element

Element id

RequestGroup.action.selectionBehavior

Short description

Definition

Defines the selection behavior for the action and its children.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

ActionSelectionBehavior (required)

Binding

Defines selection behavior of a group.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

requiredBehavior

0..1

codeBinding

There are no (further) constraints on this element

Element id

RequestGroup.action.requiredBehavior

Short description

must | could | must-unless-documented

Definition

Defines expectations around whether an action is required.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

ActionRequiredBehavior (required)

Binding

Defines expectations around whether an action or action group is required.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

precheckBehavior

0..1

codeBinding

There are no (further) constraints on this element

Element id

RequestGroup.action.precheckBehavior

Short description

yes | no

Definition

Defines whether the action should usually be preselected.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

ActionPrecheckBehavior (required)

Binding

Defines selection frequency behavior for an action or group.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

cardinalityBehavior

0..1

codeBinding

There are no (further) constraints on this element

Element id

RequestGroup.action.cardinalityBehavior

Short description

single | multiple

Definition

Defines whether the action can be selected multiple times.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

ActionCardinalityBehavior (required)

Binding

Defines behavior for an action or a group for how many times that item may be repeated.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

resource

0..1

There are no (further) constraints on this element

Element id

RequestGroup.action.resource

Short description

The target of the action

Definition

The resource that is the target of the action (e.g. CommunicationRequest).

Comments

The target resource SHALL be a Request resource with a Request.intent set to "option".

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, rqg-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

action

0..*

see (action)

There are no (further) constraints on this element

Element id

RequestGroup.action.action

Short description

Sub action

Definition

Sub actions.

Conditions

The cardinality or value of this element may be affected by these constraints: rqg-1

EnglandRequestGroup (RequestGroup)

There are no (further) constraints on this element

Element id

RequestGroup

Short description

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".

Data type

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
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
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()

Mappings

rim: Entity. Role, or Act
workflow: Request

0..1

There are no (further) constraints on this element

Element id

RequestGroup.id

Short description

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.

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

There are no (further) constraints on this element

Element id

RequestGroup.meta

Short description

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

implicitRules

Σ ?!

0..1

There are no (further) constraints on this element

Element id

RequestGroup.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

RequestGroup.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

text

0..1

There are no (further) constraints on this element

Element id

RequestGroup.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: Act.text?

contained

0..*

There are no (further) constraints on this element

Element id

RequestGroup.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

Comments

Data type

Mappings

rim: Entity. Role, or Act
rim: N/A

extension

0..*

There are no (further) constraints on this element

Element id

RequestGroup.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

NHSBSAprescriptionType

0..1

Element id

RequestGroup.extension:NHSBSAprescriptionType

Short description

Setting and HCP type for the prescrption

Alternate names

extensions, user content

Definition

Care Setting and type of prescriber.

Comments

Data type

ExtensionNHSBSAprescriptionType

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

prescriptionPendingCancellation

0..1

Element id

RequestGroup.extension:prescriptionPendingCancellation

Short description

An extension use to record if a prescription or any of its line items is pending cancellation.

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

An extension use to record if a prescription or any of its line items is pending cancellation

Data type

ExtensionPendingCancellation

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

prescriptionStatusHistory

0..*

Extension(Complex)

Element id

RequestGroup.extension:prescriptionStatusHistory

Short description

Dispensing Prescription Status

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

Extension(Complex)

Extension URL

ExtensionDMPrescriptionStatusHistory

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

repeatInformation

0..*

Extension(Complex)

Element id

RequestGroup.extension:repeatInformation

Short description

An extension use to record both the instance and the maximum number of repeat allowed for a prescription.

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

Extension(Complex)

Extension URL

ExtensionEPSRepeatInformation

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

?! C

0..*

There are no (further) constraints on this element

Element id

RequestGroup.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

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

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

identifier

0..*

There are no (further) constraints on this element

Element id

RequestGroup.identifier

Short description

Business identifier

Definition

Allows a service to provide a unique, business identifier for the request.

Requirements

Allows identification of the request as it is known by various participating systems and in a way that remains consistent across servers.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
workflow: Request.identifier
w5: FiveWs.identifier

instantiatesCanonical

0..*

There are no (further) constraints on this element

Element id

RequestGroup.instantiatesCanonical

Short description

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.

Comments

see Canonical References

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.instantiatesCanonical

instantiatesUri

0..*

There are no (further) constraints on this element

Element id

RequestGroup.instantiatesUri

Short description

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.

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.instantiatesUri

basedOn

0..*

There are no (further) constraints on this element

Element id

RequestGroup.basedOn

Short description

Fulfills plan, proposal, or order

Alternate names

fulfills

Definition

A plan, proposal or order that is fulfilled in whole or in part by this request.

Requirements

Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.basedOn

replaces

0..*

There are no (further) constraints on this element

Element id

RequestGroup.replaces

Short description

Request(s) replaced by this request

Alternate names

supersedes, prior, renewed order

Definition

Completed or terminated request(s) whose function is taken by this new request.

Requirements

Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.replaces

groupIdentifier

0..1

There are no (further) constraints on this element

Element id

RequestGroup.groupIdentifier

Short description

Composite request this is part of

Alternate names

grouperid, requisition

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.

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
workflow: Request.groupIdentifier

status

Σ ?!

1..1

codeBinding

There are no (further) constraints on this element

Element id

RequestGroup.status

Short description

Definition

The current state of the request. For request groups, the status reflects the status of all the requests in the group.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Binding

Codes identifying the lifecycle stage of a request.

RequestStatus (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.status
w5: FiveWs.status

intent

Σ ?!

1..1

codeBinding

There are no (further) constraints on this element

Element id

RequestGroup.intent

Short description

Alternate names

category

Definition

Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.

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

Data type

Binding

Codes indicating the degree of authority/intentionality associated with a request.

RequestIntent (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.intent
w5: FiveWs.class

priority

0..1

codeBinding

There are no (further) constraints on this element

Element id

RequestGroup.priority

Short description

routine | urgent | asap | stat

Definition

Indicates how quickly the request should be addressed with respect to other requests.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Meaning when missing

If missing, this request should be performed with normal priority

Data type

Binding

Identifies the level of importance to be assigned to actioning the request.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.priority
w5: FiveWs.grade

code

0..1

There are no (further) constraints on this element

Element id

RequestGroup.code

Short description

What's being requested/ordered

Definition

A code that identifies what the overall request group is.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Request.code
w5: FiveWs.what[x]

subject

0..1

There are no (further) constraints on this element

Element id

RequestGroup.subject

Short description

Who the request group is about

Definition

The subject for which the request group was created.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.subject
w5: FiveWs.subject[x]
w5: FiveWs.subject

encounter

0..1

There are no (further) constraints on this element

Element id

RequestGroup.encounter

Short description

Created as part of

Definition

Describes the context of the request group, if any.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.encounter
w5: FiveWs.context

authoredOn

0..1

There are no (further) constraints on this element

Element id

RequestGroup.authoredOn

Short description

When the request group was authored

Definition

Indicates when the request group was created.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.authoredOn
w5: FiveWs.recorded

author

0..1

Reference(Device | Practitioner | PractitionerRole)

There are no (further) constraints on this element

Element id

RequestGroup.author

Short description

Device or practitioner that authored the request group

Definition

Provides a reference to the author of the request group.

Comments

Data type

Reference(Device | Practitioner | PractitionerRole)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.requester
w5: FiveWs.author

reasonCode

0..*

There are no (further) constraints on this element

Element id

RequestGroup.reasonCode

Short description

Why the request group is needed

Definition

Describes the reason for the request group in coded or textual form.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Request.reasonCode
w5: FiveWs.why[x]

reasonReference

0..*

Reference(Condition | DiagnosticReport | DocumentReference | Observation)

There are no (further) constraints on this element

Element id

RequestGroup.reasonReference

Short description

Why the request group is needed

Definition

Indicates another resource whose existence justifies this request group.

Comments

Data type

Reference(Condition | DiagnosticReport | DocumentReference | Observation)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.reasonReference
w5: FiveWs.why[x]

note

0..*

There are no (further) constraints on this element

Element id

RequestGroup.note

Short description

Additional notes about the response

Definition

Provides a mechanism to communicate additional information about the response.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Act
workflow: Request.note

action

0..*

There are no (further) constraints on this element

Element id

RequestGroup.action

Short description

Proposed actions, if any

Definition

The actions, if any, produced by the evaluation of the artifact.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
rqg-1: Must have resource or action but not both
resource.exists() != action.exists()

Mappings

rim: n/a

0..1

There are no (further) constraints on this element

Element id

RequestGroup.action.id

Short description

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.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

RequestGroup.action.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

RequestGroup.action.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

prefix

0..1

There are no (further) constraints on this element

Element id

RequestGroup.action.prefix

Short description

User-visible prefix for the action (e.g. 1. or A.)

Definition

A user-visible prefix for the action.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

title

0..1

There are no (further) constraints on this element

Element id

RequestGroup.action.title

Short description

User-visible title

Definition

The title of the action displayed to a user.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

description

0..1

There are no (further) constraints on this element

Element id

RequestGroup.action.description

Short description

Short description of the action

Definition

A short description of the action used to provide a summary to display to the user.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

textEquivalent

0..1

There are no (further) constraints on this element

Element id

RequestGroup.action.textEquivalent

Short description

Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system

Definition

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

priority

0..1

codeBinding

There are no (further) constraints on this element

Element id

RequestGroup.action.priority

Short description

routine | urgent | asap | stat

Definition

Indicates how quickly the action should be addressed with respect to other actions.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Binding

Identifies the level of importance to be assigned to actioning the request.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.priority

code

0..*

There are no (further) constraints on this element

Element id

RequestGroup.action.code

Short description

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.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Request.code

documentation

0..*

There are no (further) constraints on this element

Element id

RequestGroup.action.documentation

Short description

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.

Comments

Each related artifact is either an attachment, or a reference to another knowledge resource, but not both.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.supportingInfo

condition

0..*

There are no (further) constraints on this element

Element id

RequestGroup.action.condition

Short description

Whether or not the action is applicable

Definition

An expression that describes applicability criteria, or start/stop conditions for the action.

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

0..1

There are no (further) constraints on this element

Element id

RequestGroup.action.condition.id

Short description

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.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

RequestGroup.action.condition.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

RequestGroup.action.condition.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

kind

1..1

codeBinding

There are no (further) constraints on this element

Element id

RequestGroup.action.condition.kind

Short description

applicability | start | stop

Definition

The kind of condition.

Comments

Data type

ActionConditionKind (required)

Binding

The kind of condition for the action.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

expression

0..1

There are no (further) constraints on this element

Element id

RequestGroup.action.condition.expression

Short description

Boolean-valued expression

Definition

An expression that returns true or false, indicating whether or not the condition is satisfied.

Comments

The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
exp-1: An expression or a reference must be provided
expression.exists() or reference.exists()

Mappings

rim: n/a

relatedAction

0..*

There are no (further) constraints on this element

Element id

RequestGroup.action.relatedAction

Short description

Relationship to another action

Definition

A relationship to another action such as "before" or "30-60 minutes after start of".

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

0..1

There are no (further) constraints on this element

Element id

RequestGroup.action.relatedAction.id

Short description

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.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

RequestGroup.action.relatedAction.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

RequestGroup.action.relatedAction.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

actionId

1..1

There are no (further) constraints on this element

Element id

RequestGroup.action.relatedAction.actionId

Short description

What action this is related to

Definition

The element id of the action this is related to.

Comments

RFC 4122

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

relationship

1..1

codeBinding

There are no (further) constraints on this element

Element id

RequestGroup.action.relatedAction.relationship

Short description

Definition

The relationship of this action to the related action.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

ActionRelationshipType (required)

Binding

Defines the types of relationships between actions.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

offset[x]

0..1

There are no (further) constraints on this element

Element id

RequestGroup.action.relatedAction.offset[x]

Short description

Time offset for the relationship

Definition

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

offsetDuration

There are no (further) constraints on this element

Data type

offsetRange

There are no (further) constraints on this element

Data type

timing[x]

0..1

There are no (further) constraints on this element

Element id

RequestGroup.action.timing[x]

Short description

When the action should take place

Definition

An optional value describing when the action should be performed.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.occurrence[x]

timingAge

There are no (further) constraints on this element

Data type

timingDateTime

There are no (further) constraints on this element

Data type

timingDuration

There are no (further) constraints on this element

Data type

timingPeriod

There are no (further) constraints on this element

Data type

timingRange

There are no (further) constraints on this element

Data type

timingTiming

There are no (further) constraints on this element

Data type

participant

0..*

Reference(Device | Patient | Practitioner | PractitionerRole | RelatedPerson)

Element id

RequestGroup.action.participant

Short description

Who should perform the action

Definition

The participant that should perform or be responsible for this action.

Comments

Data type

Reference(Device | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
nhse-requsetgrp-001: If extension-ParticipantType R5 Backport is used then RequestGroup.action.participant SHALL be empty.
RequestGroup.action.participant.empty() or RequestGroup.action.participant.extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-RequestOrchestration.action.participant.typeReference').empty()

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.performer
w5: FiveWs.actor

0..1

There are no (further) constraints on this element

Element id

RequestGroup.action.participant.id

Short description

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.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

RequestGroup.action.participant.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

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

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

participantR5

0..1

Element id

RequestGroup.action.participant.extension:participantR5

Short description

An extension use to record the type of a participant designated to perform an action.

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

Extension URL

ExtensionParticipantType

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

reference

Σ C

0..1

There are no (further) constraints on this element

Element id

RequestGroup.action.participant.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, ref-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

type

0..1

uriBinding

There are no (further) constraints on this element

Element id

RequestGroup.action.participant.type

Short description

Type the reference refers to (e.g. "Patient")

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

Comments

Data type

Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

identifier

0..1

There are no (further) constraints on this element

Element id

RequestGroup.action.participant.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
rim: .identifier

display

0..1

There are no (further) constraints on this element

Element id

RequestGroup.action.participant.display

Short description

Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

RequestGroup.action.type

Short description

create | update | remove | fire-event

Definition

The type of action to perform (create, update, remove).

Comments

Data type

Binding

The type of action to be performed.

ActionType (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD

groupingBehavior

0..1

codeBinding

There are no (further) constraints on this element

Element id

RequestGroup.action.groupingBehavior

Short description

visual-group | logical-group | sentence-group

Definition

Defines the grouping behavior for the action and its children.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

ActionGroupingBehavior (required)

Binding

Defines organization behavior of a group.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

selectionBehavior

0..1

codeBinding

There are no (further) constraints on this element

Element id

RequestGroup.action.selectionBehavior

Short description

Definition

Defines the selection behavior for the action and its children.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

ActionSelectionBehavior (required)

Binding

Defines selection behavior of a group.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

requiredBehavior

0..1

codeBinding

There are no (further) constraints on this element

Element id

RequestGroup.action.requiredBehavior

Short description

must | could | must-unless-documented

Definition

Defines expectations around whether an action is required.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

ActionRequiredBehavior (required)

Binding

Defines expectations around whether an action or action group is required.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

precheckBehavior

0..1

codeBinding

There are no (further) constraints on this element

Element id

RequestGroup.action.precheckBehavior

Short description

yes | no

Definition

Defines whether the action should usually be preselected.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

ActionPrecheckBehavior (required)

Binding

Defines selection frequency behavior for an action or group.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

cardinalityBehavior

0..1

codeBinding

There are no (further) constraints on this element

Element id

RequestGroup.action.cardinalityBehavior

Short description

single | multiple

Definition

Defines whether the action can be selected multiple times.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

ActionCardinalityBehavior (required)

Binding

Defines behavior for an action or a group for how many times that item may be repeated.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

resource

0..1

There are no (further) constraints on this element

Element id

RequestGroup.action.resource

Short description

The target of the action

Definition

The resource that is the target of the action (e.g. CommunicationRequest).

Comments

The target resource SHALL be a Request resource with a Request.intent set to "option".

Data type