This page is part of the FHIR Specification (v4.4.0: R5 Preview #2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4B R4
Clinical Decision Support Work Group | Maturity Level: 1 | Trial Use | Use Context: Any |
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/cdshooksrequestgroup
Defines a RequestGroup that can represent a CDS Hooks response
This profile was published on [no date] as a draft by HL7.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from RequestGroup.
This structure is derived from RequestGroup.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
RequestGroup | 1..1 | RequestGroup | A group of related requests | |
identifier | 1..1 | Identifier | Business identifier | |
instantiatesUri | 1..1 | uri | Instantiates external protocol or definition | |
priority | S | 0..1 | code | routine | urgent | asap | stat |
subject | S | 0..1 | Reference(Patient | Group) | Who the request group is about |
authoredOn | S | 0..1 | dateTime | When the request group was authored |
author | S | 0..1 | Reference(Device | Practitioner | PractitionerRole) | Device or practitioner that authored the request group |
action | 0..* | BackboneElement | Proposed actions, if any | |
title | S | 0..1 | string | User-visible title |
description | S | 0..1 | string | Short description of the action |
priority | S | 0..1 | code | routine | urgent | asap | stat |
documentation | S | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action |
condition | S | 0..* | BackboneElement | Whether or not the action is applicable |
timing[x] | S | 0..1 | dateTime, Age, Period, Duration, Range, Timing | When the action should take place |
participant | S | 0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device) | Who should perform the action |
type | S | 0..1 | CodeableConcept | create | update | remove | fire-event |
selectionBehavior | S | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more |
resource | S | 0..1 | Reference(Resource) | The target of the action |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
RequestGroup | I | 1..1 | RequestGroup | A group of related requests |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: Common Languages (preferred) Max Binding: All Languages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
identifier | ΣI | 1..1 | Identifier | Business identifier |
instantiatesCanonical | ΣI | 0..* | canonical() | Instantiates FHIR protocol or definition |
instantiatesUri | ΣI | 1..1 | uri | Instantiates external protocol or definition |
basedOn | I | 0..* | Reference(Resource) | Fulfills plan, proposal, or order |
replaces | I | 0..* | Reference(Resource) | Request(s) replaced by this request |
groupIdentifier | ΣI | 0..1 | Identifier | Composite request this is part of |
status | ?!ΣI | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required) |
intent | ?!ΣI | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required) |
priority | SΣI | 0..1 | code | routine | urgent | asap | stat Binding: Request priority (required) |
code | ΣI | 0..1 | CodeableConcept | What's being requested/ordered |
subject | SI | 0..1 | Reference(Patient | Group) | Who the request group is about |
encounter | I | 0..1 | Reference(Encounter) | Created as part of |
authoredOn | SI | 0..1 | dateTime | When the request group was authored |
author | SI | 0..1 | Reference(Device | Practitioner | PractitionerRole) | Device or practitioner that authored the request group |
reason | I | 0..* | CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference) | Why the request group is needed |
note | I | 0..* | Annotation | Additional notes about the response |
action | I | 0..* | BackboneElement | Proposed actions, if any |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
prefix | I | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) |
title | SI | 0..1 | string | User-visible title |
description | SΣI | 0..1 | string | Short description of the action |
textEquivalent | ΣI | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system |
priority | SI | 0..1 | code | routine | urgent | asap | stat Binding: Request priority (required) |
code | I | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions |
documentation | SI | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action |
condition | SI | 0..* | BackboneElement | Whether or not the action is applicable |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
kind | I | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required) |
expression | I | 0..1 | Expression | Boolean-valued expression |
relatedAction | I | 0..* | BackboneElement | Relationship to another action |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
actionId | I | 1..1 | id | What action this is related to |
relationship | I | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required) |
offset[x] | I | 0..1 | Time offset for the relationship | |
offsetDuration | Duration | |||
offsetRange | Range | |||
timing[x] | SI | 0..1 | When the action should take place | |
timingDateTime | dateTime | |||
timingAge | Age | |||
timingPeriod | Period | |||
timingDuration | Duration | |||
timingRange | Range | |||
timingTiming | Timing | |||
participant | SI | 0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device) | Who should perform the action |
type | SI | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible) |
groupingBehavior | I | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required) |
selectionBehavior | SI | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required) |
requiredBehavior | I | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required) |
precheckBehavior | I | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required) |
cardinalityBehavior | I | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required) |
resource | SI | 0..1 | Reference(Resource) | The target of the action |
action | I | 0..* | Unknown reference to #RequestGroup.action Sub action | |
Documentation for this format |
<!-- CDS Hooks RequestGroup --> <RequestGroup xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- 0..1 Language of the resource content --> <text><!-- 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></modifierExtension> <identifier><!-- 1..1 Identifier Business identifier --></identifier> <instantiatesCanonical value="[canonical]"/><!-- 0..* Instantiates FHIR protocol or definition --> <instantiatesUri value="[uri]"/><!-- 1..1 Instantiates external protocol or definition --> <basedOn><!-- 0..* Reference(Resource) Fulfills plan, proposal, or order --></basedOn> <replaces><!-- 0..* Reference(Resource) Request(s) replaced by this request --></replaces> <groupIdentifier><!-- 0..1 Identifier Composite request this is part of --></groupIdentifier> <status value="[code]"/><!-- 1..1 draft | active | on-hold | revoked | completed | entered-in-error | unknown --> <intent value="[code]"/><!-- 1..1 proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option --> <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat --> <code><!-- 0..1 CodeableConcept What's being requested/ordered --></code> <subject><!-- 0..1 Reference(Patient) Who the request group is about --></subject> <encounter><!-- 0..1 Reference(Encounter) Created as part of --></encounter> <authoredOn value="[dateTime]"/><!-- 0..1 When the request group was authored --> <author><!-- 0..1 Reference(Device) Device or practitioner that authored the request group --></author> <reason><!-- 0..* CodeableReference Why the request group is needed --></reason> <note><!-- 0..* Annotation Additional notes about the response --></note> <action> 0..* BackboneElement <!-- 0..* Proposed actions, if any --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <prefix value="[string]"/><!-- 0..1 User-visible prefix for the action (e.g. 1. or A.) --> <title value="[string]"/><!-- 0..1 User-visible title --> <description value="[string]"/><!-- 0..1 Short description of the action --> <textEquivalent value="[string]"/><!-- 0..1 Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system --> <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat --> <code><!-- 0..* CodeableConcept Code representing the meaning of the action or sub-actions --></code> <documentation><!-- 0..* RelatedArtifact Supporting documentation for the intended performer of the action --></documentation> <condition> 0..* BackboneElement <!-- 0..* Whether or not the action is applicable --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <kind value="[code]"/><!-- 1..1 applicability | start | stop --> <expression><!-- 0..1 Expression Boolean-valued expression --></expression> </condition> <relatedAction> 0..* BackboneElement <!-- 0..* Relationship to another action --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <actionId value="[id]"/><!-- 1..1 What action this is related to --> <relationship value="[code]"/><!-- 1..1 before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end --> <offset[x]><!-- 0..1 Duration|Range Time offset for the relationship --></offset[x]> </relatedAction> <timing[x]><!-- 0..1 dateTime|Age|Period|Duration|Range| Timing When the action should take place --></timing[x]> <participant><!-- 0..* Reference(Patient) Who should perform the action --></participant> <type><!-- 0..1 CodeableConcept create | update | remove | fire-event --></type> <groupingBehavior value="[code]"/><!-- 0..1 visual-group | logical-group | sentence-group --> <selectionBehavior value="[code]"/><!-- 0..1 any | all | all-or-none | exactly-one | at-most-one | one-or-more --> <requiredBehavior value="[code]"/><!-- 0..1 must | could | must-unless-documented --> <precheckBehavior value="[code]"/><!-- 0..1 yes | no --> <cardinalityBehavior value="[code]"/><!-- 0..1 single | multiple --> <resource><!-- 0..1 Reference(Resource) The target of the action --></resource> <action><!-- See #RequestGroup.action Sub action --></action> </action> </RequestGroup>
{ // CDS Hooks RequestGroup // from Element: extension "meta" : { Meta }, // C?Metadata about the resource "implicitRules" : "<uri>", // C?A set of rules under which this content was created "language" : "<code>", // C?Language of the resource content "text" : { Narrative }, // C?Text summary of the resource, for human interpretation "contained" : [{ Resource }], //Contained, inline Resources "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored "identifier" : { Identifier }, // C? R! Business identifier "instantiatesCanonical" : ["<canonical>"], // C?Instantiates FHIR protocol or definition "instantiatesUri" : "<uri>", // C? R! Instantiates external protocol or definition "basedOn" : [{ Reference(Resource) }], // C?Fulfills plan, proposal, or order "replaces" : [{ Reference(Resource) }], // C?Request(s) replaced by this request "groupIdentifier" : { Identifier }, // C?Composite request this is part of "status" : "<code>", // C? R! draft | active | on-hold | revoked | completed | entered-in-error | unknown "intent" : "<code>", // C? R! proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option "priority" : "<code>", // C?routine | urgent | asap | stat "code" : { CodeableConcept }, // C?What's being requested/ordered "subject" : { Reference(Patient) }, // C?Who the request group is about "encounter" : { Reference(Encounter) }, // C?Created as part of "authoredOn" : "<dateTime>", // C?When the request group was authored "author" : { Reference(Device) }, // C?Device or practitioner that authored the request group "reason" : [{ CodeableReference(Condition) }], // C?Why the request group is needed "note" : [{ Annotation }], // C?Additional notes about the response "action" : [{ BackboneElement }] // C?Proposed actions, if any }
This structure is derived from RequestGroup.
Differential View
This structure is derived from RequestGroup.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
RequestGroup | 1..1 | RequestGroup | A group of related requests | |
identifier | 1..1 | Identifier | Business identifier | |
instantiatesUri | 1..1 | uri | Instantiates external protocol or definition | |
priority | S | 0..1 | code | routine | urgent | asap | stat |
subject | S | 0..1 | Reference(Patient | Group) | Who the request group is about |
authoredOn | S | 0..1 | dateTime | When the request group was authored |
author | S | 0..1 | Reference(Device | Practitioner | PractitionerRole) | Device or practitioner that authored the request group |
action | 0..* | BackboneElement | Proposed actions, if any | |
title | S | 0..1 | string | User-visible title |
description | S | 0..1 | string | Short description of the action |
priority | S | 0..1 | code | routine | urgent | asap | stat |
documentation | S | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action |
condition | S | 0..* | BackboneElement | Whether or not the action is applicable |
timing[x] | S | 0..1 | dateTime, Age, Period, Duration, Range, Timing | When the action should take place |
participant | S | 0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device) | Who should perform the action |
type | S | 0..1 | CodeableConcept | create | update | remove | fire-event |
selectionBehavior | S | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more |
resource | S | 0..1 | Reference(Resource) | The target of the action |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
RequestGroup | I | 1..1 | RequestGroup | A group of related requests |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: Common Languages (preferred) Max Binding: All Languages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
identifier | ΣI | 1..1 | Identifier | Business identifier |
instantiatesCanonical | ΣI | 0..* | canonical() | Instantiates FHIR protocol or definition |
instantiatesUri | ΣI | 1..1 | uri | Instantiates external protocol or definition |
basedOn | I | 0..* | Reference(Resource) | Fulfills plan, proposal, or order |
replaces | I | 0..* | Reference(Resource) | Request(s) replaced by this request |
groupIdentifier | ΣI | 0..1 | Identifier | Composite request this is part of |
status | ?!ΣI | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required) |
intent | ?!ΣI | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required) |
priority | SΣI | 0..1 | code | routine | urgent | asap | stat Binding: Request priority (required) |
code | ΣI | 0..1 | CodeableConcept | What's being requested/ordered |
subject | SI | 0..1 | Reference(Patient | Group) | Who the request group is about |
encounter | I | 0..1 | Reference(Encounter) | Created as part of |
authoredOn | SI | 0..1 | dateTime | When the request group was authored |
author | SI | 0..1 | Reference(Device | Practitioner | PractitionerRole) | Device or practitioner that authored the request group |
reason | I | 0..* | CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference) | Why the request group is needed |
note | I | 0..* | Annotation | Additional notes about the response |
action | I | 0..* | BackboneElement | Proposed actions, if any |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
prefix | I | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) |
title | SI | 0..1 | string | User-visible title |
description | SΣI | 0..1 | string | Short description of the action |
textEquivalent | ΣI | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system |
priority | SI | 0..1 | code | routine | urgent | asap | stat Binding: Request priority (required) |
code | I | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions |
documentation | SI | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action |
condition | SI | 0..* | BackboneElement | Whether or not the action is applicable |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
kind | I | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required) |
expression | I | 0..1 | Expression | Boolean-valued expression |
relatedAction | I | 0..* | BackboneElement | Relationship to another action |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
actionId | I | 1..1 | id | What action this is related to |
relationship | I | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required) |
offset[x] | I | 0..1 | Time offset for the relationship | |
offsetDuration | Duration | |||
offsetRange | Range | |||
timing[x] | SI | 0..1 | When the action should take place | |
timingDateTime | dateTime | |||
timingAge | Age | |||
timingPeriod | Period | |||
timingDuration | Duration | |||
timingRange | Range | |||
timingTiming | Timing | |||
participant | SI | 0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device) | Who should perform the action |
type | SI | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible) |
groupingBehavior | I | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required) |
selectionBehavior | SI | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required) |
requiredBehavior | I | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required) |
precheckBehavior | I | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required) |
cardinalityBehavior | I | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required) |
resource | SI | 0..1 | Reference(Resource) | The target of the action |
action | I | 0..* | Unknown reference to #RequestGroup.action Sub action | |
Documentation for this format |
XML Template
<!-- CDS Hooks RequestGroup --> <RequestGroup xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- 0..1 Language of the resource content --> <text><!-- 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored --></modifierExtension> <identifier><!-- 1..1 Identifier Business identifier --></identifier> <instantiatesCanonical value="[canonical]"/><!-- 0..* Instantiates FHIR protocol or definition --> <instantiatesUri value="[uri]"/><!-- 1..1 Instantiates external protocol or definition --> <basedOn><!-- 0..* Reference(Resource) Fulfills plan, proposal, or order --></basedOn> <replaces><!-- 0..* Reference(Resource) Request(s) replaced by this request --></replaces> <groupIdentifier><!-- 0..1 Identifier Composite request this is part of --></groupIdentifier> <status value="[code]"/><!-- 1..1 draft | active | on-hold | revoked | completed | entered-in-error | unknown --> <intent value="[code]"/><!-- 1..1 proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option --> <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat --> <code><!-- 0..1 CodeableConcept What's being requested/ordered --></code> <subject><!-- 0..1 Reference(Patient) Who the request group is about --></subject> <encounter><!-- 0..1 Reference(Encounter) Created as part of --></encounter> <authoredOn value="[dateTime]"/><!-- 0..1 When the request group was authored --> <author><!-- 0..1 Reference(Device) Device or practitioner that authored the request group --></author> <reason><!-- 0..* CodeableReference Why the request group is needed --></reason> <note><!-- 0..* Annotation Additional notes about the response --></note> <action> 0..* BackboneElement <!-- 0..* Proposed actions, if any --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <prefix value="[string]"/><!-- 0..1 User-visible prefix for the action (e.g. 1. or A.) --> <title value="[string]"/><!-- 0..1 User-visible title --> <description value="[string]"/><!-- 0..1 Short description of the action --> <textEquivalent value="[string]"/><!-- 0..1 Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system --> <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat --> <code><!-- 0..* CodeableConcept Code representing the meaning of the action or sub-actions --></code> <documentation><!-- 0..* RelatedArtifact Supporting documentation for the intended performer of the action --></documentation> <condition> 0..* BackboneElement <!-- 0..* Whether or not the action is applicable --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <kind value="[code]"/><!-- 1..1 applicability | start | stop --> <expression><!-- 0..1 Expression Boolean-valued expression --></expression> </condition> <relatedAction> 0..* BackboneElement <!-- 0..* Relationship to another action --> <modifierExtension><!-- 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <actionId value="[id]"/><!-- 1..1 What action this is related to --> <relationship value="[code]"/><!-- 1..1 before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end --> <offset[x]><!-- 0..1 Duration|Range Time offset for the relationship --></offset[x]> </relatedAction> <timing[x]><!-- 0..1 dateTime|Age|Period|Duration|Range| Timing When the action should take place --></timing[x]> <participant><!-- 0..* Reference(Patient) Who should perform the action --></participant> <type><!-- 0..1 CodeableConcept create | update | remove | fire-event --></type> <groupingBehavior value="[code]"/><!-- 0..1 visual-group | logical-group | sentence-group --> <selectionBehavior value="[code]"/><!-- 0..1 any | all | all-or-none | exactly-one | at-most-one | one-or-more --> <requiredBehavior value="[code]"/><!-- 0..1 must | could | must-unless-documented --> <precheckBehavior value="[code]"/><!-- 0..1 yes | no --> <cardinalityBehavior value="[code]"/><!-- 0..1 single | multiple --> <resource><!-- 0..1 Reference(Resource) The target of the action --></resource> <action><!-- See #RequestGroup.action Sub action --></action> </action> </RequestGroup>
JSON Template
{ // CDS Hooks RequestGroup // from Element: extension "meta" : { Meta }, // C?Metadata about the resource "implicitRules" : "<uri>", // C?A set of rules under which this content was created "language" : "<code>", // C?Language of the resource content "text" : { Narrative }, // C?Text summary of the resource, for human interpretation "contained" : [{ Resource }], //Contained, inline Resources "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored "identifier" : { Identifier }, // C? R! Business identifier "instantiatesCanonical" : ["<canonical>"], // C?Instantiates FHIR protocol or definition "instantiatesUri" : "<uri>", // C? R! Instantiates external protocol or definition "basedOn" : [{ Reference(Resource) }], // C?Fulfills plan, proposal, or order "replaces" : [{ Reference(Resource) }], // C?Request(s) replaced by this request "groupIdentifier" : { Identifier }, // C?Composite request this is part of "status" : "<code>", // C? R! draft | active | on-hold | revoked | completed | entered-in-error | unknown "intent" : "<code>", // C? R! proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option "priority" : "<code>", // C?routine | urgent | asap | stat "code" : { CodeableConcept }, // C?What's being requested/ordered "subject" : { Reference(Patient) }, // C?Who the request group is about "encounter" : { Reference(Encounter) }, // C?Created as part of "authoredOn" : "<dateTime>", // C?When the request group was authored "author" : { Reference(Device) }, // C?Device or practitioner that authored the request group "reason" : [{ CodeableReference(Condition) }], // C?Why the request group is needed "note" : [{ Annotation }], // C?Additional notes about the response "action" : [{ BackboneElement }] // C?Proposed actions, if any }
Alternate definitions: Master Definition (XML, JSON), Schematron
Path | Name | Conformance | ValueSet |
RequestGroup.language | Common Languages | preferred | Common Languages |
RequestGroup.status | RequestStatus | required | RequestStatus |
RequestGroup.intent | RequestIntent | required | RequestIntent |
RequestGroup.priority | Request priority | required | Request priority |
RequestGroup.action.priority | Request priority | required | Request priority |
RequestGroup.action.condition.kind | ActionConditionKind | required | ActionConditionKind |
RequestGroup.action.relatedAction.relationship | ActionRelationshipType | required | ActionRelationshipType |
RequestGroup.action.type | ActionType | extensible | ActionType |
RequestGroup.action.groupingBehavior | ActionGroupingBehavior | required | ActionGroupingBehavior |
RequestGroup.action.selectionBehavior | ActionSelectionBehavior | required | ActionSelectionBehavior |
RequestGroup.action.requiredBehavior | ActionRequiredBehavior | required | ActionRequiredBehavior |
RequestGroup.action.precheckBehavior | ActionPrecheckBehavior | required | ActionPrecheckBehavior |
RequestGroup.action.cardinalityBehavior | ActionCardinalityBehavior | required | ActionCardinalityBehavior |