{ "resourceType": "StructureDefinition", "id": "RequestGroup", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "text": { "status": "generated", "div": "
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\"RequestGroupDomainResourceA group of related requests\r\n
Elements defined in Ancestors: \r\n id, \r\n meta, \r\n implicitRules, \r\n language, \r\n text, \r\n contained, \r\n extension, \r\n modifierExtension
\".\"\".\"\".\"identifierΣ0..*IdentifierBusiness identifier\r\n
\".\"\".\"\".\"definition0..*Reference(\r\n Any)\r\n Instantiates protocol or definition\r\n
\".\"\".\"\".\"basedOn0..*Reference(\r\n Any)\r\n Fulfills plan, proposal, or order\r\n
\".\"\".\"\".\"replaces0..*Reference(\r\n Any)\r\n Request(s) replaced by this request\r\n
\".\"\".\"\".\"groupIdentifierΣ0..1IdentifierComposite request this is part of
\".\"\".\"\".\"status?!Σ1..1codedraft | active | suspended | cancelled | completed | entered-in-error | unknown\r\n
RequestStatus (\r\n Required)\r\n
\".\"\".\"\".\"intent?!Σ1..1codeproposal | plan | order\r\n
RequestIntent (\r\n Required)\r\n
\".\"\".\"\".\"priorityΣ0..1coderoutine | urgent | asap | stat\r\n
RequestPriority (\r\n Required)\r\n
\".\"\".\"\".\"subject0..1Reference(\r\n Patient | \r\n Group)\r\n Who the request group is about
\".\"\".\"\".\"context0..1Reference(\r\n Encounter | \r\n EpisodeOfCare)\r\n Encounter or Episode for the request group
\".\"\".\"\".\"authoredOn0..1dateTimeWhen the request group was authored
\".\"\".\"\".\"author0..1Reference(\r\n Device | \r\n Practitioner)\r\n Device or practitioner that authored the request group
\".\"\".\"\".\"reason[x]0..1Reason for the request group
\".\"\".\"\".\"\".\"reasonCodeableConceptCodeableConcept
\".\"\".\"\".\"\".\" reasonReference\r\n Reference(\r\n Any)\r\n
\".\"\".\"\".\"note0..*AnnotationAdditional notes about the response\r\n
\".\"\".\"\".\"actionI0..*BackboneElementProposed actions, if any\r\n
+ Must have resource or action but not both
\".\"\".\"\".\"\".\"label0..1stringUser-visible label for the action (e.g. 1. or A.)
\".\"\".\"\".\"\".\"title0..1stringUser-visible title
\".\"\".\"\".\"\".\"descriptionΣ0..1stringShort description of the action
\".\"\".\"\".\"\".\"textEquivalentΣ0..1stringStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
\".\"\".\"\".\"\".\"code0..*CodeableConceptCode representing the meaning of the action or sub-actions\r\n
\".\"\".\"\".\"\".\"documentation0..*RelatedArtifactSupporting documentation for the intended performer of the action\r\n
\".\"\".\"\".\"\".\"condition0..*BackboneElementWhether or not the action is applicable\r\n
\".\"\".\"\".\"\".\"\".\"kind1..1codeapplicability | start | stop\r\n
ActionConditionKind (\r\n Required)\r\n
\".\"\".\"\".\"\".\"\".\"description0..1stringNatural language description of the condition
\".\"\".\"\".\"\".\"\".\"language0..1stringLanguage of the expression
\".\"\".\"\".\"\".\"\".\"expression0..1stringBoolean-valued expression
\".\"\".\"\".\"\".\"relatedAction0..*BackboneElementRelationship to another action\r\n
\".\"\".\"\".\"\".\"\".\"actionId1..1idWhat action this is related to
\".\"\".\"\".\"\".\"\".\"relationship1..1codebefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end\r\n
ActionRelationshipType (\r\n Required)\r\n
\".\"\".\"\".\"\".\"\".\"offset[x]0..1Time offset for the relationship
\".\"\".\"\".\"\".\"\".\"\".\"offsetDurationDuration
\".\"\".\"\".\"\".\"\".\"\".\"offsetRangeRange
\".\"\".\"\".\"\".\"timing[x]0..1When the action should take place
\".\"\".\"\".\"\".\"\".\"timingDateTimedateTime
\".\"\".\"\".\"\".\"\".\"timingPeriodPeriod
\".\"\".\"\".\"\".\"\".\"timingDurationDuration
\".\"\".\"\".\"\".\"\".\"timingRangeRange
\".\"\".\"\".\"\".\"\".\" timingTiming\r\n Timing
\".\"\".\"\".\"\".\"participant0..*Reference(\r\n Patient | \r\n Person | \r\n Practitioner | \r\n RelatedPerson)\r\n Who should perform the action\r\n
\".\"\".\"\".\"\".\"type0..1Codingcreate | update | remove | fire-event\r\n
ActionType (\r\n Extensible)\r\n
\".\"\".\"\".\"\".\"groupingBehavior0..1codevisual-group | logical-group | sentence-group\r\n
ActionGroupingBehavior (\r\n Required)\r\n
\".\"\".\"\".\"\".\"selectionBehavior0..1codeany | all | all-or-none | exactly-one | at-most-one | one-or-more\r\n
ActionSelectionBehavior (\r\n Required)\r\n
\".\"\".\"\".\"\".\"requiredBehavior0..1codemust | could | must-unless-documented\r\n
ActionRequiredBehavior (\r\n Required)\r\n
\".\"\".\"\".\"\".\"precheckBehavior0..1codeyes | no\r\n
ActionPrecheckBehavior (\r\n Required)\r\n
\".\"\".\"\".\"\".\"cardinalityBehavior0..1codesingle | multiple\r\n
ActionCardinalityBehavior (\r\n Required)\r\n
\".\"\".\"\".\"\".\"resourceI0..1Reference(\r\n Any)\r\n The target of the action
\".\"\".\"\".\"\".\"actionI0..*see \r\n actionSub action\r\n

\"doco\" Documentation for this format\r\n
" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 0 }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "cds" } ], "url": "http://hl7.org/fhir/StructureDefinition/RequestGroup", "name": "RequestGroup", "status": "draft", "date": "2017-04-18T21:44:43+00:00", "publisher": "Health Level Seven International (Clinical Decision Support)", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] }, { "telecom": [ { "system": "url", "value": "http://www.hl7.org/Special/committees/dss/index.cfm" } ] } ], "description": "Base StructureDefinition for RequestGroup Resource", "fhirVersion": "3.0.1", "mapping": [ { "identity": "workflow", "uri": "http://hl7.org/fhir/workflow", "name": "Workflow Mapping" }, { "identity": "w5", "uri": "http://hl7.org/fhir/w5", "name": "W5 Mapping" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "resource", "abstract": false, "type": "RequestGroup", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource", "derivation": "specialization", "snapshot": { "element": [ { "id": "RequestGroup", "path": "RequestGroup", "short": "A group of related requests", "definition": "A group of related requests that can be used to capture intended activities that have inter-dependencies such as \"give this medication after that one\".", "min": 0, "max": "*", "base": { "path": "Resource", "min": 0, "max": "*" }, "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "workflow", "map": "Request" }, { "identity": "w5", "map": "clinical.general" } ] }, { "id": "RequestGroup.id", "path": "RequestGroup.id", "short": "Logical id of this artifact", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.", "min": 0, "max": "1", "base": { "path": "Resource.id", "min": 0, "max": "1" }, "type": [ { "code": "id" } ], "isSummary": true }, { "id": "RequestGroup.meta", "path": "RequestGroup.meta", "short": "Metadata about the resource", "definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.", "min": 0, "max": "1", "base": { "path": "Resource.meta", "min": 0, "max": "1" }, "type": [ { "code": "Meta" } ], "isSummary": true }, { "id": "RequestGroup.implicitRules", "path": "RequestGroup.implicitRules", "short": "A set of rules under which this content was created", "definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.", "comment": "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. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.", "min": 0, "max": "1", "base": { "path": "Resource.implicitRules", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "isModifier": true, "isSummary": true }, { "id": "RequestGroup.language", "path": "RequestGroup.language", "short": "Language of the resource content", "definition": "The base language in which the resource is written.", "comment": "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).", "min": 0, "max": "1", "base": { "path": "Resource.language", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueReference": { "reference": "http://hl7.org/fhir/ValueSet/all-languages" } }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language" } ], "strength": "extensible", "description": "A human language.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/languages" } } }, { "id": "RequestGroup.text", "path": "RequestGroup.text", "short": "Text summary of the resource, for human interpretation", "definition": "A human-readable narrative that contains a summary of the resource, and may 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.", "comment": "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 in formation is added later.", "alias": [ "narrative", "html", "xhtml", "display" ], "min": 0, "max": "1", "base": { "path": "DomainResource.text", "min": 0, "max": "1" }, "type": [ { "code": "Narrative" } ], "condition": [ "dom-1" ], "mapping": [ { "identity": "rim", "map": "Act.text?" } ] }, { "id": "RequestGroup.contained", "path": "RequestGroup.contained", "short": "Contained, inline Resources", "definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", "comment": "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.", "alias": [ "inline resources", "anonymous resources", "contained resources" ], "min": 0, "max": "*", "base": { "path": "DomainResource.contained", "min": 0, "max": "*" }, "type": [ { "code": "Resource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "RequestGroup.extension", "path": "RequestGroup.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order 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.", "comment": "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "RequestGroup.modifierExtension", "path": "RequestGroup.modifierExtension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Extensions that cannot be ignored", "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. Usually modifier elements provide negation or qualification. In order 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.", "comment": "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "isModifier": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "RequestGroup.identifier", "path": "RequestGroup.identifier", "short": "Business identifier", "definition": "Allows a service to provide a unique, business identifier for the request.", "requirements": "Allows identification of the request as it is known by various participating systems and in a way that remains consistent across servers.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.identifier" }, { "identity": "w5", "map": "id" } ] }, { "id": "RequestGroup.definition", "path": "RequestGroup.definition", "short": "Instantiates protocol or definition", "definition": "A protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "mapping": [ { "identity": "workflow", "map": "Request.identifier" } ] }, { "id": "RequestGroup.basedOn", "path": "RequestGroup.basedOn", "short": "Fulfills plan, proposal, or order", "definition": "A plan, proposal or order that is fulfilled in whole or in part by this request.", "requirements": "Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon.", "alias": [ "fulfills" ], "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "mapping": [ { "identity": "workflow", "map": "Request.basedOn" } ] }, { "id": "RequestGroup.replaces", "path": "RequestGroup.replaces", "short": "Request(s) replaced by this request", "definition": "Completed or terminated request(s) whose function is taken by this new request.", "comment": "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.", "requirements": "Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests.", "alias": [ "supersedes", "prior", "renewed order" ], "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "mapping": [ { "identity": "workflow", "map": "Request.replaces" } ] }, { "id": "RequestGroup.groupIdentifier", "path": "RequestGroup.groupIdentifier", "short": "Composite request this is part of", "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.", "comment": "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.", "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.", "alias": [ "grouperid", "requisition" ], "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.groupIdentifier" } ] }, { "id": "RequestGroup.status", "path": "RequestGroup.status", "short": "draft | active | suspended | cancelled | completed | entered-in-error | unknown", "definition": "The current state of the request. For request groups, the status reflects the status of all the requests in the group.", "comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RequestStatus" } ], "strength": "required", "description": "Codes identifying the stage lifecycle stage of a request", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/request-status" } }, "mapping": [ { "identity": "workflow", "map": "Request.status" }, { "identity": "w5", "map": "status" } ] }, { "id": "RequestGroup.intent", "path": "RequestGroup.intent", "short": "proposal | plan | order", "definition": "Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.", "comment": "This element is labeled as a modifier because the intent alters when and how the resource is actually applicable.", "requirements": "Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain.", "alias": [ "category" ], "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RequestIntent" } ], "strength": "required", "description": "Codes indicating the degree of authority/intentionality associated with a request", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/request-intent" } }, "mapping": [ { "identity": "workflow", "map": "Request.intent" }, { "identity": "w5", "map": "class" } ] }, { "id": "RequestGroup.priority", "path": "RequestGroup.priority", "short": "routine | urgent | asap | stat", "definition": "Indicates how quickly the request should be addressed with respect to other requests.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "meaningWhenMissing": "If missing, this request should be performed with normal priority", "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RequestPriority" } ], "strength": "required", "description": "Identifies the level of importance to be assigned to actioning the request", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/request-priority" } }, "mapping": [ { "identity": "workflow", "map": "Request.priority" }, { "identity": "w5", "map": "grade" } ] }, { "id": "RequestGroup.subject", "path": "RequestGroup.subject", "short": "Who the request group is about", "definition": "The subject for which the request group was created.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group" } ], "mapping": [ { "identity": "workflow", "map": "Request.subject" }, { "identity": "w5", "map": "who.focus" } ] }, { "id": "RequestGroup.context", "path": "RequestGroup.context", "short": "Encounter or Episode for the request group", "definition": "Describes the context of the request group, if any.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare" } ], "mapping": [ { "identity": "workflow", "map": "Request.context" }, { "identity": "w5", "map": "context" } ] }, { "id": "RequestGroup.authoredOn", "path": "RequestGroup.authoredOn", "short": "When the request group was authored", "definition": "Indicates when the request group was created.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "mapping": [ { "identity": "workflow", "map": "Request.authoredOn" }, { "identity": "w5", "map": "when.recorded" } ] }, { "id": "RequestGroup.author", "path": "RequestGroup.author", "short": "Device or practitioner that authored the request group", "definition": "Provides a reference to the author of the request group.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" } ], "mapping": [ { "identity": "workflow", "map": "Request.author" }, { "identity": "w5", "map": "who.author" } ] }, { "id": "RequestGroup.reason[x]", "path": "RequestGroup.reason[x]", "short": "Reason for the request group", "definition": "Indicates the reason the request group was created. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "mapping": [ { "identity": "workflow", "map": "Request.reason" }, { "identity": "w5", "map": "why" } ] }, { "id": "RequestGroup.note", "path": "RequestGroup.note", "short": "Additional notes about the response", "definition": "Provides a mechanism to communicate additional information about the response.", "min": 0, "max": "*", "type": [ { "code": "Annotation" } ], "mapping": [ { "identity": "workflow", "map": "Request.note" } ] }, { "id": "RequestGroup.action", "path": "RequestGroup.action", "short": "Proposed actions, if any", "definition": "The actions, if any, produced by the evaluation of the artifact.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "rqg-1", "severity": "error", "human": "Must have resource or action but not both", "expression": "resource.exists() != action.exists()", "xpath": "exists(f:resource) != exists(f:action)", "source": "http://hl7.org/fhir/StructureDefinition/RequestGroup" } ] } ] }, "differential": { "element": [ { "id": "RequestGroup", "path": "RequestGroup", "short": "A group of related requests", "definition": "A group of related requests that can be used to capture intended activities that have inter-dependencies such as \"give this medication after that one\".", "min": 0, "max": "*", "mapping": [ { "identity": "workflow", "map": "Request" }, { "identity": "w5", "map": "clinical.general" } ] }, { "id": "RequestGroup.identifier", "path": "RequestGroup.identifier", "short": "Business identifier", "definition": "Allows a service to provide a unique, business identifier for the request.", "requirements": "Allows identification of the request as it is known by various participating systems and in a way that remains consistent across servers.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.identifier" }, { "identity": "w5", "map": "id" } ] }, { "id": "RequestGroup.definition", "path": "RequestGroup.definition", "short": "Instantiates protocol or definition", "definition": "A protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "mapping": [ { "identity": "workflow", "map": "Request.identifier" } ] }, { "id": "RequestGroup.basedOn", "path": "RequestGroup.basedOn", "short": "Fulfills plan, proposal, or order", "definition": "A plan, proposal or order that is fulfilled in whole or in part by this request.", "requirements": "Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon.", "alias": [ "fulfills" ], "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "mapping": [ { "identity": "workflow", "map": "Request.basedOn" } ] }, { "id": "RequestGroup.replaces", "path": "RequestGroup.replaces", "short": "Request(s) replaced by this request", "definition": "Completed or terminated request(s) whose function is taken by this new request.", "comment": "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.", "requirements": "Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests.", "alias": [ "supersedes", "prior", "renewed order" ], "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "mapping": [ { "identity": "workflow", "map": "Request.replaces" } ] }, { "id": "RequestGroup.groupIdentifier", "path": "RequestGroup.groupIdentifier", "short": "Composite request this is part of", "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.", "comment": "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.", "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.", "alias": [ "grouperid", "requisition" ], "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.groupIdentifier" } ] }, { "id": "RequestGroup.status", "path": "RequestGroup.status", "short": "draft | active | suspended | cancelled | completed | entered-in-error | unknown", "definition": "The current state of the request. For request groups, the status reflects the status of all the requests in the group.", "comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RequestStatus" } ], "strength": "required", "description": "Codes identifying the stage lifecycle stage of a request", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/request-status" } }, "mapping": [ { "identity": "workflow", "map": "Request.status" }, { "identity": "w5", "map": "status" } ] }, { "id": "RequestGroup.intent", "path": "RequestGroup.intent", "short": "proposal | plan | order", "definition": "Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.", "comment": "This element is labeled as a modifier because the intent alters when and how the resource is actually applicable.", "requirements": "Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain.", "alias": [ "category" ], "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RequestIntent" } ], "strength": "required", "description": "Codes indicating the degree of authority/intentionality associated with a request", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/request-intent" } }, "mapping": [ { "identity": "workflow", "map": "Request.intent" }, { "identity": "w5", "map": "class" } ] }, { "id": "RequestGroup.priority", "path": "RequestGroup.priority", "short": "routine | urgent | asap | stat", "definition": "Indicates how quickly the request should be addressed with respect to other requests.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "meaningWhenMissing": "If missing, this request should be performed with normal priority", "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "RequestPriority" } ], "strength": "required", "description": "Identifies the level of importance to be assigned to actioning the request", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/request-priority" } }, "mapping": [ { "identity": "workflow", "map": "Request.priority" }, { "identity": "w5", "map": "grade" } ] }, { "id": "RequestGroup.subject", "path": "RequestGroup.subject", "short": "Who the request group is about", "definition": "The subject for which the request group was created.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group" } ], "mapping": [ { "identity": "workflow", "map": "Request.subject" }, { "identity": "w5", "map": "who.focus" } ] }, { "id": "RequestGroup.context", "path": "RequestGroup.context", "short": "Encounter or Episode for the request group", "definition": "Describes the context of the request group, if any.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare" } ], "mapping": [ { "identity": "workflow", "map": "Request.context" }, { "identity": "w5", "map": "context" } ] }, { "id": "RequestGroup.authoredOn", "path": "RequestGroup.authoredOn", "short": "When the request group was authored", "definition": "Indicates when the request group was created.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "mapping": [ { "identity": "workflow", "map": "Request.authoredOn" }, { "identity": "w5", "map": "when.recorded" } ] }, { "id": "RequestGroup.author", "path": "RequestGroup.author", "short": "Device or practitioner that authored the request group", "definition": "Provides a reference to the author of the request group.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" } ], "mapping": [ { "identity": "workflow", "map": "Request.author" }, { "identity": "w5", "map": "who.author" } ] }, { "id": "RequestGroup.reason[x]", "path": "RequestGroup.reason[x]", "short": "Reason for the request group", "definition": "Indicates the reason the request group was created. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "mapping": [ { "identity": "workflow", "map": "Request.reason" }, { "identity": "w5", "map": "why" } ] }, { "id": "RequestGroup.note", "path": "RequestGroup.note", "short": "Additional notes about the response", "definition": "Provides a mechanism to communicate additional information about the response.", "min": 0, "max": "*", "type": [ { "code": "Annotation" } ], "mapping": [ { "identity": "workflow", "map": "Request.note" } ] }, { "id": "RequestGroup.action", "path": "RequestGroup.action", "short": "Proposed actions, if any", "definition": "The actions, if any, produced by the evaluation of the artifact.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "rqg-1", "severity": "error", "human": "Must have resource or action but not both", "expression": "resource.exists() != action.exists()", "xpath": "exists(f:resource) != exists(f:action)" } ] }, { "id": "RequestGroup.action.label", "path": "RequestGroup.action.label", "short": "User-visible label for the action (e.g. 1. or A.)", "definition": "A user-visible label for the action.", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "id": "RequestGroup.action.title", "path": "RequestGroup.action.title", "short": "User-visible title", "definition": "The title of the action displayed to a user.", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "id": "RequestGroup.action.description", "path": "RequestGroup.action.description", "short": "Short description of the action", "definition": "A short description of the action used to provide a summary to display to the user.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true }, { "id": "RequestGroup.action.textEquivalent", "path": "RequestGroup.action.textEquivalent", "short": "Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system", "definition": "A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that may not be capable of interpreting it dynamically.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true }, { "id": "RequestGroup.action.code", "path": "RequestGroup.action.code", "short": "Code representing the meaning of the action or sub-actions", "definition": "A code that provides meaning for the action or action group. For example, a section may have a LOINC code for a the section of a documentation template.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "mapping": [ { "identity": "workflow", "map": "Request.code" } ] }, { "id": "RequestGroup.action.documentation", "path": "RequestGroup.action.documentation", "short": "Supporting documentation for the intended performer of the action", "definition": "Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.", "min": 0, "max": "*", "type": [ { "code": "RelatedArtifact" } ], "mapping": [ { "identity": "workflow", "map": "Request.supportingInfo" } ] }, { "id": "RequestGroup.action.condition", "path": "RequestGroup.action.condition", "short": "Whether or not the action is applicable", "definition": "An expression that describes applicability criteria, or start/stop conditions for the action.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ] }, { "id": "RequestGroup.action.condition.kind", "path": "RequestGroup.action.condition.kind", "short": "applicability | start | stop", "definition": "The kind of condition.", "comment": "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 when enter/exit criteria for an action.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ActionConditionKind" } ], "strength": "required", "description": "The kind of condition for the action", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/action-condition-kind" } } }, { "id": "RequestGroup.action.condition.description", "path": "RequestGroup.action.condition.description", "short": "Natural language description of the condition", "definition": "A brief, natural language description of the condition that effectively communicates the intended semantics.", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "id": "RequestGroup.action.condition.language", "path": "RequestGroup.action.condition.language", "short": "Language of the expression", "definition": "The media type of the language for the expression.", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "id": "RequestGroup.action.condition.expression", "path": "RequestGroup.action.condition.expression", "short": "Boolean-valued expression", "definition": "An expression that returns true or false, indicating whether or not the condition is satisfied.", "comment": "The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "id": "RequestGroup.action.relatedAction", "path": "RequestGroup.action.relatedAction", "short": "Relationship to another action", "definition": "A relationship to another action such as \"before\" or \"30-60 minutes after start of\".", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ] }, { "id": "RequestGroup.action.relatedAction.actionId", "path": "RequestGroup.action.relatedAction.actionId", "short": "What action this is related to", "definition": "The element id of the action this is related to.", "min": 1, "max": "1", "type": [ { "code": "id" } ] }, { "id": "RequestGroup.action.relatedAction.relationship", "path": "RequestGroup.action.relatedAction.relationship", "short": "before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end", "definition": "The relationship of this action to the related action.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ActionRelationshipType" } ], "strength": "required", "description": "Defines the types of relationships between actions", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/action-relationship-type" } } }, { "id": "RequestGroup.action.relatedAction.offset[x]", "path": "RequestGroup.action.relatedAction.offset[x]", "short": "Time offset for the relationship", "definition": "A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.", "min": 0, "max": "1", "type": [ { "code": "Duration" }, { "code": "Range" } ] }, { "id": "RequestGroup.action.timing[x]", "path": "RequestGroup.action.timing[x]", "short": "When the action should take place", "definition": "An optional value describing when the action should be performed.", "min": 0, "max": "1", "type": [ { "code": "dateTime" }, { "code": "Period" }, { "code": "Duration" }, { "code": "Range" }, { "code": "Timing" } ], "mapping": [ { "identity": "workflow", "map": "Request.occurrence" } ] }, { "id": "RequestGroup.action.participant", "path": "RequestGroup.action.participant", "short": "Who should perform the action", "definition": "The participant that should perform or be responsible for this action.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Person" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" } ], "mapping": [ { "identity": "workflow", "map": "Request.performer" }, { "identity": "w5", "map": "who.actor" } ] }, { "id": "RequestGroup.action.type", "path": "RequestGroup.action.type", "short": "create | update | remove | fire-event", "definition": "The type of action to perform (create, update, remove).", "min": 0, "max": "1", "type": [ { "code": "Coding" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ActionType" } ], "strength": "extensible", "description": "The type of action to be performed", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/action-type" } } }, { "id": "RequestGroup.action.groupingBehavior", "path": "RequestGroup.action.groupingBehavior", "short": "visual-group | logical-group | sentence-group", "definition": "Defines the grouping behavior for the action and its children.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ActionGroupingBehavior" } ], "strength": "required", "description": "Defines organization behavior of a group", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/action-grouping-behavior" } } }, { "id": "RequestGroup.action.selectionBehavior", "path": "RequestGroup.action.selectionBehavior", "short": "any | all | all-or-none | exactly-one | at-most-one | one-or-more", "definition": "Defines the selection behavior for the action and its children.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ActionSelectionBehavior" } ], "strength": "required", "description": "Defines selection behavior of a group", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/action-selection-behavior" } } }, { "id": "RequestGroup.action.requiredBehavior", "path": "RequestGroup.action.requiredBehavior", "short": "must | could | must-unless-documented", "definition": "Defines the requiredness behavior for the action.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ActionRequiredBehavior" } ], "strength": "required", "description": "Defines requiredness behavior for selecting an action or an action group", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/action-required-behavior" } } }, { "id": "RequestGroup.action.precheckBehavior", "path": "RequestGroup.action.precheckBehavior", "short": "yes | no", "definition": "Defines whether the action should usually be preselected.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ActionPrecheckBehavior" } ], "strength": "required", "description": "Defines selection frequency behavior for an action or group", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/action-precheck-behavior" } } }, { "id": "RequestGroup.action.cardinalityBehavior", "path": "RequestGroup.action.cardinalityBehavior", "short": "single | multiple", "definition": "Defines whether the action can be selected multiple times.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ActionCardinalityBehavior" } ], "strength": "required", "description": "Defines behavior for an action or a group for how many times that item may be repeated", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/action-cardinality-behavior" } } }, { "id": "RequestGroup.action.resource", "path": "RequestGroup.action.resource", "short": "The target of the action", "definition": "The resource that is the target of the action (e.g. CommunicationRequest).", "comment": "The target resource SHALL be a [Request](request.html) resource with a Request.intent set to \"option\".", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "condition": [ "rqg-1" ] }, { "id": "RequestGroup.action.action", "path": "RequestGroup.action.action", "short": "Sub action", "definition": "Sub actions.", "min": 0, "max": "*", "contentReference": "#RequestGroup.action", "condition": [ "rqg-1" ] } ] } }