RequestOrchestration R5 (FHIR) at fhirtruck

Path

RequestOrchestration

Id

RequestOrchestration

Cardinality

0 - *

Definition

A set of related requests that can be used to capture intended activities that have inter-dependencies such as "give this medication after that one".

Comment

Constraint

dom-2 [error]

If the resource is contained in another resource, it SHALL NOT contain nested Resources

dom-3 [error]

If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource

dom-4 [error]

If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated

dom-5 [error]

If a resource is contained in another resource, it SHALL NOT have a security label

dom-6 [warning]

A resource should have narrative for robust management

Path

RequestOrchestration.identifier

Id

RequestOrchestration.identifier

Type

Identifier

Cardinality

0 - *

Definition

Allows a service to provide a unique, business identifier for the request.

Comment

Requirements

Allows identification of the request as it is known by various participating systems and in a way that remains consistent across servers.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

use

Summary: The element appears in the summary view

code

usual | official | temp | secondary | old (If known)

type

CodeableConcept

Description of identifier

coding

List: This element is a list and more than one value can be provided

Coding

Code defined by a terminology system

system

uri

Identity of the terminology system

version

string

Version of the system - if relevant

code

Symbol in syntax defined by the system

display

string

Representation defined by the system

userSelected

boolean

If this coding was chosen directly by the user

system

uri

The namespace for the identifier value

value

string

The value that is unique

period

Period

Time period when id is/was valid for use

start

dateTime

Starting time with inclusive boundary

end

dateTime

End time with inclusive boundary, if not ongoing

assigner

Reference

Organization that issued id (may be just text)

reference

string

Literal reference, Relative, internal or absolute URL

type

uri

Type the reference refers to (e.g. "Patient") - must be a resource in resources

identifier

Identifier

Logical reference, when literal reference is not known

Path

RequestOrchestration.identifier.Identifier.assigner.Reference.identifier

Id

Reference.identifier

Type

Identifier

Cardinality

0 - 1

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comment

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

ref-2

use

code

usual | official | temp | secondary | old (If known)

type

CodeableConcept

Description of identifier

system

uri

The namespace for the identifier value

value

string

The value that is unique

period

Period

Time period when id is/was valid for use

assigner

Reference

Organization that issued id (may be just text)

display

string

Text alternative for the resource

Path

RequestOrchestration.instantiatesCanonical

Id

RequestOrchestration.instantiatesCanonical

Type

canonical

Cardinality

0 - *

Definition

A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Path

RequestOrchestration.instantiatesUri

Id

RequestOrchestration.instantiatesUri

Type

uri

Cardinality

0 - *

Definition

A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Path

RequestOrchestration.basedOn

Id

RequestOrchestration.basedOn

Type

Reference

Cardinality

0 - *

Definition

A plan, proposal or order that is fulfilled in whole or in part by this request.

Comment

Requirements

Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

reference

string

Literal reference, Relative, internal or absolute URL

type

uri

Type the reference refers to (e.g. "Patient") - must be a resource in resources

identifier

Identifier

Logical reference, when literal reference is not known

Path

RequestOrchestration.basedOn.Reference.identifier

Id

Reference.identifier

Type

Identifier

Cardinality

0 - 1

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comment

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

ref-2

use

code

usual | official | temp | secondary | old (If known)

type

CodeableConcept

Description of identifier

system

uri

The namespace for the identifier value

value

string

The value that is unique

period

Period

Time period when id is/was valid for use

start

dateTime

Starting time with inclusive boundary

end

dateTime

End time with inclusive boundary, if not ongoing

assigner

Reference

Organization that issued id (may be just text)

reference

string

Literal reference, Relative, internal or absolute URL

type

uri

Type the reference refers to (e.g. "Patient") - must be a resource in resources

identifier

Identifier

Logical reference, when literal reference is not known

Path

RequestOrchestration.basedOn.Reference.identifier.Identifier.assigner.Reference.identifier

Id

Reference.identifier

Type

Identifier

Cardinality

0 - 1

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comment

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

ref-2

display

string

Text alternative for the resource

display

string

Text alternative for the resource

Path

RequestOrchestration.replaces

Id

RequestOrchestration.replaces

Type

Reference

Cardinality

0 - *

Definition

Completed or terminated request(s) whose function is taken by this new request.

Comment

The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing.

Requirements

Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

reference

string

Literal reference, Relative, internal or absolute URL

type

uri

Type the reference refers to (e.g. "Patient") - must be a resource in resources

identifier

Identifier

Logical reference, when literal reference is not known

Path

RequestOrchestration.replaces.Reference.identifier

Id

Reference.identifier

Type

Identifier

Cardinality

0 - 1

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comment

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

ref-2

use

code

usual | official | temp | secondary | old (If known)

type

CodeableConcept

Description of identifier

system

uri

The namespace for the identifier value

value

string

The value that is unique

period

Period

Time period when id is/was valid for use

start

dateTime

Starting time with inclusive boundary

end

dateTime

End time with inclusive boundary, if not ongoing

assigner

Reference

Organization that issued id (may be just text)

reference

string

Literal reference, Relative, internal or absolute URL

type

uri

Type the reference refers to (e.g. "Patient") - must be a resource in resources

identifier

Identifier

Logical reference, when literal reference is not known

Path

RequestOrchestration.replaces.Reference.identifier.Identifier.assigner.Reference.identifier

Id

Reference.identifier

Type

Identifier

Cardinality

0 - 1

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comment

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

ref-2

display

string

Text alternative for the resource

display

string

Text alternative for the resource

Path

RequestOrchestration.groupIdentifier

Id

RequestOrchestration.groupIdentifier

Type

Identifier

Cardinality

0 - 1

Definition

A shared identifier common to multiple independent Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.

Comment

Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.

Requirements

Some business processes need to know if multiple items were ordered as part of the same "prescription" or "requisition" for billing or other purposes.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

use

code

usual | official | temp | secondary | old (If known)

type

CodeableConcept

Description of identifier

coding

Coding

Code defined by a terminology system

system

uri

Identity of the terminology system

version

string

Version of the system - if relevant

code

Symbol in syntax defined by the system

display

string

Representation defined by the system

userSelected

boolean

If this coding was chosen directly by the user

system

uri

The namespace for the identifier value

value

string

The value that is unique

period

Period

Time period when id is/was valid for use

start

dateTime

Starting time with inclusive boundary

end

dateTime

End time with inclusive boundary, if not ongoing

assigner

Reference

Organization that issued id (may be just text)

reference

string

Literal reference, Relative, internal or absolute URL

type

uri

Type the reference refers to (e.g. "Patient") - must be a resource in resources

identifier

Identifier

Logical reference, when literal reference is not known

Path

RequestOrchestration.groupIdentifier.Identifier.assigner.Reference.identifier

Id

Reference.identifier

Type

Identifier

Cardinality

0 - 1

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comment

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

ref-2

use

code

usual | official | temp | secondary | old (If known)

type

CodeableConcept

Description of identifier

system

uri

The namespace for the identifier value

value

string

The value that is unique

period

Period

Time period when id is/was valid for use

assigner

Reference

Organization that issued id (may be just text)

display

string

Text alternative for the resource

Path

RequestOrchestration.status

Id

RequestOrchestration.status

Type

code

Cardinality

1 - 1

Definition

The current state of the request. For request orchestrations, the status reflects the status of all the requests in the orchestration.

Comment

Binding

Strength

required

Description

Codes identifying the lifecycle stage of a request.

ValueSet

http://hl7.org/fhir/ValueSet/request-status|5.0.0

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Path

RequestOrchestration.intent

Id

RequestOrchestration.intent

Type

code

Cardinality

1 - 1

Definition

Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.

Comment

Requirements

Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain.

Binding

Strength

required

Description

Codes indicating the degree of authority/intentionality associated with a request.

ValueSet

http://hl7.org/fhir/ValueSet/request-intent|5.0.0

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Path

RequestOrchestration.priority

Id

RequestOrchestration.priority

Type

code

Cardinality

0 - 1

Definition

Indicates how quickly the request should be addressed with respect to other requests.

Comment

Binding

Strength

required

Description

Identifies the level of importance to be assigned to actioning the request.

ValueSet

http://hl7.org/fhir/ValueSet/request-priority|5.0.0

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Path

RequestOrchestration.code

Id

RequestOrchestration.code

Type

CodeableConcept

Cardinality

0 - 1

Definition

A code that identifies what the overall request orchestration is.

Comment

This element can be used to provide a code that captures the meaning of the request orchestration as a whole, as opposed to the code of the action element, which captures the meaning of the individual actions within the request orchestration.

Binding

Strength

example

Description

ValueSet

http://hl7.org/fhir/ValueSet/action-code

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

coding

Coding

Code defined by a terminology system

system

uri

Identity of the terminology system

version

string

Version of the system - if relevant

code

Symbol in syntax defined by the system

display

string

Representation defined by the system

userSelected

boolean

If this coding was chosen directly by the user

Path

RequestOrchestration.subject

Id

RequestOrchestration.subject

Type

Reference

Cardinality

0 - 1

Definition

The subject for which the request orchestration was created.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

reference

string

Literal reference, Relative, internal or absolute URL

type

uri

Type the reference refers to (e.g. "Patient") - must be a resource in resources

identifier

Identifier

Logical reference, when literal reference is not known

Path

RequestOrchestration.subject.Reference.identifier

Id

Reference.identifier

Type

Identifier

Cardinality

0 - 1

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comment

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

ref-2

use

code

usual | official | temp | secondary | old (If known)

type

CodeableConcept

Description of identifier

system

uri

The namespace for the identifier value

value

string

The value that is unique

period

Period

Time period when id is/was valid for use

start

dateTime

Starting time with inclusive boundary

end

dateTime

End time with inclusive boundary, if not ongoing

assigner

Reference

Organization that issued id (may be just text)

reference

string

Literal reference, Relative, internal or absolute URL

type

uri

Type the reference refers to (e.g. "Patient") - must be a resource in resources

identifier

Identifier

Logical reference, when literal reference is not known

Path

RequestOrchestration.subject.Reference.identifier.Identifier.assigner.Reference.identifier

Id

Reference.identifier

Type

Identifier

Cardinality

0 - 1

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comment

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

ref-2

display

string

Text alternative for the resource

display

string

Text alternative for the resource

Path

RequestOrchestration.encounter

Id

RequestOrchestration.encounter

Type

Reference

Cardinality

0 - 1

Definition

Describes the context of the request orchestration, if any.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

reference

string

Literal reference, Relative, internal or absolute URL

type

uri

Type the reference refers to (e.g. "Patient") - must be a resource in resources

identifier

Identifier

Logical reference, when literal reference is not known

Path

RequestOrchestration.encounter.Reference.identifier

Id

Reference.identifier

Type

Identifier

Cardinality

0 - 1

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comment

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

ref-2

use

code

usual | official | temp | secondary | old (If known)

type

CodeableConcept

Description of identifier

system

uri

The namespace for the identifier value

value

string

The value that is unique

period

Period

Time period when id is/was valid for use

start

dateTime

Starting time with inclusive boundary

end

dateTime

End time with inclusive boundary, if not ongoing

assigner

Reference

Organization that issued id (may be just text)

reference

string

Literal reference, Relative, internal or absolute URL

type

uri

Type the reference refers to (e.g. "Patient") - must be a resource in resources

identifier

Identifier

Logical reference, when literal reference is not known

Path

RequestOrchestration.encounter.Reference.identifier.Identifier.assigner.Reference.identifier

Id

Reference.identifier

Type

Identifier

Cardinality

0 - 1

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comment

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

ref-2

display

string

Text alternative for the resource

display

string

Text alternative for the resource

Path

RequestOrchestration.authoredOn

Id

RequestOrchestration.authoredOn

Type

dateTime

Cardinality

0 - 1

Definition

Indicates when the request orchestration was created.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Path

RequestOrchestration.author

Id

RequestOrchestration.author

Type

Reference

Cardinality

0 - 1

Definition

Provides a reference to the author of the request orchestration.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

reference

string

Literal reference, Relative, internal or absolute URL

type

uri

Type the reference refers to (e.g. "Patient") - must be a resource in resources

identifier

Identifier

Logical reference, when literal reference is not known

Path

RequestOrchestration.author.Reference.identifier

Id

Reference.identifier

Type

Identifier

Cardinality

0 - 1

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comment

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

ref-2

use

code

usual | official | temp | secondary | old (If known)

type

CodeableConcept

Description of identifier

system

uri

The namespace for the identifier value

value

string

The value that is unique

period

Period

Time period when id is/was valid for use

start

dateTime

Starting time with inclusive boundary

end

dateTime

End time with inclusive boundary, if not ongoing

assigner

Reference

Organization that issued id (may be just text)

reference

string

Literal reference, Relative, internal or absolute URL

type

uri

Type the reference refers to (e.g. "Patient") - must be a resource in resources

identifier

Identifier

Logical reference, when literal reference is not known

Path

RequestOrchestration.author.Reference.identifier.Identifier.assigner.Reference.identifier

Id

Reference.identifier

Type

Identifier

Cardinality

0 - 1

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comment

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

ref-2

display

string

Text alternative for the resource

display

string

Text alternative for the resource

Path

RequestOrchestration.reason

Id

RequestOrchestration.reason

Type

CodeableReference

Cardinality

0 - *

Definition

Describes the reason for the request orchestration in coded or textual form.

Comment

Binding

Strength

example

Description

ValueSet

http://hl7.org/fhir/ValueSet/action-reason-code

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

concept

CodeableConcept

Reference to a concept (by class)

coding

Coding

Code defined by a terminology system

system

uri

Identity of the terminology system

version

string

Version of the system - if relevant

code

Symbol in syntax defined by the system

display

string

Representation defined by the system

userSelected

boolean

If this coding was chosen directly by the user

reference

Reference

Reference to a resource (by instance)

reference

string

Literal reference, Relative, internal or absolute URL

type

uri

Type the reference refers to (e.g. "Patient") - must be a resource in resources

identifier

Identifier

Logical reference, when literal reference is not known

Path

RequestOrchestration.reason.CodeableReference.reference.Reference.identifier

Id

Reference.identifier

Type

Identifier

Cardinality

0 - 1

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comment

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

ref-2

use

code

usual | official | temp | secondary | old (If known)

type

CodeableConcept

Description of identifier

system

uri

The namespace for the identifier value

value

string

The value that is unique

period

Period

Time period when id is/was valid for use

assigner

Reference

Organization that issued id (may be just text)

display

string

Text alternative for the resource

Path

RequestOrchestration.goal

Id

RequestOrchestration.goal

Type

Reference

Cardinality

0 - *

Definition

Goals that are intended to be achieved by following the requests in this RequestOrchestration.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

reference

string

Literal reference, Relative, internal or absolute URL

type

uri

Type the reference refers to (e.g. "Patient") - must be a resource in resources

identifier

Identifier

Logical reference, when literal reference is not known

Path

RequestOrchestration.goal.Reference.identifier

Id

Reference.identifier

Type

Identifier

Cardinality

0 - 1

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comment

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

ref-2

use

code

usual | official | temp | secondary | old (If known)

type

CodeableConcept

Description of identifier

system

uri

The namespace for the identifier value

value

string

The value that is unique

period

Period

Time period when id is/was valid for use

start

dateTime

Starting time with inclusive boundary

end

dateTime

End time with inclusive boundary, if not ongoing

assigner

Reference

Organization that issued id (may be just text)

reference

string

Literal reference, Relative, internal or absolute URL

type

uri

Type the reference refers to (e.g. "Patient") - must be a resource in resources

identifier

Identifier

Logical reference, when literal reference is not known

Path

RequestOrchestration.goal.Reference.identifier.Identifier.assigner.Reference.identifier

Id

Reference.identifier

Type

Identifier

Cardinality

0 - 1

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comment

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

ref-2

display

string

Text alternative for the resource

display

string

Text alternative for the resource

Path

RequestOrchestration.note

Id

RequestOrchestration.note

Type

Annotation

Cardinality

0 - *

Definition

Provides a mechanism to communicate additional information about the response.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

author[x]

Reference

Individual responsible for the annotation

reference

string

Literal reference, Relative, internal or absolute URL

type

uri

Type the reference refers to (e.g. "Patient") - must be a resource in resources

identifier

Identifier

Logical reference, when literal reference is not known

Path

RequestOrchestration.note.Annotation.author[x].Reference.identifier

Id

Reference.identifier

Type

Identifier

Cardinality

0 - 1

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comment

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

ref-2

use

code

usual | official | temp | secondary | old (If known)

type

CodeableConcept

Description of identifier

system

uri

The namespace for the identifier value

value

string

The value that is unique

period

Period

Time period when id is/was valid for use

assigner

Reference

Organization that issued id (may be just text)

display

string

Text alternative for the resource

time

dateTime

When the annotation was made

Path

RequestOrchestration.action

Id

RequestOrchestration.action

Type

BackboneElement

Cardinality

0 - *

Definition

The actions, if any, produced by the evaluation of the artifact.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

rqg-1 [error]

Must have resource or action but not both

Path

RequestOrchestration.action.linkId

Id

RequestOrchestration.action.linkId

Type

string

Cardinality

0 - 1

Definition

The linkId of the action from the PlanDefinition that corresponds to this action in the RequestOrchestration resource.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Path

RequestOrchestration.action.prefix

Id

RequestOrchestration.action.prefix

Type

string

Cardinality

0 - 1

Definition

A user-visible prefix for the action. For example a section or item numbering such as 1. or A.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Path

RequestOrchestration.action.title

Id

RequestOrchestration.action.title

Type

string

Cardinality

0 - 1

Definition

The title of the action displayed to a user.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Path

RequestOrchestration.action.description

Id

RequestOrchestration.action.description

Type

markdown

Cardinality

0 - 1

Definition

A short description of the action used to provide a summary to display to the user.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Path

RequestOrchestration.action.textEquivalent

Id

RequestOrchestration.action.textEquivalent

Type

markdown

Cardinality

0 - 1

Definition

A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Path

RequestOrchestration.action.priority

Id

RequestOrchestration.action.priority

Type

code

Cardinality

0 - 1

Definition

Indicates how quickly the action should be addressed with respect to other actions.

Comment

Binding

Strength

required

Description

Identifies the level of importance to be assigned to actioning the request.

ValueSet

http://hl7.org/fhir/ValueSet/request-priority|5.0.0

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Path

RequestOrchestration.action.code

Id

RequestOrchestration.action.code

Type

CodeableConcept

Cardinality

0 - *

Definition

A code that provides meaning for the action or action group. For example, a section may have a LOINC code for a section of a documentation template.

Comment

Binding

Strength

example

Description

ValueSet

http://hl7.org/fhir/ValueSet/action-code

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

coding

Coding

Code defined by a terminology system

system

uri

Identity of the terminology system

version

string

Version of the system - if relevant

code

Symbol in syntax defined by the system

display

string

Representation defined by the system

userSelected

boolean

If this coding was chosen directly by the user

Path

RequestOrchestration.action.documentation

Id

RequestOrchestration.action.documentation

Type

RelatedArtifact

Cardinality

0 - *

Definition

Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

type

code

classifier

CodeableConcept

Additional classifiers

label

string

Short label

display

string

Brief description of the related artifact

citation

markdown

Bibliographic citation for the artifact

document

Attachment

What document is being referenced

contentType

code

Mime type of the content, with charset etc.

data

base64Binary

Data inline, base64ed

url

Uri where the data can be found

size

integer64

Number of bytes of content (if url provided)

hash

base64Binary

Hash of the data (sha-1, base64ed)

title

string

Label to display in place of the data

creation

dateTime

Date attachment was first created

height

positiveInt

Height of the image in pixels (photo/video)

width

positiveInt

Width of the image in pixels (photo/video)

frames

positiveInt

Number of frames if > 1 (photo)

duration

decimal

Length in seconds (audio / video)

pages

positiveInt

Number of printed pages

resource

canonical

What artifact is being referenced

resourceReference

Reference

What artifact, if not a conformance resource

reference

string

Literal reference, Relative, internal or absolute URL

type

uri

Type the reference refers to (e.g. "Patient") - must be a resource in resources

identifier

Identifier

Logical reference, when literal reference is not known

Path

RequestOrchestration.action.documentation.RelatedArtifact.resourceReference.Reference.identifier

Id

Reference.identifier

Type

Identifier

Cardinality

0 - 1

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comment

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

ref-2

display

string

Text alternative for the resource

publicationStatus

code

draft | active | retired | unknown

publicationDate

date

Date of publication of the artifact being referred to

Path

RequestOrchestration.action.goal

Id

RequestOrchestration.action.goal

Type

Reference

Cardinality

0 - *

Definition

Goals that are intended to be achieved by following the requests in this action.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

reference

string

Literal reference, Relative, internal or absolute URL

type

uri

Type the reference refers to (e.g. "Patient") - must be a resource in resources

identifier

Identifier

Logical reference, when literal reference is not known

Path

RequestOrchestration.action.goal.Reference.identifier

Id

Reference.identifier

Type

Identifier

Cardinality

0 - 1

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comment

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

ref-2

use

code

usual | official | temp | secondary | old (If known)

type

CodeableConcept

Description of identifier

system

uri

The namespace for the identifier value

value

string

The value that is unique

period

Period

Time period when id is/was valid for use

assigner

Reference

Organization that issued id (may be just text)

display

string

Text alternative for the resource

Path

RequestOrchestration.action.condition

Id

RequestOrchestration.action.condition

Type

BackboneElement

Cardinality

0 - *

Definition

An expression that describes applicability criteria, or start/stop conditions for the action.

Comment

When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all of the conditions are true.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Path

RequestOrchestration.action.condition.kind

Id

RequestOrchestration.action.condition.kind

Type

code

Cardinality

1 - 1

Definition

The kind of condition.

Comment

Applicability criteria are used to determine immediate applicability when a plan definition is applied to a given context. Start and stop criteria are carried through application and used to describe enter/exit criteria for an action.

Binding

Strength

required

Description

The kind of condition for the action.

ValueSet

http://hl7.org/fhir/ValueSet/action-condition-kind|5.0.0

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Path

RequestOrchestration.action.condition.expression

Id

RequestOrchestration.action.condition.expression

Type

Expression

Cardinality

0 - 1

Definition

An expression that returns true or false, indicating whether or not the condition is satisfied.

Comment

The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

description

string

Natural language description of the condition

Path

RequestOrchestration.action.condition.expression.Expression.description

Id

Expression.description

Type

string

Cardinality

0 - 1

Definition

A brief, natural language description of the condition that effectively communicates the intended semantics.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

name

code

Short name assigned to expression for reuse

expression

string

Expression in specified language

reference

uri

Where the expression is found

Path

RequestOrchestration.action.input

Id

RequestOrchestration.action.input

Type

BackboneElement

Cardinality

0 - *

Definition

Defines input data requirements for the action.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

pld-0 [error]

Input data elements must have a requirement or a relatedData, but not both

Path

RequestOrchestration.action.input.title

Id

RequestOrchestration.action.input.title

Type

string

Cardinality

0 - 1

Definition

A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Path

RequestOrchestration.action.input.requirement

Id

RequestOrchestration.action.input.requirement

Type

DataRequirement

Cardinality

0 - 1

Definition

Defines the data that is to be provided as input to the action.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

pld-0

type

code

The type of the required data

profile

canonical

The profile of the required data

subject[x]

CodeableConcept

E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device

mustSupport

string

Indicates specific structure elements that are referenced by the knowledge module

codeFilter

Element

What codes are expected

path

string

A code-valued attribute to filter on

searchParam

string

A coded (token) parameter to search on

valueSet

canonical

ValueSet for the filter

code

Coding

What code is expected

dateFilter

Element

What dates/date ranges are expected

path

string

A date-valued attribute to filter on

searchParam

string

A date valued parameter to search on

value[x]

dateTime

The value of the filter, as a Period, DateTime, or Duration value

valueFilter

Element

What values are expected

path

string

An attribute to filter on

searchParam

string

A parameter to search on

comparator

code

eq | gt | lt | ge | le | sa | eb

value[x]

dateTime

The value of the filter, as a Period, DateTime, or Duration value

limit

positiveInt

Number of results

sort

Element

Order of the results

path

string

The name of the attribute to perform the sort

direction

code

ascending | descending

Path

RequestOrchestration.action.input.relatedData

Id

RequestOrchestration.action.input.relatedData

Type

id

Cardinality

0 - 1

Definition

Points to an existing input or output element that provides data to this input.

Comment

The relatedData element allows indicating that an input to a parent action is an input to specific child actions. It also allows the output of one action to be identified as the input to a different action

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

pld-0

Path

RequestOrchestration.action.output

Id

RequestOrchestration.action.output

Type

BackboneElement

Cardinality

0 - *

Definition

Defines the outputs of the action, if any.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

pld-1 [error]

Output data element must have a requirement or a relatedData, but not both

Path

RequestOrchestration.action.output.title

Id

RequestOrchestration.action.output.title

Type

string

Cardinality

0 - 1

Definition

A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Path

RequestOrchestration.action.output.requirement

Id

RequestOrchestration.action.output.requirement

Type

DataRequirement

Cardinality

0 - 1

Definition

Defines the data that results as output from the action.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

pld-1

type

code

The type of the required data

profile

canonical

The profile of the required data

subject[x]

CodeableConcept

E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device

mustSupport

string

Indicates specific structure elements that are referenced by the knowledge module

codeFilter

Element

What codes are expected

path

string

A code-valued attribute to filter on

searchParam

string

A coded (token) parameter to search on

valueSet

canonical

ValueSet for the filter

code

Coding

What code is expected

dateFilter

Element

What dates/date ranges are expected

path

string

A date-valued attribute to filter on

searchParam

string

A date valued parameter to search on

value[x]

dateTime

The value of the filter, as a Period, DateTime, or Duration value

valueFilter

Element

What values are expected

path

string

An attribute to filter on

searchParam

string

A parameter to search on

comparator

code

eq | gt | lt | ge | le | sa | eb

value[x]

dateTime

The value of the filter, as a Period, DateTime, or Duration value

limit

positiveInt

Number of results

sort

Element

Order of the results

path

string

The name of the attribute to perform the sort

direction

code

ascending | descending

Path

RequestOrchestration.action.output.relatedData

Id

RequestOrchestration.action.output.relatedData

Type

string

Cardinality

0 - 1

Definition

Points to an existing input or output element that is results as output from the action.

Comment

The relatedData element allows indicating that the output of child action is also the output of a parent action. It also allows the input of one action to be identified as the output of a different action

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

pld-1

Path

RequestOrchestration.action.relatedAction

Id

RequestOrchestration.action.relatedAction

Type

BackboneElement

Cardinality

0 - *

Definition

A relationship to another action such as "before" or "30-60 minutes after start of".

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Path

RequestOrchestration.action.relatedAction.targetId

Id

RequestOrchestration.action.relatedAction.targetId

Type

id

Cardinality

1 - 1

Definition

The element id of the target related action.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Path

RequestOrchestration.action.relatedAction.relationship

Id

RequestOrchestration.action.relatedAction.relationship

Type

code

Cardinality

1 - 1

Definition

The relationship of this action to the related action.

Comment

Binding

Strength

required

Description

Defines the types of relationships between actions.

ValueSet

http://hl7.org/fhir/ValueSet/action-relationship-type|5.0.0

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Path

RequestOrchestration.action.relatedAction.endRelationship

Id

RequestOrchestration.action.relatedAction.endRelationship

Type

code

Cardinality

0 - 1

Definition

The relationship of the end of this action to the related action.

Comment

Binding

Strength

required

Description

Defines the types of relationships between actions.

ValueSet

http://hl7.org/fhir/ValueSet/action-relationship-type|5.0.0

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Path

RequestOrchestration.action.relatedAction.offset[x]

Id

RequestOrchestration.action.relatedAction.offset[x]

Type

Duration

Cardinality

0 - 1

Definition

A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

value

decimal

Numerical value (with implicit precision)

comparator

code

< | <= | >= | > | ad - how to understand the value

unit

string

Unit representation

system

uri

System that defines coded unit form

code

Coded form of the unit

Path

RequestOrchestration.action.timing[x]

Id

RequestOrchestration.action.timing[x]

Type

dateTime

Cardinality

0 - 1

Definition

An optional value describing when the action should be performed.

Comment

The intent of the timing element is to provide timing for when the action should be performed. The timing may be absolute (specified as a dateTime or Period) or relative (specified as an Age, Duration, or Range), or it may be a more complex, potentially repeating timing specified using Timing.

Requirements

Allows prompting for activities and detection of missed planned activities.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Path

RequestOrchestration.action.location

Id

RequestOrchestration.action.location

Type

CodeableReference

Cardinality

0 - 1

Definition

Identifies the facility where the action will occur; e.g. home, hospital, specific clinic, etc.

Comment

May reference a specific clinical location or may just identify a type of location.

Requirements

Helps in planning of activity.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

concept

CodeableConcept

Reference to a concept (by class)

reference

Reference

Reference to a resource (by instance)

reference

string

Literal reference, Relative, internal or absolute URL

type

uri

Type the reference refers to (e.g. "Patient") - must be a resource in resources

identifier

Identifier

Logical reference, when literal reference is not known

Path

RequestOrchestration.action.location.CodeableReference.reference.Reference.identifier

Id

Reference.identifier

Type

Identifier

Cardinality

0 - 1

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comment

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

ref-2

display

string

Text alternative for the resource

Path

RequestOrchestration.action.participant

Id

RequestOrchestration.action.participant

Type

BackboneElement

Cardinality

0 - *

Definition

The participant that should perform or be responsible for this action.

Comment

Because request orchestrations represent potential options for performing activities, some specific participants may still be unknown, so this element allows for both definitional participants (in the same way they are specified in ActivityDefinition and PlanDefinition resources) as well as identifying specific participants when they are known.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Path

RequestOrchestration.action.participant.type

Id

RequestOrchestration.action.participant.type

Type

code

Cardinality

0 - 1

Definition

The type of participant in the action.

Comment

Binding

Strength

required

Description

The type of participant in the activity.

ValueSet

http://hl7.org/fhir/ValueSet/action-participant-type|5.0.0

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Path

RequestOrchestration.action.participant.typeCanonical

Id

RequestOrchestration.action.participant.typeCanonical

Type

canonical

Cardinality

0 - 1

Definition

The type of participant in the action.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Path

RequestOrchestration.action.participant.typeReference

Id

RequestOrchestration.action.participant.typeReference

Type

Reference

Cardinality

0 - 1

Definition

The type of participant in the action.

Comment

When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location).

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

reference

string

Literal reference, Relative, internal or absolute URL

type

uri

Type the reference refers to (e.g. "Patient") - must be a resource in resources

identifier

Identifier

Logical reference, when literal reference is not known

Path

RequestOrchestration.action.participant.typeReference.Reference.identifier

Id

Reference.identifier

Type

Identifier

Cardinality

0 - 1

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comment

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

ref-2

display

string

Text alternative for the resource

Path

RequestOrchestration.action.participant.role

Id

RequestOrchestration.action.participant.role

Type

CodeableConcept

Cardinality

0 - 1

Definition

The role the participant should play in performing the described action.

Comment

Binding

Strength

example

Description

Defines roles played by participants for the action.

ValueSet

http://terminology.hl7.org/ValueSet/action-participant-role

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

coding

Coding

Code defined by a terminology system

Path

RequestOrchestration.action.participant.function

Id

RequestOrchestration.action.participant.function

Type

CodeableConcept

Cardinality

0 - 1

Definition

Indicates how the actor will be involved in the action - author, reviewer, witness, etc.

Comment

Binding

Strength

example

Description

ValueSet

http://hl7.org/fhir/ValueSet/action-participant-function

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

coding

Coding

Code defined by a terminology system

Path

RequestOrchestration.action.participant.actor[x]

Id

RequestOrchestration.action.participant.actor[x]

Type

canonical

Cardinality

0 - 1

Definition

A reference to the actual participant.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Path

RequestOrchestration.action.type

Id

RequestOrchestration.action.type

Type

CodeableConcept

Cardinality

0 - 1

Definition

The type of action to perform (create, update, remove).

Comment

Binding

Strength

extensible

Description

The type of action to be performed.

ValueSet

http://hl7.org/fhir/ValueSet/action-type

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

coding

Coding

Code defined by a terminology system

system

uri

Identity of the terminology system

version

string

Version of the system - if relevant

code

Symbol in syntax defined by the system

display

string

Representation defined by the system

userSelected

boolean

If this coding was chosen directly by the user

Path

RequestOrchestration.action.groupingBehavior

Id

RequestOrchestration.action.groupingBehavior

Type

code

Cardinality

0 - 1

Definition

Defines the grouping behavior for the action and its children.

Comment

Binding

Strength

required

Description

Defines organization behavior of a group.

ValueSet

http://hl7.org/fhir/ValueSet/action-grouping-behavior|5.0.0

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Path

RequestOrchestration.action.selectionBehavior

Id

RequestOrchestration.action.selectionBehavior

Type

code

Cardinality

0 - 1

Definition

Defines the selection behavior for the action and its children.

Comment

Binding

Strength

required

Description

Defines selection behavior of a group.

ValueSet

http://hl7.org/fhir/ValueSet/action-selection-behavior|5.0.0

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Path

RequestOrchestration.action.requiredBehavior

Id

RequestOrchestration.action.requiredBehavior

Type

code

Cardinality

0 - 1

Definition

Defines expectations around whether an action is required.

Comment

Binding

Strength

required

Description

Defines expectations around whether an action or action group is required.

ValueSet

http://hl7.org/fhir/ValueSet/action-required-behavior|5.0.0

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Path

RequestOrchestration.action.precheckBehavior

Id

RequestOrchestration.action.precheckBehavior

Type

code

Cardinality

0 - 1

Definition

Defines whether the action should usually be preselected.

Comment

Binding

Strength

required

Description

Defines selection frequency behavior for an action or group.

ValueSet

http://hl7.org/fhir/ValueSet/action-precheck-behavior|5.0.0

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Path

RequestOrchestration.action.cardinalityBehavior

Id

RequestOrchestration.action.cardinalityBehavior

Type

code

Cardinality

0 - 1

Definition

Defines whether the action can be selected multiple times.

Comment

Binding

Strength

required

Description

Defines behavior for an action or a group for how many times that item may be repeated.

ValueSet

http://hl7.org/fhir/ValueSet/action-cardinality-behavior|5.0.0

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Path

RequestOrchestration.action.resource

Id

RequestOrchestration.action.resource

Type

Reference

Cardinality

0 - 1

Definition

The resource that is the target of the action (e.g. CommunicationRequest).

Comment

The target resource SHALL be a [Request](request.html) resource with a Request.intent set to "option".

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

rqg-1

reference

string

Literal reference, Relative, internal or absolute URL

type

uri

Type the reference refers to (e.g. "Patient") - must be a resource in resources

identifier

Identifier

Logical reference, when literal reference is not known

Path

RequestOrchestration.action.resource.Reference.identifier

Id

Reference.identifier

Type

Identifier

Cardinality

0 - 1

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comment

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

ref-2

use

code

usual | official | temp | secondary | old (If known)

type

CodeableConcept

Description of identifier

system

uri

The namespace for the identifier value

value

string

The value that is unique

period

Period

Time period when id is/was valid for use

assigner

Reference

Organization that issued id (may be just text)

display

string

Text alternative for the resource

Path

RequestOrchestration.action.definition[x]

Id

RequestOrchestration.action.definition[x]

Type

canonical

Cardinality

0 - 1

Definition

A reference to an ActivityDefinition that describes the action to be taken in detail, a PlanDefinition that describes a series of actions to be taken, a Questionnaire that should be filled out, a SpecimenDefinition describing a specimen to be collected, or an ObservationDefinition that specifies what observation should be captured.

Comment

Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Path

RequestOrchestration.action.transform

Id

RequestOrchestration.action.transform

Type

canonical

Cardinality

0 - 1

Definition

A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.

Comment

Note that when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Path

RequestOrchestration.action.dynamicValue

Id

RequestOrchestration.action.dynamicValue

Type

BackboneElement

Cardinality

0 - *

Definition

Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result.

Comment

Dynamic values are applied in the order in which they are defined in the RequestOrchestration resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Path

RequestOrchestration.action.dynamicValue.path

Id

RequestOrchestration.action.dynamicValue.path

Type

string

Cardinality

0 - 1

Definition

The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolvable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).

Comment

To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a [Simple FHIRPath Subset](fhirpath.html#simple) that allows path traversal, but not calculation.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Path

RequestOrchestration.action.dynamicValue.expression

Id

RequestOrchestration.action.dynamicValue.expression

Type

Expression

Cardinality

0 - 1

Definition

An expression specifying the value of the customized element.

Comment

The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

description

string

Natural language description of the condition

Path

RequestOrchestration.action.dynamicValue.expression.Expression.description

Id

Expression.description

Type

string

Cardinality

0 - 1

Definition

A brief, natural language description of the condition that effectively communicates the intended semantics.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

name

code

Short name assigned to expression for reuse

expression

string

Expression in specified language

reference

uri

Where the expression is found

Path

RequestOrchestration.action.action

Id

RequestOrchestration.action.action

Type

RequestOrchestration.action.action

Cardinality

0 - *

Definition

Sub actions.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children