StructureDefinition-UKCore-RequestGroup

Canonical_URLStatusCurrent_VersionLast_UpdatedDescription
https://fhir.hl7.org.uk/StructureDefinition/UKCore-RequestGroupdraft1.0.02024-07-11

This profile defines the UK constraints and extensions on the International FHIR resource RequestGroup.


Profile_Purpose

This profile is a record of a group of medication related requests, with a specific set of conditions on how they must be actioned. It is for use in hospital prescribing, where multiple routes of administration are possible.

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
instantiatesCanonicalΣ0..*canonical()
instantiatesUriΣ0..*uri
basedOnI0..*Reference(Resource)
replacesI0..*Reference(Resource)
groupIdentifierΣ0..1Identifier
statusS Σ ?!1..1codeBinding
intentS Σ ?!1..1codeBinding
priorityΣ0..1codeBinding
codeΣ0..1CodeableConcept
subjectS I0..1Reference(Patient | Group)
encounterI0..1Reference(Encounter)
authoredOn0..1dateTime
authorI0..1Reference(Device | Practitioner | PractitionerRole)
reasonCode0..*CodeableConcept
reasonReferenceI0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)
note0..*Annotation
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
prefix0..1string
title0..1string
descriptionS Σ0..1string
textEquivalentΣ0..1string
priority0..1codeBinding
code0..*CodeableConcept
documentation0..*RelatedArtifact
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
kind1..1codeBinding
expressionI0..1Expression
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
actionId1..1id
relationship1..1codeBinding
offsetDurationDuration
offsetRangeRange
timingDateTimedateTime
timingAgeAge
timingPeriodPeriod
timingDurationDuration
timingRangeRange
timingTimingTiming
participantI0..*Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device)
typeS0..1CodeableConceptBinding
groupingBehavior0..1codeBinding
selectionBehaviorS0..1codeBinding
requiredBehavior0..1codeBinding
precheckBehavior0..1codeBinding
cardinalityBehavior0..1codeBinding
resourceS I0..1Reference(Resource)
actionS I0..*see (action)

Detailed Descriptions

RequestGroup
DefinitionA group of related requests that can be used to capture intended activities that have inter-dependencies such as "give this medication after that one".
Cardinality0...*
Invariants
  • 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
RequestGroup.id
DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality0...1
Typestring
SummaryTrue
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.

RequestGroup.meta
DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Cardinality0...1
TypeMeta
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
RequestGroup.implicitRules
DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Cardinality0...1
Typeuri
ModifierTrue
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
RequestGroup.language
DefinitionThe base language in which the resource is written.
Cardinality0...1
Typecode
Binding

A human language.

CommonLanguages (preferred)
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).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
RequestGroup.text
DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Cardinality0...1
TypeNarrative
Aliasnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Invariants
  • 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?
RequestGroup.contained
DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Cardinality0...*
TypeResource
Aliasinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Mappings
  • rim: Entity. Role, or Act
  • rim: N/A
RequestGroup.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • 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
RequestGroup.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
Aliasextensions, user content
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • 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
RequestGroup.identifier
DefinitionAllows a service to provide a unique, business identifier for the request.
Cardinality0...*
TypeIdentifier
SummaryTrue
Requirements

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

Invariants
  • 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
RequestGroup.instantiatesCanonical
DefinitionA canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
Cardinality0...*
Typecanonical()
SummaryTrue
Comments

see Canonical References

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Request.instantiatesCanonical
RequestGroup.instantiatesUri
DefinitionA URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
Cardinality0...*
Typeuri
SummaryTrue
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Request.instantiatesUri
RequestGroup.basedOn
DefinitionA plan, proposal or order that is fulfilled in whole or in part by this request.
Cardinality0...*
TypeReference(Resource)
Aliasfulfills
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.

Invariants
  • 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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Request.basedOn
RequestGroup.replaces
DefinitionCompleted or terminated request(s) whose function is taken by this new request.
Cardinality0...*
TypeReference(Resource)
Aliassupersedes, prior, renewed order
Requirements

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

Comments

The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing.

Invariants
  • 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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Request.replaces
RequestGroup.groupIdentifier
DefinitionA shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.
Cardinality0...1
TypeIdentifier
SummaryTrue
Aliasgrouperid, requisition
Requirements

Some business processes need to know if multiple items were ordered as part of the same "prescription" or "requisition" for billing or other purposes.

Comments

Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.

Invariants
  • 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
RequestGroup.status
DefinitionThe current state of the request. For request groups, the status reflects the status of all the requests in the group.
Cardinality1...1
Typecode
Binding

Codes identifying the lifecycle stage of a request.

RequestStatus (required)
Must SupportTrue
ModifierTrue
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • 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
RequestGroup.intent
DefinitionIndicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.
Cardinality1...1
Typecode
Binding

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

RequestIntent (required)
Must SupportTrue
ModifierTrue
SummaryTrue
Aliascategory
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

Invariants
  • 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
RequestGroup.priority
DefinitionIndicates how quickly the request should be addressed with respect to other requests.
Cardinality0...1
Typecode
Binding

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

RequestPriority (required)
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • 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
RequestGroup.code
DefinitionA code that identifies what the overall request group is.
Cardinality0...1
TypeCodeableConcept
SummaryTrue
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.

Invariants
  • 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]
RequestGroup.subject
DefinitionThe subject for which the request group was created.
Cardinality0...1
TypeReference(Patient | Group)
Must SupportTrue
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.

Invariants
  • 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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
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
RequestGroup.encounter
DefinitionDescribes the context of the request group, if any.
Cardinality0...1
TypeReference(Encounter)
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Invariants
  • 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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
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
RequestGroup.authoredOn
DefinitionIndicates when the request group was created.
Cardinality0...1
TypedateTime
Invariants
  • 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
RequestGroup.author
DefinitionProvides a reference to the author of the request group.
Cardinality0...1
TypeReference(Device | Practitioner | PractitionerRole)
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Invariants
  • 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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
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
RequestGroup.reasonCode
DefinitionDescribes the reason for the request group in coded or textual form.
Cardinality0...*
TypeCodeableConcept
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.

Invariants
  • 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]
RequestGroup.reasonReference
DefinitionIndicates another resource whose existence justifies this request group.
Cardinality0...*
TypeReference(Condition | Observation | DiagnosticReport | DocumentReference)
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.

Invariants
  • 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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
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]
RequestGroup.note
DefinitionProvides a mechanism to communicate additional information about the response.
Cardinality0...*
TypeAnnotation
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).

Invariants
  • 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
RequestGroup.action
DefinitionThe actions, if any, produced by the evaluation of the artifact.
Cardinality0...*
TypeBackboneElement
Must SupportTrue
Invariants
  • 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
RequestGroup.action.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
RequestGroup.action.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • 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
RequestGroup.action.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • 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
RequestGroup.action.prefix
DefinitionA user-visible prefix for the action.
Cardinality0...1
Typestring
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
RequestGroup.action.title
DefinitionThe title of the action displayed to a user.
Cardinality0...1
Typestring
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
RequestGroup.action.description
DefinitionA short description of the action used to provide a summary to display to the user.
Cardinality0...1
Typestring
Must SupportTrue
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
RequestGroup.action.textEquivalent
DefinitionA text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.
Cardinality0...1
Typestring
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
RequestGroup.action.priority
DefinitionIndicates how quickly the action should be addressed with respect to other actions.
Cardinality0...1
Typecode
Binding

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

RequestPriority (required)
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Request.priority
RequestGroup.action.code
DefinitionA code that provides meaning for the action or action group. For example, a section may have a LOINC code for a section of a documentation template.
Cardinality0...*
TypeCodeableConcept
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.

Invariants
  • 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
RequestGroup.action.documentation
DefinitionDidactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.
Cardinality0...*
TypeRelatedArtifact
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Request.supportingInfo
RequestGroup.action.condition
DefinitionAn expression that describes applicability criteria, or start/stop conditions for the action.
Cardinality0...*
TypeBackboneElement
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
RequestGroup.action.condition.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
RequestGroup.action.condition.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • 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
RequestGroup.action.condition.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • 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
RequestGroup.action.condition.kind
DefinitionThe kind of condition.
Cardinality1...1
Typecode
Binding

The kind of condition for the action.

ActionConditionKind (required)
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
RequestGroup.action.condition.expression
DefinitionAn expression that returns true or false, indicating whether or not the condition is satisfied.
Cardinality0...1
TypeExpression
Comments

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

Invariants
  • 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
RequestGroup.action.relatedAction
DefinitionA relationship to another action such as "before" or "30-60 minutes after start of".
Cardinality0...*
TypeBackboneElement
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
RequestGroup.action.relatedAction.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
RequestGroup.action.relatedAction.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • 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
RequestGroup.action.relatedAction.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • 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
RequestGroup.action.relatedAction.actionId
DefinitionThe element id of the action this is related to.
Cardinality1...1
Typeid
Comments

RFC 4122

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
RequestGroup.action.relatedAction.relationship
DefinitionThe relationship of this action to the related action.
Cardinality1...1
Typecode
Binding

Defines the types of relationships between actions.

ActionRelationshipType (required)
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
RequestGroup.action.relatedAction.offset[x]
DefinitionA duration or range of durations to apply to the relationship. For example, 30-60 minutes before.
Cardinality0...1
TypeDuration
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
RequestGroup.action.timing[x]
DefinitionAn optional value describing when the action should be performed.
Cardinality0...1
TypedateTime
Invariants
  • 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]
RequestGroup.action.participant
DefinitionThe participant that should perform or be responsible for this action.
Cardinality0...*
TypeReference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device)
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.

Invariants
  • 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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
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
RequestGroup.action.type
DefinitionThe type of action to perform (create, update, remove).
Cardinality0...1
TypeCodeableConcept
Binding

The type of action to be performed.

ActionType (extensible)
Must SupportTrue
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.

Invariants
  • 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
RequestGroup.action.groupingBehavior
DefinitionDefines the grouping behavior for the action and its children.
Cardinality0...1
Typecode
Binding

Defines organization behavior of a group.

ActionGroupingBehavior (required)
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
RequestGroup.action.selectionBehavior
DefinitionDefines the selection behavior for the action and its children.
Cardinality0...1
Typecode
Binding

Defines selection behavior of a group.

ActionSelectionBehavior (required)
Must SupportTrue
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
RequestGroup.action.requiredBehavior
DefinitionDefines expectations around whether an action is required.
Cardinality0...1
Typecode
Binding

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

ActionRequiredBehavior (required)
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
RequestGroup.action.precheckBehavior
DefinitionDefines whether the action should usually be preselected.
Cardinality0...1
Typecode
Binding

Defines selection frequency behavior for an action or group.

ActionPrecheckBehavior (required)
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
RequestGroup.action.cardinalityBehavior
DefinitionDefines whether the action can be selected multiple times.
Cardinality0...1
Typecode
Binding

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

ActionCardinalityBehavior (required)
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
RequestGroup.action.resource
DefinitionThe resource that is the target of the action (e.g. CommunicationRequest).
Cardinality0...1
TypeReference(Resource)
Must SupportTrue
Comments

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

Invariants
  • 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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
RequestGroup.action.action
DefinitionSub actions.
Cardinality0...*
Typesee (action)
Must SupportTrue

Table View

RequestGroup..
RequestGroup.status..
RequestGroup.intent..
RequestGroup.subject..
RequestGroup.action..
RequestGroup.action.description..
RequestGroup.action.type..
RequestGroup.action.selectionBehavior..
RequestGroup.action.resource..
RequestGroup.action.action..

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-RequestGroup" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-RequestGroup" />
    <version value="1.0.0" />
    <name value="UKCoreRequestGroup" />
    <title value="UK Core Request Group" />
    <status value="draft" />
    <date value="2024-07-11" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="ukcore@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="This profile defines the UK constraints and extensions on the International FHIR resource [RequestGroup](https://hl7.org/fhir/R4/RequestGroup.html)." />
    <purpose value="This profile is a record of a group of medication related requests, with a specific set of conditions on how they must be actioned. It is for use in hospital prescribing, where multiple routes of administration are possible." />
    <copyright value="Copyright &#169; 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the &quot;License&quot;); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7&#174; FHIR&#174; standard Copyright &#169; 2011+ HL7 The HL7&#174; FHIR&#174; standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html." />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="RequestGroup" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/RequestGroup" />
    <derivation value="constraint" />
    <differential>
        <element id="RequestGroup.status">
            <path value="RequestGroup.status" />
            <mustSupport value="true" />
        </element>
        <element id="RequestGroup.intent">
            <path value="RequestGroup.intent" />
            <mustSupport value="true" />
        </element>
        <element id="RequestGroup.subject">
            <path value="RequestGroup.subject" />
            <mustSupport value="true" />
        </element>
        <element id="RequestGroup.action">
            <path value="RequestGroup.action" />
            <mustSupport value="true" />
        </element>
        <element id="RequestGroup.action.description">
            <path value="RequestGroup.action.description" />
            <mustSupport value="true" />
        </element>
        <element id="RequestGroup.action.type">
            <path value="RequestGroup.action.type" />
            <mustSupport value="true" />
        </element>
        <element id="RequestGroup.action.selectionBehavior">
            <path value="RequestGroup.action.selectionBehavior" />
            <mustSupport value="true" />
        </element>
        <element id="RequestGroup.action.resource">
            <path value="RequestGroup.action.resource" />
            <mustSupport value="true" />
        </element>
        <element id="RequestGroup.action.action">
            <path value="RequestGroup.action.action" />
            <mustSupport value="true" />
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "UKCore-RequestGroup",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-RequestGroup",
    "version": "1.0.0",
    "name": "UKCoreRequestGroup",
    "title": "UK Core Request Group",
    "status": "draft",
    "date": "2024-07-11",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "This profile defines the UK constraints and extensions on the International FHIR resource [RequestGroup](https://hl7.org/fhir/R4/RequestGroup.html).",
    "purpose": "This profile is a record of a group of medication related requests, with a specific set of conditions on how they must be actioned. It is for use in hospital prescribing, where multiple routes of administration are possible.",
    "copyright": "Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html.",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "RequestGroup",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/RequestGroup",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "RequestGroup.status",
                "path": "RequestGroup.status",
                "mustSupport": true
            },
            {
                "id": "RequestGroup.intent",
                "path": "RequestGroup.intent",
                "mustSupport": true
            },
            {
                "id": "RequestGroup.subject",
                "path": "RequestGroup.subject",
                "mustSupport": true
            },
            {
                "id": "RequestGroup.action",
                "path": "RequestGroup.action",
                "mustSupport": true
            },
            {
                "id": "RequestGroup.action.description",
                "path": "RequestGroup.action.description",
                "mustSupport": true
            },
            {
                "id": "RequestGroup.action.type",
                "path": "RequestGroup.action.type",
                "mustSupport": true
            },
            {
                "id": "RequestGroup.action.selectionBehavior",
                "path": "RequestGroup.action.selectionBehavior",
                "mustSupport": true
            },
            {
                "id": "RequestGroup.action.resource",
                "path": "RequestGroup.action.resource",
                "mustSupport": true
            },
            {
                "id": "RequestGroup.action.action",
                "path": "RequestGroup.action.action",
                "mustSupport": true
            }
        ]
    }
}

Usage

This Profile has the following derived profiles:


This Profile is referenced in the following Extensions:


This Profile is referenced in the following Profiles:

Feedback

Click here to:

Report issue for UKCore-RequestGroup, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,

Examples

Ciprofloxacin - Example to illustrate the options for Ciprofloxacin when prescribing multiple routes.
Example UKCore-RequestGroup-Ciprofloxacin

Multiple Antibiotics - Example to illustrate the options for multiple antibiotics when prescribing multiple routes.
Example UKCore-RequestGroup-MultipleAnitibiotics

Paracetamol - Example to illustrate the options for Paracetamol when prescribing multiple routes.
Example UKCore-RequestGroup-Paracetamol

Example Usage Scenarios

The following are example usage scenarios for the UK Core RequestGroup profile:

An example of the same drug, different route

This example shows how a request for the same drug through two different routes can be structured, with the decision to the more appropriate route being taken before a dispense is made.

RequestGroup-Paracetamol

An example of different drugs, with a preference to one of them

This example shows how a request can be achieved giving the option for multiple different drugs, with one being preferred option and up to one being allowed to be dispensed.

RequestGroup-MultipleAntibiotics

An example of same drug different doses, where both are dispensed but only one administered

This example shows a request of the same drug each with a different dose and route. This request allows both to be dispensed, with one being administered now and the other that may be dispensed at a later date or disposed.

RequestGroup-Ciprofloxacin

Profile Specific Implementation Guidance:

Minimum Viable Content

A minimum viable content that all provider and consumer systems SHALL support are the following elements.

Element Reason
status The current state of the request. For request groups, the status reflects the status of all the requests in the group.
intent Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.
subject The subject for which the request group was created.
action.description A short description of the action used to provide a summary to display to the user.
action.type The type of action to perform (create, update, remove).
action.selectionBehavior Defines the selection behavior for the action and its children.
action.resource The resource that is the target of the action (e.g. CommunicationRequest).
action.action Sub actions.

intent

For any medication requests RequestGroup.intent SHALL have the value order. Each MedicationRequest referenced within the RequestGroup MedicationRequest.intent SHALL have the value option.

priority

When RequestGroup is used for medication requests the recommendation is that RequestGroup.priority is not to be used within an implementation - or used with caution.

The stating of a priority, in any business context including healthcare, is often de-valued as given the choice, every clinician wants medication urgently for their patients.

If RequestGroup.priority is used, consider only initially supporting the routine and urgent request priorities, and set clear criteria for when a MedicationRequest and RequestGroup should be marked and handled as urgent.

Usage of the value "stat"

The stat request priority is potentially confusing as it has two meanings:

  1. to indicate a "here and now" order going to pharmacy
  2. used within a MedicationRequest.dosageInstruction can also mean "give once immediately".

Avoid using stat and asap where possible.

subject

The resource being referenced SHALL conform to one of the following:

author

The resource being referenced SHALL conform to one of the following:

reasonReference

The resource being referenced SHALL conform to one of the following:

action

With the base FHIR constraint rule "Must have resource or action but not both" it is expected that:

  • RequestGroup.action has multiple action elements, each defining an individual MedicationRequest.
  • Within each of the Medication.action.action the resource element SHOULD reference the associated MedicationRequest.

action.participant

The resource being referenced SHALL conform to one of the following: