Release 5 Preview #3

This page is part of the FHIR Specification (v4.5.0: R5 Preview #3). 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

14.9 Resource EventDefinition - Content

Clinical Decision Support Work GroupMaturity Level: 0 Trial UseSecurity Category: Anonymous Compartments: Not linked to any defined compartments

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

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

14.9.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.9.3 References

No resources refer to this resource directly.

This resource implements the Definition pattern.

14.9.4 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. EventDefinition TUMetadataResourceA 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, url, identifier, version, name, title, status, experimental, date, publisher, contact, description, useContext, jurisdiction, purpose, copyright, approvalDate, lastReviewDate, effectivePeriod
... url Σ0..1uriCanonical identifier for this event definition, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the event definition
... version Σ0..1stringBusiness version of the event definition
... name ΣI0..1stringName for this event definition (computer friendly)
... title Σ0..1stringName for this event definition (human friendly)
... subtitle 0..1stringSubordinate title of the event definition
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... subject[x] 0..1Type of individual the event definition is focused on
Subject type (Extensible)
.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the event definition
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for event definition (if applicable)
Jurisdiction (Extensible)
... purpose 0..1markdownWhy this event definition is defined
... usage 0..1stringDescribes the clinical usage of the event definition
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate Σ0..1dateWhen the event definition was approved by publisher
... lastReviewDate Σ0..1dateWhen the event definition was last reviewed
... effectivePeriod Σ0..1PeriodWhen the event definition is expected to be used
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
DefinitionTopic (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

UML Diagram (Legend)

EventDefinition (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 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]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]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] « The lifecycle status of an artifact. (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); The possible types of subjects for an event (E.g. Patient, Practitioner, Organization, Location, etc.). (Strength=Extensible) SubjectType+ »The date (and optionally time) when the event definition was published. 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 that published 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..*] « Countries and regions within which this artifact is targeted for use. (Strength=Extensible)Jurisdiction ValueSet+ »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 : string [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]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..*] « High-level categorization of the definition, used for searching, sorting, and filtering. (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 primarily responsible for review of some aspect of the contentreviewer : ContactDetail [0..*]An individual or organization 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 -->
 <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 -->
 <name value="[string]"/><!-- ?? 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 (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="[string]"/><!-- 0..1 Describes the clinical usage of the event definition -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <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>
 <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
  "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
  "name" : "<string>", // C? 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 (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" : "<string>", // Describes the clinical usage of the event definition
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "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
  "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
  fhir:EventDefinition.url [ uri ]; # 0..1 Canonical identifier for this event definition, represented as a URI (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.subtitle [ string ]; # 0..1 Subordinate title of the event definition
  fhir:EventDefinition.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:EventDefinition.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  # EventDefinition.subject[x] : 0..1 Type of individual the event definition is focused on. One of these 2
    fhir:EventDefinition.subjectCodeableConcept [ CodeableConcept ]
    fhir:EventDefinition.subjectReference [ Reference(Group) ]
  fhir:EventDefinition.date [ dateTime ]; # 0..1 Date last changed
  fhir:EventDefinition.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:EventDefinition.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:EventDefinition.description [ markdown ]; # 0..1 Natural language description of the event definition
  fhir:EventDefinition.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support
  fhir:EventDefinition.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for event definition (if applicable)
  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.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  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.topic [ CodeableConcept ], ... ; # 0..* E.g. Education, Treatment, Assessment, etc.
  fhir:EventDefinition.author [ ContactDetail ], ... ; # 0..* Who authored the content
  fhir:EventDefinition.editor [ ContactDetail ], ... ; # 0..* Who edited the content
  fhir:EventDefinition.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the content
  fhir:EventDefinition.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the content
  fhir:EventDefinition.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations, etc.
  fhir:EventDefinition.trigger [ TriggerDefinition ], ... ; # 1..* "when" the event occurs (multiple = 'or')
]

Changes since R3

EventDefinition
EventDefinition.status
  • Change value set from http://hl7.org/fhir/ValueSet/publication-status|4.0.0 to http://hl7.org/fhir/ValueSet/publication-status|4.5.0

See the Full Difference for further information

This analysis is available as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. EventDefinition TUMetadataResourceA 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, url, identifier, version, name, title, status, experimental, date, publisher, contact, description, useContext, jurisdiction, purpose, copyright, approvalDate, lastReviewDate, effectivePeriod
... url Σ0..1uriCanonical identifier for this event definition, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the event definition
... version Σ0..1stringBusiness version of the event definition
... name ΣI0..1stringName for this event definition (computer friendly)
... title Σ0..1stringName for this event definition (human friendly)
... subtitle 0..1stringSubordinate title of the event definition
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... subject[x] 0..1Type of individual the event definition is focused on
Subject type (Extensible)
.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the event definition
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for event definition (if applicable)
Jurisdiction (Extensible)
... purpose 0..1markdownWhy this event definition is defined
... usage 0..1stringDescribes the clinical usage of the event definition
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate Σ0..1dateWhen the event definition was approved by publisher
... lastReviewDate Σ0..1dateWhen the event definition was last reviewed
... effectivePeriod Σ0..1PeriodWhen the event definition is expected to be used
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
DefinitionTopic (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

UML Diagram (Legend)

EventDefinition (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 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]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]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] « The lifecycle status of an artifact. (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); The possible types of subjects for an event (E.g. Patient, Practitioner, Organization, Location, etc.). (Strength=Extensible) SubjectType+ »The date (and optionally time) when the event definition was published. 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 that published 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..*] « Countries and regions within which this artifact is targeted for use. (Strength=Extensible)Jurisdiction ValueSet+ »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 : string [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]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..*] « High-level categorization of the definition, used for searching, sorting, and filtering. (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 primarily responsible for review of some aspect of the contentreviewer : ContactDetail [0..*]An individual or organization 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 -->
 <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 -->
 <name value="[string]"/><!-- ?? 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 (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="[string]"/><!-- 0..1 Describes the clinical usage of the event definition -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <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>
 <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
  "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
  "name" : "<string>", // C? 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 (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" : "<string>", // Describes the clinical usage of the event definition
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "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
  "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
  fhir:EventDefinition.url [ uri ]; # 0..1 Canonical identifier for this event definition, represented as a URI (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.subtitle [ string ]; # 0..1 Subordinate title of the event definition
  fhir:EventDefinition.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:EventDefinition.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  # EventDefinition.subject[x] : 0..1 Type of individual the event definition is focused on. One of these 2
    fhir:EventDefinition.subjectCodeableConcept [ CodeableConcept ]
    fhir:EventDefinition.subjectReference [ Reference(Group) ]
  fhir:EventDefinition.date [ dateTime ]; # 0..1 Date last changed
  fhir:EventDefinition.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:EventDefinition.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:EventDefinition.description [ markdown ]; # 0..1 Natural language description of the event definition
  fhir:EventDefinition.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support
  fhir:EventDefinition.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for event definition (if applicable)
  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.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  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.topic [ CodeableConcept ], ... ; # 0..* E.g. Education, Treatment, Assessment, etc.
  fhir:EventDefinition.author [ ContactDetail ], ... ; # 0..* Who authored the content
  fhir:EventDefinition.editor [ ContactDetail ], ... ; # 0..* Who edited the content
  fhir:EventDefinition.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the content
  fhir:EventDefinition.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the content
  fhir:EventDefinition.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations, etc.
  fhir:EventDefinition.trigger [ TriggerDefinition ], ... ; # 1..* "when" the event occurs (multiple = 'or')
]

Changes since Release 3

EventDefinition
EventDefinition.status
  • Change value set from http://hl7.org/fhir/ValueSet/publication-status|4.0.0 to http://hl7.org/fhir/ValueSet/publication-status|4.5.0

See the Full Difference for further information

This analysis is available as XML or JSON.

 

See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) , the spreadsheet version & the dependency analysis a

14.9.4.1 Terminology Bindings

PathDefinitionTypeReference
EventDefinition.status The lifecycle status of an artifact.RequiredPublicationStatus
EventDefinition.subject[x] The possible types of subjects for an event (E.g. Patient, Practitioner, Organization, Location, etc.).ExtensibleSubjectType
EventDefinition.jurisdiction Countries and regions within which this artifact is targeted for use.ExtensibleJurisdiction ValueSet
EventDefinition.topic High-level categorization of the definition, used for searching, sorting, and filtering.ExampleDefinitionTopic

14.9.4.2 Constraints

idLevelLocationDescriptionExpression
cnl-0Warning (base)Name should be usable as an identifier for the module by machine processing applications such as code generationname.matches('[A-Z]([A-Za-z0-9_]){0,254}')

14.9.5 Search Parameters

Search parameters for 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)
contexttokenA use context assigned to the event definition(EventDefinition.useContext.value as CodeableConcept)
context-quantityquantityA quantity- or range-valued use context assigned to the event definition(EventDefinition.useContext.value as Quantity) | (EventDefinition.useContext.value as Range)
context-typetokenA type of use context assigned to the event definitionEventDefinition.useContext.code
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.as(Quantity) | value.as(Range)
context-type-valuecompositeA use context type and value assigned to the event definitionOn EventDefinition.useContext:
  context-type: code
  context: value.as(CodeableConcept)
date NdateThe event definition publication dateEventDefinition.date
depends-onreferenceWhat resource is being referencedEventDefinition.relatedArtifact.where(type='depends-on').resource
(Any)
derived-fromreferenceWhat resource is being referencedEventDefinition.relatedArtifact.where(type='derived-from').resource
(Any)
description NstringThe description of the event definitionEventDefinition.description
effectivedateThe time during which the event definition is intended to be in useEventDefinition.effectivePeriod
identifiertokenExternal identifier for the event definitionEventDefinition.identifier
jurisdictiontokenIntended jurisdiction for the event definitionEventDefinition.jurisdiction
name NstringComputationally friendly name of the event definitionEventDefinition.name
predecessorreferenceWhat resource is being referencedEventDefinition.relatedArtifact.where(type='predecessor').resource
(Any)
publisher NstringName of the publisher of the event definitionEventDefinition.publisher
status NtokenThe current status of the event definitionEventDefinition.status
successorreferenceWhat resource is being referencedEventDefinition.relatedArtifact.where(type='successor').resource
(Any)
title NstringThe human-friendly name of the event definitionEventDefinition.title
topictokenTopics associated with the moduleEventDefinition.topic
url NuriThe uri that identifies the event definitionEventDefinition.url
version NtokenThe business version of the event definitionEventDefinition.version