This page is part of the FHIR Specification (v3.2.0: R4 Ballot 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4
Clinical Decision Support Work Group | Maturity Level: 0 | Draft | Compartments: Not linked to any defined compartments |
The EventDefinition resource provides a reusable description of when a particular event can occur.
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.
The EventDefinition resource is intended to be used to provide a resuable 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.
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
EventDefinition | D | DomainResource | A description of when an event can occur Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
url | Σ | 0..1 | uri | Logical URI to reference this event definition (globally unique) |
identifier | Σ | 0..* | Identifier | Additional identifier for the event definition |
version | Σ | 0..1 | string | Business version of the event definition |
name | Σ | 0..1 | string | Name for this event definition (computer friendly) |
title | Σ | 0..1 | string | Name for this event definition (human friendly) |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (Required) |
experimental | ?!Σ | 0..1 | boolean | For testing purposes, not real usage |
date | Σ | 0..1 | dateTime | Date this was last changed |
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) |
description | 0..1 | markdown | Natural language description of the event definition | |
purpose | 0..1 | markdown | Why this event definition is defined | |
usage | 0..1 | string | Describes the clinical usage of the event definition | |
approvalDate | Σ | 0..1 | date | When the event definition was approved by publisher |
lastReviewDate | Σ | 0..1 | date | When the event definition was last reviewed |
effectivePeriod | Σ | 0..1 | Period | When the event definition is expected to be used |
useContext | Σ | 0..* | UsageContext | Context the content is intended to support |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for event definition (if applicable) Jurisdiction ValueSet (Extensible) |
topic | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc DefinitionTopic (Example) | |
contributor | 0..* | Contributor | A content contributor | |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations, etc | |
trigger | Σ | 1..1 | TriggerDefinition | "when" the event occurs |
Documentation for this format |
UML Diagram (Legend)
XML Template
<EventDefinition xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <url value="[uri]"/><!-- 0..1 Logical URI to reference this event definition (globally unique) --> <identifier><!-- 0..* Identifier Additional identifier for the event definition --></identifier> <version value="[string]"/><!-- 0..1 Business version of the event definition --> <name value="[string]"/><!-- 0..1 Name for this event definition (computer friendly) --> <title value="[string]"/><!-- 0..1 Name for this event definition (human friendly) --> <status value="[code]"/><!-- 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage --> <date value="[dateTime]"/><!-- 0..1 Date this was last changed --> <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) --> <description value="[markdown]"/><!-- 0..1 Natural language description of the event definition --> <purpose value="[markdown]"/><!-- 0..1 Why this event definition is defined --> <usage value="[string]"/><!-- 0..1 Describes the clinical usage of the event definition --> <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 --> <effectivePeriod><!-- 0..1 Period When the event definition is expected to be used --></effectivePeriod> <useContext><!-- 0..* UsageContext Context the content is intended to support --></useContext> <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for event definition (if applicable) --></jurisdiction> <topic><!-- 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc --></topic> <contributor><!-- 0..* Contributor A content contributor --></contributor> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions --> <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc --></relatedArtifact> <trigger><!-- 1..1 TriggerDefinition "when" the event occurs --></trigger> </EventDefinition>
JSON Template
{ "resourceType" : "EventDefinition", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "url" : "<uri>", // Logical URI to reference this event definition (globally unique) "identifier" : [{ Identifier }], // Additional identifier for the event definition "version" : "<string>", // Business version of the event definition "name" : "<string>", // Name for this event definition (computer friendly) "title" : "<string>", // Name for this event definition (human friendly) "status" : "<code>", // R! draft | active | retired | unknown "experimental" : <boolean>, // For testing purposes, not real usage "date" : "<dateTime>", // Date this was last changed "publisher" : "<string>", // Name of the publisher (organization or individual) "description" : "<markdown>", // Natural language description of the event definition "purpose" : "<markdown>", // Why this event definition is defined "usage" : "<string>", // Describes the clinical usage of the event definition "approvalDate" : "<date>", // When the event definition was approved by publisher "lastReviewDate" : "<date>", // When the event definition was last reviewed "effectivePeriod" : { Period }, // When the event definition is expected to be used "useContext" : [{ UsageContext }], // Context the content is intended to support "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for event definition (if applicable) "topic" : [{ CodeableConcept }], // E.g. Education, Treatment, Assessment, etc "contributor" : [{ Contributor }], // A content contributor "contact" : [{ ContactDetail }], // Contact details for the publisher "copyright" : "<markdown>", // Use and/or publishing restrictions "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations, etc "trigger" : { TriggerDefinition } // R! "when" the event occurs }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:EventDefinition; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:EventDefinition.url [ uri ]; # 0..1 Logical URI to reference this event definition (globally unique) fhir:EventDefinition.identifier [ Identifier ], ... ; # 0..* Additional identifier for the event definition fhir:EventDefinition.version [ string ]; # 0..1 Business version of the event definition fhir:EventDefinition.name [ string ]; # 0..1 Name for this event definition (computer friendly) fhir:EventDefinition.title [ string ]; # 0..1 Name for this event definition (human friendly) fhir:EventDefinition.status [ code ]; # 1..1 draft | active | retired | unknown fhir:EventDefinition.experimental [ boolean ]; # 0..1 For testing purposes, not real usage fhir:EventDefinition.date [ dateTime ]; # 0..1 Date this was last changed fhir:EventDefinition.publisher [ string ]; # 0..1 Name of the publisher (organization or individual) fhir:EventDefinition.description [ markdown ]; # 0..1 Natural language description of the event definition fhir:EventDefinition.purpose [ markdown ]; # 0..1 Why this event definition is defined fhir:EventDefinition.usage [ string ]; # 0..1 Describes the clinical usage of the event definition fhir:EventDefinition.approvalDate [ date ]; # 0..1 When the event definition was approved by publisher fhir:EventDefinition.lastReviewDate [ date ]; # 0..1 When the event definition was last reviewed fhir:EventDefinition.effectivePeriod [ Period ]; # 0..1 When the event definition is expected to be used fhir:EventDefinition.useContext [ UsageContext ], ... ; # 0..* Context the content is intended to support fhir:EventDefinition.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for event definition (if applicable) fhir:EventDefinition.topic [ CodeableConcept ], ... ; # 0..* E.g. Education, Treatment, Assessment, etc fhir:EventDefinition.contributor [ Contributor ], ... ; # 0..* A content contributor fhir:EventDefinition.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher fhir:EventDefinition.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions fhir:EventDefinition.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations, etc fhir:EventDefinition.trigger [ TriggerDefinition ]; # 1..1 "when" the event occurs ]
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
EventDefinition | D | DomainResource | A description of when an event can occur Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
url | Σ | 0..1 | uri | Logical URI to reference this event definition (globally unique) |
identifier | Σ | 0..* | Identifier | Additional identifier for the event definition |
version | Σ | 0..1 | string | Business version of the event definition |
name | Σ | 0..1 | string | Name for this event definition (computer friendly) |
title | Σ | 0..1 | string | Name for this event definition (human friendly) |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (Required) |
experimental | ?!Σ | 0..1 | boolean | For testing purposes, not real usage |
date | Σ | 0..1 | dateTime | Date this was last changed |
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) |
description | 0..1 | markdown | Natural language description of the event definition | |
purpose | 0..1 | markdown | Why this event definition is defined | |
usage | 0..1 | string | Describes the clinical usage of the event definition | |
approvalDate | Σ | 0..1 | date | When the event definition was approved by publisher |
lastReviewDate | Σ | 0..1 | date | When the event definition was last reviewed |
effectivePeriod | Σ | 0..1 | Period | When the event definition is expected to be used |
useContext | Σ | 0..* | UsageContext | Context the content is intended to support |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for event definition (if applicable) Jurisdiction ValueSet (Extensible) |
topic | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc DefinitionTopic (Example) | |
contributor | 0..* | Contributor | A content contributor | |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations, etc | |
trigger | Σ | 1..1 | TriggerDefinition | "when" the event occurs |
Documentation for this format |
XML Template
<EventDefinition xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <url value="[uri]"/><!-- 0..1 Logical URI to reference this event definition (globally unique) --> <identifier><!-- 0..* Identifier Additional identifier for the event definition --></identifier> <version value="[string]"/><!-- 0..1 Business version of the event definition --> <name value="[string]"/><!-- 0..1 Name for this event definition (computer friendly) --> <title value="[string]"/><!-- 0..1 Name for this event definition (human friendly) --> <status value="[code]"/><!-- 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage --> <date value="[dateTime]"/><!-- 0..1 Date this was last changed --> <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) --> <description value="[markdown]"/><!-- 0..1 Natural language description of the event definition --> <purpose value="[markdown]"/><!-- 0..1 Why this event definition is defined --> <usage value="[string]"/><!-- 0..1 Describes the clinical usage of the event definition --> <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 --> <effectivePeriod><!-- 0..1 Period When the event definition is expected to be used --></effectivePeriod> <useContext><!-- 0..* UsageContext Context the content is intended to support --></useContext> <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for event definition (if applicable) --></jurisdiction> <topic><!-- 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc --></topic> <contributor><!-- 0..* Contributor A content contributor --></contributor> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions --> <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc --></relatedArtifact> <trigger><!-- 1..1 TriggerDefinition "when" the event occurs --></trigger> </EventDefinition>
JSON Template
{ "resourceType" : "EventDefinition", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "url" : "<uri>", // Logical URI to reference this event definition (globally unique) "identifier" : [{ Identifier }], // Additional identifier for the event definition "version" : "<string>", // Business version of the event definition "name" : "<string>", // Name for this event definition (computer friendly) "title" : "<string>", // Name for this event definition (human friendly) "status" : "<code>", // R! draft | active | retired | unknown "experimental" : <boolean>, // For testing purposes, not real usage "date" : "<dateTime>", // Date this was last changed "publisher" : "<string>", // Name of the publisher (organization or individual) "description" : "<markdown>", // Natural language description of the event definition "purpose" : "<markdown>", // Why this event definition is defined "usage" : "<string>", // Describes the clinical usage of the event definition "approvalDate" : "<date>", // When the event definition was approved by publisher "lastReviewDate" : "<date>", // When the event definition was last reviewed "effectivePeriod" : { Period }, // When the event definition is expected to be used "useContext" : [{ UsageContext }], // Context the content is intended to support "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for event definition (if applicable) "topic" : [{ CodeableConcept }], // E.g. Education, Treatment, Assessment, etc "contributor" : [{ Contributor }], // A content contributor "contact" : [{ ContactDetail }], // Contact details for the publisher "copyright" : "<markdown>", // Use and/or publishing restrictions "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations, etc "trigger" : { TriggerDefinition } // R! "when" the event occurs }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:EventDefinition; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:EventDefinition.url [ uri ]; # 0..1 Logical URI to reference this event definition (globally unique) fhir:EventDefinition.identifier [ Identifier ], ... ; # 0..* Additional identifier for the event definition fhir:EventDefinition.version [ string ]; # 0..1 Business version of the event definition fhir:EventDefinition.name [ string ]; # 0..1 Name for this event definition (computer friendly) fhir:EventDefinition.title [ string ]; # 0..1 Name for this event definition (human friendly) fhir:EventDefinition.status [ code ]; # 1..1 draft | active | retired | unknown fhir:EventDefinition.experimental [ boolean ]; # 0..1 For testing purposes, not real usage fhir:EventDefinition.date [ dateTime ]; # 0..1 Date this was last changed fhir:EventDefinition.publisher [ string ]; # 0..1 Name of the publisher (organization or individual) fhir:EventDefinition.description [ markdown ]; # 0..1 Natural language description of the event definition fhir:EventDefinition.purpose [ markdown ]; # 0..1 Why this event definition is defined fhir:EventDefinition.usage [ string ]; # 0..1 Describes the clinical usage of the event definition fhir:EventDefinition.approvalDate [ date ]; # 0..1 When the event definition was approved by publisher fhir:EventDefinition.lastReviewDate [ date ]; # 0..1 When the event definition was last reviewed fhir:EventDefinition.effectivePeriod [ Period ]; # 0..1 When the event definition is expected to be used fhir:EventDefinition.useContext [ UsageContext ], ... ; # 0..* Context the content is intended to support fhir:EventDefinition.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for event definition (if applicable) fhir:EventDefinition.topic [ CodeableConcept ], ... ; # 0..* E.g. Education, Treatment, Assessment, etc fhir:EventDefinition.contributor [ Contributor ], ... ; # 0..* A content contributor fhir:EventDefinition.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher fhir:EventDefinition.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions fhir:EventDefinition.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations, etc fhir:EventDefinition.trigger [ TriggerDefinition ]; # 1..1 "when" the event occurs ]
Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions & the dependency analysis
Path | Definition | Type | Reference |
---|---|---|---|
EventDefinition.status | The lifecycle status of a Value Set or Concept Map. | Required | PublicationStatus |
EventDefinition.jurisdiction | Countries and regions within which this artifact is targeted for use | Extensible | Jurisdiction ValueSet |
EventDefinition.topic | High-level categorization of the definition, used for searching, sorting, and filtering | Example | DefinitionTopic |
Search parameters for 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) | |
date | date | The event definition publication date | EventDefinition.date | |
depends-on | reference | What resource is being referenced | EventDefinition.relatedArtifact.where(type='depends-on').resource (Any) | |
derived-from | reference | What resource is being referenced | EventDefinition.relatedArtifact.where(type='derived-from').resource (Any) | |
description | string | The description of the event definition | EventDefinition.description | |
effective | date | The time during which the event definition is intended to be in use | EventDefinition.effectivePeriod | |
identifier | token | External identifier for the event definition | EventDefinition.identifier | |
jurisdiction | token | Intended jurisdiction for the event definition | EventDefinition.jurisdiction | |
name | string | Computationally friendly name of the event definition | EventDefinition.name | |
predecessor | reference | What resource is being referenced | EventDefinition.relatedArtifact.where(type='predecessor').resource (Any) | |
publisher | string | Name of the publisher of the event definition | EventDefinition.publisher | |
status | token | The current status of the event definition | EventDefinition.status | |
successor | reference | What resource is being referenced | EventDefinition.relatedArtifact.where(type='successor').resource (Any) | |
title | string | The human-friendly name of the event definition | EventDefinition.title | |
topic | token | Topics associated with the module | EventDefinition.topic | |
url | uri | The uri that identifies the event definition | EventDefinition.url | |
version | token | The business version of the event definition | EventDefinition.version |