R6 Ballot (3rd Draft) FHIR CI-Build

This page is part of the FHIR Specification v6.0.0-ballot3: Release 6 Ballot (3rd Draft) (see Ballot Notes ). The current version is 5.0.0 . For a full list Continuous Integration Build of available versions, see FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

14.10 Resource EventDefinition - Content

Responsible Owner: Clinical Decision Support icon Work Group Maturity Level : 0   Trial Use Normative Security Category : Anonymous Compartments : No defined compartments

The EventDefinition resource provides a reusable description of when a particular event can occur.

14.10.1 Scope and Usage

This resource is a definition resource from a FHIR workflow perspective - see Workflow , specifically Definition .

The EventDefinition resource provides a reusable description of an event. The resource supports describing different kinds of events, including named events, periodic events, and data-based events. For each of these, the resource also supports a formal description of the event. For example, a 'monitor-emergency-admissions' event can be a named event, but also provide a formal description of the event as monitoring for encounters that occur in emergency department locations.

Implementation Note: The EventDefinition resource is a candidate for removal from the specification. The resource was proposed prior to the development of the current subscriptions approach and the functionality it supports has been replaced by the SubscriptionTopic resource. We are seeking feedback on whether there would be any gaps left open by removing the EventDefinition in favor of making use of the SubscriptionTopic resource.

14.10.2 Boundaries and Relationships

The EventDefinition resource is intended to be used to provide a reusable description of events for use by other resources that require event definition, such as Subscription. MessageDefinition. The SubscriptionTopic resource is focused on supporting the definition of topics that can be used in Subscriptions. EventDefinition is a definition of an event that could occur, whereas Subscription is asking for notification of events when they occur.

The EventDefinition resource uses the TriggerDefinition data type to represent the description of an event as one of:

  • Named event: An event identified by the implementation environment
  • Schedule event: An event occurs on a fixed or periodic schedule
  • Data event: An event that occurs when data is change such as a record being added, updated, or deleted
  • Subscription topic: An event that is defined by referencing a subscription topic

This allows an EventDefinition to be used to reference a SubscriptionTopic, enabling subscriptions to be used in MessageDefinition and PlanDefinition.

14.10.3 References to this Resource

14.10.4 Resource Content

Structure

Intended jurisdiction for Use and/or publishing XD
Name Flags Card. Type Description & Constraints      Filter: Filters doco
. . EventDefinition TU N DomainResource A description of when an event can occur
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation

Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
Interfaces Implemented: MetadataResource
. . . url Σ C 0..1 uri Canonical identifier for this event definition, represented as a URI (globally unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic
. . . identifier Σ 0..* Identifier Additional identifier for the event definition

. . . version Σ 0..1 string Business version of the event definition
. . . versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: Version Algorithm ( Extensible )
. . . . versionAlgorithmString string
. . . . versionAlgorithmCoding Coding
. . . name Σ C 0..1 string Name for this event definition (computer friendly)
. . . title Σ T 0..1 string Name for this event definition (human friendly)
. . . subtitle 0..1 string Subordinate title of the event definition
. . . status ?! Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus ( Required )
. . . experimental Σ 0..1 boolean For testing only - never for real usage
. . . subject[x] 0..1 Type of individual the event definition is focused on
Binding: Participant Resource Types ( Extensible )
. . . . subjectCodeableConcept CodeableConcept
. . . . subjectReference Reference ( Group )
. . . date Σ 0..1 dateTime Date last changed
. . . publisher Σ T 0..1 string Name of the publisher/steward (organization or individual)
. . . contact Σ 0..* ContactDetail Contact details for the publisher

. . . description T 0..1 markdown Natural language description of the event definition
. . . useContext Σ 0..* UsageContext The context that the content is intended to support

. . . jurisdiction Σ XD 0..* CodeableConcept Jurisdiction of the authority that maintains the event definition (if applicable)
Binding: Jurisdiction ValueSet icon ( Extensible )

. . . purpose T 0..1 markdown Why this event definition is defined
. . . usage 0..1 markdown Describes the clinical usage of the event definition
. . . copyright T 0..1 markdown Notice about intellectual property ownership, can include restrictions on use
. . . copyrightLabel T 0..1 string Copyright holder and year(s)
. . . approvalDate Σ 0..1 date When the event definition was approved by publisher
. . . lastReviewDate Σ 0..1 date When the event definition was last reviewed by the publisher
. . . effectivePeriod Σ 0..1 Period When the event definition is expected to be used
. . . topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: Definition Topic ( Example )

. . . author 0..* ContactDetail Who authored the content

. . . editor 0..* ContactDetail Who edited the content

. . . reviewer 0..* ContactDetail Who reviewed the content

. . . endorser 0..* ContactDetail Who endorsed the content

. . . relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc

. . . trigger Σ 1..* TriggerDefinition "when" the event occurs (multiple = 'or')


doco Documentation for this format icon

See the Extensions for this resource

UML Diagram ( Legend )

EventDefinition ( DomainResource ) + MetadataResource An absolute URI that is used to identify this event definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this event definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the event definition is stored on different servers url : uri [0..1] A formal identifier that is used to identify this event definition when it is represented in other formats, or referenced in a specification, model, design or an instance identifier : Identifier [0..*] The identifier that is used to identify this version of the event definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the event definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence version : string [0..1] Indicates the mechanism used to compare versions to determine which is more current versionAlgorithm[x] : DataType [0..1] « string | Coding ; null (Strength=Extensible) VersionAlgorithm + » A natural language name identifying the event definition. This name should be usable as an identifier for the module by machine processing applications such as code generation name : string [0..1] « This element has or is affected by some invariants C » A short, descriptive, user-friendly title for the event definition title : string [0..1] An explanatory or alternate title for the event definition giving additional information about its content subtitle : string [0..1] The status of this event definition. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements) status : code [1..1] « null (Strength=Required) PublicationStatus ! » A Boolean value to indicate that this event definition is authored for testing purposes (or education/evaluation/marketing) and no version of this resource will ever be intended for genuine usage experimental : boolean [0..1] A code or group definition that describes the intended subject of the event definition subject[x] : DataType [0..1] « CodeableConcept | Reference ( Group ); null (Strength=Extensible) ParticipantResourceTypes + » The date (and optionally time) when the event definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the event definition changes date : dateTime [0..1] The name of the organization or individual responsible for the release and ongoing maintenance of the event definition publisher : string [0..1] Contact details to assist a user in finding and communicating with the publisher contact : ContactDetail [0..*] A free text natural language description of the event definition from a consumer's perspective description : markdown [0..1] The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate event definition instances useContext : UsageContext [0..*] A legal or geographic region in which the event definition authority that maintains the resource is intended to be used operating. In general, the jurisdiction is also found in the useContext. The useContext may reference additional jurisdictions because the defining jurisdiction does not necessarily limit the jurisdictions of use jurisdiction : CodeableConcept [0..*] « null (Strength=Extensible) JurisdictionValueSet + » Explanation of why this event definition is needed and why it has been designed as it has purpose : markdown [0..1] A detailed description of how the event definition is used from a clinical perspective usage : markdown [0..1] A copyright statement relating to the event definition and/or its contents. Copyright statements are generally legal notices of intellectual property ownership and can include restrictions on the use and publishing of the event definition copyright : markdown [0..1] A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. restricted. (e.g. 'All rights reserved', 'Some rights reserved') copyrightLabel : string [0..1] The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage approvalDate : date [0..1] The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date lastReviewDate : date [0..1] The period during which the event definition content was or is planned to be in active use effectivePeriod : Period [0..1] Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching topic : CodeableConcept [0..*] « null (Strength=Example) DefinitionTopic ?? » An individiual or organization primarily involved in the creation and maintenance of the content author : ContactDetail [0..*] An individual or organization primarily responsible for internal coherence of the content editor : ContactDetail [0..*] An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content reviewer : ContactDetail [0..*] An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting endorser : ContactDetail [0..*] Related resources such as additional documentation, justification, or bibliographic references relatedArtifact : RelatedArtifact [0..*] The trigger element defines when the event occurs. If more than one trigger condition is specified, the event fires whenever any one of the trigger conditions is met trigger : TriggerDefinition [1..*]

XML Template 

<EventDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this event definition, represented as a URI (globally unique) -->
 <identifier><!-- 0..* Identifier Additional identifier for the event definition --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the event definition -->
 <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]>
 <name value="[string]"/><!-- I 0..1 Name for this event definition (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this event definition (human friendly) -->
 <subtitle value="[string]"/><!-- 0..1 Subordinate title of the event definition -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing only - never for real usage -->
 <subject[x]><!-- 0..1 CodeableConcept|Reference(Group) Type of individual the event definition is focused on --></subject[x]>
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the event definition -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <</jurisdiction>

 <jurisdiction><!-- 0..* CodeableConcept Jurisdiction of the authority that maintains the event definition (if applicable) icon --></jurisdiction>

 <purpose value="[markdown]"/><!-- 0..1 Why this event definition is defined -->
 <usage value="[markdown]"/><!-- 0..1 Describes the clinical usage of the event definition -->
 <
 <

 <copyright value="[markdown]"/><!-- 0..1 Notice about intellectual property ownership, can include restrictions on use -->
 <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) -->

 <approvalDate value="[date]"/><!-- 0..1 When the event definition was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the event definition was last reviewed by the publisher -->
 <effectivePeriod><!-- 0..1 Period When the event definition is expected to be used --></effectivePeriod>
 <topic><!-- 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc --></topic>
 <author><!-- 0..* ContactDetail Who authored the content --></author>
 <editor><!-- 0..* ContactDetail Who edited the content --></editor>
 <reviewer><!-- 0..* ContactDetail Who reviewed the content --></reviewer>
 <endorser><!-- 0..* ContactDetail Who endorsed the content --></endorser>
 <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc --></relatedArtifact>
 <trigger><!-- 1..* TriggerDefinition "when" the event occurs (multiple = 'or') --></trigger>
</EventDefinition>

JSON Template 

{doco
  "resourceType" : "EventDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this event definition, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the event definition
  "version" : "<string>", // Business version of the event definition
  // versionAlgorithm[x]: How to compare versions. One of these 2:
  "versionAlgorithmString" : "<string>",
  "versionAlgorithmCoding" : { Coding },
  "name" : "<string>", // I Name for this event definition (computer friendly)
  "title" : "<string>", // Name for this event definition (human friendly)
  "subtitle" : "<string>", // Subordinate title of the event definition
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing only - never for real usage
  // subject[x]: Type of individual the event definition is focused on. One of these 2:
  "subjectCodeableConcept" : { CodeableConcept },
  "subjectReference" : { Reference(Group) },
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher/steward (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the event definition
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "

  "jurisdiction" : [{ CodeableConcept }], // Jurisdiction of the authority that maintains the event definition (if applicable) icon

  "purpose" : "<markdown>", // Why this event definition is defined
  "usage" : "<markdown>", // Describes the clinical usage of the event definition
  "
  "

  "copyright" : "<markdown>", // Notice about intellectual property ownership, can include restrictions on use
  "copyrightLabel" : "<string>", // Copyright holder and year(s)

  "approvalDate" : "<date>", // When the event definition was approved by publisher
  "lastReviewDate" : "<date>", // When the event definition was last reviewed by the publisher
  "effectivePeriod" : { Period }, // When the event definition is expected to be used
  "topic" : [{ CodeableConcept }], // E.g. Education, Treatment, Assessment, etc
  "author" : [{ ContactDetail }], // Who authored the content
  "editor" : [{ ContactDetail }], // Who edited the content
  "reviewer" : [{ ContactDetail }], // Who reviewed the content
  "endorser" : [{ ContactDetail }], // Who endorsed the content
  "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations, etc
  "trigger" : [{ TriggerDefinition }] // R!  "when" the event occurs (multiple = 'or')
}

Turtle Template 

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


[ a fhir:EventDefinition;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from 
  # from 

  # from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language
  # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension

  fhir:url [ uri ] ; # 0..1 Canonical identifier for this event definition, represented as a URI (globally unique)
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Additional identifier for the event definition
  fhir:version [ string ] ; # 0..1 Business version of the event definition
  # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2
    fhir: ]

    fhir:versionAlgorithm [  a fhir:String ; string ]

    fhir:versionAlgorithm [  a fhir:Coding ; Coding ]
  fhir:name [ string ] ; # 0..1 I Name for this event definition (computer friendly)
  fhir:title [ string ] ; # 0..1 Name for this event definition (human friendly)
  fhir:subtitle [ string ] ; # 0..1 Subordinate title of the event definition
  fhir:status [ code ] ; # 1..1 draft | active | retired | unknown
  fhir:experimental [ boolean ] ; # 0..1 For testing only - never for real usage
  # subject[x] : 0..1 Type of individual the event definition is focused on. One of these 2
    fhir:subject [  a fhir:CodeableConcept ; CodeableConcept ]
    fhir:subject [  a fhir:Reference ; Reference(Group) ]
  fhir:date [ dateTime ] ; # 0..1 Date last changed
  fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual)
  fhir:contact  ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher
  fhir:description [ markdown ] ; # 0..1 Natural language description of the event definition
  fhir:useContext  ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support
  fhir:

  fhir:jurisdiction  ( [ CodeableConcept ] ... ) ; # 0..* Jurisdiction of the authority that maintains the event definition (if applicable)

  fhir:purpose [ markdown ] ; # 0..1 Why this event definition is defined
  fhir:usage [ markdown ] ; # 0..1 Describes the clinical usage of the event definition
  fhir:
  fhir:

  fhir:copyright [ markdown ] ; # 0..1 Notice about intellectual property ownership, can include restrictions on use
  fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s)

  fhir:approvalDate [ date ] ; # 0..1 When the event definition was approved by publisher
  fhir:lastReviewDate [ date ] ; # 0..1 When the event definition was last reviewed by the publisher
  fhir:effectivePeriod [ Period ] ; # 0..1 When the event definition is expected to be used
  fhir:topic  ( [ CodeableConcept ] ... ) ; # 0..* E.g. Education, Treatment, Assessment, etc
  fhir:author  ( [ ContactDetail ] ... ) ; # 0..* Who authored the content
  fhir:editor  ( [ ContactDetail ] ... ) ; # 0..* Who edited the content
  fhir:reviewer  ( [ ContactDetail ] ... ) ; # 0..* Who reviewed the content
  fhir:endorser  ( [ ContactDetail ] ... ) ; # 0..* Who endorsed the content
  fhir:relatedArtifact  ( [ RelatedArtifact ] ... ) ; # 0..* Additional documentation, citations, etc
  fhir:trigger  ( [ TriggerDefinition ] ... ) ; # 1..* "when" the event occurs (multiple = 'or')
]

Changes from both R4 and R4B

EventDefinition
EventDefinition.versionAlgorithm[x]
  • Added Element
EventDefinition.subject[x]
  • Change value set from http://hl7.org/fhir/ValueSet/subject-type to Participant Resource Types
  • Change code system for extensibly bound codes from "http://hl7.org/fhir/resource-types" to "http://hl7.org/fhir/fhir-types"
EventDefinition.jurisdiction
EventDefinition.usage
  • Type changed from string to markdown
EventDefinition.copyrightLabel
  • Added Element

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON .

Structure

Intended jurisdiction for Use and/or publishing XD
Name Flags Card. Type Description & Constraints      Filter: Filters doco
. . EventDefinition TU N DomainResource A description of when an event can occur
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation

Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
Interfaces Implemented: MetadataResource
. . . url Σ C 0..1 uri Canonical identifier for this event definition, represented as a URI (globally unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic
. . . identifier Σ 0..* Identifier Additional identifier for the event definition

. . . version Σ 0..1 string Business version of the event definition
. . . versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: Version Algorithm ( Extensible )
. . . . versionAlgorithmString string
. . . . versionAlgorithmCoding Coding
. . . name Σ C 0..1 string Name for this event definition (computer friendly)
. . . title Σ T 0..1 string Name for this event definition (human friendly)
. . . subtitle 0..1 string Subordinate title of the event definition
. . . status ?! Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus ( Required )
. . . experimental Σ 0..1 boolean For testing only - never for real usage
. . . subject[x] 0..1 Type of individual the event definition is focused on
Binding: Participant Resource Types ( Extensible )
. . . . subjectCodeableConcept CodeableConcept
. . . . subjectReference Reference ( Group )
. . . date Σ 0..1 dateTime Date last changed
. . . publisher Σ T 0..1 string Name of the publisher/steward (organization or individual)
. . . contact Σ 0..* ContactDetail Contact details for the publisher

. . . description T 0..1 markdown Natural language description of the event definition
. . . useContext Σ 0..* UsageContext The context that the content is intended to support

. . . jurisdiction Σ XD 0..* CodeableConcept Jurisdiction of the authority that maintains the event definition (if applicable)
Binding: Jurisdiction ValueSet icon ( Extensible )

. . . purpose T 0..1 markdown Why this event definition is defined
. . . usage 0..1 markdown Describes the clinical usage of the event definition
. . . copyright T 0..1 markdown Notice about intellectual property ownership, can include restrictions on use
. . . copyrightLabel T 0..1 string Copyright holder and year(s)
. . . approvalDate Σ 0..1 date When the event definition was approved by publisher
. . . lastReviewDate Σ 0..1 date When the event definition was last reviewed by the publisher
. . . effectivePeriod Σ 0..1 Period When the event definition is expected to be used
. . . topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: Definition Topic ( Example )

. . . author 0..* ContactDetail Who authored the content

. . . editor 0..* ContactDetail Who edited the content

. . . reviewer 0..* ContactDetail Who reviewed the content

. . . endorser 0..* ContactDetail Who endorsed the content

. . . relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc

. . . trigger Σ 1..* TriggerDefinition "when" the event occurs (multiple = 'or')


doco Documentation for this format icon

See the Extensions for this resource

UML Diagram ( Legend )

EventDefinition ( DomainResource ) + MetadataResource An absolute URI that is used to identify this event definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this event definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the event definition is stored on different servers url : uri [0..1] A formal identifier that is used to identify this event definition when it is represented in other formats, or referenced in a specification, model, design or an instance identifier : Identifier [0..*] The identifier that is used to identify this version of the event definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the event definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence version : string [0..1] Indicates the mechanism used to compare versions to determine which is more current versionAlgorithm[x] : DataType [0..1] « string | Coding ; null (Strength=Extensible) VersionAlgorithm + » A natural language name identifying the event definition. This name should be usable as an identifier for the module by machine processing applications such as code generation name : string [0..1] « This element has or is affected by some invariants C » A short, descriptive, user-friendly title for the event definition title : string [0..1] An explanatory or alternate title for the event definition giving additional information about its content subtitle : string [0..1] The status of this event definition. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements) status : code [1..1] « null (Strength=Required) PublicationStatus ! » A Boolean value to indicate that this event definition is authored for testing purposes (or education/evaluation/marketing) and no version of this resource will ever be intended for genuine usage experimental : boolean [0..1] A code or group definition that describes the intended subject of the event definition subject[x] : DataType [0..1] « CodeableConcept | Reference ( Group ); null (Strength=Extensible) ParticipantResourceTypes + » The date (and optionally time) when the event definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the event definition changes date : dateTime [0..1] The name of the organization or individual responsible for the release and ongoing maintenance of the event definition publisher : string [0..1] Contact details to assist a user in finding and communicating with the publisher contact : ContactDetail [0..*] A free text natural language description of the event definition from a consumer's perspective description : markdown [0..1] The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate event definition instances useContext : UsageContext [0..*] A legal or geographic region in which the event definition authority that maintains the resource is intended to be used operating. In general, the jurisdiction is also found in the useContext. The useContext may reference additional jurisdictions because the defining jurisdiction does not necessarily limit the jurisdictions of use jurisdiction : CodeableConcept [0..*] « null (Strength=Extensible) JurisdictionValueSet + » Explanation of why this event definition is needed and why it has been designed as it has purpose : markdown [0..1] A detailed description of how the event definition is used from a clinical perspective usage : markdown [0..1] A copyright statement relating to the event definition and/or its contents. Copyright statements are generally legal notices of intellectual property ownership and can include restrictions on the use and publishing of the event definition copyright : markdown [0..1] A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. restricted. (e.g. 'All rights reserved', 'Some rights reserved') copyrightLabel : string [0..1] The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage approvalDate : date [0..1] The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date lastReviewDate : date [0..1] The period during which the event definition content was or is planned to be in active use effectivePeriod : Period [0..1] Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching topic : CodeableConcept [0..*] « null (Strength=Example) DefinitionTopic ?? » An individiual or organization primarily involved in the creation and maintenance of the content author : ContactDetail [0..*] An individual or organization primarily responsible for internal coherence of the content editor : ContactDetail [0..*] An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content reviewer : ContactDetail [0..*] An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting endorser : ContactDetail [0..*] Related resources such as additional documentation, justification, or bibliographic references relatedArtifact : RelatedArtifact [0..*] The trigger element defines when the event occurs. If more than one trigger condition is specified, the event fires whenever any one of the trigger conditions is met trigger : TriggerDefinition [1..*]

XML Template 

<EventDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this event definition, represented as a URI (globally unique) -->
 <identifier><!-- 0..* Identifier Additional identifier for the event definition --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the event definition -->
 <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]>
 <name value="[string]"/><!-- I 0..1 Name for this event definition (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this event definition (human friendly) -->
 <subtitle value="[string]"/><!-- 0..1 Subordinate title of the event definition -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing only - never for real usage -->
 <subject[x]><!-- 0..1 CodeableConcept|Reference(Group) Type of individual the event definition is focused on --></subject[x]>
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the event definition -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <</jurisdiction>

 <jurisdiction><!-- 0..* CodeableConcept Jurisdiction of the authority that maintains the event definition (if applicable) icon --></jurisdiction>

 <purpose value="[markdown]"/><!-- 0..1 Why this event definition is defined -->
 <usage value="[markdown]"/><!-- 0..1 Describes the clinical usage of the event definition -->
 <
 <

 <copyright value="[markdown]"/><!-- 0..1 Notice about intellectual property ownership, can include restrictions on use -->
 <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) -->

 <approvalDate value="[date]"/><!-- 0..1 When the event definition was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the event definition was last reviewed by the publisher -->
 <effectivePeriod><!-- 0..1 Period When the event definition is expected to be used --></effectivePeriod>
 <topic><!-- 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc --></topic>
 <author><!-- 0..* ContactDetail Who authored the content --></author>
 <editor><!-- 0..* ContactDetail Who edited the content --></editor>
 <reviewer><!-- 0..* ContactDetail Who reviewed the content --></reviewer>
 <endorser><!-- 0..* ContactDetail Who endorsed the content --></endorser>
 <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc --></relatedArtifact>
 <trigger><!-- 1..* TriggerDefinition "when" the event occurs (multiple = 'or') --></trigger>
</EventDefinition>

JSON Template 

{doco
  "resourceType" : "EventDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this event definition, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the event definition
  "version" : "<string>", // Business version of the event definition
  // versionAlgorithm[x]: How to compare versions. One of these 2:
  "versionAlgorithmString" : "<string>",
  "versionAlgorithmCoding" : { Coding },
  "name" : "<string>", // I Name for this event definition (computer friendly)
  "title" : "<string>", // Name for this event definition (human friendly)
  "subtitle" : "<string>", // Subordinate title of the event definition
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing only - never for real usage
  // subject[x]: Type of individual the event definition is focused on. One of these 2:
  "subjectCodeableConcept" : { CodeableConcept },
  "subjectReference" : { Reference(Group) },
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher/steward (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the event definition
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "

  "jurisdiction" : [{ CodeableConcept }], // Jurisdiction of the authority that maintains the event definition (if applicable) icon

  "purpose" : "<markdown>", // Why this event definition is defined
  "usage" : "<markdown>", // Describes the clinical usage of the event definition
  "
  "

  "copyright" : "<markdown>", // Notice about intellectual property ownership, can include restrictions on use
  "copyrightLabel" : "<string>", // Copyright holder and year(s)

  "approvalDate" : "<date>", // When the event definition was approved by publisher
  "lastReviewDate" : "<date>", // When the event definition was last reviewed by the publisher
  "effectivePeriod" : { Period }, // When the event definition is expected to be used
  "topic" : [{ CodeableConcept }], // E.g. Education, Treatment, Assessment, etc
  "author" : [{ ContactDetail }], // Who authored the content
  "editor" : [{ ContactDetail }], // Who edited the content
  "reviewer" : [{ ContactDetail }], // Who reviewed the content
  "endorser" : [{ ContactDetail }], // Who endorsed the content
  "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations, etc
  "trigger" : [{ TriggerDefinition }] // R!  "when" the event occurs (multiple = 'or')
}

Turtle Template 

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


[ a fhir:EventDefinition;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from 
  # from 

  # from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language
  # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension

  fhir:url [ uri ] ; # 0..1 Canonical identifier for this event definition, represented as a URI (globally unique)
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Additional identifier for the event definition
  fhir:version [ string ] ; # 0..1 Business version of the event definition
  # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2
    fhir: ]

    fhir:versionAlgorithm [  a fhir:String ; string ]

    fhir:versionAlgorithm [  a fhir:Coding ; Coding ]
  fhir:name [ string ] ; # 0..1 I Name for this event definition (computer friendly)
  fhir:title [ string ] ; # 0..1 Name for this event definition (human friendly)
  fhir:subtitle [ string ] ; # 0..1 Subordinate title of the event definition
  fhir:status [ code ] ; # 1..1 draft | active | retired | unknown
  fhir:experimental [ boolean ] ; # 0..1 For testing only - never for real usage
  # subject[x] : 0..1 Type of individual the event definition is focused on. One of these 2
    fhir:subject [  a fhir:CodeableConcept ; CodeableConcept ]
    fhir:subject [  a fhir:Reference ; Reference(Group) ]
  fhir:date [ dateTime ] ; # 0..1 Date last changed
  fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual)
  fhir:contact  ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher
  fhir:description [ markdown ] ; # 0..1 Natural language description of the event definition
  fhir:useContext  ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support
  fhir:

  fhir:jurisdiction  ( [ CodeableConcept ] ... ) ; # 0..* Jurisdiction of the authority that maintains the event definition (if applicable)

  fhir:purpose [ markdown ] ; # 0..1 Why this event definition is defined
  fhir:usage [ markdown ] ; # 0..1 Describes the clinical usage of the event definition
  fhir:
  fhir:

  fhir:copyright [ markdown ] ; # 0..1 Notice about intellectual property ownership, can include restrictions on use
  fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s)

  fhir:approvalDate [ date ] ; # 0..1 When the event definition was approved by publisher
  fhir:lastReviewDate [ date ] ; # 0..1 When the event definition was last reviewed by the publisher
  fhir:effectivePeriod [ Period ] ; # 0..1 When the event definition is expected to be used
  fhir:topic  ( [ CodeableConcept ] ... ) ; # 0..* E.g. Education, Treatment, Assessment, etc
  fhir:author  ( [ ContactDetail ] ... ) ; # 0..* Who authored the content
  fhir:editor  ( [ ContactDetail ] ... ) ; # 0..* Who edited the content
  fhir:reviewer  ( [ ContactDetail ] ... ) ; # 0..* Who reviewed the content
  fhir:endorser  ( [ ContactDetail ] ... ) ; # 0..* Who endorsed the content
  fhir:relatedArtifact  ( [ RelatedArtifact ] ... ) ; # 0..* Additional documentation, citations, etc
  fhir:trigger  ( [ TriggerDefinition ] ... ) ; # 1..* "when" the event occurs (multiple = 'or')
]

Changes from both R4 and R4B

EventDefinition
EventDefinition.versionAlgorithm[x]
  • Added Element
EventDefinition.subject[x]
  • Change value set from http://hl7.org/fhir/ValueSet/subject-type to Participant Resource Types
  • Change code system for extensibly bound codes from "http://hl7.org/fhir/resource-types" to "http://hl7.org/fhir/fhir-types"
EventDefinition.jurisdiction
EventDefinition.usage
  • Type changed from string to markdown
EventDefinition.copyrightLabel
  • Added Element

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON .

 

Additional definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) , the spreadsheet version & the dependency analysis

14.10.4.1 Terminology Bindings

Path ValueSet Type Documentation
EventDefinition.versionAlgorithm[x] VersionAlgorithm Extensible

Indicates the mechanism used to compare versions to determine which is more current.

EventDefinition.status PublicationStatus Required

The lifecycle status of an artifact.

EventDefinition.subject[x] ParticipantResourceTypes Extensible

All Resource Types that represent participant resources

EventDefinition.jurisdiction JurisdictionValueSet icon Extensible

This value set defines a base set of codes for country, country subdivision and region for indicating where a resource is intended to be used.

Note: The codes for countries and country subdivisions are taken from ISO 3166 icon while the codes for "supra-national" regions are from UN Standard country or area codes for statistical use (M49) icon .

EventDefinition.topic DefinitionTopic Example

High-level categorization of the definition, used for searching, sorting, and filtering.

14.10.4.2 Constraints

UniqueKey Level Location Description Expression
img  cnl-0 Warning (base) Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
img  cnl-1 Warning EventDefinition.url URL should not contain | or # - these characters make processing canonical references problematic exists() implies matches('^[^|# ]+$')

14.10.5 Examples

The following examples illustrate EventDefinition resources representing the event "3 consecutive negative stick tests" using the different approaches to event representation supported by the resource.

14.10.5.1 Named Event

The named event approach uses a name, or code to identify the event. In this approach, a unique code for the event is agreed upon by both sides of an integration. The Workflow icon and Task icon usage context types are another example. CDS Hooks hook names are another example of this approach.

The following example illustrates this approach for a three-consecutive-negative-stick-tests event: 

<trigger>

  <type value="named-event"/>
  <code>
    <coding>
      <system value="http://example.org/CodeSystem/events"/>
      <code value="three-consecutive-negative-stick-tests"/>
    </coding>
  </code>
</trigger>

14.10.5.2 Data Event

Alternatively, a trigger may be identified as a data event . In this approach, a DataRequirement is used to identify the data change event: 

<trigger>

  <type value="data-changed"/>
  <data>
    <type value="Observation"/>
    <codeFilter>
      <path value="code"/>
      <valueSet value="http://example.org/ValueSet/stick-test-codes"/>
    </codeFilter>
  </data>
  <condition>
    <language value="text/cql-expression"/>
    <expression value="StickTest.consecutivelyFrom(%context).take(3).negative().count() = 3"/>
  </condition>
</trigger>

This example indicates that the event should be triggered when Observations with a code matching a code in the http://example.org/ValueSet/stick-test-codes value set is created, updated, or deleted.

In addition, the example has a condition element providing an expression that is evaluated as part of determining whether or not the event is triggered. If the expression evaluates to true , the event is triggered.

The expression in this case: 


StickTest.consecutivelyFrom(%context).take(3).negative().count()
=
3

Relies on the fluent functions defined in the ExampleEventDefinitionLogic library: 

define StickTest:

  [Observation: "Stick Test Codes"] O
    where O.status in { 'final', 'amended', 'corrected' }

define fluent function negative(observations List<Observation>):
  observations O
    where O.interpretation ~ "LA6577-6|http://loinc.org"

define fluent function during(observations List<Observation>, encounter Encounter):
  observations O
    where O.issued during minute of encounter.period

define fluent function within(observations List<Observation>, quantity Quantity):
  observations O
    where (O.issued + quantity) on or after minute of Now()

define fluent function consecutively(observations List<Observation>):
  observations O
    sort by issued

define fluent function consecutivelyFrom(observations List<Observation>, observation Observation):
  observations O
    where O.issued on or after observation.issued
    sort by issued

Alternatively, if a profile is available, it can be used to define the data requirement, as well as to provide the starting data element in the expression: 

<trigger>

  <type value="data-changed"/>
  <data>
    <type value="Observation"/>
    <profile value="http://example.org/StructureDefinition/stick-test-profile"/>
  </data>
  <condition>
    <language value="text/cql-expression"/>
    <expression value="[StickTestProfile].consecutivelyFrom(%context).take(3).negative().count() = 3"/>
  </condition>
</trigger>

14.10.5.3 Periodic Event

And finally, the periodic approach can be used to indicate the event should occur on a timing: 

<trigger>

  <type value="periodic"/>
  <timingTiming>
    <repeat>
      <frequency value="1"/>
      <period value="3"/>
      <periodUnit value="h"/>
    </repeat>
  </timingTiming>
  <condition>
    <language value="text/cql-expression"/>
    <expression value="StickTest.within(3 hours).consecutively.take(3).negative().count() = 3"/>
  </condition>
</trigger>

14.10.5 14.10.6 Search Parameters

Search parameters for this resource. See also the full list of search parameters for this resource , and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Expression In Common
composed-of reference What resource is being referenced EventDefinition.relatedArtifact.where(type='composed-of').resource
(Any) 		5 Resources
context token A use context assigned to the event definition (EventDefinition.useContext.value.ofType(CodeableConcept)) 30 25 Resources
context-quantity quantity A quantity- or range-valued use context assigned to the event definition (EventDefinition.useContext.value.ofType(Quantity)) | (EventDefinition.useContext.value.ofType(Range)) 30 25 Resources
context-type token A type of use context assigned to the event definition EventDefinition.useContext.code 30 25 Resources
context-type-quantity composite A use context type and quantity- or range-based value assigned to the event definition On EventDefinition.useContext:
  context-type: code
  context-quantity: value.ofType(Quantity) | value.ofType(Range) 		30 25 Resources
context-type-value composite A use context type and value assigned to the event definition On EventDefinition.useContext:
  context-type: code
  context: value.ofType(CodeableConcept) 		30 25 Resources
date date The event definition publication date EventDefinition.date 31 26 Resources
depends-on reference What resource is being referenced EventDefinition.relatedArtifact.where(type='depends-on').resource
(Any) 		5 Resources
derived-from reference What resource is being referenced EventDefinition.relatedArtifact.where(type='derived-from').resource
(Any) 		9 Resources
description string The description of the event definition EventDefinition.description 29 24 Resources
effective date The time during which the event definition is intended to be in use EventDefinition.effectivePeriod 12 10 Resources
experimental token Whether the EventDefinition is experimental EventDefinition.experimental
identifier token External identifier for the event definition EventDefinition.identifier 35 30 Resources
jurisdiction token Intended jurisdiction for Jurisdiction of the authority that maintains the the event definition EventDefinition.jurisdiction 27 22 Resources
name string Computationally friendly name of the event definition EventDefinition.name 28 24 Resources
predecessor reference What resource is being referenced EventDefinition.relatedArtifact.where(type='predecessor').resource
(Any) 		9 Resources
publisher string Name of the publisher of the event definition EventDefinition.publisher 31 26 Resources
status token The current status of the event definition EventDefinition.status 35 30 Resources
successor reference What resource is being referenced EventDefinition.relatedArtifact.where(type='successor').resource
(Any) 		5 Resources
title string The human-friendly name of the event definition EventDefinition.title 28 24 Resources
topic token Topics associated with the module EventDefinition.topic 10 Resources
url uri The uri that identifies the event definition EventDefinition.url 35 30 Resources
version token The business version of the event definition EventDefinition.version 32 27 Resources