England-RequestGroup
Conformance url | FHIR Module | Maturity Level |
---|---|---|
https://fhir.nhs.uk/StructureDefinition/England-RequestGroup | Administration | trial-use |
The RequestGroup resource is used to represent a group of optional activities that may be performed for a specific patient or context. EPS use case is using this resource to represent a medication prescription.
This profile should be used for Clinical Prescription Tracker only.
EnglandRequestGroup (RequestGroup) | I | RequestGroup | There are no (further) constraints on this element Element idRequestGroup A group of related requests DefinitionA group of related requests that can be used to capture intended activities that have inter-dependencies such as "give this medication after that one".
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idRequestGroup.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idRequestGroup.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idRequestGroup.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idRequestGroup.language Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idRequestGroup.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idRequestGroup.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |
extension | I | 0..* | Extension | Element idRequestGroup.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
|
prescriptionStatusHistory | I | 0..* | Extension(Complex) | Element idRequestGroup.extension:prescriptionStatusHistory Dispensing Prescription Status Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. Extension(Complex) Extension URLhttps://fhir.nhs.uk/StructureDefinition/Extension-DM-PrescriptionStatusHistory Constraints
|
repeatInformation | I | 0..* | Extension(Complex) | Element idRequestGroup.extension:repeatInformation An extension use to record both the instance and the maximum number of repeat allowed for a prescription. Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. Extension(Complex) Extension URLhttps://fhir.nhs.uk/StructureDefinition/Extension-EPS-RepeatInformation Constraints
|
NHSBSAprescriptionType | I | 0..1 | Extension(Coding) | Element idRequestGroup.extension:NHSBSAprescriptionType Setting and HCP type for the prescrption Alternate namesextensions, user content DefinitionCare Setting and type of prescriber. 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. https://fhir.nhs.uk/StructureDefinition/Extension-DM-PrescriptionType Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idRequestGroup.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idRequestGroup.identifier Business identifier DefinitionAllows a service to provide a unique, business identifier for the request. Allows identification of the request as it is known by various participating systems and in a way that remains consistent across servers.
|
instantiatesCanonical | Σ | 0..* | canonical() | There are no (further) constraints on this element Element idRequestGroup.instantiatesCanonical Instantiates FHIR protocol or definition DefinitionA canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
|
instantiatesUri | Σ | 0..* | uri | There are no (further) constraints on this element Element idRequestGroup.instantiatesUri Instantiates external protocol or definition DefinitionA URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
|
basedOn | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idRequestGroup.basedOn Fulfills plan, proposal, or order Alternate namesfulfills DefinitionA plan, proposal or order that is fulfilled in whole or in part by this request. Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon.
| |
replaces | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idRequestGroup.replaces Request(s) replaced by this request Alternate namessupersedes, prior, renewed order DefinitionCompleted or terminated request(s) whose function is taken by this new request. Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests. The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing.
| |
groupIdentifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idRequestGroup.groupIdentifier Composite request this is part of Alternate namesgrouperid, requisition DefinitionA shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form. Some business processes need to know if multiple items were ordered as part of the same "prescription" or "requisition" for billing or other purposes. Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.
|
status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idRequestGroup.status draft | active | on-hold | revoked | completed | entered-in-error | unknown DefinitionThe current state of the request. For request groups, the status reflects the status of all the requests in the group. Codes identifying the lifecycle stage of a request.
|
intent | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idRequestGroup.intent proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Alternate namescategory DefinitionIndicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain. Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain. Codes indicating the degree of authority/intentionality associated with a request.
|
priority | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idRequestGroup.priority routine | urgent | asap | stat DefinitionIndicates how quickly the request should be addressed with respect to other requests. If missing, this request should be performed with normal priority Identifies the level of importance to be assigned to actioning the request.
|
code | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idRequestGroup.code What's being requested/ordered DefinitionA code that identifies what the overall request group is. This element can be used to provide a code that captures the meaning of the request group as a whole, as opposed to the code of the action element, which captures the meaning of the individual actions within the request group.
|
subject | 0..1 | Reference(Patient | Group) | There are no (further) constraints on this element Element idRequestGroup.subject Who the request group is about DefinitionThe subject for which the request group was created.
| |
encounter | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element idRequestGroup.encounter Created as part of DefinitionDescribes the context of the request group, if any.
| |
authoredOn | 0..1 | dateTime | There are no (further) constraints on this element Element idRequestGroup.authoredOn When the request group was authored DefinitionIndicates when the request group was created.
| |
author | 0..1 | Reference(Device | Practitioner | PractitionerRole) | There are no (further) constraints on this element Element idRequestGroup.author Device or practitioner that authored the request group DefinitionProvides a reference to the author of the request group. Reference(Device | Practitioner | PractitionerRole) Constraints
| |
reasonCode | 0..* | CodeableConcept | There are no (further) constraints on this element Element idRequestGroup.reasonCode Why the request group is needed DefinitionDescribes the reason for the request group in coded or textual form.
| |
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | There are no (further) constraints on this element Element idRequestGroup.reasonReference Why the request group is needed DefinitionIndicates another resource whose existence justifies this request group. Reference(Condition | Observation | DiagnosticReport | DocumentReference) Constraints
| |
note | 0..* | Annotation | There are no (further) constraints on this element Element idRequestGroup.note Additional notes about the response DefinitionProvides a mechanism to communicate additional information about the response.
| |
action | I | 0..* | BackboneElement | There are no (further) constraints on this element Element idRequestGroup.action Proposed actions, if any DefinitionThe actions, if any, produced by the evaluation of the artifact.
|
id | 0..1 | string | There are no (further) constraints on this element Element idRequestGroup.action.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idRequestGroup.action.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idRequestGroup.action.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
prefix | 0..1 | string | There are no (further) constraints on this element Element idRequestGroup.action.prefix User-visible prefix for the action (e.g. 1. or A.) DefinitionA user-visible prefix for the action.
| |
title | 0..1 | string | There are no (further) constraints on this element Element idRequestGroup.action.title User-visible title DefinitionThe title of the action displayed to a user.
| |
description | Σ | 0..1 | string | There are no (further) constraints on this element Element idRequestGroup.action.description Short description of the action DefinitionA short description of the action used to provide a summary to display to the user.
|
textEquivalent | Σ | 0..1 | string | There are no (further) constraints on this element Element idRequestGroup.action.textEquivalent Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system DefinitionA text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.
|
priority | 0..1 | codeBinding | There are no (further) constraints on this element Element idRequestGroup.action.priority routine | urgent | asap | stat DefinitionIndicates how quickly the action should be addressed with respect to other actions. Identifies the level of importance to be assigned to actioning the request.
| |
code | 0..* | CodeableConcept | There are no (further) constraints on this element Element idRequestGroup.action.code Code representing the meaning of the action or sub-actions DefinitionA code that provides meaning for the action or action group. For example, a section may have a LOINC code for a section of a documentation template.
| |
documentation | 0..* | RelatedArtifact | There are no (further) constraints on this element Element idRequestGroup.action.documentation Supporting documentation for the intended performer of the action DefinitionDidactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.
| |
condition | 0..* | BackboneElement | There are no (further) constraints on this element Element idRequestGroup.action.condition Whether or not the action is applicable DefinitionAn expression that describes applicability criteria, or start/stop conditions for the action. When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all of the conditions are true.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idRequestGroup.action.condition.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idRequestGroup.action.condition.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idRequestGroup.action.condition.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
kind | 1..1 | codeBinding | There are no (further) constraints on this element Element idRequestGroup.action.condition.kind applicability | start | stop DefinitionThe kind of condition. Applicability criteria are used to determine immediate applicability when a plan definition is applied to a given context. Start and stop criteria are carried through application and used to describe enter/exit criteria for an action. The kind of condition for the action.
| |
expression | 0..1 | Expression | There are no (further) constraints on this element Element idRequestGroup.action.condition.expression Boolean-valued expression DefinitionAn expression that returns true or false, indicating whether or not the condition is satisfied. The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.
| |
relatedAction | 0..* | BackboneElement | There are no (further) constraints on this element Element idRequestGroup.action.relatedAction Relationship to another action DefinitionA relationship to another action such as "before" or "30-60 minutes after start of".
| |
id | 0..1 | string | There are no (further) constraints on this element Element idRequestGroup.action.relatedAction.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idRequestGroup.action.relatedAction.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idRequestGroup.action.relatedAction.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
actionId | 1..1 | id | There are no (further) constraints on this element Element idRequestGroup.action.relatedAction.actionId What action this is related to DefinitionThe element id of the action this is related to.
| |
relationship | 1..1 | codeBinding | There are no (further) constraints on this element Element idRequestGroup.action.relatedAction.relationship before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end DefinitionThe relationship of this action to the related action. Defines the types of relationships between actions.
| |
offset[x] | 0..1 | There are no (further) constraints on this element Element idRequestGroup.action.relatedAction.offset[x] Time offset for the relationship DefinitionA duration or range of durations to apply to the relationship. For example, 30-60 minutes before.
| ||
offsetDuration | Duration | There are no (further) constraints on this element Data type | ||
offsetRange | Range | There are no (further) constraints on this element Data type | ||
timing[x] | 0..1 | There are no (further) constraints on this element Element idRequestGroup.action.timing[x] When the action should take place DefinitionAn optional value describing when the action should be performed.
| ||
timingDateTime | dateTime | There are no (further) constraints on this element Data type | ||
timingAge | Age | There are no (further) constraints on this element Data type | ||
timingPeriod | Period | There are no (further) constraints on this element Data type | ||
timingDuration | Duration | There are no (further) constraints on this element Data type | ||
timingRange | Range | There are no (further) constraints on this element Data type | ||
timingTiming | Timing | There are no (further) constraints on this element Data type | ||
participant | I | 0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device) | Element idRequestGroup.action.participant Who should perform the action DefinitionThe participant that should perform or be responsible for this action. Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device) Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idRequestGroup.action.participant.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idRequestGroup.action.participant.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
participantR5 | I | 0..1 | Extension(Reference()) | Element idRequestGroup.action.participant.extension:participantR5 An extension use to record the type of a participant designated to perform an action. Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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.
|
reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element idRequestGroup.action.participant.reference Literal reference, Relative, internal or absolute URL DefinitionA 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. 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.
|
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idRequestGroup.action.participant.type Type the reference refers to (e.g. "Patient") DefinitionThe 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). 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. Aa resource (or, for logical models, the URI of the logical model).
|
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idRequestGroup.action.participant.identifier Logical reference, when literal reference is not known DefinitionAn 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. 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).
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idRequestGroup.action.participant.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. 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.
|
type | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idRequestGroup.action.type create | update | remove | fire-event DefinitionThe type of action to perform (create, update, remove). The type of action to be performed.
| |
groupingBehavior | 0..1 | codeBinding | There are no (further) constraints on this element Element idRequestGroup.action.groupingBehavior visual-group | logical-group | sentence-group DefinitionDefines the grouping behavior for the action and its children. Defines organization behavior of a group.
| |
selectionBehavior | 0..1 | codeBinding | There are no (further) constraints on this element Element idRequestGroup.action.selectionBehavior any | all | all-or-none | exactly-one | at-most-one | one-or-more DefinitionDefines the selection behavior for the action and its children. Defines selection behavior of a group.
| |
requiredBehavior | 0..1 | codeBinding | There are no (further) constraints on this element Element idRequestGroup.action.requiredBehavior must | could | must-unless-documented DefinitionDefines expectations around whether an action is required. Defines expectations around whether an action or action group is required.
| |
precheckBehavior | 0..1 | codeBinding | There are no (further) constraints on this element Element idRequestGroup.action.precheckBehavior yes | no DefinitionDefines whether the action should usually be preselected. Defines selection frequency behavior for an action or group.
| |
cardinalityBehavior | 0..1 | codeBinding | There are no (further) constraints on this element Element idRequestGroup.action.cardinalityBehavior single | multiple DefinitionDefines whether the action can be selected multiple times. Defines behavior for an action or a group for how many times that item may be repeated.
| |
resource | I | 0..1 | Reference(Resource) | There are no (further) constraints on this element Element idRequestGroup.action.resource The target of the action DefinitionThe resource that is the target of the action (e.g. CommunicationRequest). The target resource SHALL be a Request resource with a Request.intent set to "option".
|
action | I | 0..* | see (action) | There are no (further) constraints on this element Element idRequestGroup.action.action Sub action DefinitionSub actions.
|
EnglandRequestGroup (RequestGroup) | I | RequestGroup | There are no (further) constraints on this element Element idRequestGroup A group of related requests DefinitionA group of related requests that can be used to capture intended activities that have inter-dependencies such as "give this medication after that one".
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idRequestGroup.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idRequestGroup.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idRequestGroup.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idRequestGroup.language Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idRequestGroup.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idRequestGroup.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |
extension | I | 0..* | Extension | Element idRequestGroup.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
|
prescriptionStatusHistory | I | 0..* | Extension(Complex) | Element idRequestGroup.extension:prescriptionStatusHistory Dispensing Prescription Status Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. Extension(Complex) Extension URLhttps://fhir.nhs.uk/StructureDefinition/Extension-DM-PrescriptionStatusHistory Constraints
|
repeatInformation | I | 0..* | Extension(Complex) | Element idRequestGroup.extension:repeatInformation An extension use to record both the instance and the maximum number of repeat allowed for a prescription. Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. Extension(Complex) Extension URLhttps://fhir.nhs.uk/StructureDefinition/Extension-EPS-RepeatInformation Constraints
|
NHSBSAprescriptionType | I | 0..1 | Extension(Coding) | Element idRequestGroup.extension:NHSBSAprescriptionType Setting and HCP type for the prescrption Alternate namesextensions, user content DefinitionCare Setting and type of prescriber. 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. https://fhir.nhs.uk/StructureDefinition/Extension-DM-PrescriptionType Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idRequestGroup.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idRequestGroup.identifier Business identifier DefinitionAllows a service to provide a unique, business identifier for the request. Allows identification of the request as it is known by various participating systems and in a way that remains consistent across servers.
|
instantiatesCanonical | Σ | 0..* | canonical() | There are no (further) constraints on this element Element idRequestGroup.instantiatesCanonical Instantiates FHIR protocol or definition DefinitionA canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
|
instantiatesUri | Σ | 0..* | uri | There are no (further) constraints on this element Element idRequestGroup.instantiatesUri Instantiates external protocol or definition DefinitionA URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
|
basedOn | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idRequestGroup.basedOn Fulfills plan, proposal, or order Alternate namesfulfills DefinitionA plan, proposal or order that is fulfilled in whole or in part by this request. Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon.
| |
replaces | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idRequestGroup.replaces Request(s) replaced by this request Alternate namessupersedes, prior, renewed order DefinitionCompleted or terminated request(s) whose function is taken by this new request. Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests. The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing.
| |
groupIdentifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idRequestGroup.groupIdentifier Composite request this is part of Alternate namesgrouperid, requisition DefinitionA shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form. Some business processes need to know if multiple items were ordered as part of the same "prescription" or "requisition" for billing or other purposes. Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.
|
status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idRequestGroup.status draft | active | on-hold | revoked | completed | entered-in-error | unknown DefinitionThe current state of the request. For request groups, the status reflects the status of all the requests in the group. Codes identifying the lifecycle stage of a request.
|
intent | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idRequestGroup.intent proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Alternate namescategory DefinitionIndicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain. Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain. Codes indicating the degree of authority/intentionality associated with a request.
|
priority | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idRequestGroup.priority routine | urgent | asap | stat DefinitionIndicates how quickly the request should be addressed with respect to other requests. If missing, this request should be performed with normal priority Identifies the level of importance to be assigned to actioning the request.
|
code | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idRequestGroup.code What's being requested/ordered DefinitionA code that identifies what the overall request group is. This element can be used to provide a code that captures the meaning of the request group as a whole, as opposed to the code of the action element, which captures the meaning of the individual actions within the request group.
|
subject | 0..1 | Reference(Patient | Group) | There are no (further) constraints on this element Element idRequestGroup.subject Who the request group is about DefinitionThe subject for which the request group was created.
| |
encounter | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element idRequestGroup.encounter Created as part of DefinitionDescribes the context of the request group, if any.
| |
authoredOn | 0..1 | dateTime | There are no (further) constraints on this element Element idRequestGroup.authoredOn When the request group was authored DefinitionIndicates when the request group was created.
| |
author | 0..1 | Reference(Device | Practitioner | PractitionerRole) | There are no (further) constraints on this element Element idRequestGroup.author Device or practitioner that authored the request group DefinitionProvides a reference to the author of the request group. Reference(Device | Practitioner | PractitionerRole) Constraints
| |
reasonCode | 0..* | CodeableConcept | There are no (further) constraints on this element Element idRequestGroup.reasonCode Why the request group is needed DefinitionDescribes the reason for the request group in coded or textual form.
| |
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | There are no (further) constraints on this element Element idRequestGroup.reasonReference Why the request group is needed DefinitionIndicates another resource whose existence justifies this request group. Reference(Condition | Observation | DiagnosticReport | DocumentReference) Constraints
| |
note | 0..* | Annotation | There are no (further) constraints on this element Element idRequestGroup.note Additional notes about the response DefinitionProvides a mechanism to communicate additional information about the response.
| |
action | I | 0..* | BackboneElement | There are no (further) constraints on this element Element idRequestGroup.action Proposed actions, if any DefinitionThe actions, if any, produced by the evaluation of the artifact.
|
id | 0..1 | string | There are no (further) constraints on this element Element idRequestGroup.action.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idRequestGroup.action.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idRequestGroup.action.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
prefix | 0..1 | string | There are no (further) constraints on this element Element idRequestGroup.action.prefix User-visible prefix for the action (e.g. 1. or A.) DefinitionA user-visible prefix for the action.
| |
title | 0..1 | string | There are no (further) constraints on this element Element idRequestGroup.action.title User-visible title DefinitionThe title of the action displayed to a user.
| |
description | Σ | 0..1 | string | There are no (further) constraints on this element Element idRequestGroup.action.description Short description of the action DefinitionA short description of the action used to provide a summary to display to the user.
|
textEquivalent | Σ | 0..1 | string | There are no (further) constraints on this element Element idRequestGroup.action.textEquivalent Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system DefinitionA text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.
|
priority | 0..1 | codeBinding | There are no (further) constraints on this element Element idRequestGroup.action.priority routine | urgent | asap | stat DefinitionIndicates how quickly the action should be addressed with respect to other actions. Identifies the level of importance to be assigned to actioning the request.
| |
code | 0..* | CodeableConcept | There are no (further) constraints on this element Element idRequestGroup.action.code Code representing the meaning of the action or sub-actions DefinitionA code that provides meaning for the action or action group. For example, a section may have a LOINC code for a section of a documentation template.
| |
documentation | 0..* | RelatedArtifact | There are no (further) constraints on this element Element idRequestGroup.action.documentation Supporting documentation for the intended performer of the action DefinitionDidactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.
| |
condition | 0..* | BackboneElement | There are no (further) constraints on this element Element idRequestGroup.action.condition Whether or not the action is applicable DefinitionAn expression that describes applicability criteria, or start/stop conditions for the action. When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all of the conditions are true.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idRequestGroup.action.condition.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idRequestGroup.action.condition.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idRequestGroup.action.condition.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
kind | 1..1 | codeBinding | There are no (further) constraints on this element Element idRequestGroup.action.condition.kind applicability | start | stop DefinitionThe kind of condition. Applicability criteria are used to determine immediate applicability when a plan definition is applied to a given context. Start and stop criteria are carried through application and used to describe enter/exit criteria for an action. The kind of condition for the action.
| |
expression | 0..1 | Expression | There are no (further) constraints on this element Element idRequestGroup.action.condition.expression Boolean-valued expression DefinitionAn expression that returns true or false, indicating whether or not the condition is satisfied. The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.
| |
relatedAction | 0..* | BackboneElement | There are no (further) constraints on this element Element idRequestGroup.action.relatedAction Relationship to another action DefinitionA relationship to another action such as "before" or "30-60 minutes after start of".
| |
id | 0..1 | string | There are no (further) constraints on this element Element idRequestGroup.action.relatedAction.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idRequestGroup.action.relatedAction.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idRequestGroup.action.relatedAction.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
actionId | 1..1 | id | There are no (further) constraints on this element Element idRequestGroup.action.relatedAction.actionId What action this is related to DefinitionThe element id of the action this is related to.
| |
relationship | 1..1 | codeBinding | There are no (further) constraints on this element Element idRequestGroup.action.relatedAction.relationship before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end DefinitionThe relationship of this action to the related action. Defines the types of relationships between actions.
| |
offset[x] | 0..1 | There are no (further) constraints on this element Element idRequestGroup.action.relatedAction.offset[x] Time offset for the relationship DefinitionA duration or range of durations to apply to the relationship. For example, 30-60 minutes before.
| ||
offsetDuration | Duration | There are no (further) constraints on this element Data type | ||
offsetRange | Range | There are no (further) constraints on this element Data type | ||
timing[x] | 0..1 | There are no (further) constraints on this element Element idRequestGroup.action.timing[x] When the action should take place DefinitionAn optional value describing when the action should be performed.
| ||
timingDateTime | dateTime | There are no (further) constraints on this element Data type | ||
timingAge | Age | There are no (further) constraints on this element Data type | ||
timingPeriod | Period | There are no (further) constraints on this element Data type | ||
timingDuration | Duration | There are no (further) constraints on this element Data type | ||
timingRange | Range | There are no (further) constraints on this element Data type | ||
timingTiming | Timing | There are no (further) constraints on this element Data type | ||
participant | I | 0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device) | Element idRequestGroup.action.participant Who should perform the action DefinitionThe participant that should perform or be responsible for this action. Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device) Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idRequestGroup.action.participant.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idRequestGroup.action.participant.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
participantR5 | I | 0..1 | Extension(Reference()) | Element idRequestGroup.action.participant.extension:participantR5 An extension use to record the type of a participant designated to perform an action. Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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.
|
reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element idRequestGroup.action.participant.reference Literal reference, Relative, internal or absolute URL DefinitionA 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. 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.
|
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idRequestGroup.action.participant.type Type the reference refers to (e.g. "Patient") DefinitionThe 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). 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. Aa resource (or, for logical models, the URI of the logical model).
|
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idRequestGroup.action.participant.identifier Logical reference, when literal reference is not known DefinitionAn 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. 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).
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idRequestGroup.action.participant.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. 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.
|
type | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idRequestGroup.action.type create | update | remove | fire-event DefinitionThe type of action to perform (create, update, remove). The type of action to be performed.
| |
groupingBehavior | 0..1 | codeBinding | There are no (further) constraints on this element Element idRequestGroup.action.groupingBehavior visual-group | logical-group | sentence-group DefinitionDefines the grouping behavior for the action and its children. Defines organization behavior of a group.
| |
selectionBehavior | 0..1 | codeBinding | There are no (further) constraints on this element Element idRequestGroup.action.selectionBehavior any | all | all-or-none | exactly-one | at-most-one | one-or-more DefinitionDefines the selection behavior for the action and its children. Defines selection behavior of a group.
| |
requiredBehavior | 0..1 | codeBinding | There are no (further) constraints on this element Element idRequestGroup.action.requiredBehavior must | could | must-unless-documented DefinitionDefines expectations around whether an action is required. Defines expectations around whether an action or action group is required.
| |
precheckBehavior | 0..1 | codeBinding | There are no (further) constraints on this element Element idRequestGroup.action.precheckBehavior yes | no DefinitionDefines whether the action should usually be preselected. Defines selection frequency behavior for an action or group.
| |
cardinalityBehavior | 0..1 | codeBinding | There are no (further) constraints on this element Element idRequestGroup.action.cardinalityBehavior single | multiple DefinitionDefines whether the action can be selected multiple times. Defines behavior for an action or a group for how many times that item may be repeated.
| |
resource | I | 0..1 | Reference(Resource) | There are no (further) constraints on this element Element idRequestGroup.action.resource The target of the action DefinitionThe resource that is the target of the action (e.g. CommunicationRequest). The target resource SHALL be a Request resource with a Request.intent set to "option".
|
action | I | 0..* | see (action) | There are no (further) constraints on this element Element idRequestGroup.action.action Sub action DefinitionSub actions.
|
key | human | severity | expression |
---|---|---|---|
nhse-requsetgrp-001 | If extension-ParticipantType R5 Backport is used then RequestGroup.action.participant SHALL be empty. | error | RequestGroup.action.participant.empty() or RequestGroup.action.participant.extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-RequestOrchestration.action.participant.typeReference').empty() |