Release 5 Draft Ballot

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions

Clinical Decision Support Work Group Maturity Level: 0Trial 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 Thu, Jan 1, 1970 00:00+0000 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..*BackboneElementWho 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 1..1RequestGroupA group of related requests
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..1IdentifierBusiness identifier
... instantiatesCanonical Σ0..*canonical()Instantiates FHIR protocol or definition
... instantiatesUri Σ1..1uriInstantiates external protocol or definition
... basedOn 0..*Reference(Resource)Fulfills plan, proposal, or order
... replaces 0..*Reference(Resource)Request(s) replaced by this request
... groupIdentifier Σ0..1IdentifierComposite request this is part of
... status ?!Σ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Codes identifying the lifecycle stage of a request.

... intent ?!Σ1..1codeproposal | 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Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... code Σ0..1CodeableConceptWhat's being requested/ordered
Binding: ActionCode (example)
... subject S0..1Reference(Patient | Group)Who the request group is about
... encounter 0..1Reference(Encounter)Created as part of
... authoredOn S0..1dateTimeWhen the request group was authored
... author S0..1Reference(Device | Practitioner | PractitionerRole)Device or practitioner that authored the request group
... reason 0..*CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference)Why the request group is needed
Binding: ActionReasonCode (example)
... note 0..*AnnotationAdditional notes about the response
... action I0..*BackboneElementProposed actions, if any
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... prefix 0..1stringUser-visible prefix for the action (e.g. 1. or A.)
.... title S0..1stringUser-visible title
.... description SΣ0..1stringShort description of the action
.... textEquivalent Σ0..1stringStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
.... priority S0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

.... code 0..*CodeableConceptCode representing the meaning of the action or sub-actions
Binding: ActionCode (example)
.... documentation S0..*RelatedArtifactSupporting documentation for the intended performer of the action
.... condition S0..*BackboneElementWhether or not the action is applicable
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... kind 1..1codeapplicability | start | stop
Binding: ActionConditionKind (required): The kind of condition for the action.

..... expression 0..1ExpressionBoolean-valued expression
.... relatedAction 0..*BackboneElementRelationship to another action
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... targetId 1..1idWhat action this is related to
..... relationship 1..1codebefore-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] 0..1Time offset for the relationship
...... offsetDurationDuration
...... offsetRangeRange
.... timing[x] S0..1When the action should take place
..... timingDateTimedateTime
..... timingAgeAge
..... timingPeriodPeriod
..... timingDurationDuration
..... timingRangeRange
..... timingTimingTiming
.... location 0..1CodeableReference(Location)Where it should happen
.... participant S0..*BackboneElementWho should perform the action
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 0..1codecareteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ActionParticipantType (required): The type of participant in the activity.

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

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

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

.... selectionBehavior S0..1codeany | all | all-or-none | exactly-one | at-most-one | one-or-more
Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.

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

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

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

.... resource SI0..1Reference(Resource)The target of the action
.... action I0..*See action (RequestGroup)Sub 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>
   <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]>
  <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><!-- 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
    "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..*BackboneElementWho 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 1..1RequestGroupA group of related requests
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..1IdentifierBusiness identifier
... instantiatesCanonical Σ0..*canonical()Instantiates FHIR protocol or definition
... instantiatesUri Σ1..1uriInstantiates external protocol or definition
... basedOn 0..*Reference(Resource)Fulfills plan, proposal, or order
... replaces 0..*Reference(Resource)Request(s) replaced by this request
... groupIdentifier Σ0..1IdentifierComposite request this is part of
... status ?!Σ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Codes identifying the lifecycle stage of a request.

... intent ?!Σ1..1codeproposal | 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Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... code Σ0..1CodeableConceptWhat's being requested/ordered
Binding: ActionCode (example)
... subject S0..1Reference(Patient | Group)Who the request group is about
... encounter 0..1Reference(Encounter)Created as part of
... authoredOn S0..1dateTimeWhen the request group was authored
... author S0..1Reference(Device | Practitioner | PractitionerRole)Device or practitioner that authored the request group
... reason 0..*CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference)Why the request group is needed
Binding: ActionReasonCode (example)
... note 0..*AnnotationAdditional notes about the response
... action I0..*BackboneElementProposed actions, if any
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... prefix 0..1stringUser-visible prefix for the action (e.g. 1. or A.)
.... title S0..1stringUser-visible title
.... description SΣ0..1stringShort description of the action
.... textEquivalent Σ0..1stringStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
.... priority S0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

.... code 0..*CodeableConceptCode representing the meaning of the action or sub-actions
Binding: ActionCode (example)
.... documentation S0..*RelatedArtifactSupporting documentation for the intended performer of the action
.... condition S0..*BackboneElementWhether or not the action is applicable
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... kind 1..1codeapplicability | start | stop
Binding: ActionConditionKind (required): The kind of condition for the action.

..... expression 0..1ExpressionBoolean-valued expression
.... relatedAction 0..*BackboneElementRelationship to another action
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... targetId 1..1idWhat action this is related to
..... relationship 1..1codebefore-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] 0..1Time offset for the relationship
...... offsetDurationDuration
...... offsetRangeRange
.... timing[x] S0..1When the action should take place
..... timingDateTimedateTime
..... timingAgeAge
..... timingPeriodPeriod
..... timingDurationDuration
..... timingRangeRange
..... timingTimingTiming
.... location 0..1CodeableReference(Location)Where it should happen
.... participant S0..*BackboneElementWho should perform the action
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 0..1codecareteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ActionParticipantType (required): The type of participant in the activity.

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

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

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

.... selectionBehavior S0..1codeany | all | all-or-none | exactly-one | at-most-one | one-or-more
Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.

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

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

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

.... resource SI0..1Reference(Resource)The target of the action
.... action I0..*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 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>
   <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]>
  <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><!-- 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
    "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.priorityRequestPriorityrequiredRequestPriority
RequestGroup.codeActionCodeexampleActionCode
RequestGroup.reasonActionReasonCodeexampleActionReasonCode
RequestGroup.action.priorityRequestPriorityrequiredRequestPriority
RequestGroup.action.codeActionCodeexampleActionCode
RequestGroup.action.condition.kindActionConditionKindrequiredActionConditionKind
RequestGroup.action.relatedAction.relationshipActionRelationshipTyperequiredActionRelationshipType
RequestGroup.action.participant.typeActionParticipantTyperequiredActionParticipantType
RequestGroup.action.participant.roleActionParticipantRoleexampleActionParticipantRole
RequestGroup.action.participant.functionActionParticipantFunctionexampleActionParticipantFunction
RequestGroup.action.typeActionTypeextensibleActionType
RequestGroup.action.groupingBehaviorActionGroupingBehaviorrequiredActionGroupingBehavior
RequestGroup.action.selectionBehaviorActionSelectionBehaviorrequiredActionSelectionBehavior
RequestGroup.action.requiredBehaviorActionRequiredBehaviorrequiredActionRequiredBehavior
RequestGroup.action.precheckBehaviorActionPrecheckBehaviorrequiredActionPrecheckBehavior
RequestGroup.action.cardinalityBehaviorActionCardinalityBehaviorrequiredActionCardinalityBehavior
.