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![]() |
|---|---|---|---|---|
![]() | 1..1 | |||
![]() ![]() | 1..1 | Identifier | ||
![]() ![]() | 1..1 | uri | ||
![]() ![]() | S | 0..1 | code | |
![]() ![]() | S | 0..1 | Reference(Patient | Group) | |
![]() ![]() | S | 0..1 | dateTime | |
![]() ![]() | S | 0..1 | Reference(Device | Practitioner | PractitionerRole) | |
![]() ![]() | 0..* | BackboneElement | ||
![]() ![]() ![]() | S | 0..1 | string | |
![]() ![]() ![]() | S | 0..1 | string | |
![]() ![]() ![]() | S | 0..1 | code | |
![]() ![]() ![]() | S | 0..* | RelatedArtifact | |
![]() ![]() ![]() | S | 0..* | BackboneElement | |
![]() ![]() ![]() | S | 0..1 | dateTime, Age, Period, Duration, Range, Timing | |
![]() ![]() ![]() | S | 0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device) | |
![]() ![]() ![]() | S | 0..1 | CodeableConcept | |
![]() ![]() ![]() | S | 0..1 | code | |
![]() ![]() ![]() | S | 0..1 | Reference(Resource) | |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | I | 1..1 | A group of related requests | |
![]() ![]() | Σ | 0..1 | id | Logical id of this artifact |
![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() | 0..1 | code | Language of the resource content Binding: Common Languages (preferred) | |
![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
![]() ![]() | 0..* | Resource | Contained, inline Resources | |
![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() | Σ | 1..1 | Identifier | Business identifier |
![]() ![]() | Σ | 0..* | canonical() | Instantiates FHIR protocol or definition |
![]() ![]() | Σ | 1..1 | uri | Instantiates external protocol or definition |
![]() ![]() | 0..* | Reference(Resource) | Fulfills plan, proposal, or order | |
![]() ![]() | 0..* | Reference(Resource) | Request(s) replaced by this request | |
![]() ![]() | Σ | 0..1 | Identifier | Composite request this is part of |
![]() ![]() | ?!Σ | 1..1 | code | draft | active | suspended | cancelled | completed | entered-in-error | unknown Binding: RequestStatus (required) |
![]() ![]() | ?!Σ | 1..1 | code | proposal | plan | order Binding: RequestIntent (required) |
![]() ![]() | SΣ | 0..1 | code | routine | urgent | asap | stat Binding: Request priority (required) |
![]() ![]() | Σ | 0..1 | CodeableConcept | What's being requested/ordered |
![]() ![]() | S | 0..1 | Reference(Patient | Group) | Who the request group is about |
![]() ![]() | 0..1 | Reference(Encounter) | Created as part of | |
![]() ![]() | S | 0..1 | dateTime | When the request group was authored |
![]() ![]() | S | 0..1 | Reference(Device | Practitioner | PractitionerRole) | Device or practitioner that authored the request group |
![]() ![]() | 0..* | CodeableConcept | Why the request group is needed | |
![]() ![]() | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why the request group is needed | |
![]() ![]() | 0..* | Annotation | Additional notes about the response | |
![]() ![]() | I | 0..* | BackboneElement | Proposed actions, if any |
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) | |
![]() ![]() ![]() | S | 0..1 | string | User-visible title |
![]() ![]() ![]() | SΣ | 0..1 | string | Short description of the action |
![]() ![]() ![]() | Σ | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system |
![]() ![]() ![]() | S | 0..1 | code | routine | urgent | asap | stat Binding: Request priority (required) |
![]() ![]() ![]() | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions | |
![]() ![]() ![]() | S | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action |
![]() ![]() ![]() | SI | 0..* | BackboneElement | Whether or not the action is applicable |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required) | |
![]() ![]() ![]() ![]() | 0..1 | Expression | Boolean-valued expression | |
![]() ![]() ![]() | I | 0..* | BackboneElement | Relationship to another action |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 1..1 | id | What action this is related to | |
![]() ![]() ![]() ![]() | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required) | |
![]() ![]() ![]() ![]() | 0..1 | Duration, Range | Time offset for the relationship | |
![]() ![]() ![]() | S | 0..1 | dateTime, Age, Period, Duration, Range, Timing | When the action should take place |
![]() ![]() ![]() | S | 0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device) | Who should perform the action |
![]() ![]() ![]() | S | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible) |
![]() ![]() ![]() | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required) | |
![]() ![]() ![]() | S | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required) |
![]() ![]() ![]() | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required) | |
![]() ![]() ![]() | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required) | |
![]() ![]() ![]() | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required) | |
![]() ![]() ![]() | SI | 0..1 | Reference(Resource) | The target of the 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 | suspended | cancelled | completed | entered-in-error | unknown --> <intent value="[code]"/><!-- 1..1 proposal | plan | order --> <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> <reasonCode><!-- 0..* CodeableConcept Why the request group is needed --></reasonCode> <reasonReference><!-- 0..* Reference(Condition) Why the request group is needed --></reasonReference> <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 }, //Metadata about the resource
"implicitRules" : "<uri>", //A set of rules under which this content was created
"language" : "<code>", //Language of the resource content
"text" : { Narrative }, //Text summary of the resource, for human interpretation
"contained" : [{ Resource }], //Contained, inline Resources
"modifierExtension" : [{ Extension }], //Extensions that cannot be ignored
"identifier" : { Identifier }, // R! Business identifier
"instantiatesCanonical" : ["<canonical>"], //Instantiates FHIR protocol or definition
"instantiatesUri" : "<uri>", // R! Instantiates external protocol or definition
"basedOn" : [{ Reference(Resource) }], //Fulfills plan, proposal, or order
"replaces" : [{ Reference(Resource) }], //Request(s) replaced by this request
"groupIdentifier" : { Identifier }, //Composite request this is part of
"status" : "<code>", // R! draft | active | suspended | cancelled | completed | entered-in-error | unknown
"intent" : "<code>", // R! proposal | plan | order
"priority" : "<code>", //routine | urgent | asap | stat
"code" : { CodeableConcept }, //What's being requested/ordered
"subject" : { Reference(Patient) }, //Who the request group is about
"encounter" : { Reference(Encounter) }, //Created as part of
"authoredOn" : "<dateTime>", //When the request group was authored
"author" : { Reference(Device) }, //Device or practitioner that authored the request group
"reasonCode" : [{ CodeableConcept }], //Why the request group is needed
"reasonReference" : [{ Reference(Condition) }], //Why the request group is needed
"note" : [{ Annotation }], //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![]() |
|---|---|---|---|---|
![]() | 1..1 | |||
![]() ![]() | 1..1 | Identifier | ||
![]() ![]() | 1..1 | uri | ||
![]() ![]() | S | 0..1 | code | |
![]() ![]() | S | 0..1 | Reference(Patient | Group) | |
![]() ![]() | S | 0..1 | dateTime | |
![]() ![]() | S | 0..1 | Reference(Device | Practitioner | PractitionerRole) | |
![]() ![]() | 0..* | BackboneElement | ||
![]() ![]() ![]() | S | 0..1 | string | |
![]() ![]() ![]() | S | 0..1 | string | |
![]() ![]() ![]() | S | 0..1 | code | |
![]() ![]() ![]() | S | 0..* | RelatedArtifact | |
![]() ![]() ![]() | S | 0..* | BackboneElement | |
![]() ![]() ![]() | S | 0..1 | dateTime, Age, Period, Duration, Range, Timing | |
![]() ![]() ![]() | S | 0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device) | |
![]() ![]() ![]() | S | 0..1 | CodeableConcept | |
![]() ![]() ![]() | S | 0..1 | code | |
![]() ![]() ![]() | S | 0..1 | Reference(Resource) | |
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | I | 1..1 | A group of related requests | |
![]() ![]() | Σ | 0..1 | id | Logical id of this artifact |
![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() | 0..1 | code | Language of the resource content Binding: Common Languages (preferred) | |
![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
![]() ![]() | 0..* | Resource | Contained, inline Resources | |
![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() | Σ | 1..1 | Identifier | Business identifier |
![]() ![]() | Σ | 0..* | canonical() | Instantiates FHIR protocol or definition |
![]() ![]() | Σ | 1..1 | uri | Instantiates external protocol or definition |
![]() ![]() | 0..* | Reference(Resource) | Fulfills plan, proposal, or order | |
![]() ![]() | 0..* | Reference(Resource) | Request(s) replaced by this request | |
![]() ![]() | Σ | 0..1 | Identifier | Composite request this is part of |
![]() ![]() | ?!Σ | 1..1 | code | draft | active | suspended | cancelled | completed | entered-in-error | unknown Binding: RequestStatus (required) |
![]() ![]() | ?!Σ | 1..1 | code | proposal | plan | order Binding: RequestIntent (required) |
![]() ![]() | SΣ | 0..1 | code | routine | urgent | asap | stat Binding: Request priority (required) |
![]() ![]() | Σ | 0..1 | CodeableConcept | What's being requested/ordered |
![]() ![]() | S | 0..1 | Reference(Patient | Group) | Who the request group is about |
![]() ![]() | 0..1 | Reference(Encounter) | Created as part of | |
![]() ![]() | S | 0..1 | dateTime | When the request group was authored |
![]() ![]() | S | 0..1 | Reference(Device | Practitioner | PractitionerRole) | Device or practitioner that authored the request group |
![]() ![]() | 0..* | CodeableConcept | Why the request group is needed | |
![]() ![]() | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why the request group is needed | |
![]() ![]() | 0..* | Annotation | Additional notes about the response | |
![]() ![]() | I | 0..* | BackboneElement | Proposed actions, if any |
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) | |
![]() ![]() ![]() | S | 0..1 | string | User-visible title |
![]() ![]() ![]() | SΣ | 0..1 | string | Short description of the action |
![]() ![]() ![]() | Σ | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system |
![]() ![]() ![]() | S | 0..1 | code | routine | urgent | asap | stat Binding: Request priority (required) |
![]() ![]() ![]() | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions | |
![]() ![]() ![]() | S | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action |
![]() ![]() ![]() | SI | 0..* | BackboneElement | Whether or not the action is applicable |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required) | |
![]() ![]() ![]() ![]() | 0..1 | Expression | Boolean-valued expression | |
![]() ![]() ![]() | I | 0..* | BackboneElement | Relationship to another action |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 1..1 | id | What action this is related to | |
![]() ![]() ![]() ![]() | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required) | |
![]() ![]() ![]() ![]() | 0..1 | Duration, Range | Time offset for the relationship | |
![]() ![]() ![]() | S | 0..1 | dateTime, Age, Period, Duration, Range, Timing | When the action should take place |
![]() ![]() ![]() | S | 0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device) | Who should perform the action |
![]() ![]() ![]() | S | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible) |
![]() ![]() ![]() | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required) | |
![]() ![]() ![]() | S | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required) |
![]() ![]() ![]() | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required) | |
![]() ![]() ![]() | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required) | |
![]() ![]() ![]() | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required) | |
![]() ![]() ![]() | SI | 0..1 | Reference(Resource) | The target of the 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 | suspended | cancelled | completed | entered-in-error | unknown --> <intent value="[code]"/><!-- 1..1 proposal | plan | order --> <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> <reasonCode><!-- 0..* CodeableConcept Why the request group is needed --></reasonCode> <reasonReference><!-- 0..* Reference(Condition) Why the request group is needed --></reasonReference> <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 }, //Metadata about the resource
"implicitRules" : "<uri>", //A set of rules under which this content was created
"language" : "<code>", //Language of the resource content
"text" : { Narrative }, //Text summary of the resource, for human interpretation
"contained" : [{ Resource }], //Contained, inline Resources
"modifierExtension" : [{ Extension }], //Extensions that cannot be ignored
"identifier" : { Identifier }, // R! Business identifier
"instantiatesCanonical" : ["<canonical>"], //Instantiates FHIR protocol or definition
"instantiatesUri" : "<uri>", // R! Instantiates external protocol or definition
"basedOn" : [{ Reference(Resource) }], //Fulfills plan, proposal, or order
"replaces" : [{ Reference(Resource) }], //Request(s) replaced by this request
"groupIdentifier" : { Identifier }, //Composite request this is part of
"status" : "<code>", // R! draft | active | suspended | cancelled | completed | entered-in-error | unknown
"intent" : "<code>", // R! proposal | plan | order
"priority" : "<code>", //routine | urgent | asap | stat
"code" : { CodeableConcept }, //What's being requested/ordered
"subject" : { Reference(Patient) }, //Who the request group is about
"encounter" : { Reference(Encounter) }, //Created as part of
"authoredOn" : "<dateTime>", //When the request group was authored
"author" : { Reference(Device) }, //Device or practitioner that authored the request group
"reasonCode" : [{ CodeableConcept }], //Why the request group is needed
"reasonReference" : [{ Reference(Condition) }], //Why the request group is needed
"note" : [{ Annotation }], //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 |