STU 3 Ballot

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

14.14.0 Trigger Definition

Clinical Decision Support

Work Group

Maturity Level: N/A

Ballot Status: STU 3

The TriggerDefinition structure defines when a knowledge artifact is expected to be evaluated. The structure can represent three main kinds of triggering events:

Named Event
Scheduled Event
Data Event

A named event is an event identified by the implementation environment. This allows any event generated within the implementation environment to be used as a trigger, but it requires pre-coordination of the names involved with the consuming environments.

A scheduled event occurs on a fixed or periodic schedule.

And finally, a data event occurs in response to some data-related event in the integrated environment such as a record being added or updated. The data-of-interest for a data event is described using a DataRequirement. This allows for systems to automatically invoke based on data activity occurring within the system.

Structure

Name	Flags	Card.	Type	Description & Constraints
TriggerDefinition	Σ		Element	Defines an expected trigger for a module
type	Σ	1..1	code	named-event \| periodic \| data-added \| data-modified \| data-removed \| data-accessed \| data-access-ended TriggerType (Required)
eventName	Σ	0..1	string	Name of the event
eventTiming[x]	Σ	0..1		Timing of the event
eventTimingTiming			Timing
eventTimingReference			Reference(Schedule)
eventTimingDate			date
eventTimingDateTime			dateTime
eventData	Σ	0..1	DataRequirement	Triggering data of the event
Documentation for this format

UML Diagram (Legend)

XML Template

<[name] xmlns="http://hl7.org/fhir"> 
 <!-- from Element: extension -->
 <type value="[code]"/><!-- 1..1 named-event | periodic | data-added | data-modified | data-removed | data-accessed | data-access-ended -->
 <eventName value="[string]"/><!-- 0..1 Name of the event -->
 <eventTiming[x]><!-- 0..1 Timing|Reference(Schedule)|date|dateTime Timing of the event --></eventTiming[x]>
 <eventData><!-- 0..1 DataRequirement Triggering data of the event --></eventData>
</[name]>

JSON Template

{
  // from Element: extension
  "type" : "<code>", // R!  named-event | periodic | data-added | data-modified | data-removed | data-accessed | data-access-ended
  "eventName" : "<string>", // Name of the event
  // eventTiming[x]: Timing of the event. One of these 4:
  "eventTimingTiming" : { Timing },
  "eventTimingReference" : { Reference(Schedule) },
  "eventTimingDate" : "<date>",
  "eventTimingDateTime" : "<dateTime>",
  "eventData" : { DataRequirement } // Triggering data of the event
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:TriggerDefinition.type [ code ]; # 1..1 named-event | periodic | data-added | data-modified | data-removed | data-accessed | data-access-ended
  fhir:TriggerDefinition.eventName [ string ]; # 0..1 Name of the event
  # TriggerDefinition.eventTiming[x] : 0..1 Timing of the event. One of these 4
    fhir:TriggerDefinition.eventTimingTiming [ Timing ]
    fhir:TriggerDefinition.eventTimingReference [ Reference(Schedule) ]
    fhir:TriggerDefinition.eventTimingDate [ date ]
    fhir:TriggerDefinition.eventTimingDateTime [ dateTime ]
  fhir:TriggerDefinition.eventData [ DataRequirement ]; # 0..1 Triggering data of the event
]

Changes since DSTU2

This complex-type did not exist in Release 2