Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

14.17.10.2 StructureDefinition: CDS Hooks RequestOrchestration

Clinical Decision Support Work Group Maturity Level: 0Trial Use Use Context: Any

The canonical URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/cdshooksrequestorchestration

Defines a RequestOrchestration that can represent a CDS Hooks response

This profile was published on Thu, Jan 1, 1970 00:00+1000 as a draft by HL7.

14.17.10.2.1 Formal Views of Profile Content

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

This structure is derived from RequestOrchestration.

Summary

Mandatory: 2 elements
Must-Support: 14 elements

This indicates the differences between this profile and the base RequestOrchestration structure.

NameFlagsCard.TypeDescription & Constraintsdoco
.. RequestOrchestration 1..1RequestOrchestrationA set 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 orchestration was authored
... author S0..1Reference(Device | Practitioner | PractitionerRole)Device or practitioner that authored the request orchestration
... 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

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base RequestOrchestration structure.

NameFlagsCard.TypeDescription & Constraintsdoco
.. RequestOrchestration 1..1RequestOrchestrationA set 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 orchestration is about
... encounter 0..1Reference(Encounter)Created as part of
... authoredOn S0..1dateTimeWhen the request orchestration was authored
... author S0..1Reference(Device | Practitioner | PractitionerRole)Device or practitioner that authored the request orchestration
... reason 0..*CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference)Why the request orchestration is needed
Binding: ActionReasonCode (example)
... goal 0..*Reference(Goal)What goals
... note 0..*AnnotationAdditional notes about the response
... action C 0..*BackboneElementProposed actions, if any
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... linkId 0..1stringPointer to specific item from the PlanDefinition
.... 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
.... goal 0..*Reference(Goal)What goals
.... condition S0..*BackboneElementWhether or not the action is applicable
..... id 0..1stringUnique 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
.... input C 0..*BackboneElementInput data requirements
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... title 0..1stringUser-visible title
..... requirement 0..1DataRequirementWhat data is provided
..... relatedData 0..1idWhat data is provided
.... output C 0..*BackboneElementOutput data definition
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... title 0..1stringUser-visible title
..... requirement 0..1DataRequirementWhat data is provided
..... relatedData 0..1stringWhat data is provided
.... relatedAction 0..*BackboneElementRelationship to another action
..... id 0..1stringUnique 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..1stringUnique 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.

..... typeCanonical 0..1canonical(CapabilityStatement)Who or what can participate
..... typeReference 0..1Reference(CareTeam | Device | DeviceDefinition | Endpoint | 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[x] 0..1canonical(CapabilityStatement), Reference(CareTeam | Device | DeviceDefinition | Endpoint | 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 SC 0..1Reference(Resource)The target of the action
.... definition[x] 0..1Description of the activity to be performed
..... definitionCanonicalcanonical(ActivityDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition)
..... definitionUriuri
.... transform 0..1canonical(StructureMap)Transform to apply the template
.... dynamicValue 0..*BackboneElementDynamic aspects of the definition
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... path 0..1stringThe path to the element to be set dynamically
..... expression 0..1ExpressionAn expression that provides the dynamic value for the customization
.... action C 0..*See action (RequestOrchestration)Sub action

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

<RequestOrchestration xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- I 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- I 0..1 Language of the resource content   -->
 <text><!-- I 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource 
     Contained, inline Resources --></contained>
 <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!-- I 1..1 Identifier 
     Business identifier --></identifier>
 <instantiatesCanonical value="[canonical]"/><!-- I 0..* Instantiates FHIR protocol or definition -->
 <instantiatesUri value="[uri]"/><!-- I 1..1 Instantiates external protocol or definition -->
 <basedOn><!-- I 0..* Reference(Resource) 
     Fulfills plan, proposal, or order --></basedOn>
 <replaces><!-- I 0..* Reference(Resource) 
     Request(s) replaced by this request --></replaces>
 <groupIdentifier><!-- I 0..1 Identifier 
     Composite request this is part of --></groupIdentifier>
 <status value="[code]"/><!-- I 1..1 draft | active | on-hold | revoked | completed | entered-in-error | unknown   -->
 <intent value="[code]"/><!-- I 1..1 proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option   -->
 <priority value="[code]"/><!-- I 0..1 routine | urgent | asap | stat   -->
 <code><!-- I 0..1 CodeableConcept What's being requested/ordered   --></code>
 <subject><!-- I 0..1 Reference(Patient) 
     Who the request orchestration is about --></subject>
 <encounter><!-- I 0..1 Reference(Encounter) 
     Created as part of --></encounter>
 <authoredOn value="[dateTime]"/><!-- I 0..1 When the request orchestration was authored -->
 <author><!-- I 0..1 Reference(Device) 
     Device or practitioner that authored the request orchestration --></author>
 <reason><!-- I 0..* CodeableReference Why the request orchestration is needed   --></reason>
 <goal><!-- I 0..* Reference(Goal) What goals --></goal>
 <note><!-- I 0..* Annotation 
     Additional notes about the response --></note>
 <action> I 0..* BackboneElement  <!-- I 0..* Proposed actions, if any -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <linkId value="[string]"/><!-- I 0..1 Pointer to specific item from the PlanDefinition -->
  <prefix value="[string]"/><!-- I 0..1 User-visible prefix for the action (e.g. 1. or A.) -->
  <title value="[string]"/><!-- I 0..1 User-visible title -->
  <description value="[string]"/><!-- I 0..1 Short description of the action -->
  <textEquivalent value="[string]"/><!-- I 0..1 
      Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system -->
  <priority value="[code]"/><!-- I 0..1 routine | urgent | asap | stat   -->
  <code><!-- I 0..* CodeableConcept Code representing the meaning of the action or sub-actions   --></code>
  <documentation><!-- I 0..* RelatedArtifact 
      Supporting documentation for the intended performer of the action --></documentation>
  <goal><!-- I 0..* Reference(Goal) What goals --></goal>
  <condition> I 0..* BackboneElement  <!-- I 0..* Whether or not the action is applicable -->
   <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <kind value="[code]"/><!-- I 1..1 applicability | start | stop   -->
   <expression><!-- I 0..1 Expression 
       Boolean-valued expression --></expression>
  </condition>
  <input> I 0..* BackboneElement  <!-- I 0..* Input data requirements -->
   <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <title value="[string]"/><!-- I 0..1 User-visible title -->
   <requirement><!-- I 0..1 DataRequirement 
       What data is provided --></requirement>
   <relatedData value="[id]"/><!-- I 0..1 What data is provided -->
  </input>
  <output> I 0..* BackboneElement  <!-- I 0..* Output data definition -->
   <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <title value="[string]"/><!-- I 0..1 User-visible title -->
   <requirement><!-- I 0..1 DataRequirement 
       What data is provided --></requirement>
   <relatedData value="[string]"/><!-- I 0..1 What data is provided -->
  </output>
  <relatedAction> I 0..* BackboneElement  <!-- I 0..* Relationship to another action -->
   <modifierExtension><!-- I 0..* 
     Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <targetId value="[id]"/><!-- I 1..1 What action this is related to -->
   <relationship value="[code]"/><!-- I 1..1 before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end   -->
   <offset[x]><!-- I 0..1 Duration|Range 
       Time offset for the relationship --></offset[x]>
  </relatedAction>
  <timing[x]><!-- I 0..1 dateTime|Age|Period|Duration|
    Range|Timing When the action should take place --></timing[x]>
  <location><!-- I 0..1 CodeableReference 
      Where it should happen --></location>
  <participant> I 0..* BackboneElement  <!-- I 0..* Who should perform the action -->
   <modifierExtension><!-- I 0..* 
     Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <type value="[code]"/><!-- I 0..1 careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson   -->
   <typeCanonical value="[canonical]"/><!-- I 0..1 Who or what can participate -->
   <typeReference><!-- I 0..1 Reference(CareTeam) 
       Who or what can participate --></typeReference>
   <role><!-- I 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent, etc.    --></role>
   <function><!-- I 0..1 CodeableConcept E.g. Author, Reviewer, Witness, etc.   --></function>
   <actor[x]><!-- I 0..1 canonical|
     Reference(CareTeam) Who/what is participating? --></actor[x]>
  </participant>
  <type><!-- I 0..1 CodeableConcept create | update | remove | fire-event   --></type>
  <groupingBehavior value="[code]"/><!-- I 0..1 visual-group | logical-group | sentence-group   -->
  <selectionBehavior value="[code]"/><!-- I 0..1 any | all | all-or-none | exactly-one | at-most-one | one-or-more   -->
  <requiredBehavior value="[code]"/><!-- I 0..1 must | could | must-unless-documented   -->
  <precheckBehavior value="[code]"/><!-- I 0..1 yes | no   -->
  <cardinalityBehavior value="[code]"/><!-- I 0..1 single | multiple   -->
  <resource><!-- I 0..1 Reference(Resource) 
      The target of the action --></resource>
  <definition[x]><!-- I 0..1 canonical|uri 
      Description of the activity to be performed --></definition[x]>
  <transform value="[canonical]"/><!-- I 0..1 Transform to apply the template -->
  <dynamicValue> I 0..* BackboneElement  <!-- I 0..* Dynamic aspects of the definition -->
   <modifierExtension><!-- I 0..* 
     Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <path value="[string]"/><!-- I 0..1 The path to the element to be set dynamically -->
   <expression><!-- I 0..1 Expression 
       An expression that provides the dynamic value for the customization --></expression>
  </dynamicValue>
  <action><!-- See http://hl7.org/fhir/StructureDefinition/RequestOrchestration#RequestOrchestration.action  Sub action --></action>
 </action>
</RequestOrchestration>

{ // CDS Hooks RequestOrchestration
  // from Element: extension
    "meta" : { Meta }, // IMetadata about the resource
    "implicitRules" : "<uri>", // IA set of rules under which this content was created
    "language" : "<code>", // ILanguage of the resource content
    "text" : { Narrative }, // IText summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
    "identifier" : { Identifier }, // I R! Business identifier
    "instantiatesCanonical" : ["<canonical>"], // IInstantiates FHIR protocol or definition
    "instantiatesUri" : "<uri>", // I R! Instantiates external protocol or definition
    "basedOn" : [{ Reference(Resource) }], // IFulfills plan, proposal, or order
    "replaces" : [{ Reference(Resource) }], // IRequest(s) replaced by this request
    "groupIdentifier" : { Identifier }, // IComposite request this is part of
    "status" : "<code>", // I R! draft | active | on-hold | revoked | completed | entered-in-error | unknown
    "intent" : "<code>", // I R! proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
    "priority" : "<code>", // Iroutine | urgent | asap | stat
    "code" : { CodeableConcept }, // IWhat's being requested/ordered
    "subject" : { Reference(Patient) }, // IWho the request orchestration is about
    "encounter" : { Reference(Encounter) }, // ICreated as part of
    "authoredOn" : "<dateTime>", // IWhen the request orchestration was authored
    "author" : { Reference(Device) }, // IDevice or practitioner that authored the request orchestration
    "reason" : [{ CodeableReference(Condition) }], // IWhy the request orchestration is needed
    "goal" : [{ Reference(Goal) }], // IWhat goals
    "note" : [{ Annotation }], // IAdditional notes about the response
    "action" : [{ BackboneElement }] // IProposed actions, if any
  }

This structure is derived from RequestOrchestration.

Summary

Mandatory: 2 elements
Must-Support: 14 elements

Differential View

This indicates the differences between this profile and the base RequestOrchestration structure.

NameFlagsCard.TypeDescription & Constraintsdoco
.. RequestOrchestration 1..1RequestOrchestrationA set 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 orchestration was authored
... author S0..1Reference(Device | Practitioner | PractitionerRole)Device or practitioner that authored the request orchestration
... 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

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base RequestOrchestration structure.

NameFlagsCard.TypeDescription & Constraintsdoco
.. RequestOrchestration 1..1RequestOrchestrationA set 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 orchestration is about
... encounter 0..1Reference(Encounter)Created as part of
... authoredOn S0..1dateTimeWhen the request orchestration was authored
... author S0..1Reference(Device | Practitioner | PractitionerRole)Device or practitioner that authored the request orchestration
... reason 0..*CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference)Why the request orchestration is needed
Binding: ActionReasonCode (example)
... goal 0..*Reference(Goal)What goals
... note 0..*AnnotationAdditional notes about the response
... action C 0..*BackboneElementProposed actions, if any
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... linkId 0..1stringPointer to specific item from the PlanDefinition
.... 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
.... goal 0..*Reference(Goal)What goals
.... condition S0..*BackboneElementWhether or not the action is applicable
..... id 0..1stringUnique 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
.... input C 0..*BackboneElementInput data requirements
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... title 0..1stringUser-visible title
..... requirement 0..1DataRequirementWhat data is provided
..... relatedData 0..1idWhat data is provided
.... output C 0..*BackboneElementOutput data definition
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... title 0..1stringUser-visible title
..... requirement 0..1DataRequirementWhat data is provided
..... relatedData 0..1stringWhat data is provided
.... relatedAction 0..*BackboneElementRelationship to another action
..... id 0..1stringUnique 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..1stringUnique 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.

..... typeCanonical 0..1canonical(CapabilityStatement)Who or what can participate
..... typeReference 0..1Reference(CareTeam | Device | DeviceDefinition | Endpoint | 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[x] 0..1canonical(CapabilityStatement), Reference(CareTeam | Device | DeviceDefinition | Endpoint | 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 SC 0..1Reference(Resource)The target of the action
.... definition[x] 0..1Description of the activity to be performed
..... definitionCanonicalcanonical(ActivityDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition)
..... definitionUriuri
.... transform 0..1canonical(StructureMap)Transform to apply the template
.... dynamicValue 0..*BackboneElementDynamic aspects of the definition
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... path 0..1stringThe path to the element to be set dynamically
..... expression 0..1ExpressionAn expression that provides the dynamic value for the customization
.... action C 0..*See action (RequestOrchestration)Sub action

doco Documentation for this format

XML Template

<!-- CDS Hooks RequestOrchestration -->doco

<RequestOrchestration xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- I 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- I 0..1 Language of the resource content   -->
 <text><!-- I 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource 
     Contained, inline Resources --></contained>
 <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!-- I 1..1 Identifier 
     Business identifier --></identifier>
 <instantiatesCanonical value="[canonical]"/><!-- I 0..* Instantiates FHIR protocol or definition -->
 <instantiatesUri value="[uri]"/><!-- I 1..1 Instantiates external protocol or definition -->
 <basedOn><!-- I 0..* Reference(Resource) 
     Fulfills plan, proposal, or order --></basedOn>
 <replaces><!-- I 0..* Reference(Resource) 
     Request(s) replaced by this request --></replaces>
 <groupIdentifier><!-- I 0..1 Identifier 
     Composite request this is part of --></groupIdentifier>
 <status value="[code]"/><!-- I 1..1 draft | active | on-hold | revoked | completed | entered-in-error | unknown   -->
 <intent value="[code]"/><!-- I 1..1 proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option   -->
 <priority value="[code]"/><!-- I 0..1 routine | urgent | asap | stat   -->
 <code><!-- I 0..1 CodeableConcept What's being requested/ordered   --></code>
 <subject><!-- I 0..1 Reference(Patient) 
     Who the request orchestration is about --></subject>
 <encounter><!-- I 0..1 Reference(Encounter) 
     Created as part of --></encounter>
 <authoredOn value="[dateTime]"/><!-- I 0..1 When the request orchestration was authored -->
 <author><!-- I 0..1 Reference(Device) 
     Device or practitioner that authored the request orchestration --></author>
 <reason><!-- I 0..* CodeableReference Why the request orchestration is needed   --></reason>
 <goal><!-- I 0..* Reference(Goal) What goals --></goal>
 <note><!-- I 0..* Annotation 
     Additional notes about the response --></note>
 <action> I 0..* BackboneElement  <!-- I 0..* Proposed actions, if any -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <linkId value="[string]"/><!-- I 0..1 Pointer to specific item from the PlanDefinition -->
  <prefix value="[string]"/><!-- I 0..1 User-visible prefix for the action (e.g. 1. or A.) -->
  <title value="[string]"/><!-- I 0..1 User-visible title -->
  <description value="[string]"/><!-- I 0..1 Short description of the action -->
  <textEquivalent value="[string]"/><!-- I 0..1 
      Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system -->
  <priority value="[code]"/><!-- I 0..1 routine | urgent | asap | stat   -->
  <code><!-- I 0..* CodeableConcept Code representing the meaning of the action or sub-actions   --></code>
  <documentation><!-- I 0..* RelatedArtifact 
      Supporting documentation for the intended performer of the action --></documentation>
  <goal><!-- I 0..* Reference(Goal) What goals --></goal>
  <condition> I 0..* BackboneElement  <!-- I 0..* Whether or not the action is applicable -->
   <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <kind value="[code]"/><!-- I 1..1 applicability | start | stop   -->
   <expression><!-- I 0..1 Expression 
       Boolean-valued expression --></expression>
  </condition>
  <input> I 0..* BackboneElement  <!-- I 0..* Input data requirements -->
   <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <title value="[string]"/><!-- I 0..1 User-visible title -->
   <requirement><!-- I 0..1 DataRequirement 
       What data is provided --></requirement>
   <relatedData value="[id]"/><!-- I 0..1 What data is provided -->
  </input>
  <output> I 0..* BackboneElement  <!-- I 0..* Output data definition -->
   <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <title value="[string]"/><!-- I 0..1 User-visible title -->
   <requirement><!-- I 0..1 DataRequirement 
       What data is provided --></requirement>
   <relatedData value="[string]"/><!-- I 0..1 What data is provided -->
  </output>
  <relatedAction> I 0..* BackboneElement  <!-- I 0..* Relationship to another action -->
   <modifierExtension><!-- I 0..* 
     Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <targetId value="[id]"/><!-- I 1..1 What action this is related to -->
   <relationship value="[code]"/><!-- I 1..1 before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end   -->
   <offset[x]><!-- I 0..1 Duration|Range 
       Time offset for the relationship --></offset[x]>
  </relatedAction>
  <timing[x]><!-- I 0..1 dateTime|Age|Period|Duration|
    Range|Timing When the action should take place --></timing[x]>
  <location><!-- I 0..1 CodeableReference 
      Where it should happen --></location>
  <participant> I 0..* BackboneElement  <!-- I 0..* Who should perform the action -->
   <modifierExtension><!-- I 0..* 
     Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <type value="[code]"/><!-- I 0..1 careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson   -->
   <typeCanonical value="[canonical]"/><!-- I 0..1 Who or what can participate -->
   <typeReference><!-- I 0..1 Reference(CareTeam) 
       Who or what can participate --></typeReference>
   <role><!-- I 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent, etc.    --></role>
   <function><!-- I 0..1 CodeableConcept E.g. Author, Reviewer, Witness, etc.   --></function>
   <actor[x]><!-- I 0..1 canonical|
     Reference(CareTeam) Who/what is participating? --></actor[x]>
  </participant>
  <type><!-- I 0..1 CodeableConcept create | update | remove | fire-event   --></type>
  <groupingBehavior value="[code]"/><!-- I 0..1 visual-group | logical-group | sentence-group   -->
  <selectionBehavior value="[code]"/><!-- I 0..1 any | all | all-or-none | exactly-one | at-most-one | one-or-more   -->
  <requiredBehavior value="[code]"/><!-- I 0..1 must | could | must-unless-documented   -->
  <precheckBehavior value="[code]"/><!-- I 0..1 yes | no   -->
  <cardinalityBehavior value="[code]"/><!-- I 0..1 single | multiple   -->
  <resource><!-- I 0..1 Reference(Resource) 
      The target of the action --></resource>
  <definition[x]><!-- I 0..1 canonical|uri 
      Description of the activity to be performed --></definition[x]>
  <transform value="[canonical]"/><!-- I 0..1 Transform to apply the template -->
  <dynamicValue> I 0..* BackboneElement  <!-- I 0..* Dynamic aspects of the definition -->
   <modifierExtension><!-- I 0..* 
     Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <path value="[string]"/><!-- I 0..1 The path to the element to be set dynamically -->
   <expression><!-- I 0..1 Expression 
       An expression that provides the dynamic value for the customization --></expression>
  </dynamicValue>
  <action><!-- See http://hl7.org/fhir/StructureDefinition/RequestOrchestration#RequestOrchestration.action  Sub action --></action>
 </action>
</RequestOrchestration>

JSON Template

{ // CDS Hooks RequestOrchestration
  // from Element: extension
    "meta" : { Meta }, // IMetadata about the resource
    "implicitRules" : "<uri>", // IA set of rules under which this content was created
    "language" : "<code>", // ILanguage of the resource content
    "text" : { Narrative }, // IText summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
    "identifier" : { Identifier }, // I R! Business identifier
    "instantiatesCanonical" : ["<canonical>"], // IInstantiates FHIR protocol or definition
    "instantiatesUri" : "<uri>", // I R! Instantiates external protocol or definition
    "basedOn" : [{ Reference(Resource) }], // IFulfills plan, proposal, or order
    "replaces" : [{ Reference(Resource) }], // IRequest(s) replaced by this request
    "groupIdentifier" : { Identifier }, // IComposite request this is part of
    "status" : "<code>", // I R! draft | active | on-hold | revoked | completed | entered-in-error | unknown
    "intent" : "<code>", // I R! proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
    "priority" : "<code>", // Iroutine | urgent | asap | stat
    "code" : { CodeableConcept }, // IWhat's being requested/ordered
    "subject" : { Reference(Patient) }, // IWho the request orchestration is about
    "encounter" : { Reference(Encounter) }, // ICreated as part of
    "authoredOn" : "<dateTime>", // IWhen the request orchestration was authored
    "author" : { Reference(Device) }, // IDevice or practitioner that authored the request orchestration
    "reason" : [{ CodeableReference(Condition) }], // IWhy the request orchestration is needed
    "goal" : [{ Reference(Goal) }], // IWhat goals
    "note" : [{ Annotation }], // IAdditional notes about the response
    "action" : [{ BackboneElement }] // IProposed actions, if any
  }

 

Alternate definitions: Master Definition (XML, JSON), Schematron

14.17.10.2.2 Terminology Bindings

PathNameConformanceValueSet
RequestOrchestration.languageCommon LanguagespreferredCommon Languages
RequestOrchestration.statusRequestStatusrequiredRequestStatus
RequestOrchestration.intentRequestIntentrequiredRequestIntent
RequestOrchestration.priorityRequestPriorityrequiredRequestPriority
RequestOrchestration.codeActionCodeexampleActionCode
RequestOrchestration.reasonActionReasonCodeexampleActionReasonCode
RequestOrchestration.action.priorityRequestPriorityrequiredRequestPriority
RequestOrchestration.action.codeActionCodeexampleActionCode
RequestOrchestration.action.condition.kindActionConditionKindrequiredActionConditionKind
RequestOrchestration.action.relatedAction.relationshipActionRelationshipTyperequiredActionRelationshipType
RequestOrchestration.action.participant.typeActionParticipantTyperequiredActionParticipantType
RequestOrchestration.action.participant.roleActionParticipantRoleexampleActionParticipantRole
RequestOrchestration.action.participant.functionActionParticipantFunctionexampleActionParticipantFunction
RequestOrchestration.action.typeActionTypeextensibleActionType
RequestOrchestration.action.groupingBehaviorActionGroupingBehaviorrequiredActionGroupingBehavior
RequestOrchestration.action.selectionBehaviorActionSelectionBehaviorrequiredActionSelectionBehavior
RequestOrchestration.action.requiredBehaviorActionRequiredBehaviorrequiredActionRequiredBehavior
RequestOrchestration.action.precheckBehaviorActionPrecheckBehaviorrequiredActionPrecheckBehavior
RequestOrchestration.action.cardinalityBehaviorActionCardinalityBehaviorrequiredActionCardinalityBehavior
.