Release 5 Ballot

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

Extension: triggeredBy

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

Summary

Defining URL: http://hl7.org/fhir/StructureDefinition/workflow-triggeredBy

Version: 5.0.0-ballot

Name: triggeredBy

Title: null

Modifier: This extension is not a modifier extension

Status: draft

Definition: This resource came into being as a result of expectations set in the referenced Definition resource. I.e. This resource represents a 'step' dictated within the protocol/order set/etc.

Committee: FHIR Infrastructure Work Group

Status: draft. Extension maintained by: Health Level Seven, Inc. - FHIR WG

This resource came into being as a result of expectations set in the referenced Definition resource. I.e. This resource represents a 'step' dictated within the protocol/order set/etc.

Comment:

See the notes in the workflow extensions area for more guidance on this element.

Context of Use: Use on Element ID CarePlan, Element ID CarePlan.activity.plannedActivityDetail, Element ID CommunicationRequest, Element ID DeviceRequest, Element ID Encounter, Element ID ImmunizationRecommendation, Element ID NutritionOrder, Element ID RequestOrchestration, Element ID SupplyRequest, Element ID ServiceRequest, Element ID Task, Element ID Condition, Element ID Communication, Element ID DiagnosticReport, Element ID DocumentReference, Element ID FamilyMemberHistory, Element ID Immunization, Element ID Observation, Element ID QuestionnaireResponse or Element ID SupplyDelivery

Summary

Name	Flags	Card.	Type	Description & Constraints
triggeredBy		0..1	canonical(ActivityDefinition \| Measure \| OperationDefinition \| PlanDefinition \| Questionnaire), Reference(ActivityDefinition \| Measure \| OperationDefinition \| PlanDefinition \| Questionnaire), uri	URL = http://hl7.org/fhir/StructureDefinition/workflow-triggeredBy triggeredBy: This resource came into being as a result of expectations set in the referenced Definition resource. I.e. This resource represents a 'step' dictated within the protocol/order set/etc. Use on Element ID CarePlan, Element ID CarePlan.activity.plannedActivityDetail, Element ID CommunicationRequest, Element ID DeviceRequest, Element ID Encounter, Element ID ImmunizationRecommendation, Element ID NutritionOrder, Element ID RequestOrchestration, Element ID SupplyRequest, Element ID ServiceRequest, Element ID Task, Element ID Condition, Element ID Communication, Element ID DiagnosticReport, Element ID DocumentReference, Element ID FamilyMemberHistory, Element ID Immunization, Element ID Observation, Element ID QuestionnaireResponse or Element ID SupplyDelivery
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/workflow-triggeredBy triggeredBy: This resource came into being as a result of expectations set in the referenced Definition resource. I.e. This resource represents a 'step' dictated within the protocol/order set/etc. Use on Element ID CarePlan, Element ID CarePlan.activity.plannedActivityDetail, Element ID CommunicationRequest, Element ID DeviceRequest, Element ID Encounter, Element ID ImmunizationRecommendation, Element ID NutritionOrder, Element ID RequestOrchestration, Element ID SupplyRequest, Element ID ServiceRequest, Element ID Task, Element ID Condition, Element ID Communication, Element ID DiagnosticReport, Element ID DocumentReference, Element ID FamilyMemberHistory, Element ID Immunization, Element ID Observation, Element ID QuestionnaireResponse or Element ID SupplyDelivery
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/workflow-triggeredBy"
value[x]	1..1		Value of extension
valueCanonical		canonical(ActivityDefinition \| Measure \| OperationDefinition \| PlanDefinition \| Questionnaire)
valueReference		Reference(ActivityDefinition \| Measure \| OperationDefinition \| PlanDefinition \| Questionnaire)
valueUri		uri
Documentation for this format

XML Template

<!-- triggeredBy -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/workflow-triggeredBy" >
  <!-- from Element: extension -->
 <value[x]><!-- I 1..1 canonical|Reference(ActivityDefinition)|uri Value of extension --></value[x]>
</extension>

JSON Template

{ // triggeredBy
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/workflow-triggeredBy", // R! 
  // value[x]: Value of extension. One of these 3:
    "valueCanonical" : "<canonical>", // I R! Value of extension
    "valueReference" : { Reference(ActivityDefinition) }, // I R! Value of extension
    "valueUri" : "<uri>" // I R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
triggeredBy		0..1	canonical(ActivityDefinition \| Measure \| OperationDefinition \| PlanDefinition \| Questionnaire), Reference(ActivityDefinition \| Measure \| OperationDefinition \| PlanDefinition \| Questionnaire), uri	URL = http://hl7.org/fhir/StructureDefinition/workflow-triggeredBy triggeredBy: This resource came into being as a result of expectations set in the referenced Definition resource. I.e. This resource represents a 'step' dictated within the protocol/order set/etc. Use on Element ID CarePlan, Element ID CarePlan.activity.plannedActivityDetail, Element ID CommunicationRequest, Element ID DeviceRequest, Element ID Encounter, Element ID ImmunizationRecommendation, Element ID NutritionOrder, Element ID RequestOrchestration, Element ID SupplyRequest, Element ID ServiceRequest, Element ID Task, Element ID Condition, Element ID Communication, Element ID DiagnosticReport, Element ID DocumentReference, Element ID FamilyMemberHistory, Element ID Immunization, Element ID Observation, Element ID QuestionnaireResponse or Element ID SupplyDelivery
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/workflow-triggeredBy triggeredBy: This resource came into being as a result of expectations set in the referenced Definition resource. I.e. This resource represents a 'step' dictated within the protocol/order set/etc. Use on Element ID CarePlan, Element ID CarePlan.activity.plannedActivityDetail, Element ID CommunicationRequest, Element ID DeviceRequest, Element ID Encounter, Element ID ImmunizationRecommendation, Element ID NutritionOrder, Element ID RequestOrchestration, Element ID SupplyRequest, Element ID ServiceRequest, Element ID Task, Element ID Condition, Element ID Communication, Element ID DiagnosticReport, Element ID DocumentReference, Element ID FamilyMemberHistory, Element ID Immunization, Element ID Observation, Element ID QuestionnaireResponse or Element ID SupplyDelivery
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/workflow-triggeredBy"
value[x]	1..1		Value of extension
valueCanonical		canonical(ActivityDefinition \| Measure \| OperationDefinition \| PlanDefinition \| Questionnaire)
valueReference		Reference(ActivityDefinition \| Measure \| OperationDefinition \| PlanDefinition \| Questionnaire)
valueUri		uri
Documentation for this format

XML Template

<!-- triggeredBy -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/workflow-triggeredBy" >
  <!-- from Element: extension -->
 <value[x]><!-- I 1..1 canonical|Reference(ActivityDefinition)|uri Value of extension --></value[x]>
</extension>

JSON Template

{ // triggeredBy
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/workflow-triggeredBy", // R! 
  // value[x]: Value of extension. One of these 3:
    "valueCanonical" : "<canonical>", // I R! Value of extension
    "valueReference" : { Reference(ActivityDefinition) }, // I R! Value of extension
    "valueUri" : "<uri>" // I R! Value of extension
  }

Constraints

ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div)

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.