Release 4 5 Snapshot #1

This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always be available at this URL). (v5.0.0-snapshot1: R5 Snapshot #1). 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 0 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] Thu, Jan 1, 1970 00:00+1000 as a draft by HL7.

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work .

This structure is derived from RequestGroup .

Summary

Mandatory: 2 elements
Must-Support: 14 elements

This structure is derived from RequestGroup .

Name Flags Card. Type Description & Constraints doco
. . 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
. . . 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 BackboneElement ) 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

doco Documentation for this format
I I I I I Unknown reference to #RequestGroup.action
Name Flags Card. Type Description & Constraints doco
. . RequestGroup I 1..1 RequestGroup A group of related requests
. . . id Σ 0..1 string 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
. . . 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 ) ): Codes identifying the lifecycle stage of a request.

. . . intent ?! Σ I 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent ( required ) ): Codes indicating the degree of authority/intentionality associated with a request.

. . . priority S Σ I 0..1 code routine | urgent | asap | stat
Binding: Request priority RequestPriority ( required ) ): Identifies the level of importance to be assigned to actioning the request.

. . . code Σ I 0..1 CodeableConcept What's being requested/ordered
Binding: ActionCode ( example )
. . . subject S I 0..1 Reference ( Patient | Group ) Who the request group is about
. . . encounter I 0..1 Reference ( Encounter ) Created as part of
. . . authoredOn S I 0..1 dateTime When the request group was authored
. . . author S I 0..1 Reference ( Device | Practitioner | PractitionerRole ) Device or practitioner that authored the request group
. . reasonCode . reason I 0..* CodeableConcept CodeableReference ( Condition | Observation | DiagnosticReport | DocumentReference ) Why the request group is needed
Binding: ActionReasonCode ( example )
. . . reasonReference goal I 0..* Reference ( Condition | Observation | DiagnosticReport | DocumentReference Goal ) Why the request group is needed What goals
. . . note I 0..* Annotation Additional notes about the response
. . . action I 0..* BackboneElement Proposed actions, if any
. . . . id 0..1 string 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 linkId I 0..1 string Pointer to specific item from the PlanDefinition
.... prefix 0..1 string User-visible prefix for the action (e.g. 1. or A.)
. . . . title S I 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 S I 0..1 code routine | urgent | asap | stat
Binding: Request priority RequestPriority ( required ) ): Identifies the level of importance to be assigned to actioning the request.

. . . . code 0..* CodeableConcept Code representing the meaning of the action or sub-actions
Binding: ActionCode ( example )
. . . . documentation S I 0..* RelatedArtifact Supporting documentation for the intended performer of the action
. . . . goal 0..* Reference ( Goal ) What goals
... . condition S I 0..* BackboneElement Whether or not the action is applicable
. . . . . id 0..1 string 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 ) ): The kind of condition for the action.

. . . . . expression I 0..1 Expression Boolean-valued expression
. . . . relatedAction I 0..* BackboneElement Relationship to another action
. . . . . id 0..1 string 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 targetId 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 ) ): Defines the types of relationships between actions.

. . . . . offset[x] I 0..1 Time offset for the relationship
. . . . . . offsetDuration Duration
. . . . . . offsetRange Range
. . . . timing[x] S I 0..1 When the action should take place
. . . . . timingDateTime dateTime
. . . . . timingAge Age
. . . . . timingPeriod Period
. . . . . timingDuration Duration
. . . . . timingRange Range
. . . . . timingTiming Timing
. . . . location 0..1 CodeableReference ( Location ) Where it should happen
.... participant S I 0..* BackboneElement Who should perform the action
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 0..1 code careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ActionParticipantType ( required ): The type of participant in the activity.

..... typeReference 0..1 Reference ( CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Device ) Who should perform or what can participate
..... role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent, etc.
Binding: ActionParticipantRole ( example ): Defines roles played by participants for the action action.

. . . . . function 0..1 CodeableConcept E.g. Author, Reviewer, Witness, etc.
Binding: ActionParticipantFunction ( example )
..... actor 0..1 Reference ( CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson ) Who/what is participating?
.... type S I 0..1 CodeableConcept create | update | remove | fire-event
Binding: ActionType ( extensible ) ): The type of action to be performed.

. . . . groupingBehavior 0..1 code visual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior ( required ) ): Defines organization behavior of a group.

. . . . selectionBehavior S I 0..1 code any | all | all-or-none | exactly-one | at-most-one | one-or-more
Binding: ActionSelectionBehavior ( required ) ): Defines selection behavior of a group.

. . . . requiredBehavior 0..1 code must | could | must-unless-documented
Binding: ActionRequiredBehavior ( required ) ): Defines expectations around whether an action or action group is required.

. . . . precheckBehavior 0..1 code yes | no
Binding: ActionPrecheckBehavior ( required ) ): Defines selection frequency behavior for an action or group.

. . . . cardinalityBehavior 0..1 code single | multiple
Binding: ActionCardinalityBehavior ( required ) ): Defines behavior for an action or a group for how many times that item may be repeated.

. . . . resource S I 0..1 Reference ( Resource ) The target of the action
. . . . action I 0..* See action (RequestGroup) Sub action

doco Documentation for this format
<!-- CDS Hooks RequestGroup -->doco

<RequestGroup xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <</id>

 <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>

 <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>

 <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>
 <
     Why the request group is needed</reasonCode>
 <
     Why the request group is needed</reasonReference>

 <reason><!-- ?? 0..* CodeableReference Why the request group is needed   --></reason>
 <goal><!-- ?? 0..* Reference(Goal) What goals --></goal>

 <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>
  <

  <linkId value="[string]"/><!-- ?? 0..1 Pointer to specific item from the PlanDefinition -->
  <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 representing the meaning of the action or sub-actions</code>

  <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>
  <

  <goal><!-- ?? 0..* Reference(Goal) What goals --></goal>
  <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>
   <

   <targetId 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]>
  <
      Who should perform the action</participant>

  <location><!-- ?? 0..1 CodeableReference 
      Where it should happen --></location>
  <participant> ?? 0..* BackboneElement  <!-- ?? 0..* Who should perform the action -->
   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <type value="[code]"/><!-- ?? 0..1 careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson   -->
   <typeReference><!-- ?? 0..1 Reference(CareTeam) 
       Who or what can participate --></typeReference>
   <role><!-- ?? 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent, etc.    --></role>
   <function><!-- ?? 0..1 CodeableConcept E.g. Author, Reviewer, Witness, etc.   --></function>
   <actor><!-- ?? 0..1 Reference(CareTeam) 
       Who/what is participating? --></actor>
  </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>

  <action><!-- See http://hl7.org/fhir/StructureDefinition/RequestGroup#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
    "goal" : [{ Reference(Goal) }], // C?What goals

    "note" : [{ Annotation }], // C?Additional notes about the response
    "

    "action" : [{ BackboneElement }] // C?Proposed actions, if any

  }

This structure is derived from RequestGroup .

Summary

Mandatory: 2 elements
Must-Support: 14 elements

Differential View

This structure is derived from RequestGroup .

Name Flags Card. Type Description & Constraints doco
. . 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
. . . 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 BackboneElement ) 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

doco Documentation for this format

Snapshot View

I I I I I Unknown reference to #RequestGroup.action
Name Flags Card. Type Description & Constraints doco
. . RequestGroup I 1..1 RequestGroup A group of related requests
. . . id Σ 0..1 string 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
. . . 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 ) ): Codes identifying the lifecycle stage of a request.

. . . intent ?! Σ I 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent ( required ) ): Codes indicating the degree of authority/intentionality associated with a request.

. . . priority S Σ I 0..1 code routine | urgent | asap | stat
Binding: Request priority RequestPriority ( required ) ): Identifies the level of importance to be assigned to actioning the request.

. . . code Σ I 0..1 CodeableConcept What's being requested/ordered
Binding: ActionCode ( example )
. . . subject S I 0..1 Reference ( Patient | Group ) Who the request group is about
. . . encounter I 0..1 Reference ( Encounter ) Created as part of
. . . authoredOn S I 0..1 dateTime When the request group was authored
. . . author S I 0..1 Reference ( Device | Practitioner | PractitionerRole ) Device or practitioner that authored the request group
. . reasonCode . reason I 0..* CodeableConcept CodeableReference ( Condition | Observation | DiagnosticReport | DocumentReference ) Why the request group is needed
Binding: ActionReasonCode ( example )
. . . reasonReference goal I 0..* Reference ( Condition | Observation | DiagnosticReport | DocumentReference Goal ) Why the request group is needed What goals
. . . note I 0..* Annotation Additional notes about the response
. . . action I 0..* BackboneElement Proposed actions, if any
. . . . id 0..1 string 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 linkId I 0..1 string Pointer to specific item from the PlanDefinition
.... prefix 0..1 string User-visible prefix for the action (e.g. 1. or A.)
. . . . title S I 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 S I 0..1 code routine | urgent | asap | stat
Binding: Request priority RequestPriority ( required ) ): Identifies the level of importance to be assigned to actioning the request.

. . . . code 0..* CodeableConcept Code representing the meaning of the action or sub-actions
Binding: ActionCode ( example )
. . . . documentation S I 0..* RelatedArtifact Supporting documentation for the intended performer of the action
. . . . goal 0..* Reference ( Goal ) What goals
... . condition S I 0..* BackboneElement Whether or not the action is applicable
. . . . . id 0..1 string 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 ) ): The kind of condition for the action.

. . . . . expression I 0..1 Expression Boolean-valued expression
. . . . relatedAction I 0..* BackboneElement Relationship to another action
. . . . . id 0..1 string 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 targetId 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 ) ): Defines the types of relationships between actions.

. . . . . offset[x] I 0..1 Time offset for the relationship
. . . . . . offsetDuration Duration
. . . . . . offsetRange Range
. . . . timing[x] S I 0..1 When the action should take place
. . . . . timingDateTime dateTime
. . . . . timingAge Age
. . . . . timingPeriod Period
. . . . . timingDuration Duration
. . . . . timingRange Range
. . . . . timingTiming Timing
. . . . location 0..1 CodeableReference ( Location ) Where it should happen
.... participant S I 0..* BackboneElement Who should perform the action
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 0..1 code careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ActionParticipantType ( required ): The type of participant in the activity.

..... typeReference 0..1 Reference ( CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Device ) Who should perform or what can participate
..... role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent, etc.
Binding: ActionParticipantRole ( example ): Defines roles played by participants for the action action.

. . . . . function 0..1 CodeableConcept E.g. Author, Reviewer, Witness, etc.
Binding: ActionParticipantFunction ( example )
..... actor 0..1 Reference ( CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson ) Who/what is participating?
.... type S I 0..1 CodeableConcept create | update | remove | fire-event
Binding: ActionType ( extensible ) ): The type of action to be performed.

. . . . groupingBehavior 0..1 code visual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior ( required ) ): Defines organization behavior of a group.

. . . . selectionBehavior S I 0..1 code any | all | all-or-none | exactly-one | at-most-one | one-or-more
Binding: ActionSelectionBehavior ( required ) ): Defines selection behavior of a group.

. . . . requiredBehavior 0..1 code must | could | must-unless-documented
Binding: ActionRequiredBehavior ( required ) ): Defines expectations around whether an action or action group is required.

. . . . precheckBehavior 0..1 code yes | no
Binding: ActionPrecheckBehavior ( required ) ): Defines selection frequency behavior for an action or group.

. . . . cardinalityBehavior 0..1 code single | multiple
Binding: ActionCardinalityBehavior ( required ) ): Defines behavior for an action or a group for how many times that item may be repeated.

. . . . resource S I 0..1 Reference ( Resource ) The target of the action
. . . . action I 0..* See action (RequestGroup) Sub action

doco Documentation for this format

XML Template

<!-- CDS Hooks RequestGroup -->doco

<RequestGroup xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <</id>

 <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>

 <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>

 <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>
 <
     Why the request group is needed</reasonCode>
 <
     Why the request group is needed</reasonReference>

 <reason><!-- ?? 0..* CodeableReference Why the request group is needed   --></reason>
 <goal><!-- ?? 0..* Reference(Goal) What goals --></goal>

 <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>
  <

  <linkId value="[string]"/><!-- ?? 0..1 Pointer to specific item from the PlanDefinition -->
  <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 representing the meaning of the action or sub-actions</code>

  <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>
  <

  <goal><!-- ?? 0..* Reference(Goal) What goals --></goal>
  <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>
   <

   <targetId 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]>
  <
      Who should perform the action</participant>

  <location><!-- ?? 0..1 CodeableReference 
      Where it should happen --></location>
  <participant> ?? 0..* BackboneElement  <!-- ?? 0..* Who should perform the action -->
   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <type value="[code]"/><!-- ?? 0..1 careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson   -->
   <typeReference><!-- ?? 0..1 Reference(CareTeam) 
       Who or what can participate --></typeReference>
   <role><!-- ?? 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent, etc.    --></role>
   <function><!-- ?? 0..1 CodeableConcept E.g. Author, Reviewer, Witness, etc.   --></function>
   <actor><!-- ?? 0..1 Reference(CareTeam) 
       Who/what is participating? --></actor>
  </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>

  <action><!-- See http://hl7.org/fhir/StructureDefinition/RequestGroup#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
    "goal" : [{ Reference(Goal) }], // C?What goals

    "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 RequestPriority required Request priority RequestPriority
RequestGroup.code ActionCode example ActionCode
RequestGroup.reason ActionReasonCode example ActionReasonCode
RequestGroup.action.priority Request priority RequestPriority required Request priority RequestPriority
RequestGroup.action.code ActionCode example ActionCode
RequestGroup.action.condition.kind ActionConditionKind required ActionConditionKind
RequestGroup.action.relatedAction.relationship ActionRelationshipType required ActionRelationshipType
RequestGroup.action.participant.type ActionParticipantType required ActionParticipantType
RequestGroup.action.participant.role ActionParticipantRole example ActionParticipantRole
RequestGroup.action.participant.function ActionParticipantFunction example ActionParticipantFunction
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
.