Release 5 Preview #2
Clinical Decision Support Work Group Maturity Level: 1Trial 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.

Summary

Mandatory: 2 elements
Must-Support: 14 elements

This structure is derived from RequestGroup.

NameFlagsCard.TypeDescription & Constraintsdoco
.. RequestGroup 1..1RequestGroupA group of related requests
... identifier 1..1IdentifierBusiness identifier
... instantiatesUri 1..1uriInstantiates external protocol or definition
... priority S0..1coderoutine | urgent | asap | stat
... authoredOn S0..1dateTimeWhen the request group was authored
... author S0..1Reference(Device | Practitioner | PractitionerRole)Device or practitioner that authored the request group
... action 0..*BackboneElementProposed actions, if any
.... title S0..1stringUser-visible title
.... description S0..1stringShort description of the action
.... priority S0..1coderoutine | urgent | asap | stat
.... documentation S0..*RelatedArtifactSupporting documentation for the intended performer of the action
.... condition S0..*BackboneElementWhether or not the action is applicable
.... timing[x] S0..1dateTime, Age, Period, Duration, Range, TimingWhen the action should take place
.... participant S0..*Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device)Who should perform the action
.... type S0..1CodeableConceptcreate | update | remove | fire-event
.... selectionBehavior S0..1codeany | all | all-or-none | exactly-one | at-most-one | one-or-more
.... resource S0..1Reference(Resource)The target of the action

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. RequestGroup I1..1RequestGroupA group of related requests
... id Σ0..1idLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI1..1IdentifierBusiness identifier
... instantiatesCanonical ΣI0..*canonical()Instantiates FHIR protocol or definition
... instantiatesUri ΣI1..1uriInstantiates external protocol or definition
... basedOn I0..*Reference(Resource)Fulfills plan, proposal, or order
... replaces I0..*Reference(Resource)Request(s) replaced by this request
... groupIdentifier ΣI0..1IdentifierComposite request this is part of
... status ?!ΣI1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required)
... intent ?!ΣI1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required)
... priority SΣI0..1coderoutine | urgent | asap | stat
Binding: Request priority (required)
... code ΣI0..1CodeableConceptWhat's being requested/ordered
... subject SI0..1Reference(Patient | Group)Who the request group is about
... encounter I0..1Reference(Encounter)Created as part of
... authoredOn SI0..1dateTimeWhen the request group was authored
... author SI0..1Reference(Device | Practitioner | PractitionerRole)Device or practitioner that authored the request group
... reason I0..*CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference)Why the request group is needed
... note I0..*AnnotationAdditional notes about the response
... action I0..*BackboneElementProposed actions, if any
.... id 0..1idUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... prefix I0..1stringUser-visible prefix for the action (e.g. 1. or A.)
.... title SI0..1stringUser-visible title
.... description SΣI0..1stringShort description of the action
.... textEquivalent ΣI0..1stringStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
.... priority SI0..1coderoutine | urgent | asap | stat
Binding: Request priority (required)
.... code I0..*CodeableConceptCode representing the meaning of the action or sub-actions
.... documentation SI0..*RelatedArtifactSupporting documentation for the intended performer of the action
.... condition SI0..*BackboneElementWhether or not the action is applicable
..... id 0..1idUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... kind I1..1codeapplicability | start | stop
Binding: ActionConditionKind (required)
..... expression I0..1ExpressionBoolean-valued expression
.... relatedAction I0..*BackboneElementRelationship to another action
..... id 0..1idUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... actionId I1..1idWhat action this is related to
..... relationship I1..1codebefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Binding: ActionRelationshipType (required)
..... offset[x] I0..1Time offset for the relationship
...... offsetDurationDuration
...... offsetRangeRange
.... timing[x] SI0..1When the action should take place
..... timingDateTimedateTime
..... timingAgeAge
..... timingPeriodPeriod
..... timingDurationDuration
..... timingRangeRange
..... timingTimingTiming
.... participant SI0..*Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device)Who should perform the action
.... type SI0..1CodeableConceptcreate | update | remove | fire-event
Binding: ActionType (extensible)
.... groupingBehavior I0..1codevisual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior (required)
.... selectionBehavior SI0..1codeany | all | all-or-none | exactly-one | at-most-one | one-or-more
Binding: ActionSelectionBehavior (required)
.... requiredBehavior I0..1codemust | could | must-unless-documented
Binding: ActionRequiredBehavior (required)
.... precheckBehavior I0..1codeyes | no
Binding: ActionPrecheckBehavior (required)
.... cardinalityBehavior I0..1codesingle | multiple
Binding: ActionCardinalityBehavior (required)
.... resource SI0..1Reference(Resource)The target of the action
.... action I0..*See actionSub action

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

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

Summary

Mandatory: 2 elements
Must-Support: 14 elements

Differential View

This structure is derived from RequestGroup.

NameFlagsCard.TypeDescription & Constraintsdoco
.. RequestGroup 1..1RequestGroupA group of related requests
... identifier 1..1IdentifierBusiness identifier
... instantiatesUri 1..1uriInstantiates external protocol or definition
... priority S0..1coderoutine | urgent | asap | stat
... authoredOn S0..1dateTimeWhen the request group was authored
... author S0..1Reference(Device | Practitioner | PractitionerRole)Device or practitioner that authored the request group
... action 0..*BackboneElementProposed actions, if any
.... title S0..1stringUser-visible title
.... description S0..1stringShort description of the action
.... priority S0..1coderoutine | urgent | asap | stat
.... documentation S0..*RelatedArtifactSupporting documentation for the intended performer of the action
.... condition S0..*BackboneElementWhether or not the action is applicable
.... timing[x] S0..1dateTime, Age, Period, Duration, Range, TimingWhen the action should take place
.... participant S0..*Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device)Who should perform the action
.... type S0..1CodeableConceptcreate | update | remove | fire-event
.... selectionBehavior S0..1codeany | all | all-or-none | exactly-one | at-most-one | one-or-more
.... resource S0..1Reference(Resource)The target of the action

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RequestGroup I1..1RequestGroupA group of related requests
... id Σ0..1idLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI1..1IdentifierBusiness identifier
... instantiatesCanonical ΣI0..*canonical()Instantiates FHIR protocol or definition
... instantiatesUri ΣI1..1uriInstantiates external protocol or definition
... basedOn I0..*Reference(Resource)Fulfills plan, proposal, or order
... replaces I0..*Reference(Resource)Request(s) replaced by this request
... groupIdentifier ΣI0..1IdentifierComposite request this is part of
... status ?!ΣI1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required)
... intent ?!ΣI1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required)
... priority SΣI0..1coderoutine | urgent | asap | stat
Binding: Request priority (required)
... code ΣI0..1CodeableConceptWhat's being requested/ordered
... subject SI0..1Reference(Patient | Group)Who the request group is about
... encounter I0..1Reference(Encounter)Created as part of
... authoredOn SI0..1dateTimeWhen the request group was authored
... author SI0..1Reference(Device | Practitioner | PractitionerRole)Device or practitioner that authored the request group
... reason I0..*CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference)Why the request group is needed
... note I0..*AnnotationAdditional notes about the response
... action I0..*BackboneElementProposed actions, if any
.... id 0..1idUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... prefix I0..1stringUser-visible prefix for the action (e.g. 1. or A.)
.... title SI0..1stringUser-visible title
.... description SΣI0..1stringShort description of the action
.... textEquivalent ΣI0..1stringStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
.... priority SI0..1coderoutine | urgent | asap | stat
Binding: Request priority (required)
.... code I0..*CodeableConceptCode representing the meaning of the action or sub-actions
.... documentation SI0..*RelatedArtifactSupporting documentation for the intended performer of the action
.... condition SI0..*BackboneElementWhether or not the action is applicable
..... id 0..1idUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... kind I1..1codeapplicability | start | stop
Binding: ActionConditionKind (required)
..... expression I0..1ExpressionBoolean-valued expression
.... relatedAction I0..*BackboneElementRelationship to another action
..... id 0..1idUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... actionId I1..1idWhat action this is related to
..... relationship I1..1codebefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Binding: ActionRelationshipType (required)
..... offset[x] I0..1Time offset for the relationship
...... offsetDurationDuration
...... offsetRangeRange
.... timing[x] SI0..1When the action should take place
..... timingDateTimedateTime
..... timingAgeAge
..... timingPeriodPeriod
..... timingDurationDuration
..... timingRangeRange
..... timingTimingTiming
.... participant SI0..*Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device)Who should perform the action
.... type SI0..1CodeableConceptcreate | update | remove | fire-event
Binding: ActionType (extensible)
.... groupingBehavior I0..1codevisual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior (required)
.... selectionBehavior SI0..1codeany | all | all-or-none | exactly-one | at-most-one | one-or-more
Binding: ActionSelectionBehavior (required)
.... requiredBehavior I0..1codemust | could | must-unless-documented
Binding: ActionRequiredBehavior (required)
.... precheckBehavior I0..1codeyes | no
Binding: ActionPrecheckBehavior (required)
.... cardinalityBehavior I0..1codesingle | multiple
Binding: ActionCardinalityBehavior (required)
.... resource SI0..1Reference(Resource)The target of the action
.... action I0..*See actionSub action

doco Documentation for this format

XML Template

<!-- CDS Hooks RequestGroup -->doco

<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

PathNameConformanceValueSet
RequestGroup.languageCommon LanguagespreferredCommon Languages
RequestGroup.statusRequestStatusrequiredRequestStatus
RequestGroup.intentRequestIntentrequiredRequestIntent
RequestGroup.priorityRequest priorityrequiredRequest priority
RequestGroup.action.priorityRequest priorityrequiredRequest priority
RequestGroup.action.condition.kindActionConditionKindrequiredActionConditionKind
RequestGroup.action.relatedAction.relationshipActionRelationshipTyperequiredActionRelationshipType
RequestGroup.action.typeActionTypeextensibleActionType
RequestGroup.action.groupingBehaviorActionGroupingBehaviorrequiredActionGroupingBehavior
RequestGroup.action.selectionBehaviorActionSelectionBehaviorrequiredActionSelectionBehavior
RequestGroup.action.requiredBehaviorActionRequiredBehaviorrequiredActionRequiredBehavior
RequestGroup.action.precheckBehaviorActionPrecheckBehaviorrequiredActionPrecheckBehavior
RequestGroup.action.cardinalityBehaviorActionCardinalityBehaviorrequiredActionCardinalityBehavior
.