This page is part of the FHIR Specification (v5.0.0-snapshot3: R5 Snapshot #3, to support Connectathon 32). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Clinical Decision Support Work Group | Maturity Level: 0 | Trial Use | Use Context: Any |
Definitions for the cdshooksrequestorchestration Profile.
RequestOrchestration | |||||||||||||||||||||||||
Element Id | RequestOrchestration | ||||||||||||||||||||||||
Definition | A set of related requests that can be used to capture intended activities that have inter-dependencies such as "give this medication after that one". | ||||||||||||||||||||||||
Short Display | A set of related requests | ||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.id | |||||||||||||||||||||||||
Element Id | RequestOrchestration.id | ||||||||||||||||||||||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||||||||||||||||||||||
Short Display | Logical id of this artifact | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | id | ||||||||||||||||||||||||
Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. | ||||||||||||||||||||||||
RequestOrchestration.meta | |||||||||||||||||||||||||
Element Id | RequestOrchestration.meta | ||||||||||||||||||||||||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||||||||||||||||||||||
Short Display | Metadata about the resource | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | Meta | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.implicitRules | |||||||||||||||||||||||||
Element Id | RequestOrchestration.implicitRules | ||||||||||||||||||||||||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||||||||||||||||||||||
Short Display | A set of rules under which this content was created | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | uri | ||||||||||||||||||||||||
Is Modifier | true (Reason: This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation) | ||||||||||||||||||||||||
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 |
| ||||||||||||||||||||||||
RequestOrchestration.language | |||||||||||||||||||||||||
Element Id | RequestOrchestration.language | ||||||||||||||||||||||||
Definition | The base language in which the resource is written. | ||||||||||||||||||||||||
Short Display | Language of the resource content | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Terminology Binding | IETF language tag The codes SHOULD be taken from Common Languages | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
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 |
| ||||||||||||||||||||||||
RequestOrchestration.text | |||||||||||||||||||||||||
Element Id | RequestOrchestration.text | ||||||||||||||||||||||||
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||||||||||||||||||||||||
Short Display | Text summary of the resource, for human interpretation | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | Narrative | ||||||||||||||||||||||||
Alternate Names | narrative, html, xhtml, display | ||||||||||||||||||||||||
Comments | Contained resources do not have a 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 |
| ||||||||||||||||||||||||
RequestOrchestration.contained | |||||||||||||||||||||||||
Element Id | RequestOrchestration.contained | ||||||||||||||||||||||||
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. | ||||||||||||||||||||||||
Short Display | Contained, inline Resources | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Resource | ||||||||||||||||||||||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||||||||||||||||||||||
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. | ||||||||||||||||||||||||
RequestOrchestration.extension | |||||||||||||||||||||||||
Element Id | RequestOrchestration.extension | ||||||||||||||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||||||||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||
Alternate Names | extensions, user content | ||||||||||||||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.modifierExtension | |||||||||||||||||||||||||
Element Id | RequestOrchestration.modifierExtension | ||||||||||||||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||||||||||||||||||
Short Display | Extensions that cannot be ignored | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them) | ||||||||||||||||||||||||
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. | ||||||||||||||||||||||||
Alternate Names | extensions, user content | ||||||||||||||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.identifier | |||||||||||||||||||||||||
Element Id | RequestOrchestration.identifier | ||||||||||||||||||||||||
Definition | Allows a service to provide a unique, business identifier for the request. | ||||||||||||||||||||||||
Short Display | Business identifier | ||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||
Type | Identifier | ||||||||||||||||||||||||
Requirements | Allows identification of the request as it is known by various participating systems and in a way that remains consistent across servers. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.instantiatesCanonical | |||||||||||||||||||||||||
Element Id | RequestOrchestration.instantiatesCanonical | ||||||||||||||||||||||||
Definition | A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request. | ||||||||||||||||||||||||
Short Display | Instantiates FHIR protocol or definition | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | canonical | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.instantiatesUri | |||||||||||||||||||||||||
Element Id | RequestOrchestration.instantiatesUri | ||||||||||||||||||||||||
Definition | A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request. | ||||||||||||||||||||||||
Short Display | Instantiates external protocol or definition | ||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||
Type | uri | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.basedOn | |||||||||||||||||||||||||
Element Id | RequestOrchestration.basedOn | ||||||||||||||||||||||||
Definition | A plan, proposal or order that is fulfilled in whole or in part by this request. | ||||||||||||||||||||||||
Short Display | Fulfills plan, proposal, or order | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Reference(Resource) | ||||||||||||||||||||||||
Requirements | Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon. | ||||||||||||||||||||||||
Alternate Names | fulfills | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.replaces | |||||||||||||||||||||||||
Element Id | RequestOrchestration.replaces | ||||||||||||||||||||||||
Definition | Completed or terminated request(s) whose function is taken by this new request. | ||||||||||||||||||||||||
Short Display | Request(s) replaced by this request | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Reference(Resource) | ||||||||||||||||||||||||
Requirements | Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests. | ||||||||||||||||||||||||
Alternate Names | supersedes, prior, renewed order | ||||||||||||||||||||||||
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 |
| ||||||||||||||||||||||||
RequestOrchestration.groupIdentifier | |||||||||||||||||||||||||
Element Id | RequestOrchestration.groupIdentifier | ||||||||||||||||||||||||
Definition | A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form. | ||||||||||||||||||||||||
Short Display | Composite request this is part of | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | Identifier | ||||||||||||||||||||||||
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. | ||||||||||||||||||||||||
Alternate Names | grouperid, requisition | ||||||||||||||||||||||||
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 |
| ||||||||||||||||||||||||
RequestOrchestration.status | |||||||||||||||||||||||||
Element Id | RequestOrchestration.status | ||||||||||||||||||||||||
Definition | The current state of the request. For request orchestrations, the status reflects the status of all the requests in the orchestration. | ||||||||||||||||||||||||
Short Display | draft | active | on-hold | revoked | completed | entered-in-error | unknown | ||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||
Terminology Binding | Codes identifying the lifecycle stage of a request. The codes SHALL be taken from RequestStatus | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Is Modifier | true (Reason: This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid) | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.intent | |||||||||||||||||||||||||
Element Id | RequestOrchestration.intent | ||||||||||||||||||||||||
Definition | Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain. | ||||||||||||||||||||||||
Short Display | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option | ||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||
Terminology Binding | Codes indicating the degree of authority/intentionality associated with a request. The codes SHALL be taken from RequestIntent | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Is Modifier | true (Reason: This element changes the interpretation of all descriptive attributes. For example "the time the request is recommended to occur" vs. "the time the request is authorized to occur" or "who is recommended to perform the request" vs. "who is authorized to perform the request) | ||||||||||||||||||||||||
Requirements | Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain. | ||||||||||||||||||||||||
Alternate Names | category | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.priority | |||||||||||||||||||||||||
Element Id | RequestOrchestration.priority | ||||||||||||||||||||||||
Definition | Indicates how quickly the request should be addressed with respect to other requests. | ||||||||||||||||||||||||
Short Display | routine | urgent | asap | stat | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Terminology Binding | Identifies the level of importance to be assigned to actioning the request. The codes SHALL be taken from RequestPriority | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Must Support | true | ||||||||||||||||||||||||
Meaning if Missing | If missing, this request should be performed with normal priority | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.code | |||||||||||||||||||||||||
Element Id | RequestOrchestration.code | ||||||||||||||||||||||||
Definition | A code that identifies what the overall request orchestration is. | ||||||||||||||||||||||||
Short Display | What's being requested/ordered | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Terminology Binding | null For example codes, see ActionCode | ||||||||||||||||||||||||
Type | CodeableConcept | ||||||||||||||||||||||||
Comments | This element can be used to provide a code that captures the meaning of the request orchestration as a whole, as opposed to the code of the action element, which captures the meaning of the individual actions within the request orchestration. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.subject | |||||||||||||||||||||||||
Element Id | RequestOrchestration.subject | ||||||||||||||||||||||||
Definition | The subject for which the request orchestration was created. | ||||||||||||||||||||||||
Short Display | Who the request orchestration is about | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | Reference(Patient) | ||||||||||||||||||||||||
Must Support | true | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.encounter | |||||||||||||||||||||||||
Element Id | RequestOrchestration.encounter | ||||||||||||||||||||||||
Definition | Describes the context of the request orchestration, if any. | ||||||||||||||||||||||||
Short Display | Created as part of | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | Reference(Encounter) | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.authoredOn | |||||||||||||||||||||||||
Element Id | RequestOrchestration.authoredOn | ||||||||||||||||||||||||
Definition | Indicates when the request orchestration was created. | ||||||||||||||||||||||||
Short Display | When the request orchestration was authored | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | dateTime | ||||||||||||||||||||||||
Must Support | true | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.author | |||||||||||||||||||||||||
Element Id | RequestOrchestration.author | ||||||||||||||||||||||||
Definition | Provides a reference to the author of the request orchestration. | ||||||||||||||||||||||||
Short Display | Device or practitioner that authored the request orchestration | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | Reference(Device) | ||||||||||||||||||||||||
Must Support | true | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.reason | |||||||||||||||||||||||||
Element Id | RequestOrchestration.reason | ||||||||||||||||||||||||
Definition | Describes the reason for the request orchestration in coded or textual form. | ||||||||||||||||||||||||
Short Display | Why the request orchestration is needed | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Terminology Binding | null For example codes, see ActionReasonCode | ||||||||||||||||||||||||
Type | CodeableReference(Condition) | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.goal | |||||||||||||||||||||||||
Element Id | RequestOrchestration.goal | ||||||||||||||||||||||||
Definition | Goals that are intended to be achieved by following the requests in this RequestOrchestration. | ||||||||||||||||||||||||
Short Display | What goals | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Reference(Goal) | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.note | |||||||||||||||||||||||||
Element Id | RequestOrchestration.note | ||||||||||||||||||||||||
Definition | Provides a mechanism to communicate additional information about the response. | ||||||||||||||||||||||||
Short Display | Additional notes about the response | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Annotation | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action | ||||||||||||||||||||||||
Definition | The actions, if any, produced by the evaluation of the artifact. | ||||||||||||||||||||||||
Short Display | Proposed actions, if any | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | BackboneElement | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.id | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.id | ||||||||||||||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
RequestOrchestration.action.extension | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.extension | ||||||||||||||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||||||||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||
Alternate Names | extensions, user content | ||||||||||||||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.modifierExtension | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.modifierExtension | ||||||||||||||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||||||||||||||||||
Short Display | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them) | ||||||||||||||||||||||||
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. | ||||||||||||||||||||||||
Alternate Names | extensions, user content, modifiers | ||||||||||||||||||||||||
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 |
| ||||||||||||||||||||||||
RequestOrchestration.action.linkId | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.linkId | ||||||||||||||||||||||||
Definition | The linkId of the action from the PlanDefinition that corresponds to this action in the RequestOrchestration resource. | ||||||||||||||||||||||||
Short Display | Pointer to specific item from the PlanDefinition | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.prefix | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.prefix | ||||||||||||||||||||||||
Definition | A user-visible prefix for the action. For example a section or item numbering such as 1. or A. | ||||||||||||||||||||||||
Short Display | User-visible prefix for the action (e.g. 1. or A.) | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.title | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.title | ||||||||||||||||||||||||
Definition | The title of the action displayed to a user. | ||||||||||||||||||||||||
Short Display | User-visible title | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
Must Support | true | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.description | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.description | ||||||||||||||||||||||||
Definition | A short description of the action used to provide a summary to display to the user. | ||||||||||||||||||||||||
Short Display | Short description of the action | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
Must Support | true | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.textEquivalent | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.textEquivalent | ||||||||||||||||||||||||
Definition | A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically. | ||||||||||||||||||||||||
Short Display | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.priority | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.priority | ||||||||||||||||||||||||
Definition | Indicates how quickly the action should be addressed with respect to other actions. | ||||||||||||||||||||||||
Short Display | routine | urgent | asap | stat | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Terminology Binding | Identifies the level of importance to be assigned to actioning the request. The codes SHALL be taken from RequestPriority | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Must Support | true | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.code | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.code | ||||||||||||||||||||||||
Definition | A code that provides meaning for the action or action group. For example, a section may have a LOINC code for a section of a documentation template. | ||||||||||||||||||||||||
Short Display | Code representing the meaning of the action or sub-actions | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Terminology Binding | null For example codes, see ActionCode | ||||||||||||||||||||||||
Type | CodeableConcept | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.documentation | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.documentation | ||||||||||||||||||||||||
Definition | Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources. | ||||||||||||||||||||||||
Short Display | Supporting documentation for the intended performer of the action | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | RelatedArtifact | ||||||||||||||||||||||||
Must Support | true | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.goal | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.goal | ||||||||||||||||||||||||
Definition | Goals that are intended to be achieved by following the requests in this action. | ||||||||||||||||||||||||
Short Display | What goals | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Reference(Goal) | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.condition | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.condition | ||||||||||||||||||||||||
Definition | An expression that describes applicability criteria, or start/stop conditions for the action. | ||||||||||||||||||||||||
Short Display | Whether or not the action is applicable | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | BackboneElement | ||||||||||||||||||||||||
Must Support | true | ||||||||||||||||||||||||
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 |
| ||||||||||||||||||||||||
RequestOrchestration.action.condition.id | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.condition.id | ||||||||||||||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
RequestOrchestration.action.condition.extension | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.condition.extension | ||||||||||||||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||||||||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||
Alternate Names | extensions, user content | ||||||||||||||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.condition.modifierExtension | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.condition.modifierExtension | ||||||||||||||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||||||||||||||||||
Short Display | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them) | ||||||||||||||||||||||||
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. | ||||||||||||||||||||||||
Alternate Names | extensions, user content, modifiers | ||||||||||||||||||||||||
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 |
| ||||||||||||||||||||||||
RequestOrchestration.action.condition.kind | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.condition.kind | ||||||||||||||||||||||||
Definition | The kind of condition. | ||||||||||||||||||||||||
Short Display | applicability | start | stop | ||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||
Terminology Binding | The kind of condition for the action. The codes SHALL be taken from ActionConditionKind | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
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 |
| ||||||||||||||||||||||||
RequestOrchestration.action.condition.expression | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.condition.expression | ||||||||||||||||||||||||
Definition | An expression that returns true or false, indicating whether or not the condition is satisfied. | ||||||||||||||||||||||||
Short Display | Boolean-valued expression | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | Expression | ||||||||||||||||||||||||
Comments | The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.input | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.input | ||||||||||||||||||||||||
Definition | Defines input data requirements for the action. | ||||||||||||||||||||||||
Short Display | Input data requirements | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | BackboneElement | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.input.id | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.input.id | ||||||||||||||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
RequestOrchestration.action.input.extension | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.input.extension | ||||||||||||||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||||||||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||
Alternate Names | extensions, user content | ||||||||||||||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.input.modifierExtension | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.input.modifierExtension | ||||||||||||||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||||||||||||||||||
Short Display | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them) | ||||||||||||||||||||||||
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. | ||||||||||||||||||||||||
Alternate Names | extensions, user content, modifiers | ||||||||||||||||||||||||
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 |
| ||||||||||||||||||||||||
RequestOrchestration.action.input.title | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.input.title | ||||||||||||||||||||||||
Definition | A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers. | ||||||||||||||||||||||||
Short Display | User-visible title | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.input.requirement | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.input.requirement | ||||||||||||||||||||||||
Definition | Defines the data that is to be provided as input to the action. | ||||||||||||||||||||||||
Short Display | What data is provided | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | DataRequirement | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.input.relatedData | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.input.relatedData | ||||||||||||||||||||||||
Definition | Points to an existing input or output element that provides data to this input. | ||||||||||||||||||||||||
Short Display | What data is provided | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | id | ||||||||||||||||||||||||
Comments | The relatedData element allows indicating that an input to a parent action is an input to specific child actions. It also allows the output of one action to be identified as the input to a different action | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.output | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.output | ||||||||||||||||||||||||
Definition | Defines the outputs of the action, if any. | ||||||||||||||||||||||||
Short Display | Output data definition | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | BackboneElement | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.output.id | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.output.id | ||||||||||||||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
RequestOrchestration.action.output.extension | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.output.extension | ||||||||||||||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||||||||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||
Alternate Names | extensions, user content | ||||||||||||||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.output.modifierExtension | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.output.modifierExtension | ||||||||||||||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||||||||||||||||||
Short Display | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them) | ||||||||||||||||||||||||
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. | ||||||||||||||||||||||||
Alternate Names | extensions, user content, modifiers | ||||||||||||||||||||||||
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 |
| ||||||||||||||||||||||||
RequestOrchestration.action.output.title | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.output.title | ||||||||||||||||||||||||
Definition | A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers. | ||||||||||||||||||||||||
Short Display | User-visible title | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.output.requirement | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.output.requirement | ||||||||||||||||||||||||
Definition | Defines the data that results as output from the action. | ||||||||||||||||||||||||
Short Display | What data is provided | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | DataRequirement | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.output.relatedData | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.output.relatedData | ||||||||||||||||||||||||
Definition | Points to an existing input or output element that is results as output from the action. | ||||||||||||||||||||||||
Short Display | What data is provided | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
Comments | The relatedData element allows indicating that the output of child action is also the output of a parent action. It also allows the input of one action to be identified as the output of a different action | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.relatedAction | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.relatedAction | ||||||||||||||||||||||||
Definition | A relationship to another action such as "before" or "30-60 minutes after start of". | ||||||||||||||||||||||||
Short Display | Relationship to another action | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | BackboneElement | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.relatedAction.id | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.relatedAction.id | ||||||||||||||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
RequestOrchestration.action.relatedAction.extension | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.relatedAction.extension | ||||||||||||||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||||||||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||
Alternate Names | extensions, user content | ||||||||||||||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.relatedAction.modifierExtension | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.relatedAction.modifierExtension | ||||||||||||||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||||||||||||||||||
Short Display | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them) | ||||||||||||||||||||||||
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. | ||||||||||||||||||||||||
Alternate Names | extensions, user content, modifiers | ||||||||||||||||||||||||
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 |
| ||||||||||||||||||||||||
RequestOrchestration.action.relatedAction.targetId | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.relatedAction.targetId | ||||||||||||||||||||||||
Definition | The element id of the target related action. | ||||||||||||||||||||||||
Short Display | What action this is related to | ||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||
Type | id | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.relatedAction.relationship | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.relatedAction.relationship | ||||||||||||||||||||||||
Definition | The relationship of this action to the related action. | ||||||||||||||||||||||||
Short Display | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end | ||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||
Terminology Binding | Defines the types of relationships between actions. The codes SHALL be taken from ActionRelationshipType | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.relatedAction.offset[x] | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.relatedAction.offset[x] | ||||||||||||||||||||||||
Definition | A duration or range of durations to apply to the relationship. For example, 30-60 minutes before. | ||||||||||||||||||||||||
Short Display | Time offset for the relationship | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | Choice of: Duration, Range | ||||||||||||||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.timing[x] | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.timing[x] | ||||||||||||||||||||||||
Definition | An optional value describing when the action should be performed. | ||||||||||||||||||||||||
Short Display | When the action should take place | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | Choice of: dateTime, Age, Period, Duration, Range, Timing | ||||||||||||||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||||||||||||||
Must Support | true | ||||||||||||||||||||||||
Requirements | Allows prompting for activities and detection of missed planned activities. | ||||||||||||||||||||||||
Comments | The intent of the timing element is to provide timing for when the action should be performed. The timing may be absolute (specified as a dateTime or Period) or relative (specified as an Age, Duration, or Range), or it may be a more complex, potentially repeating timing specified using Timing. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.location | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.location | ||||||||||||||||||||||||
Definition | Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etc. | ||||||||||||||||||||||||
Short Display | Where it should happen | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | CodeableReference(Location) | ||||||||||||||||||||||||
Requirements | Helps in planning of activity. | ||||||||||||||||||||||||
Alternate Names | facility | ||||||||||||||||||||||||
Comments | May reference a specific clinical location or may just identify a type of location. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.participant | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.participant | ||||||||||||||||||||||||
Definition | The participant that should perform or be responsible for this action. | ||||||||||||||||||||||||
Short Display | Who should perform the action | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | BackboneElement | ||||||||||||||||||||||||
Must Support | true | ||||||||||||||||||||||||
Comments | Because request orchestrations represent potential options for performing activities, some specific participants may still be unknown, so this element allows for both definitional participants (in the same way they are specified in ActivityDefinition and PlanDefinition resources) as well as identifying specific participants when they are known. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.participant.id | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.participant.id | ||||||||||||||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
RequestOrchestration.action.participant.extension | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.participant.extension | ||||||||||||||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||||||||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||
Alternate Names | extensions, user content | ||||||||||||||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.participant.modifierExtension | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.participant.modifierExtension | ||||||||||||||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||||||||||||||||||
Short Display | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them) | ||||||||||||||||||||||||
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. | ||||||||||||||||||||||||
Alternate Names | extensions, user content, modifiers | ||||||||||||||||||||||||
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 |
| ||||||||||||||||||||||||
RequestOrchestration.action.participant.type | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.participant.type | ||||||||||||||||||||||||
Definition | The type of participant in the action. | ||||||||||||||||||||||||
Short Display | careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Terminology Binding | The type of participant in the activity. The codes SHALL be taken from ActionParticipantType | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.participant.typeCanonical | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.participant.typeCanonical | ||||||||||||||||||||||||
Definition | The type of participant in the action. | ||||||||||||||||||||||||
Short Display | Who or what can participate | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | canonical(CapabilityStatement) | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.participant.typeReference | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.participant.typeReference | ||||||||||||||||||||||||
Definition | The type of participant in the action. | ||||||||||||||||||||||||
Short Display | Who or what can participate | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | Reference(CareTeam) | ||||||||||||||||||||||||
Comments | When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location). | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.participant.role | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.participant.role | ||||||||||||||||||||||||
Definition | The role the participant should play in performing the described action. | ||||||||||||||||||||||||
Short Display | E.g. Nurse, Surgeon, Parent, etc. | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Terminology Binding | Defines roles played by participants for the action. For example codes, see ActionParticipantRole | ||||||||||||||||||||||||
Type | CodeableConcept | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.participant.function | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.participant.function | ||||||||||||||||||||||||
Definition | Indicates how the actor will be involved in the action - author, reviewer, witness, etc. | ||||||||||||||||||||||||
Short Display | E.g. Author, Reviewer, Witness, etc. | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Terminology Binding | null For example codes, see ActionParticipantFunction | ||||||||||||||||||||||||
Type | CodeableConcept | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.participant.actor[x] | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.participant.actor[x] | ||||||||||||||||||||||||
Definition | A reference to the actual participant. | ||||||||||||||||||||||||
Short Display | Who/what is participating? | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | Choice of: canonical(CapabilityStatement), Reference(CareTeam) | ||||||||||||||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.type | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.type | ||||||||||||||||||||||||
Definition | The type of action to perform (create, update, remove). | ||||||||||||||||||||||||
Short Display | create | update | remove | fire-event | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Terminology Binding | The type of action to be performed. The codes SHALL be taken from ActionType; other codes may be used where these codes are not suitable | ||||||||||||||||||||||||
Type | CodeableConcept | ||||||||||||||||||||||||
Must Support | true | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.groupingBehavior | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.groupingBehavior | ||||||||||||||||||||||||
Definition | Defines the grouping behavior for the action and its children. | ||||||||||||||||||||||||
Short Display | visual-group | logical-group | sentence-group | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Terminology Binding | Defines organization behavior of a group. The codes SHALL be taken from ActionGroupingBehavior | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.selectionBehavior | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.selectionBehavior | ||||||||||||||||||||||||
Definition | Defines the selection behavior for the action and its children. | ||||||||||||||||||||||||
Short Display | any | all | all-or-none | exactly-one | at-most-one | one-or-more | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Terminology Binding | Defines selection behavior of a group. The codes SHALL be taken from ActionSelectionBehavior | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Must Support | true | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.requiredBehavior | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.requiredBehavior | ||||||||||||||||||||||||
Definition | Defines expectations around whether an action is required. | ||||||||||||||||||||||||
Short Display | must | could | must-unless-documented | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Terminology Binding | Defines expectations around whether an action or action group is required. The codes SHALL be taken from ActionRequiredBehavior | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.precheckBehavior | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.precheckBehavior | ||||||||||||||||||||||||
Definition | Defines whether the action should usually be preselected. | ||||||||||||||||||||||||
Short Display | yes | no | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Terminology Binding | Defines selection frequency behavior for an action or group. The codes SHALL be taken from ActionPrecheckBehavior | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.cardinalityBehavior | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.cardinalityBehavior | ||||||||||||||||||||||||
Definition | Defines whether the action can be selected multiple times. | ||||||||||||||||||||||||
Short Display | single | multiple | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Terminology Binding | Defines behavior for an action or a group for how many times that item may be repeated. The codes SHALL be taken from ActionCardinalityBehavior | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.resource | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.resource | ||||||||||||||||||||||||
Definition | The resource that is the target of the action (e.g. CommunicationRequest). | ||||||||||||||||||||||||
Short Display | The target of the action | ||||||||||||||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: rqg-1 | ||||||||||||||||||||||||
Type | Reference(Resource) | ||||||||||||||||||||||||
Must Support | true | ||||||||||||||||||||||||
Comments | The target resource SHALL be a Request resource with a Request.intent set to "option". | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.definition[x] | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.definition[x] | ||||||||||||||||||||||||
Definition | A reference to an ActivityDefinition that describes the action to be taken in detail, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured. | ||||||||||||||||||||||||
Short Display | Description of the activity to be performed | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | Choice of: canonical(ActivityDefinition), uri | ||||||||||||||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||||||||||||||
Comments | Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.transform | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.transform | ||||||||||||||||||||||||
Definition | A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input. | ||||||||||||||||||||||||
Short Display | Transform to apply the template | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | canonical(StructureMap) | ||||||||||||||||||||||||
Comments | Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.dynamicValue | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.dynamicValue | ||||||||||||||||||||||||
Definition | Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result. | ||||||||||||||||||||||||
Short Display | Dynamic aspects of the definition | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | BackboneElement | ||||||||||||||||||||||||
Comments | Dynamic values are applied in the order in which they are defined in the RequestOrchestration resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.dynamicValue.id | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.dynamicValue.id | ||||||||||||||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
RequestOrchestration.action.dynamicValue.extension | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.dynamicValue.extension | ||||||||||||||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||||||||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||
Alternate Names | extensions, user content | ||||||||||||||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.dynamicValue.modifierExtension | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.dynamicValue.modifierExtension | ||||||||||||||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||||||||||||||||||
Short Display | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them) | ||||||||||||||||||||||||
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. | ||||||||||||||||||||||||
Alternate Names | extensions, user content, modifiers | ||||||||||||||||||||||||
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 |
| ||||||||||||||||||||||||
RequestOrchestration.action.dynamicValue.path | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.dynamicValue.path | ||||||||||||||||||||||||
Definition | The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). | ||||||||||||||||||||||||
Short Display | The path to the element to be set dynamically | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
Comments | To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.dynamicValue.expression | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.dynamicValue.expression | ||||||||||||||||||||||||
Definition | An expression specifying the value of the customized element. | ||||||||||||||||||||||||
Short Display | An expression that provides the dynamic value for the customization | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | Expression | ||||||||||||||||||||||||
Comments | The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
RequestOrchestration.action.action | |||||||||||||||||||||||||
Element Id | RequestOrchestration.action.action | ||||||||||||||||||||||||
Definition | Sub actions. | ||||||||||||||||||||||||
Short Display | Sub action | ||||||||||||||||||||||||
Cardinality | 0..* This element is affected by the following invariants: rqg-1 | ||||||||||||||||||||||||
Type | See ttp://hl7.org/fhir/StructureDefinition/RequestOrchestration#RequestOrchestration.action | ||||||||||||||||||||||||
Invariants |
|