{
"description": "Base StructureDefinition for RequestGroup Resource",
"_filename": "requestgroup.profile.json",
"package_name": "hl7.fhir.core",
"date": "2016-12-06T12:22:34+11:00",
"derivation": "specialization",
"meta": {
"lastUpdated": "2016-12-06T12:22:34.981+11:00"
},
"publisher": "Health Level Seven International (Clinical Decision Support)",
"fhirVersion": "1.8.0",
"name": "RequestGroup",
"mapping": [ {
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "RequestGroup",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "1.8.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 0
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "cds"
} ],
"snapshot": {
"element": [ {
"id": "RequestGroup",
"max": "*",
"min": 0,
"path": "RequestGroup",
"short": "A group of related requests",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "clinical.general",
"identity": "w5"
} ],
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-1",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.text.empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()"
} ],
"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\"."
}, {
"path": "RequestGroup.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"short": "Logical id of this artifact",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "RequestGroup.id",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"path": "RequestGroup.meta",
"min": 0,
"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.",
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "RequestGroup.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"path": "RequestGroup.implicitRules",
"min": 0,
"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.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"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 as much as possible.",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "RequestGroup.implicitRules",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isSummary": true
}, {
"path": "RequestGroup.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"short": "Language of the resource content",
"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).",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
} ],
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
},
"max": "1",
"id": "RequestGroup.language",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
}
}, {
"path": "RequestGroup.text",
"min": 0,
"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.",
"short": "Text summary of the resource, for human interpretation",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "RequestGroup.text",
"condition": [ "dom-1" ],
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
}
}, {
"path": "RequestGroup.contained",
"min": 0,
"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.",
"short": "Contained, inline 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.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "RequestGroup.contained",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
}
}, {
"path": "RequestGroup.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"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.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "RequestGroup.extension",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"path": "RequestGroup.modifierExtension",
"min": 0,
"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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"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.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "RequestGroup.modifierExtension",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
}
}, {
"path": "RequestGroup.identifier",
"min": 0,
"definition": "Allows a service to provide a unique, business identifier for the response.",
"short": "Business identifier",
"mapping": [ {
"map": "id",
"identity": "w5"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "1",
"id": "RequestGroup.identifier",
"isSummary": true
}, {
"id": "RequestGroup.subject",
"max": "1",
"min": 0,
"path": "RequestGroup.subject",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Group"
} ],
"short": "Subject of the request group",
"mapping": [ {
"map": "who.focus",
"identity": "w5"
} ],
"definition": "The subject for which the request group was created."
}, {
"id": "RequestGroup.context",
"max": "1",
"min": 0,
"path": "RequestGroup.context",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"
} ],
"short": "Encounter or Episode for the request group",
"mapping": [ {
"map": "context",
"identity": "w5"
} ],
"definition": "Describes the context of the request group, if any."
}, {
"id": "RequestGroup.occurrenceDateTime",
"max": "1",
"min": 0,
"path": "RequestGroup.occurrenceDateTime",
"type": [ {
"code": "dateTime"
} ],
"short": "When the request group was authored",
"mapping": [ {
"map": "when.done",
"identity": "w5"
} ],
"definition": "Indicates when the request group was created."
}, {
"id": "RequestGroup.author",
"max": "1",
"min": 0,
"path": "RequestGroup.author",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Device"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
} ],
"short": "Device or practitioner that authored the request group",
"definition": "Provides a reference to the author of the request group."
}, {
"id": "RequestGroup.reason[x]",
"max": "1",
"min": 0,
"path": "RequestGroup.reason[x]",
"type": [ {
"code": "CodeableConcept"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
} ],
"short": "Reason for the request group",
"mapping": [ {
"map": "why",
"identity": "w5"
} ],
"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."
}, {
"id": "RequestGroup.note",
"max": "*",
"min": 0,
"path": "RequestGroup.note",
"type": [ {
"code": "Annotation"
} ],
"short": "Additional notes about the response",
"definition": "Provides a mechanism to communicate additional information about the response."
}, {
"id": "RequestGroup.action",
"max": "*",
"min": 0,
"path": "RequestGroup.action",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Proposed actions, if any",
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "children().count() > id.count()"
}, {
"key": "rqg-1",
"human": "Must have resource or action but not both",
"xpath": "exists(f:resource) != exists(f:action)",
"severity": "error",
"expression": "resource.exists() != action.exists()"
} ],
"definition": "The actions, if any, produced by the evaluation of the artifact."
}, {
"path": "RequestGroup.action.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "RequestGroup.action.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "RequestGroup.action.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"short": "Additional Content defined by implementations",
"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.",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "RequestGroup.action.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "RequestGroup.action.modifierExtension",
"min": 0,
"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 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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"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.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "RequestGroup.action.modifierExtension",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"id": "RequestGroup.action.actionIdentifier",
"max": "1",
"min": 0,
"path": "RequestGroup.action.actionIdentifier",
"type": [ {
"code": "Identifier"
} ],
"short": "Unique identifier",
"definition": "A unique identifier for the action. The identifier SHALL be unique within the container in which it appears, and MAY be universally unique."
}, {
"id": "RequestGroup.action.label",
"max": "1",
"min": 0,
"path": "RequestGroup.action.label",
"type": [ {
"code": "string"
} ],
"short": "User-visible label for the action (e.g. 1. or A.)",
"definition": "A user-visible label for the action."
}, {
"id": "RequestGroup.action.title",
"max": "1",
"min": 0,
"path": "RequestGroup.action.title",
"type": [ {
"code": "string"
} ],
"short": "User-visible title",
"definition": "The title of the action displayed to a user."
}, {
"id": "RequestGroup.action.description",
"max": "1",
"min": 0,
"path": "RequestGroup.action.description",
"type": [ {
"code": "string"
} ],
"short": "Short description of the action",
"definition": "A short description of the action used to provide a summary to display to the user."
}, {
"id": "RequestGroup.action.textEquivalent",
"max": "1",
"min": 0,
"path": "RequestGroup.action.textEquivalent",
"type": [ {
"code": "string"
} ],
"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."
}, {
"id": "RequestGroup.action.code",
"max": "*",
"min": 0,
"path": "RequestGroup.action.code",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "The meaning of the action or its sub-actions",
"definition": "The concept represented by this action or its sub-actions."
}, {
"id": "RequestGroup.action.documentation",
"max": "*",
"min": 0,
"path": "RequestGroup.action.documentation",
"type": [ {
"code": "RelatedArtifact"
} ],
"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."
}, {
"id": "RequestGroup.action.condition",
"max": "*",
"min": 0,
"path": "RequestGroup.action.condition",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Whether or not the action is applicable",
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "children().count() > id.count()"
} ],
"definition": "An expression that describes applicability criteria, or start/stop conditions for the action."
}, {
"path": "RequestGroup.action.condition.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "RequestGroup.action.condition.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "RequestGroup.action.condition.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"short": "Additional Content defined by implementations",
"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.",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "RequestGroup.action.condition.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "RequestGroup.action.condition.modifierExtension",
"min": 0,
"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 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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"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.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "RequestGroup.action.condition.modifierExtension",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "RequestGroup.action.condition.kind",
"min": 1,
"definition": "The kind of condition.",
"short": "applicability | start | stop",
"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 when enter/exit criteria for an action.",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"description": "The kind of condition for the action",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-condition-kind"
}
},
"max": "1",
"id": "RequestGroup.action.condition.kind"
}, {
"id": "RequestGroup.action.condition.description",
"max": "1",
"min": 0,
"path": "RequestGroup.action.condition.description",
"type": [ {
"code": "string"
} ],
"short": "Natural language description of the condition",
"definition": "A brief, natural language description of the condition that effectively communicates the intended semantics."
}, {
"id": "RequestGroup.action.condition.language",
"max": "1",
"min": 0,
"path": "RequestGroup.action.condition.language",
"type": [ {
"code": "string"
} ],
"short": "Language of the expression",
"definition": "The media type of the language for the expression."
}, {
"id": "RequestGroup.action.condition.expression",
"max": "1",
"min": 0,
"path": "RequestGroup.action.condition.expression",
"type": [ {
"code": "string"
} ],
"short": "Boolean-valued 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.",
"definition": "An expression that returns true or false, indicating whether or not the condition is satisfied."
}, {
"id": "RequestGroup.action.relatedAction",
"max": "*",
"min": 0,
"path": "RequestGroup.action.relatedAction",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Relationship to another action",
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "children().count() > id.count()"
} ],
"definition": "A relationship to another action such as \"before\" or \"30-60 minutes after start of\"."
}, {
"path": "RequestGroup.action.relatedAction.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "RequestGroup.action.relatedAction.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "RequestGroup.action.relatedAction.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"short": "Additional Content defined by implementations",
"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.",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "RequestGroup.action.relatedAction.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "RequestGroup.action.relatedAction.modifierExtension",
"min": 0,
"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 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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"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.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "RequestGroup.action.relatedAction.modifierExtension",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"id": "RequestGroup.action.relatedAction.actionIdentifier",
"max": "1",
"min": 1,
"path": "RequestGroup.action.relatedAction.actionIdentifier",
"type": [ {
"code": "Identifier"
} ],
"short": "Identifier of the related action",
"definition": "The unique identifier of the related action."
}, {
"id": "RequestGroup.action.relatedAction.relationship",
"max": "1",
"min": 1,
"path": "RequestGroup.action.relatedAction.relationship",
"type": [ {
"code": "code"
} ],
"short": "before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end",
"binding": {
"strength": "required",
"description": "Defines the types of relationships between actions",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-relationship-type"
}
},
"definition": "The relationship of this action to the related action."
}, {
"id": "RequestGroup.action.relatedAction.offset[x]",
"max": "1",
"min": 0,
"path": "RequestGroup.action.relatedAction.offset[x]",
"type": [ {
"code": "Duration"
}, {
"code": "Range"
} ],
"short": "Time offset for the relationship",
"definition": "A duration or range of durations to apply to the relationship. For example, 30-60 minutes before."
}, {
"id": "RequestGroup.action.timing[x]",
"max": "1",
"min": 0,
"path": "RequestGroup.action.timing[x]",
"type": [ {
"code": "dateTime"
}, {
"code": "Period"
}, {
"code": "Duration"
}, {
"code": "Range"
}, {
"code": "Timing"
} ],
"short": "When the action should take place",
"definition": "An optional value describing when the action should be performed."
}, {
"id": "RequestGroup.action.participant",
"max": "*",
"min": 0,
"path": "RequestGroup.action.participant",
"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"
} ],
"short": "Participant",
"mapping": [ {
"map": "who.actor",
"identity": "w5"
} ],
"definition": "The participant in the action."
}, {
"id": "RequestGroup.action.type",
"max": "1",
"min": 0,
"path": "RequestGroup.action.type",
"type": [ {
"code": "Coding"
} ],
"short": "create | update | remove | fire-event",
"binding": {
"strength": "extensible",
"description": "The type of action to be performed",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-type"
}
},
"definition": "The type of action to perform (create, update, remove)."
}, {
"id": "RequestGroup.action.groupingBehavior",
"max": "1",
"min": 0,
"path": "RequestGroup.action.groupingBehavior",
"type": [ {
"code": "code"
} ],
"short": "visual-group | logical-group | sentence-group",
"binding": {
"strength": "required",
"description": "Defines organization behavior of a group",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-grouping-behavior"
}
},
"definition": "Defines the grouping behavior for the action and its children."
}, {
"id": "RequestGroup.action.selectionBehavior",
"max": "1",
"min": 0,
"path": "RequestGroup.action.selectionBehavior",
"type": [ {
"code": "code"
} ],
"short": "any | all | all-or-none | exactly-one | at-most-one | one-or-more",
"binding": {
"strength": "required",
"description": "Defines selection behavior of a group",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-selection-behavior"
}
},
"definition": "Defines the selection behavior for the action and its children."
}, {
"id": "RequestGroup.action.requiredBehavior",
"max": "1",
"min": 0,
"path": "RequestGroup.action.requiredBehavior",
"type": [ {
"code": "code"
} ],
"short": "must | could | must-unless-documented",
"binding": {
"strength": "required",
"description": "Defines requiredness behavior for selecting an action or an action group",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-required-behavior"
}
},
"definition": "Defines the requiredness behavior for the action."
}, {
"id": "RequestGroup.action.precheckBehavior",
"max": "1",
"min": 0,
"path": "RequestGroup.action.precheckBehavior",
"type": [ {
"code": "code"
} ],
"short": "yes | no",
"binding": {
"strength": "required",
"description": "Defines selection frequency behavior for an action or group",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-precheck-behavior"
}
},
"definition": "Defines whether the action should usually be preselected."
}, {
"id": "RequestGroup.action.cardinalityBehavior",
"max": "1",
"min": 0,
"path": "RequestGroup.action.cardinalityBehavior",
"type": [ {
"code": "code"
} ],
"short": "single | multiple",
"binding": {
"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"
}
},
"definition": "Defines whether the action can be selected multiple times."
}, {
"path": "RequestGroup.action.resource",
"min": 0,
"definition": "The resource that is the target of the action (e.g. CommunicationRequest).",
"short": "The target of the action",
"comments": "The target resource SHALL be a [Request](request.html) resource with a Request.intent set to \"option\".",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
} ],
"max": "1",
"id": "RequestGroup.action.resource",
"condition": [ "rqg-1" ]
}, {
"id": "RequestGroup.action.action",
"max": "*",
"min": 0,
"path": "RequestGroup.action.action",
"short": "Sub action",
"condition": [ "rqg-1" ],
"definition": "Sub actions.",
"contentReference": "#RequestGroup.action"
} ]
},
"status": "draft",
"id": "7b25d742-3e30-450a-a5d2-f8d493545590",
"kind": "resource",
"url": "http://hl7.org/fhir/StructureDefinition/RequestGroup",
"version": null,
"differential": {
"element": [ {
"id": "RequestGroup",
"max": "*",
"min": 0,
"path": "RequestGroup",
"short": "A group of related requests",
"mapping": [ {
"map": "clinical.general",
"identity": "w5"
} ],
"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\"."
}, {
"path": "RequestGroup.identifier",
"min": 0,
"definition": "Allows a service to provide a unique, business identifier for the response.",
"short": "Business identifier",
"mapping": [ {
"map": "id",
"identity": "w5"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "1",
"id": "RequestGroup.identifier",
"isSummary": true
}, {
"id": "RequestGroup.subject",
"max": "1",
"min": 0,
"path": "RequestGroup.subject",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Group"
} ],
"short": "Subject of the request group",
"mapping": [ {
"map": "who.focus",
"identity": "w5"
} ],
"definition": "The subject for which the request group was created."
}, {
"id": "RequestGroup.context",
"max": "1",
"min": 0,
"path": "RequestGroup.context",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"
} ],
"short": "Encounter or Episode for the request group",
"mapping": [ {
"map": "context",
"identity": "w5"
} ],
"definition": "Describes the context of the request group, if any."
}, {
"id": "RequestGroup.occurrenceDateTime",
"max": "1",
"min": 0,
"path": "RequestGroup.occurrenceDateTime",
"type": [ {
"code": "dateTime"
} ],
"short": "When the request group was authored",
"mapping": [ {
"map": "when.done",
"identity": "w5"
} ],
"definition": "Indicates when the request group was created."
}, {
"id": "RequestGroup.author",
"max": "1",
"min": 0,
"path": "RequestGroup.author",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Device"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
} ],
"short": "Device or practitioner that authored the request group",
"definition": "Provides a reference to the author of the request group."
}, {
"id": "RequestGroup.reason[x]",
"max": "1",
"min": 0,
"path": "RequestGroup.reason[x]",
"type": [ {
"code": "CodeableConcept"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
} ],
"short": "Reason for the request group",
"mapping": [ {
"map": "why",
"identity": "w5"
} ],
"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."
}, {
"id": "RequestGroup.note",
"max": "*",
"min": 0,
"path": "RequestGroup.note",
"type": [ {
"code": "Annotation"
} ],
"short": "Additional notes about the response",
"definition": "Provides a mechanism to communicate additional information about the response."
}, {
"id": "RequestGroup.action",
"max": "*",
"min": 0,
"path": "RequestGroup.action",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Proposed actions, if any",
"constraint": [ {
"key": "rqg-1",
"human": "Must have resource or action but not both",
"xpath": "exists(f:resource) != exists(f:action)",
"severity": "error",
"expression": "resource.exists() != action.exists()"
} ],
"definition": "The actions, if any, produced by the evaluation of the artifact."
}, {
"id": "RequestGroup.action.actionIdentifier",
"max": "1",
"min": 0,
"path": "RequestGroup.action.actionIdentifier",
"type": [ {
"code": "Identifier"
} ],
"short": "Unique identifier",
"definition": "A unique identifier for the action. The identifier SHALL be unique within the container in which it appears, and MAY be universally unique."
}, {
"id": "RequestGroup.action.label",
"max": "1",
"min": 0,
"path": "RequestGroup.action.label",
"type": [ {
"code": "string"
} ],
"short": "User-visible label for the action (e.g. 1. or A.)",
"definition": "A user-visible label for the action."
}, {
"id": "RequestGroup.action.title",
"max": "1",
"min": 0,
"path": "RequestGroup.action.title",
"type": [ {
"code": "string"
} ],
"short": "User-visible title",
"definition": "The title of the action displayed to a user."
}, {
"id": "RequestGroup.action.description",
"max": "1",
"min": 0,
"path": "RequestGroup.action.description",
"type": [ {
"code": "string"
} ],
"short": "Short description of the action",
"definition": "A short description of the action used to provide a summary to display to the user."
}, {
"id": "RequestGroup.action.textEquivalent",
"max": "1",
"min": 0,
"path": "RequestGroup.action.textEquivalent",
"type": [ {
"code": "string"
} ],
"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."
}, {
"id": "RequestGroup.action.code",
"max": "*",
"min": 0,
"path": "RequestGroup.action.code",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "The meaning of the action or its sub-actions",
"definition": "The concept represented by this action or its sub-actions."
}, {
"id": "RequestGroup.action.documentation",
"max": "*",
"min": 0,
"path": "RequestGroup.action.documentation",
"type": [ {
"code": "RelatedArtifact"
} ],
"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."
}, {
"id": "RequestGroup.action.condition",
"max": "*",
"min": 0,
"path": "RequestGroup.action.condition",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Whether or not the action is applicable",
"definition": "An expression that describes applicability criteria, or start/stop conditions for the action."
}, {
"path": "RequestGroup.action.condition.kind",
"min": 1,
"definition": "The kind of condition.",
"short": "applicability | start | stop",
"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 when enter/exit criteria for an action.",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"description": "The kind of condition for the action",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-condition-kind"
}
},
"max": "1",
"id": "RequestGroup.action.condition.kind"
}, {
"id": "RequestGroup.action.condition.description",
"max": "1",
"min": 0,
"path": "RequestGroup.action.condition.description",
"type": [ {
"code": "string"
} ],
"short": "Natural language description of the condition",
"definition": "A brief, natural language description of the condition that effectively communicates the intended semantics."
}, {
"id": "RequestGroup.action.condition.language",
"max": "1",
"min": 0,
"path": "RequestGroup.action.condition.language",
"type": [ {
"code": "string"
} ],
"short": "Language of the expression",
"definition": "The media type of the language for the expression."
}, {
"id": "RequestGroup.action.condition.expression",
"max": "1",
"min": 0,
"path": "RequestGroup.action.condition.expression",
"type": [ {
"code": "string"
} ],
"short": "Boolean-valued 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.",
"definition": "An expression that returns true or false, indicating whether or not the condition is satisfied."
}, {
"id": "RequestGroup.action.relatedAction",
"max": "*",
"min": 0,
"path": "RequestGroup.action.relatedAction",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Relationship to another action",
"definition": "A relationship to another action such as \"before\" or \"30-60 minutes after start of\"."
}, {
"id": "RequestGroup.action.relatedAction.actionIdentifier",
"max": "1",
"min": 1,
"path": "RequestGroup.action.relatedAction.actionIdentifier",
"type": [ {
"code": "Identifier"
} ],
"short": "Identifier of the related action",
"definition": "The unique identifier of the related action."
}, {
"id": "RequestGroup.action.relatedAction.relationship",
"max": "1",
"min": 1,
"path": "RequestGroup.action.relatedAction.relationship",
"type": [ {
"code": "code"
} ],
"short": "before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end",
"binding": {
"strength": "required",
"description": "Defines the types of relationships between actions",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-relationship-type"
}
},
"definition": "The relationship of this action to the related action."
}, {
"id": "RequestGroup.action.relatedAction.offset[x]",
"max": "1",
"min": 0,
"path": "RequestGroup.action.relatedAction.offset[x]",
"type": [ {
"code": "Duration"
}, {
"code": "Range"
} ],
"short": "Time offset for the relationship",
"definition": "A duration or range of durations to apply to the relationship. For example, 30-60 minutes before."
}, {
"id": "RequestGroup.action.timing[x]",
"max": "1",
"min": 0,
"path": "RequestGroup.action.timing[x]",
"type": [ {
"code": "dateTime"
}, {
"code": "Period"
}, {
"code": "Duration"
}, {
"code": "Range"
}, {
"code": "Timing"
} ],
"short": "When the action should take place",
"definition": "An optional value describing when the action should be performed."
}, {
"id": "RequestGroup.action.participant",
"max": "*",
"min": 0,
"path": "RequestGroup.action.participant",
"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"
} ],
"short": "Participant",
"mapping": [ {
"map": "who.actor",
"identity": "w5"
} ],
"definition": "The participant in the action."
}, {
"id": "RequestGroup.action.type",
"max": "1",
"min": 0,
"path": "RequestGroup.action.type",
"type": [ {
"code": "Coding"
} ],
"short": "create | update | remove | fire-event",
"binding": {
"strength": "extensible",
"description": "The type of action to be performed",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-type"
}
},
"definition": "The type of action to perform (create, update, remove)."
}, {
"id": "RequestGroup.action.groupingBehavior",
"max": "1",
"min": 0,
"path": "RequestGroup.action.groupingBehavior",
"type": [ {
"code": "code"
} ],
"short": "visual-group | logical-group | sentence-group",
"binding": {
"strength": "required",
"description": "Defines organization behavior of a group",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-grouping-behavior"
}
},
"definition": "Defines the grouping behavior for the action and its children."
}, {
"id": "RequestGroup.action.selectionBehavior",
"max": "1",
"min": 0,
"path": "RequestGroup.action.selectionBehavior",
"type": [ {
"code": "code"
} ],
"short": "any | all | all-or-none | exactly-one | at-most-one | one-or-more",
"binding": {
"strength": "required",
"description": "Defines selection behavior of a group",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-selection-behavior"
}
},
"definition": "Defines the selection behavior for the action and its children."
}, {
"id": "RequestGroup.action.requiredBehavior",
"max": "1",
"min": 0,
"path": "RequestGroup.action.requiredBehavior",
"type": [ {
"code": "code"
} ],
"short": "must | could | must-unless-documented",
"binding": {
"strength": "required",
"description": "Defines requiredness behavior for selecting an action or an action group",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-required-behavior"
}
},
"definition": "Defines the requiredness behavior for the action."
}, {
"id": "RequestGroup.action.precheckBehavior",
"max": "1",
"min": 0,
"path": "RequestGroup.action.precheckBehavior",
"type": [ {
"code": "code"
} ],
"short": "yes | no",
"binding": {
"strength": "required",
"description": "Defines selection frequency behavior for an action or group",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-precheck-behavior"
}
},
"definition": "Defines whether the action should usually be preselected."
}, {
"id": "RequestGroup.action.cardinalityBehavior",
"max": "1",
"min": 0,
"path": "RequestGroup.action.cardinalityBehavior",
"type": [ {
"code": "code"
} ],
"short": "single | multiple",
"binding": {
"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"
}
},
"definition": "Defines whether the action can be selected multiple times."
}, {
"path": "RequestGroup.action.resource",
"min": 0,
"definition": "The resource that is the target of the action (e.g. CommunicationRequest).",
"short": "The target of the action",
"comments": "The target resource SHALL be a [Request](request.html) resource with a Request.intent set to \"option\".",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
} ],
"max": "1",
"id": "RequestGroup.action.resource",
"condition": [ "rqg-1" ]
}, {
"id": "RequestGroup.action.action",
"max": "*",
"min": 0,
"path": "RequestGroup.action.action",
"short": "Sub action",
"condition": [ "rqg-1" ],
"definition": "Sub actions.",
"contentReference": "#RequestGroup.action"
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://hl7.org/fhir",
"system": "url"
} ]
}, {
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/dss/index.cfm",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource"
}