R6 Ballot (2nd Draft)

Publish-box (todo)

Clinical Decision Support icon Work GroupMaturity Level: 0 Trial UseSecurity Category: Anonymous Compartments: No defined compartments

Detailed Descriptions for the elements in the EventDefinition resource.

EventDefinition
Element Id EventDefinition
Definition

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

Short Display A description of when an event can occur
Cardinality 0..*
Type MetadataResource
Summary false
Invariants
Defined on this element
cnl-0Warning 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}$')
EventDefinition.url
Element Id EventDefinition.url
Definition

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

Short Display Canonical identifier for this event definition, represented as a URI (globally unique)
Cardinality 0..1
Type uri
Requirements

Allows the event definition to be referenced by a single globally unique identifier.

Summary true
Comments

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.

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 element to indicate where the current master source of the resource can be found.

Invariants
Defined on this element
cnl-1Warning URL should not contain | or # - these characters make processing canonical references problematicexists() implies matches('^[^|# ]+$')
EventDefinition.identifier
Element Id EventDefinition.identifier
Definition

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

Short Display Additional identifier for the event definition
Note This is a business identifier, not a resource identifier (see discussion)
Cardinality 0..*
Type Identifier
Requirements

Allows externally provided and/or usable business identifiers to be easily associated with the module.

Summary true
Comments

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.

EventDefinition.version
Element Id EventDefinition.version
Definition

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

Short Display Business version of the event definition
Note This is a business versionId, not a resource version id (see discussion)
Cardinality 0..1
Type string
Summary true
Comments

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]. The version SHOULD NOT contain a '#' - see Business Version.

EventDefinition.versionAlgorithm[x]
Element Id EventDefinition.versionAlgorithm[x]
Definition

Indicates the mechanism used to compare versions to determine which is more current.

Short Display How to compare versions
Cardinality 0..1
Terminology Binding Version Algorithm (Extensible)
Type string|Coding
[x] Note See Choice of Datatypes for further information about how to use [x]
Summary true
Comments

If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

EventDefinition.name
Element Id EventDefinition.name
Definition

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.

Short Display Name for this event definition (computer friendly)
Cardinality 0..1
Type string
Requirements

Support human navigation and code generation.

Summary true
Comments

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.

Invariants
Affect this element
cnl-0Warning 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}$')
EventDefinition.title
Element Id EventDefinition.title
Definition

A short, descriptive, user-friendly title for the event definition.

Short Display Name for this event definition (human friendly)
Cardinality 0..1
Type string
Summary true
Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

EventDefinition.subtitle
Element Id EventDefinition.subtitle
Definition

An explanatory or alternate title for the event definition giving additional information about its content.

Short Display Subordinate title of the event definition
Cardinality 0..1
Type string
Summary false
EventDefinition.status
Element Id EventDefinition.status
Definition

The status of this event definition. Enables tracking the life-cycle of the content.

Short Display draft | active | retired | unknown
Cardinality 1..1
Terminology Binding PublicationStatus (Required)
Type code
Is Modifier true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)
Summary true
Comments

Allows filtering of event definitions that are appropriate for use versus not.

See guidance around (not) making local changes to elements here.

EventDefinition.experimental
Element Id EventDefinition.experimental
Definition

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

Short Display For testing purposes, not real usage
Cardinality 0..1
Type boolean
Meaning if Missing If absent, this resource is treated as though it is not experimental.
Requirements

Enables experimental content to be developed following the same lifecycle that would be used for a production-level event definition.

Summary true
Comments

Allows filtering of event definitions that are appropriate for use versus not.

EventDefinition.subject[x]
Element Id EventDefinition.subject[x]
Definition

A code or group definition that describes the intended subject of the event definition.

Short Display Type of individual the event definition is focused on
Cardinality 0..1
Terminology Binding Participant Resource Types (Extensible)
Type CodeableConcept|Reference(Group)
[x] Note See Choice of Datatypes for further information about how to use [x]
Meaning if Missing Patient
Summary false
EventDefinition.date
Element Id EventDefinition.date
Definition

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

Short Display Date last changed
Cardinality 0..1
Type dateTime
Alternate Names Revision Date
Summary true
Comments

The date is often not tracked until the resource is published, but may be present on draft content. 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.

See guidance around (not) making local changes to elements here.

EventDefinition.publisher
Element Id EventDefinition.publisher
Definition

The name of the organization or individual responsible for the release and ongoing maintenance of the event definition.

Short Display Name of the publisher/steward (organization or individual)
Cardinality 0..1
Type string
Requirements

Helps establish the "authority/credibility" of the event definition. May also allow for contact.

Summary true
Comments

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.

EventDefinition.contact
Element Id EventDefinition.contact
Definition

Contact details to assist a user in finding and communicating with the publisher.

Short Display Contact details for the publisher
Cardinality 0..*
Type ContactDetail
Summary true
Comments

May be a web site, an email address, a telephone number, etc.

See guidance around (not) making local changes to elements here.

EventDefinition.description
Element Id EventDefinition.description
Definition

A free text natural language description of the event definition from a consumer's perspective.

Short Display Natural language description of the event definition
Cardinality 0..1
Type markdown
Summary false
Comments

This description can be used to capture details such as 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).

EventDefinition.useContext
Element Id EventDefinition.useContext
Definition

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

Short Display The context that the content is intended to support
Cardinality 0..*
Type UsageContext
Requirements

Assist in searching for appropriate content.

Summary true
Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

EventDefinition.jurisdiction
Standards Status This element has a standards status of "Deprecated" which is different from the status of the whole resource
Element Id EventDefinition.jurisdiction
Definition

A legal or geographic region in which the event definition is intended to be used.

Short Display Intended jurisdiction for event definition (if applicable)
Cardinality 0..*
Terminology Binding Jurisdiction ValueSet (Extensible)
Type CodeableConcept
Summary true
Comments

It may be possible for the event definition to be used in jurisdictions other than those for which it was originally designed or intended.

DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)

EventDefinition.purpose
Element Id EventDefinition.purpose
Definition

Explanation of why this event definition is needed and why it has been designed as it has.

Short Display Why this event definition is defined
Cardinality 0..1
Type markdown
Summary false
Comments

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.

EventDefinition.usage
Element Id EventDefinition.usage
Definition

A detailed description of how the event definition is used from a clinical perspective.

Short Display Describes the clinical usage of the event definition
Cardinality 0..1
Type markdown
Summary false
To Do Does this apply?
EventDefinition.copyright
Element Id EventDefinition.copyright
Definition

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

Short Display Use and/or publishing restrictions
Cardinality 0..1
Type markdown
Requirements

Consumers must be able to determine any legal restrictions on the use of the event definition and/or its content.

Alternate Names License; Restrictions
Summary false
Comments

The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.

EventDefinition.copyrightLabel
Element Id EventDefinition.copyrightLabel
Definition

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').

Short Display Copyright holder and year(s)
Cardinality 0..1
Type string
Requirements

Defines the content expected to be rendered in all representations of the artifact.

Summary false
Comments

The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

EventDefinition.approvalDate
Element Id EventDefinition.approvalDate
Definition

The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

Short Display When the event definition was approved by publisher
Cardinality 0..1
Type date
Summary true
Comments

The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.

See guidance around (not) making local changes to elements here.

EventDefinition.lastReviewDate
Element Id EventDefinition.lastReviewDate
Definition

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

Short Display When the event definition was last reviewed by the publisher
Cardinality 0..1
Type date
Requirements

Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.

Summary true
Comments

If specified, this date follows the original approval date.

See guidance around (not) making local changes to elements here.

EventDefinition.effectivePeriod
Element Id EventDefinition.effectivePeriod
Definition

The period during which the event definition content was or is planned to be in active use.

Short Display When the event definition is expected to be used
Cardinality 0..1
Type Period
Requirements

Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the event definition are or are expected to be used instead.

Summary true
Comments

The effective period for an event definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a definition intended to be used for the year 2016 might be published in 2015.

See guidance around (not) making local changes to elements here.

EventDefinition.topic
Standards Status This element has a standards status of "Deprecated" which is different from the status of the whole resource
Element Id EventDefinition.topic
Definition

Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching.

Short Display E.g. Education, Treatment, Assessment, etc
Cardinality 0..*
Terminology Binding Definition Topic (Example)
Type CodeableConcept
Requirements

Repositories must be able to determine how to categorize the module so that it can be found by topical searches.

Summary false
Comments

DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic)

EventDefinition.author
Element Id EventDefinition.author
Definition

An individiual or organization primarily involved in the creation and maintenance of the content.

Short Display Who authored the content
Cardinality 0..*
Type ContactDetail
Summary false
To Do Does this apply?
EventDefinition.editor
Element Id EventDefinition.editor
Definition

An individual or organization primarily responsible for internal coherence of the content.

Short Display Who edited the content
Cardinality 0..*
Type ContactDetail
Summary false
To Do Does this apply?
EventDefinition.reviewer
Element Id EventDefinition.reviewer
Definition

An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content.

Short Display Who reviewed the content
Cardinality 0..*
Type ContactDetail
Summary false
Comments

See guidance around (not) making local changes to elements here.

To Do Does this apply?
EventDefinition.endorser
Element Id EventDefinition.endorser
Definition

An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting.

Short Display Who endorsed the content
Cardinality 0..*
Type ContactDetail
Summary false
Comments

See guidance around (not) making local changes to elements here.

To Do Does this apply?
EventDefinition.relatedArtifact
Element Id EventDefinition.relatedArtifact
Definition

Related resources such as additional documentation, justification, or bibliographic references.

Short Display Additional documentation, citations, etc
Cardinality 0..*
Type RelatedArtifact
Requirements

Modules must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.

Summary false
Comments

Each related resource is either an attachment, or a reference to another resource, but not both.

To Do Does this apply?
EventDefinition.trigger
Element Id EventDefinition.trigger
Definition

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.

Short Display "when" the event occurs (multiple = 'or')
Cardinality 1..*
Type TriggerDefinition
Summary true