FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

14.10 Resource EventDefinition - Content

Clinical Decision Support icon Work GroupMaturity Level: 0 Trial UseSecurity 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 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. EventDefinition is a definition of an event that could occur, whereas Subscription is asking for notification of events when they occur.

14.10.3 References to this Resource

14.10.4 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. EventDefinition TU 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 Intended jurisdiction for event definition (if applicable)
Binding: Jurisdiction ValueSet (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 Use and/or publishing restrictions
... 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 XD 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

 

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 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

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

14.10.5 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 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 Resources
context-type token A type of use context assigned to the event definition EventDefinition.useContext.code 30 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 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 Resources
date date The event definition publication date EventDefinition.date 31 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 Resources
effective date The time during which the event definition is intended to be in use EventDefinition.effectivePeriod 12 Resources
identifier token External identifier for the event definition EventDefinition.identifier 35 Resources
jurisdiction token Intended jurisdiction for the event definition EventDefinition.jurisdiction 27 Resources
name string Computationally friendly name of the event definition EventDefinition.name 28 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 Resources
status token The current status of the event definition EventDefinition.status 35 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 Resources
topic token Topics associated with the module EventDefinition.topic 10 Resources
url uri The uri that identifies the event definition EventDefinition.url 34 Resources
version token The business version of the event definition EventDefinition.version 32 Resources