Resource type: eventdefinition

Description

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

Elements

PathShortDefinitionComments
A description of when an event can occurThe EventDefinition resource provides a reusable description of when a particular event can occur.
urlCanonical identifier for this event definition, represented as a URI (globally unique)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 servers.Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.
identifierAdditional identifier for the event definitionA formal identifier that is used to identify this event definition when it is represented in other formats, or referenced in a specification, model, design or an instance.Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this event definition outside of FHIR, where it is not possible to use the logical URI.
versionBusiness version of the event definitionThe identifier that is used to identify this version of the event definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the event definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.There may be different event definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the event definition with the format [url]|[version].
nameName for this event definition (computer friendly)A natural language name identifying the event definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
titleName for this event definition (human friendly)A short, descriptive, user-friendly title for the event definition.This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
subtitleSubordinate title of the event definitionAn explanatory or alternate title for the event definition giving additional information about its content.
statusdraft | active | retired | unknownThe status of this event definition. Enables tracking the life-cycle of the content.Allows filtering of event definitions that are appropriate for use versus not.
experimentalFor testing purposes, not real usageA 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 usage.Allows filtering of event definitions that are appropriate for use versus not.
subject[x]Type of individual the event definition is focused onA code or group definition that describes the intended subject of the event definition.
dateDate last changedThe 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 changes.Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the event definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
publisherName of the publisher (organization or individual)The name of the organization or individual that published the event definition.Usually an organization but may be an individual. The publisher (or steward) of the event definition is the organization or individual primarily responsible for the maintenance and upkeep of the event definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the event definition. This item SHOULD be populated unless the information is available from context.
contactContact details for the publisherContact details to assist a user in finding and communicating with the publisher.May be a web site, an email address, a telephone number, etc.
descriptionNatural language description of the event definitionA free text natural language description of the event definition from a consumer's perspective.This description can be used to capture details such as why the event definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the event definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the event definition is presumed to be the predominant language in the place the event definition was created).
useContextThe context that the content is intended to supportThe content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate event definition instances.When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
jurisdictionIntended jurisdiction for event definition (if applicable)A legal or geographic region in which the event definition is intended to be used.It may be possible for the event definition to be used in jurisdictions other than those for which it was originally designed or intended.
purposeWhy this event definition is definedExplanation of why this event definition is needed and why it has been designed as it has.This element does not describe the usage of the event definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this event definition.
usageDescribes the clinical usage of the event definitionA detailed description of how the event definition is used from a clinical perspective.
copyrightUse and/or publishing restrictionsA 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 definition.
approvalDateWhen the event definition was approved by publisherThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
lastReviewDateWhen the event definition was last reviewedThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.If specified, this date follows the original approval date.
effectivePeriodWhen the event definition is expected to be usedThe period during which the event definition content was or is planned to be in active use.The effective period for a event definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.
topicE.g. Education, Treatment, Assessment, etc.Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching.
authorWho authored the contentAn individiual or organization primarily involved in the creation and maintenance of the content.
editorWho edited the contentAn individual or organization primarily responsible for internal coherence of the content.
reviewerWho reviewed the contentAn individual or organization primarily responsible for review of some aspect of the content.
endorserWho endorsed the contentAn individual or organization responsible for officially endorsing the content for use in some setting.
relatedArtifactAdditional documentation, citations, etc.Related resources such as additional documentation, justification, or bibliographic references.Each related resource is either an attachment, or a reference to another resource, but not both.
trigger"when" the event occurs (multiple = 'or')The trigger element defines when the event occurs. If more than one trigger condition is specified, the event fires whenever any one of the trigger conditions is met.

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.

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.

Search Parameters

composed-ofWhat resource is being referencedEventDefinition.relatedArtifact.where(type='composed-of').resource
contextA use context assigned to the event definition(EventDefinition.useContext.value as CodeableConcept)
context-quantityA quantity- or range-valued use context assigned to the event definition(EventDefinition.useContext.value as Quantity) | (EventDefinition.useContext.value as Range)
context-typeA type of use context assigned to the event definitionEventDefinition.useContext.code
dateThe event definition publication dateEventDefinition.date
depends-onWhat resource is being referencedEventDefinition.relatedArtifact.where(type='depends-on').resource
derived-fromWhat resource is being referencedEventDefinition.relatedArtifact.where(type='derived-from').resource
descriptionThe description of the event definitionEventDefinition.description
effectiveThe time during which the event definition is intended to be in useEventDefinition.effectivePeriod
identifierExternal identifier for the event definitionEventDefinition.identifier
jurisdictionIntended jurisdiction for the event definitionEventDefinition.jurisdiction
nameComputationally friendly name of the event definitionEventDefinition.name
predecessorWhat resource is being referencedEventDefinition.relatedArtifact.where(type='predecessor').resource
publisherName of the publisher of the event definitionEventDefinition.publisher
statusThe current status of the event definitionEventDefinition.status
successorWhat resource is being referencedEventDefinition.relatedArtifact.where(type='successor').resource
titleThe human-friendly name of the event definitionEventDefinition.title
topicTopics associated with the moduleEventDefinition.topic
urlThe uri that identifies the event definitionEventDefinition.url
versionThe business version of the event definitionEventDefinition.version
context-type-quantityA use context type and quantity- or range-based value assigned to the event definitionEventDefinition.useContext
context-type-valueA use context type and value assigned to the event definitionEventDefinition.useContext

Extension Definitions

These are extension definitions for this resource defined by the spec