Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4

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 TUDomainResourceA 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 ΣC0..1uriCanonical 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..*IdentifierAdditional identifier for the event definition

... version Σ0..1stringBusiness version of the event definition
... versionAlgorithm[x] Σ0..1How to compare versions
Binding: Version Algorithm (Extensible)
.... versionAlgorithmStringstring
.... versionAlgorithmCodingCoding
... name ΣC0..1stringName for this event definition (computer friendly)
... title ΣT0..1stringName for this event definition (human friendly)
... subtitle 0..1stringSubordinate title of the event definition
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... subject[x] 0..1Type of individual the event definition is focused on
Binding: Participant Resource Types (Extensible)
.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date Σ0..1dateTimeDate last changed
... publisher ΣT0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher

... description T0..1markdownNatural language description of the event definition
... useContext Σ0..*UsageContextThe context that the content is intended to support

... jurisdiction ΣXD0..*CodeableConceptIntended jurisdiction for event definition (if applicable)
Binding: Jurisdiction ValueSet (Extensible)

... purpose T0..1markdownWhy this event definition is defined
... usage 0..1markdownDescribes the clinical usage of the event definition
... copyright T0..1markdownUse and/or publishing restrictions
... copyrightLabel T0..1stringCopyright holder and year(s)
... approvalDate Σ0..1dateWhen the event definition was approved by publisher
... lastReviewDate Σ0..1dateWhen the event definition was last reviewed by the publisher
... effectivePeriod Σ0..1PeriodWhen the event definition is expected to be used
... topic XD0..*CodeableConceptE.g. Education, Treatment, Assessment, etc
Binding: Definition Topic (Example)

... author 0..*ContactDetailWho authored the content

... editor 0..*ContactDetailWho edited the content

... reviewer 0..*ContactDetailWho reviewed the content

... endorser 0..*ContactDetailWho endorsed the content

... relatedArtifact 0..*RelatedArtifactAdditional 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) +MetadataResourceAn 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 serversurl : 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 instanceidentifier : 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 sequenceversion : string [0..1]Indicates the mechanism used to compare versions to determine which is more currentversionAlgorithm[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 generationname : string [0..1] « This element has or is affected by some invariantsC »A short, descriptive, user-friendly title for the event definitiontitle : string [0..1]An explanatory or alternate title for the event definition giving additional information about its contentsubtitle : 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 is not intended to be used for genuine usageexperimental : boolean [0..1]A code or group definition that describes the intended subject of the event definitionsubject[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 changesdate : dateTime [0..1]The name of the organization or individual responsible for the release and ongoing maintenance of the event definitionpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the event definition from a consumer's perspectivedescription : 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 instancesuseContext : UsageContext [0..*]A legal or geographic region in which the event definition is intended to be usedjurisdiction : CodeableConcept [0..*] « null (Strength=Extensible)JurisdictionValueSet+ »Explanation of why this event definition is needed and why it has been designed as it haspurpose : markdown [0..1]A detailed description of how the event definition is used from a clinical perspectiveusage : markdown [0..1]A copyright statement relating to the event definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the event definitioncopyright : 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. (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 usageapprovalDate : 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 datelastReviewDate : date [0..1]The period during which the event definition content was or is planned to be in active useeffectivePeriod : 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 searchingtopic : CodeableConcept [0..*] « null (Strength=Example)DefinitionTopic?? »An individiual or organization primarily involved in the creation and maintenance of the contentauthor : ContactDetail [0..*]An individual or organization primarily responsible for internal coherence of the contenteditor : ContactDetail [0..*]An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the contentreviewer : ContactDetail [0..*]An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some settingendorser : ContactDetail [0..*]Related resources such as additional documentation, justification, or bibliographic referencesrelatedArtifact : 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 mettrigger : 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 purposes, not 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><!-- 0..* CodeableConcept Intended jurisdiction for event definition (if applicable) --></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 Use and/or publishing restrictions -->
 <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 purposes, not 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 }], // Intended jurisdiction for event definition (if applicable)
  "purpose" : "<markdown>", // Why this event definition is defined
  "usage" : "<markdown>", // Describes the clinical usage of the event definition
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "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 Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .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: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 purposes, not 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:jurisdiction  ( [ CodeableConcept ] ... ) ; # 0..* Intended jurisdiction for 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:copyright [ markdown ] ; # 0..1 Use and/or publishing restrictions
  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.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

NameFlagsCard.TypeDescription & Constraintsdoco
.. EventDefinition TUDomainResourceA 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 ΣC0..1uriCanonical 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..*IdentifierAdditional identifier for the event definition

... version Σ0..1stringBusiness version of the event definition
... versionAlgorithm[x] Σ0..1How to compare versions
Binding: Version Algorithm (Extensible)
.... versionAlgorithmStringstring
.... versionAlgorithmCodingCoding
... name ΣC0..1stringName for this event definition (computer friendly)
... title ΣT0..1stringName for this event definition (human friendly)
... subtitle 0..1stringSubordinate title of the event definition
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... subject[x] 0..1Type of individual the event definition is focused on
Binding: Participant Resource Types (Extensible)
.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date Σ0..1dateTimeDate last changed
... publisher ΣT0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher

... description T0..1markdownNatural language description of the event definition
... useContext Σ0..*UsageContextThe context that the content is intended to support

... jurisdiction ΣXD0..*CodeableConceptIntended jurisdiction for event definition (if applicable)
Binding: Jurisdiction ValueSet (Extensible)

... purpose T0..1markdownWhy this event definition is defined
... usage 0..1markdownDescribes the clinical usage of the event definition
... copyright T0..1markdownUse and/or publishing restrictions
... copyrightLabel T0..1stringCopyright holder and year(s)
... approvalDate Σ0..1dateWhen the event definition was approved by publisher
... lastReviewDate Σ0..1dateWhen the event definition was last reviewed by the publisher
... effectivePeriod Σ0..1PeriodWhen the event definition is expected to be used
... topic XD0..*CodeableConceptE.g. Education, Treatment, Assessment, etc
Binding: Definition Topic (Example)

... author 0..*ContactDetailWho authored the content

... editor 0..*ContactDetailWho edited the content

... reviewer 0..*ContactDetailWho reviewed the content

... endorser 0..*ContactDetailWho endorsed the content

... relatedArtifact 0..*RelatedArtifactAdditional 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) +MetadataResourceAn 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 serversurl : 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 instanceidentifier : 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 sequenceversion : string [0..1]Indicates the mechanism used to compare versions to determine which is more currentversionAlgorithm[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 generationname : string [0..1] « This element has or is affected by some invariantsC »A short, descriptive, user-friendly title for the event definitiontitle : string [0..1]An explanatory or alternate title for the event definition giving additional information about its contentsubtitle : 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 is not intended to be used for genuine usageexperimental : boolean [0..1]A code or group definition that describes the intended subject of the event definitionsubject[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 changesdate : dateTime [0..1]The name of the organization or individual responsible for the release and ongoing maintenance of the event definitionpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the event definition from a consumer's perspectivedescription : 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 instancesuseContext : UsageContext [0..*]A legal or geographic region in which the event definition is intended to be usedjurisdiction : CodeableConcept [0..*] « null (Strength=Extensible)JurisdictionValueSet+ »Explanation of why this event definition is needed and why it has been designed as it haspurpose : markdown [0..1]A detailed description of how the event definition is used from a clinical perspectiveusage : markdown [0..1]A copyright statement relating to the event definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the event definitioncopyright : 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. (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 usageapprovalDate : 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 datelastReviewDate : date [0..1]The period during which the event definition content was or is planned to be in active useeffectivePeriod : 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 searchingtopic : CodeableConcept [0..*] « null (Strength=Example)DefinitionTopic?? »An individiual or organization primarily involved in the creation and maintenance of the contentauthor : ContactDetail [0..*]An individual or organization primarily responsible for internal coherence of the contenteditor : ContactDetail [0..*]An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the contentreviewer : ContactDetail [0..*]An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some settingendorser : ContactDetail [0..*]Related resources such as additional documentation, justification, or bibliographic referencesrelatedArtifact : 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 mettrigger : 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 purposes, not 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><!-- 0..* CodeableConcept Intended jurisdiction for event definition (if applicable) --></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 Use and/or publishing restrictions -->
 <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 purposes, not 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 }], // Intended jurisdiction for event definition (if applicable)
  "purpose" : "<markdown>", // Why this event definition is defined
  "usage" : "<markdown>", // Describes the clinical usage of the event definition
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "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 Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .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: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 purposes, not 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:jurisdiction  ( [ CodeableConcept ] ... ) ; # 0..* Intended jurisdiction for 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:copyright [ markdown ] ; # 0..1 Use and/or publishing restrictions
  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.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

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

NameTypeDescriptionExpressionIn Common
composed-ofreferenceWhat resource is being referencedEventDefinition.relatedArtifact.where(type='composed-of').resource
(Any)		6 Resources
contexttokenA use context assigned to the event definition(EventDefinition.useContext.value.ofType(CodeableConcept))30 Resources
context-quantityquantityA quantity- or range-valued use context assigned to the event definition(EventDefinition.useContext.value.ofType(Quantity)) | (EventDefinition.useContext.value.ofType(Range))30 Resources
context-typetokenA type of use context assigned to the event definitionEventDefinition.useContext.code30 Resources
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the event definitionOn EventDefinition.useContext:
  context-type: code
  context-quantity: value.ofType(Quantity) | value.ofType(Range)		30 Resources
context-type-valuecompositeA use context type and value assigned to the event definitionOn EventDefinition.useContext:
  context-type: code
  context: value.ofType(CodeableConcept)		30 Resources
datedateThe event definition publication dateEventDefinition.date30 Resources
depends-onreferenceWhat resource is being referencedEventDefinition.relatedArtifact.where(type='depends-on').resource
(Any)		6 Resources
derived-fromreferenceWhat resource is being referencedEventDefinition.relatedArtifact.where(type='derived-from').resource
(Any)		10 Resources
descriptionstringThe description of the event definitionEventDefinition.description28 Resources
effectivedateThe time during which the event definition is intended to be in useEventDefinition.effectivePeriod12 Resources
identifiertokenExternal identifier for the event definitionEventDefinition.identifier34 Resources
jurisdictiontokenIntended jurisdiction for the event definitionEventDefinition.jurisdiction26 Resources
namestringComputationally friendly name of the event definitionEventDefinition.name26 Resources
predecessorreferenceWhat resource is being referencedEventDefinition.relatedArtifact.where(type='predecessor').resource
(Any)		10 Resources
publisherstringName of the publisher of the event definitionEventDefinition.publisher30 Resources
statustokenThe current status of the event definitionEventDefinition.status35 Resources
successorreferenceWhat resource is being referencedEventDefinition.relatedArtifact.where(type='successor').resource
(Any)		6 Resources
titlestringThe human-friendly name of the event definitionEventDefinition.title27 Resources
topictokenTopics associated with the moduleEventDefinition.topic10 Resources
urluriThe uri that identifies the event definitionEventDefinition.url34 Resources
versiontokenThe business version of the event definitionEventDefinition.version30 Resources