Extensions for Using Data Elements from FHIR R4B in FHIR R5
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R4B in FHIR R5 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R4B_RequestGroup_R5_RequestOrchestration

Official URL: http://hl7.org/fhir/4.3/StructureDefinition/profile-RequestGroup-for-RequestOrchestration Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R4B_RequestGroup_R5_RequestOrchestration

This cross-version profile allows R4B RequestGroup content to be represented via FHIR R5 RequestOrchestration resources.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RequestOrchestration 0..* RequestOrchestration(5.0.0) A set of related requests
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:reasonCode 0..* CodeableConcept R4B: Why the request group is needed (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-RequestGroup.reasonCode
Constraints: ext-1
.... extension:reasonReference 0..* Reference(Cross-version Profile for R4B.Condition for use in FHIR R5(0.1.0) | Condition | Cross-version Profile for R4B.Observation for use in FHIR R5(0.1.0) | Observation | Cross-version Profile for R4B.DiagnosticReport for use in FHIR R5(0.1.0) | DiagnosticReport | Cross-version Profile for R4B.DocumentReference for use in FHIR R5(0.1.0) | DocumentReference) R4B: Why the request group is needed (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-RequestGroup.reasonReference
Constraints: ext-1
... status ?!Σ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Codes identifying the lifecycle stage of a request.
... intent ?!Σ 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RequestOrchestration.​status Base required RequestStatus 📍5.0.0 FHIR Std.
RequestOrchestration.​intent Base required RequestIntent 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error RequestOrchestration If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error RequestOrchestration 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 contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error RequestOrchestration If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error RequestOrchestration If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice RequestOrchestration A resource should have narrative for robust management text.`div`.exists()
ele-1 error RequestOrchestration.implicitRules, RequestOrchestration.extension, RequestOrchestration.extension:reasonCode, RequestOrchestration.extension:reasonReference, RequestOrchestration.modifierExtension, RequestOrchestration.status, RequestOrchestration.intent All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error RequestOrchestration.extension, RequestOrchestration.extension:reasonCode, RequestOrchestration.extension:reasonReference, RequestOrchestration.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from RequestOrchestration

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RequestOrchestration 0..* RequestOrchestration(5.0.0) A set of related requests
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:reasonCode 0..* CodeableConcept R4B: Why the request group is needed (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-RequestGroup.reasonCode
.... extension:reasonReference 0..* Reference(Cross-version Profile for R4B.Condition for use in FHIR R5(0.1.0) | Condition | Cross-version Profile for R4B.Observation for use in FHIR R5(0.1.0) | Observation | Cross-version Profile for R4B.DiagnosticReport for use in FHIR R5(0.1.0) | DiagnosticReport | Cross-version Profile for R4B.DocumentReference for use in FHIR R5(0.1.0) | DocumentReference) R4B: Why the request group is needed (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-RequestGroup.reasonReference

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RequestOrchestration 0..* RequestOrchestration(5.0.0) A set of related requests
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:reasonCode 0..* CodeableConcept R4B: Why the request group is needed (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-RequestGroup.reasonCode
Constraints: ext-1
.... extension:reasonReference 0..* Reference(Cross-version Profile for R4B.Condition for use in FHIR R5(0.1.0) | Condition | Cross-version Profile for R4B.Observation for use in FHIR R5(0.1.0) | Observation | Cross-version Profile for R4B.DiagnosticReport for use in FHIR R5(0.1.0) | DiagnosticReport | Cross-version Profile for R4B.DocumentReference for use in FHIR R5(0.1.0) | DocumentReference) R4B: Why the request group is needed (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-RequestGroup.reasonReference
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier Business identifier
... instantiatesCanonical Σ 0..* canonical() Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn 0..* Reference(Resource) Fulfills plan, proposal, or order
... replaces 0..* Reference(Resource) Request(s) replaced by this request
... groupIdentifier Σ 0..1 Identifier Composite request this is part of
... status ?!Σ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Codes identifying the lifecycle stage of a request.
... intent ?!Σ 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request.
... priority Σ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
... code Σ 0..1 CodeableConcept What's being requested/ordered
Binding: ActionCode (example)
... subject 0..1 Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) Who the request orchestration is about
... encounter 0..1 Reference(Encounter) Created as part of
... authoredOn 0..1 dateTime When the request orchestration was authored
... author 0..1 Reference(Device | Practitioner | PractitionerRole) Device or practitioner that authored the request orchestration
... reason 0..* CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference) Why the request orchestration is needed
Binding: ActionReasonCode (example)
... goal 0..* Reference(Goal) What goals
... note 0..* Annotation Additional notes about the response
... action C 0..* BackboneElement Proposed actions, if any
Constraints: rqg-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... linkId 0..1 string Pointer to specific item from the PlanDefinition
.... prefix 0..1 string User-visible prefix for the action (e.g. 1. or A.)
.... title 0..1 string User-visible title
.... description Σ 0..1 markdown Short description of the action
.... textEquivalent Σ 0..1 markdown Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
.... priority 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
.... code 0..* CodeableConcept Code representing the meaning of the action or sub-actions
Binding: ActionCode (example)
.... documentation 0..* RelatedArtifact Supporting documentation for the intended performer of the action
.... goal 0..* Reference(Goal) What goals
.... condition 0..* BackboneElement Whether or not the action is applicable
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... kind 1..1 code applicability | start | stop
Binding: ActionConditionKind (required): The kind of condition for the action.
..... expression 0..1 Expression Boolean-valued expression
.... input C 0..* BackboneElement Input data requirements
Constraints: pld-0
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... title 0..1 string User-visible title
..... requirement C 0..1 DataRequirement What data is provided
..... relatedData C 0..1 id What data is provided
.... output C 0..* BackboneElement Output data definition
Constraints: pld-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... title 0..1 string User-visible title
..... requirement C 0..1 DataRequirement What data is provided
..... relatedData C 0..1 string What data is provided
.... relatedAction 0..* BackboneElement Relationship to another action
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... targetId 1..1 id What action this is related to
..... relationship 1..1 code before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
..... endRelationship 0..1 code before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
..... offset[x] 0..1 Time offset for the relationship
...... offsetDuration Duration
...... offsetRange Range
.... timing[x] 0..1 When the action should take place
..... timingDateTime dateTime
..... timingAge Age
..... timingPeriod Period
..... timingDuration Duration
..... timingRange Range
..... timingTiming Timing
.... location 0..1 CodeableReference(Location) Where it should happen
.... participant 0..* BackboneElement Who should perform the action
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... type 0..1 code careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ActionParticipantType (required): The type of participant in the activity.
..... typeCanonical 0..1 canonical(CapabilityStatement) Who or what can participate
..... typeReference 0..1 Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) Who or what can participate
..... role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent, etc
Binding: ActionParticipantRole (2.0.0) (example): Defines roles played by participants for the action.
..... function 0..1 CodeableConcept E.g. Author, Reviewer, Witness, etc
Binding: ActionParticipantFunction (example)
..... actor[x] 0..1 canonical(CapabilityStatement), Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) Who/what is participating?
.... type 0..1 CodeableConcept create | update | remove | fire-event
Binding: ActionType (extensible): The type of action to be performed.
.... groupingBehavior 0..1 code visual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
.... selectionBehavior 0..1 code any | all | all-or-none | exactly-one | at-most-one | one-or-more
Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.
.... requiredBehavior 0..1 code must | could | must-unless-documented
Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
.... precheckBehavior 0..1 code yes | no
Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
.... cardinalityBehavior 0..1 code single | multiple
Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.
.... resource C 0..1 Reference(Resource) The target of the action
.... definition[x] 0..1 Description of the activity to be performed
..... definitionCanonical canonical(ActivityDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition)
..... definitionUri uri
.... transform 0..1 canonical(StructureMap) Transform to apply the template
.... dynamicValue 0..* BackboneElement Dynamic aspects of the definition
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... path 0..1 string The path to the element to be set dynamically
..... expression 0..1 Expression An expression that provides the dynamic value for the customization
.... action 0..* See action (RequestOrchestration) Sub action

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RequestOrchestration.​language Base required All Languages 📍5.0.0 FHIR Std.
RequestOrchestration.​status Base required RequestStatus 📍5.0.0 FHIR Std.
RequestOrchestration.​intent Base required RequestIntent 📍5.0.0 FHIR Std.
RequestOrchestration.​priority Base required RequestPriority 📍5.0.0 FHIR Std.
RequestOrchestration.​code Base example Action Code 📍5.0.0 FHIR Std.
RequestOrchestration.​reason Base example Action Reason Code 📍5.0.0 FHIR Std.
RequestOrchestration.​action.priority Base required RequestPriority 📍5.0.0 FHIR Std.
RequestOrchestration.​action.code Base example Action Code 📍5.0.0 FHIR Std.
RequestOrchestration.​action.condition.kind Base required Action Condition Kind 📍5.0.0 FHIR Std.
RequestOrchestration.​action.relatedAction.​relationship Base required Action Relationship Type 📍5.0.0 FHIR Std.
RequestOrchestration.​action.relatedAction.​endRelationship Base required Action Relationship Type 📍5.0.0 FHIR Std.
RequestOrchestration.​action.participant.type Base required Action Participant Type 📍5.0.0 FHIR Std.
RequestOrchestration.​action.participant.role Base example Action Participant Role 📍2.0.0 THO v7.1
RequestOrchestration.​action.participant.function Base example Action Participant Function 📍5.0.0 FHIR Std.
RequestOrchestration.​action.type Base extensible Action Type 📍5.0.0 FHIR Std.
RequestOrchestration.​action.groupingBehavior Base required Action Grouping Behavior 📍5.0.0 FHIR Std.
RequestOrchestration.​action.selectionBehavior Base required Action Selection Behavior 📍5.0.0 FHIR Std.
RequestOrchestration.​action.requiredBehavior Base required Action Required Behavior 📍5.0.0 FHIR Std.
RequestOrchestration.​action.precheckBehavior Base required Action Precheck Behavior 📍5.0.0 FHIR Std.
RequestOrchestration.​action.cardinalityBehavior Base required Action Cardinality Behavior 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error RequestOrchestration If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error RequestOrchestration 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 contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error RequestOrchestration If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error RequestOrchestration If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice RequestOrchestration A resource should have narrative for robust management text.`div`.exists()
ele-1 error RequestOrchestration.meta, RequestOrchestration.implicitRules, RequestOrchestration.language, RequestOrchestration.text, RequestOrchestration.extension, RequestOrchestration.extension:reasonCode, RequestOrchestration.extension:reasonReference, RequestOrchestration.modifierExtension, RequestOrchestration.identifier, RequestOrchestration.instantiatesCanonical, RequestOrchestration.instantiatesUri, RequestOrchestration.basedOn, RequestOrchestration.replaces, RequestOrchestration.groupIdentifier, RequestOrchestration.status, RequestOrchestration.intent, RequestOrchestration.priority, RequestOrchestration.code, RequestOrchestration.subject, RequestOrchestration.encounter, RequestOrchestration.authoredOn, RequestOrchestration.author, RequestOrchestration.reason, RequestOrchestration.goal, RequestOrchestration.note, RequestOrchestration.action, RequestOrchestration.action.extension, RequestOrchestration.action.modifierExtension, RequestOrchestration.action.linkId, RequestOrchestration.action.prefix, RequestOrchestration.action.title, RequestOrchestration.action.description, RequestOrchestration.action.textEquivalent, RequestOrchestration.action.priority, RequestOrchestration.action.code, RequestOrchestration.action.documentation, RequestOrchestration.action.goal, RequestOrchestration.action.condition, RequestOrchestration.action.condition.extension, RequestOrchestration.action.condition.modifierExtension, RequestOrchestration.action.condition.kind, RequestOrchestration.action.condition.expression, RequestOrchestration.action.input, RequestOrchestration.action.input.extension, RequestOrchestration.action.input.modifierExtension, RequestOrchestration.action.input.title, RequestOrchestration.action.input.requirement, RequestOrchestration.action.input.relatedData, RequestOrchestration.action.output, RequestOrchestration.action.output.extension, RequestOrchestration.action.output.modifierExtension, RequestOrchestration.action.output.title, RequestOrchestration.action.output.requirement, RequestOrchestration.action.output.relatedData, RequestOrchestration.action.relatedAction, RequestOrchestration.action.relatedAction.extension, RequestOrchestration.action.relatedAction.modifierExtension, RequestOrchestration.action.relatedAction.targetId, RequestOrchestration.action.relatedAction.relationship, RequestOrchestration.action.relatedAction.endRelationship, RequestOrchestration.action.relatedAction.offset[x], RequestOrchestration.action.timing[x], RequestOrchestration.action.location, RequestOrchestration.action.participant, RequestOrchestration.action.participant.extension, RequestOrchestration.action.participant.modifierExtension, RequestOrchestration.action.participant.type, RequestOrchestration.action.participant.typeCanonical, RequestOrchestration.action.participant.typeReference, RequestOrchestration.action.participant.role, RequestOrchestration.action.participant.function, RequestOrchestration.action.participant.actor[x], RequestOrchestration.action.type, RequestOrchestration.action.groupingBehavior, RequestOrchestration.action.selectionBehavior, RequestOrchestration.action.requiredBehavior, RequestOrchestration.action.precheckBehavior, RequestOrchestration.action.cardinalityBehavior, RequestOrchestration.action.resource, RequestOrchestration.action.definition[x], RequestOrchestration.action.transform, RequestOrchestration.action.dynamicValue, RequestOrchestration.action.dynamicValue.extension, RequestOrchestration.action.dynamicValue.modifierExtension, RequestOrchestration.action.dynamicValue.path, RequestOrchestration.action.dynamicValue.expression, RequestOrchestration.action.action All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error RequestOrchestration.extension, RequestOrchestration.extension:reasonCode, RequestOrchestration.extension:reasonReference, RequestOrchestration.modifierExtension, RequestOrchestration.action.extension, RequestOrchestration.action.modifierExtension, RequestOrchestration.action.condition.extension, RequestOrchestration.action.condition.modifierExtension, RequestOrchestration.action.input.extension, RequestOrchestration.action.input.modifierExtension, RequestOrchestration.action.output.extension, RequestOrchestration.action.output.modifierExtension, RequestOrchestration.action.relatedAction.extension, RequestOrchestration.action.relatedAction.modifierExtension, RequestOrchestration.action.participant.extension, RequestOrchestration.action.participant.modifierExtension, RequestOrchestration.action.dynamicValue.extension, RequestOrchestration.action.dynamicValue.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
pld-0 error RequestOrchestration.action.input Input data elements must have a requirement or a relatedData, but not both requirement.exists() xor relatedData.exists()
pld-1 error RequestOrchestration.action.output Output data element must have a requirement or a relatedData, but not both requirement.exists() xor relatedData.exists()
rqg-1 error RequestOrchestration.action Must have resource or action but not both resource.exists() != action.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RequestOrchestration 0..* RequestOrchestration(5.0.0) A set of related requests
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:reasonCode 0..* CodeableConcept R4B: Why the request group is needed (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-RequestGroup.reasonCode
Constraints: ext-1
.... extension:reasonReference 0..* Reference(Cross-version Profile for R4B.Condition for use in FHIR R5(0.1.0) | Condition | Cross-version Profile for R4B.Observation for use in FHIR R5(0.1.0) | Observation | Cross-version Profile for R4B.DiagnosticReport for use in FHIR R5(0.1.0) | DiagnosticReport | Cross-version Profile for R4B.DocumentReference for use in FHIR R5(0.1.0) | DocumentReference) R4B: Why the request group is needed (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-RequestGroup.reasonReference
Constraints: ext-1
... status ?!Σ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Codes identifying the lifecycle stage of a request.
... intent ?!Σ 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RequestOrchestration.​status Base required RequestStatus 📍5.0.0 FHIR Std.
RequestOrchestration.​intent Base required RequestIntent 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error RequestOrchestration If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error RequestOrchestration 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 contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error RequestOrchestration If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error RequestOrchestration If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice RequestOrchestration A resource should have narrative for robust management text.`div`.exists()
ele-1 error RequestOrchestration.implicitRules, RequestOrchestration.extension, RequestOrchestration.extension:reasonCode, RequestOrchestration.extension:reasonReference, RequestOrchestration.modifierExtension, RequestOrchestration.status, RequestOrchestration.intent All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error RequestOrchestration.extension, RequestOrchestration.extension:reasonCode, RequestOrchestration.extension:reasonReference, RequestOrchestration.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from RequestOrchestration

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RequestOrchestration 0..* RequestOrchestration(5.0.0) A set of related requests
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:reasonCode 0..* CodeableConcept R4B: Why the request group is needed (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-RequestGroup.reasonCode
.... extension:reasonReference 0..* Reference(Cross-version Profile for R4B.Condition for use in FHIR R5(0.1.0) | Condition | Cross-version Profile for R4B.Observation for use in FHIR R5(0.1.0) | Observation | Cross-version Profile for R4B.DiagnosticReport for use in FHIR R5(0.1.0) | DiagnosticReport | Cross-version Profile for R4B.DocumentReference for use in FHIR R5(0.1.0) | DocumentReference) R4B: Why the request group is needed (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-RequestGroup.reasonReference

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RequestOrchestration 0..* RequestOrchestration(5.0.0) A set of related requests
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:reasonCode 0..* CodeableConcept R4B: Why the request group is needed (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-RequestGroup.reasonCode
Constraints: ext-1
.... extension:reasonReference 0..* Reference(Cross-version Profile for R4B.Condition for use in FHIR R5(0.1.0) | Condition | Cross-version Profile for R4B.Observation for use in FHIR R5(0.1.0) | Observation | Cross-version Profile for R4B.DiagnosticReport for use in FHIR R5(0.1.0) | DiagnosticReport | Cross-version Profile for R4B.DocumentReference for use in FHIR R5(0.1.0) | DocumentReference) R4B: Why the request group is needed (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-RequestGroup.reasonReference
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier Business identifier
... instantiatesCanonical Σ 0..* canonical() Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn 0..* Reference(Resource) Fulfills plan, proposal, or order
... replaces 0..* Reference(Resource) Request(s) replaced by this request
... groupIdentifier Σ 0..1 Identifier Composite request this is part of
... status ?!Σ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Codes identifying the lifecycle stage of a request.
... intent ?!Σ 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request.
... priority Σ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
... code Σ 0..1 CodeableConcept What's being requested/ordered
Binding: ActionCode (example)
... subject 0..1 Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) Who the request orchestration is about
... encounter 0..1 Reference(Encounter) Created as part of
... authoredOn 0..1 dateTime When the request orchestration was authored
... author 0..1 Reference(Device | Practitioner | PractitionerRole) Device or practitioner that authored the request orchestration
... reason 0..* CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference) Why the request orchestration is needed
Binding: ActionReasonCode (example)
... goal 0..* Reference(Goal) What goals
... note 0..* Annotation Additional notes about the response
... action C 0..* BackboneElement Proposed actions, if any
Constraints: rqg-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... linkId 0..1 string Pointer to specific item from the PlanDefinition
.... prefix 0..1 string User-visible prefix for the action (e.g. 1. or A.)
.... title 0..1 string User-visible title
.... description Σ 0..1 markdown Short description of the action
.... textEquivalent Σ 0..1 markdown Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
.... priority 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
.... code 0..* CodeableConcept Code representing the meaning of the action or sub-actions
Binding: ActionCode (example)
.... documentation 0..* RelatedArtifact Supporting documentation for the intended performer of the action
.... goal 0..* Reference(Goal) What goals
.... condition 0..* BackboneElement Whether or not the action is applicable
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... kind 1..1 code applicability | start | stop
Binding: ActionConditionKind (required): The kind of condition for the action.
..... expression 0..1 Expression Boolean-valued expression
.... input C 0..* BackboneElement Input data requirements
Constraints: pld-0
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... title 0..1 string User-visible title
..... requirement C 0..1 DataRequirement What data is provided
..... relatedData C 0..1 id What data is provided
.... output C 0..* BackboneElement Output data definition
Constraints: pld-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... title 0..1 string User-visible title
..... requirement C 0..1 DataRequirement What data is provided
..... relatedData C 0..1 string What data is provided
.... relatedAction 0..* BackboneElement Relationship to another action
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... targetId 1..1 id What action this is related to
..... relationship 1..1 code before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
..... endRelationship 0..1 code before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end
Binding: ActionRelationshipType (required): Defines the types of relationships between actions.
..... offset[x] 0..1 Time offset for the relationship
...... offsetDuration Duration
...... offsetRange Range
.... timing[x] 0..1 When the action should take place
..... timingDateTime dateTime
..... timingAge Age
..... timingPeriod Period
..... timingDuration Duration
..... timingRange Range
..... timingTiming Timing
.... location 0..1 CodeableReference(Location) Where it should happen
.... participant 0..* BackboneElement Who should perform the action
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... type 0..1 code careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
Binding: ActionParticipantType (required): The type of participant in the activity.
..... typeCanonical 0..1 canonical(CapabilityStatement) Who or what can participate
..... typeReference 0..1 Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) Who or what can participate
..... role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent, etc
Binding: ActionParticipantRole (2.0.0) (example): Defines roles played by participants for the action.
..... function 0..1 CodeableConcept E.g. Author, Reviewer, Witness, etc
Binding: ActionParticipantFunction (example)
..... actor[x] 0..1 canonical(CapabilityStatement), Reference(CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) Who/what is participating?
.... type 0..1 CodeableConcept create | update | remove | fire-event
Binding: ActionType (extensible): The type of action to be performed.
.... groupingBehavior 0..1 code visual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
.... selectionBehavior 0..1 code any | all | all-or-none | exactly-one | at-most-one | one-or-more
Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.
.... requiredBehavior 0..1 code must | could | must-unless-documented
Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
.... precheckBehavior 0..1 code yes | no
Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
.... cardinalityBehavior 0..1 code single | multiple
Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.
.... resource C 0..1 Reference(Resource) The target of the action
.... definition[x] 0..1 Description of the activity to be performed
..... definitionCanonical canonical(ActivityDefinition | ObservationDefinition | PlanDefinition | Questionnaire | SpecimenDefinition)
..... definitionUri uri
.... transform 0..1 canonical(StructureMap) Transform to apply the template
.... dynamicValue 0..* BackboneElement Dynamic aspects of the definition
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... path 0..1 string The path to the element to be set dynamically
..... expression 0..1 Expression An expression that provides the dynamic value for the customization
.... action 0..* See action (RequestOrchestration) Sub action

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RequestOrchestration.​language Base required All Languages 📍5.0.0 FHIR Std.
RequestOrchestration.​status Base required RequestStatus 📍5.0.0 FHIR Std.
RequestOrchestration.​intent Base required RequestIntent 📍5.0.0 FHIR Std.
RequestOrchestration.​priority Base required RequestPriority 📍5.0.0 FHIR Std.
RequestOrchestration.​code Base example Action Code 📍5.0.0 FHIR Std.
RequestOrchestration.​reason Base example Action Reason Code 📍5.0.0 FHIR Std.
RequestOrchestration.​action.priority Base required RequestPriority 📍5.0.0 FHIR Std.
RequestOrchestration.​action.code Base example Action Code 📍5.0.0 FHIR Std.
RequestOrchestration.​action.condition.kind Base required Action Condition Kind 📍5.0.0 FHIR Std.
RequestOrchestration.​action.relatedAction.​relationship Base required Action Relationship Type 📍5.0.0 FHIR Std.
RequestOrchestration.​action.relatedAction.​endRelationship Base required Action Relationship Type 📍5.0.0 FHIR Std.
RequestOrchestration.​action.participant.type Base required Action Participant Type 📍5.0.0 FHIR Std.
RequestOrchestration.​action.participant.role Base example Action Participant Role 📍2.0.0 THO v7.1
RequestOrchestration.​action.participant.function Base example Action Participant Function 📍5.0.0 FHIR Std.
RequestOrchestration.​action.type Base extensible Action Type 📍5.0.0 FHIR Std.
RequestOrchestration.​action.groupingBehavior Base required Action Grouping Behavior 📍5.0.0 FHIR Std.
RequestOrchestration.​action.selectionBehavior Base required Action Selection Behavior 📍5.0.0 FHIR Std.
RequestOrchestration.​action.requiredBehavior Base required Action Required Behavior 📍5.0.0 FHIR Std.
RequestOrchestration.​action.precheckBehavior Base required Action Precheck Behavior 📍5.0.0 FHIR Std.
RequestOrchestration.​action.cardinalityBehavior Base required Action Cardinality Behavior 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error RequestOrchestration If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error RequestOrchestration 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 contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error RequestOrchestration If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error RequestOrchestration If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice RequestOrchestration A resource should have narrative for robust management text.`div`.exists()
ele-1 error RequestOrchestration.meta, RequestOrchestration.implicitRules, RequestOrchestration.language, RequestOrchestration.text, RequestOrchestration.extension, RequestOrchestration.extension:reasonCode, RequestOrchestration.extension:reasonReference, RequestOrchestration.modifierExtension, RequestOrchestration.identifier, RequestOrchestration.instantiatesCanonical, RequestOrchestration.instantiatesUri, RequestOrchestration.basedOn, RequestOrchestration.replaces, RequestOrchestration.groupIdentifier, RequestOrchestration.status, RequestOrchestration.intent, RequestOrchestration.priority, RequestOrchestration.code, RequestOrchestration.subject, RequestOrchestration.encounter, RequestOrchestration.authoredOn, RequestOrchestration.author, RequestOrchestration.reason, RequestOrchestration.goal, RequestOrchestration.note, RequestOrchestration.action, RequestOrchestration.action.extension, RequestOrchestration.action.modifierExtension, RequestOrchestration.action.linkId, RequestOrchestration.action.prefix, RequestOrchestration.action.title, RequestOrchestration.action.description, RequestOrchestration.action.textEquivalent, RequestOrchestration.action.priority, RequestOrchestration.action.code, RequestOrchestration.action.documentation, RequestOrchestration.action.goal, RequestOrchestration.action.condition, RequestOrchestration.action.condition.extension, RequestOrchestration.action.condition.modifierExtension, RequestOrchestration.action.condition.kind, RequestOrchestration.action.condition.expression, RequestOrchestration.action.input, RequestOrchestration.action.input.extension, RequestOrchestration.action.input.modifierExtension, RequestOrchestration.action.input.title, RequestOrchestration.action.input.requirement, RequestOrchestration.action.input.relatedData, RequestOrchestration.action.output, RequestOrchestration.action.output.extension, RequestOrchestration.action.output.modifierExtension, RequestOrchestration.action.output.title, RequestOrchestration.action.output.requirement, RequestOrchestration.action.output.relatedData, RequestOrchestration.action.relatedAction, RequestOrchestration.action.relatedAction.extension, RequestOrchestration.action.relatedAction.modifierExtension, RequestOrchestration.action.relatedAction.targetId, RequestOrchestration.action.relatedAction.relationship, RequestOrchestration.action.relatedAction.endRelationship, RequestOrchestration.action.relatedAction.offset[x], RequestOrchestration.action.timing[x], RequestOrchestration.action.location, RequestOrchestration.action.participant, RequestOrchestration.action.participant.extension, RequestOrchestration.action.participant.modifierExtension, RequestOrchestration.action.participant.type, RequestOrchestration.action.participant.typeCanonical, RequestOrchestration.action.participant.typeReference, RequestOrchestration.action.participant.role, RequestOrchestration.action.participant.function, RequestOrchestration.action.participant.actor[x], RequestOrchestration.action.type, RequestOrchestration.action.groupingBehavior, RequestOrchestration.action.selectionBehavior, RequestOrchestration.action.requiredBehavior, RequestOrchestration.action.precheckBehavior, RequestOrchestration.action.cardinalityBehavior, RequestOrchestration.action.resource, RequestOrchestration.action.definition[x], RequestOrchestration.action.transform, RequestOrchestration.action.dynamicValue, RequestOrchestration.action.dynamicValue.extension, RequestOrchestration.action.dynamicValue.modifierExtension, RequestOrchestration.action.dynamicValue.path, RequestOrchestration.action.dynamicValue.expression, RequestOrchestration.action.action All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error RequestOrchestration.extension, RequestOrchestration.extension:reasonCode, RequestOrchestration.extension:reasonReference, RequestOrchestration.modifierExtension, RequestOrchestration.action.extension, RequestOrchestration.action.modifierExtension, RequestOrchestration.action.condition.extension, RequestOrchestration.action.condition.modifierExtension, RequestOrchestration.action.input.extension, RequestOrchestration.action.input.modifierExtension, RequestOrchestration.action.output.extension, RequestOrchestration.action.output.modifierExtension, RequestOrchestration.action.relatedAction.extension, RequestOrchestration.action.relatedAction.modifierExtension, RequestOrchestration.action.participant.extension, RequestOrchestration.action.participant.modifierExtension, RequestOrchestration.action.dynamicValue.extension, RequestOrchestration.action.dynamicValue.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
pld-0 error RequestOrchestration.action.input Input data elements must have a requirement or a relatedData, but not both requirement.exists() xor relatedData.exists()
pld-1 error RequestOrchestration.action.output Output data element must have a requirement or a relatedData, but not both requirement.exists() xor relatedData.exists()
rqg-1 error RequestOrchestration.action Must have resource or action but not both resource.exists() != action.exists()

 

Other representations of profile: CSV, Excel, Schematron