This
page
is
part
of
the
FHIR
Specification
(v5.0.0:
R5
-
STU
v6.0.0-ballot2:
Release
6
Ballot
(2nd
Draft)
(see
Ballot
Notes
).
This
is
the
The
current
published
version
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
Clinical
Decision
Support
Work
Group
|
Maturity Level : 0 | Trial 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
00:00+0800
as
a
draft
by
HL7.
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.
Name
|
Flags
|
Card.
|
Type
|
Description
&
Constraints
|
|---|---|---|---|---|
|
1..1 | RequestOrchestration | A set of related requests | |
|
1..1 | Identifier | Business identifier | |
|
1..1 | uri | Instantiates external protocol or definition | |
|
S | 0 .. 1 | code | routine | urgent | asap | stat |
|
S | 0 .. 1 | Reference ( CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson ) | Who the request orchestration is about |
|
S | 0 .. 1 | dateTime | When the request orchestration was authored |
|
S | 0 .. 1 | Reference ( Device | Practitioner | PractitionerRole ) | Device or practitioner that authored the request orchestration |
|
0 .. * | BackboneElement | Proposed actions, if any | |
|
S | 0 .. 1 | string | User-visible title |
|
S | 0 .. 1 | markdown | Short description of the action |
|
S | 0 .. 1 | code | routine | urgent | asap | stat |
|
S | 0 .. * | RelatedArtifact | Supporting documentation for the intended performer of the action |
|
S | 0 .. * | BackboneElement | Whether or not the action is applicable |
|
S | 0 .. 1 | dateTime , Age , Period , Duration , Range , Timing | When the action should take place |
|
S | 0 .. * | BackboneElement | Who should perform the action |
|
S | 0 .. 1 | CodeableConcept | create | update | remove | fire-event |
|
S | 0 .. 1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more |
|
S | 0 .. 1 | Reference ( Resource ) | The target of the action |
|
||||
This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base RequestOrchestration structure.
Name
|
Flags
|
Card.
|
Type
|
Description
&
Constraints
|
||||
|---|---|---|---|---|---|---|---|---|
|
1..1 | RequestOrchestration |
A
set
of
related
requests
|
|||||
|
Σ | 0..1 | id | Logical id of this artifact | ||||
|
Σ | 0..1 | Meta | Metadata about the resource | ||||
|
?! Σ | 0..1 | uri | A set of rules under which this content was created | ||||
|
0..1 | code |
Language
of
the
resource
content
Binding: All Languages ( required ): IETF language tag for a human language
| |||||
|
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
|
0..* | Resource |
Contained,
inline
Resources
|
|||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
|
||||
|
Σ | 1..1 | Identifier |
Business
identifier
|
||||
|
Σ | 0..* | canonical () |
Instantiates
FHIR
protocol
or
definition
|
||||
|
Σ | 1..1 | uri |
Instantiates
external
protocol
or
definition
|
||||
|
0..* | Reference ( Resource ) |
Fulfills
plan,
proposal,
or
order
|
|||||
|
0..* | Reference ( Resource ) |
Request(s)
replaced
by
this
request
|
|||||
|
Σ | 0..1 | Identifier | Composite request this is part of | ||||
|
?! Σ | 1..1 | code |
draft
|
active
|
on-hold
|
revoked
|
completed
|
entered-in-error
|
unknown
Binding: RequestStatus ( required ): Codes identifying the lifecycle stage of a request. |
||||
|
?! Σ | 1..1 | code |
proposal
|
plan
|
directive
|
order
|
original-order
|
reflex-order
|
filler-order
|
instance-order
|
option
Binding: RequestIntent ( required ): Codes indicating the degree of authority/intentionality associated with a request. |
||||
|
S Σ | 0..1 | code |
routine
|
urgent
|
asap
|
stat
Binding: RequestPriority ( required ): Identifies the level of importance to be assigned to actioning the request. |
||||
|
Σ | 0..1 | CodeableConcept |
What's
being
requested/ordered
Binding: Action Code ( example ) |
||||
|
S | 0..1 | Reference ( CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson ) | Who the request orchestration is about | ||||
|
0..1 | Reference ( Encounter ) | Created as part of | |||||
|
S | 0..1 | dateTime | When the request orchestration was authored | ||||
|
S | 0..1 | Reference ( Device | Practitioner | PractitionerRole ) | Device or practitioner that authored the request orchestration | ||||
|
0..* | CodeableReference ( Condition | Observation | DiagnosticReport | DocumentReference ) |
Why
the
request
orchestration
is
needed
Binding: Action Reason Code ( example ) |
|||||
|
0..* | Reference ( Goal ) |
What
goals
|
|||||
|
0..* | Annotation |
Additional
notes
about
the
response
|
|||||
|
C
|
0..* | BackboneElement |
Proposed
actions,
if
any
rqg-1: Must have resource or action but not both |
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
0..1 | string | Pointer to specific item from the PlanDefinition | |||||
|
0..1 | string | User-visible prefix for the action (e.g. 1. or A.) | |||||
|
S | 0..1 | string | User-visible title | ||||
|
S Σ | 0..1 | markdown | Short description of the action | ||||
|
Σ | 0..1 | markdown | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system | ||||
|
S | 0..1 | code |
routine
|
urgent
|
asap
|
stat
Binding: RequestPriority ( required ): Identifies the level of importance to be assigned to actioning the request. |
||||
|
0..* | CodeableConcept |
Code
representing
the
meaning
of
the
action
or
sub-actions
Binding: Action Code ( example ) |
|||||
|
S | 0..* | RelatedArtifact |
Supporting
documentation
for
the
intended
performer
of
the
action
|
||||
|
0..* | Reference ( Goal ) |
What
goals
|
|||||
|
S | 0..* | BackboneElement |
Whether
or
not
the
action
is
applicable
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
1..1 | code |
applicability
|
start
|
stop
Binding: Action Condition Kind ( required ): The kind of condition for the action. |
|||||
|
0..1 | Expression | Boolean-valued expression | |||||
|
C
|
0..* | BackboneElement |
Input
data
requirements
pld-0: Input data elements must have a requirement or a relatedData, but not both |
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
0..1 | string | User-visible title | |||||
|
C
|
0..1 | DataRequirement | What data is provided | ||||
|
C
|
0..1 | id | What data is provided | ||||
|
C
|
0..* | BackboneElement |
Output
data
definition
pld-1: Output data element must have a requirement or a relatedData, but not both |
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
0..1 | string | User-visible title | |||||
|
C
|
0..1 | DataRequirement | What data is provided | ||||
|
C
|
0..1 | string | What data is provided | ||||
|
0..* | BackboneElement |
Relationship
to
another
action
|
|||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
1..1 | id | What action this is related to | |||||
|
1..1 | code |
before
|
before-start
|
before-end
|
concurrent
|
concurrent-with-start
|
concurrent-with-end
|
after
|
after-start
|
after-end
Binding: Action Relationship Type ( required ): Defines the types of relationships between actions. |
|||||
|
0..1 | code |
before
|
before-start
|
before-end
|
concurrent
|
concurrent-with-start
|
concurrent-with-end
|
after
|
after-start
|
after-end
Binding: Action Relationship Type ( required ): Defines the types of relationships between actions. |
|||||
|
0..1 | Time offset for the relationship | ||||||
|
Duration | |||||||
|
Range | |||||||
|
S | 0..1 | When the action should take place | |||||
|
dateTime | |||||||
|
Age | |||||||
|
Period | |||||||
|
Duration | |||||||
|
Range | |||||||
|
Timing | |||||||
|
0..1 | CodeableReference ( Location ) | Where it should happen | |||||
|
S | 0..* | BackboneElement |
Who
should
perform
the
action
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
0..1 | code |
careteam
|
device
|
group
|
healthcareservice
|
location
|
organization
|
patient
|
practitioner
|
practitionerrole
|
relatedperson
Binding: Action Participant Type ( required ): The type of participant in the activity. |
|||||
|
0..1 | canonical ( CapabilityStatement ) | Who or what can participate | |||||
|
0..1 | Reference ( CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson ) | Who or what can participate | |||||
|
0..1 | CodeableConcept |
E.g.
Nurse,
Surgeon,
Parent,
etc
Binding: Action Participant Role
(
example
):
Defines
roles
played
by
participants
for
the
action.
|
|||||
|
0..1 | CodeableConcept |
E.g.
Author,
Reviewer,
Witness,
etc
Binding: Action Participant Function ( example ) |
|||||
|
0..1 | canonical ( CapabilityStatement ), Reference ( CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson ) | Who/what is participating? | |||||
|
S | 0..1 | CodeableConcept |
create
|
update
|
remove
|
fire-event
Binding: Action Type ( extensible ): The type of action to be performed. |
||||
|
0..1 | code |
visual-group
|
logical-group
|
sentence-group
Binding: Action Grouping Behavior ( required ): Defines organization behavior of a group. |
|||||
|
S | 0..1 | code |
any
|
all
|
all-or-none
|
exactly-one
|
at-most-one
|
one-or-more
Binding: Action Selection Behavior ( required ): Defines selection behavior of a group. |
||||
|
0..1 | code |
must
|
could
|
must-unless-documented
Binding: Action Required Behavior ( required ): Defines expectations around whether an action or action group is required. |
|||||
|
0..1 | code |
yes
|
no
Binding: Action Precheck Behavior ( required ): Defines selection frequency behavior for an action or group. |
|||||
|
0..1 | code |
single
|
multiple
Binding: Action Cardinality Behavior ( required ): Defines behavior for an action or a group for how many times that item may be repeated. |
|||||
|
S
C
|
0..1 | Reference ( Resource ) | The target of the action | ||||
|
0..1 | Description of the activity to be performed | ||||||
|
canonical ( ActivityDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition ) | |||||||
|
uri | |||||||
|
0..1 | canonical ( StructureMap ) | Transform to apply the template | |||||
|
0..* | BackboneElement |
Dynamic
aspects
of
the
definition
|
|||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
0..1 | string | The path to the element to be set dynamically | |||||
|
0..1 | Expression | An expression that provides the dynamic value for the customization | |||||
|
0..* | See action (RequestOrchestration) |
Sub
action
|
|||||
|
||||||||
<!-- CDSHooksRequestOrchestration --><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>
<<a href="cdshooksrequestorchestration-definitions.html#RequestOrchestration.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><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(CareTeam) 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 --><<a href="cdshooksrequestorchestration-definitions.html#RequestOrchestration.action.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><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="[markdown]"/><!-- I 0..1 Short description of the action --> <textEquivalent value="[markdown]"/><!-- 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 --><<a href="cdshooksrequestorchestration-definitions.html#RequestOrchestration.action.condition.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><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 --><<a href="cdshooksrequestorchestration-definitions.html#RequestOrchestration.action.input.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><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 --><<a href="cdshooksrequestorchestration-definitions.html#RequestOrchestration.action.output.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><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 --><<a href="cdshooksrequestorchestration-definitions.html#RequestOrchestration.action.relatedAction.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"><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 | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end --> <endRelationship value="[code]"/><!-- I 0..1 before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | 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 --><<a href="cdshooksrequestorchestration-definitions.html#RequestOrchestration.action.participant.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"><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><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 -->
<<a href="cdshooksrequestorchestration-definitions.html#RequestOrchestration.action.dynamicValue.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"><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>
{ // CDSHooksRequestOrchestration
// 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
"<a href="cdshooksrequestorchestration-definitions.html#RequestOrchestration.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">
"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(CareTeam) }, // 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 .
Differential View
This indicates the differences between this profile and the base RequestOrchestration structure.
Name
|
Flags
|
Card.
|
Type
|
Description
&
Constraints
|
|---|---|---|---|---|
|
1..1 | RequestOrchestration | A set of related requests | |
|
1..1 | Identifier | Business identifier | |
|
1..1 | uri | Instantiates external protocol or definition | |
|
S | 0 .. 1 | code | routine | urgent | asap | stat |
|
S | 0 .. 1 | Reference ( CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson ) | Who the request orchestration is about |
|
S | 0 .. 1 | dateTime | When the request orchestration was authored |
|
S | 0 .. 1 | Reference ( Device | Practitioner | PractitionerRole ) | Device or practitioner that authored the request orchestration |
|
0 .. * | BackboneElement | Proposed actions, if any | |
|
S | 0 .. 1 | string | User-visible title |
|
S | 0 .. 1 | markdown | Short description of the action |
|
S | 0 .. 1 | code | routine | urgent | asap | stat |
|
S | 0 .. * | RelatedArtifact | Supporting documentation for the intended performer of the action |
|
S | 0 .. * | BackboneElement | Whether or not the action is applicable |
|
S | 0 .. 1 | dateTime , Age , Period , Duration , Range , Timing | When the action should take place |
|
S | 0 .. * | BackboneElement | Who should perform the action |
|
S | 0 .. 1 | CodeableConcept | create | update | remove | fire-event |
|
S | 0 .. 1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more |
|
S | 0 .. 1 | Reference ( Resource ) | The target of the action |
|
||||
Snapshot View
This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base RequestOrchestration structure.
Name
|
Flags
|
Card.
|
Type
|
Description
&
Constraints
|
||||
|---|---|---|---|---|---|---|---|---|
|
1..1 | RequestOrchestration |
A
set
of
related
requests
|
|||||
|
Σ | 0..1 | id | Logical id of this artifact | ||||
|
Σ | 0..1 | Meta | Metadata about the resource | ||||
|
?! Σ | 0..1 | uri | A set of rules under which this content was created | ||||
|
0..1 | code |
Language
of
the
resource
content
Binding: All Languages ( required ): IETF language tag for a human language
|
|||||
|
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
|
0..* | Resource |
Contained,
inline
Resources
|
|||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
|
||||
|
Σ | 1..1 | Identifier |
Business
identifier
|
||||
|
Σ | 0..* | canonical () |
Instantiates
FHIR
protocol
or
definition
|
||||
|
Σ | 1..1 | uri |
Instantiates
external
protocol
or
definition
|
||||
|
0..* | Reference ( Resource ) |
Fulfills
plan,
proposal,
or
order
|
|||||
|
0..* | Reference ( Resource ) |
Request(s)
replaced
by
this
request
|
|||||
|
Σ | 0..1 | Identifier | Composite request this is part of | ||||
|
?! Σ | 1..1 | code |
draft
|
active
|
on-hold
|
revoked
|
completed
|
entered-in-error
|
unknown
Binding: RequestStatus ( required ): Codes identifying the lifecycle stage of a request. |
||||
|
?! Σ | 1..1 | code |
proposal
|
plan
|
directive
|
order
|
original-order
|
reflex-order
|
filler-order
|
instance-order
|
option
Binding: RequestIntent ( required ): Codes indicating the degree of authority/intentionality associated with a request. |
||||
|
S Σ | 0..1 | code |
routine
|
urgent
|
asap
|
stat
Binding: RequestPriority ( required ): Identifies the level of importance to be assigned to actioning the request. |
||||
|
Σ | 0..1 | CodeableConcept |
What's
being
requested/ordered
Binding: Action Code ( example ) |
||||
|
S | 0..1 | Reference ( CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson ) | Who the request orchestration is about | ||||
|
0..1 | Reference ( Encounter ) | Created as part of | |||||
|
S | 0..1 | dateTime | When the request orchestration was authored | ||||
|
S | 0..1 | Reference ( Device | Practitioner | PractitionerRole ) | Device or practitioner that authored the request orchestration | ||||
|
0..* | CodeableReference ( Condition | Observation | DiagnosticReport | DocumentReference ) |
Why
the
request
orchestration
is
needed
Binding: Action Reason Code ( example ) |
|||||
|
0..* | Reference ( Goal ) |
What
goals
|
|||||
|
0..* | Annotation |
Additional
notes
about
the
response
|
|||||
|
C
|
0..* | BackboneElement |
Proposed
actions,
if
any
rqg-1: Must have resource or action but not both |
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
0..1 | string | Pointer to specific item from the PlanDefinition | |||||
|
0..1 | string | User-visible prefix for the action (e.g. 1. or A.) | |||||
|
S | 0..1 | string | User-visible title | ||||
|
S Σ | 0..1 | markdown | Short description of the action | ||||
|
Σ | 0..1 | markdown | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system | ||||
|
S | 0..1 | code |
routine
|
urgent
|
asap
|
stat
Binding: RequestPriority ( required ): Identifies the level of importance to be assigned to actioning the request. |
||||
|
0..* | CodeableConcept |
Code
representing
the
meaning
of
the
action
or
sub-actions
Binding: Action Code ( example ) |
|||||
|
S | 0..* | RelatedArtifact |
Supporting
documentation
for
the
intended
performer
of
the
action
|
||||
|
0..* | Reference ( Goal ) |
What
goals
|
|||||
|
S | 0..* | BackboneElement |
Whether
or
not
the
action
is
applicable
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
1..1 | code |
applicability
|
start
|
stop
Binding: Action Condition Kind ( required ): The kind of condition for the action. |
|||||
|
0..1 | Expression | Boolean-valued expression | |||||
|
C
|
0..* | BackboneElement |
Input
data
requirements
pld-0: Input data elements must have a requirement or a relatedData, but not both |
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
0..1 | string | User-visible title | |||||
|
C
|
0..1 | DataRequirement | What data is provided | ||||
|
C
|
0..1 | id | What data is provided | ||||
|
C
|
0..* | BackboneElement |
Output
data
definition
pld-1: Output data element must have a requirement or a relatedData, but not both |
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
0..1 | string | User-visible title | |||||
|
C
|
0..1 | DataRequirement | What data is provided | ||||
|
C
|
0..1 | string | What data is provided | ||||
|
0..* | BackboneElement |
Relationship
to
another
action
|
|||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
1..1 | id | What action this is related to | |||||
|
1..1 | code |
before
|
before-start
|
before-end
|
concurrent
|
concurrent-with-start
|
concurrent-with-end
|
after
|
after-start
|
after-end
Binding: Action Relationship Type ( required ): Defines the types of relationships between actions. |
|||||
|
0..1 | code |
before
|
before-start
|
before-end
|
concurrent
|
concurrent-with-start
|
concurrent-with-end
|
after
|
after-start
|
after-end
Binding: Action Relationship Type ( required ): Defines the types of relationships between actions. |
|||||
|
0..1 | Time offset for the relationship | ||||||
|
Duration | |||||||
|
Range | |||||||
|
S | 0..1 | When the action should take place | |||||
|
dateTime | |||||||
|
Age | |||||||
|
Period | |||||||
|
Duration | |||||||
|
Range | |||||||
|
Timing | |||||||
|
0..1 | CodeableReference ( Location ) | Where it should happen | |||||
|
S | 0..* | BackboneElement |
Who
should
perform
the
action
|
||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
0..1 | code |
careteam
|
device
|
group
|
healthcareservice
|
location
|
organization
|
patient
|
practitioner
|
practitionerrole
|
relatedperson
Binding: Action Participant Type ( required ): The type of participant in the activity. |
|||||
|
0..1 | canonical ( CapabilityStatement ) | Who or what can participate | |||||
|
0..1 | Reference ( CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson ) | Who or what can participate | |||||
|
0..1 | CodeableConcept |
E.g.
Nurse,
Surgeon,
Parent,
etc
Binding: Action Participant Role
(
example
):
Defines
roles
played
by
participants
for
the
action.
|
|||||
|
0..1 | CodeableConcept |
E.g.
Author,
Reviewer,
Witness,
etc
Binding: Action Participant Function ( example ) |
|||||
|
0..1 | canonical ( CapabilityStatement ), Reference ( CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson ) | Who/what is participating? | |||||
|
S | 0..1 | CodeableConcept |
create
|
update
|
remove
|
fire-event
Binding: Action Type ( extensible ): The type of action to be performed. |
||||
|
0..1 | code |
visual-group
|
logical-group
|
sentence-group
Binding: Action Grouping Behavior ( required ): Defines organization behavior of a group. |
|||||
|
S | 0..1 | code |
any
|
all
|
all-or-none
|
exactly-one
|
at-most-one
|
one-or-more
Binding: Action Selection Behavior ( required ): Defines selection behavior of a group. |
||||
|
0..1 | code |
must
|
could
|
must-unless-documented
Binding: Action Required Behavior ( required ): Defines expectations around whether an action or action group is required. |
|||||
|
0..1 | code |
yes
|
no
Binding: Action Precheck Behavior ( required ): Defines selection frequency behavior for an action or group. |
|||||
|
0..1 | code |
single
|
multiple
Binding: Action Cardinality Behavior ( required ): Defines behavior for an action or a group for how many times that item may be repeated. |
|||||
|
S
C
|
0..1 | Reference ( Resource ) | The target of the action | ||||
|
0..1 | Description of the activity to be performed | ||||||
|
canonical ( ActivityDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition ) | |||||||
|
uri | |||||||
|
0..1 | canonical ( StructureMap ) | Transform to apply the template | |||||
|
0..* | BackboneElement |
Dynamic
aspects
of
the
definition
|
|||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
0..1 | string | The path to the element to be set dynamically | |||||
|
0..1 | Expression | An expression that provides the dynamic value for the customization | |||||
|
0..* | See action (RequestOrchestration) |
Sub
action
|
|||||
|
||||||||
XML Template
<!-- CDSHooksRequestOrchestration --><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>
<<a href="cdshooksrequestorchestration-definitions.html#RequestOrchestration.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><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(CareTeam) 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 --><<a href="cdshooksrequestorchestration-definitions.html#RequestOrchestration.action.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><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="[markdown]"/><!-- I 0..1 Short description of the action --> <textEquivalent value="[markdown]"/><!-- 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 --><<a href="cdshooksrequestorchestration-definitions.html#RequestOrchestration.action.condition.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><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 --><<a href="cdshooksrequestorchestration-definitions.html#RequestOrchestration.action.input.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><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 --><<a href="cdshooksrequestorchestration-definitions.html#RequestOrchestration.action.output.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><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 --><<a href="cdshooksrequestorchestration-definitions.html#RequestOrchestration.action.relatedAction.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"><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 | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end --> <endRelationship value="[code]"/><!-- I 0..1 before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | 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 --><<a href="cdshooksrequestorchestration-definitions.html#RequestOrchestration.action.participant.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"><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><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 -->
<<a href="cdshooksrequestorchestration-definitions.html#RequestOrchestration.action.dynamicValue.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"><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
{ // CDSHooksRequestOrchestration
// 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
"<a href="cdshooksrequestorchestration-definitions.html#RequestOrchestration.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">
"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(CareTeam) }, // 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
| Path | Name | Conformance | ValueSet |
| RequestOrchestration.language | All Languages | required | All Languages |
| RequestOrchestration.status | RequestStatus | required | RequestStatus |
| RequestOrchestration.intent | RequestIntent | required | RequestIntent |
| RequestOrchestration.priority | RequestPriority | required | RequestPriority |
| RequestOrchestration.code | Action Code | example | Action Code |
| RequestOrchestration.reason | Action Reason Code | example | Action Reason Code |
| RequestOrchestration.action.priority | RequestPriority | required | RequestPriority |
| RequestOrchestration.action.code | Action Code | example | Action Code |
| RequestOrchestration.action.condition.kind | Action Condition Kind | required | Action Condition Kind |
| RequestOrchestration.action.relatedAction.relationship | Action Relationship Type | required | Action Relationship Type |
| RequestOrchestration.action.relatedAction.endRelationship | Action Relationship Type | required | Action Relationship Type |
| RequestOrchestration.action.participant.type | Action Participant Type | required | Action Participant Type |
| RequestOrchestration.action.participant.role | Action Participant Role | example |
Action
Participant
Role
|
| RequestOrchestration.action.participant.function | Action Participant Function | example | Action Participant Function |
| RequestOrchestration.action.type | Action Type | extensible | Action Type |
| RequestOrchestration.action.groupingBehavior | Action Grouping Behavior | required | Action Grouping Behavior |
| RequestOrchestration.action.selectionBehavior | Action Selection Behavior | required | Action Selection Behavior |
| RequestOrchestration.action.requiredBehavior | Action Required Behavior | required | Action Required Behavior |
| RequestOrchestration.action.precheckBehavior | Action Precheck Behavior | required | Action Precheck Behavior |
| RequestOrchestration.action.cardinalityBehavior | Action Cardinality Behavior | required | Action Cardinality Behavior |